algos/crc.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
  31  *
  32  * -->
  33  *
  34  * \brief XModem-CRC16 algorithm (interface)
  35  *
  36  * \note This algorithm is incompatible with the CCITT-CRC16.
  37  *
  38  * This code is based on the article Copyright 1986 Stephen Satchell.
  39  *
  40  * Programmers may incorporate any or all code into their programs,
  41  * giving proper credit within the source. Publication of the
  42  * source routines is permitted so long as proper credit is given
  43  * to Stephen Satchell, Satchell Evaluations and Chuck Forsberg,
  44  * Omen Technology.
  45  *
  46  * \version $Id$
  47  * \author Bernardo Innocenti <bernie@develer.com>
  48  */
  49
  50 /*#*
  51  *#* $Log$
  52  *#* Revision 1.1  2007/06/07 09:09:41  batt
  53  *#* Move crc routines to algos/.
  54  *#*
  55  *#* Revision 1.7  2006/07/19 12:56:27  bernie
  56  *#* Convert to new Doxygen style.
  57  *#*
  58  *#* Revision 1.6  2005/11/04 16:20:02  bernie
  59  *#* Fix reference to README.devlib in header.
  60  *#*
  61  *#* Revision 1.5  2005/04/11 19:10:28  bernie
  62  *#* Include top-level headers from cfg/ subdir.
  63  *#*
  64  *#* Revision 1.4  2004/08/25 14:12:09  rasky
  65  *#* Aggiornato il comment block dei log RCS
  66  *#*
  67  *#* Revision 1.3  2004/08/15 05:47:26  bernie
  68  *#* updcrc16(): inline version of UPDCRC16(); Cleanup documentation.
  69  *#*
  70  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  71  *#* Add dual-license information.
  72  *#*
  73  *#* Revision 1.1  2004/06/03 08:58:16  bernie
  74  *#* Import into DevLib
  75  *#*
  76  *#*/
  77 #ifndef CRC_H
  78 #define CRC_H
  79
  80 #include <cfg/compiler.h>
  81
  82 #ifdef __cplusplus
  83 extern "C" {
  84 #endif /* __cplusplus */
  85
  86
  87 /* CRC table */
  88 extern const uint16_t crc16tab[256];
  89
  90
  91 /**
  92  * \brief Compute the updated CRC16 value for one octet (macro version)
  93  *
  94  * \note This version is only intended for old/broken compilers.
  95  *       Use the inline function in new code.
  96  *
  97  * \param c New octet (range 0-255)
  98  * \param oldcrc Previous CRC16 value (referenced twice, beware of side effects)
  99  */
 100 #define UPDCRC16(c, oldcrc) (crc16tab[((oldcrc) >> 8) ^ ((unsigned char)(c))] ^ ((oldcrc) << 8))
 101
 102
 103 #ifdef INLINE
 104 /**
 105  * \brief Compute the updated CRC16 value for one octet (macro version)
 106  */
 107 INLINE uint16_t updcrc16(uint8_t c, uint16_t oldcrc)
 108 {
 109         return crc16tab[(oldcrc >> 8) ^ c] ^ (oldcrc << 8);
 110 }
 111 #endif // INLINE
 112
 113
 114 /**
 115  * This function implements the CRC 16 calculation on a buffer.
 116  *
 117  * \param crc  Current CRC16 value.
 118  * \param buf  The buffer to perform CRC calculation on.
 119  * \param len  The length of the Buffer.
 120  *
 121  * \return The updated CRC16 value.
 122  */
 123 extern uint16_t crc16(uint16_t crc, const void *buf, size_t len);
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif /* __cplusplus */
 128
 129 #endif /* CRC_H */