aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-11-29 00:48:52 -0500
committerMarti Bolivar <mbolivar@leaflabs.com>2012-04-11 16:56:52 -0400
commit626f742037878dfe67c3c133fc9768fa0c0e6d88 (patch)
tree3e7b3b93012404037af6f1ddf7e9db883fec0f9f
parentfc966dffb9840f73b74112e5ee121fc1443544d4 (diff)
downloadlibrambutan-626f742037878dfe67c3c133fc9768fa0c0e6d88.tar.gz
librambutan-626f742037878dfe67c3c133fc9768fa0c0e6d88.zip
boards.cpp: Remove implementation details from Doxygen comments.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
-rw-r--r--wirish/boards.cpp15
1 files changed, 9 insertions, 6 deletions
diff --git a/wirish/boards.cpp b/wirish/boards.cpp
index dd3f21d..5d5ecb5 100644
--- a/wirish/boards.cpp
+++ b/wirish/boards.cpp
@@ -27,9 +27,15 @@
/**
* @brief Generic board initialization routines.
*
- * By default, we bring up all Maple boards to 72MHz, clocked off the
- * PLL, driven by the 8MHz external crystal. AHB and APB2 are clocked
- * at 72MHz. APB1 is clocked at 36MHz.
+ * This file is mostly interesting for the init() function, which
+ * configures Flash, the core sytem clocks, and a variety of other
+ * available peripherals on the board so the rest of Wirish doesn't
+ * have to turn things on before using them.
+ *
+ * Prior to returning, init() calls boardInit(), which allows boards
+ * to perform any initialization they need to.
+ *
+ * Specifically how init() works varies across boards and MCUs.
*/
#include <wirish/boards.h>
@@ -82,9 +88,6 @@ static void setupFlash(void) {
* Clock setup. Note that some of this only takes effect if we're
* running bare metal and the bootloader hasn't done it for us
* already.
- *
- * If you change this function, you MUST change the file-level Doxygen
- * comment above.
*/
static void setupClocks() {
rcc_clk_init(RCC_CLKSRC_PLL, RCC_PLLSRC_HSE, RCC_PLLMUL_9);