bos.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Intel Corporation
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_USB_BOS_H_
#define ZEPHYR_INCLUDE_USB_BOS_H_
 
#include <stdint.h>
 
#define USB_DEVICE_BOS_DESC_DEFINE_CAP \
        static __in_section(usb, bos_desc_area, 1) __aligned(1) __used
 
enum usb_bos_capability_types {
        USB_BOS_CAPABILITY_EXTENSION = 0x02,
        USB_BOS_CAPABILITY_PLATFORM = 0x05,
};
 
struct usb_bos_capability_lpm {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint8_t bDevCapabilityType;
        uint32_t bmAttributes;
} __packed;
 
struct usb_bos_platform_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint8_t bDevCapabilityType;
        uint8_t bReserved;
        uint8_t PlatformCapabilityUUID[16];
} __packed;
 
struct usb_bos_capability_webusb {
        uint16_t bcdVersion;
        uint8_t bVendorCode;
        uint8_t iLandingPage;
} __packed;
 
struct usb_bos_capability_msos {
        uint32_t dwWindowsVersion;
        uint16_t wMSOSDescriptorSetTotalLength;
        uint8_t bMS_VendorCode;
        uint8_t bAltEnumCode;
} __packed;
 
void usb_bos_register_cap(struct usb_bos_platform_descriptor *hdr);
 
/* BOS Descriptor (root descriptor) */
struct usb_bos_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint16_t wTotalLength;
        uint8_t bNumDeviceCaps;
} __packed;
 
#define USB_DEVICE_BOS_DESC_DEFINE_HDR \
        static __in_section(usb, bos_desc_area, 0) __aligned(1) __used
 
size_t usb_bos_get_length(void);
 
void usb_bos_fix_total_length(void);
 
const void *usb_bos_get_header(void);
 
#if defined(CONFIG_USB_DEVICE_BOS)
int usb_handle_bos(struct usb_setup_packet *setup, int32_t *len, uint8_t **data);
#else
#define usb_handle_bos(x, y, z)         -ENOTSUP
#endif
#endif  /* ZEPHYR_INCLUDE_USB_BOS_H_ */