From 551dded11a77ca5ed84de2f8a9b4423e5e74186c Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Mon, 22 Aug 2011 22:10:14 -0400
Subject: stm32.h: Doxygen

---
 libmaple/stm32.h | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

(limited to 'libmaple')

diff --git a/libmaple/stm32.h b/libmaple/stm32.h
index d15a28b..6cf5ba4 100644
--- a/libmaple/stm32.h
+++ b/libmaple/stm32.h
@@ -25,12 +25,23 @@
  *****************************************************************************/
 
 /**
- *  @brief General STM32 chip-specific definitions
+ * @file stm32.h
+ * @brief STM32 chip-specific definitions
  */
 
 #ifndef _STM32_H_
 #define _STM32_H_
 
+/**
+ * \def PCLK1
+ * Clock speed of APB1 peripherals, in Hz.
+ */
+
+/**
+ * \def PCLK2
+ * Clock speed of APB2 peripherals, in Hz.
+ */
+
 #ifndef PCLK1
 #define PCLK1   36000000U
 #endif
@@ -38,6 +49,11 @@
 #define PCLK2   72000000U
 #endif
 
+/**
+ * \def NR_INTERRUPTS
+ * Number of interrupts in the NVIC.
+ */
+
 #ifdef STM32_MEDIUM_DENSITY
     #define NR_INTERRUPTS 43
 #else
@@ -48,6 +64,20 @@
 #endif
 #endif
 
+/**
+ * \def NR_GPIO_PORTS
+ * Number of GPIO ports
+ */
+
+/* SRAM_SIZE intentionally not part of Doxygen interface */
+
+/**
+ * \def DELAY_US_MULT
+ * Multiplier to convert microseconds into loop iterations in delay_us().
+ *
+ * @see delay_us()
+ */
+
 /* MCU-specific configuration */
 #if defined(MCU_STM32F103RB)
     /* e.g., LeafLabs Maple */
-- 
cgit v1.2.3