Annotation of libelwix/inc/elwix/acrc.h, revision 1.10.4.1
1.1 misho 1: /*************************************************************************
2: * (C) 2013 AITNET ltd - Sofia/Bulgaria - <misho@aitnet.org>
3: * by Michael Pounov <misho@elwix.org>
4: *
5: * $Author: misho $
1.10.4.1! misho 6: * $Id: acrc.h,v 1.10 2024/10/28 09:58:51 misho Exp $
1.1 misho 7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
1.8 misho 15: Copyright 2004 - 2024
1.1 misho 16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
46: #ifndef __ACRC_H
47: #define __ACRC_H
48:
49:
50: #define REVOPTS_REVERTBYTE 1
51: #define REVOPTS_REVERTCRC 2
52:
53:
54: struct tagCRCPoly {
55: u_char poly_bits;
56: u_int poly_num;
57: char poly_name[19];
58: }; /* size 24bytes */
59: typedef struct tagCRCPoly crcPoly_t;
60:
1.10.4.1! misho 61: #ifdef __cplusplus
! 62: extern "C" {
! 63: #endif
1.1 misho 64:
65: /*
66: * crcReflect() - Reflect all bits of number
67: *
68: * @crcNum = Number for reflection
69: * @crcBits = Number width bits
1.7 misho 70: * return: reflecting number
1.1 misho 71: */
1.2 misho 72: unsigned int crcReflect(unsigned int crcNum, unsigned char crcBits);
1.1 misho 73: /*
74: * crcCalc() - Generic CRC calculation function for many sub variants of CRC algorithms
75: *
76: * @psBuf = Data for calculation
77: * @bufLen = Length of data
78: * @crcBits = CRC algorithm bits (1, 4, 5, 6, 7, 8, 10, 11, 12, 15, 16, 24, 30, 32)
79: * @RevOpts = Options for computation (REVOPTS_REVERTBYTE, REVOPTS_REVERTCRC)
80: * @initCRC = Initial CRC value
81: * @xorCRC = Last xor CRC value
1.7 misho 82: * return: CRC checksum
1.1 misho 83: */
1.2 misho 84: unsigned int crcCalc(unsigned char * __restrict psBuf, unsigned int bufLen,
1.1 misho 85: unsigned char crcBits, unsigned char RevOpts,
86: unsigned int initCRC, unsigned int xorCRC);
1.8 misho 87: #define crc_32(x, l) crcCalc((x), (l), 32, REVOPTS_REVERTBYTE|REVOPTS_REVERTCRC, 0xFFFFFFFF, 0xFFFFFFFF)
88: #define crc_16(x, l) crcCalc((x), (l), 16, REVOPTS_REVERTBYTE|REVOPTS_REVERTCRC, 0x0, 0x0)
89: #define crc_16_ccitt(x, l) crcCalc((x), (l), 161, 0, 0x0, 0x0)
90: #define crc_16_xmodem(x, l) crcCalc((x), (l), 162, REVOPTS_REVERTBYTE|REVOPTS_REVERTCRC, 0x0, 0x0)
1.9 misho 91: #define crc_8(x, l) crcCalc((x), (l), 8, 0, 0x0, 0x0)
1.1 misho 92:
93: /*
1.8 misho 94: * crc16_ccitt() - Checksum calculation
1.7 misho 95: *
96: * @buf = Data for calculation
97: * @bufLen = Length of data
98: * return: Checksum
99: */
1.8 misho 100: unsigned short crc16_ccitt(unsigned char * __restrict buf, int bufLen);
1.7 misho 101: /*
1.8 misho 102: * crc16_xy() - Checksum calculation in X/Y modem communication
1.7 misho 103: *
104: * @buf = Data for calculation
105: * @bufLen = Length of data
106: * return: Checksum
107: */
1.8 misho 108: unsigned short crc16_xy(unsigned char * __restrict buf, int bufLen);
1.7 misho 109: /*
1.1 misho 110: * crcIP() - Checksum in IP communication
111: *
112: * @buf = Data for calculation
1.10 misho 113: * @len = Length of data in bytes
1.7 misho 114: * return: Checksum
1.1 misho 115: */
1.10 misho 116: unsigned short crcIP(unsigned short* __restrict buf, int len);
1.6 misho 117: /*
118: * crcTCP() - Checksum for TCP v4 communication
119: *
120: * @buf = Data for calculation
121: * @bufLen = Length of data
122: * @th = TCP header
1.7 misho 123: * return: Checksum
1.6 misho 124: */
125: unsigned short crcTCP(struct in_addr src, struct in_addr dst,
126: unsigned char * __restrict th);
127: /*
128: * crcUDP() - Checksum for UDP v4 communication
129: *
130: * @buf = Data for calculation
131: * @bufLen = Length of data
132: * @uh = UDP header
1.7 misho 133: * return: Checksum
1.6 misho 134: */
135: unsigned short crcUDP(struct in_addr src, struct in_addr dst,
136: unsigned char * __restrict uh);
137:
1.1 misho 138: /*
139: * crcFletcher16() - Fletcher-16 Checksum computing
140: *
141: * @nBuf = Data for calculation
142: * @bufLen = Length of data
1.7 misho 143: * return: Checksum
1.1 misho 144: */
1.2 misho 145: unsigned short crcFletcher16(unsigned short * __restrict nBuf, int bufLen);
1.1 misho 146: /*
147: * crcFletcher() - Fletcher-32 Checksum computing
148: *
149: * @nBuf = Data for calculation
150: * @bufLen = Length of data
1.7 misho 151: * return: Checksum
1.1 misho 152: */
1.2 misho 153: unsigned int crcFletcher(unsigned short * __restrict nBuf, int bufLen);
1.1 misho 154: /*
155: * crcAdler() - crcAdler-32 Checksum computing
156: *
157: * @psBuf = Data for calculation
158: * @bufLen = Length of data
1.7 misho 159: * return: Checksum
1.1 misho 160: */
1.2 misho 161: unsigned int crcAdler(unsigned char * __restrict psBuf, int bufLen);
1.1 misho 162:
163: /*
164: * crcEther() - Checksum in Ethernet communication
165: *
166: * @psBuf = Data for calculation
167: * @bufLen = Length of data
1.7 misho 168: * return: Checksum
1.1 misho 169: */
170: #define crcEther(psBuf, bufLen) crcCalc((psBuf), (bufLen), 32, 3, 0xFFFFFFFF, 0xFFFFFFFF)
171:
1.3 misho 172: /*
1.9 misho 173: * crc8tbl() - CRC8 calculation from table
174: *
175: * @crc = Initial crc value
176: * @buf = Data for calculation
177: * @len = Length of data
178: * return: calculated CRC8
179: */
180: uint8_t crc8tbl(unsigned char crc, const unsigned char * __restrict buf, unsigned int len);
181: /*
1.8 misho 182: * crc32tbl() - CRC32 calculation from table
1.3 misho 183: *
184: * @crc = Initial crc value
185: * @buf = Data for calculation
186: * @len = Length of data
187: * return: calculated CRC32
188: */
1.8 misho 189: unsigned int crc32tbl(unsigned int crc, const unsigned char * __restrict buf, unsigned int len);
1.1 misho 190:
191: /*
192: * crcPelco() - Calculate Pelco D/P CRC
193: *
194: * @ver = Pelco protocol version (Dd | Pp)
195: * @pkt = Packet for calculate crc
196: * return: crc for packet, if is 0 check and crc_GetErrno() == 1
197: Pelco protocol not supported
198: */
1.2 misho 199: unsigned char crcPelco(unsigned char ver, unsigned char *pkt);
1.1 misho 200:
201:
202: /*
203: * hash_varchar() - Compute index hash by variable length string
204: *
205: * @csStr = Input data buffer
206: * @nStrLen = Length of data buffer
207: * @nVer = Version of algorythm; 0 - original, 1 - AITNET variant
208: * return: Hash value
209: */
1.2 misho 210: unsigned int hash_varchar(const char *csStr, int nStrLen, int nVer);
1.1 misho 211: /*
212: * hash_bernstein() - Compute index hash by Bernstein
213: *
214: * @csStr = Input data buffer
215: * @nStrLen = Length of data buffer
216: * @nVer = Version of algorythm; 0 - Bernstein, 1 - DJBX33A variant
217: * return: Hash value
218: */
1.2 misho 219: unsigned int hash_bernstein(const char *csStr, int nStrLen, int nVer);
1.1 misho 220: /*
221: * hash_jenkins() - Compute index hash by Jenkins (one-at-a-time)
222: *
223: * @csStr = Input data buffer
224: * @nStrLen = Length of data buffer
225: * return: Hash value
226: */
1.2 misho 227: unsigned int hash_jenkins(const char *csStr, int nStrLen);
1.1 misho 228: /*
229: * hash_jenkins32() - Fast Jenkins hash function
230: *
231: * @buf = Input buffer
232: * @len = Length of buffer
233: * @prevhash = Previous hash, if participate in continuing hash
234: * return: Hash value
235: */
236: unsigned int hash_jenkins32(const unsigned int *buf, int len, unsigned int prevhash);
237: /*
238: * hash_reddragon() - Compute index hash by Red Dragon
239: *
240: * @csStr = Input data buffer
241: * @nStrLen = Length of data buffer
242: * return: Hash value
243: */
1.2 misho 244: unsigned int hash_reddragon(const char *csStr, int nStrLen);
1.1 misho 245: /*
246: * hash_fnv1() - Compute index hash by FNV-1
247: *
248: * @csStr = Input data buffer
249: * @nStrLen = Length of data buffer
250: * @nVer = Version of algorythm; 0 - FNV-1, 1 - FNV-1a (best avalanche)
251: * return: Hash value
252: */
1.2 misho 253: unsigned int hash_fnv1(const char *csStr, int nStrLen, int nVer);
1.1 misho 254:
255: /*
256: * hash_fnv() - Compute index hash by FNV-1a
257: *
258: * @csStr = Input data buffer
259: * @nStrLen = Length of data buffer
260: * return: Hash value
261: */
262: #define hash_fnv(str, len) hash_fnv1((str), (len), 1)
263:
1.10.4.1! misho 264: #ifdef __cplusplus
! 265: }
! 266: #endif
1.1 misho 267:
268: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to acrc.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libelwix / inc / elwix