usb_ch9.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 PHYTEC Messtechnik GmbH
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#include <zephyr/version.h>
#include <zephyr/sys/util.h>
#include <zephyr/math/ilog2.h>
#include <zephyr/usb/class/usb_hub.h>
 
#ifndef ZEPHYR_INCLUDE_USB_CH9_H_
#define ZEPHYR_INCLUDE_USB_CH9_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct usb_req_type_field {
#ifdef CONFIG_LITTLE_ENDIAN
        uint8_t recipient : 5;
        uint8_t type : 2;
        uint8_t direction : 1;
#else
        uint8_t direction : 1;
        uint8_t type : 2;
        uint8_t recipient : 5;
#endif
} __packed;
 
struct usb_setup_packet {
        union {
                uint8_t bmRequestType;
                struct usb_req_type_field RequestType;
        };
        uint8_t bRequest;
        uint16_t wValue;
        uint16_t wIndex;
        uint16_t wLength;
};
 
#define USB_REQTYPE_DIR_TO_DEVICE       0
#define USB_REQTYPE_DIR_TO_HOST         1
 
#define USB_REQTYPE_TYPE_STANDARD       0
#define USB_REQTYPE_TYPE_CLASS          1
#define USB_REQTYPE_TYPE_VENDOR         2
#define USB_REQTYPE_TYPE_RESERVED       3
 
#define USB_REQTYPE_RECIPIENT_DEVICE    0
#define USB_REQTYPE_RECIPIENT_INTERFACE 1
#define USB_REQTYPE_RECIPIENT_ENDPOINT  2
#define USB_REQTYPE_RECIPIENT_OTHER     3
 
#define USB_REQTYPE_GET_DIR(bmRequestType) (((bmRequestType) >> 7) & 0x01U)
#define USB_REQTYPE_GET_TYPE(bmRequestType) (((bmRequestType) >> 5) & 0x03U)
#define USB_REQTYPE_GET_RECIPIENT(bmRequestType) ((bmRequestType) & 0x1FU)
 
static inline bool usb_reqtype_is_to_host(const struct usb_setup_packet *setup)
{
        return setup->RequestType.direction == USB_REQTYPE_DIR_TO_HOST;
}
 
static inline bool usb_reqtype_is_to_device(const struct usb_setup_packet *setup)
{
        return setup->RequestType.direction == USB_REQTYPE_DIR_TO_DEVICE;
}
 
#define USB_SREQ_GET_STATUS             0x00
#define USB_SREQ_CLEAR_FEATURE          0x01
#define USB_SREQ_SET_FEATURE            0x03
#define USB_SREQ_SET_ADDRESS            0x05
#define USB_SREQ_GET_DESCRIPTOR         0x06
#define USB_SREQ_SET_DESCRIPTOR         0x07
#define USB_SREQ_GET_CONFIGURATION      0x08
#define USB_SREQ_SET_CONFIGURATION      0x09
#define USB_SREQ_GET_INTERFACE          0x0A
#define USB_SREQ_SET_INTERFACE          0x0B
#define USB_SREQ_SYNCH_FRAME            0x0C
 
#define USB_DESC_DEVICE                 1
#define USB_DESC_CONFIGURATION          2
#define USB_DESC_STRING                 3
#define USB_DESC_INTERFACE              4
#define USB_DESC_ENDPOINT               5
#define USB_DESC_DEVICE_QUALIFIER       6
#define USB_DESC_OTHER_SPEED            7
#define USB_DESC_INTERFACE_POWER        8
#define USB_DESC_OTG                    9
#define USB_DESC_DEBUG                  10
#define USB_DESC_INTERFACE_ASSOC        11
#define USB_DESC_BOS                    15
#define USB_DESC_DEVICE_CAPABILITY      16
 
#define USB_DESC_CS_DEVICE              0x21
#define USB_DESC_CS_CONFIGURATION       0x22
#define USB_DESC_CS_STRING              0x23
#define USB_DESC_CS_INTERFACE           0x24
#define USB_DESC_CS_ENDPOINT            0x25
 
