Annotation of libelwix/inc/elwix/acrc.h, revision 1.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 $
! 6: * $Id: global.h,v 1.13 2012/08/29 13:51:29 misho Exp $
! 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:
! 15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
! 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: */
! 69: inline unsigned int crcReflect(unsigned int crcNum, unsigned char crcBits);
! 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: */
! 81: inline unsigned int crcCalc(unsigned char * __restrict psBuf, unsigned int bufLen,
! 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: */
! 92: inline unsigned short crcIP(unsigned char * __restrict buf, int bufLen);
! 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: */
! 100: inline unsigned short crcFletcher16(unsigned short * __restrict nBuf, int bufLen);
! 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: */
! 108: inline unsigned int crcFletcher(unsigned short * __restrict nBuf, int bufLen);
! 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: */
! 116: inline unsigned int crcAdler(unsigned char * __restrict psBuf, int bufLen);
! 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:
! 127:
! 128: /*
! 129: * crcPelco() - Calculate Pelco D/P CRC
! 130: *
! 131: * @ver = Pelco protocol version (Dd | Pp)
! 132: * @pkt = Packet for calculate crc
! 133: * return: crc for packet, if is 0 check and crc_GetErrno() == 1
! 134: Pelco protocol not supported
! 135: */
! 136: inline unsigned char crcPelco(unsigned char ver, unsigned char *pkt);
! 137:
! 138:
! 139: /*
! 140: * hash_varchar() - Compute index hash by variable length string
! 141: *
! 142: * @csStr = Input data buffer
! 143: * @nStrLen = Length of data buffer
! 144: * @nVer = Version of algorythm; 0 - original, 1 - AITNET variant
! 145: * return: Hash value
! 146: */
! 147: inline unsigned int hash_varchar(const char *csStr, int nStrLen, int nVer);
! 148: /*
! 149: * hash_bernstein() - Compute index hash by Bernstein
! 150: *
! 151: * @csStr = Input data buffer
! 152: * @nStrLen = Length of data buffer
! 153: * @nVer = Version of algorythm; 0 - Bernstein, 1 - DJBX33A variant
! 154: * return: Hash value
! 155: */
! 156: inline unsigned int hash_bernstein(const char *csStr, int nStrLen, int nVer);
! 157: /*
! 158: * hash_jenkins() - Compute index hash by Jenkins (one-at-a-time)
! 159: *
! 160: * @csStr = Input data buffer
! 161: * @nStrLen = Length of data buffer
! 162: * return: Hash value
! 163: */
! 164: inline unsigned int hash_jenkins(const char *csStr, int nStrLen);
! 165: /*
! 166: * hash_jenkins32() - Fast Jenkins hash function
! 167: *
! 168: * @buf = Input buffer
! 169: * @len = Length of buffer
! 170: * @prevhash = Previous hash, if participate in continuing hash
! 171: * return: Hash value
! 172: */
! 173: unsigned int hash_jenkins32(const unsigned int *buf, int len, unsigned int prevhash);
! 174: /*
! 175: * hash_reddragon() - Compute index hash by Red Dragon
! 176: *
! 177: * @csStr = Input data buffer
! 178: * @nStrLen = Length of data buffer
! 179: * return: Hash value
! 180: */
! 181: inline unsigned int hash_reddragon(const char *csStr, int nStrLen);
! 182: /*
! 183: * hash_fnv1() - Compute index hash by FNV-1
! 184: *
! 185: * @csStr = Input data buffer
! 186: * @nStrLen = Length of data buffer
! 187: * @nVer = Version of algorythm; 0 - FNV-1, 1 - FNV-1a (best avalanche)
! 188: * return: Hash value
! 189: */
! 190: inline unsigned int hash_fnv1(const char *csStr, int nStrLen, int nVer);
! 191:
! 192: /*
! 193: * hash_fnv() - Compute index hash by FNV-1a
! 194: *
! 195: * @csStr = Input data buffer
! 196: * @nStrLen = Length of data buffer
! 197: * return: Hash value
! 198: */
! 199: #define hash_fnv(str, len) hash_fnv1((str), (len), 1)
! 200:
! 201:
! 202: #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