usb: device_next: allow BOS support to be disabled

Disabling it if not needed can save about 400 bytes of flash memory.

Signed-off-by: Johann Fischer <[email protected]>

Author: jfischer-no

include/zephyr/usb/usbd.h

@@ -667,11 +667,15 @@ static inline void *usbd_class_get_private(const struct usbd_class_data *const c
  * The application defines a BOS capability descriptor node for descriptors
  * such as USB 2.0 Extension Descriptor.
  *
+ * @note It requires Kconfig options USBD_BOS_SUPPORT to be enabled.
+ *
  * @param name       Descriptor node identifier
  * @param len        Device Capability descriptor length
  * @param subset     Pointer to a Device Capability descriptor
  */
 #define USBD_DESC_BOS_DEFINE(name, len, subset)					\
+	BUILD_ASSERT(IS_ENABLED(CONFIG_USBD_BOS_SUPPORT),			\
+		     "USB device BOS support is disabled");			\
 	static struct usbd_desc_node name = {					\
 		.bos = {							\
 			.utype = USBD_DUT_BOS_NONE,				\
@@ -713,6 +717,8 @@ static inline void *usbd_class_get_private(const struct usbd_class_data *const c
  * @param vto_dev   Vendor callback for to-device direction request
  */
 #define USBD_DESC_BOS_VREQ_DEFINE(name, len, subset, vcode, vto_host, vto_dev)	\
+	BUILD_ASSERT(IS_ENABLED(CONFIG_USBD_BOS_SUPPORT),			\
+		     "USB device BOS support is disabled");			\
 	USBD_VREQUEST_DEFINE(vreq_nd_##name, vcode, vto_host, vto_dev);		\
 	static struct usbd_desc_node name = {					\
 		.bos = {							\

samples/subsys/usb/common/Kconfig.sample_usbd

@@ -47,6 +47,7 @@ config SAMPLE_USBD_MAX_POWER
 
 config SAMPLE_USBD_20_EXTENSION_DESC
 	bool "Use default USB 2.0 Extension Descriptor"
+	depends on USBD_BOS_SUPPORT
 	help
 	  Set bcdUSB value to 0201 and use default USB 2.0 Extension Descriptor.
 

samples/subsys/usb/common/sample_usbd_init.c

@@ -60,6 +60,7 @@ USBD_CONFIGURATION_DEFINE(sample_hs_config,
 			  CONFIG_SAMPLE_USBD_MAX_POWER, &hs_cfg_desc);
 /* doc configuration instantiation end */
 
+#if CONFIG_SAMPLE_USBD_20_EXTENSION_DESC
 /*
  * This does not yet provide valuable information, but rather serves as an
  * example, and will be improved in the future.
@@ -72,6 +73,7 @@ static const struct usb_bos_capability_lpm bos_cap_lpm = {
 };
 
 USBD_DESC_BOS_DEFINE(sample_usbext, sizeof(bos_cap_lpm), &bos_cap_lpm);
+#endif
 
 static void sample_fix_code_triple(struct usbd_context *uds_ctx,
 				   const enum usbd_speed speed)
@@ -175,16 +177,16 @@ struct usbd_context *sample_usbd_setup_device(usbd_msg_cb_t msg_cb)
 		/* doc device init-and-msg end */
 	}
 
-	if (IS_ENABLED(CONFIG_SAMPLE_USBD_20_EXTENSION_DESC)) {
-		(void)usbd_device_set_bcd_usb(&sample_usbd, USBD_SPEED_FS, 0x0201);
-		(void)usbd_device_set_bcd_usb(&sample_usbd, USBD_SPEED_HS, 0x0201);
+#if CONFIG_SAMPLE_USBD_20_EXTENSION_DESC
+	(void)usbd_device_set_bcd_usb(&sample_usbd, USBD_SPEED_FS, 0x0201);
+	(void)usbd_device_set_bcd_usb(&sample_usbd, USBD_SPEED_HS, 0x0201);
 
-		err = usbd_add_descriptor(&sample_usbd, &sample_usbext);
-		if (err) {
-			LOG_ERR("Failed to add USB 2.0 Extension Descriptor");
-			return NULL;
-		}
+	err = usbd_add_descriptor(&sample_usbd, &sample_usbext);
+	if (err) {
+		LOG_ERR("Failed to add USB 2.0 Extension Descriptor");
+		return NULL;
 	}
+#endif
 
 	return &sample_usbd;
 }

subsys/usb/device_next/Kconfig

@@ -36,6 +36,13 @@ config USBD_MAX_SPEED
 	default 0 if USBD_MAX_SPEED_FULL
 	default 1 if USBD_MAX_SPEED_HIGH
 
+config USBD_BOS_SUPPORT
+	bool "USB device BOS support"
+	default y
+	help
+	  BOS support can be disabled if the application does not use a BOS
+	  descriptor.
+
 config USBD_SHELL
 	bool "USB device shell"
 	depends on SHELL

subsys/usb/device_next/usbd_ch9.c

@@ -733,6 +733,11 @@ static int sreq_get_desc_bos(struct usbd_context *const uds_ctx,
 	struct usbd_desc_node *desc_nd;
 	size_t len;
 
+	if (!IS_ENABLED(CONFIG_USBD_BOS_SUPPORT)) {
+		errno = -ENOTSUP;
+		return 0;
+	}
+
 	switch (usbd_bus_speed(uds_ctx)) {
 	case USBD_SPEED_FS:
 		dev_dsc = uds_ctx->fs_desc;

subsys/usb/device_next/usbd_desc.c

@@ -93,7 +93,8 @@ struct usbd_desc_node *usbd_get_descriptor(struct usbd_context *const uds_ctx,
 				}
 			}
 
-			if (desc_nd->bDescriptorType == USB_DESC_BOS) {
+			if (IS_ENABLED(CONFIG_USBD_BOS_SUPPORT) &&
+			    desc_nd->bDescriptorType == USB_DESC_BOS) {
 				return desc_nd;
 			}
 		}
@@ -142,7 +143,8 @@ int usbd_add_descriptor(struct usbd_context *const uds_ctx,
 		goto add_descriptor_error;
 	}
 
-	if (desc_nd->bDescriptorType == USB_DESC_BOS) {
+	if (IS_ENABLED(CONFIG_USBD_BOS_SUPPORT) &&
+	    desc_nd->bDescriptorType == USB_DESC_BOS) {
 		if (desc_nd->bos.utype == USBD_DUT_BOS_VREQ) {
 			ret =  usbd_device_register_vreq(uds_ctx, desc_nd->bos.vreq_nd);
 			if (ret) {