Add Binary Object Store (BOS) descriptor support.

Author: whitequark

examples/boot-uf2-dfu/Makefile

@@ -2,8 +2,8 @@ TARGET    = boot-uf2-dfu
 LIBRARIES = fx2 fx2usb fx2dfu fx2usbmassstor fx2uf2 fx2isrs
 MODEL     = medium
 
-CODE_SIZE ?= 0x3c00
-XRAM_SIZE ?= 0x0400
+CODE_SIZE ?= 0x3d00
+XRAM_SIZE ?= 0x0300
 
 LIBFX2  = ../../firmware/library
 include $(LIBFX2)/fx2rules.mk

firmware/library/include/fx2usb.h

@@ -160,6 +160,8 @@ struct usb_descriptor_set {
   usb_configuration_set_c     *configs;
   uint8_t                      string_count;
   usb_ascii_string_c          *strings;
+  uint8_t                      capability_count;
+  usb_desc_generic_c          *capabilities;
 };
 
 typedef __code const struct usb_descriptor_set

firmware/library/include/usb.h

@@ -54,6 +54,12 @@ enum usb_descriptor {
   USB_DESC_DEVICE_QUALIFIER = 6,
   USB_DESC_OTHER_SPEED_CONFIGURATION = 7,
   USB_DESC_INTERFACE_POWER  = 8,
+  USB_DESC_BINARY_OBJECT_STORE = 15,
+  USB_DESC_DEVICE_CAPABILITY = 16,
+};
+
+enum usb_device_capability {
+  USB_DEV_CAP_PLATFORM      = 5,
 };
 
 enum usb_feature {
@@ -232,4 +238,14 @@ struct usb_desc_string {
 typedef __code const struct usb_desc_string
   usb_desc_string_c;
 
+struct usb_desc_binary_object_store {
+  uint8_t  bLength;
+  uint8_t  bDescriptorType;
+  uint16_t wTotalLength;
+  uint8_t  bNumDeviceCaps;
+};
+
+typedef __code const struct usb_desc_binary_object_store
+  usb_binary_object_store_c;
+
 #endif

firmware/library/usb.c

@@ -213,6 +213,22 @@ void usb_serve_descriptor(usb_descriptor_set_c *set,
       *buf++ = 0;
       scratch[0] += 2;
     }
+  } else if(type == USB_DESC_BINARY_OBJECT_STORE && index == 0) {
+    __xdata struct usb_desc_binary_object_store *bos_desc =
+      (__xdata struct usb_desc_binary_object_store *)buf;
+    bos_desc->bLength = sizeof(struct usb_desc_binary_object_store);
+    bos_desc->bDescriptorType = USB_DESC_BINARY_OBJECT_STORE;
+    // bos_desc->wTotalLength filled in later
+    bos_desc->bNumDeviceCaps = set->capability_count;
+    buf += bos_desc->bLength;
+    __code const struct usb_desc_generic *dev_cap_desc = set->capabilities;
+    for(uint8_t i = 0; i < set->capability_count; i++) {
+      APPEND(dev_cap_desc);
+      dev_cap_desc++;
+    }
+    bos_desc->wTotalLength = (uint16_t)(buf - scratch);
+    SETUP_EP0_IN_DATA(scratch, bos_desc->wTotalLength);
+    return;
   } else {
     STALL_EP0();
     return;