EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: stm32: flash: tidy up doxygen warnings and broken groupings

Browse Source
This commit is contained in:
Karl Palsson
2020-03-06 01:14:17 +00:00
parent 3df3ed7db9
commit b146fd6aa7
4 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
include/libopencm3/stm32/common/flash_common_f24.h
View File

@@ -61,12 +61,9 @@
#define FLASH_OPTCR1 MMIO32(FLASH_MEM_INTERFACE_BASE + 0x18) #define FLASH_OPTCR1 MMIO32(FLASH_MEM_INTERFACE_BASE + 0x18)
/*@}*/ /*@}*/
/** @defgroup flash_acr_values FLASH_ACR values /** @defgroup flash_latency FLASH Wait States
* @ingroup flash_registers @ingroup flash_defines
* @brief Access Control register values
@{*/ @{*/
#define FLASH_ACR_LATENCY_SHIFT 0
#define FLASH_ACR_LATENCY_MASK 0x0f
#define FLASH_ACR_LATENCY(w) ((w) & FLASH_ACR_LATENCY_MASK) #define FLASH_ACR_LATENCY(w) ((w) & FLASH_ACR_LATENCY_MASK)
#define FLASH_ACR_LATENCY_0WS 0x00 #define FLASH_ACR_LATENCY_0WS 0x00
#define FLASH_ACR_LATENCY_1WS 0x01 #define FLASH_ACR_LATENCY_1WS 0x01
@@ -76,8 +73,16 @@
#define FLASH_ACR_LATENCY_5WS 0x05 #define FLASH_ACR_LATENCY_5WS 0x05
#define FLASH_ACR_LATENCY_6WS 0x06 #define FLASH_ACR_LATENCY_6WS 0x06
#define FLASH_ACR_LATENCY_7WS 0x07 #define FLASH_ACR_LATENCY_7WS 0x07
#define FLASH_ACR_PRFTEN (1 << 8)
/*@}*/ /*@}*/
#define FLASH_ACR_LATENCY_SHIFT 0
#define FLASH_ACR_LATENCY_MASK 0x0f
/** @defgroup flash_acr_values FLASH_ACR values
* @ingroup flash_registers
* @brief Access Control register values
* @{*/
#define FLASH_ACR_PRFTEN (1 << 8)
/**@}*/
/* --- FLASH_SR values ----------------------------------------------------- */ /* --- FLASH_SR values ----------------------------------------------------- */

5
include/libopencm3/stm32/common/flash_common_idcache.h
View File

@@ -22,10 +22,15 @@
#include <libopencm3/stm32/flash.h> #include <libopencm3/stm32/flash.h>
/**@{*/ /**@{*/
/** @addtogroup flash_acr_values
* @{
*/
#define FLASH_ACR_DCRST (1 << 12) #define FLASH_ACR_DCRST (1 << 12)
#define FLASH_ACR_ICRST (1 << 11) #define FLASH_ACR_ICRST (1 << 11)
#define FLASH_ACR_DCEN (1 << 10) #define FLASH_ACR_DCEN (1 << 10)
#define FLASH_ACR_ICEN (1 << 9) #define FLASH_ACR_ICEN (1 << 9)
/**@}*/
BEGIN_DECLS BEGIN_DECLS

2
include/libopencm3/stm32/f3/flash.h
View File

@@ -65,7 +65,9 @@
#define FLASH_ACR_HLFCYA (1 << 3) #define FLASH_ACR_HLFCYA (1 << 3)
#define FLASH_ACR_LATENCY_SHIFT 0 #define FLASH_ACR_LATENCY_SHIFT 0
#define FLASH_ACR_LATENCY_MASK 0x0f #define FLASH_ACR_LATENCY_MASK 0x0f
/** @defgroup flash_latency FLASH Wait States @{*/
#define FLASH_ACR_LATENCY(w) ((w) & FLASH_ACR_LATENCY_MASK) #define FLASH_ACR_LATENCY(w) ((w) & FLASH_ACR_LATENCY_MASK)
/**@}*/
/* --- FLASH_SR values ----------------------------------------------------- */ /* --- FLASH_SR values ----------------------------------------------------- */

2
include/libopencm3/stm32/f7/flash.h
View File

@@ -53,7 +53,7 @@
/* --- FLASH_ACR values ---------------------------------------------------- */ /* --- FLASH_ACR values ---------------------------------------------------- */
/** @addtogroup flash_acr_values FLASH_ACR_VALUES /** @addtogroup flash_acr_values FLASH_ACR values
* @ingroup flash_registers * @ingroup flash_registers
@{*/ @{*/
#define FLASH_ACR_ARTRST (1 << 11) #define FLASH_ACR_ARTRST (1 << 11)