doc: cm3: scb: add basic documentation

Adds a summary page, and now we have the existing functions documented.
This commit is contained in:
Karl Palsson 2019-06-25 13:31:50 +00:00
parent e5b5ba0f9c
commit 668cfb2967
1 changed files with 22 additions and 0 deletions

View File

@ -1,3 +1,23 @@
/** @defgroup CM3_scb_file SCB
*
* @ingroup CM3_files
*
* @brief <b>libopencm3 Cortex-M System Control Block</b>
*
* The System Control Block (SCB) is a section of the System Control Space
* which provides status information and control features for the processor core.
* It allows, amongst other:
* * software reset control
* * exception management and grouping
* * fault information
* * power management
* * debug status information
*
* @see ARMv7m Architecture Reference Manual (Chapter B3.2.1 About the SCB)
*
* LGPL License Terms @ref lgpl_license
* @{
*/
/*
* This file is part of the libopencm3 project.
*
@ -45,3 +65,5 @@ void scb_set_priority_grouping(uint32_t prigroup)
SCB_AIRCR = SCB_AIRCR_VECTKEY | prigroup;
}
#endif
/**@}*/