From f36fae273ec84ee2c53a33caa2dddea2d79db0da Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Tue, 15 Nov 2011 12:45:43 -0500
Subject: Move public headers to include directories; related cleanups.

Move libmaple/*.h to (new) libmaple/include/libmaple/. The new
accepted way to include a libmaple header foo.h is with:

    #include <libmaple/foo.h>

This is more polite in terms of the include namespace. It also allows
us to e.g. implement the Arduino SPI library at all (which has header
SPI.h; providing it was previously impossible on case-insensitive
filesystems due to libmaple's spi.h).

Similarly for Wirish.

The old include style (#include "header.h") is now deprecated.

libmaple/*.h:

- Change include guard #defines from _FOO_H_ to _LIBMAPLE_FOO_H_.
- Add license headers where they're missing
- Add conditional extern "C" { ... } blocks where they're missing
  (they aren't always necessary, but we might was well do it against
  the future, while we're at it.).
- Change includes from #include "foo.h" to #include <libmaple/foo.h>.
- Move includes after extern "C".
- Remove extra trailing newlines

Note that this doesn't include the headers under libmaple/usb/ or
libmaple/usb/usb_lib. These will get fixed later.

libmaple/*.c:

- Change includes from #include "foo.h" to #include <libmaple/foo.h>.

Makefile:

- Add I$(LIBMAPLE_PATH)/include/libmaple to GLOBAL_FLAGS.  This allows
  for users (including Wirish) to migrate their code, but should go
  away ASAP, since it slows down compilation.

Wirish:

- Move wirish/**/*.h to (new) wirish/include/wirish/.  This ignores
  the USB headers, which, as usual, are getting handled after
  everything else.

- Similarly generify wirish/boards/ structure. For each supported
  board "foo", move wirish/boards/foo.h and wirish/boards/foo.cpp to
  wirish/boards/foo/include/board/board.h and
  wirish/boards/foo/board.cpp, respectively. Also remove the #ifdef
  hacks around the .cpp files.

- wirish/rules.mk: put wirish/boards/foo/include in the include path
  (and add wirish/boards/foo/board.cpp to the list of sources to be
  compiled). This allows saying:

      #include <board/board.h>

  instead of the hack currently in place. We can allow the user to
  override this setting later to make adding custom board definitions
  easier.

- Disable -Werror in libmaple/rules.mk, as the current USB warnings
  don't let the olimex_stm32_h103 board compile. We can re-enable
  -Werror once we've moved the board-specific bits out of libmaple
  proper.

libraries, examples:

- Update includes accordingly.
- Miscellaneous cosmetic fixups.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
---
 examples/test-usart-dma.cpp | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'examples/test-usart-dma.cpp')

diff --git a/examples/test-usart-dma.cpp b/examples/test-usart-dma.cpp
index 5ff5b86..8fbcccb 100644
--- a/examples/test-usart-dma.cpp
+++ b/examples/test-usart-dma.cpp
@@ -19,11 +19,11 @@
  * This code is released into the public domain.
  */
 
-#include "dma.h"
-#include "usart.h"
-#include "gpio.h"
+#include <libmaple/dma.h>
+#include <libmaple/usart.h>
+#include <libmaple/gpio.h>
 
-#include "wirish.h"
+#include <wirish/wirish.h>
 
 #define BAUD 9600
 
-- 
cgit v1.2.3


From b5c11895b59fbfdc6dda9d26e02df053f8035ff2 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Tue, 8 May 2012 16:22:41 -0400
Subject: Fix a bunch of Doxygen file-level comments.

Fix @file in many places. Also fix up the descriptions where it's
appropriate. This standardizes the @file formatting across the library
to explicitly include any parent directories up to the repository
root.

Besides being nice, this will hopefully let us manage Doxygen's XML
output so as to make extracting series-specific pieces via Breathe in
the leaflabs-docs repo possible.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
---
 examples/test-usart-dma.cpp                | 2 +-
 libmaple/dac.c                             | 2 +-
 libmaple/exti.c                            | 2 +-
 libmaple/gpio.c                            | 2 +-
 libmaple/i2c.c                             | 2 +-
 libmaple/include/libmaple/adc.h            | 2 +-
 libmaple/include/libmaple/bitband.h        | 2 +-
 libmaple/include/libmaple/bkp.h            | 2 +-
 libmaple/include/libmaple/dac.h            | 2 +-
 libmaple/include/libmaple/delay.h          | 2 +-
 libmaple/include/libmaple/exti.h           | 2 +-
 libmaple/include/libmaple/fsmc.h           | 2 +-
 libmaple/include/libmaple/gpio.h           | 2 +-
 libmaple/include/libmaple/i2c.h            | 2 +-
 libmaple/include/libmaple/iwdg.h           | 2 +-
 libmaple/include/libmaple/libmaple.h       | 2 +-
 libmaple/include/libmaple/libmaple_types.h | 2 +-
 libmaple/include/libmaple/nvic.h           | 2 +-
 libmaple/include/libmaple/pwr.h            | 4 ++--
 libmaple/include/libmaple/rcc.h            | 2 +-
 libmaple/include/libmaple/scb.h            | 2 +-
 libmaple/include/libmaple/spi.h            | 2 +-
 libmaple/include/libmaple/systick.h        | 3 +--
 libmaple/include/libmaple/timer.h          | 2 +-
 libmaple/include/libmaple/usart.h          | 2 +-
 libmaple/include/libmaple/usb_cdcacm.h     | 2 +-
 libmaple/include/libmaple/util.h           | 2 +-
 libmaple/iwdg.c                            | 2 +-
 libmaple/nvic.c                            | 2 +-
 libmaple/pwr.c                             | 2 +-
 libmaple/stm32f1/adc.c                     | 4 ++--
 libmaple/stm32f1/bkp.c                     | 4 ++--
 libmaple/stm32f1/fsmc.c                    | 2 +-
 libmaple/stm32f1/gpio.c                    | 2 +-
 libmaple/stm32f1/include/series/adc.h      | 2 +-
 libmaple/stm32f1/include/series/flash.h    | 2 +-
 libmaple/stm32f1/include/series/gpio.h     | 8 +++++---
 libmaple/stm32f1/include/series/pwr.h      | 2 +-
 libmaple/stm32f1/include/series/rcc.h      | 4 ++--
 libmaple/stm32f1/include/series/stm32.h    | 2 +-
 libmaple/stm32f1/include/series/timer.h    | 4 ++--
 libmaple/stm32f1/include/series/usart.h    | 4 ++--
 libmaple/stm32f1/rcc.c                     | 2 +-
 libmaple/stm32f1/spi.c                     | 2 +-
 libmaple/stm32f1/timer.c                   | 2 +-
 libmaple/stm32f1/usart.c                   | 2 +-
 libmaple/stm32f2/adc.c                     | 4 ++--
 libmaple/stm32f2/fsmc.c                    | 2 +-
 libmaple/stm32f2/gpio.c                    | 2 +-
 libmaple/stm32f2/include/series/adc.h      | 4 ++--
 libmaple/stm32f2/include/series/flash.h    | 2 +-
 libmaple/stm32f2/include/series/gpio.h     | 4 ++--
 libmaple/stm32f2/include/series/pwr.h      | 2 +-
 libmaple/stm32f2/include/series/rcc.h      | 2 +-
 libmaple/stm32f2/include/series/stm32.h    | 2 +-
 libmaple/stm32f2/include/series/timer.h    | 4 ++--
 libmaple/stm32f2/include/series/usart.h    | 4 ++--
 libmaple/stm32f2/rcc.c                     | 2 +-
 libmaple/stm32f2/timer.c                   | 2 +-
 libmaple/stm32f2/usart.c                   | 2 +-
 libmaple/syscalls.c                        | 8 +++++---
 libmaple/systick.c                         | 4 ++--
 libmaple/usart.c                           | 4 ++--
 libmaple/usb/usb.c                         | 4 +++-
 libmaple/usb/usb_cdcacm.c                  | 8 +++++---
 libmaple/util.c                            | 2 +-
 wirish/HardwareSerial.cpp                  | 2 +-
 wirish/boards.cpp                          | 2 +-
 wirish/ext_interrupts.cpp                  | 5 ++---
 wirish/include/wirish/HardwareSPI.h        | 2 +-
 wirish/include/wirish/HardwareSerial.h     | 2 +-
 wirish/include/wirish/boards.h             | 4 ++--
 wirish/include/wirish/ext_interrupts.h     | 5 ++---
 wirish/include/wirish/io.h                 | 5 ++---
 wirish/include/wirish/pwm.h                | 5 ++---
 wirish/include/wirish/wirish_debug.h       | 2 +-
 wirish/include/wirish/wirish_math.h        | 4 ++--
 wirish/include/wirish/wirish_time.h        | 2 +-
 wirish/include/wirish/wirish_types.h       | 2 +-
 79 files changed, 112 insertions(+), 109 deletions(-)

(limited to 'examples/test-usart-dma.cpp')

