Merge pull request #370 from adafruit/rework-config-descriptor-builder

Rework config descriptor builder

Author: hathach

.github/workflows/githubci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Setup Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
 
@@ -60,7 +60,7 @@ jobs:
 
     steps:
     - name: Setup Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
 

examples/Vendor/i2c_tiny_usb_adapter/Adafruit_USBD_I2C.cpp

@@ -64,15 +64,28 @@ Adafruit_USBD_I2C::Adafruit_USBD_I2C(TwoWire* wire) {
   setStringDescriptor("I2C Interface");
 }
 
-uint16_t Adafruit_USBD_I2C::getInterfaceDescriptor(uint8_t itfnum, uint8_t* buf, uint16_t bufsize) {
-  uint8_t desc[] = { TUD_VENDOR_DESCRIPTOR(itfnum, 0, 0x00, 0x80, 64) };
+uint16_t Adafruit_USBD_I2C::getInterfaceDescriptor(uint8_t itfnum_deprecated, uint8_t* buf, uint16_t bufsize) {
+  uint8_t itfnum = 0;
+  uint8_t ep_in = 0;
+  uint8_t ep_out = 0;
+
+  // null buffer is used to get the length of descriptor only
+  if (buf) {
+    itfnum = TinyUSBDevice.allocInterface(1);
+    ep_in = TinyUSBDevice.allocEndpoint(TUSB_DIR_IN);
+    ep_out = TinyUSBDevice.allocEndpoint(TUSB_DIR_OUT);
+  }
+
+  uint8_t const desc[] = { TUD_VENDOR_DESCRIPTOR(itfnum, _strid, ep_out, ep_in, 64) };
   uint16_t const len = sizeof(desc);
+
   if (buf) {
     if (bufsize < len) {
       return 0;
     }
     memcpy(buf, desc, len);
   }
+
   return len;
 }
 

examples/Vendor/i2c_tiny_usb_adapter/Adafruit_USBD_I2C.h

@@ -88,11 +88,13 @@
 class Adafruit_USBD_I2C : public Adafruit_USBD_Interface {
 public:
   Adafruit_USBD_I2C(TwoWire* wire);
-  uint16_t getInterfaceDescriptor(uint8_t itfnum, uint8_t* buf, uint16_t bufsize);
   bool begin(uint8_t* buffer, size_t bufsize);
 
   bool handleControlTransfer(uint8_t rhport, uint8_t stage, tusb_control_request_t const* request);
 
+  // from Adafruit_USBD_Interface
+  virtual uint16_t getInterfaceDescriptor(uint8_t itfnum, uint8_t* buf, uint16_t bufsize);
+
 private:
   TwoWire* _wire;
   uint8_t _state;

src/arduino/Adafruit_TinyUSB_API.h

@@ -30,7 +30,7 @@
 
 // API Version, need to be updated when there is changes for
 // TinyUSB_API, USBD_CDC, USBD_Device, USBD_Interface,
-#define TINYUSB_API_VERSION 20000
+#define TINYUSB_API_VERSION 20400
 
 //--------------------------------------------------------------------+
 // Core API

src/arduino/Adafruit_USBD_CDC.cpp

@@ -46,21 +46,42 @@ Adafruit_USBD_CDC::Adafruit_USBD_CDC(void) { _instance = INVALID_INSTANCE; }
 
 #if CFG_TUD_ENABLED
 
-#define EPOUT 0x00
-#define EPIN 0x80
-
-uint16_t Adafruit_USBD_CDC::getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
+uint16_t Adafruit_USBD_CDC::getInterfaceDescriptor(uint8_t itfnum_deprecated,
+                                                   uint8_t *buf,
                                                    uint16_t bufsize) {
+  (void)itfnum_deprecated;
+
   // CDC is mostly always existed for DFU
-  // usb core will automatically update endpoint number
-  uint8_t desc[] = {TUD_CDC_DESCRIPTOR(itfnum, 0, EPIN, 8, EPOUT, EPIN, 64)};
+  uint8_t itfnum = 0;
+  uint8_t ep_notif = 0;
+  uint8_t ep_in = 0;
+  uint8_t ep_out = 0;
+
+  if (buf) {
+    itfnum = TinyUSBDevice.allocInterface(2);
+    ep_notif = TinyUSBDevice.allocEndpoint(TUSB_DIR_IN);
+    ep_in = TinyUSBDevice.allocEndpoint(TUSB_DIR_IN);
+    ep_out = TinyUSBDevice.allocEndpoint(TUSB_DIR_OUT);
+  }
+
+#if TINYUSB_API_VERSION < 20400
+  // backward compatible for core that include pre-2.4.0 TinyUSB
+  uint8_t _strid = 0;
+#endif
+
+  uint8_t const desc[] = {
+      TUD_CDC_DESCRIPTOR(itfnum, _strid, ep_notif, 8, ep_out, ep_in, 64)};
+
   uint16_t const len = sizeof(desc);
 
-  if (bufsize < len) {
-    return 0;
+  // null buffer is used to get the length of descriptor only
+  if (buf) {
+    if (bufsize < len) {
+      return 0;
+    }
+    memcpy(buf, desc, len);
   }
 
-  memcpy(buf, desc, len);
   return len;
 }
 
@@ -268,9 +289,10 @@ void tud_cdc_line_state_cb(uint8_t instance, bool dtr, bool rts) {
 // Device stack is not enabled (probably in host mode)
 #warning "TinyUSB Host selected. No output to Serial will occur!"
 
-uint16_t Adafruit_USBD_CDC::getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
+uint16_t Adafruit_USBD_CDC::getInterfaceDescriptor(uint8_t itfnum_deprecated,
+                                                   uint8_t *buf,
                                                    uint16_t bufsize) {
-  (void)itfnum;
+  (void)itfnum_deprecated;
   (void)buf;
   (void)bufsize;
 

src/arduino/Adafruit_USBD_CDC.h

@@ -45,10 +45,6 @@ class Adafruit_USBD_CDC : public Stream, public Adafruit_USBD_Interface {
 
   static uint8_t getInstanceCount(void) { return _instance_count; }
 
-  // from Adafruit_USBD_Interface
-  virtual uint16_t getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
-                                          uint16_t bufsize);
-
   void setPins(uint8_t pin_rx, uint8_t pin_tx) {
     (void)pin_rx;
     (void)pin_tx;
@@ -83,6 +79,10 @@ class Adafruit_USBD_CDC : public Stream, public Adafruit_USBD_Interface {
   using Print::write; // pull in write(str) from Print
   operator bool();
 
+  // from Adafruit_USBD_Interface
+  virtual uint16_t getInterfaceDescriptor(uint8_t itfnum_deprecated,
+                                          uint8_t *buf, uint16_t bufsize);
+
 private:
   enum { INVALID_INSTANCE = 0xffu };
   static uint8_t _instance_count;

src/arduino/Adafruit_USBD_Device.cpp

@@ -235,14 +235,15 @@ bool Adafruit_USBD_Device::addInterface(Adafruit_USBD_Interface &itf) {
   uint8_t *desc = _desc_cfg + _desc_cfg_len;
   uint16_t const len = itf.getInterfaceDescriptor(
       _itf_count, desc, _desc_cfg_maxlen - _desc_cfg_len);
-  uint8_t *desc_end = desc + len;
-
-  const char *desc_str = itf.getStringDescriptor();
 
   if (!len) {
     return false;
   }
 
+#if 0
+  uint8_t *desc_end = desc + len;
+  const char *desc_str = itf.getStringDescriptor();
+
   // Parse interface descriptor to update
   // - IAD: interface number
   // - Interface: number & string descriptor
@@ -321,6 +322,7 @@ bool Adafruit_USBD_Device::addInterface(Adafruit_USBD_Interface &itf) {
 
     desc += tu_desc_len(desc);
   }
+#endif
 
   _desc_cfg_len += len;
 

src/arduino/Adafruit_USBD_Device.h

@@ -71,16 +71,26 @@ class Adafruit_USBD_Device {
 
   //------------- Configuration descriptor -------------//
 
-  // Add an new interface
+  // Add a new interface
   bool addInterface(Adafruit_USBD_Interface &itf);
 
   // Clear/Reset configuration descriptor
   void clearConfiguration(void);
 
-  // Provide user buffer for configuration descriptor, needed if total length >
-  // 256
+  // Provide user buffer for configuration descriptor, if total length > 256
   void setConfigurationBuffer(uint8_t *buf, uint32_t buflen);
 
+  // Allocate a new interface number
+  uint8_t allocInterface(uint8_t count = 1) {
+    uint8_t ret = _itf_count;
+    _itf_count += count;
+    return ret;
+  }
+
+  uint8_t allocEndpoint(uint8_t in) {
+    return in ? (0x80 | _epin_count++) : _epout_count++;
+  }
+
   //------------- String descriptor -------------//
   void setLanguageDescriptor(uint16_t language_id);
   void setManufacturerDescriptor(const char *s);

src/arduino/Adafruit_USBD_Interface.cpp

@@ -0,0 +1,35 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Ha Thach (tinyusb.org) 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.
+ */
+
+#include "tusb_option.h"
+
+#if CFG_TUD_ENABLED
+
+#include "Adafruit_USBD_Device.h"
+
+void Adafruit_USBD_Interface::setStringDescriptor(const char *str) {
+  _strid = TinyUSBDevice.addStringDescriptor(str);
+}
+
+#endif

src/arduino/Adafruit_USBD_Interface.h

@@ -30,18 +30,21 @@
 
 class Adafruit_USBD_Interface {
 protected:
-  const char *_desc_str;
+  uint8_t _strid;
 
 public:
-  Adafruit_USBD_Interface(void) { _desc_str = NULL; }
+  Adafruit_USBD_Interface(void) { _strid = 0; }
 
   // Get Interface Descriptor
   // Fill the descriptor (if buf is not NULL) and return its length
-  virtual uint16_t getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
-                                          uint16_t bufsize) = 0;
+  virtual uint16_t getInterfaceDescriptor(uint8_t itfnum_deprecated,
+                                          uint8_t *buf, uint16_t bufsize) = 0;
+  // Get Interface Descriptor Length
+  uint16_t getInterfaceDescriptorLen() {
+    return getInterfaceDescriptor(0, NULL, 0);
+  }
 
-  void setStringDescriptor(const char *str) { _desc_str = str; }
-  const char *getStringDescriptor(void) { return _desc_str; }
+  void setStringDescriptor(const char *str);
 };
 
 #endif

src/arduino/hid/Adafruit_USBD_HID.cpp

@@ -28,9 +28,6 @@
 
 #include "Adafruit_USBD_HID.h"
 
-#define EPOUT 0x00
-#define EPIN 0x80
-
 uint8_t const _ascii2keycode[128][2] = {HID_ASCII_TO_KEYCODE};
 static Adafruit_USBD_HID *_hid_instances[CFG_TUD_HID] = {0};
 
@@ -94,7 +91,7 @@ Adafruit_USBD_HID::Adafruit_USBD_HID(uint8_t const *desc_report, uint16_t len,
   _instance = _instance_count++;
   _hid_instances[_instance] = this;
 
-  uint16_t const desc_len = getInterfaceDescriptor(0, NULL, 0);
+  uint16_t const desc_len = getInterfaceDescriptorLen();
   tinyusb_enable_interface(USB_INTERFACE_HID, desc_len, hid_load_descriptor);
 #endif
 }
@@ -132,11 +129,11 @@ uint16_t Adafruit_USBD_HID::makeItfDesc(uint8_t itfnum, uint8_t *buf,
     return 0;
   }
 
-  uint8_t const desc_inout[] = {
-      TUD_HID_INOUT_DESCRIPTOR(itfnum, 0, _protocol, _desc_report_len, ep_in,
-                               ep_out, CFG_TUD_HID_EP_BUFSIZE, _interval_ms)};
+  uint8_t const desc_inout[] = {TUD_HID_INOUT_DESCRIPTOR(
+      itfnum, _strid, _protocol, _desc_report_len, ep_in, ep_out,
+      CFG_TUD_HID_EP_BUFSIZE, _interval_ms)};
   uint8_t const desc_in_only[] = {
-      TUD_HID_DESCRIPTOR(itfnum, 0, _protocol, _desc_report_len, ep_in,
+      TUD_HID_DESCRIPTOR(itfnum, _strid, _protocol, _desc_report_len, ep_in,
                          CFG_TUD_HID_EP_BUFSIZE, _interval_ms)};
 
   uint8_t const *desc;
@@ -155,17 +152,32 @@ uint16_t Adafruit_USBD_HID::makeItfDesc(uint8_t itfnum, uint8_t *buf,
     if (bufsize < len) {
       return 0;
     }
-
     memcpy(buf, desc, len);
   }
 
   return len;
 }
 
-uint16_t Adafruit_USBD_HID::getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
+uint16_t Adafruit_USBD_HID::getInterfaceDescriptor(uint8_t itfnum_deprecated,
+                                                   uint8_t *buf,
                                                    uint16_t bufsize) {
-  // usb core will automatically update endpoint number
-  return makeItfDesc(itfnum, buf, bufsize, EPIN, EPOUT);
+  (void)itfnum_deprecated;
+
+  uint8_t itfnum = 0;
+  uint8_t ep_in = 0;
+  uint8_t ep_out = 0;
+
+  // null buffer is used to get the length of descriptor only
+  if (buf) {
+    itfnum = TinyUSBDevice.allocInterface(1);
+    ep_in = TinyUSBDevice.allocEndpoint(TUSB_DIR_IN);
+
+    if (_out_endpoint) {
+      TinyUSBDevice.allocEndpoint(TUSB_DIR_OUT);
+    }
+  }
+
+  return makeItfDesc(itfnum, buf, bufsize, ep_in, ep_out);
 }
 
 bool Adafruit_USBD_HID::begin(void) {

src/arduino/hid/Adafruit_USBD_HID.h

@@ -80,8 +80,8 @@ class Adafruit_USBD_HID : public Adafruit_USBD_Interface {
   bool mouseButtonRelease(uint8_t report_id);
 
   // from Adafruit_USBD_Interface
-  virtual uint16_t getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
-                                          uint16_t bufsize);
+  virtual uint16_t getInterfaceDescriptor(uint8_t itfnum_deprecated,
+                                          uint8_t *buf, uint16_t bufsize);
 
   // internal use only
   uint16_t makeItfDesc(uint8_t itfnum, uint8_t *buf, uint16_t bufsize,