7 * crc32c - Castagnoli 32 bit crc of string of bytes
8 * @start_crc: the initial crc (usually 0)
9 * @buf: pointer to bytes
10 * @size: length of buffer
12 * If you don't know what crc32 to use, use this one: it's the best.
14 * @Article{castagnoli-crc,
15 * author = { Guy Castagnoli and Stefan Braeuer and Martin Herrman},
16 * title = {{Optimization of Cyclic Redundancy-Check Codes with 24
17 * and 32 Parity Bits}},
18 * journal = IEEE Transactions on Communication,
25 * 32 bit CRC checksum using polynomial
26 * X^32+X^28+X^27+X^26+X^25+X^23+X^22+X^20+X^19+X^18+X^14+X^13+X^11+X^10+X^9+X^8+X^6+X^0.
28 * You can calculate the CRC of non-contiguous arrays by passing @start_crc
29 * as 0 the first time, and the current crc result from then on.
32 * // Check that iovec has the crc we expect (Castagnoli version)
33 * bool check_crc(uint32_t expected, const struct iovec *iov, int iovcnt)
36 * while (iovcnt >= 0) {
37 * crc = crc32c(crc, iov->iov_base, iov->iov_len);
40 * return crc == expected;
43 uint32_t crc32c(uint32_t start_crc, const void *buf, size_t size);
46 * crc32c_table - Get the Castagnoli CRC table
48 * For special effects, you might want direct access to the table; this is
49 * the standard 256-entry table for this algorithm.
51 * In theory, this might need to malloc(), and thus return NULL.
54 * // This dumb code only handles Castagnoli, so assert that here.
55 * void check_user_crc_table(const uint32_t *usertab)
57 * const uint32_t *ctab = crc32c_table();
58 * if (!ctab || memcmp(ctab, usertab, 1024) != 0)
62 const uint32_t *crc32c_table(void);
65 * crc32_ieee - IEEE 802.3 32 bit crc of string of bytes
66 * @start_crc: the initial crc (usually 0)
67 * @buf: pointer to bytes
68 * @size: length of buffer
70 * 32 bit CRC checksum using polynomial
71 * X^32+X^26+X^23+X^22+X^16+X^12+X^11+X^10+X^8+X^7+X^5+X^4+X^2+X^1+X^0.
73 * See crc32c() for details.
75 uint32_t crc32_ieee(uint32_t start_crc, const void *buf, size_t size);
78 * crc32_ieee_table - Get the IEEE 802.3 CRC table
80 * See crc32c_table() for details.
82 const uint32_t *crc32_ieee_table(void);
85 * crc64_iso - ISO 3309
86 * @start_crc: the initial crc (usually 0)
87 * @buf: pointer to bytes
88 * @size: length of buffer
90 * 64 bit CRC checksum using polynomial
91 * X^64 + X^4 + X^3 + X^1 + X^0
93 * See crc32c() for details.
95 uint64_t crc64_iso(uint64_t start_crc, const void *buf, size_t size);
98 * crc64_iso_table - Get the ISO 3309 CRC table
100 * See crc32c_table() for details.
102 const uint64_t *crc64_iso_table(void);
104 #endif /* CCAN_CRC_H */