130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * This file holds USB constants and structures that are needed for 330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * USB device APIs. These are used by the USB device model, which is 430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * defined in chapter 9 of the USB 2.0 specification and in the 530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Wireless USB 1.0 (spread around). Linux has several APIs in C that 630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * need these: 730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * - the master/host side Linux-USB kernel driver API; 930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * - the "usbfs" user space API; and 1030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * - the Linux "gadget" slave/device/peripheral side driver API. 1130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 1230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems 1330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * act either as a USB master/host or as a USB slave/device. That means 1430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * the master and slave side APIs benefit from working well together. 1530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 1630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * There's also "Wireless USB", using low power short range radios for 1730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * peripheral interconnection but otherwise building on the USB framework. 1830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 1930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Note all descriptors are declared '__attribute__((packed))' so that: 2030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 2130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * [a] they never get padded, either internally (USB spec writers 2230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * probably handled that) or externally; 2330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 2430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * [b] so that accessing bigger-than-a-bytes fields will never 2530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * generate bus errors on any platform, even when the location of 2630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * its descriptor inside a bundle isn't "naturally aligned", and 2730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 2830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * [c] for consistency, removing all doubt even when it appears to 2930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * someone that the two other points are non-issues for that 3030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * particular descriptor type. 3130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 3230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 3330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#ifndef _UAPI__LINUX_USB_CH9_H 3430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define _UAPI__LINUX_USB_CH9_H 3530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 3630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#include <linux/types.h> /* __u8 etc */ 3730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#include <asm/byteorder.h> /* le16_to_cpu */ 3830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 3930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 4030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 4130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* CONTROL REQUEST SUPPORT */ 4230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 4330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 4430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * USB directions 4530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 4630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * This bit flag is used in endpoint descriptors' bEndpointAddress field. 4730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * It's also one of three fields in control requests bRequestType. 4830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 4930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DIR_OUT 0 /* to device */ 5030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DIR_IN 0x80 /* to host */ 5130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 5230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 5330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * USB types, the second of three bRequestType fields 5430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 5530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_TYPE_MASK (0x03 << 5) 5630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_TYPE_STANDARD (0x00 << 5) 5730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_TYPE_CLASS (0x01 << 5) 5830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_TYPE_VENDOR (0x02 << 5) 5930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_TYPE_RESERVED (0x03 << 5) 6030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 6130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 6230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * USB recipients, the third of three bRequestType fields 6330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 6430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_RECIP_MASK 0x1f 6530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_RECIP_DEVICE 0x00 6630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_RECIP_INTERFACE 0x01 6730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_RECIP_ENDPOINT 0x02 6830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_RECIP_OTHER 0x03 6930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* From Wireless USB 1.0 */ 7030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_RECIP_PORT 0x04 7130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_RECIP_RPIPE 0x05 7230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 7330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 7430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Standard requests, for the bRequest field of a SETUP packet. 7530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 7630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * These are qualified by the bRequestType field, so that for example 7730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved 7830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * by a GET_STATUS request. 7930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 8030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_GET_STATUS 0x00 8130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_CLEAR_FEATURE 0x01 8230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_FEATURE 0x03 8330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_ADDRESS 0x05 8430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_GET_DESCRIPTOR 0x06 8530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_DESCRIPTOR 0x07 8630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_GET_CONFIGURATION 0x08 8730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_CONFIGURATION 0x09 8830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_GET_INTERFACE 0x0A 8930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_INTERFACE 0x0B 9030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SYNCH_FRAME 0x0C 9130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_SEL 0x30 9230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_ISOCH_DELAY 0x31 9330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 9430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ 9530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_GET_ENCRYPTION 0x0E 9630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_RPIPE_ABORT 0x0E 9730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_HANDSHAKE 0x0F 9830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_RPIPE_RESET 0x0F 9930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_GET_HANDSHAKE 0x10 10030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_CONNECTION 0x11 10130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_SECURITY_DATA 0x12 10230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_GET_SECURITY_DATA 0x13 10330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_WUSB_DATA 0x14 10430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_LOOPBACK_DATA_WRITE 0x15 10530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_LOOPBACK_DATA_READ 0x16 10630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_REQ_SET_INTERFACE_DS 0x17 10730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 10830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command, 10930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * used by hubs to put ports into a new L1 suspend state, except that it 11030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * forgot to define its number ... 11130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 11230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 11330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 11430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and 11530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * are read as a bit array returned by USB_REQ_GET_STATUS. (So there 11630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * are at most sixteen features of each type.) Hubs may also support a 11730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend. 11830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 11930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_SELF_POWERED 0 /* (read only) */ 12030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ 12130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ 12230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_BATTERY 2 /* (wireless) */ 12330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ 12430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/ 12530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ 12630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ 12730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ 12830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 12930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 13030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Test Mode Selectors 13130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * See USB 2.0 spec Table 9-7 13230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 13330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define TEST_J 1 13430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define TEST_K 2 13530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define TEST_SE0_NAK 3 13630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define TEST_PACKET 4 13730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define TEST_FORCE_EN 5 13830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 13930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 14030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * New Feature Selectors as added by USB 3.0 14130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * See USB 3.0 spec Table 9-7 14230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 14330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */ 14430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */ 14530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */ 14630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */ 14730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 14830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00 14930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 15030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Suspend Options, Table 9-8 USB 3.0 spec 15130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 15230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_INTRF_FUNC_SUSPEND_LP (1 << (8 + 0)) 15330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_INTRF_FUNC_SUSPEND_RW (1 << (8 + 1)) 15430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 15530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 15630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Interface status, Figure 9-5 USB 3.0 spec 15730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 15830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_INTRF_STAT_FUNC_RW_CAP 1 15930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_INTRF_STAT_FUNC_RW 2 16030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 16130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ 16230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 16330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* Bit array elements as returned by the USB_REQ_GET_STATUS request. */ 16430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */ 16530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */ 16630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */ 16730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 16830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 16930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * struct usb_ctrlrequest - SETUP data for a USB device control request 17030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @bRequestType: matches the USB bmRequestType field 17130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @bRequest: matches the USB bRequest field 17230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @wValue: matches the USB wValue field (le16 byte order) 17330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @wIndex: matches the USB wIndex field (le16 byte order) 17430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @wLength: matches the USB wLength field (le16 byte order) 17530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 17630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * This structure is used to send control requests to a USB device. It matches 17730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the 17830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * USB spec for a fuller description of the different fields, and what they are 17930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * used for. 18030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 18130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Note that the driver for any interface can issue control requests. 18230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * For most devices, interfaces don't coordinate with each other, so 18330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * such requests may be made at any time. 18430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 18530692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_ctrlrequest { 18630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bRequestType; 18730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bRequest; 18830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wValue; 18930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wIndex; 19030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wLength; 19130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 19230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 19330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 19430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 19530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 19630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or 19730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * (rarely) accepted by SET_DESCRIPTOR. 19830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 19930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Note that all multi-byte values here are encoded in little endian 20030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * byte order "on the wire". Within the kernel and when exposed 20130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * through the Linux-USB APIs, they are not converted to cpu byte 20230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * order; it is the responsibility of the client code to do this. 20330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * The single exception is when device and configuration descriptors (but 20430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD); 20530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * in this case the fields are converted to host endianness by the kernel. 20630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 20730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 20830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 20930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Descriptor types ... USB 2.0 spec table 9.5 21030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 21130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_DEVICE 0x01 21230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_CONFIG 0x02 21330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_STRING 0x03 21430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_INTERFACE 0x04 21530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_ENDPOINT 0x05 21630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_DEVICE_QUALIFIER 0x06 21730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_OTHER_SPEED_CONFIG 0x07 21830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_INTERFACE_POWER 0x08 21930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* these are from a minor usb 2.0 revision (ECN) */ 22030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_OTG 0x09 22130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_DEBUG 0x0a 22230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_INTERFACE_ASSOCIATION 0x0b 22330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* these are from the Wireless USB spec */ 22430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_SECURITY 0x0c 22530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_KEY 0x0d 22630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_ENCRYPTION_TYPE 0x0e 22730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_BOS 0x0f 22830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_DEVICE_CAPABILITY 0x10 22930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_WIRELESS_ENDPOINT_COMP 0x11 23030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_WIRE_ADAPTER 0x21 23130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_RPIPE 0x22 23230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_CS_RADIO_CONTROL 0x23 23330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* From the T10 UAS specification */ 23430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_PIPE_USAGE 0x24 23530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* From the USB 3.0 spec */ 23630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_SS_ENDPOINT_COMP 0x30 23730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 23830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* Conventional codes for class-specific descriptors. The convention is 23930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * defined in the USB "Common Class" Spec (3.11). Individual class specs 24030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * are authoritative for their usage, not the "common class" writeup. 24130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 24230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE) 24330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG) 24430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING) 24530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE) 24630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT) 24730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 24830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* All standard descriptors have these 2 fields at the beginning */ 24930692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_descriptor_header { 25030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 25130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 25230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 25330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 25430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 25530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 25630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 25730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_DEVICE: Device descriptor */ 25830692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_device_descriptor { 25930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 26030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 26130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 26230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 bcdUSB; 26330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDeviceClass; 26430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDeviceSubClass; 26530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDeviceProtocol; 26630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bMaxPacketSize0; 26730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 idVendor; 26830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 idProduct; 26930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 bcdDevice; 27030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 iManufacturer; 27130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 iProduct; 27230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 iSerialNumber; 27330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bNumConfigurations; 27430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 27530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 27630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_DEVICE_SIZE 18 27730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 27830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 27930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 28030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Device and/or Interface Class codes 28130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * as found in bDeviceClass or bInterfaceClass 28230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * and defined by www.usb.org documents 28330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 28430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */ 28530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_AUDIO 1 28630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_COMM 2 28730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_HID 3 28830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_PHYSICAL 5 28930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_STILL_IMAGE 6 29030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_PRINTER 7 29130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_MASS_STORAGE 8 29230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_HUB 9 29330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_CDC_DATA 0x0a 29430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_CSCID 0x0b /* chip+ smart card */ 29530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_CONTENT_SEC 0x0d /* content security */ 29630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_VIDEO 0x0e 29730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_WIRELESS_CONTROLLER 0xe0 29830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_MISC 0xef 29930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_APP_SPEC 0xfe 30030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CLASS_VENDOR_SPEC 0xff 30130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 30230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_SUBCLASS_VENDOR_SPEC 0xff 30330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 30430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 30530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 30630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_CONFIG: Configuration descriptor information. 30730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 30830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the 30930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * descriptor type is different. Highspeed-capable devices can look 31030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * different depending on what speed they're currently running. Only 31130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG 31230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * descriptors. 31330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 31430692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_config_descriptor { 31530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 31630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 31730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 31830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wTotalLength; 31930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bNumInterfaces; 32030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bConfigurationValue; 32130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 iConfiguration; 32230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmAttributes; 32330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bMaxPower; 32430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 32530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 32630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_CONFIG_SIZE 9 32730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 32830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* from config descriptor bmAttributes */ 32930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */ 33030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */ 33130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */ 33230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */ 33330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 33430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 33530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 33630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_STRING: String descriptor */ 33730692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_string_descriptor { 33830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 33930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 34030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 34130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wData[1]; /* UTF-16LE encoded */ 34230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 34330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 34430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* note that "string" zero is special, it holds language codes that 34530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * the device supports, not Unicode characters. 34630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 34730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 34830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 34930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 35030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_INTERFACE: Interface descriptor */ 35130692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_interface_descriptor { 35230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 35330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 35430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 35530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bInterfaceNumber; 35630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bAlternateSetting; 35730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bNumEndpoints; 35830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bInterfaceClass; 35930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bInterfaceSubClass; 36030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bInterfaceProtocol; 36130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 iInterface; 36230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 36330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 36430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_INTERFACE_SIZE 9 36530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 36630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 36730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 36830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_ENDPOINT: Endpoint descriptor */ 36930692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_endpoint_descriptor { 37030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 37130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 37230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 37330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bEndpointAddress; 37430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmAttributes; 37530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wMaxPacketSize; 37630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bInterval; 37730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 37830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng /* NOTE: these two are _only_ in audio endpoints. */ 37930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */ 38030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bRefresh; 38130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bSynchAddress; 38230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 38330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 38430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_ENDPOINT_SIZE 7 38530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ 38630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 38730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 38830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 38930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Endpoints 39030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 39130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ 39230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_DIR_MASK 0x80 39330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 39430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ 39530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_XFER_CONTROL 0 39630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_XFER_ISOC 1 39730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_XFER_BULK 2 39830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_XFER_INT 3 39930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 40030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 40130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */ 40230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_INTRTYPE 0x30 40330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_INTR_PERIODIC (0 << 4) 40430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_INTR_NOTIFICATION (1 << 4) 40530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 40630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SYNCTYPE 0x0c 40730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SYNC_NONE (0 << 2) 40830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SYNC_ASYNC (1 << 2) 40930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2) 41030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SYNC_SYNC (3 << 2) 41130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 41230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_USAGE_MASK 0x30 41330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_USAGE_DATA 0x00 41430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_USAGE_FEEDBACK 0x10 41530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */ 41630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 41730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 41830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 41930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 42030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_num - get the endpoint's number 42130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 42230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 42330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns @epd's number: 0 to 15. 42430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 42530692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd) 42630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 42730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK; 42830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 42930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 43030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 43130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_type - get the endpoint's transfer type 43230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 43330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 43430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according 43530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * to @epd's transfer type. 43630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 43730692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd) 43830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 43930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK; 44030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 44130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 44230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 44330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_dir_in - check if the endpoint has IN direction 44430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 44530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 44630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint is of type IN, otherwise it returns false. 44730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 44830692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd) 44930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 45030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN); 45130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 45230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 45330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 45430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_dir_out - check if the endpoint has OUT direction 45530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 45630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 45730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint is of type OUT, otherwise it returns false. 45830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 45930692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_dir_out( 46030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 46130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 46230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT); 46330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 46430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 46530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 46630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type 46730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 46830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 46930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint is of type bulk, otherwise it returns false. 47030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 47130692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_xfer_bulk( 47230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 47330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 47430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 47530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_ENDPOINT_XFER_BULK); 47630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 47730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 47830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 47930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_xfer_control - check if the endpoint has control transfer type 48030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 48130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 48230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint is of type control, otherwise it returns false. 48330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 48430692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_xfer_control( 48530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 48630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 48730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 48830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_ENDPOINT_XFER_CONTROL); 48930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 49030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 49130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 49230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type 49330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 49430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 49530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint is of type interrupt, otherwise it returns 49630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * false. 49730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 49830692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_xfer_int( 49930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 50030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 50130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 50230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_ENDPOINT_XFER_INT); 50330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 50430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 50530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 50630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type 50730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 50830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 50930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint is of type isochronous, otherwise it returns 51030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * false. 51130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 51230692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_xfer_isoc( 51330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 51430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 51530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 51630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_ENDPOINT_XFER_ISOC); 51730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 51830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 51930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 52030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN 52130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 52230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 52330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint has bulk transfer type and IN direction, 52430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * otherwise it returns false. 52530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 52630692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_is_bulk_in( 52730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 52830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 52930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd); 53030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 53130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 53230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 53330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT 53430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 53530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 53630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint has bulk transfer type and OUT direction, 53730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * otherwise it returns false. 53830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 53930692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_is_bulk_out( 54030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 54130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 54230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd); 54330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 54430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 54530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 54630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_is_int_in - check if the endpoint is interrupt IN 54730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 54830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 54930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint has interrupt transfer type and IN direction, 55030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * otherwise it returns false. 55130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 55230692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_is_int_in( 55330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 55430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 55530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd); 55630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 55730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 55830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 55930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT 56030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 56130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 56230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint has interrupt transfer type and OUT direction, 56330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * otherwise it returns false. 56430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 56530692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_is_int_out( 56630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 56730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 56830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd); 56930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 57030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 57130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 57230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN 57330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 57430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 57530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint has isochronous transfer type and IN direction, 57630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * otherwise it returns false. 57730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 57830692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_is_isoc_in( 57930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 58030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 58130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd); 58230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 58330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 58430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 58530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT 58630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 58730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 58830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns true if the endpoint has isochronous transfer type and OUT direction, 58930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * otherwise it returns false. 59030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 59130692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_is_isoc_out( 59230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 59330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 59430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd); 59530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 59630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 59730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/** 59830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * usb_endpoint_maxp - get endpoint's max packet size 59930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * @epd: endpoint to be checked 60030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 60130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Returns @epd's max packet 60230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 60330692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd) 60430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 60530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return __le16_to_cpu(epd->wMaxPacketSize); 60630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 60730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 60830692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int usb_endpoint_interrupt_type( 60930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng const struct usb_endpoint_descriptor *epd) 61030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 61130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return epd->bmAttributes & USB_ENDPOINT_INTRTYPE; 61230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 61330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 61430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 61530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 61630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */ 61730692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_ss_ep_comp_descriptor { 61830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 61930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 62030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 62130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bMaxBurst; 62230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmAttributes; 62330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wBytesPerInterval; 62430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 62530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 62630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_SS_EP_COMP_SIZE 6 62730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 62830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* Bits 4:0 of bmAttributes if this is a bulk endpoint */ 62930692c65c4174412c90e79489e98ab85c1a7412fBen Chengstatic inline int 63030692c65c4174412c90e79489e98ab85c1a7412fBen Chengusb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp) 63130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng{ 63230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng int max_streams; 63330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 63430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng if (!comp) 63530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return 0; 63630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 63730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng max_streams = comp->bmAttributes & 0x1f; 63830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 63930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng if (!max_streams) 64030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return 0; 64130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 64230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng max_streams = 1 << max_streams; 64330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 64430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng return max_streams; 64530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} 64630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 64730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* Bits 1:0 of bmAttributes if this is an isoc endpoint */ 64830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_SS_MULT(p) (1 + ((p) & 0x3)) 64930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 65030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 65130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 65230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */ 65330692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_qualifier_descriptor { 65430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 65530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 65630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 65730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 bcdUSB; 65830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDeviceClass; 65930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDeviceSubClass; 66030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDeviceProtocol; 66130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bMaxPacketSize0; 66230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bNumConfigurations; 66330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bRESERVED; 66430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 66530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 66630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 66730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 66830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 66930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_OTG (from OTG 1.0a supplement) */ 67030692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_otg_descriptor { 67130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 67230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 67330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 67430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmAttributes; /* support for HNP, SRP, etc */ 67530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 67630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 67730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* from usb_otg_descriptor.bmAttributes */ 67830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_OTG_SRP (1 << 0) 67930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_OTG_HNP (1 << 1) /* swap host/device roles */ 68030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 68130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 68230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 68330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_DEBUG: for special highspeed devices, replacing serial console */ 68430692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_debug_descriptor { 68530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 68630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 68730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 68830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng /* bulk endpoints with 8 byte maxpacket */ 68930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDebugInEndpoint; 69030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDebugOutEndpoint; 69130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 69230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 69330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 69430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 69530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */ 69630692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_interface_assoc_descriptor { 69730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 69830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 69930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 70030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bFirstInterface; 70130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bInterfaceCount; 70230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bFunctionClass; 70330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bFunctionSubClass; 70430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bFunctionProtocol; 70530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 iFunction; 70630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 70730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 70830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 70930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 71030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 71130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_SECURITY: group of wireless security descriptors, including 71230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * encryption types available for setting up a CC/association. 71330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 71430692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_security_descriptor { 71530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 71630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 71730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 71830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wTotalLength; 71930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bNumEncryptionTypes; 72030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 72130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 72230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 72330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 72430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys 72530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * may be retrieved. 72630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 72730692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_key_descriptor { 72830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 72930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 73030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 73130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 tTKID[3]; 73230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bReserved; 73330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bKeyData[0]; 73430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 73530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 73630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 73730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 73830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */ 73930692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_encryption_descriptor { 74030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 74130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 74230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 74330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bEncryptionType; 74430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENC_TYPE_UNSECURE 0 74530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */ 74630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */ 74730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */ 74830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bEncryptionValue; /* use in SET_ENCRYPTION */ 74930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bAuthKeyIndex; 75030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 75130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 75230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 75330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 75430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 75530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_BOS: group of device-level capabilities */ 75630692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_bos_descriptor { 75730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 75830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 75930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 76030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wTotalLength; 76130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bNumDeviceCaps; 76230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 76330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 76430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_BOS_SIZE 5 76530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 76630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 76730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_DEVICE_CAPABILITY: grouped with BOS */ 76830692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_dev_cap_header { 76930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 77030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 77130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDevCapabilityType; 77230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 77330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 77430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CAP_TYPE_WIRELESS_USB 1 77530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 77630692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_wireless_cap_descriptor { /* Ultra Wide Band */ 77730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 77830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 77930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDevCapabilityType; 78030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 78130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmAttributes; 78230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_P2P_DRD (1 << 1) 78330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_BEACON_MASK (3 << 2) 78430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_BEACON_SELF (1 << 2) 78530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_BEACON_DIRECTED (2 << 2) 78630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_BEACON_NONE (3 << 2) 78730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wPHYRates; /* bit rates, Mbps */ 78830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_PHY_53 (1 << 0) /* always set */ 78930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_PHY_80 (1 << 1) 79030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_PHY_107 (1 << 2) /* always set */ 79130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_PHY_160 (1 << 3) 79230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_PHY_200 (1 << 4) /* always set */ 79330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_PHY_320 (1 << 5) 79430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_PHY_400 (1 << 6) 79530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_WIRELESS_PHY_480 (1 << 7) 79630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmTFITXPowerInfo; /* TFI power levels */ 79730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmFFITXPowerInfo; /* FFI power levels */ 79830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 bmBandGroup; 79930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bReserved; 80030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 80130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 80230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB 2.0 Extension descriptor */ 80330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_CAP_TYPE_EXT 2 80430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 80530692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_ext_cap_descriptor { /* Link Power Management */ 80630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 80730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 80830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDevCapabilityType; 80930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le32 bmAttributes; 81030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_LPM_SUPPORT (1 << 1) /* supports LPM */ 81130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_BESL_SUPPORT (1 << 2) /* supports BESL */ 81230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/ 81330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */ 81430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8) 81530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12) 81630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 81730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 81830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_USB_EXT_CAP_SIZE 7 81930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 82030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 82130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB 82230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * specific device level capabilities 82330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 82430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_SS_CAP_TYPE 3 82530692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_ss_cap_descriptor { /* Link Power Management */ 82630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 82730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 82830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDevCapabilityType; 82930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmAttributes; 83030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_LTM_SUPPORT (1 << 1) /* supports LTM */ 83130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wSpeedSupported; 83230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */ 83330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */ 83430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */ 83530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */ 83630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bFunctionalitySupport; 83730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bU1devExitLat; 83830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 bU2DevExitLat; 83930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 84030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 84130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_USB_SS_CAP_SIZE 10 84230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 84330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 84430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * Container ID Capability descriptor: Defines the instance unique ID used to 84530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * identify the instance across all operating modes 84630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 84730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define CONTAINER_ID_TYPE 4 84830692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_ss_container_id_descriptor { 84930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 85030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 85130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDevCapabilityType; 85230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bReserved; 85330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 ContainerID[16]; /* 128-bit number */ 85430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 85530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 85630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_DT_USB_SS_CONTN_ID_SIZE 20 85730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 85830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 85930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with 86030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * each endpoint descriptor for a wireless device 86130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 86230692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_wireless_ep_comp_descriptor { 86330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bLength; 86430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bDescriptorType; 86530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 86630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bMaxBurst; 86730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bMaxSequence; 86830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wMaxStreamDelay; 86930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 wOverTheAirPacketSize; 87030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bOverTheAirInterval; 87130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bmCompAttributes; 87230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */ 87330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SWITCH_NO 0 87430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SWITCH_SWITCH 1 87530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_ENDPOINT_SWITCH_SCALE 2 87630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 87730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 87830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 87930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 88030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless 88130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * host and a device for connection set up, mutual authentication, and 88230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * exchanging short lived session keys. The handshake depends on a CC. 88330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 88430692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_handshake { 88530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bMessageNumber; 88630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bStatus; 88730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 tTKID[3]; 88830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 bReserved; 88930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 CDID[16]; 89030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 nonce[16]; 89130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 MIC[8]; 89230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 89330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 89430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 89530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 89630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC). 89730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * A CC may also be set up using non-wireless secure channels (including 89830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * wired USB!), and some devices may support CCs with multiple hosts. 89930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 90030692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_connection_context { 90130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 CHID[16]; /* persistent host id */ 90230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 CDID[16]; /* device id (unique w/in host context) */ 90330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 CK[16]; /* connection key */ 90430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__((packed)); 90530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 90630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 90730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 90830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* USB 2.0 defines three speeds, here's how Linux identifies them */ 90930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 91030692c65c4174412c90e79489e98ab85c1a7412fBen Chengenum usb_device_speed { 91130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_SPEED_UNKNOWN = 0, /* enumerating */ 91230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */ 91330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_SPEED_HIGH, /* usb 2.0 */ 91430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_SPEED_WIRELESS, /* wireless (usb 2.5) */ 91530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_SPEED_SUPER, /* usb 3.0 */ 91630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng}; 91730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 91830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 91930692c65c4174412c90e79489e98ab85c1a7412fBen Chengenum usb_device_state { 92030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng /* NOTATTACHED isn't in the USB spec, and this state acts 92130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * the same as ATTACHED ... but it's clearer this way. 92230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 92330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_NOTATTACHED = 0, 92430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 92530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng /* chapter 9 and authentication (wireless) device states */ 92630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_ATTACHED, 92730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_POWERED, /* wired */ 92830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_RECONNECTING, /* auth */ 92930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_UNAUTHENTICATED, /* auth */ 93030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_DEFAULT, /* limited function */ 93130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_ADDRESS, 93230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_CONFIGURED, /* most functions */ 93330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 93430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB_STATE_SUSPENDED 93530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 93630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng /* NOTE: there are actually four different SUSPENDED 93730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * states, returning to POWERED, DEFAULT, ADDRESS, or 93830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * CONFIGURED respectively when SOF tokens flow again. 93930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * At this level there's no difference between L1 and L2 94030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * suspend states. (L2 being original USB 1.1 suspend.) 94130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 94230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng}; 94330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 94430692c65c4174412c90e79489e98ab85c1a7412fBen Chengenum usb3_link_state { 94530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB3_LPM_U0 = 0, 94630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB3_LPM_U1, 94730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB3_LPM_U2, 94830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng USB3_LPM_U3 94930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng}; 95030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 95130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 95230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1. 95330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 0xff means the parent hub will accept transitions to U1, but will not 95430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * initiate a transition. 95530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 95630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to 95730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * U1 after that many microseconds. Timeouts of 0x80 to 0xFE are reserved 95830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * values. 95930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 96030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2. 96130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 0xff means the parent hub will accept transitions to U2, but will not 96230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * initiate a transition. 96330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 96430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to 96530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * U2 after N*256 microseconds. Therefore a U2 timeout value of 0x1 means a U2 96630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means 96730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * 65.024ms. 96830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 96930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB3_LPM_DISABLED 0x0 97030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB3_LPM_U1_MAX_TIMEOUT 0x7F 97130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB3_LPM_U2_MAX_TIMEOUT 0xFE 97230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB3_LPM_DEVICE_INITIATED 0xFF 97330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 97430692c65c4174412c90e79489e98ab85c1a7412fBen Chengstruct usb_set_sel_req { 97530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 u1_sel; 97630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __u8 u1_pel; 97730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 u2_sel; 97830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng __le16 u2_pel; 97930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng} __attribute__ ((packed)); 98030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 98130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 98230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * The Set System Exit Latency control transfer provides one byte each for 98330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * U1 SEL and U1 PEL, so the max exit latency is 0xFF. U2 SEL and U2 PEL each 98430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * are two bytes long. 98530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 98630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB3_LPM_MAX_U1_SEL_PEL 0xFF 98730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB3_LPM_MAX_U2_SEL_PEL 0xFFFF 98830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 98930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/*-------------------------------------------------------------------------*/ 99030692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 99130692c65c4174412c90e79489e98ab85c1a7412fBen Cheng/* 99230692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * As per USB compliance update, a device that is actively drawing 99330692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * more than 100mA from USB must report itself as bus-powered in 99430692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * the GetStatus(DEVICE) call. 99530692c65c4174412c90e79489e98ab85c1a7412fBen Cheng * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34 99630692c65c4174412c90e79489e98ab85c1a7412fBen Cheng */ 99730692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#define USB_SELF_POWER_VBUS_MAX_DRAW 100 99830692c65c4174412c90e79489e98ab85c1a7412fBen Cheng 99930692c65c4174412c90e79489e98ab85c1a7412fBen Cheng#endif /* _UAPI__LINUX_USB_CH9_H */ 1000