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, 166 insertions, 0 deletions

diff --git a/libmaple/include/libmaple/bkp.h b/libmaple/include/libmaple/bkp.h
new file mode 100644
index 0000000..92359b6
--- /dev/null
+++ b/libmaple/include/libmaple/bkp.h
@@ -0,0 +1,166 @@
+/******************************************************************************
+ * 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 bkp.h
+ * @brief Backup register support.
+ */
+
+#ifndef _LIBMAPLE_BKP_H_
+#define _LIBMAPLE_BKP_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <libmaple/libmaple.h>
+
+#if defined(STM32_MEDIUM_DENSITY)
+#define BKP_NR_DATA_REGS 10
+#elif defined(STM32_HIGH_DENSITY)
+#define BKP_NR_DATA_REGS 42
+#endif
+
+/** Backup peripheral register map type. */
+typedef struct bkp_reg_map {
+    const uint32 RESERVED1;     ///< Reserved
+    __io uint32 DR1;            ///< Data register 1
+    __io uint32 DR2;            ///< Data register 2
+    __io uint32 DR3;            ///< Data register 3
+    __io uint32 DR4;            ///< Data register 4
+    __io uint32 DR5;            ///< Data register 5
+    __io uint32 DR6;            ///< Data register 6
+    __io uint32 DR7;            ///< Data register 7
+    __io uint32 DR8;            ///< Data register 8
+    __io uint32 DR9;            ///< Data register 9
+    __io uint32 DR10;           ///< Data register 10
+    __io uint32 RTCCR;          ///< RTC control register
+    __io uint32 CR;             ///< Control register
+    __io uint32 CSR;            ///< Control and status register
+#ifdef STM32_HIGH_DENSITY
+    const uint32 RESERVED2;     ///< Reserved
+    const uint32 RESERVED3;     ///< Reserved
+    __io uint32 DR11;           ///< Data register 11
+    __io uint32 DR12;           ///< Data register 12
+    __io uint32 DR13;           ///< Data register 13
+    __io uint32 DR14;           ///< Data register 14
+    __io uint32 DR15;           ///< Data register 15
+    __io uint32 DR16;           ///< Data register 16
+    __io uint32 DR17;           ///< Data register 17
+    __io uint32 DR18;           ///< Data register 18
+    __io uint32 DR19;           ///< Data register 19
+    __io uint32 DR20;           ///< Data register 20
+    __io uint32 DR21;           ///< Data register 21
+    __io uint32 DR22;           ///< Data register 22
+    __io uint32 DR23;           ///< Data register 23
+    __io uint32 DR24;           ///< Data register 24
+    __io uint32 DR25;           ///< Data register 25
+    __io uint32 DR26;           ///< Data register 26
+    __io uint32 DR27;           ///< Data register 27
+    __io uint32 DR28;           ///< Data register 28
+    __io uint32 DR29;           ///< Data register 29
+    __io uint32 DR30;           ///< Data register 30
+    __io uint32 DR31;           ///< Data register 31
+    __io uint32 DR32;           ///< Data register 32
+    __io uint32 DR33;           ///< Data register 33
+    __io uint32 DR34;           ///< Data register 34
+    __io uint32 DR35;           ///< Data register 35
+    __io uint32 DR36;           ///< Data register 36
+    __io uint32 DR37;           ///< Data register 37
+    __io uint32 DR38;           ///< Data register 38
+    __io uint32 DR39;           ///< Data register 39
+    __io uint32 DR40;           ///< Data register 40
+    __io uint32 DR41;           ///< Data register 41
+    __io uint32 DR42;           ///< Data register 42
+#endif
+} bkp_reg_map;
+
+/** Backup peripheral register map base pointer. */
+#define BKP_BASE                        ((struct bkp_reg_map*)0x40006C00)
+
+/** Backup peripheral device type. */
+typedef struct bkp_dev {
+    bkp_reg_map *regs; /**< Register map */
+} bkp_dev;
+
+extern const bkp_dev *BKP;
+
+/*
+ * Register bit definitions
+ */
+
+/* Data Registers */
+
+#define BKP_DR_D                        0xFFFF
+
+/* RTC Clock Calibration Register */
+
+#define BKP_RTCCR_ASOS_BIT              9
+#define BKP_RTCCR_ASOE_BIT              8
+#define BKP_RTCCR_CCO_BIT               7
+
+#define BKP_RTCCR_ASOS                  BIT(BKP_RTCCR_ASOS_BIT)
+#define BKP_RTCCR_ASOE                  BIT(BKP_RTCCR_ASOE_BIT)
+#define BKP_RTCCR_CCO                   BIT(BKP_RTCCR_CCO_BIT)
+#define BKP_RTCCR_CAL                   0x7F
+
+/* Backup control register */
+
+#define BKP_CR_TPAL_BIT                 1
+#define BKP_CR_TPE_BIT                  0
+
+#define BKP_CR_TPAL                     BIT(BKP_CR_TPAL_BIT)
+#define BKP_CR_TPE                      BIT(BKP_CR_TPE_BIT)
+
+/* Backup control/status register */
+
+#define BKP_CSR_TIF_BIT                 9
+#define BKP_CSR_TEF_BIT                 8
+#define BKP_CSR_TPIE_BIT                2
+#define BKP_CSR_CTI_BIT                 1
+#define BKP_CSR_CTE_BIT                 0
+
+#define BKP_CSR_TIF                     BIT(BKP_CSR_TIF_BIT)
+#define BKP_CSR_TEF                     BIT(BKP_CSR_TEF_BIT)
+#define BKP_CSR_TPIE                    BIT(BKP_CSR_TPIE_BIT)
+#define BKP_CSR_CTI                     BIT(BKP_CSR_CTI_BIT)
+#define BKP_CSR_CTE                     BIT(BKP_CSR_CTE_BIT)
+
+/*
+ * Convenience functions
+ */
+
+void bkp_init(void);
+void bkp_enable_writes(void);
+void bkp_disable_writes(void);
+uint16 bkp_read(uint8 reg);
+void bkp_write(uint8 reg, uint16 val);
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif