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

stm32: crc-v2: tweak doxygen output

Browse Source 
Make it group better and include labels
This commit is contained in:
Karl Palsson 2018-02-05 21:52:32 +00:00
parent 88ca8058aa
commit 316c33a6a3
4 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -43,13 +43,13 @@ specific memorymap.h header before including this header file.*/
/* Register definitions */ /* Register definitions */
/*****************************************************************************/ /*****************************************************************************/
/* Data register (CRC_DR) */ /** CRC_DR Data register */
#define CRC_DR MMIO32(CRC_BASE + 0x00) #define CRC_DR MMIO32(CRC_BASE + 0x00)
/* Independent data register (CRC_IDR) */ /** CRC_IDR Independent data register */
#define CRC_IDR MMIO32(CRC_BASE + 0x04) #define CRC_IDR MMIO32(CRC_BASE + 0x04)
/* Control register (CRC_CR) */ /** CRC_CR Control register */
#define CRC_CR MMIO32(CRC_BASE + 0x08) #define CRC_CR MMIO32(CRC_BASE + 0x08)
/*****************************************************************************/ /*****************************************************************************/
@ -66,12 +66,12 @@ specific memorymap.h header before including this header file.*/
/* Bits [7:0]: General-purpose 8-bit data register bits */ /* Bits [7:0]: General-purpose 8-bit data register bits */
/* --- CRC_CR values ------------------------------------------------------- */
/* Bits [31:1]: Reserved */ /** @defgroup crc_cr_values CRC_CR values
@{*/
/* RESET bit */ /** CRC_CR_RESET reset the CRC peripheral */
#define CRC_CR_RESET (1 << 0) #define CRC_CR_RESET (1 << 0)
/**@}*/
/*****************************************************************************/ /*****************************************************************************/
/* API definitions */ /* API definitions */

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

@ -45,20 +45,22 @@
/* Register definitions */ /* Register definitions */
/*****************************************************************************/ /*****************************************************************************/
/* Data register (CRC_DR) */ /** 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 */
#define CRC_DR16 MMIO16(CRC_BASE + 0x00) #define CRC_DR16 MMIO16(CRC_BASE + 0x00)
/* Initial CRC Value */ /** CRC_INIT Initial CRC Value */
#define CRC_INIT MMIO32(CRC_BASE + 0x10) #define CRC_INIT MMIO32(CRC_BASE + 0x10)
/* CRC Polynomial */ /** CRC_POL CRC Polynomial */
#define CRC_POL MMIO32(CRC_BASE + 0x14) #define CRC_POL MMIO32(CRC_BASE + 0x14)
/*****************************************************************************/ /*****************************************************************************/
/* Register values */ /* Register values */
/*****************************************************************************/ /*****************************************************************************/
/** @addtogroup crc_cr_values CRC_CR values
@{*/
#define CRC_CR_REV_OUT (1 << 7) #define CRC_CR_REV_OUT (1 << 7)
#define CRC_CR_REV_IN_SHIFT 5 #define CRC_CR_REV_IN_SHIFT 5
@ -77,6 +79,7 @@
/* Default polynomial */ /* Default polynomial */
#define CRC_POL_DEFAULT 0x04C11DB7 #define CRC_POL_DEFAULT 0x04C11DB7
/**@}*/
/*****************************************************************************/ /*****************************************************************************/
/* API definitions */ /* API definitions */

2
lib/stm32/common/crc_common_all.c
View File

@ -1,4 +1,4 @@
/** @addtogroup crc_file /** @addtogroup crc_file CRC
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@remake.is> @author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@remake.is>

2
lib/stm32/common/crc_v2.c
View File

@ -1,4 +1,4 @@
/** @addtogroup crc_defines /** @addtogroup crc_file CRC
@author @htmlonly &copy; @endhtmlonly 2016 Cem Basoglu <cem.basoglu@web.de> @author @htmlonly &copy; @endhtmlonly 2016 Cem Basoglu <cem.basoglu@web.de>