bertos/algo/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 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \brief Cyclic Redundancy Check 16 (CRC). This algorithm is the one used by the XMODEM protocol.
  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  * \author Bernie Innocenti <bernie@codewiz.org>
  47  *
  48  * $WIZ$ module_name = "crc16"
  49  */
  50
  51 #ifndef ALGO_CRC_H
  52 #define ALGO_CRC_H
  53
  54 #include "cfg/cfg_arch.h"
  55
  56 #include <cfg/compiler.h>
  57 #include <cpu/pgm.h>
  58
  59 EXTERN_C_BEGIN
  60
  61 /* CRC table */
  62 extern const uint16_t crc16tab[256];
  63
  64
  65 /**
  66  * \brief Compute the updated CRC16 value for one octet (macro version)
  67  *
  68  * \note This version is only intended for old/broken compilers.
  69  *       Use the inline function in new code.
  70  *
  71  * \param c New octet (range 0-255)
  72  * \param oldcrc Previous CRC16 value (referenced twice, beware of side effects)
  73  */
  74 #if CPU_HARVARD && !(defined(ARCH_BOOT) && (ARCH & ARCH_BOOT))
  75         #define UPDCRC16(c, oldcrc) (pgm_read_uint16_t(&crc16tab[((oldcrc) >> 8) ^ ((unsigned char)(c))]) ^ ((oldcrc) << 8))
  76 #else
  77         #define UPDCRC16(c, oldcrc) ((crc16tab[((oldcrc) >> 8) ^ ((unsigned char)(c))]) ^ ((oldcrc) << 8))
  78 #endif
  79
  80 /** CRC-16 init value */
  81 #define CRC16_INIT_VAL ((uint16_t)0)
  82
  83 #ifdef INLINE
  84 /**
  85  * \brief Compute the updated CRC16 value for one octet (inline version)
  86  */
  87 INLINE uint16_t updcrc16(uint8_t c, uint16_t oldcrc)
  88 {
  89 #if CPU_HARVARD && !(defined(ARCH_BOOT) && (ARCH & ARCH_BOOT))
  90         return pgm_read_uint16_t(&crc16tab[(oldcrc >> 8) ^ c]) ^ (oldcrc << 8);
  91 #else
  92         return crc16tab[(oldcrc >> 8) ^ c] ^ (oldcrc << 8);
  93 #endif
  94 }
  95 #endif // INLINE
  96
  97
  98 /**
  99  * This function implements the CRC 16 calculation on a buffer.
 100  *
 101  * \param crc  Current CRC16 value.
 102  * \param buf  The buffer to perform CRC calculation on.
 103  * \param len  The length of the Buffer.
 104  *
 105  * \return The updated CRC16 value.
 106  */
 107 extern uint16_t crc16(uint16_t crc, const void *buf, size_t len);
 108
 109 int crc_testSetup(void);
 110 int crc_testRun(void);
 111 int crc_testTearDown(void);
 112
 113 EXTERN_C_END
 114
 115 #endif /* ALGO_CRC_H */