bertos/algo/crc_ccitt.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 2009 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief CCITT Cyclic Redundancy Check (CRC-CCITT).
  34  *
  35  * \note This algorithm is incompatible with the CRC16.
  36  *
  37  * \author Francesco Sacchi <batt@develer.com>
  38  *
  39  * $WIZ$ module_name = "crc-ccitt"
  40  */
  41
  42 #ifndef ALGO_CRC_CCITT_H
  43 #define ALGO_CRC_CCITT_H
  44
  45 #include <cfg/compiler.h>
  46 #include <cpu/pgm.h>
  47
  48 EXTERN_C_BEGIN
  49
  50 /* CRC table */
  51 extern const uint16_t crc_ccitt_tab[256];
  52
  53 /**
  54  * \brief Compute the updated CRC-CCITT value for one octet (inline version)
  55  */
  56 INLINE uint16_t updcrc_ccitt(uint8_t c, uint16_t oldcrc)
  57 {
  58         return (oldcrc >> 8) ^ pgm_read16(&crc_ccitt_tab[(oldcrc ^ c) & 0xff]);
  59 }
  60
  61 /** CRC-CCITT init value */
  62 #define CRC_CCITT_INIT_VAL ((uint16_t)0xFFFF)
  63
  64
  65 /**
  66  * This function implements the CRC-CCITT calculation on a buffer.
  67  *
  68  * \param crc  Current CRC-CCITT value.
  69  * \param buf  The buffer to perform CRC calculation on.
  70  * \param len  The length of the Buffer.
  71  *
  72  * \return The updated CRC-CCITT value.
  73  */
  74 extern uint16_t crc_ccitt(uint16_t crc, const void *buf, size_t len);
  75
  76 EXTERN_C_END
  77
  78 #endif /* ALGO_CRC_CCITT_H */