added Adafruit_USBDevice based on tinyusb

- added Adafruit_USBInterface
- remove setLoopStacksize
- move usb code around

Author: hathach

cores/nRF5/Arduino.h

@@ -36,7 +36,6 @@ void setup( void ) ;
 void loop( void ) ;
 
 void suspendLoop(void);
-uint32_t setLoopStacksize(void);
 
 #include "WVariant.h"
 
@@ -70,11 +69,10 @@ uint32_t setLoopStacksize(void);
 
 #ifdef NRF52840_XXAA
   #include "tusb.h"
-
 #ifdef __cplusplus
+  #include "Adafruit_USBDevice.h"
   #include "USBSerial.h"
 #endif
-
 #endif
 
 // Include board variant

cores/nRF5/main.cpp

@@ -16,6 +16,14 @@
 #define ARDUINO_MAIN
 #include "Arduino.h"
 
+#include "usb.h"
+
+/* USB VID/PID if not defined, tinyusb to use default value
+ * Note: different class combination e.g CDC and (CDC + MSC) should have different
+ * PID since Host OS will "remembered" device driver after the first plug */
+#define USB_VID  0x239A
+#define USB_PID  0x8029
+
 // DEBUG Level 1
 #if CFG_DEBUG
 // weak function to avoid compilation error with
@@ -37,9 +45,8 @@ static TaskHandle_t  _loopHandle;
 void initVariant() __attribute__((weak));
 void initVariant() { }
 
-uint32_t _loopStacksize = 512*3;
-
-uint32_t setLoopStacksize(void) __attribute__ ((weak));
+#define LOOP_STACK_SZ   (512*3)
+#define USBD_STACK_SZ   (150)
 
 static void loop_task(void* arg)
 {
@@ -68,25 +75,41 @@ static void loop_task(void* arg)
   }
 }
 
