Sistema l'errore da me commesso in fase di conversione...
[bertos.git] / algos / 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 README.devlib 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.1  2007/06/07 09:09:41  batt
28  *#* Move crc routines to algos/.
29  *#*
30  *#* Revision 1.7  2006/07/19 12:56:27  bernie
31  *#* Convert to new Doxygen style.
32  *#*
33  *#* Revision 1.6  2005/11/04 16:20:02  bernie
34  *#* Fix reference to README.devlib in header.
35  *#*
36  *#* Revision 1.5  2005/04/11 19:10:28  bernie
37  *#* Include top-level headers from cfg/ subdir.
38  *#*
39  *#* Revision 1.4  2004/08/25 14:12:09  rasky
40  *#* Aggiornato il comment block dei log RCS
41  *#*
42  *#* Revision 1.3  2004/08/15 05:47:26  bernie
43  *#* updcrc16(): inline version of UPDCRC16(); Cleanup documentation.
44  *#*
45  *#* Revision 1.2  2004/06/03 11:27:09  bernie
46  *#* Add dual-license information.
47  *#*
48  *#* Revision 1.1  2004/06/03 08:58:16  bernie
49  *#* Import into DevLib
50  *#*
51  *#*/
52 #ifndef CRC_H
53 #define CRC_H
54
55 #include <cfg/compiler.h>
56
57 #ifdef __cplusplus
58 extern "C" {
59 #endif /* __cplusplus */
60
61
62 /* CRC table */
63 extern const uint16_t crc16tab[256];
64
65
66 /**
67  * \brief Compute the updated CRC16 value for one octet (macro version)
68  *
69  * \note This version is only intended for old/broken compilers.
70  *       Use the inline function in new code.
71  *
72  * \param c New octet (range 0-255)
73  * \param oldcrc Previous CRC16 value (referenced twice, beware of side effects)
74  */
75 #define UPDCRC16(c, oldcrc) (crc16tab[((oldcrc) >> 8) ^ ((unsigned char)(c))] ^ ((oldcrc) << 8))
76
77
78 #ifdef INLINE
79 /**
80  * \brief Compute the updated CRC16 value for one octet (macro version)
81  */
82 INLINE uint16_t updcrc16(uint8_t c, uint16_t oldcrc)
83 {
84         return crc16tab[(oldcrc >> 8) ^ c] ^ (oldcrc << 8);
85 }
86 #endif // INLINE
87
88
89 /**
90  * This function implements the CRC 16 calculation on a buffer.
91  *
92  * \param crc  Current CRC16 value.
93  * \param buf  The buffer to perform CRC calculation on.
94  * \param len  The length of the Buffer.
95  *
96  * \return The updated CRC16 value.
97  */
98 extern uint16_t crc16(uint16_t crc, const void *buf, size_t len);
99
100 #ifdef __cplusplus
101 }
102 #endif /* __cplusplus */
103
104 #endif /* CRC_H */