#define USB_SFS_ENDPOINT_HALT           0x00
#define USB_SFS_REMOTE_WAKEUP           0x01
#define USB_SFS_TEST_MODE               0x02
 
#define USB_SFS_TEST_MODE_J             0x01
#define USB_SFS_TEST_MODE_K             0x02
#define USB_SFS_TEST_MODE_SE0_NAK       0x03
#define USB_SFS_TEST_MODE_PACKET        0x04
#define USB_SFS_TEST_MODE_FORCE_ENABLE  0x05
 
#define USB_GET_STATUS_SELF_POWERED     BIT(0)
#define USB_GET_STATUS_REMOTE_WAKEUP    BIT(1)
 
struct usb_desc_header {
        uint8_t bLength;
        uint8_t bDescriptorType;
} __packed;
 
struct usb_device_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint16_t bcdUSB;
        uint8_t bDeviceClass;
        uint8_t bDeviceSubClass;
        uint8_t bDeviceProtocol;
        uint8_t bMaxPacketSize0;
        uint16_t idVendor;
        uint16_t idProduct;
        uint16_t bcdDevice;
        uint8_t iManufacturer;
        uint8_t iProduct;
        uint8_t iSerialNumber;
        uint8_t bNumConfigurations;
} __packed;
 
struct usb_device_qualifier_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint16_t bcdUSB;
        uint8_t bDeviceClass;
        uint8_t bDeviceSubClass;
        uint8_t bDeviceProtocol;
        uint8_t bMaxPacketSize0;
        uint8_t bNumConfigurations;
        uint8_t bReserved;
} __packed;
 
struct usb_cfg_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint16_t wTotalLength;
        uint8_t bNumInterfaces;
        uint8_t bConfigurationValue;
        uint8_t iConfiguration;
        uint8_t bmAttributes;
        uint8_t bMaxPower;
} __packed;
 
struct usb_if_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint8_t bInterfaceNumber;
        uint8_t bAlternateSetting;
        uint8_t bNumEndpoints;
        uint8_t bInterfaceClass;
        uint8_t bInterfaceSubClass;
        uint8_t bInterfaceProtocol;
        uint8_t iInterface;
} __packed;
 
struct usb_ep_desc_bmattr {
#ifdef CONFIG_LITTLE_ENDIAN
        uint8_t transfer : 2;
        uint8_t synch: 2;
        uint8_t usage: 2;
        uint8_t reserved: 2;
#else
        uint8_t reserved: 2;
        uint8_t usage : 2;
        uint8_t synch : 2;
        uint8_t transfer : 2;
#endif
} __packed;
 
struct usb_ep_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint8_t bEndpointAddress;
        union {
                uint8_t bmAttributes;
                struct usb_ep_desc_bmattr Attributes;
        };
        uint16_t wMaxPacketSize;
        uint8_t bInterval;
} __packed;
 
struct usb_string_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint16_t bString;
} __packed;
 
struct usb_association_descriptor {
        uint8_t bLength;
        uint8_t bDescriptorType;
        uint8_t bFirstInterface;
        uint8_t bInterfaceCount;
        uint8_t bFunctionClass;
        uint8_t bFunctionSubClass;
        uint8_t bFunctionProtocol;
        uint8_t iFunction;
} __packed;
 
#define USB_SCD_RESERVED        BIT(7)
#define USB_SCD_SELF_POWERED    BIT(6)
#define USB_SCD_REMOTE_WAKEUP   BIT(5)
 
#define USB_BCC_AUDIO                   0x01
#define USB_BCC_CDC_CONTROL             0x02
#define USB_BCC_HID                     0x03
#define USB_BCC_MASS_STORAGE            0x08
#define USB_BCC_CDC_DATA                0x0A
#define USB_BCC_VIDEO                   0x0E
#define USB_BCC_WIRELESS_CONTROLLER     0xE0
#define USB_BCC_MISCELLANEOUS           0xEF
#define USB_BCC_APPLICATION             0xFE
#define USB_BCC_VENDOR                  0xFF
 
