improve port API with TinyUSB_Port_GetSerialNumber

Author: hathach

examples/Composite/mouse_external_flash/mouse_external_flash.ino

@@ -19,13 +19,26 @@
 #include "Adafruit_SPIFlash.h"
 #include "Adafruit_TinyUSB.h"
 
-#if defined(__SAMD51__) || defined(NRF52840_XXAA)
-  Adafruit_FlashTransport_QSPI flashTransport(PIN_QSPI_SCK, PIN_QSPI_CS, PIN_QSPI_IO0, PIN_QSPI_IO1, PIN_QSPI_IO2, PIN_QSPI_IO3);
+// Uncomment to run example with FRAM
+// #define FRAM_CS   A5
+// #define FRAM_SPI  SPI
+
+#if defined(FRAM_CS) && defined(FRAM_SPI)
+  Adafruit_FlashTransport_SPI flashTransport(FRAM_CS, FRAM_SPI);
+
 #else
-  #if (SPI_INTERFACES_COUNT == 1)
-    Adafruit_FlashTransport_SPI flashTransport(SS, &SPI);
+  // On-board external flash (QSPI or SPI) macros should already
+  // defined in your board variant if supported
+  // - EXTERNAL_FLASH_USE_QSPI
+  // - EXTERNAL_FLASH_USE_CS/EXTERNAL_FLASH_USE_SPI
+  #if defined(EXTERNAL_FLASH_USE_QSPI)
+    Adafruit_FlashTransport_QSPI flashTransport;
+
+  #elif defined(EXTERNAL_FLASH_USE_SPI)
+    Adafruit_FlashTransport_SPI flashTransport(EXTERNAL_FLASH_USE_CS, EXTERNAL_FLASH_USE_SPI);
+
   #else
-    Adafruit_FlashTransport_SPI flashTransport(SS1, &SPI1);
+    #error No QSPI/SPI flash are defined on your board variant.h !
   #endif
 #endif
 
@@ -82,7 +95,7 @@ void setup()
   usb_hid.begin();
 
   Serial.begin(115200);
-  while ( !Serial ) delay(10);   // wait for native usb
+  //while ( !Serial ) delay(10);   // wait for native usb
 
   Serial.println("Adafruit TinyUSB Mouse + Mass Storage (external flash) example");
 }
@@ -143,4 +156,3 @@ void msc_flush_cb (void)
 {
   flash.syncBlocks();
 }
-

src/arduino/Adafruit_USBD_Device.cpp

@@ -208,6 +208,29 @@ void Adafruit_USBD_Device::setProductDescriptor(const char *s)
   _desc_str_arr[STRID_PRODUCT] = s;
 }
 
