wip: descriptor building

dhalbert · dhalbert · commit 64e095891635 · 2021-04-21T23:25:36.000-04:00
diff --git a/ports/atmel-samd/common-hal/microcontroller/Processor.c b/ports/atmel-samd/common-hal/microcontroller/Processor.c
@@ -346,7 +346,7 @@ void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {
 
     for (int i=0; i<4; i++) {
         for (int k=0; k<4; k++) {
-            raw_id[4 * i + k] = (*(id_addresses[i]) >> k * 8) & 0xff;
+            raw_id[4 * i + (3 -k)] = (*(id_addresses[i]) >> k * 8) & 0xff;
         }
     }
 }
diff --git a/ports/atmel-samd/mpconfigport.mk b/ports/atmel-samd/mpconfigport.mk
@@ -20,8 +20,6 @@ endif
 
 INTERNAL_LIBM = 1
 
-USB_SERIAL_NUMBER_LENGTH = 32
-
 # Number of USB endpoint pairs.
 USB_NUM_EP = 8
 
diff --git a/ports/cxd56/mpconfigport.mk b/ports/cxd56/mpconfigport.mk
@@ -1,4 +1,3 @@
-USB_SERIAL_NUMBER_LENGTH = 10
 USB_HIGHSPEED = 1
 USB_RENUMBER_ENDPOINTS = 0
 USB_CDC_EP_NUM_NOTIFICATION = 3
diff --git a/ports/esp32s2/mpconfigport.mk b/ports/esp32s2/mpconfigport.mk
@@ -6,9 +6,6 @@ MPY_TOOL_LONGINT_IMPL = -mlongint-impl=mpz
 # Internal math library is substantially smaller than toolchain one
 INTERNAL_LIBM = 1
 
-# Chip supplied serial number, in bytes
-USB_SERIAL_NUMBER_LENGTH = 12
-
 # Longints can be implemented as mpz, as longlong, or not
 LONGINT_IMPL = MPZ
 
diff --git a/ports/litex/mpconfigport.mk b/ports/litex/mpconfigport.mk
@@ -9,9 +9,6 @@ INTERNAL_LIBM = 1
 # Number of USB endpoint pairs.
 USB_NUM_EP = 16
 
-# Chip supplied serial number, in bytes
-USB_SERIAL_NUMBER_LENGTH = 30
-
 # Longints can be implemented as mpz, as longlong, or not
 LONGINT_IMPL = MPZ
 
diff --git a/ports/mimxrt10xx/mpconfigport.mk b/ports/mimxrt10xx/mpconfigport.mk
@@ -14,7 +14,6 @@ endif
 
 INTERNAL_LIBM = 1
 
-USB_SERIAL_NUMBER_LENGTH = 32
 USB_HIGHSPEED = 1
 
 # Number of USB endpoint pairs.
diff --git a/ports/nrf/mpconfigport.mk b/ports/nrf/mpconfigport.mk
@@ -9,8 +9,6 @@ MPY_TOOL_LONGINT_IMPL = -mlongint-impl=mpz
 
 INTERNAL_LIBM = 1
 
-USB_SERIAL_NUMBER_LENGTH = 16
-
 # Number of USB endpoint pairs.
 USB_NUM_EP = 8
 
diff --git a/ports/raspberrypi/mpconfigport.mk b/ports/raspberrypi/mpconfigport.mk
@@ -47,8 +47,6 @@ CIRCUITPY_AUDIOMIXER ?= 0
 
 INTERNAL_LIBM = 1
 
-USB_SERIAL_NUMBER_LENGTH = 16
-
 # Number of USB endpoint pairs.
 USB_NUM_EP = 8
 
diff --git a/ports/stm/mpconfigport.mk b/ports/stm/mpconfigport.mk
@@ -1,7 +1,6 @@
 MPY_TOOL_LONGINT_IMPL ?= -mlongint-impl=mpz
 LONGINT_IMPL ?= MPZ
 INTERNAL_LIBM ?= 1
-USB_SERIAL_NUMBER_LENGTH ?= 24
 
 ifeq ($(MCU_VARIANT),$(filter $(MCU_VARIANT),STM32F405xx STM32F407xx))
 	CIRCUITPY_CANIO = 1
