jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: stm32: crc-v2 fix up markup for doxygen

Browse Source 
Eliminates errors, fixes groupings, adds missing groupings.
This commit is contained in:
Karl Palsson 2019-06-11 18:59:46 +00:00 committed by Karl Palsson
parent 7c0320bf21
commit 121d854841
2 changed files with 19 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
include/libopencm3/stm32/common/crc_common_all.h
View File

@ -43,6 +43,8 @@ specific memorymap.h header before including this header file.*/
/* Register definitions */ /* Register definitions */
/*****************************************************************************/ /*****************************************************************************/
/**@defgroup crc_registers CRC Registers
@{*/
/** CRC_DR Data register */ /** CRC_DR Data register */
#define CRC_DR MMIO32(CRC_BASE + 0x00) #define CRC_DR MMIO32(CRC_BASE + 0x00)
@ -51,6 +53,7 @@ specific memorymap.h header before including this header file.*/
/** CRC_CR Control register */ /** CRC_CR Control register */
#define CRC_CR MMIO32(CRC_BASE + 0x08) #define CRC_CR MMIO32(CRC_BASE + 0x08)
/*@}*/
/*****************************************************************************/ /*****************************************************************************/
/* Register values */ /* Register values */

38
include/libopencm3/stm32/common/crc_v2.h
View File

@ -27,11 +27,7 @@
The order of header inclusion is important. crc.h includes the device The order of header inclusion is important. crc.h includes the device
specific memorymap.h header before including this header file.*/ specific memorymap.h header before including this header file.*/
/** @cond */ #pragma once
#ifdef LIBOPENCM3_CRC_H
/** @endcond */
#ifndef LIBOPENCM3_CRC_V2_H
#define LIBOPENCM3_CRC_V2_H
/**@{*/ /**@{*/
@ -45,6 +41,8 @@
/* Register definitions */ /* Register definitions */
/*****************************************************************************/ /*****************************************************************************/
/** @addtogroup crc_registers CRC Registers
@{*/
/** CRC_DR Data register 8bit wide access */ /** CRC_DR Data register 8bit wide access */
#define CRC_DR8 MMIO8(CRC_BASE + 0x00) #define CRC_DR8 MMIO8(CRC_BASE + 0x00)
/** CRC_DR Data register 16bit wide access */ /** CRC_DR Data register 16bit wide access */
@ -55,6 +53,7 @@
/** CRC_POL CRC Polynomial */ /** CRC_POL CRC Polynomial */
#define CRC_POL MMIO32(CRC_BASE + 0x14) #define CRC_POL MMIO32(CRC_BASE + 0x14)
/**@}*/
/*****************************************************************************/ /*****************************************************************************/
/* Register values */ /* Register values */
@ -65,29 +64,31 @@
#define CRC_CR_REV_IN_SHIFT 5 #define CRC_CR_REV_IN_SHIFT 5
#define CRC_CR_REV_IN (3 << CRC_CR_REV_IN_SHIFT) #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_NONE (0 << CRC_CR_REV_IN_SHIFT)
#define CRC_CR_REV_IN_BYTE (1 << 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_HALF (2 << CRC_CR_REV_IN_SHIFT)
#define CRC_CR_REV_IN_WORD (3 << 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_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_32 (0 << CRC_CR_POLYSIZE_SHIFT)
#define CRC_CR_POLYSIZE_16 (1 << 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_8 (2 << CRC_CR_POLYSIZE_SHIFT)
#define CRC_CR_POLYSIZE_7 (3 << 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 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 */