Binary Device Object Store (BOS) support API

API reference

group usb_bos

USB Binary Device Object Store support.

Defines

USB_DEVICE_BOS_DESC_DEFINE_CAP

Helper macro to place the BOS compatibility descriptor in the right memory section.

Enums

enum usb_bos_capability_types

Device capability type codes.

Values:

enumerator USB_BOS_CAPABILITY_EXTENSION = 0x02
enumerator USB_BOS_CAPABILITY_PLATFORM = 0x05

Functions

void usb_bos_register_cap(struct usb_bos_platform_descriptor *hdr)

Register BOS capability descriptor.

This function should be used by the application to register BOS capability descriptors before the USB device stack is enabled.

Parameters:
  • hdr[in] Pointer to BOS capability descriptor

struct usb_bos_capability_lpm
#include <bos.h>

BOS USB 2.0 extension capability descriptor.

struct usb_bos_platform_descriptor
#include <bos.h>

BOS platform capability descriptor.

struct usb_bos_capability_webusb
#include <bos.h>

WebUSB specific part of platform capability descriptor.

struct usb_bos_capability_msos
#include <bos.h>

Microsoft OS 2.0 descriptor specific part of platform capability descriptor.