From 668cfb2967c5aab4d4a24bfd11306e52e3aec074 Mon Sep 17 00:00:00 2001
From: Karl Palsson <karlp@etactica.com>
Date: Tue, 25 Jun 2019 13:31:50 +0000
Subject: [PATCH] doc: cm3: scb: add basic documentation

Adds a summary page, and now we have the existing functions documented.
---
 lib/cm3/scb.c | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/lib/cm3/scb.c b/lib/cm3/scb.c
index 8c5a2f3a..52f38e81 100644
--- a/lib/cm3/scb.c
+++ b/lib/cm3/scb.c
@@ -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
+
+/**@}*/
\ No newline at end of file