summaryrefslogtreecommitdiffstats
path: root/include/osmocom/core
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-16 14:29:26 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-16 14:29:26 +0200
commit197a4ac06d2bb84c7fa3232f78a9e45f9d58e53e (patch)
tree3848175049dcb85ac639af83408acfe5adb8ff82 /include/osmocom/core
parentef7a44e33d52ab2e046efdd2535c9428796fc09e (diff)
[doc] Put CRC-16 and generic CRC code in one Doxygen module
.. and add missing API documentation bits Change-Id: I67119894bcbf8c779426a0272bae4c5ce1fbd1ed
Diffstat (limited to 'include/osmocom/core')
-rw-r--r--include/osmocom/core/crc16.h18
-rw-r--r--include/osmocom/core/crcXXgen.h.tpl2
-rw-r--r--include/osmocom/core/crcgen.h2
3 files changed, 14 insertions, 8 deletions
diff --git a/include/osmocom/core/crc16.h b/include/osmocom/core/crc16.h
index 52807af4..f2e77e4a 100644
--- a/include/osmocom/core/crc16.h
+++ b/include/osmocom/core/crc16.h
@@ -1,13 +1,16 @@
-/*! \file crc16.h
- * This was copied from the linux kernel and adjusted for our types.
+/*! \addtogroup crc
+ * @{
+ * \file crc16.h
+ * This was copied from the linux kernel and adjusted for our types.
*/
+
/*
* crc16.h - CRC-16 routine
*
* Implements the standard CRC-16:
- * Width 16
- * Poly 0x8005 (x^16 + x^15 + x^2 + 1)
- * Init 0
+ * - Width 16
+ * - Poly 0x8005 (x^16 + x^15 + x^2 + 1)
+ * - Init 0
*
* Copyright (c) 2005 Ben Gardner <bgardner@wabtec.com>
*
@@ -25,19 +28,22 @@ extern uint16_t const osmo_crc16_table[256];
extern uint16_t osmo_crc16(uint16_t crc, const uint8_t *buffer, size_t len);
+/*! CRC-16 polynome 0x8005 (x^16 + x^15 + x^2 + 1) */
static inline uint16_t osmo_crc16_byte(uint16_t crc, const uint8_t data)
{
return (crc >> 8) ^ osmo_crc16_table[(crc ^ data) & 0xff];
}
-/* CCITT polynome 0x8408. This corresponds to x^0 + x^5 + x^12 */
extern uint16_t const osmo_crc16_ccitt_table[256];
extern uint16_t osmo_crc16_ccitt(uint16_t crc, const uint8_t *buffer, size_t len);
+/*! CCITT polynome 0x8408 (x^0 + x^5 + x^12) */
static inline uint16_t osmo_crc16_ccitt_byte(uint16_t crc, const uint8_t data)
{
return (crc >> 8) ^ osmo_crc16_ccitt_table[(crc ^ data) & 0xff];
}
+
+/*! @} */
diff --git a/include/osmocom/core/crcXXgen.h.tpl b/include/osmocom/core/crcXXgen.h.tpl
index 2c909f92..823f21f2 100644
--- a/include/osmocom/core/crcXXgen.h.tpl
+++ b/include/osmocom/core/crcXXgen.h.tpl
@@ -22,7 +22,7 @@
#pragma once
-/*! \addtogroup crcgen
+/*! \addtogroup crc
* @{
* \file crcXXgen.h.tpl */
diff --git a/include/osmocom/core/crcgen.h b/include/osmocom/core/crcgen.h
index d73e6e80..7cfe8699 100644
--- a/include/osmocom/core/crcgen.h
+++ b/include/osmocom/core/crcgen.h
@@ -22,7 +22,7 @@
#pragma once
-/*! \defgroup crcgen Osmocom generic CRC routines
+/*! \defgroup crc Osmocom CRC routines
* @{
* \file crcgen.h */