#define USB_SRN_1_1                     0x0110
#define USB_SRN_2_0                     0x0200
#define USB_SRN_2_0_1                   0x0201
#define USB_SRN_2_1                     0x0210
 
#define USB_DEC_TO_BCD(dec)     ((((dec) / 10) << 4) | ((dec) % 10))
 
#define USB_BCD_DRN             (USB_DEC_TO_BCD(KERNEL_VERSION_MAJOR) << 8 | \
                                 USB_DEC_TO_BCD(KERNEL_VERSION_MINOR))
 
#define USB_GET_DESCRIPTOR_TYPE(wValue)         ((uint8_t)((wValue) >> 8))
 
#define USB_GET_DESCRIPTOR_INDEX(wValue)        ((uint8_t)(wValue))
 
#define USB_CONTROL_EP_MPS              64U
 
#define USB_EP_DIR_MASK                 (uint8_t)BIT(7)
 
#define USB_EP_DIR_IN                   (uint8_t)BIT(7)
 
#define USB_EP_DIR_OUT                  0U
 
/*
 * REVISE: this should actually be (ep) & 0x0F, but is causes
 * many regressions in the current device support that are difficult
 * to handle.
 */
#define USB_EP_GET_IDX(ep)              ((ep) & ~USB_EP_DIR_MASK)
 
#define USB_EP_GET_DIR(ep)              ((ep) & USB_EP_DIR_MASK)
 
#define USB_EP_GET_ADDR(idx, dir)       ((idx) | ((dir) & USB_EP_DIR_MASK))
 
#define USB_EP_DIR_IS_IN(ep)            (USB_EP_GET_DIR(ep) == USB_EP_DIR_IN)
 
#define USB_EP_DIR_IS_OUT(ep)           (USB_EP_GET_DIR(ep) == USB_EP_DIR_OUT)
 
#define USB_CONTROL_EP_OUT              (USB_EP_DIR_OUT | 0U)
 
#define USB_CONTROL_EP_IN               (USB_EP_DIR_IN | 0U)
 
#define USB_EP_TRANSFER_TYPE_MASK       0x3U
 
#define USB_EP_TYPE_CONTROL             0U
 
#define USB_EP_TYPE_ISO                 1U
 
#define USB_EP_TYPE_BULK                2U
 
#define USB_EP_TYPE_INTERRUPT           3U
 
#define USB_FS_INT_EP_INTERVAL(us)      CLAMP(((us) / 1000U), 1U, 255U)
 
#define USB_HS_INT_EP_INTERVAL(us)      CLAMP((ilog2((us) / 125U) + 1U), 1U, 16U)
 
#define USB_FS_ISO_EP_INTERVAL(us)      CLAMP(((us) / 1000U), 1U, 16U)
 
#define USB_HS_ISO_EP_INTERVAL(us)      CLAMP((ilog2((us) / 125U) + 1U), 1U, 16U)
 
#define USB_MPS_EP_SIZE(mps)            ((mps) & BIT_MASK(11))
 
#define USB_MPS_ADDITIONAL_TRANSACTIONS(mps) (((mps) & 0x1800) >> 11)
 
#define USB_MPS_TO_TPL(mps)     \
        ((1 + USB_MPS_ADDITIONAL_TRANSACTIONS(mps)) * USB_MPS_EP_SIZE(mps))
 
#define USB_TPL_TO_MPS(tpl)                             \
        (((tpl) > 2048) ? ((2 << 11) | ((tpl) / 3)) :   \
         ((tpl) > 1024) ? ((1 << 11) | ((tpl) / 2)) :   \
         (tpl))
 
#define USB_TPL_ROUND_UP(tpl)                           \
        (((tpl) > 2048) ? ROUND_UP(tpl, 3) :            \
         ((tpl) > 1024) ? ROUND_UP(tpl, 2) :            \
         (tpl))
 
#define USB_TPL_IS_VALID(tpl)                           \
        (((tpl) > 3072) ? false :                       \
         ((tpl) > 2048) ? ((tpl) % 3 == 0) :            \
         ((tpl) > 1024) ? ((tpl) % 2 == 0) :            \
         ((tpl) >= 0))
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_USB_CH9_H_ */