diff options
author | Karl Palsson <karlp@etactica.com> | 2019-06-11 21:59:46 +0300 |
---|---|---|
committer | Karl Palsson <karlp@tweak.net.au> | 2019-06-13 02:06:22 +0300 |
commit | 121d854841763f57fe50920ac3a58d50614ac1bf (patch) | |
tree | 8d3929d20627790b3738ce0abac08d44facf451f /include/libopencm3/stm32/common/crc_v2.h | |
parent | 7c0320bf21a1a177cbee55af3f5cc1314ef59d31 (diff) |
doc: stm32: crc-v2 fix up markup for doxygen
Eliminates errors, fixes groupings, adds missing groupings.
Diffstat (limited to 'include/libopencm3/stm32/common/crc_v2.h')
-rw-r--r-- | include/libopencm3/stm32/common/crc_v2.h | 36 |
1 files changed, 15 insertions, 21 deletions
diff --git a/include/libopencm3/stm32/common/crc_v2.h b/include/libopencm3/stm32/common/crc_v2.h index 850dc252..515f7570 100644 --- a/include/libopencm3/stm32/common/crc_v2.h +++ b/include/libopencm3/stm32/common/crc_v2.h @@ -27,11 +27,7 @@ The order of header inclusion is important. crc.h includes the device specific memorymap.h header before including this header file.*/ -/** @cond */ -#ifdef LIBOPENCM3_CRC_H -/** @endcond */ -#ifndef LIBOPENCM3_CRC_V2_H -#define LIBOPENCM3_CRC_V2_H +#pragma once /**@{*/ @@ -45,6 +41,8 @@ /* Register definitions */ /*****************************************************************************/ +/** @addtogroup crc_registers CRC Registers +@{*/ /** CRC_DR Data register 8bit wide access */ #define CRC_DR8 MMIO8(CRC_BASE + 0x00) /** CRC_DR Data register 16bit wide access */ @@ -55,6 +53,7 @@ /** CRC_POL CRC Polynomial */ #define CRC_POL MMIO32(CRC_BASE + 0x14) +/**@}*/ /*****************************************************************************/ /* Register values */ @@ -65,29 +64,31 @@ #define CRC_CR_REV_IN_SHIFT 5 #define CRC_CR_REV_IN (3 << CRC_CR_REV_IN_SHIFT) +/** @defgroup crc_rev_in CRC Reverse input options + @{*/ #define CRC_CR_REV_IN_NONE (0 << CRC_CR_REV_IN_SHIFT) #define CRC_CR_REV_IN_BYTE (1 << CRC_CR_REV_IN_SHIFT) #define CRC_CR_REV_IN_HALF (2 << CRC_CR_REV_IN_SHIFT) #define CRC_CR_REV_IN_WORD (3 << CRC_CR_REV_IN_SHIFT) +/**@}*/ #define CRC_CR_POLYSIZE_SHIFT 3 -#define CRC_CR_POLYSIZE (3 << CRC_CR_POLYSIZE_SHIFT) +#define CRC_CR_POLYSIZE (3 << CRC_CR_POLYSIZE_SHIFT) +/** + * @defgroup crc_polysize CRC Polynomial size + * @{ + */ #define CRC_CR_POLYSIZE_32 (0 << CRC_CR_POLYSIZE_SHIFT) #define CRC_CR_POLYSIZE_16 (1 << CRC_CR_POLYSIZE_SHIFT) #define CRC_CR_POLYSIZE_8 (2 << CRC_CR_POLYSIZE_SHIFT) #define CRC_CR_POLYSIZE_7 (3 << CRC_CR_POLYSIZE_SHIFT) +/**@}*/ -/* Default polynomial */ -#define CRC_POL_DEFAULT 0x04C11DB7 /**@}*/ -/*****************************************************************************/ -/* API definitions */ -/*****************************************************************************/ +/** Default polynomial */ +#define CRC_POL_DEFAULT 0x04C11DB7 -/*****************************************************************************/ -/* API Functions */ -/*****************************************************************************/ BEGIN_DECLS @@ -104,10 +105,3 @@ END_DECLS /**@}*/ -#endif -/** @cond */ -#else -#warning "crc_v2.h should not be included explicitly, only via crc.h" -#endif -/** @endcond */ - |