diff --git a/examples/test-usart-dma.cpp b/examples/test-usart-dma.cpp
index 8fbcccb..10ebe8b 100644
--- a/examples/test-usart-dma.cpp
+++ b/examples/test-usart-dma.cpp
@@ -1,5 +1,5 @@
 /**
- * @file test-usart-dma.cpp
+ * @file examples/test-usart-dma.cpp
  * @author Marti Bolivar <mbolivar@leaflabs.com>
  *
  * Simple test of DMA used with a USART receiver.
diff --git a/libmaple/dac.c b/libmaple/dac.c
index efcba15..f630ac0 100644
--- a/libmaple/dac.c
+++ b/libmaple/dac.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file dac.c
+ * @file libmaple/dac.c
  * @brief Digital to analog converter support.
  */
 
diff --git a/libmaple/exti.c b/libmaple/exti.c
index 00e0df2..248c4b6 100644
--- a/libmaple/exti.c
+++ b/libmaple/exti.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file exti.c
+ * @file libmaple/exti.c
  * @brief External interrupt control routines
  */
 
diff --git a/libmaple/gpio.c b/libmaple/gpio.c
index 64b2d54..898007a 100644
--- a/libmaple/gpio.c
+++ b/libmaple/gpio.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file gpio.c
+ * @file libmaple/gpio.c
  * @brief Generic STM32 GPIO support.
  */
 
diff --git a/libmaple/i2c.c b/libmaple/i2c.c
index ae44532..3eca22a 100644
--- a/libmaple/i2c.c
+++ b/libmaple/i2c.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file i2c.c
+ * @file libmaple/i2c.c
  * @brief Inter-Integrated Circuit (I2C) support.
  *
  * Currently, only master mode is supported.
diff --git a/libmaple/include/libmaple/adc.h b/libmaple/include/libmaple/adc.h
index 3cd3eb2..8d2f398 100644
--- a/libmaple/include/libmaple/adc.h
+++ b/libmaple/include/libmaple/adc.h
@@ -26,7 +26,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/adc.h
+ * @file libmaple/include/libmaple/adc.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
  *         Perry Hung <perry@leaflabs.com>
  * @brief Analog-to-Digital Conversion (ADC) header.
diff --git a/libmaple/include/libmaple/bitband.h b/libmaple/include/libmaple/bitband.h
index 607e4eb..0980311 100644
--- a/libmaple/include/libmaple/bitband.h
+++ b/libmaple/include/libmaple/bitband.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file bitband.h
+ * @file libmaple/include/libmaple/bitband.h
  *
  * @brief Bit-banding utility functions
  */
diff --git a/libmaple/include/libmaple/bkp.h b/libmaple/include/libmaple/bkp.h
index edc1013..bb63a2f 100644
--- a/libmaple/include/libmaple/bkp.h
+++ b/libmaple/include/libmaple/bkp.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file bkp.h
+ * @file libmaple/include/libmaple/bkp.h
  * @brief Backup register support (STM32F1 only).
  */
 
diff --git a/libmaple/include/libmaple/dac.h b/libmaple/include/libmaple/dac.h
index 9bd74b4..047f874 100644
--- a/libmaple/include/libmaple/dac.h
+++ b/libmaple/include/libmaple/dac.h
@@ -26,7 +26,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/dac.h
+ * @file libmaple/include/libmaple/dac.h
  * @brief Digital to analog converter support.
  */
 
diff --git a/libmaple/include/libmaple/delay.h b/libmaple/include/libmaple/delay.h
index f79655d..472a208 100644
--- a/libmaple/include/libmaple/delay.h
+++ b/libmaple/include/libmaple/delay.h
@@ -26,7 +26,7 @@
  *****************************************************************************/
 
 /**
- * @file delay.h
+ * @file libmaple/include/libmaple/delay.h
  * @brief Delay implementation
  */
 
diff --git a/libmaple/include/libmaple/exti.h b/libmaple/include/libmaple/exti.h
index 0a763d7..d7bfe51 100644
--- a/libmaple/include/libmaple/exti.h
+++ b/libmaple/include/libmaple/exti.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file exti.h
+ * @file libmaple/include/libmaple/exti.h
  * @brief External interrupt control prototypes and defines
  */
 
diff --git a/libmaple/include/libmaple/fsmc.h b/libmaple/include/libmaple/fsmc.h
index df211b2..01a6a3b 100644
--- a/libmaple/include/libmaple/fsmc.h
+++ b/libmaple/include/libmaple/fsmc.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file fsmc.h
+ * @file libmaple/include/libmaple/fsmc.h
  * @brief Flexible static memory controller support.
  */
 
diff --git a/libmaple/include/libmaple/gpio.h b/libmaple/include/libmaple/gpio.h
index 609320f..f7773c0 100644
--- a/libmaple/include/libmaple/gpio.h
+++ b/libmaple/include/libmaple/gpio.h
@@ -25,7 +25,7 @@
 *****************************************************************************/
 
 /**
- * @file gpio.h
+ * @file libmaple/include/libmaple/gpio.h
  * @brief General Purpose I/O (GPIO) interace.
  */
 
diff --git a/libmaple/include/libmaple/i2c.h b/libmaple/include/libmaple/i2c.h
index 8a1485e..ffd0cfb 100644
--- a/libmaple/include/libmaple/i2c.h
+++ b/libmaple/include/libmaple/i2c.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file i2c.h
+ * @file libmaple/include/libmaple/i2c.h
  * @brief Inter-Integrated Circuit (I2C) peripheral support
  */
 
diff --git a/libmaple/include/libmaple/iwdg.h b/libmaple/include/libmaple/iwdg.h
index 80202d2..0aef8fd 100644
--- a/libmaple/include/libmaple/iwdg.h
+++ b/libmaple/include/libmaple/iwdg.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/iwdg.h
+ * @file libmaple/include/libmaple/iwdg.h
  * @author Michael Hope, Marti Bolivar <mbolivar@leaflabs.com>
  * @brief Independent watchdog support.
  *
diff --git a/libmaple/include/libmaple/libmaple.h b/libmaple/include/libmaple/libmaple.h
index 60b23ed..f1a595e 100644
--- a/libmaple/include/libmaple/libmaple.h
+++ b/libmaple/include/libmaple/libmaple.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- *  @file libmaple.h
+ *  @file libmaple/include/libmaple/libmaple.h
  *  @brief General include file for libmaple
  */
 
diff --git a/libmaple/include/libmaple/libmaple_types.h b/libmaple/include/libmaple/libmaple_types.h
index 0a83795..0c22792 100644
--- a/libmaple/include/libmaple/libmaple_types.h
+++ b/libmaple/include/libmaple/libmaple_types.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- *  @file libmaple_types.h
+ *  @file libmaple/include/libmaple/libmaple_types.h
  *
  *  @brief libmaple's types, and operations on types.
  */
diff --git a/libmaple/include/libmaple/nvic.h b/libmaple/include/libmaple/nvic.h
index 1a1a4ed..86ac1cb 100644
--- a/libmaple/include/libmaple/nvic.h
+++ b/libmaple/include/libmaple/nvic.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file nvic.h
+ * @file libmaple/include/libmaple/nvic.h
  * @brief Nested vectored interrupt controller support.
  *
  * Basic usage:
diff --git a/libmaple/include/libmaple/pwr.h b/libmaple/include/libmaple/pwr.h
index 2611587..e4b5b0d 100644
--- a/libmaple/include/libmaple/pwr.h
+++ b/libmaple/include/libmaple/pwr.h
@@ -25,8 +25,8 @@
  *****************************************************************************/
 
 /**
- * @file pwr.h
- * @brief Power control (PWR) defines.
+ * @file libmaple/include/libmaple/pwr.h
+ * @brief Power control (PWR).
  */
 
 #ifndef _LIBMAPLE_PWR_H_
diff --git a/libmaple/include/libmaple/rcc.h b/libmaple/include/libmaple/rcc.h
index b04f016..7c23f1b 100644
--- a/libmaple/include/libmaple/rcc.h
+++ b/libmaple/include/libmaple/rcc.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/rcc.h
+ * @file libmaple/include/libmaple/rcc.h
  * @brief Reset and Clock Control (RCC) interface.
  */
 
diff --git a/libmaple/include/libmaple/scb.h b/libmaple/include/libmaple/scb.h
index 9c4ee15..1c7c5d7 100644
--- a/libmaple/include/libmaple/scb.h
+++ b/libmaple/include/libmaple/scb.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file scb.h
+ * @file libmaple/include/libmaple/scb.h
  * @brief System control block header
  */
 
diff --git a/libmaple/include/libmaple/spi.h b/libmaple/include/libmaple/spi.h
index 5b045a9..3805b2e 100644
--- a/libmaple/include/libmaple/spi.h
+++ b/libmaple/include/libmaple/spi.h
@@ -26,7 +26,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/spi.h
+ * @file libmaple/include/libmaple/spi.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
  * @brief Serial Peripheral Interface (SPI) and Integrated
  *        Interchip Sound (I2S) peripheral support.
