Merge branch 'refactor'

This merges the libmaple refactor work into master.  The contents of
libmaple proper (/libmaple/) are almost completely incompatible with
previous APIs in master.  See /docs/source/libmaple/overview.rst for
more information on the new design.

Wirish incompatibilities are limited to the HardwareTimer class;
however, there are several new deprecations, most likely to be removed
in 0.1.0.

10 files changed, 137 insertions, 131 deletions

diff --git a/libmaple/usb/descriptors.c b/libmaple/usb/descriptors.c
index 360e6dd..8dd9521 100644
--- a/libmaple/usb/descriptors.c
+++ b/libmaple/usb/descriptors.c
@@ -150,43 +150,50 @@ const USB_Descriptor_Config usbVcomDescriptor_Config = {
  //  }
 };
 
-/*
-   String Identifiers:
+/*****************************************************************************
+ *****************************************************************************
+ ***
+ *** FIXME FIXME FIXME NOT THE RIGHT THING! MOVE ALL THIS INTO TO WIRISH!
+ ***
+ *****************************************************************************
+ *****************************************************************************/
 
-   we may choose to specify any or none of the following string
-   identifiers:
+const uint8 usbVcomDescriptor_LangID[USB_DESCRIPTOR_STRING_LEN(1)] = {
+    USB_DESCRIPTOR_STRING_LEN(1),
+    USB_DESCRIPTOR_TYPE_STRING,
+    0x09,
+    0x04
+};
 
-   iManufacturer:    LeafLabs
-   iProduct:         Maple R3
-   iSerialNumber:    NONE
-   iConfiguration:   NONE
-   iInterface(CCI):  NONE
-   iInterface(DCI):  NONE
+const uint8 usbVcomDescriptor_iManufacturer[USB_DESCRIPTOR_STRING_LEN(8)] = {
+    USB_DESCRIPTOR_STRING_LEN(8),
+    USB_DESCRIPTOR_TYPE_STRING,
+    'L', 0, 'e', 0, 'a', 0, 'f', 0,
+    'L', 0, 'a', 0, 'b', 0, 's', 0
+};
 
-   additionally we must provide the unicode language identifier,
-   which is 0x0409 for US English
-*/
+/*
+  String Identifiers:
 
-const uint8 usbVcomDescriptor_LangID[USB_DESCRIPTOR_STRING_LEN(1)] =
-{
-  USB_DESCRIPTOR_STRING_LEN(1),
-  USB_DESCRIPTOR_TYPE_STRING,
-  0x09,
-  0x04
-};
+  we may choose to specify any or none of the following string
+  identifiers:
 
-const uint8 usbVcomDescriptor_iManufacturer[USB_DESCRIPTOR_STRING_LEN(8)] =
-{
-  USB_DESCRIPTOR_STRING_LEN(8),
-  USB_DESCRIPTOR_TYPE_STRING,
-  'L', 0, 'e', 0, 'a', 0, 'f', 0,
-  'L', 0, 'a', 0, 'b', 0, 's', 0
-};
+  iManufacturer:    LeafLabs
+  iProduct:         Maple R3
+  iSerialNumber:    NONE
+  iConfiguration:   NONE
+  iInterface(CCI):  NONE
+  iInterface(DCI):  NONE
 
-const uint8 usbVcomDescriptor_iProduct[USB_DESCRIPTOR_STRING_LEN(8)] =
-{
-  USB_DESCRIPTOR_STRING_LEN(8),
-  USB_DESCRIPTOR_TYPE_STRING,
-  'M', 0, 'a', 0, 'p', 0, 'l', 0,
-  'e', 0, ' ', 0, 'R', 0, '3', 0
+  additionally we must provide the unicode language identifier,
+  which is 0x0409 for US English
+*/
+const uint8 usbVcomDescriptor_iProduct[USB_DESCRIPTOR_STRING_LEN(8)] = {
+    USB_DESCRIPTOR_STRING_LEN(8),
+    USB_DESCRIPTOR_TYPE_STRING,
+    'M', 0, 'a', 0, 'p', 0, 'l', 0,
+    'e', 0, ' ', 0, ' ', 0, ' ', 0
 };
