xref: /spdk/lib/util/util_internal.h (revision 0ed85362c8132a2d1927757fbcade66b6660d26a)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
5  *   Copyright (c) Intel Corporation.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef SPDK_UTIL_INTERNAL_H
36 #define SPDK_UTIL_INTERNAL_H
37 
38 #include "spdk/stdinc.h"
39 
40 /**
41  * IEEE CRC-32 polynomial (bit reflected)
42  */
43 #define SPDK_CRC32_POLYNOMIAL_REFLECT 0xedb88320UL
44 
45 /**
46  * CRC-32C (Castagnoli) polynomial (bit reflected)
47  */
48 #define SPDK_CRC32C_POLYNOMIAL_REFLECT 0x82f63b78UL
49 
50 struct spdk_crc32_table {
51 	uint32_t table[256];
52 };
53 
54 /**
55  * Initialize a CRC32 lookup table for a given polynomial.
56  *
57  * \param table Table to fill with precalculated CRC-32 data.
58  * \param polynomial_reflect Bit-reflected CRC-32 polynomial.
59  */
60 void crc32_table_init(struct spdk_crc32_table *table,
61 		      uint32_t polynomial_reflect);
62 
63 
64 /**
65  * Calculate a partial CRC-32 checksum.
66  *
67  * \param table CRC-32 table initialized with crc32_table_init().
68  * \param buf Data buffer to checksum.
69  * \param len Length of buf in bytes.
70  * \param crc Previous CRC-32 value.
71  * \return Updated CRC-32 value.
72  */
73 uint32_t crc32_update(const struct spdk_crc32_table *table,
74 		      const void *buf, size_t len,
75 		      uint32_t crc);
76 
77 #endif /* SPDK_UTIL_INTERNAL_H */
78