mware/crc.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
   6  * This file is part of DevLib - See README.devlib for information.
   7  * -->
   8  *
   9  * \brief XModem-CRC16 algorithm (interface)
  10  *
  11  * \note This algorithm is incompatible with the CCITT-CRC16.
  12  *
  13  * This code is based on the article Copyright 1986 Stephen Satchell.
  14  *
  15  * Programmers may incorporate any or all code into their programs,
  16  * giving proper credit within the source. Publication of the
  17  * source routines is permitted so long as proper credit is given
  18  * to Stephen Satchell, Satchell Evaluations and Chuck Forsberg,
  19  * Omen Technology.
  20  *
  21  * \version $Id$
  22  * \author Bernardo Innocenti <bernie@develer.com>
  23  */
  24
  25 /*#*
  26  *#* $Log$
  27  *#* Revision 1.6  2005/11/04 16:20:02  bernie
  28  *#* Fix reference to README.devlib in header.
  29  *#*
  30  *#* Revision 1.5  2005/04/11 19:10:28  bernie
  31  *#* Include top-level headers from cfg/ subdir.
  32  *#*
  33  *#* Revision 1.4  2004/08/25 14:12:09  rasky
  34  *#* Aggiornato il comment block dei log RCS
  35  *#*
  36  *#* Revision 1.3  2004/08/15 05:47:26  bernie
  37  *#* updcrc16(): inline version of UPDCRC16(); Cleanup documentation.
  38  *#*
  39  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  40  *#* Add dual-license information.
  41  *#*
  42  *#* Revision 1.1  2004/06/03 08:58:16  bernie
  43  *#* Import into DevLib
  44  *#*
  45  *#*/
  46 #ifndef CRC_H
  47 #define CRC_H
  48
  49 #include <cfg/compiler.h>
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif /* __cplusplus */
  54
  55
  56 /* CRC table */
  57 extern const uint16_t crc16tab[256];
  58
  59
  60 /*!
  61  * \brief Compute the updated CRC16 value for one octet (macro version)
  62  *
  63  * \note This version is only intended for old/broken compilers.
  64  *       Use the inline function in new code.
  65  *
  66  * \param c New octet (range 0-255)
  67  * \param oldcrc Previous CRC16 value (referenced twice, beware of side effects)
  68  */
  69 #define UPDCRC16(c, oldcrc) (crc16tab[((oldcrc) >> 8) ^ ((unsigned char)(c))] ^ ((oldcrc) << 8))
  70
  71
  72 #ifdef INLINE
  73 /*!
  74  * \brief Compute the updated CRC16 value for one octet (macro version)
  75  */
  76 INLINE uint16_t updcrc16(uint8_t c, uint16_t oldcrc)
  77 {
  78         return crc16tab[(oldcrc >> 8) ^ c] ^ (oldcrc << 8);
  79 }
  80 #endif // INLINE
  81
  82
  83 /*!
  84  * This function implements the CRC 16 calculation on a buffer.
  85  *
  86  * \param crc  Current CRC16 value.
  87  * \param buf  The buffer to perform CRC calculation on.
  88  * \param len  The length of the Buffer.
  89  *
  90  * \return The updated CRC16 value.
  91  */
  92 extern uint16_t crc16(uint16_t crc, const void *buf, size_t len);
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif /* __cplusplus */
  97
  98 #endif /* CRC_H */