Merged from external project:
[bertos.git] / 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 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 Bernie Innocenti <bernie@codewiz.org>
48  */
49
50 #ifndef ALGO_CRC_H
51 #define ALGO_CRC_H
52
53 #include <cfg/compiler.h>
54
55 #ifdef __cplusplus
56 extern "C" {
57 #endif /* __cplusplus */
58
59
60 /* CRC table */
61 extern const uint16_t crc16tab[256];
62
63
64 /**
65  * \brief Compute the updated CRC16 value for one octet (macro version)
66  *
67  * \note This version is only intended for old/broken compilers.
68  *       Use the inline function in new code.
69  *
70  * \param c New octet (range 0-255)
71  * \param oldcrc Previous CRC16 value (referenced twice, beware of side effects)
72  */
73 #define UPDCRC16(c, oldcrc) (crc16tab[((oldcrc) >> 8) ^ ((unsigned char)(c))] ^ ((oldcrc) << 8))
74
75
76 #ifdef INLINE
77 /**
78  * \brief Compute the updated CRC16 value for one octet (macro version)
79  */
80 INLINE uint16_t updcrc16(uint8_t c, uint16_t oldcrc)
81 {
82         return crc16tab[(oldcrc >> 8) ^ c] ^ (oldcrc << 8);
83 }
84 #endif // INLINE
85
86
87 /**
88  * This function implements the CRC 16 calculation on a buffer.
89  *
90  * \param crc  Current CRC16 value.
91  * \param buf  The buffer to perform CRC calculation on.
92  * \param len  The length of the Buffer.
93  *
94  * \return The updated CRC16 value.
95  */
96 extern uint16_t crc16(uint16_t crc, const void *buf, size_t len);
97
98 #ifdef __cplusplus
99 }
100 #endif /* __cplusplus */
101
102 #endif /* ALGO_CRC_H */