diff --git a/libmaple/include/libmaple/systick.h b/libmaple/include/libmaple/systick.h
index 1731c85..551f800 100644
--- a/libmaple/include/libmaple/systick.h
+++ b/libmaple/include/libmaple/systick.h
@@ -25,8 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file systick.h
- *
+ * @file libmaple/include/libmaple/systick.h
  * @brief System timer definitions
  */
 
diff --git a/libmaple/include/libmaple/timer.h b/libmaple/include/libmaple/timer.h
index 0a34066..887b7eb 100644
--- a/libmaple/include/libmaple/timer.h
+++ b/libmaple/include/libmaple/timer.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file   libmaple/timer.h
+ * @file   libmaple/include/libmaple/timer.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
  * @brief  Timer interface.
  */
diff --git a/libmaple/include/libmaple/usart.h b/libmaple/include/libmaple/usart.h
index 42f9576..ad7eb51 100644
--- a/libmaple/include/libmaple/usart.h
+++ b/libmaple/include/libmaple/usart.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file usart.h
+ * @file libmaple/include/libmaple/usart.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
  *         Perry Hung <perry@leaflabs.com>
  * @brief USART definitions and prototypes
diff --git a/libmaple/include/libmaple/usb_cdcacm.h b/libmaple/include/libmaple/usb_cdcacm.h
index 2dbcbea..9d70758 100644
--- a/libmaple/include/libmaple/usb_cdcacm.h
+++ b/libmaple/include/libmaple/usb_cdcacm.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file usb_cdcacm.h
+ * @file libmaple/include/libmaple/usb_cdcacm.h
  * @brief USB CDC ACM (virtual serial terminal) support
  */
 
diff --git a/libmaple/include/libmaple/util.h b/libmaple/include/libmaple/util.h
index 78bc03d..60ca0d3 100644
--- a/libmaple/include/libmaple/util.h
+++ b/libmaple/include/libmaple/util.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file util.h
+ * @file libmaple/include/libmaple/util.h
  * @brief Miscellaneous utility macros and procedures.
  */
 
diff --git a/libmaple/iwdg.c b/libmaple/iwdg.c
index 6dd77fc..2456235 100644
--- a/libmaple/iwdg.c
+++ b/libmaple/iwdg.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file iwdg.c
+ * @file libmaple/iwdg.c
  * @brief Independent watchdog (IWDG) support
  */
 
diff --git a/libmaple/nvic.c b/libmaple/nvic.c
index e3f79a3..fe7c7bc 100644
--- a/libmaple/nvic.c
+++ b/libmaple/nvic.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file nvic.c
+ * @file libmaple/nvic.c
  * @brief Nested vector interrupt controller support.
  */
 
diff --git a/libmaple/pwr.c b/libmaple/pwr.c
index f934269..3cf170f 100644
--- a/libmaple/pwr.c
+++ b/libmaple/pwr.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file pwr.c
+ * @file libmaple/pwr.c
  * @brief Power control (PWR) support.
  */
 
diff --git a/libmaple/stm32f1/adc.c b/libmaple/stm32f1/adc.c
index 794c5c8..facc6bd 100644
--- a/libmaple/stm32f1/adc.c
+++ b/libmaple/stm32f1/adc.c
@@ -26,10 +26,10 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f1/include/series/adc.c
+ * @file libmaple/stm32f1/adc.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
  *         Perry Hung <perry@leaflabs.com>
- * @brief STM32F1-specific ADC support.
+ * @brief STM32F1 ADC support.
  */
 
 #include <libmaple/adc.h>
diff --git a/libmaple/stm32f1/bkp.c b/libmaple/stm32f1/bkp.c
index 62783e7..f435ff1 100644
--- a/libmaple/stm32f1/bkp.c
+++ b/libmaple/stm32f1/bkp.c
@@ -25,8 +25,8 @@
  *****************************************************************************/
 
 /**
- * @file bkp.c
- * @brief Backup register support.
+ * @file libmaple/stm32f1/bkp.c
+ * @brief STM32F1 Backup register support.
  */
 
 #include <libmaple/bkp.h>
diff --git a/libmaple/stm32f1/fsmc.c b/libmaple/stm32f1/fsmc.c
index 8e01b5e..210f0be 100644
--- a/libmaple/stm32f1/fsmc.c
+++ b/libmaple/stm32f1/fsmc.c
@@ -26,7 +26,7 @@
  *****************************************************************************/
 
 /**
- * @file stm32f1/fsmc.c
+ * @file libmaple/stm32f1/fsmc.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
  *         Bryan Newbold <bnewbold@robocracy.org>
  * @brief STM32F1 FSMC support.
diff --git a/libmaple/stm32f1/gpio.c b/libmaple/stm32f1/gpio.c
index 01a4028..2cbe299 100644
--- a/libmaple/stm32f1/gpio.c
+++ b/libmaple/stm32f1/gpio.c
@@ -26,7 +26,7 @@
 
 /**
  * @file libmaple/stm32f1/gpio.c
- * @brief GPIO support for STM32F1 line.
+ * @brief STM32F1 GPIO support.
  */
 
 #include <libmaple/gpio.h>
diff --git a/libmaple/stm32f1/include/series/adc.h b/libmaple/stm32f1/include/series/adc.h
index 007641a..774c97c 100644
--- a/libmaple/stm32f1/include/series/adc.h
+++ b/libmaple/stm32f1/include/series/adc.h
@@ -26,7 +26,7 @@
  *****************************************************************************/
 
 /**
- * @file stm32f1/include/series/adc.h
+ * @file libmaple/stm32f1/include/series/adc.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
  *         Perry Hung <perry@leaflabs.com>
  * @brief STM32F1 ADC header.
diff --git a/libmaple/stm32f1/include/series/flash.h b/libmaple/stm32f1/include/series/flash.h
index 5603176..0c70986 100644
--- a/libmaple/stm32f1/include/series/flash.h
+++ b/libmaple/stm32f1/include/series/flash.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f1/flash.h
+ * @file libmaple/stm32f1/include/series/flash.h
  * @brief STM32F1 Flash header.
  *
  * Provides register map, base pointer, and register bit definitions
diff --git a/libmaple/stm32f1/include/series/gpio.h b/libmaple/stm32f1/include/series/gpio.h
index c10244d..1f209fe 100644
--- a/libmaple/stm32f1/include/series/gpio.h
+++ b/libmaple/stm32f1/include/series/gpio.h
@@ -26,9 +26,11 @@
 *****************************************************************************/
 
 /**
- *  @file libmaple/stm32f1/gpio.h
- *  @brief General purpose I/O (GPIO) and Alternate Function I/O
- *         (AFIO) prototypes, defines, and inlined access functions.
+ * @file libmaple/stm32f1/include/series/gpio.h
+ * @brief STM32F1 GPIO support.
+ *
+ * General purpose I/O (GPIO) and Alternate Function I/O (AFIO)
+ * prototypes, defines, and support functions.
  */
 
 #ifndef _LIBMAPLE_STM32F1_GPIO_H_
diff --git a/libmaple/stm32f1/include/series/pwr.h b/libmaple/stm32f1/include/series/pwr.h
index d13ffa7..e143a8c 100644
--- a/libmaple/stm32f1/include/series/pwr.h
+++ b/libmaple/stm32f1/include/series/pwr.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file stm32f1/pwr.h
+ * @file libmaple/stm32f1/include/series/pwr.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
  * @brief STM32F1 Power control (PWR) support.
  */
diff --git a/libmaple/stm32f1/include/series/rcc.h b/libmaple/stm32f1/include/series/rcc.h
index f60b07b..3e7f7c6 100644
--- a/libmaple/stm32f1/include/series/rcc.h
+++ b/libmaple/stm32f1/include/series/rcc.h
@@ -26,8 +26,8 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f1/rcc.h
- * @brief STM32F1 reset and clock control (RCC) header.
+ * @file libmaple/stm32f1/include/series/rcc.h
+ * @brief STM32F1 reset and clock control (RCC) support.
  */
 
 #ifndef _LIBMAPLE_STM32F1_RCC_H_
diff --git a/libmaple/stm32f1/include/series/stm32.h b/libmaple/stm32f1/include/series/stm32.h
index 999abab..e6d3b19 100644
--- a/libmaple/stm32f1/include/series/stm32.h
+++ b/libmaple/stm32f1/include/series/stm32.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f1/stm32.h
+ * @file libmaple/stm32f1/include/series/stm32.h
  * @brief STM32F1 chip- and series-specific definitions.
  */
 
diff --git a/libmaple/stm32f1/include/series/timer.h b/libmaple/stm32f1/include/series/timer.h
index 2551f70..8a64ffa 100644
--- a/libmaple/stm32f1/include/series/timer.h
+++ b/libmaple/stm32f1/include/series/timer.h
@@ -25,9 +25,9 @@
  *****************************************************************************/
 
 /**
- * @file   stm32f1/include/series/timer.h
+ * @file   libmaple/stm32f1/include/series/timer.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief  STM32F1 timer sub-header.
+ * @brief  STM32F1 timer support.
  */
 
 #ifndef _LIBMAPLE_STM32F1_TIMER_H_
