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 devlib/README 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.3  2004/08/15 05:47:26  bernie
  28  * updcrc16(): inline version of UPDCRC16(); Cleanup documentation.
  29  *
  30  * Revision 1.2  2004/06/03 11:27:09  bernie
  31  * Add dual-license information.
  32  *
  33  * Revision 1.1  2004/06/03 08:58:16  bernie
  34  * Import into DevLib
  35  *
  36  */
  37 #ifndef CRC_H
  38 #define CRC_H
  39
  40 #include <compiler.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif /* __cplusplus */
  45
  46
  47 /* CRC table */
  48 extern const uint16_t crc16tab[256];
  49
  50
  51 /*!
  52  * \brief Compute the updated CRC16 value for one octet (macro version)
  53  *
  54  * \note This version is only intended for old/broken compilers.
  55  *       Use the inline function in new code.
  56  *
  57  * \param c New octet (range 0-255)
  58  * \param oldcrc Previous CRC16 value (referenced twice, beware of side effects)
  59  */
  60 #define UPDCRC16(c, oldcrc) (crc16tab[((oldcrc) >> 8) ^ ((unsigned char)(c))] ^ ((oldcrc) << 8))
  61
  62
  63 #ifdef INLINE
  64 /*!
  65  * \brief Compute the updated CRC16 value for one octet (macro version)
  66  */
  67 INLINE uint16_t updcrc16(uint8_t c, uint16_t oldcrc)
  68 {
  69         return crc16tab[(oldcrc >> 8) ^ c] ^ (oldcrc << 8);
  70 }
  71 #endif // INLINE
  72
  73
  74 /*!
  75  * This function implements the CRC 16 calculation on a buffer.
  76  *
  77  * \param crc  Current CRC16 value.
  78  * \param buf  The buffer to perform CRC calculation on.
  79  * \param len  The length of the Buffer.
  80  *
  81  * \return The updated CRC16 value.
  82  */
  83 extern uint16_t crc16(uint16_t crc, const void *buf, size_t len);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif /* __cplusplus */
  88
  89 #endif /* CRC_H */