+uint8_t Adafruit_USBD_Device::getSerialDescriptor(uint16_t* serial_utf16)
+{
+  uint8_t serial_id[16] __attribute__((aligned(4)));
+  uint8_t const serial_len = TinyUSB_Port_GetSerialNumber(serial_id);
+
+  for ( uint8_t i = 0; i < serial_len; i++ )
+  {
+    for ( uint8_t j = 0; j < 2; j++ )
+    {
+      const char nibble_to_hex[16] =
+      {
+        '0', '1', '2', '3', '4', '5', '6', '7',
+        '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
+      };
+
+      uint8_t nibble = (serial_id[i] >> (j * 4)) & 0xf;
+      serial_utf16[1 + i * 2 + (1 - j)] = nibble_to_hex[nibble]; // UTF-16-LE
+    }
+  }
+
+  return 2*serial_len;
+}
+
 bool Adafruit_USBD_Device::begin(uint8_t rhport)
 {
   Serial.setStringDescriptor("TinyUSB Serial");
@@ -259,20 +282,17 @@ uint16_t const* Adafruit_USBD_Device::descriptor_string_cb(uint8_t index, uint16
 {
   (void) langid;
 
-  // up to 32 unicode characters (header make it 33)
-  static uint16_t _desc_str[33];
   uint8_t chr_count;
 
   switch (index)
   {
-    case 0:
+    case STRID_LANGUAGE:
       _desc_str[1] = ((uint16_t) ((uint32_t) _desc_str_arr[STRID_LANGUAGE]));
       chr_count = 1;
     break;
 
-    case 3:
-      // serial Number
-      chr_count = this->getSerialDescriptor(_desc_str+1);
+    case STRID_SERIAL:
+      chr_count = getSerialDescriptor(_desc_str);
     break;
 
     default:

src/arduino/Adafruit_USBD_Device.h

@@ -33,8 +33,10 @@ class Adafruit_USBD_Device
   private:
     enum { STRING_DESCRIPTOR_MAX = 8 };
 
+    // Device descriptor
     uint8_t _desc_device[18] __attribute__ ((aligned(4)));
 
+    // Configuration descriptor
     uint8_t* _desc_cfg;
     uint8_t  _desc_cfg_buffer[256];
     uint16_t _desc_cfg_len;
@@ -45,8 +47,10 @@ class Adafruit_USBD_Device
     uint8_t  _epin_count;
     uint8_t  _epout_count;
 
+    // String descriptor
     const char* _desc_str_arr[STRING_DESCRIPTOR_MAX];
     uint8_t     _desc_str_count;
+    uint16_t    _desc_str[32+1]; // up to 32 unicode characters with headers
 
   public:
     Adafruit_USBD_Device(void);
@@ -60,10 +64,13 @@ class Adafruit_USBD_Device
     bool addInterface(Adafruit_USBD_Interface& itf);
     void setDescriptorBuffer(uint8_t* buf, uint32_t buflen);
 
+    // String descriptor
     void setLanguageDescriptor(uint16_t language_id);
     void setManufacturerDescriptor(const char *s);
     void setProductDescriptor(const char *s);
+    uint8_t getSerialDescriptor(uint16_t* serial_utf16);
 
+    // Control
     bool begin(uint8_t rhport=0);
     void task(void);
 
@@ -77,12 +84,6 @@ class Adafruit_USBD_Device
     bool detach       (void);
     bool attach       (void);
 
-    //------------- Platform Dependent APIs -------------//
-    uint8_t getSerialDescriptor(uint16_t* serial_str);
-
-  private:
-    void port_InitHardware(uint8_t rhport);
-    void port_Touch1200(void);
 
   private:
     uint16_t const* descriptor_string_cb(uint8_t index, uint16_t langid);

src/arduino/ports/Adafruit_TinyUSB_Port.h

@@ -37,4 +37,9 @@ void TinyUSB_Port_EnterDFU(void);
 // Called by USBDevice.begin()
 void TinyUSB_Port_InitDeviceController(uint8_t rhport);
 
+// Get unique serial number, needed for Serial String Descriptor
+// Fill serial_id (raw bytes) and return its length (limit to 16 bytes)
+// Note: Serial descriptor can be overwritten by user API
+uint8_t TinyUSB_Port_GetSerialNumber(uint8_t serial_id[16]);
+
 #endif

src/arduino/ports/Adafruit_TinyUSB_samd.cpp

@@ -35,18 +35,28 @@
 extern "C"
 {
 
-#if defined(__SAMD51__)
+#if CFG_TUSB_MCU == OPT_MCU_SAMD51 || CFG_TUSB_MCU == OPT_MCU_SAME5X
 
+// SAMD51
 void USB_0_Handler (void) { tud_int_handler(0); }
 void USB_1_Handler (void) { tud_int_handler(0); }
 void USB_2_Handler (void) { tud_int_handler(0); }
 void USB_3_Handler (void) { tud_int_handler(0); }
 
-#else
+#elif CFG_TUSB_MCU == OPT_MCU_SAMD21
 
+// SAMD21
 void USB_Handler(void) { tud_int_handler(0); }
 
 #endif
+
+// run TinyUSB background task when yield()
+void yield(void)
+{
+  tud_task();
+  tud_cdc_write_flush();
+}
+
 } // extern C
 
 
@@ -69,23 +79,7 @@ extern "C" int serial1_printf(const char *__restrict format, ...)
 #endif
 
 //--------------------------------------------------------------------+
-// Core Init & Touch1200
-//--------------------------------------------------------------------+
-
-void TinyUSB_Port_EnterDFU(void)
-{
-  initiateReset(250);
-}
-
-// run TinyUSB background task when yield()
-extern "C" void yield(void)
-{
-  tud_task();
-  tud_cdc_write_flush();
-}
-
-//--------------------------------------------------------------------+
-// Adafruit_USBD_Device platform dependent
+// Porting API
 //--------------------------------------------------------------------+
 void TinyUSB_Port_InitDeviceController(uint8_t rhport)
 {
@@ -131,10 +125,13 @@ void TinyUSB_Port_InitDeviceController(uint8_t rhport)
 #endif
 }
 
-uint8_t Adafruit_USBD_Device::getSerialDescriptor(uint16_t* serial_str)
+void TinyUSB_Port_EnterDFU(void)
 {
-  enum { SERIAL_BYTE_LEN = 16 };
+  initiateReset(250);
+}
 
+uint8_t TinyUSB_Port_GetSerialNumber(uint8_t serial_id[16])
+{
 #ifdef __SAMD51__
   uint32_t* id_addresses[4] = {(uint32_t *) 0x008061FC, (uint32_t *) 0x00806010,
                                (uint32_t *) 0x00806014, (uint32_t *) 0x00806018};
@@ -143,25 +140,14 @@ uint8_t Adafruit_USBD_Device::getSerialDescriptor(uint16_t* serial_str)
                                (uint32_t *) 0x0080A044, (uint32_t *) 0x0080A048};
 #endif
 
-  uint8_t raw_id[SERIAL_BYTE_LEN];
-
-  for (int i=0; i<4; i++) {
-      for (int k=0; k<4; k++) {
-          raw_id[4 * i + (3 - k)] = (*(id_addresses[i]) >> k * 8) & 0xff;
-      }
-  }
-
-  const char nibble_to_hex[16] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'};
+  uint32_t* serial_32 = (uint32_t*) serial_id;
 
-  for (unsigned int i = 0; i < sizeof(raw_id); i++) {
-    for (int j = 0; j < 2; j++) {
-      uint8_t nibble = (raw_id[i] >> (j * 4)) & 0xf;
-      // Strings are UTF-16-LE encoded.
-      serial_str[i * 2 + (1 - j)] = nibble_to_hex[nibble];
-    }
+  for (int i=0; i<4; i++)
+  {
+    *serial_32++ = __builtin_bswap32(*id_addresses[i]);
   }
 
-  return sizeof(raw_id)*2;
+  return 16;
 }
 
 #endif // USE_TINYUSB