-/*
- * \brief Main entry point of Arduino application
- */
+// USB Device Driver task
+// This top level thread process all usb events and invoke callbacks
+static void usb_device_task(void* param)
+{
+  (void) param;
+
+  // RTOS forever loop
+  while (1)
+  {
+    // tinyusb device task
+    tud_task();
+  }
+}
+
+// \brief Main entry point of Arduino application
 int main( void )
 {
   init();
   initVariant();
 
-  if (setLoopStacksize)
-  {
-    _loopStacksize = setLoopStacksize();
-  }
+#ifdef NRF52840_XXAA
+  USBDevice.addInterface( (Adafruit_USBInterface&) Serial);
+  USBDevice.begin(USB_VID, USB_PID);
+  usb_init();
+
+  // Create a task for tinyusb device stack
+  xTaskCreate( usb_device_task, "usbd", USBD_STACK_SZ, NULL, TASK_PRIO_HIGH, NULL);
+#endif
 
 #if CFG_DEBUG >= 3
   SEGGER_SYSVIEW_Conf();
 #endif
 
   // Create a task for loop()
-  xTaskCreate( loop_task, "loop", _loopStacksize, NULL, TASK_PRIO_LOW, &_loopHandle);
+  xTaskCreate( loop_task, "loop", LOOP_STACK_SZ, NULL, TASK_PRIO_LOW, &_loopHandle);
 
   // Initialize callback task
   ada_callback_init();

cores/nRF5/usb/Adafruit_USBDevice.cpp

@@ -0,0 +1,180 @@
+/* 
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 hathach for Adafruit Industries
+ *
+ * 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.
+ */
+
+#ifdef NRF52840_XXAA
+
+#include "Adafruit_USBDevice.h"
+
+extern "C"
+{
+extern uint16_t usb_desc_str_serial[1+16];
+
+// array of pointer to string descriptors
+uint16_t const * const string_desc_arr [] =
+{
+  // 0: is supported language = English
+  TUD_DESC_STRCONV(0x0409),
+
+  // 1: Manufacturer
+  TUD_DESC_STRCONV('A','d','a','f','r','u','i','t',' ','I','n','d','u','s','t','r','i','e','s'),
+
+  // 2: Product
+  TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','n','R','F','5','2','8','4','0'),
+
+  // 3: Serials
+  usb_desc_str_serial,
+
+  //    // 4: CDC Interface
+  //    TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','S','e','r','i','a','l'),
+  //
+  //    // 5: MSC Interface
+  //    TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','U','F','2'),
+};
+
+// tud_desc_set is required by tinyusb stack
+// since CFG_TUD_DESC_AUTO is enabled, we only need to set string_arr
+tud_desc_set_t tud_desc_set =
+{
+  .device       = NULL,
+  .config       = NULL,
+  .string_arr   = (uint8_t const **) string_desc_arr,
+  .string_count = sizeof(string_desc_arr)/sizeof(string_desc_arr[0]),
+
+  .hid_report =
+  {
+    .generic       = NULL,
+    .boot_keyboard = NULL,
+    .boot_mouse    = NULL
+  }
+};
+
+} // extern C
+
+Adafruit_USBDevice USBDevice;
+
+Adafruit_USBDevice::Adafruit_USBDevice(void)
+{
+  tusb_desc_device_t  desc_dev =
+  {
+    .bLength            = sizeof(tusb_desc_device_t),
+    .bDescriptorType    = TUSB_DESC_DEVICE,
+    .bcdUSB             = 0x0200,
+
+#if CFG_TUD_CDC
+    // Use Interface Association Descriptor (IAD) for CDC
+    // As required by USB Specs IAD's subclass must be common class (2) and protocol must be IAD (1)
+    .bDeviceClass       = TUSB_CLASS_MISC,
+    .bDeviceSubClass    = MISC_SUBCLASS_COMMON,
+    .bDeviceProtocol    = MISC_PROTOCOL_IAD,
+#else
+    .bDeviceClass       = 0x00,
+    .bDeviceSubClass    = 0x00,
+    .bDeviceProtocol    = 0x00,
+#endif
+
+    .bMaxPacketSize0    = CFG_TUD_ENDOINT0_SIZE,
+
+    .idVendor           = 0,
+    .idProduct          = 0,
+    .bcdDevice          = 0x0100,
+
+    .iManufacturer      = 0x01,
+    .iProduct           = 0x02,
+    .iSerialNumber      = 0x03,
+
+    .bNumConfigurations = 0x01
+  };
+
+  _desc_device = desc_dev;
+
+  tusb_desc_configuration_t dev_cfg =
+  {
+    .bLength             = sizeof(tusb_desc_configuration_t),
+    .bDescriptorType     = TUSB_DESC_CONFIGURATION,
+
+    // Total Length & Interface Number will be updated later
+    .wTotalLength        = 0,
+    .bNumInterfaces      = 0,
+
+    .bConfigurationValue = 1,
+    .iConfiguration      = 0x00,
+    .bmAttributes        = TU_BIT(7) | TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP,
+    .bMaxPower           = TUSB_DESC_CONFIG_POWER_MA(100)
+  };
+
+  memcpy(_desc_cfg, &dev_cfg, sizeof(tusb_desc_configuration_t));
+
+  _desc_cfglen = sizeof(tusb_desc_configuration_t);
+  _itf_count = 0;
+
+  tud_desc_set.config = _desc_cfg;
+  tud_desc_set.device = &_desc_device;
+}
+
+// Add interface descriptor, interface number will be updated to match current count
+bool Adafruit_USBDevice::addInterface(Adafruit_USBInterface& itf)
+{
+  uint8_t* desc = _desc_cfg+_desc_cfglen;
+  uint16_t len = itf.getDescriptor(desc, sizeof(_desc_cfg)-_desc_cfglen);
+
+  uint8_t* desc_end = desc+len;
+
+  // Handle IAD
+  if ( desc[1] == TUSB_DESC_INTERFACE_ASSOCIATION )
+  {
+    // update starting interface
+    ((tusb_desc_interface_assoc_t*) desc)->bFirstInterface = _itf_count;
+
+    desc += desc[0]; // next
+  }
+
+  while (desc < desc_end)
+  {
+    if (desc[1] == TUSB_DESC_INTERFACE)
+    {
+      // No alternate interface support
+      ((tusb_desc_interface_t*) desc)->bInterfaceNumber = _itf_count++;
+    }
+
+    if (desc[0] == 0) return false;
+    desc += desc[0]; // next
+  }
+
+  _desc_cfglen += len;
+
+  // Update config descriptor
+  tusb_desc_configuration_t* config = (tusb_desc_configuration_t*)_desc_cfg;
+  config->wTotalLength = _desc_cfglen;
+  config->bNumInterfaces = _itf_count;
+
+  return true;
+}
+
+bool Adafruit_USBDevice::begin(uint16_t vid, uint16_t pid)
+{
+  _desc_device.idVendor = vid;
+  _desc_device.idProduct = pid;
+}
+
+#endif

cores/nRF5/usb/Adafruit_USBDevice.h

@@ -0,0 +1,56 @@
+/* 
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 hathach for Adafruit Industries
+ *
+ * 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.
+ */
+
+#ifndef ADAFRUIT_USBDEVICE_H_
+#define ADAFRUIT_USBDEVICE_H_
+
+#include "tusb.h"
+
+class Adafruit_USBInterface
+{
+  public:
+    virtual uint16_t getDescriptor(uint8_t* buf, uint16_t bufsize) = 0;
+};
+
+class Adafruit_USBDevice
+{
+  private:
+    tusb_desc_device_t _desc_device;
+
+    uint8_t  _desc_cfg[256];
+    uint16_t _desc_cfglen;
+
+    uint8_t  _itf_count;
+
+  public:
+    Adafruit_USBDevice(void);
+
+    bool addInterface(Adafruit_USBInterface& itf);
+
+    bool begin(uint16_t vid, uint16_t pid);
+};
+
+extern Adafruit_USBDevice USBDevice;
+
+#endif /* ADAFRUIT_USBDEVICE_H_ */

cores/nRF5/usb/USBSerial.cpp

@@ -27,14 +27,26 @@
 #include "Arduino.h"
 #include "tusb.h"
 
-
 USBSerial Serial;
 
 USBSerial::USBSerial(void)
 {
 
 }
 
+uint16_t USBSerial::getDescriptor(uint8_t* buf, uint16_t bufsize)
+{
+  // CDC is mostly always existed for DFU
+  // Let's pick EP 1 & 2 for it
+  uint8_t desc[] = { TUD_CDC_DESCRIPTOR(0, 0, 0x81, 8, 0x02, 0x82, 64) };
+  uint16_t const len = sizeof(desc);
+
+  if ( bufsize < len ) return 0;
+
+  memcpy(buf, desc, len);
+  return len;
+}
+
 // Baud and config is ignore in CDC
 void USBSerial::begin (uint32_t baud)
 {

cores/nRF5/usb/USBSerial.h

@@ -27,13 +27,17 @@
 
 #ifdef NRF52840_XXAA
 
+#include "Adafruit_USBDevice.h"
 #include "Stream.h"
 
-class USBSerial : public Stream
+class USBSerial : public Stream, Adafruit_USBInterface
 {
 public:
 	USBSerial(void);
 
+	// fron Adafruit_USBInterface
+	virtual uint16_t getDescriptor(uint8_t* buf, uint16_t bufsize);
+
 	void setPins(uint8_t pin_rx, uint8_t pin_tx) { (void) pin_rx; (void) pin_tx; }
 	void begin(uint32_t baud_count);
 	void begin(uint32_t baud, uint8_t config);