diff --git a/shared-module/storage/__init__.c b/shared-module/storage/__init__.c
@@ -58,7 +58,7 @@ static const uint8_t storage_usb_msc_descriptor_template[] = {
     // MSC Endpoint IN Descriptor
     0x07,        //  9 bLength
     0x05,        // 10 bDescriptorType (Endpoint)
-    0xFF,        // 11 bEndpointAddress (IN/D2H) [SET AT RUNTIME: 0x8 | number]
+    0xFF,        // 11 bEndpointAddress (IN/D2H) [SET AT RUNTIME: 0x80 | number]
 #define MSC_IN_ENDPOINT_INDEX 11
     0x02,        // 12 bmAttributes (Bulk)
     0x40, 0x00,  // 13,14 wMaxPacketSize 64
@@ -81,12 +81,21 @@ size_t storage_usb_descriptor_length(void) {
     return sizeof(usb_msc_descriptor);
 }
 
-size_t storage_usb_add_descriptor(uint8_t *descriptor_buf, uint8_t interface_number, uint8_t in_endpoint, uint8_t out_endpoint, uint8_t interface_string) {
+static const char[] storage_interface_name =  USB_INTERFACE_NAME " Mass Storage";
+
+size_t storage_usb_add_descriptor(uint8_t *descriptor_buf, uint8_t *current_interface, uint8_t *current_endpoint, uint8_t* current_interface_string) {
     memcpy(descriptor_buf, storage_usb_msc_descriptor_template, sizeof(storage_usb_msc_descriptor_template));
-    descriptor_buf[MSC_INTERFACE_INDEX] = interface_number;
-    descriptor_buf[MSC_INTERFACE_STRING_INDEX] = interface_string;
-    descriptor_buf[MSC_IN_ENDPOINT_INDEX] = in_endpoint_address;
-    descriptor_buf[MSC_OUT_ENDPOINT_INDEX] = 0x80 | out_endpoint_address;
+    descriptor_buf[MSC_INTERFACE_INDEX] = *current_interface;
+    (*current_interface)++;
+
+    descriptor_buf[MSC_IN_ENDPOINT_INDEX] = USB_MSC_EP_NUM_IN ? USB_MSC_EP_NUM_IN : *current_endpoint;
+    descriptor_buf[MSC_OUT_ENDPOINT_INDEX] = 0x80 | (USB_MSC_EP_NUM_OUT ? USB_MSC_EP_NUM_OUT : *current_endpoint);
+    (*current_endpoint)++:
+
+    usb_add_interface_string(*current_interface_string,);
+    descriptor_buf[MSC_INTERFACE_STRING_INDEX] = *current_interface_string;
+    (*current_interface_string)++;
+
     return sizeof(storage_usb_msc_descriptor_template);
 }
 
diff --git a/shared-module/storage/__init__.h b/shared-module/storage/__init__.h
@@ -31,6 +31,6 @@ extern bool storage_usb_enabled;
 
 void storage_init(void);
 size_t storage_usb_descriptor_length(void);
-size_t storage_usb_add_descriptor(uint8_t *descriptor_buf, uint8_t interface, uint8_t in_endpoint, uint8_t out_endpoint, uint8_tt interface_string);
+size_t storage_usb_add_descriptor(uint8_t *descriptor_buf, uint8_t *current_interface, uint8_t *current_endpoint, uint8_t* current_interface_string);
 
 #endif // SHARED_MODULE_STORAGE___INIT___H
diff --git a/shared-module/usb_cdc/__init__.c b/shared-module/usb_cdc/__init__.c
@@ -140,21 +140,48 @@ size_t usb_cdc_descriptor_length(void) {
     return sizeof(usb_cdc_descriptor_template);
 }
 
-size_t usb_cdc_add_descriptor(uint8_t *descriptor_buf, uint8 comm_interface, uint8_t data_interface, uint8_t control_in_endpoint, uint8_t data_in_endpoint, uint8_t data_out_endpoint, uint8_t comm_interface_string, uint8_t data_interface_string) {
+static const char[] repl_cdc_comm_interface_name = USB_INTERFACE_NAME " CDC control";
+static const char[] data_cdc_comm_interface_name = USB_INTERFACE_NAME " CDC2 control";
+static const char[] repl_cdc_data_interface_name = USB_INTERFACE_NAME " CDC data";
+static const char[] data_cdc_data_interface_name = USB_INTERFACE_NAME " CDC2 data";
+
+size_t usb_cdc_add_descriptor(uint8_t *descriptor_buf, uint8_t *current_interface, uint8_t *current_endpoint, uint8_t* current_interface_string, bool repl) {
     memcpy(descriptor_buf, usb_midi_descriptor_template, sizeof(usb_midi_descriptor_template));
-    descriptor_buf[CDC_FIRST_INTERFACE_INDEX] = comm_interface;
-    descriptor_buf[CDC_COMM_INTERFACE_INDEX] = comm_interface;
-    descriptor_buf[CDC_CALL_MANAGEMENT_DATA_INTERFACE_INDEX] = data_interface;
-    descriptor_buf[CDC_UNION_MASTER_INTERFACE_INDEX] = comm_interface;
-    descriptor_buf[CDC_UNION_SLAVE_INTERFACE_INDEX] = data_interface;
-    descriptor_buf[CDC_DATA_INTERFACE_INDEX] = data_interface;
-
-    descriptor_buf[CDC_CONTROL_IN_ENDPOINT_INDEX] = control_in_endpoint;
-    descriptor_buf[CDC_DATA_OUT_ENDPOINT_INDEX] = data_out_endpoint;
-    descriptor_buf[CDC_DATA_IN_ENDPOINT_INDEX] = data_in_endpoint;
-
-    descriptor_buf[CDC_COMM_INTERFACE_STRING_INDEX] = comm_interface_string;
-    descriptor_buf[CDC_DATA_INTERFACE_STRING_INDEX] = data_interface_string;
+
+    // Store comm interface number.
+    descriptor_buf[CDC_FIRST_INTERFACE_INDEX] = *current_interface;
+    descriptor_buf[CDC_COMM_INTERFACE_INDEX] = *current_interface;
+    descriptor_buf[CDC_UNION_MASTER_INTERFACE_INDEX] = *current_interface;
+    (*current_interface)++;
+
+    // Now store data interface number.
+    descriptor_buf[CDC_CALL_MANAGEMENT_DATA_INTERFACE_INDEX] = *current_interface;
+    descriptor_buf[CDC_UNION_SLAVE_INTERFACE_INDEX] = *current_interface;
+    descriptor_buf[CDC_DATA_INTERFACE_INDEX] = *current_interface;
+
+    descriptor_buf[CDC_CONTROL_IN_ENDPOINT_INDEX] = repl
+        ? (USB_CDC_EP_NUM_NOTIFICATION ? USB_CDC_EP_NUM_NOTIFICATION : *current_endpoint)
+        : (USB_CDC2_EP_NUM_NOTIFICATION ? USB_CDC2_EP_NUM_NOTIFICATION : *current_endpoint);
+    (*current_endpoint)++;
+
+    descriptor_buf[CDC_DATA_OUT_ENDPOINT_INDEX] = repl
+        ? (USB_CDC_EP_NUM_DATA_OUT ? USB_CDC_EP_NUM_DATA_OUT : *current_endpoint)
+        : (USB_CDC2_EP_NUM_DATA_OUT ? USB_CDC2_EP_NUM_DATA_OUT : *current_endpoint);
+
+    descriptor_buf[CDC_DATA_IN_ENDPOINT_INDEX] = repl
+        ? (USB_CDC_EP_NUM_DATA_IN ? USB_CDC_EP_NUM_DATA_IN : *current_endpoint)
+        : (USB_CDC2_EP_NUM_DATA_IN ? USB_CDC2_EP_NUM_DATA_IN : *current_endpoint);
+    (*current_endpoint)++;
+
+    usb_add_interface_string(*current_interface_string,
+                             repl ? repl_cdc_comm_interface_name : data_cdc_comm_interface_name);
+    descriptor_buf[CDC_COMM_INTERFACE_STRING_INDEX] = *current_interface_string;
+    (*current_interface_string)++;
+
+    usb_add_interface_string(*current_interface_string,
+                             repl ? repl_cdc_data_interface_name : data_cdc_data_interface_name);
+    descriptor_buf[CDC_DATA_INTERFACE_STRING_INDEX] = *current_interface_string;
+    (*current_interface_string)++;
 
     return sizeof(usb_midi_descriptor_template);
 }
diff --git a/shared-module/usb_cdc/__init__.h b/shared-module/usb_cdc/__init__.h
@@ -34,6 +34,6 @@ extern bool usb_cdc_data_enabled;
 
 void usb_cdc_init(void);
 size_t usb_cdc_descriptor_length(void);
-size_t usb_cdc_add_descriptor(uint8_t *descriptor_buf, uint8 comm_interface, uint8_t data_interface, uint8_t control_in_endpoint, uint8_t data_in_endpoint, uint8_t data_out_endpoint, uint8_t comm_interface_string, uint8_t data_interface_string);
+size_t usb_cdc_add_descriptor(uint8_t *descriptor_buf, uint8_t *current_interface, uint8_t *current_endpoint, uint8_t* current_interface_string, bool repl);
 
 #endif /* SHARED_MODULE_USB_CDC___INIT___H */
diff --git a/shared-module/usb_hid/__init__.c b/shared-module/usb_hid/__init__.c
@@ -24,4 +24,51 @@
  * THE SOFTWARE.
  */
 
-// Nothing needed here. Tables of HID devices are generated in autogen_usb_descriptor.c at compile-time.
+static const uint8_t usb_hid_descriptor_template[] = {
+    0x09,        //  0 bLength
+    0x21,        //  1 bDescriptorType (HID)
+    0x11, 0x01,  //  2 bcdHID 1.11
+    0x00,        //  3 bCountryCode
+    0x01,        //  4 bNumDescriptors
+    0x22,        //  5 bDescriptorType[0] (HID)
+    0xFF, 0xFF,  //  6,7 wDescriptorLength[0]   [SET AT RUNTIME: lo, hi]
+#define HID_DESCRIPTOR_LENGTH_INDEX 6
+
+    0x07,        //  8 bLength
+    0x05,        //  9 bDescriptorType (Endpoint)
+    0xFF,        // 10 bEndpointAddress (IN/D2H) [SET AT RUNTIME: 0x80 | endpoint]
+#define HID_IN_ENDPOINT_INDEX 10
+    0x03,        // 11 bmAttributes (Interrupt)
+    0x40, 0x00,  // 12,13  wMaxPacketSize 64
+    0x08,        // 14 bInterval 8 (unit depends on device speed)
+
+    0x07,        // 15 bLength
+    0x05,        // 16 bDescriptorType (Endpoint)
+    0xFF,        // 17 bEndpointAddress (OUT/H2D)  [SET AT RUNTIME]
+#define HID_OUT_ENDPOINT_INDEX 17
+    0x03,        // 18 bmAttributes (Interrupt)
+    0x40, 0x00,  // 19,20 wMaxPacketSize 64
+    0x08,        // 21 bInterval 8 (unit depends on device speed)
+};
+
+// Is the HID device enabled?
+bool usb_hid_enabled;
+
+size_t usb_hid_descriptor_length(void) {
+    return sizeof(usb_hid_descriptor);
+}
+
+static const char[] usb_hid_interface_name =  USB_INTERFACE_NAME " Mass Storage";
+
+size_t usb_hid_add_descriptor(uint8_t *descriptor_buf, uint8_t *current_interface, uint8_t *current_endpoint, uint8_t* current_interface_string, uint16_t report_descriptor_length) {
+    memcpy(descriptor_buf, usb_hid_descriptor_template, sizeof(usb_hid_descriptor_template));
+
+    descriptor_buf[HID_DESCRIPTOR_LENGTH_INDEX] = report_descriptor_length & 0xFF;
+    descriptor_buf[HID_DESCRIPTOR_LENGTH_INDEX + 1] = (report_descriptor_length >> 8);
+
+    descriptor_buf[HID_IN_ENDPOINT_INDEX] = USB_HID_EP_NUM_IN ? USB_HID_EP_NUM_IN : *current_endpoint;
+    descriptor_buf[HID_OUT_ENDPOINT_INDEX] = 0x80 | (USB_HID_EP_NUM_OUT ? USB_HID_EP_NUM_OUT : *current_endpoint);
+    (*current_endpoint)++:
+
+    return sizeof(usb_hid_descriptor_template);
+}
diff --git a/shared-module/usb_midi/__init__.c b/shared-module/usb_midi/__init__.c
@@ -163,21 +163,41 @@ size_t usb_midi_descriptor_length(void) {
     return sizeof(usb_midi_descriptor_template);
 }
 
-size_t usb_midi_add_descriptor(uint8_t *descriptor_buf,
-                         uint8_t audio_control_interface, uint8_t midi_streaming_interface, uint8_t midi_streaming_in_endpoint, uint8_t midi_streaming_out_endpoint, uint8_t audio_control_interface_string, uint8_t midi_streaming_interface_string, uint8_t in_jack_string, uint8_t out_jack_string) {
+static const char[] midi_streaming_interface_name =  USB_INTERFACE_NAME " MIDI";
+static const char[] midi_audio_control_interface_name = USB_INTERFACE_NAME " Audio";
+static const char[] midi_in_jack_name =  USB_INTERFACE_NAME " usb_midi.ports[0]";
+static const char[] midi_out_jack_name =  USB_INTERFACE_NAME " usb_midi.ports[0]";
+
+size_t usb_midi_add_descriptor(uint8_t *descriptor_buf, uint8_t *current_interface, uint8_t *current_endpoint, uint8_t* current_interface_string) {
     memcpy(descriptor_buf, usb_midi_descriptor_template, sizeof(usb_midi_descriptor_template));
-    descriptor_buf[MIDI_AUDIO_CONTROL_INTERFACE_NUMBER_INDEX] = audio_control_interface_number;
-    descriptor_buf[MIDI_AUDIO_CONTROL_INTERFACE_STRING_INDEX] = audio_control_interface_string;
 
-    descriptor_buf[MSC_IN_ENDPOINT_INDEX] = midi_streaming_in_endpoint;
-    descriptor_buf[MSC_OUT_ENDPOINT_INDEX] = 0x80 | midi_streaming_out_endpoint;
+    descriptor_buf[MIDI_AUDIO_CONTROL_INTERFACE_NUMBER_INDEX] = *current_interface;
+    (*current_interface)++;
+
+    descriptor_buf[MSC_IN_ENDPOINT_INDEX] = USB_MIDI_EP_NUM_IN ? USB_MIDI_EP_NUM_IN : *current_endpoint;
+    descriptor_buf[MSC_OUT_ENDPOINT_INDEX] =
+        0x80 | (USB_MIDI_EP_NUM_OUT ? USB_MIDI_EP_NUM_OUT : *current_endpoint);
+    (*current_endpoint)++;
+
+    descriptor_buf[MIDI_STREAMING_INTERFACE_NUMBER_INDEX] = *current_interface;
+    descriptor_buf[MIDI_STREAMING_INTERFACE_NUMBER_INDEX_2] = *current_interface;
+    (*current_interface)++;
+
+    usb_add_interface_string(*current_interface, midi_streaming_interface_name);
+    descriptor_buf[MIDI_STREAMING_INTERFACE_STRING_INDEX] = *current_interface;
+    (*current_interface_string)++;
+
+    usb_add_interface_string(*current_interface, midi_audio_control_interface_name);
+    descriptor_buf[MIDI_AUDIO_CONTROL_INTERFACE_STRING_INDEX] = *current_interface;
+    (*current_interface_string)++;
 
-    descriptor_buf[MIDI_STREAMING_INTERFACE_NUMBER_INDEX] = midi_streaming_interface_number;
-    descriptor_buf[MIDI_STREAMING_INTERFACE_NUMBER_INDEX_2] = midi_streaming_interface_number;
-    descriptor_buf[MIDI_STREAMING_INTERFACE_STRING_INDEX] = midi_streaming_interface_string;
+    usb_add_interface_string(*current_interface, midi_in_jack_name);
+    descriptor_buf[MIDI_IN_JACK_STRING_INDEX] = *current_interface;
+    (*current_interface_string)++;
 
-    descriptor_buf[MIDI_IN_JACK_STRING_INDEX] = in_jack_string;
-    descriptor_buf[MIDI_OUT_JACK_STRING_INDEX] = out_jack_string;
+    usb_add_interface_string(*current_interface, midi_out_jack_name);
+    descriptor_buf[MIDI_OUT_JACK_STRING_INDEX] = *current_interface;
+    (*current_interface_string)++;
 
     return sizeof(usb_midi_descriptor_template);
 }
diff --git a/shared-module/usb_midi/__init__.h b/shared-module/usb_midi/__init__.h
@@ -33,6 +33,6 @@ void usb_midi_init(void);
 void usb_midi_usb_init(void);
 
 size_t usb_midi_descriptor_length(void);
-size_t usb_midi_add_descriptor(uint8_t *descriptor_buf, uint8_t audio_control_interface, uint8_t midi_streaming_interface, uint8_t midi_streaming_in_endpoint, uint8_t midi_streaming_out_endpoint, uint8_t audio_control_interface_string, uint8_t midi_streaming_interface_string, uint8_t in_jack_string, uint8_t out_jack_string);
+size_t usb_midi_add_descriptor(uint8_t *descriptor_buf, uint8_t *current_interface, uint8_t *current_endpoint, uint8_t* current_interface_string);
 
 #endif /* SHARED_MODULE_USB_MIDI___INIT___H */
diff --git a/supervisor/shared/usb/usb.c b/supervisor/shared/usb/usb.c
@@ -51,27 +51,6 @@ extern const tusb_desc_webusb_url_t desc_webusb_url;
 static bool web_serial_connected = false;
 #endif
 
-
-
-// Serial number as hex characters. This writes directly to the USB
-// descriptor.
-extern uint16_t usb_serial_number[1 + COMMON_HAL_MCU_PROCESSOR_UID_LENGTH * 2];
-
-void load_serial_number(void) {
-    // create serial number based on device unique id
-    uint8_t raw_id[COMMON_HAL_MCU_PROCESSOR_UID_LENGTH];
-    common_hal_mcu_processor_get_uid(raw_id);
-
-    usb_serial_number[0] = 0x300 | sizeof(usb_serial_number);
-    for (int i = 0; i < COMMON_HAL_MCU_PROCESSOR_UID_LENGTH; i++) {
-        for (int j = 0; j < 2; j++) {
-            uint8_t nibble = (raw_id[i] >> (j * 4)) & 0xf;
-            // Strings are UTF-16-LE encoded.
-            usb_serial_number[1 + i * 2 + j] = nibble_to_hex_upper[nibble];
-        }
-    }
-}
-
 bool usb_enabled(void) {
     return tusb_inited();
 }
@@ -80,8 +59,13 @@ MP_WEAK void post_usb_init(void) {
 }
 
 void usb_init(void) {
+    usb_build_device_descriptor();
+    usb_build_configuration_descriptor();
+    usb_build_hid_descriptor();
+    usb_build_string_descriptors();
+
+
     init_usb_hardware();
-    load_serial_number();
 
     tusb_init();
 
diff --git a/supervisor/shared/usb/usb_desc.c b/supervisor/shared/usb/usb_desc.c
diff --git a/supervisor/supervisor.mk b/supervisor/supervisor.mk
diff --git a/supervisor/usb.h b/supervisor/usb.h

Original file line number	Diff line number	Diff line change
`@@ -346,7 +346,7 @@ void common_hal_mcu_processor_get_uid(uint8_t raw_id[]) {`
`346`	`346`
`347`	`347`	`for (int i=0; i<4; i++) {`
`348`	`348`	`for (int k=0; k<4; k++) {`
`349`		`- raw_id[4 * i + k] = ((id_addresses[i]) >> k 8) & 0xff;`
	`349`	`+ raw_id[4 * i + (3 -k)] = ((id_addresses[i]) >> k 8) & 0xff;`
`350`	`350`	`}`
`351`	`351`	`}`
`352`	`352`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-USB_SERIAL_NUMBER_LENGTH = 10`
`2`	`1`	`USB_HIGHSPEED = 1`
`3`	`2`	`USB_RENUMBER_ENDPOINTS = 0`
`4`	`3`	`USB_CDC_EP_NUM_NOTIFICATION = 3`