diff --git a/libmaple/stm32f1/include/series/usart.h b/libmaple/stm32f1/include/series/usart.h
index 93a7728..d12a3e2 100644
--- a/libmaple/stm32f1/include/series/usart.h
+++ b/libmaple/stm32f1/include/series/usart.h
@@ -25,9 +25,9 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f1/usart.h
+ * @file libmaple/stm32f1/include/series/usart.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F1 USART header.
+ * @brief STM32F1 USART support.
  */
 
 #ifndef _LIBMAPLE_STM32F1_USART_H_
diff --git a/libmaple/stm32f1/rcc.c b/libmaple/stm32f1/rcc.c
index aeedf66..ca81755 100644
--- a/libmaple/stm32f1/rcc.c
+++ b/libmaple/stm32f1/rcc.c
@@ -27,7 +27,7 @@
 
 /**
  * @file libmaple/stm32f1/rcc.c
- * @brief STM32F1 RCC routines.
+ * @brief STM32F1 RCC.
  */
 
 #include <libmaple/rcc.h>
diff --git a/libmaple/stm32f1/spi.c b/libmaple/stm32f1/spi.c
index 45ff354..8b6e495 100644
--- a/libmaple/stm32f1/spi.c
+++ b/libmaple/stm32f1/spi.c
@@ -28,7 +28,7 @@
 /**
  * @file libmaple/stm32f1/spi.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F1 SPI/I2S support.
+ * @brief STM32F1 SPI/I2S.
  */
 
 #include <libmaple/spi.h>
diff --git a/libmaple/stm32f1/timer.c b/libmaple/stm32f1/timer.c
index 899abbc..002b9d6 100644
--- a/libmaple/stm32f1/timer.c
+++ b/libmaple/stm32f1/timer.c
@@ -27,7 +27,7 @@
 /**
  * @file   libmaple/stm32f1/timer.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief  STM32F1 timer support.
+ * @brief  STM32F1 timer.
  */
 
 /* Notes:
diff --git a/libmaple/stm32f1/usart.c b/libmaple/stm32f1/usart.c
index ee68082..eed420e 100644
--- a/libmaple/stm32f1/usart.c
+++ b/libmaple/stm32f1/usart.c
@@ -29,7 +29,7 @@
  * @file libmaple/stm32f1/usart.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
  *         Perry Hung <perry@leaflabs.com>
- * @brief STM32F1 USART support.
+ * @brief STM32F1 USART.
  */
 
 #include <libmaple/usart.h>
diff --git a/libmaple/stm32f2/adc.c b/libmaple/stm32f2/adc.c
index a4c227e..0380736 100644
--- a/libmaple/stm32f2/adc.c
+++ b/libmaple/stm32f2/adc.c
@@ -25,8 +25,8 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f2/include/series/adc.c
- * @brief STM32F2 ADC header.
+ * @file libmaple/stm32f2/adc.c
+ * @brief STM32F2 ADC.
  */
 
 #include <libmaple/adc.h>
diff --git a/libmaple/stm32f2/fsmc.c b/libmaple/stm32f2/fsmc.c
index 9b23eea..7f49cd8 100644
--- a/libmaple/stm32f2/fsmc.c
+++ b/libmaple/stm32f2/fsmc.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file stm32f2/fsmc.c
+ * @file libmaple/stm32f2/fsmc.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
  * @brief STM32F2 FSMC support.
  */
diff --git a/libmaple/stm32f2/gpio.c b/libmaple/stm32f2/gpio.c
index e441fbc..7479922 100644
--- a/libmaple/stm32f2/gpio.c
+++ b/libmaple/stm32f2/gpio.c
@@ -26,7 +26,7 @@
 
 /**
  * @file libmaple/stm32f2/gpio.c
- * @brief GPIO support for STM32F2 line.
+ * @brief STM32F2 GPIO.
  */
 
 #include <libmaple/gpio.h>
diff --git a/libmaple/stm32f2/include/series/adc.h b/libmaple/stm32f2/include/series/adc.h
index 4f0cd6b..714179c 100644
--- a/libmaple/stm32f2/include/series/adc.h
+++ b/libmaple/stm32f2/include/series/adc.h
@@ -25,9 +25,9 @@
  *****************************************************************************/
 
 /**
- * @file stm32f2/include/series/adc.h
+ * @file libmaple/stm32f2/include/series/adc.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
- * @brief STM32F2 ADC header.
+ * @brief STM32F2 ADC support.
  */
 
 #ifndef _LIBMAPLE_STM32F2_ADC_H_
diff --git a/libmaple/stm32f2/include/series/flash.h b/libmaple/stm32f2/include/series/flash.h
index f48eea3..cfc6e6b 100644
--- a/libmaple/stm32f2/include/series/flash.h
+++ b/libmaple/stm32f2/include/series/flash.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f2/flash.h
+ * @file libmaple/stm32f2/include/series/flash.h
  * @brief STM32F2 Flash header.
  *
  * Provides register map, base pointer, and register bit definitions
diff --git a/libmaple/stm32f2/include/series/gpio.h b/libmaple/stm32f2/include/series/gpio.h
index 40c7292..9687247 100644
--- a/libmaple/stm32f2/include/series/gpio.h
+++ b/libmaple/stm32f2/include/series/gpio.h
@@ -25,8 +25,8 @@
 *****************************************************************************/
 
 /**
- * @file libmaple/stm32f2/gpio.h
- * @brief STM32F2 General Purpose I/O (GPIO) header.
+ * @file libmaple/stm32f2/include/series/gpio.h
+ * @brief STM32F2 GPIO support.
  */
 
 #ifndef _LIBMAPLE_STM32F2_GPIO_H_
diff --git a/libmaple/stm32f2/include/series/pwr.h b/libmaple/stm32f2/include/series/pwr.h
index dec2d76..96353a4 100644
--- a/libmaple/stm32f2/include/series/pwr.h
+++ b/libmaple/stm32f2/include/series/pwr.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file stm32f2/pwr.h
+ * @file libmaple/stm32f2/include/series/pwr.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
  * @brief STM32F2 Power control (PWR) support.
  */
diff --git a/libmaple/stm32f2/include/series/rcc.h b/libmaple/stm32f2/include/series/rcc.h
index d797ba9..9c3fdd5 100644
--- a/libmaple/stm32f2/include/series/rcc.h
+++ b/libmaple/stm32f2/include/series/rcc.h
@@ -26,7 +26,7 @@
 
 /**
  * @file libmaple/stm32f2/include/series/rcc.h
- * @brief STM32F2 reset and clock control (RCC) header.
+ * @brief STM32F2 reset and clock control (RCC) support.
  */
 
 /*
diff --git a/libmaple/stm32f2/include/series/stm32.h b/libmaple/stm32f2/include/series/stm32.h
index 5ab4c56..9e88a70 100644
--- a/libmaple/stm32f2/include/series/stm32.h
+++ b/libmaple/stm32f2/include/series/stm32.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f2/stm32.h
+ * @file libmaple/stm32f2/include/series/stm32.h
  * @brief STM32F2 chip- and series-specific definitions.
  */
 
diff --git a/libmaple/stm32f2/include/series/timer.h b/libmaple/stm32f2/include/series/timer.h
index cf7cc15..0d959d0 100644
--- a/libmaple/stm32f2/include/series/timer.h
+++ b/libmaple/stm32f2/include/series/timer.h
@@ -25,9 +25,9 @@
  *****************************************************************************/
 
 /**
- * @file   stm32f2/include/series/timer.h
+ * @file   libmaple/stm32f2/include/series/timer.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief  STM32F2 timer sub-header.
+ * @brief  STM32F2 timer support.
  */
 
 #ifndef _LIBMAPLE_STM32F2_TIMER_H_
diff --git a/libmaple/stm32f2/include/series/usart.h b/libmaple/stm32f2/include/series/usart.h
index 9b18b9c..805a2b2 100644
--- a/libmaple/stm32f2/include/series/usart.h
+++ b/libmaple/stm32f2/include/series/usart.h
@@ -25,9 +25,9 @@
  *****************************************************************************/
 
 /**
- * @file libmaple/stm32f2/usart.h
+ * @file libmaple/stm32f2/include/series/usart.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 USART header.
+ * @brief STM32F2 USART support.
  */
 
 #ifndef _LIBMAPLE_STM32F2_USART_H_
diff --git a/libmaple/stm32f2/rcc.c b/libmaple/stm32f2/rcc.c
index 8a91f30..a13e56d 100644
--- a/libmaple/stm32f2/rcc.c
+++ b/libmaple/stm32f2/rcc.c
@@ -26,7 +26,7 @@
 
 /**
  * @file libmaple/stm32f2/rcc.c
- * @brief STM32F2 RCC routines.
+ * @brief STM32F2 RCC.
  */
 
 #include <libmaple/rcc.h>
