Annotation of libelwix/inc/elwix/acrc.h, revision 1.5

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.5     ! misho       6: * $Id: acrc.h,v 1.4.16.1 2015/06/25 00:36:47 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.5     ! misho      15: Copyright 2004 - 2015
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: 
                     61: 
                     62: /*
                     63:  * crcReflect() - Reflect all bits of number 
                     64:  *
                     65:  * @crcNum = Number for reflection
                     66:  * @crcBits = Number width bits 
                     67:  * return: -1 error, !=-1 reflecting number
                     68:  */
1.2       misho      69: unsigned int crcReflect(unsigned int crcNum, unsigned char crcBits);
1.1       misho      70: /*
                     71:  * crcCalc() - Generic CRC calculation function for many sub variants of CRC algorithms
                     72:  *
                     73:  * @psBuf = Data for calculation
                     74:  * @bufLen = Length of data
                     75:  * @crcBits = CRC algorithm bits (1, 4, 5, 6, 7, 8, 10, 11, 12, 15, 16, 24, 30, 32)
                     76:  * @RevOpts = Options for computation (REVOPTS_REVERTBYTE, REVOPTS_REVERTCRC)
                     77:  * @initCRC = Initial CRC value
                     78:  * @xorCRC = Last xor CRC value
                     79:  * return: -1 error, !=-1 CRC checksum
                     80:  */
1.2       misho      81: unsigned int crcCalc(unsigned char * __restrict psBuf, unsigned int bufLen, 
1.1       misho      82:                unsigned char crcBits, unsigned char RevOpts, 
                     83:                unsigned int initCRC, unsigned int xorCRC);
                     84: 
                     85: /*
                     86:  * crcIP() - Checksum in IP communication
                     87:  *
                     88:  * @buf = Data for calculation
                     89:  * @bufLen = Length of data
                     90:  * return: -1 error, !=-1 Checksum
                     91:  */
1.2       misho      92: unsigned short crcIP(unsigned char * __restrict buf, int bufLen);
1.1       misho      93: /*
                     94:  * crcFletcher16() - Fletcher-16 Checksum computing
                     95:  *
                     96:  * @nBuf = Data for calculation
                     97:  * @bufLen = Length of data
                     98:  * return: -1 error, !=-1 Checksum
                     99:  */
1.2       misho     100: unsigned short crcFletcher16(unsigned short * __restrict nBuf, int bufLen);
1.1       misho     101: /*
                    102:  * crcFletcher() - Fletcher-32 Checksum computing
                    103:  *
                    104:  * @nBuf = Data for calculation
                    105:  * @bufLen = Length of data
                    106:  * return: -1 error, !=-1 Checksum
                    107:  */
1.2       misho     108: unsigned int crcFletcher(unsigned short * __restrict nBuf, int bufLen);
1.1       misho     109: /*
                    110:  * crcAdler() - crcAdler-32 Checksum computing
                    111:  *
                    112:  * @psBuf = Data for calculation
                    113:  * @bufLen = Length of data
                    114:  * return: -1 error, !=-1 Checksum
                    115:  */
1.2       misho     116: unsigned int crcAdler(unsigned char * __restrict psBuf, int bufLen);
1.1       misho     117: 
                    118: /*
                    119:  * crcEther() - Checksum in Ethernet communication
                    120:  *
                    121:  * @psBuf = Data for calculation
                    122:  * @bufLen = Length of data
                    123:  * return: -1 error, !=-1 Checksum
                    124:  */
                    125: #define crcEther(psBuf, bufLen) crcCalc((psBuf), (bufLen), 32, 3, 0xFFFFFFFF, 0xFFFFFFFF)
                    126: 
1.3       misho     127: /*
1.4       misho     128:  * crc_32() - CRC32 calculation from table
1.3       misho     129:  *
                    130:  * @crc = Initial crc value
                    131:  * @buf = Data for calculation
                    132:  * @len = Length of data
                    133:  * return: calculated CRC32
                    134:  */
1.4       misho     135: unsigned int crc_32(unsigned int crc, const unsigned char * __restrict buf, unsigned int len);
1.1       misho     136: 
                    137: /*
                    138:  * crcPelco() - Calculate Pelco D/P CRC
                    139:  *
                    140:  * @ver = Pelco protocol version (Dd | Pp)
                    141:  * @pkt = Packet for calculate crc
                    142:  * return: crc for packet, if is 0 check and crc_GetErrno() == 1 
                    143:        Pelco protocol not supported
                    144:  */
1.2       misho     145: unsigned char crcPelco(unsigned char ver, unsigned char *pkt);
1.1       misho     146: 
                    147: 
                    148: /*
                    149:  * hash_varchar() - Compute index hash by variable length string
                    150:  *
                    151:  * @csStr = Input data buffer
                    152:  * @nStrLen = Length of data buffer
                    153:  * @nVer = Version of algorythm; 0 - original, 1 - AITNET variant
                    154:  * return: Hash value
                    155: */
1.2       misho     156: unsigned int hash_varchar(const char *csStr, int nStrLen, int nVer);
1.1       misho     157: /*
                    158:  * hash_bernstein() - Compute index hash by Bernstein
                    159:  *
                    160:  * @csStr = Input data buffer
                    161:  * @nStrLen = Length of data buffer
                    162:  * @nVer = Version of algorythm; 0 - Bernstein, 1 - DJBX33A variant
                    163:  * return: Hash value
                    164: */
1.2       misho     165: unsigned int hash_bernstein(const char *csStr, int nStrLen, int nVer);
1.1       misho     166: /*
                    167:  * hash_jenkins() - Compute index hash by Jenkins (one-at-a-time)
                    168:  *
                    169:  * @csStr = Input data buffer
                    170:  * @nStrLen = Length of data buffer
                    171:  * return: Hash value
                    172: */
1.2       misho     173: unsigned int hash_jenkins(const char *csStr, int nStrLen);
1.1       misho     174: /*
                    175:  * hash_jenkins32() - Fast Jenkins hash function
                    176:  *
                    177:  * @buf = Input buffer
                    178:  * @len = Length of buffer
                    179:  * @prevhash = Previous hash, if participate in continuing hash
                    180:  * return: Hash value
                    181:  */
                    182: unsigned int hash_jenkins32(const unsigned int *buf, int len, unsigned int prevhash);
                    183: /*
                    184:  * hash_reddragon() - Compute index hash by Red Dragon
                    185:  *
                    186:  * @csStr = Input data buffer
                    187:  * @nStrLen = Length of data buffer
                    188:  * return: Hash value
                    189: */
1.2       misho     190: unsigned int hash_reddragon(const char *csStr, int nStrLen);
1.1       misho     191: /*
                    192:  * hash_fnv1() - Compute index hash by FNV-1
                    193:  *
                    194:  * @csStr = Input data buffer
                    195:  * @nStrLen = Length of data buffer
                    196:  * @nVer = Version of algorythm; 0 - FNV-1, 1 - FNV-1a (best avalanche)
                    197:  * return: Hash value
                    198: */
1.2       misho     199: unsigned int hash_fnv1(const char *csStr, int nStrLen, int nVer);
1.1       misho     200: 
                    201: /*
                    202:  * hash_fnv() - Compute index hash by FNV-1a
                    203:  *
                    204:  * @csStr = Input data buffer
                    205:  * @nStrLen = Length of data buffer
                    206:  * return: Hash value
                    207: */
                    208: #define hash_fnv(str, len)     hash_fnv1((str), (len), 1)
                    209: 
                    210: 
                    211: #endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>