+
+/*****************************************************************************
+ *****************************************************************************/
diff --git a/libmaple/usb/descriptors.h b/libmaple/usb/descriptors.h
index 6f7d08b..460a88c 100644
--- a/libmaple/usb/descriptors.h
+++ b/libmaple/usb/descriptors.h
@@ -61,7 +61,7 @@ extern "C" {
     uint16 bString[len];			\
   }
 
-#define CDC_FUCNTIONAL_DESCRIPTOR(DataSize)	\
+#define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)	\
   struct					\
   {						\
     uint8 bLength;				\
diff --git a/libmaple/usb/usb.c b/libmaple/usb/usb.c
index d875785..b34c4b6 100644
--- a/libmaple/usb/usb.c
+++ b/libmaple/usb/usb.c
@@ -35,6 +35,7 @@
 #include "usb_lib.h"
 #include "gpio.h"
 #include "usb_hardware.h"
+#include "delay.h"
 
 #include "usb_config.h"
 #include "usb_callbacks.h"
@@ -44,7 +45,7 @@
 
 volatile uint32 bDeviceState = UNCONNECTED;
 volatile uint16 wIstr = 0;
-volatile bIntPackSOF  = 0;
+volatile uint32 bIntPackSOF = 0;
 
 DEVICE Device_Table =
     {NUM_ENDPTS,
@@ -99,15 +100,13 @@ struct {
 } ResumeS;
 
 void setupUSB (void) {
-  gpio_set_mode(USB_DISC_BANK,
-                USB_DISC_PIN,
-                GPIO_MODE_OUTPUT_PP);
+  gpio_set_mode(USB_DISC_DEV, USB_DISC_PIN, GPIO_OUTPUT_PP);
 
   /* setup the apb1 clock for USB */
   pRCC->APB1ENR |= 0x00800000;
 
   /* initialize the usb application */
-  gpio_write_bit(USB_DISC_BANK, USB_DISC_PIN, 0); // presents us to the host
+  gpio_write_bit(USB_DISC_DEV, USB_DISC_PIN, 0); // presents us to the host
   USB_Init();  // low level init routine provided by the ST library
 }
 
@@ -115,7 +114,7 @@ void disableUSB (void) {
   // These are just guesses about how to do this
   // TODO: real disable function
   usbDsbISR();
-  gpio_write_bit(USB_DISC_BANK,USB_DISC_PIN,1);
+  gpio_write_bit(USB_DISC_DEV, USB_DISC_PIN, 1);
 }
 
 void usbSuspend(void) {
@@ -241,7 +240,7 @@ void usbDsbISR(void) {
 }
 
 /* overloaded ISR routine, this is the main usb ISR */
-void usb_lpIRQHandler(void) {
+void __irq_usb_lp_can_rx0(void) {
 wIstr = _GetISTR();
 
 /* go nuts with the preproc switches since this is an ISTR and must be FAST */
@@ -321,7 +320,7 @@ if (wIstr & ISTR_CTR & wInterrupt_Mask) {
 }
 
 void usbWaitReset(void) {
-  delay(RESET_DELAY);
+  delay_us(RESET_DELAY);
   systemHardReset();
 }
 
@@ -344,23 +343,21 @@ void usbBlockingSendByte(char ch) {
     countTx = 1;
     while (countTx);
 }
-uint32 usbSendBytes(uint8* sendBuf, uint32 len) {
-  /* any checks on connection (via dtr/rts) done upstream in wirish or
-     by user */
 
-  /* last xmit hasnt finished, abort */
+uint32 usbSendBytes(const uint8* sendBuf, uint32 len) {
+  /* Last transmission hasn't finished, abort */
   if (countTx) {
     return 0;
   }
 
   // We can only put VCOM_TX_EPSIZE bytes in the buffer
-  if(len > VCOM_TX_EPSIZE/2) {
-    len = VCOM_TX_EPSIZE/2;
+  if (len > VCOM_TX_EPSIZE / 2) {
+    len = VCOM_TX_EPSIZE / 2;
   }
 
   // Try to load some bytes if we can
   if (len) {
-    UserToPMABufferCopy(sendBuf,VCOM_TX_ADDR, len);
+    UserToPMABufferCopy(sendBuf, VCOM_TX_ADDR, len);
     _SetEPTxCount(VCOM_TX_ENDP, len);
     countTx += len;
     _SetEPTxValid(VCOM_TX_ENDP);
diff --git a/libmaple/usb/usb.h b/libmaple/usb/usb.h
index 0ed02e5..c724c54 100644
--- a/libmaple/usb/usb.h
+++ b/libmaple/usb/usb.h
@@ -69,12 +69,12 @@ void usbDsbISR(void);
 void usbEnbISR(void);
 
 /* overloaded ISR routine, this is the main usb ISR */
-void usb_lpIRQHandler(void);
+void __irq_usb_lp_can_rx0(void);
 void usbWaitReset(void);
 
 /* blocking functions for send/receive */
 void   usbBlockingSendByte(char ch);
-uint32 usbSendBytes(uint8* sendBuf,uint32 len);
+uint32 usbSendBytes(const uint8* sendBuf,uint32 len);
 uint32 usbBytesAvailable(void);
 uint32 usbReceiveBytes(uint8* recvBuf, uint32 len);
 uint8 usbGetDTR(void);
diff --git a/libmaple/usb/usb_callbacks.c b/libmaple/usb/usb_callbacks.c
index ccb0fdd..8184537 100644
--- a/libmaple/usb/usb_callbacks.c
+++ b/libmaple/usb/usb_callbacks.c
@@ -129,7 +129,7 @@ u8* vcomGetSetLineCoding(uint16 length) {
     return (uint8*)&line_coding;
 }
 
-vcomSetLineState(void) {
+void vcomSetLineState(void) {
 }
 
 void usbInit(void) {
diff --git a/libmaple/usb/usb_config.h b/libmaple/usb/usb_config.h
index e5f3979..23b49ee 100644
--- a/libmaple/usb/usb_config.h
+++ b/libmaple/usb/usb_config.h
@@ -4,6 +4,68 @@
 #define __USB_CONFIG_H
 
 #include "usb_lib.h"
+#include "gpio.h"
+
+/******************************************************************************
+ ******************************************************************************
+ ***
+ ***   HACK ALERT
+ ***
+ ***   FIXME FIXME FIXME FIXME
+ ***
+ ***   A bunch of board-specific #defines that are only used by the
+ ***   USB routines got put into libmaple.h for what appear to be
+ ***   historical reasons.  I'm [mbolivar] putting them in here for
+ ***   now, so that we can treat the usb/ directory as a black box,
+ ***   freeing the rest of libmaple/ to be implemented as a
+ ***   general-purpose STM32 library. All of this REALLY needs to get
+ ***   moved into wirish when we get a chance to redo the USB stack.
+ ***
+ ******************************************************************************
+ *****************************************************************************/
+
+#define VCOM_ID_VENDOR            0x1EAF
+#define RESET_DELAY               (100000)
+#define USB_CONFIG_MAX_POWER      (100 >> 1)
+
+#if defined(BOARD_maple) || defined(BOARD_maple_RET6)
+
+    /* USB Identifier numbers */
+    #define VCOM_ID_PRODUCT      0x0004
+    #define USB_DISC_DEV         GPIOC
+    #define USB_DISC_PIN         12
+
+#elif defined(BOARD_maple_mini)
+
+    #define VCOM_ID_PRODUCT      0x0004
+    #define USB_DISC_DEV         GPIOB
+    #define USB_DISC_PIN         9
+
+#elif defined(BOARD_maple_native)
+
+    #define VCOM_ID_PRODUCT      0x0004
+    #define USB_DISC_DEV         GPIOB
+    #define USB_DISC_PIN         8
+
+#else
+
+#error ("Sorry! the USB stack relies on LeafLabs board-specific "       \
+        "configuration right now.  If you want, you can pretend you're one " \
+        "of our boards; i.e., #define BOARD_maple, BOARD_maple_mini, or " \
+        "BOARD_maple_native according to what matches your MCU best. "  \
+        "You should also take a look at libmaple/usb/descriptors.c; we make " \
+        "some assumptions there that you probably won't like.")
+
+#endif
+
+/******************************************************************************
+ ******************************************************************************
+ ***
+ ***   END HACK
+ ***
+ ******************************************************************************
+ *****************************************************************************/
+
 
 /* choose addresses to give endpoints the max 64 byte buffers */
 #define USB_BTABLE_ADDRESS        0x00
@@ -33,14 +95,15 @@
 #define NUM_ENDPTS                0x04
 
 /* handle all usb interrupts */
-#define ISR_MSK ( CNTR_CTRM    |           \
-		  CNTR_WKUPM   |	   \
-		  CNTR_SUSPM   |	   \
-		  CNTR_ERRM    |	   \
-		  CNTR_SOFM    |	   \
-		  CNTR_ESOFM   |	   \
-		  CNTR_RESETM  )
+#define ISR_MSK (CNTR_CTRM    |                                         \
+                 CNTR_WKUPM   |                                         \
+                 CNTR_SUSPM   |                                         \
+                 CNTR_ERRM    |                                         \
+                 CNTR_SOFM    |                                         \
+                 CNTR_ESOFM   |                                         \
+                 CNTR_RESETM)
 
 #define F_SUSPEND_ENABLED 1
 
+
 #endif
diff --git a/libmaple/usb/usb_hardware.c b/libmaple/usb/usb_hardware.c
index 505dcf1..9a7d12c 100644
--- a/libmaple/usb/usb_hardware.c
+++ b/libmaple/usb/usb_hardware.c
@@ -33,47 +33,6 @@
 
 #include "usb_hardware.h"
 
-void setPin(u32 bank, u8 pin) {
-    u32 pinMask = 0x1 << (pin);
-    SET_REG(GPIO_BSRR(bank),pinMask);
-}
-
-void resetPin(u32 bank, u8 pin) {
-    u32 pinMask = 0x1 << (16+pin);
-    SET_REG(GPIO_BSRR(bank),pinMask);
-}
-
-void systemReset(void) {
-    SET_REG(RCC_CR, GET_REG(RCC_CR)     | 0x00000001);
-    SET_REG(RCC_CFGR, GET_REG(RCC_CFGR) & 0xF8FF0000);
-    SET_REG(RCC_CR, GET_REG(RCC_CR)     & 0xFEF6FFFF);
-    SET_REG(RCC_CR, GET_REG(RCC_CR)     & 0xFFFBFFFF);
-    SET_REG(RCC_CFGR, GET_REG(RCC_CFGR) & 0xFF80FFFF);
-
-    SET_REG(RCC_CIR, 0x00000000); // disable all RCC interrupts
-}
-
-void setupCLK (void) {
-    /* enable HSE */
-    SET_REG(RCC_CR,GET_REG(RCC_CR) | 0x00010001);
-    /* for it to come on */
-    while ((GET_REG(RCC_CR) & 0x00020000) == 0);
-
-    /* Configure PLL */
-    /* pll=72Mhz,APB1=36Mhz,AHB=72Mhz */
-    SET_REG(RCC_CFGR,GET_REG(RCC_CFGR) | 0x001D0400);
-    /* enable the pll */
-    SET_REG(RCC_CR,GET_REG(RCC_CR)     | 0x01000000);
-    /* wait for it to come on */
-    while ((GET_REG(RCC_CR) & 0x03000000) == 0);
-
-    /* Set SYSCLK as PLL */
-    SET_REG(RCC_CFGR,GET_REG(RCC_CFGR) | 0x00000002);
-    /* wait for it to come on */
-    while ((GET_REG(RCC_CFGR) & 0x00000008) == 0);
-}
-
-
 void nvicInit(NVIC_InitTypeDef* NVIC_InitStruct) {
     u32 tmppriority = 0x00;
     u32 tmpreg      = 0x00;
diff --git a/libmaple/usb/usb_hardware.h b/libmaple/usb/usb_hardware.h
index e4a26b4..cfead1a 100644
--- a/libmaple/usb/usb_hardware.h
+++ b/libmaple/usb/usb_hardware.h
@@ -22,34 +22,20 @@
  * THE SOFTWARE.
  * ****************************************************************************/
 
-#ifndef __HARDWARE_H
-#define __HARDWARE_H
-
+#include "rcc.h"
 #include "usb_type.h"
 
+#ifndef _USB_HARDWARE_H_
+#define _USB_HARDWARE_H_
+
 /* macro'd register and peripheral definitions */
 #define EXC_RETURN 0xFFFFFFF9
 #define DEFAULT_CPSR 0x61000000
 
-#define RCC   ((u32)0x40021000)
 #define FLASH ((u32)0x40022000)
-#define GPIOA ((u32)0x40010800)
-#define GPIOC ((u32)0x40011000)
 
 #define USB_PACKET_BUFFER ((u32)0x40006000)
 
-#define RCC_CR      RCC
-#define RCC_CFGR    RCC + 0x04
-#define RCC_CIR     RCC + 0x08
-#define RCC_AHBENR  RCC + 0x14
-#define RCC_APB2ENR RCC + 0x18
-#define RCC_APB1ENR RCC + 0x16
-
-#define GPIO_CRL(port)  port
-#define GPIO_CRH(port)  port+0x04
-#define GPIO_ODR(port)  port+0x0c
-#define GPIO_BSRR(port) port+0x10
-
 #define SCS_BASE   ((u32)0xE000E000)
 #define NVIC_BASE  (SCS_BASE + 0x0100)
 #define SCB_BASE   (SCS_BASE + 0x0D00)
@@ -74,9 +60,8 @@
 #define __PSC(__TIMCLK, __PERIOD)  (((__VAL(__TIMCLK, __PERIOD)+49999UL)/50000UL) - 1)
 #define __ARR(__TIMCLK, __PERIOD) ((__VAL(__TIMCLK, __PERIOD)/(__PSC(__TIMCLK, __PERIOD)+1)) - 1)
 
-/* todo, wrap in do whiles for the natural ; */
-#define SET_REG(addr,val) *(vu32*)(addr)=val
-#define GET_REG(addr)     *(vu32*)(addr)
+#define SET_REG(addr,val)  do { *(vu32*)(addr)=val; } while (0)
+#define GET_REG(addr)      do { *(vu32*)(addr); } while (0)
 
 #if defined(__cplusplus)
 extern "C" {
@@ -85,7 +70,7 @@ extern "C" {
 /* todo: there must be some major misunderstanding in how we access regs. The direct access approach (GET_REG)
    causes the usb init to fail upon trying to activate RCC_APB1 |= 0x00800000. However, using the struct approach
    from ST, it works fine...temporarily switching to that approach */
-typedef struct 
+typedef struct
 {
   vu32 CR;
   vu32 CFGR;
@@ -98,7 +83,7 @@ typedef struct
   vu32 BDCR;
   vu32 CSR;
 } RCC_RegStruct;
-#define pRCC ((RCC_RegStruct *) RCC)
+#define pRCC ((RCC_RegStruct *) RCC_BASE)
 
 typedef struct {
   vu32 ISER[2];
@@ -139,12 +124,7 @@ typedef struct {
 } SCB_TypeDef;
 
 
-void setPin    (u32 bank, u8 pin);
-void resetPin  (u32 bank, u8 pin);
-
 void systemHardReset(void);
-void systemReset   (void);
-void setupCLK      (void);
 
 void nvicInit        (NVIC_InitTypeDef*);
 void nvicDisableInterrupts(void);
diff --git a/libmaple/usb/usb_lib/usb_mem.c b/libmaple/usb/usb_lib/usb_mem.c
index ee698c5..90ffc62 100644
--- a/libmaple/usb/usb_lib/usb_mem.c
+++ b/libmaple/usb/usb_lib/usb_mem.c
@@ -30,9 +30,9 @@
 *                  - wPMABufAddr: address into PMA.

 *                  - wNBytes: no. of bytes to be copied.

 * Output         : None.

-* Return         : None	.

+* Return         : None                           .

 *******************************************************************************/

-void UserToPMABufferCopy(u8 *pbUsrBuf, u16 wPMABufAddr, u16 wNBytes)

+void UserToPMABufferCopy(const u8 *pbUsrBuf, u16 wPMABufAddr, u16 wNBytes)

 {

   u32 n = (wNBytes + 1) >> 1;   /* n = (wNBytes + 1) / 2 */

   u32 i, temp1, temp2;

diff --git a/libmaple/usb/usb_lib/usb_mem.h b/libmaple/usb/usb_lib/usb_mem.h
index a3d7927..60ff9f1 100644
--- a/libmaple/usb/usb_lib/usb_mem.h
+++ b/libmaple/usb/usb_lib/usb_mem.h
@@ -26,7 +26,7 @@
 extern "C" {

 #endif

 

-void UserToPMABufferCopy(u8 *pbUsrBuf, u16 wPMABufAddr, u16 wNBytes);

+void UserToPMABufferCopy(const u8 *pbUsrBuf, u16 wPMABufAddr, u16 wNBytes);

 void PMAToUserBufferCopy(u8 *pbUsrBuf, u16 wPMABufAddr, u16 wNBytes);

 

 #if defined(__cplusplus)