diff --git a/libmaple/stm32f2/timer.c b/libmaple/stm32f2/timer.c
index eed7810..3f9a8d2 100644
--- a/libmaple/stm32f2/timer.c
+++ b/libmaple/stm32f2/timer.c
@@ -27,7 +27,7 @@
 /**
  * @file   libmaple/stm32f2/timer.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief  STM32F2 timer support.
+ * @brief  STM32F2 timers.
  */
 
 #include <libmaple/timer.h>
diff --git a/libmaple/stm32f2/usart.c b/libmaple/stm32f2/usart.c
index 364558c..e4fc9b1 100644
--- a/libmaple/stm32f2/usart.c
+++ b/libmaple/stm32f2/usart.c
@@ -27,7 +27,7 @@
 /**
  * @file libmaple/stm32f2/usart.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>
- * @brief STM32F2 USART support.
+ * @brief STM32F2 USART.
  */
 
 #include <libmaple/usart.h>
diff --git a/libmaple/syscalls.c b/libmaple/syscalls.c
index 86fd8e6..30a63bf 100644
--- a/libmaple/syscalls.c
+++ b/libmaple/syscalls.c
@@ -25,9 +25,11 @@
  *****************************************************************************/
 
 /**
- * @file syscalls.c
- * @brief Low level system routines used by Newlib for basic I/O and
- * memory allocation.
+ * @file libmaple/syscalls.c
+ * @brief newlib stubs
+ *
+ * Low level system routines used by Newlib for basic I/O and memory
+ * allocation.
  */
 
 #include <libmaple/libmaple.h>
diff --git a/libmaple/systick.c b/libmaple/systick.c
index c6e3cbd..80c0c47 100644
--- a/libmaple/systick.c
+++ b/libmaple/systick.c
@@ -25,8 +25,8 @@
  *****************************************************************************/
 
 /**
- * @file systick.c
- * @brief System timer interrupt handler and initialization routines
+ * @file libmaple/systick.c
+ * @brief System timer (SysTick).
  */
 
 #include <libmaple/systick.h>
diff --git a/libmaple/usart.c b/libmaple/usart.c
index 1070aa2..253cf9f 100644
--- a/libmaple/usart.c
+++ b/libmaple/usart.c
@@ -25,10 +25,10 @@
  *****************************************************************************/
 
 /**
- * @file usart.c
+ * @file libmaple/usart.c
  * @author Marti Bolivar <mbolivar@leaflabs.com>,
  *         Perry Hung <perry@leaflabs.com>
- * @brief USART control routines
+ * @brief Portable USART routines
  */
 
 #include <libmaple/usart.h>
diff --git a/libmaple/usb/usb.c b/libmaple/usb/usb.c
index 6f23848..0130bab 100644
--- a/libmaple/usb/usb.c
+++ b/libmaple/usb/usb.c
@@ -25,8 +25,10 @@
  *****************************************************************************/
 
 /**
- * @file usb.c
+ * @file libmaple/usb/usb.c
  * @brief USB support.
+ *
+ * This is a mess. What we need almost amounts to a ground-up rewrite.
  */
 
 #include <libmaple/usb.h>
diff --git a/libmaple/usb/usb_cdcacm.c b/libmaple/usb/usb_cdcacm.c
index 07d2bc8..6ef4806 100644
--- a/libmaple/usb/usb_cdcacm.c
+++ b/libmaple/usb/usb_cdcacm.c
@@ -25,10 +25,12 @@
  *****************************************************************************/
 
 /**
- * @file usb_cdcacm.c
+ * @file libmaple/usb/usb_cdcacm.c
+ * @brief USB CDC ACM (a.k.a. virtual serial terminal, VCOM).
  *
- * @brief USB CDC ACM (a.k.a. virtual serial terminal, VCOM) state and
- *        routines.
+ * FIXME: this works on the STM32F1 USB peripherals, and probably no
+ * place else. Nonportable bits really need to be factored out, and
+ * the result made cleaner.
  */
 
 #include <libmaple/usb_cdcacm.h>
diff --git a/libmaple/util.c b/libmaple/util.c
index 96050a1..ff100fe 100644
--- a/libmaple/util.c
+++ b/libmaple/util.c
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file util.c
+ * @file libmaple/util.c
  * @brief Utility procedures for debugging, mostly an error LED fade
  * and messages dumped over a UART for failed asserts.
  */
diff --git a/wirish/HardwareSerial.cpp b/wirish/HardwareSerial.cpp
index a9eb763..0f12e72 100644
--- a/wirish/HardwareSerial.cpp
+++ b/wirish/HardwareSerial.cpp
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file HardwareSerial.cpp
+ * @file wirish/HardwareSerial.cpp
  * @brief Wirish serial port implementation.
  */
 
diff --git a/wirish/boards.cpp b/wirish/boards.cpp
index 54807d3..51ff50e 100644
--- a/wirish/boards.cpp
+++ b/wirish/boards.cpp
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file boards.cpp
+ * @file wirish/boards.cpp
  * @brief Generic board routines.
  *
  * This file is mostly interesting for the init() function, which
diff --git a/wirish/ext_interrupts.cpp b/wirish/ext_interrupts.cpp
index 8f8c768..a4a27c2 100644
--- a/wirish/ext_interrupts.cpp
+++ b/wirish/ext_interrupts.cpp
@@ -25,9 +25,8 @@
  *****************************************************************************/
 
 /**
- *  @file ext_interrupts.c
- *
- *  @brief Wiring-like interface for external interrupts
+ * @file wirish/ext_interrupts.c
+ * @brief Wiring-like interface for external interrupts
  */
 
 #include <wirish/ext_interrupts.h>
diff --git a/wirish/include/wirish/HardwareSPI.h b/wirish/include/wirish/HardwareSPI.h
index ad95191..89cf166 100644
--- a/wirish/include/wirish/HardwareSPI.h
+++ b/wirish/include/wirish/HardwareSPI.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file HardwareSPI.h
+ * @file wirish/include/wirish/HardwareSPI.h
  * @brief High-level SPI interface
  *
  * This is a "bare essentials" polling driver for now.
diff --git a/wirish/include/wirish/HardwareSerial.h b/wirish/include/wirish/HardwareSerial.h
index c25fd6e..1eaacb6 100644
--- a/wirish/include/wirish/HardwareSerial.h
+++ b/wirish/include/wirish/HardwareSerial.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file HardwareSerial.h
+ * @file wirish/include/wirish/HardwareSerial.h
  * @brief Wirish serial port interface.
  */
 
diff --git a/wirish/include/wirish/boards.h b/wirish/include/wirish/boards.h
index c762542..3c2740a 100644
--- a/wirish/include/wirish/boards.h
+++ b/wirish/include/wirish/boards.h
@@ -25,10 +25,10 @@
  *****************************************************************************/
 
 /**
- * @file boards.h
+ * @file wirish/include/wirish/boards.h
  * @author Bryan Newbold <bnewbold@leaflabs.com>,
  *         Marti Bolivar <mbolivar@leaflabs.com>
- * @brief Board-specific pin information.
+ * @brief init() and board-specific pin information.
  */
 
 #ifndef _WIRISH_BOARDS_H_
diff --git a/wirish/include/wirish/ext_interrupts.h b/wirish/include/wirish/ext_interrupts.h
index 617e43d..03b8e97 100644
--- a/wirish/include/wirish/ext_interrupts.h
+++ b/wirish/include/wirish/ext_interrupts.h
@@ -25,9 +25,8 @@
  *****************************************************************************/
 
 /**
- *  @file ext_interrupts.h
- *
- *  @brief Wiring-like external interrupt prototypes and types.
+ * @file wirish/include/wirish/ext_interrupts.h
+ * @brief Wiring-like external interrupt prototypes and types.
  */
 
 #ifndef _WIRISH_EXT_INTERRUPTS_H_
diff --git a/wirish/include/wirish/io.h b/wirish/include/wirish/io.h
index de56a49..b5fe3a8 100644
--- a/wirish/include/wirish/io.h
+++ b/wirish/include/wirish/io.h
@@ -25,9 +25,8 @@
  *****************************************************************************/
 
 /**
- *  @file io.h
- *
- *  @brief Arduino-compatible digital pin I/O interface.
+ * @file wirish/include/wirish/io.h
+ * @brief Wiring-style pin I/O interface.
  */
 
 #ifndef _WIRISH_IO_H_
diff --git a/wirish/include/wirish/pwm.h b/wirish/include/wirish/pwm.h
index e7130fb..6631d42 100644
--- a/wirish/include/wirish/pwm.h
+++ b/wirish/include/wirish/pwm.h
@@ -25,9 +25,8 @@
  *****************************************************************************/
 
 /**
- *  @file pwm.h
- *
- *  @brief Arduino-compatible PWM interface.
+ * @file wirish/include/wirish/pwm.h
+ * @brief Wiring-style PWM interface.
  */
 
 #ifndef _WIRISH_PWM_H_
diff --git a/wirish/include/wirish/wirish_debug.h b/wirish/include/wirish/wirish_debug.h
index c8bc077..cb1be3d 100644
--- a/wirish/include/wirish/wirish_debug.h
+++ b/wirish/include/wirish/wirish_debug.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file wirish_debug.h
+ * @file wirish/include/wirish/wirish_debug.h
  * @brief High level debug port configuration
  */
 
diff --git a/wirish/include/wirish/wirish_math.h b/wirish/include/wirish/wirish_math.h
index 3820cab..39f16a0 100644
--- a/wirish/include/wirish/wirish_math.h
+++ b/wirish/include/wirish/wirish_math.h
@@ -25,8 +25,8 @@
  *****************************************************************************/
 
 /**
- * @file wirish_math.h
- * @brief Includes <math.h>; provides Arduino-compatible math routines.
+ * @file wirish/include/wirish/wirish_math.h
+ * @brief Includes <math.h>; provides Wiring-compatible math routines.
  */
 
 #ifndef _WIRISH_WIRISH_MATH_H_
diff --git a/wirish/include/wirish/wirish_time.h b/wirish/include/wirish/wirish_time.h
index a81075c..1520b1e 100644
--- a/wirish/include/wirish/wirish_time.h
+++ b/wirish/include/wirish/wirish_time.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file wirish_time.h
+ * @file wirish/include/wirish/wirish_time.h
  * @brief Timing and delay functions.
  */
 
diff --git a/wirish/include/wirish/wirish_types.h b/wirish/include/wirish/wirish_types.h
index d70b26f..fce895e 100644
--- a/wirish/include/wirish/wirish_types.h
+++ b/wirish/include/wirish/wirish_types.h
@@ -25,7 +25,7 @@
  *****************************************************************************/
 
 /**
- * @file   wirish_types.h
+ * @file   wirish/include/wirish/wirish_types.h
  * @author Marti Bolivar <mbolivar@leaflabs.com>
  * @brief  Wirish library type definitions.
  */
-- 
cgit v1.2.3


From 3bbdc100fb7e84a51c63a6cbba7ad46a9a4ae197 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Wed, 13 Jun 2012 11:57:16 -0400
Subject: examples/test-usart-dma.cpp: Cleanups and comments.

Someone pointed to this example on the DMA page in the wiki, so it's
probably worth making it more clear what's going on. Remove unused
code, add comments, and move things around for better exposition.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
---
 examples/test-usart-dma.cpp | 127 +++++++++++++++++++++++++++-----------------
 1 file changed, 78 insertions(+), 49 deletions(-)

(limited to 'examples/test-usart-dma.cpp')

diff --git a/examples/test-usart-dma.cpp b/examples/test-usart-dma.cpp
index 10ebe8b..7dafc3a 100644
--- a/examples/test-usart-dma.cpp
+++ b/examples/test-usart-dma.cpp
@@ -12,9 +12,9 @@
  *
  * This example isn't very robust; don't use it in production.  In
  * particular, since the buffer keeps filling (DMA_CIRC_MODE is set),
- * if you keep typing after filling the buffer, you'll overwrite
- * earlier bytes; this may happen before those earlier bytes are done
- * printing.
+ * if you keep sending characters after filling the buffer, you'll
+ * overwrite earlier bytes; this may happen before those earlier bytes
+ * are done printing.
  *
  * This code is released into the public domain.
  */
@@ -25,29 +25,65 @@
 
 #include <wirish/wirish.h>
 
-#define BAUD 9600
+/*
+ * Configuration and state
+ */
 
+// USART and DMA configuration
 #define USART USART2
 #define USART_HWSER Serial2
 #define USART_DMA_DEV DMA1
 #define USART_RX_DMA_CHANNEL DMA_CH6
-#define USART_TX BOARD_USART2_TX_PIN
-#define USART_RX BOARD_USART2_RX_PIN
-
-#define BUF_SIZE 8
-uint8 rx_buf[BUF_SIZE];
+#define BAUD 9600
 
-dma_irq_cause irq_cause;
+// This will store received USART characters.
+#define BUF_SIZE 20
+char rx_buf[BUF_SIZE];
 
+// The interrupt handler, rx_dma_irq(), sets this to 1.
 volatile uint32 irq_fired = 0;
+// Used to store the ISR bits inside rx_dma_irq(). This helps explain
+// what's going on inside loop(); see comments below.
+volatile uint32 isr = 0;
+
+/*
+ * Helper functions
+ */
+
+// This is our DMA interrupt handler.
+void rx_dma_irq(void) {
+    irq_fired = 1;
+    isr = dma_get_isr_bits(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
+}
+
+// Configure the USART receiver for use with DMA:
+// 1. Turn it on.
+// 2. Set the "DMA request on RX" bit in USART_CR3 (USART_CR3_DMAR).
+void init_usart(void) {
+    USART_HWSER.begin(BAUD);
+    USART->regs->CR3 = USART_CR3_DMAR;
+}
+
+// Configure the DMA controller to serve DMA requests from the USART.
+void init_dma_xfer(void) {
+    dma_init(USART_DMA_DEV);
+    dma_setup_transfer(USART_DMA_DEV, USART_RX_DMA_CHANNEL,
+                       &USART->regs->DR, DMA_SIZE_8BITS,
+                       rx_buf,           DMA_SIZE_8BITS,
+                       (DMA_MINC_MODE | DMA_CIRC_MODE | DMA_TRNS_CMPLT));
+    dma_set_num_transfers(USART_DMA_DEV, USART_RX_DMA_CHANNEL,
+                          BUF_SIZE - 1);
+    dma_attach_interrupt(USART_DMA_DEV, USART_RX_DMA_CHANNEL, rx_dma_irq);
+    dma_enable(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
+}
 
-void init_usart(void);
-void init_dma_xfer(void);
-void rx_dma_irq(void);
+/*
+ * setup() and loop()
+ */
 
 void setup(void) {
     pinMode(BOARD_LED_PIN, OUTPUT);
-
+    rx_buf[BUF_SIZE - 1] = '\0'; // null-terminate rx_buf so we can print it
     init_dma_xfer();
     init_usart();
 }
@@ -56,56 +92,49 @@ void loop(void) {
     toggleLED();
     delay(100);
 
-    dma_channel_reg_map *ch_regs = dma_channel_regs(USART_DMA_DEV,
-                                                    USART_RX_DMA_CHANNEL);
+    // See if the interrupt handler got called since the last time we
+    // checked.
     if (irq_fired) {
         USART_HWSER.println("** IRQ **");
+        // Notice how the ISR bits show transfer complete _and_
+        // half-complete here, but the ISR bits we print next will be
+        // zero. That's because the variable "isr" gets set _inside_
+        // rx_dma_irq(). After it exits, libmaple cleans up by
+        // clearing the ISR bits. (If it didn't, and we forgot to, the
+        // interrupt would repeatedly fire forever.)
+        USART_HWSER.print("ISR bits: 0x");
+        USART_HWSER.println(isr, HEX);
         irq_fired = 0;
     }
+
+    // Print the ISR (interrupt status register) bits.
+    //
+    // Notice that the "transfer half-complete" ISR flag gets set when
+    // we reach the rx_buf half-way point. This is true even though we
+    // don't tell the DMA controller to interrupt us on a
+    // half-complete transfer. That is, the ISR bits get set at the
+    // right times no matter what; we just don't get interrupted
+    // unless we asked. (If an error or other problem occurs, the
+    // relevant ISR bits will get set in the same way).
     USART_HWSER.print("[");
     USART_HWSER.print(millis());
     USART_HWSER.print("]\tISR bits: 0x");
     uint8 isr_bits = dma_get_isr_bits(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
     USART_HWSER.print(isr_bits, HEX);
-    USART_HWSER.print("\tCCR: 0x");
-    USART_HWSER.print(ch_regs->CCR, HEX);
-    USART_HWSER.print("\tCNDTR: 0x");
-    USART_HWSER.print(ch_regs->CNDTR, HEX);
-    USART_HWSER.print("\tBuffer contents: ");
-     for (int i = 0; i < BUF_SIZE; i++) {
-        USART_HWSER.print('\'');
-        USART_HWSER.print(rx_buf[i]);
-        USART_HWSER.print('\'');
-        if (i < BUF_SIZE - 1) USART_HWSER.print(", ");
-    }
-    USART_HWSER.println();
+
+    // Print the contents of rx_buf. If you keep typing after it fills
+    // up, the new characters will overwrite the old ones, thanks to
+    // DMA_CIRC_MODE.
+    USART_HWSER.print("\tCharacter buffer contents: '");
+    USART_HWSER.print(rx_buf);
+    USART_HWSER.println("'");
     if (isr_bits == 0x7) {
         USART_HWSER.println("** Clearing ISR bits.");
         dma_clear_isr_bits(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
     }
 }
 
-/* Configure USART receiver for use with DMA */
-void init_usart(void) {
-    USART_HWSER.begin(BAUD);
-    USART->regs->CR3 = USART_CR3_DMAR;
-}
-
-/* Configure DMA transmission */
-void init_dma_xfer(void) {
-    dma_init(USART_DMA_DEV);
-    dma_setup_transfer(USART_DMA_DEV, USART_RX_DMA_CHANNEL,
-                       &USART->regs->DR, DMA_SIZE_8BITS,
-                       rx_buf,           DMA_SIZE_8BITS,
-                       (DMA_MINC_MODE | DMA_CIRC_MODE | DMA_TRNS_CMPLT));
-    dma_set_num_transfers(USART_DMA_DEV, USART_RX_DMA_CHANNEL, BUF_SIZE);
-    dma_attach_interrupt(USART_DMA_DEV, USART_RX_DMA_CHANNEL, rx_dma_irq);
-    dma_enable(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
-}
-
-void rx_dma_irq(void) {
-    irq_fired = true;
-}
+// ------- init() and main() --------------------------------------------------
 
 // Force init to be called *first*, i.e. before static object allocation.
 // Otherwise, statically allocated objects that need libmaple may fail.
-- 
cgit v1.2.3


From c000038c8b16a9be40ac95231c309aad05a57158 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Wed, 13 Jun 2012 11:57:56 -0400
Subject: examples/test-usart-dma.cpp: Use HardwareSerial::c_dev().

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
---
 examples/test-usart-dma.cpp | 37 +++++++++++++++++++------------------
 1 file changed, 19 insertions(+), 18 deletions(-)

(limited to 'examples/test-usart-dma.cpp')

diff --git a/examples/test-usart-dma.cpp b/examples/test-usart-dma.cpp
index 7dafc3a..b3c766e 100644
--- a/examples/test-usart-dma.cpp
+++ b/examples/test-usart-dma.cpp
@@ -29,9 +29,9 @@
  * Configuration and state
  */
 
-// USART and DMA configuration
-#define USART USART2
-#define USART_HWSER Serial2
+// USART and DMA configuration. You can change these to suit your
+// purposes.
+HardwareSerial *serial = &Serial2;
 #define USART_DMA_DEV DMA1
 #define USART_RX_DMA_CHANNEL DMA_CH6
 #define BAUD 9600
@@ -60,16 +60,17 @@ void rx_dma_irq(void) {
 // 1. Turn it on.
 // 2. Set the "DMA request on RX" bit in USART_CR3 (USART_CR3_DMAR).
 void init_usart(void) {
-    USART_HWSER.begin(BAUD);
-    USART->regs->CR3 = USART_CR3_DMAR;
+    serial->begin(BAUD);
+    usart_dev *serial_dev = serial->c_dev();
+    serial_dev->regs->CR3 = USART_CR3_DMAR;
 }
 
 // Configure the DMA controller to serve DMA requests from the USART.
 void init_dma_xfer(void) {
     dma_init(USART_DMA_DEV);
     dma_setup_transfer(USART_DMA_DEV, USART_RX_DMA_CHANNEL,
-                       &USART->regs->DR, DMA_SIZE_8BITS,
-                       rx_buf,           DMA_SIZE_8BITS,
+                       &serial->c_dev()->regs->DR, DMA_SIZE_8BITS,
+                       rx_buf,                     DMA_SIZE_8BITS,
                        (DMA_MINC_MODE | DMA_CIRC_MODE | DMA_TRNS_CMPLT));
     dma_set_num_transfers(USART_DMA_DEV, USART_RX_DMA_CHANNEL,
                           BUF_SIZE - 1);
@@ -95,15 +96,15 @@ void loop(void) {
     // See if the interrupt handler got called since the last time we
     // checked.
     if (irq_fired) {
-        USART_HWSER.println("** IRQ **");
+        serial->println("** IRQ **");
         // Notice how the ISR bits show transfer complete _and_
         // half-complete here, but the ISR bits we print next will be
         // zero. That's because the variable "isr" gets set _inside_
         // rx_dma_irq(). After it exits, libmaple cleans up by
         // clearing the ISR bits. (If it didn't, and we forgot to, the
         // interrupt would repeatedly fire forever.)
-        USART_HWSER.print("ISR bits: 0x");
-        USART_HWSER.println(isr, HEX);
+        serial->print("ISR bits: 0x");
+        serial->println(isr, HEX);
         irq_fired = 0;
     }
 
@@ -116,20 +117,20 @@ void loop(void) {
     // right times no matter what; we just don't get interrupted
     // unless we asked. (If an error or other problem occurs, the
     // relevant ISR bits will get set in the same way).
-    USART_HWSER.print("[");
-    USART_HWSER.print(millis());
-    USART_HWSER.print("]\tISR bits: 0x");
+    serial->print("[");
+    serial->print(millis());
+    serial->print("]\tISR bits: 0x");
     uint8 isr_bits = dma_get_isr_bits(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
-    USART_HWSER.print(isr_bits, HEX);
+    serial->print(isr_bits, HEX);
 
     // Print the contents of rx_buf. If you keep typing after it fills
     // up, the new characters will overwrite the old ones, thanks to
     // DMA_CIRC_MODE.
-    USART_HWSER.print("\tCharacter buffer contents: '");
-    USART_HWSER.print(rx_buf);
-    USART_HWSER.println("'");
+    serial->print("\tCharacter buffer contents: '");
+    serial->print(rx_buf);
+    serial->println("'");
     if (isr_bits == 0x7) {
-        USART_HWSER.println("** Clearing ISR bits.");
+        serial->println("** Clearing ISR bits.");
         dma_clear_isr_bits(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
     }
 }
-- 
cgit v1.2.3


From e935e86a6f6a10fae3b646fc6aadfaf89bd76496 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Wed, 13 Jun 2012 13:31:12 -0400
Subject: test-usart-dma.cpp: tweaks.

Touch up comments, change some function names, and don't set something
to zero which already is.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
---
 examples/test-usart-dma.cpp | 33 +++++++++++++++++----------------
 1 file changed, 17 insertions(+), 16 deletions(-)

(limited to 'examples/test-usart-dma.cpp')

diff --git a/examples/test-usart-dma.cpp b/examples/test-usart-dma.cpp
index b3c766e..4a63044 100644
--- a/examples/test-usart-dma.cpp
+++ b/examples/test-usart-dma.cpp
@@ -29,8 +29,8 @@
  * Configuration and state
  */
 
-// USART and DMA configuration. You can change these to suit your
-// purposes.
+// Serial port and DMA configuration. You can change these to suit
+// your purposes.
 HardwareSerial *serial = &Serial2;
 #define USART_DMA_DEV DMA1
 #define USART_RX_DMA_CHANNEL DMA_CH6
@@ -42,8 +42,9 @@ char rx_buf[BUF_SIZE];
 
 // The interrupt handler, rx_dma_irq(), sets this to 1.
 volatile uint32 irq_fired = 0;
-// Used to store the ISR bits inside rx_dma_irq(). This helps explain
-// what's going on inside loop(); see comments below.
+// Used to store DMA interrupt status register (ISR) bits inside
+// rx_dma_irq(). This helps explain what's going on inside loop(); see
+// comments below.
 volatile uint32 isr = 0;
 
 /*
@@ -59,14 +60,14 @@ void rx_dma_irq(void) {
 // Configure the USART receiver for use with DMA:
 // 1. Turn it on.
 // 2. Set the "DMA request on RX" bit in USART_CR3 (USART_CR3_DMAR).
-void init_usart(void) {
+void setup_usart(void) {
     serial->begin(BAUD);
     usart_dev *serial_dev = serial->c_dev();
     serial_dev->regs->CR3 = USART_CR3_DMAR;
 }
 
 // Configure the DMA controller to serve DMA requests from the USART.
-void init_dma_xfer(void) {
+void setup_dma_xfer(void) {
     dma_init(USART_DMA_DEV);
     dma_setup_transfer(USART_DMA_DEV, USART_RX_DMA_CHANNEL,
                        &serial->c_dev()->regs->DR, DMA_SIZE_8BITS,
@@ -84,9 +85,8 @@ void init_dma_xfer(void) {
 
 void setup(void) {
     pinMode(BOARD_LED_PIN, OUTPUT);
-    rx_buf[BUF_SIZE - 1] = '\0'; // null-terminate rx_buf so we can print it
-    init_dma_xfer();
-    init_usart();
+    setup_dma_xfer();
+    setup_usart();
 }
 
 void loop(void) {
@@ -97,18 +97,19 @@ void loop(void) {
     // checked.
     if (irq_fired) {
         serial->println("** IRQ **");
-        // Notice how the ISR bits show transfer complete _and_
-        // half-complete here, but the ISR bits we print next will be
-        // zero. That's because the variable "isr" gets set _inside_
-        // rx_dma_irq(). After it exits, libmaple cleans up by
-        // clearing the ISR bits. (If it didn't, and we forgot to, the
-        // interrupt would repeatedly fire forever.)
+        // Notice how the interrupt status register (ISR) bits show
+        // transfer complete _and_ half-complete here, but the ISR
+        // bits we print next will be zero. That's because the
+        // variable "isr" gets set _inside_ rx_dma_irq(). After it
+        // exits, libmaple cleans up by clearing the tube's ISR
+        // bits. (If it didn't, and we forgot to, the interrupt would
+        // repeatedly fire forever.)
         serial->print("ISR bits: 0x");
         serial->println(isr, HEX);
         irq_fired = 0;
     }
 
-    // Print the ISR (interrupt status register) bits.
+    // Print the ISR bits.
     //
     // Notice that the "transfer half-complete" ISR flag gets set when
     // we reach the rx_buf half-way point. This is true even though we
-- 
cgit v1.2.3


From 59b81331e9e767a271b873dc4a594e7406fa36a3 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Wed, 13 Jun 2012 13:53:00 -0400
Subject: Port test-usart-dma.cpp to use tube API.

This is straightforward. Do it in a verbose style with lots of
comments, so we can use this patch as an example for how to port
existing DMA code.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
---
 examples/test-usart-dma.cpp | 74 +++++++++++++++++++++++++++++++++++++--------
 1 file changed, 61 insertions(+), 13 deletions(-)

(limited to 'examples/test-usart-dma.cpp')

diff --git a/examples/test-usart-dma.cpp b/examples/test-usart-dma.cpp
index 4a63044..04117c3 100644
--- a/examples/test-usart-dma.cpp
+++ b/examples/test-usart-dma.cpp
@@ -14,7 +14,9 @@
  * particular, since the buffer keeps filling (DMA_CIRC_MODE is set),
  * if you keep sending characters after filling the buffer, you'll
  * overwrite earlier bytes; this may happen before those earlier bytes
- * are done printing.
+ * are done printing. (Typing quickly and seeing how it affects the
+ * output is a fun way to make sense of how the interrupts and the
+ * main thread of execution interleave.)
  *
  * This code is released into the public domain.
  */
@@ -33,9 +35,18 @@
 // your purposes.
 HardwareSerial *serial = &Serial2;
 #define USART_DMA_DEV DMA1
-#define USART_RX_DMA_CHANNEL DMA_CH6
+// On STM32F1 microcontrollers (like what's on Maple and Maple Mini),
+// dma tubes are channels.
+#define USART_RX_DMA_TUBE DMA_CH6
+// The serial port will make a DMA request each time it receives data.
+// This is the dma_request_src we use to tell the DMA tube to handle
+// that DMA request.
+#define USART_DMA_REQ_SRC DMA_REQ_SRC_USART2_RX
 #define BAUD 9600
 
+// This will store the DMA configuration for USART RX.
+dma_tube_config tube_config;
+
 // This will store received USART characters.
 #define BUF_SIZE 20
 char rx_buf[BUF_SIZE];
@@ -54,7 +65,7 @@ volatile uint32 isr = 0;
 // This is our DMA interrupt handler.
 void rx_dma_irq(void) {
     irq_fired = 1;
-    isr = dma_get_isr_bits(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
+    isr = dma_get_isr_bits(USART_DMA_DEV, USART_RX_DMA_TUBE);
 }
 
 // Configure the USART receiver for use with DMA:
@@ -66,17 +77,53 @@ void setup_usart(void) {
     serial_dev->regs->CR3 = USART_CR3_DMAR;
 }
 
+// Set up our dma_tube_config structure. (We could have done this
+// above, when we declared tube_config, but having this function makes
+// it easier to explain what's going on).
+void setup_tube_config(void) {
+    // We're receiving from the USART data register. serial->c_dev()
+    // returns a pointer to the libmaple usart_dev for that serial
+    // port, so this is a pointer to its data register.
+    tube_config.tube_src = &serial->c_dev()->regs->DR;
+    // We're only interested in the bottom 8 bits of that data register.
+    tube_config.tube_src_size = DMA_SIZE_8BITS;
+    // We're storing to rx_buf.
+    tube_config.tube_dst = rx_buf;
+    // rx_buf is a char array, and a "char" takes up 8 bits on STM32.
+    tube_config.tube_dst_size = DMA_SIZE_8BITS;
+    // Only fill BUF_SIZE - 1 characters, to leave a null byte at the end.
+    tube_config.tube_nr_xfers = BUF_SIZE - 1;
+    // Flags:
+    // - DMA_CFG_DST_INC so we start at the beginning of rx_buf and
+    //   fill towards the end.
+    // - DMA_CFG_CIRC so we go back to the beginning and start over when
+    //   rx_buf fills up.
+    // - DMA_CFG_CMPLT_IE to turn on interrupts on transfer completion.
+    tube_config.tube_flags = DMA_CFG_DST_INC | DMA_CFG_CIRC | DMA_CFG_CMPLT_IE;
+    // Target data: none. It's important to set this to NULL if you
+    // don't have any special (microcontroller-specific) configuration
+    // in mind, which we don't.
+    tube_config.target_data = NULL;
+    // DMA request source.
+    tube_config.tube_req_src = USART_DMA_REQ_SRC;
+}
+
 // Configure the DMA controller to serve DMA requests from the USART.
 void setup_dma_xfer(void) {
+    // First, turn it on.
     dma_init(USART_DMA_DEV);
-    dma_setup_transfer(USART_DMA_DEV, USART_RX_DMA_CHANNEL,
-                       &serial->c_dev()->regs->DR, DMA_SIZE_8BITS,
-                       rx_buf,                     DMA_SIZE_8BITS,
-                       (DMA_MINC_MODE | DMA_CIRC_MODE | DMA_TRNS_CMPLT));
-    dma_set_num_transfers(USART_DMA_DEV, USART_RX_DMA_CHANNEL,
-                          BUF_SIZE - 1);
-    dma_attach_interrupt(USART_DMA_DEV, USART_RX_DMA_CHANNEL, rx_dma_irq);
-    dma_enable(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
+    // Next, configure it by calling dma_tube_cfg(), and check to make
+    // sure it succeeded. DMA tubes have many restrictions on their
+    // configuration, and there are configurations which work on some
+    // types of STM32 but not others. libmaple tries hard to make
+    // things just work, but checking the return status is important!
+    int status = dma_tube_cfg(USART_DMA_DEV, USART_RX_DMA_TUBE, &tube_config);
+    ASSERT(status == DMA_TUBE_CFG_SUCCESS);
+    // Now we'll perform any other configuration we want. For this
+    // example, we attach an interrupt handler.
+    dma_attach_interrupt(USART_DMA_DEV, USART_RX_DMA_TUBE, rx_dma_irq);
+    // Turn on the DMA tube. It will now begin serving requests.
+    dma_enable(USART_DMA_DEV, USART_RX_DMA_TUBE);
 }
 
 /*
@@ -85,6 +132,7 @@ void setup_dma_xfer(void) {
 
 void setup(void) {
     pinMode(BOARD_LED_PIN, OUTPUT);
+    setup_tube_config();
     setup_dma_xfer();
     setup_usart();
 }
@@ -121,7 +169,7 @@ void loop(void) {
     serial->print("[");
     serial->print(millis());
     serial->print("]\tISR bits: 0x");
-    uint8 isr_bits = dma_get_isr_bits(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
+    uint8 isr_bits = dma_get_isr_bits(USART_DMA_DEV, USART_RX_DMA_TUBE);
     serial->print(isr_bits, HEX);
 
     // Print the contents of rx_buf. If you keep typing after it fills
@@ -132,7 +180,7 @@ void loop(void) {
     serial->println("'");
     if (isr_bits == 0x7) {
         serial->println("** Clearing ISR bits.");
-        dma_clear_isr_bits(USART_DMA_DEV, USART_RX_DMA_CHANNEL);
+        dma_clear_isr_bits(USART_DMA_DEV, USART_RX_DMA_TUBE);
     }
 }
 
-- 
cgit v1.2.3


From c5b954a8670abe277daa06f4eea2b48d761e3175 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Thu, 14 Jun 2012 18:32:01 -0400
Subject: Port test-usart-dma.cpp for STM32F2.

Too ugly? Meh.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
---
 examples/test-usart-dma.cpp | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'examples/test-usart-dma.cpp')

diff --git a/examples/test-usart-dma.cpp b/examples/test-usart-dma.cpp
index 04117c3..d10dc68 100644
--- a/examples/test-usart-dma.cpp
+++ b/examples/test-usart-dma.cpp
@@ -35,9 +35,18 @@
 // your purposes.
 HardwareSerial *serial = &Serial2;
 #define USART_DMA_DEV DMA1
+#if STM32_MCU_SERIES == STM32_SERIES_F1
 // On STM32F1 microcontrollers (like what's on Maple and Maple Mini),
 // dma tubes are channels.
 #define USART_RX_DMA_TUBE DMA_CH6
+#elif (STM32_MCU_SERIES == STM32_SERIES_F2 || \
+       STM32_MCU_SERIES == STM32_SERIES_F4)
+// On STM32F2 and STM32F4 microcontrollers (Maple 2 will have an F4),
+// dma tubes are streams.
+#define USART_RX_DMA_TUBE DMA_S5
+#else
+#error "unsupported stm32 series"
+#endif
 // The serial port will make a DMA request each time it receives data.
 // This is the dma_request_src we use to tell the DMA tube to handle
 // that DMA request.
-- 
cgit v1.2.3