doc: add all cm3 headers to doxygen.

Just get them all included as they are.  Gets them grouped up and
visible so we can start clarifying the rest of their docs.
This commit is contained in:
Karl Palsson 2018-09-09 15:21:02 +00:00
parent a21aeab3b1
commit 1ad2cda496
7 changed files with 41 additions and 4 deletions

View File

@ -1,4 +1,5 @@
/** @defgroup debugging Debugging
@ingroup CM3_defines
@brief Macros and functions to aid in debugging

View File

@ -20,6 +20,12 @@
#ifndef LIBOPENCM3_CM3_DWT_H
#define LIBOPENCM3_CM3_DWT_H
/**
* @defgroup cm_fpb Cortex-M Flash Patch and Breakpoint (FPB) unit
* @ingroup CM3_defines
* @{
*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/cm3/memorymap.h>
@ -149,4 +155,6 @@ uint32_t dwt_read_cycle_counter(void);
END_DECLS
/**@}*/
#endif /* LIBOPENCM3_CM3_DWT_H */

View File

@ -20,7 +20,11 @@
#ifndef LIBOPENCM3_CM3_FPB_H
#define LIBOPENCM3_CM3_FPB_H
/* Cortex-M3 Flash Patch and Breakpoint (FPB) unit */
/**
* @defgroup cm_fpb Cortex-M Flash Patch and Breakpoint (FPB) unit
* @ingroup CM3_defines
* @{
*/
/* Those defined only on ARMv7 and above */
#if !defined(__ARM_ARCH_7M__) && !defined(__ARM_ARCH_7EM__)
@ -84,4 +88,6 @@
#define FPB_COMP_ENABLE (1 << 0)
/**@}*/
#endif

View File

@ -20,7 +20,11 @@
#ifndef LIBOPENCM3_CM3_ITM_H
#define LIBOPENCM3_CM3_ITM_H
/* Cortex-M3 Instrumentation Trace Macrocell (ITM) */
/**
* @defgroup cm_itm Cortex-M Instrumentation Trace Macrocell (ITM)
* @ingroup CM3_defines
* @{
*/
/* Those defined only on ARMv7 and above */
#if !defined(__ARM_ARCH_7M__) && !defined(__ARM_ARCH_7EM__)
@ -85,4 +89,6 @@
#define ITM_TCR_TSENA (1 << 1)
#define ITM_TCR_ITMENA (1 << 0)
/**@}*/
#endif

View File

@ -21,6 +21,11 @@
#ifndef LIBOPENCM3_SCB_H
#define LIBOPENCM3_SCB_H
/**
* @defgroup cm_scb Cortex-M System Control Block
* @ingroup CM3_defines
* @{
*/
#include <libopencm3/cm3/memorymap.h>
#include <libopencm3/cm3/common.h>
@ -447,4 +452,6 @@ void scb_set_priority_grouping(uint32_t prigroup);
END_DECLS
/**@}*/
#endif

View File

@ -28,7 +28,9 @@
* Processors" for details on System Timer/SysTick.
*/
/*
/**
* @defgroup cm_scs Cortex-M System Control Space
* @ingroup CM3_defines
* The System Control Space (SCS) is a memory-mapped 4KB address space that
* provides 32-bit registers for configuration, status reporting and control.
* The SCS registers divide into the following groups:
@ -328,4 +330,5 @@
/* CoreSight Lock Access key, common for all */
#define SCS_LAR_KEY 0xC5ACCE55
/**@}*/
#endif

View File

@ -20,7 +20,11 @@
#ifndef LIBOPENCM3_CM3_TPIU_H
#define LIBOPENCM3_CM3_TPIU_H
/* Cortex-M3 Trace Port Interface Unit (TPIU) */
/**
* @defgroup cm_tpiu Cortex-M Trace Port Interface Unit (TPIU)
* @ingroup CM3_defines
* @{
*/
/* Those defined only on ARMv7 and above */
#if !defined(__ARM_ARCH_7M__) && !defined(__ARM_ARCH_7EM__)
@ -94,4 +98,6 @@
#define TPUI_DEVID_FIFO_SIZE_MASK (7 << 6)
/* Bits 5:0 - Implementation defined */
/**@}*/
#endif