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

diff --git a/libmaple/bitband.h b/libmaple/bitband.h
deleted file mode 100644
index 73941b0..0000000
--- a/libmaple/bitband.h
+++ /dev/null
@@ -1,120 +0,0 @@
-/******************************************************************************
- * The MIT License
- *
- * Copyright (c) 2011 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 bitband.h
- *
- * @brief Bit-banding utility functions
- */
-
-#include "libmaple_types.h"
-
-#ifndef _BITBAND_H_
-#define _BITBAND_H_
-
-#define BB_SRAM_REF      0x20000000
-#define BB_SRAM_BASE     0x22000000
-#define BB_PERI_REF      0x40000000
-#define BB_PERI_BASE     0x42000000
-
-static inline volatile uint32* __bb_addr(volatile void*,
-                                         uint32,
-                                         uint32,
-                                         uint32);
-
-/**
- * @brief Obtain a pointer to the bit-band address corresponding to a
- * bit in a volatile SRAM address.
- * @param address Address in the bit-banded SRAM region
- * @param bit     Bit in address to bit-band
- */
-static inline volatile uint32* bb_sramp(volatile void *address, uint32 bit) {
-    return __bb_addr(address, bit, BB_SRAM_BASE, BB_SRAM_REF);
-}
-
-/**
- * @brief Get a bit from an address in the SRAM bit-band region.
- * @param address Address in the SRAM bit-band region to read from
- * @param bit Bit in address to read
- * @return bit's value in address.
- */
-static inline uint8 bb_sram_get_bit(volatile void *address, uint32 bit) {
-    return *bb_sramp(address, bit);
-}
-
-/**
- * @brief Set a bit in an address in the SRAM bit-band region.
- * @param address Address in the SRAM bit-band region to write to
- * @param bit Bit in address to write to
- * @param val Value to write for bit, either 0 or 1.
- */
-static inline void bb_sram_set_bit(volatile void *address,
-                                   uint32 bit,
-                                   uint8 val) {
-    *bb_sramp(address, bit) = val;
-}
-
-/**
- * @brief Obtain a pointer to the bit-band address corresponding to a
- * bit in a peripheral address.
- * @param address Address in the bit-banded peripheral region
- * @param bit     Bit in address to bit-band
- */
-static inline volatile uint32* bb_perip(volatile void *address, uint32 bit) {
-    return __bb_addr(address, bit, BB_PERI_BASE, BB_PERI_REF);
-}
-
-/**
- * @brief Get a bit from an address in the peripheral bit-band region.
- * @param address Address in the peripheral bit-band region to read from
- * @param bit Bit in address to read
- * @return bit's value in address.
- */
-static inline uint8 bb_peri_get_bit(volatile void *address, uint32 bit) {
-    return *bb_perip(address, bit);
-}
-
-/**
- * @brief Set a bit in an address in the peripheral bit-band region.
- * @param address Address in the peripheral bit-band region to write to
- * @param bit Bit in address to write to
- * @param val Value to write for bit, either 0 or 1.
- */
-static inline void bb_peri_set_bit(volatile void *address,
-                                   uint32 bit,
-                                   uint8 val) {
-    *bb_perip(address, bit) = val;
-}
-
-static inline volatile uint32* __bb_addr(volatile void *address,
-                                         uint32 bit,
-                                         uint32 bb_base,
-                                         uint32 bb_ref) {
-    return (volatile uint32*)(bb_base + ((uint32)address - bb_ref) * 32 +
-                              bit * 4);
-}
-
-#endif  /* _BITBAND_H_ */