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>

1 files changed, 199 insertions, 0 deletions

diff --git a/libmaple/include/libmaple/stm32.h b/libmaple/include/libmaple/stm32.h
new file mode 100644
index 0000000..53a5d7a
--- /dev/null
+++ b/libmaple/include/libmaple/stm32.h
@@ -0,0 +1,199 @@
+/******************************************************************************
+ * The MIT License
+ *
+ * Copyright (c) 2010 LeafLabs, LLC.
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy,
+ * modify, merge, publish, distribute, sublicense, and/or sell copies
+ * of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *****************************************************************************/
+
+/**
+ * @file stm32.h
+ * @brief STM32 chip-specific definitions
+ */
+
+#ifndef _LIBMAPLE_STM32_H_
+#define _LIBMAPLE_STM32_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * User-specific configuration.
+ *
+ * The #defines here depend upon how libmaple is used.  Because of the
+ * potential for a mismatch between them and the actual libmaple
+ * usage, you should try to keep their number to an absolute minimum.
+ */
+
+#ifdef __DOXYGEN_PREDEFINED_HACK
+
+    /** @brief APB1 clock speed, in Hz. */
+    #define STM32_PCLK1
+    /** @brief APB2 clock speed, in Hz. */
+    #define STM32_PCLK2
+
+    /** Deprecated.  Use STM32_PCLK1 instead. */
+    #define PCLK1
+    /** Deprecated. Use STM32_PCLK2 instead. */
+    #define PCLK2
+
+#endif
+
+#ifndef STM32_PCLK1
+#define STM32_PCLK1   36000000U
+#endif
+#ifndef PCLK1
+#define PCLK1 STM32_PCLK1
+#endif
+#if PCLK1 != STM32_PCLK1
+#error "(Deprecated) PCLK1 differs from STM32_PCLK1"
+#endif
+
+#ifndef STM32_PCLK2
+#define STM32_PCLK2   72000000U
+#endif
+#ifndef PCLK2
+#define PCLK2 STM32_PCLK2
+#endif
+#if PCLK2 != STM32_PCLK2
+#error "(Deprecated) PCLK2 differs from STM32_PCLK2"
+#endif
+
+/*
+ * Density-specific configuration.
+ */
+
+#ifdef __DOXYGEN_PREDEFINED_HACK
+
+    /**
+     * @brief Number of interrupts in the NVIC.
+     *
+     * This define is automatically generated whenever the proper
+     * density is defined (currently, this is restricted to defining
+     * one of STM32_MEDIUM_DENSITY and STM32_HIGH_DENSITY).
+     */
+    #define STM32_NR_INTERRUPTS
+
+    /** Deprecated.  Use STM32_NR_INTERRUPTS instead. */
+    #define NR_INTERRUPTS
+
+#endif
+
+#ifdef STM32_MEDIUM_DENSITY
+    #define STM32_NR_INTERRUPTS 43
+#elif defined(STM32_HIGH_DENSITY)
+    #define STM32_NR_INTERRUPTS 60
+#else
+#error "No STM32 board type defined!"
+#endif
+
+#define NR_INTERRUPTS STM32_NR_INTERRUPTS
+
+/*
+ * MCU-specific configuration.
+ */
+
+#ifdef __DOXYGEN_PREDEFINED_HACK
+
+    /**
+     * Number of GPIO ports.
+     */
+    #define STM32_NR_GPIO_PORTS
+
+    /**
+     * @brief Multiplier to convert microseconds into loop iterations
+     *        in delay_us().
+     *
+     * @see delay_us()
+     */
+    #define STM32_DELAY_US_MULT
+
+    /**
+     * @brief Pointer to end of built-in SRAM.
+     *
+     * Points to the address which is 1 byte past the last valid
+     * SRAM address.
+     */
+    #define STM32_SRAM_END
+
+    /** Deprecated.  Use STM32_NR_GPIO_PORTS instead. */
+    #define NR_GPIO_PORTS
+    /** Deprecated.  Use STM32_DELAY_US_MULT instead. */
+    #define DELAY_US_MULT
+
+#endif
+
+#if defined(MCU_STM32F103RB)
+    /* e.g., LeafLabs Maple */
+
+    #define STM32_NR_GPIO_PORTS          4
+    #define STM32_DELAY_US_MULT         12
+    #define STM32_SRAM_END              ((void*)0x20005000)
+
+    #define NR_GPIO_PORTS               STM32_NR_GPIO_PORTS
+    #define DELAY_US_MULT               STM32_DELAY_US_MULT
+
+#elif defined(MCU_STM32F103ZE)
+    /* e.g., LeafLabs Maple Native */
+
+    #define STM32_NR_GPIO_PORTS          7
+    #define STM32_DELAY_US_MULT         12
+    #define STM32_SRAM_END              ((void*)0x20010000)
+
+    #define NR_GPIO_PORTS               STM32_NR_GPIO_PORTS
+    #define DELAY_US_MULT               STM32_DELAY_US_MULT
+
+#elif defined(MCU_STM32F103CB)
+    /* e.g., LeafLabs Maple Mini */
+
+    /* This STM32_NR_GPIO_PORTS value is not, strictly speaking, true.
+     * But only pins 0 and 1 exist, and they're used for OSC on the
+     * Mini, so we'll live with this for now. */
+    #define STM32_NR_GPIO_PORTS          3
+    #define STM32_DELAY_US_MULT         12
+    #define STM32_SRAM_END              ((void*)0x20005000)
+
+    #define NR_GPIO_PORTS               STM32_NR_GPIO_PORTS
+    #define DELAY_US_MULT               STM32_DELAY_US_MULT
+
+#elif defined(MCU_STM32F103RE)
+    /* e.g., LeafLabs Maple RET6 edition */
+
+    #define STM32_NR_GPIO_PORTS          4
+    #define STM32_DELAY_US_MULT         12
+    #define STM32_SRAM_END              ((void*)0x20010000)
+
+    #define NR_GPIO_PORTS               STM32_NR_GPIO_PORTS
+    #define DELAY_US_MULT               STM32_DELAY_US_MULT
+
+#else
+
+#error "No MCU type specified. Add something like -DMCU_STM32F103RB "   \
+       "to your compiler arguments (probably in a Makefile)."
+
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif