usb.h

Go to the documentation of this file.

/*
 * Copyright (c) 1998 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Lennart Augustsson (lennart@augustsson.net) at
 * Carlstedt Research & Technology.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *        This product includes software developed by the NetBSD
 *        Foundation, Inc. and its contributors.
 * 4. Neither the name of The NetBSD Foundation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
/* Modified by Synopsys, Inc, 12/12/2007 */
 
 
#ifndef _USB_H_
#define _USB_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * The USB records contain some unaligned little-endian word
 * components.  The U[SG]ETW macros take care of both the alignment
 * and endian problem and should always be used to access non-byte
 * values.
 */
typedef u8 uByte;
typedef u8 uWord[2];
typedef u8 uDWord[4];
 
#define USETW2(w,h,l) ((w)[0] = (u8)(l), (w)[1] = (u8)(h))
#define UCONSTW(x)  { (x) & 0xffU, ((x) >> 8) & 0xffU }
#define UCONSTDW(x) { (x) & 0xffU, ((x) >> 8) & 0xffU, \
              ((x) >> 16) & 0xffU, ((x) >> 24) & 0xffU }
 
#if 1
#define UGETW(w) ((w)[0] | ((uint16_t)(w)[1] << 8))
#define USETW(w,v) ((w)[0] = (u8)(v), (w)[1] = (u8)((v) >> 8))
#define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((uint32_t)(w)[3] << 24))
#define USETDW(w,v) ((w)[0] = (u8)(v), \
             (w)[1] = (u8)((v) >> 8), \
             (w)[2] = (u8)((v) >> 16), \
             (w)[3] = (u8)((v) >> 24))
#else
/*
 * On little-endian machines that can handle unaligned accesses
 * (e.g. i386) these macros can be replaced by the following.
 */
#define UGETW(w) (*(u_int16_t *)(w))
#define USETW(w,v) (*(u_int16_t *)(w) = (v))
#define UGETDW(w) (*(u_int32_t *)(w))
#define USETDW(w,v) (*(u_int32_t *)(w) = (v))
#endif
 
/*
 * Macros for accessing UAS IU fields, which are big-endian
 */
#define IUSETW2(w,h,l) ((w)[0] = (u8)(h), (w)[1] = (u8)(l))
#define IUCONSTW(x) { ((x) >> 8) & 0xff, (x) & 0xff }
#define IUCONSTDW(x)    { ((x) >> 24) & 0xff, ((x) >> 16) & 0xff, \
            ((x) >> 8) & 0xff, (x) & 0xff }
#define IUGETW(w) (((w)[0] << 8) | (w)[1])
#define IUSETW(w,v) ((w)[0] = (u8)((v) >> 8), (w)[1] = (u8)(v))
#define IUGETDW(w) (((w)[0] << 24) | ((w)[1] << 16) | ((w)[2] << 8) | (w)[3])
#define IUSETDW(w,v) ((w)[0] = (u8)((v) >> 24), \
              (w)[1] = (u8)((v) >> 16), \
              (w)[2] = (u8)((v) >> 8), \
              (w)[3] = (u8)(v))
 
//#define UPACKED __attribute__((__packed__))
 
typedef struct {
    uByte       bmRequestType;
    uByte       bRequest;
    uWord       wValue;
    uWord       wIndex;
    uWord       wLength;
} UPACKED usb_device_request_t;
 
#define UT_GET_DIR(a) ((a) & 0x80)
#define UT_WRITE        0x00
#define UT_READ         0x80
 
#define UT_GET_TYPE(a) ((a) & 0x60U)
#define UT_STANDARD     0x00U
#define UT_CLASS        0x20U
#define UT_VENDOR       0x40U
 
#define UT_GET_RECIPIENT(a) ((a) & 0x1fU)
#define UT_DEVICE       0x00
#define UT_INTERFACE        0x01
#define UT_ENDPOINT     0x02
#define UT_OTHER        0x03
 
#define UT_READ_DEVICE      (UT_READ  | UT_STANDARD | UT_DEVICE)
#define UT_READ_INTERFACE   (UT_READ  | UT_STANDARD | UT_INTERFACE)
#define UT_READ_ENDPOINT    (UT_READ  | UT_STANDARD | UT_ENDPOINT)
#define UT_WRITE_DEVICE     (UT_WRITE | UT_STANDARD | UT_DEVICE)
#define UT_WRITE_INTERFACE  (UT_WRITE | UT_STANDARD | UT_INTERFACE)
#define UT_WRITE_ENDPOINT   (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
#define UT_READ_CLASS_DEVICE    (UT_READ  | UT_CLASS | UT_DEVICE)
#define UT_READ_CLASS_INTERFACE (UT_READ  | UT_CLASS | UT_INTERFACE)
#define UT_READ_CLASS_OTHER (UT_READ  | UT_CLASS | UT_OTHER)
#define UT_READ_CLASS_ENDPOINT  (UT_READ  | UT_CLASS | UT_ENDPOINT)
#define UT_WRITE_CLASS_DEVICE   (UT_WRITE | UT_CLASS | UT_DEVICE)
#define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
#define UT_WRITE_CLASS_OTHER    (UT_WRITE | UT_CLASS | UT_OTHER)
#define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT)
#define UT_READ_VENDOR_DEVICE   (UT_READ  | UT_VENDOR | UT_DEVICE)
#define UT_READ_VENDOR_INTERFACE (UT_READ  | UT_VENDOR | UT_INTERFACE)
#define UT_READ_VENDOR_OTHER    (UT_READ  | UT_VENDOR | UT_OTHER)
#define UT_READ_VENDOR_ENDPOINT (UT_READ  | UT_VENDOR | UT_ENDPOINT)
#define UT_WRITE_VENDOR_DEVICE  (UT_WRITE | UT_VENDOR | UT_DEVICE)
#define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
#define UT_WRITE_VENDOR_OTHER   (UT_WRITE | UT_VENDOR | UT_OTHER)
#define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
 
/* Requests */
#define UR_GET_STATUS       0x00
#define  USTAT_STANDARD_STATUS  0x00
#define  WUSTAT_WUSB_FEATURE    0x01
#define  WUSTAT_CHANNEL_INFO    0x02
#define  WUSTAT_RECEIVED_DATA   0x03
#define  WUSTAT_MAS_AVAILABILITY 0x04
#define  WUSTAT_CURRENT_TRANSMIT_POWER 0x05
#define UR_CLEAR_FEATURE    0x01
#define UR_SET_FEATURE      0x03
#define UR_SET_AND_TEST_FEATURE 0x0c
#define UR_SET_ADDRESS      0x05
#define UR_GET_DESCRIPTOR   0x06
#define  UDESC_DEVICE       0x01
#define  UDESC_CONFIG       0x02
#define  UDESC_STRING       0x03
#define  UDESC_INTERFACE    0x04
#define  UDESC_ENDPOINT     0x05
#define  UDESC_SS_USB_COMPANION 0x30
#define  UDESC_DEVICE_QUALIFIER 0x06
#define  UDESC_OTHER_SPEED_CONFIGURATION 0x07
#define  UDESC_INTERFACE_POWER  0x08
#define  UDESC_OTG      0x09
#define  WUDESC_SECURITY    0x0c
#define  WUDESC_KEY     0x0d
#define   WUD_GET_KEY_INDEX(_wValue_) ((_wValue_) & 0xf)
#define   WUD_GET_KEY_TYPE(_wValue_) (((_wValue_) & 0x30) >> 4)
#define    WUD_KEY_TYPE_ASSOC   0x01
#define    WUD_KEY_TYPE_GTK 0x02
#define   WUD_GET_KEY_ORIGIN(_wValue_) (((_wValue_) & 0x40) >> 6)
#define    WUD_KEY_ORIGIN_HOST  0x00
#define    WUD_KEY_ORIGIN_DEVICE 0x01
#define  WUDESC_ENCRYPTION_TYPE 0x0e
#define  WUDESC_BOS     0x0f
#define  WUDESC_DEVICE_CAPABILITY 0x10
#define  WUDESC_WIRELESS_ENDPOINT_COMPANION 0x11
#define  UDESC_BOS      0x0f
#define  UDESC_DEVICE_CAPABILITY 0x10
#define  UDESC_CS_DEVICE    0x21    /* class specific */
#define  UDESC_CS_CONFIG    0x22
#define  UDESC_CS_STRING    0x23
#define  UDESC_CS_INTERFACE 0x24
#define  UDESC_CS_ENDPOINT  0x25
#define  UDESC_HUB      0x29
#define UR_SET_DESCRIPTOR   0x07
#define UR_GET_CONFIG       0x08
#define UR_SET_CONFIG       0x09
#define UR_GET_INTERFACE    0x0a
#define UR_SET_INTERFACE    0x0b
#define UR_SYNCH_FRAME      0x0c
#define UR_SET_SEL      0x30
#define UR_SET_ISOC_DELAY   0x31
#define WUR_SET_ENCRYPTION  0x0d
#define WUR_GET_ENCRYPTION  0x0e
#define WUR_SET_HANDSHAKE   0x0f
#define WUR_GET_HANDSHAKE   0x10
#define WUR_SET_CONNECTION  0x11
#define WUR_SET_SECURITY_DATA   0x12
#define WUR_GET_SECURITY_DATA   0x13
#define WUR_SET_WUSB_DATA   0x14
#define  WUDATA_DRPIE_INFO  0x01
#define  WUDATA_TRANSMIT_DATA   0x02
#define  WUDATA_TRANSMIT_PARAMS 0x03
#define  WUDATA_RECEIVE_PARAMS  0x04
#define  WUDATA_TRANSMIT_POWER  0x05
#define WUR_LOOPBACK_DATA_WRITE 0x15
#define WUR_LOOPBACK_DATA_READ  0x16
#define WUR_SET_INTERFACE_DS    0x17
 
/* Feature numbers */
#define UF_ENDPOINT_HALT    0U
#define UF_DEVICE_REMOTE_WAKEUP 1
#define UF_TEST_MODE        2
#define UF_DEVICE_B_HNP_ENABLE  3
#define UF_DEVICE_A_HNP_SUPPORT 4
#define UF_DEVICE_A_ALT_HNP_SUPPORT 5
#define WUF_WUSB        3
#define  WUF_TX_DRPIE       0x0
#define  WUF_DEV_XMIT_PACKET    0x1
#define  WUF_COUNT_PACKETS  0x2
#define  WUF_CAPTURE_PACKETS    0x3
#define UF_FUNCTION_SUSPEND 0
#define UF_U1_ENABLE        48
#define UF_U2_ENABLE        49
#define UF_LTM_ENABLE       50
 
/* Class requests from the USB 2.0 hub spec, table 11-15 */
#define UCR_CLEAR_HUB_FEATURE       (0x2000 | UR_CLEAR_FEATURE)
#define UCR_CLEAR_PORT_FEATURE      (0x2300 | UR_CLEAR_FEATURE)
#define UCR_GET_HUB_DESCRIPTOR      (0xa000 | UR_GET_DESCRIPTOR)
#define UCR_GET_HUB_STATUS      (0xa000 | UR_GET_STATUS)
#define UCR_GET_PORT_STATUS     (0xa300 | UR_GET_STATUS)
#define UCR_SET_HUB_FEATURE     (0x2000 | UR_SET_FEATURE)
#define UCR_SET_PORT_FEATURE        (0x2300 | UR_SET_FEATURE)
#define UCR_SET_AND_TEST_PORT_FEATURE   (0xa300 | UR_SET_AND_TEST_FEATURE)
 
#ifdef _MSC_VER
#include <pshpack1.h>
#endif
 
typedef struct {
    uByte       bLength;
    uByte       bDescriptorType;
    uByte       bDescriptorSubtype;
} UPACKED usb_descriptor_t;
 
typedef struct {
    uByte       bLength;
    uByte       bDescriptorType;
} UPACKED usb_descriptor_header_t;
 
typedef struct {
    uByte       bLength;
    uByte       bDescriptorType;
    uWord       bcdUSB;
#define UD_USB_2_0      0x0200
#define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0)
    uByte       bDeviceClass;
    uByte       bDeviceSubClass;
    uByte       bDeviceProtocol;
    uByte       bMaxPacketSize;
    /* The fields below are not part of the initial descriptor. */
    uWord       idVendor;
    uWord       idProduct;
    uWord       bcdDevice;
    uByte       iManufacturer;
    uByte       iProduct;
    uByte       iSerialNumber;
    uByte       bNumConfigurations;
} UPACKED usb_device_descriptor_t;
#define USB_DEVICE_DESCRIPTOR_SIZE 18
 
typedef struct {
    uByte       bLength;
    uByte       bDescriptorType;
    uWord       wTotalLength;
    uByte       bNumInterface;
    uByte       bConfigurationValue;
    uByte       iConfiguration;
#define UC_ATT_ONE      (1U << 7)   /* must be set */
#define UC_ATT_SELFPOWER    (1U << 6)   /* self powered */
#define UC_ATT_WAKEUP       (1 << 5)    /* can wakeup */
#define UC_ATT_BATTERY      (1 << 4)    /* battery powered */
    uByte       bmAttributes;
#define UC_BUS_POWERED      0x80
#define UC_SELF_POWERED     0x40
#define UC_REMOTE_WAKEUP    0x20
    uByte       bMaxPower; /* max current in 2 mA units */
#define UC_POWER_FACTOR 2
} UPACKED usb_config_descriptor_t;
#define USB_CONFIG_DESCRIPTOR_SIZE 9
 
typedef struct {
    uByte       bLength;
    uByte       bDescriptorType;
    uByte       bInterfaceNumber;
    uByte       bAlternateSetting;
    uByte       bNumEndpoints;
    uByte       bInterfaceClass;
    uByte       bInterfaceSubClass;
    uByte       bInterfaceProtocol;
    uByte       iInterface;
} UPACKED usb_interface_descriptor_t;
#define USB_INTERFACE_DESCRIPTOR_SIZE 9
 
typedef struct usb_endpoint_descriptor_t{
    uByte       bLength;                
    uByte       bDescriptorType;        
    uByte       bEndpointAddress;       
#define UE_GET_DIR(a)       ((a) & 0x80U)
#define UE_SET_DIR(a,d)     ((a) | (((d)&1) << 7))
#define UE_DIR_IN           ((uByte)0x80U)
#define UE_DIR_OUT          ((uByte)0x00U)
#define UE_ADDR             ((uByte)0x0f)
#define UE_GET_ADDR(a)      ((a) & UE_ADDR)
    uByte       bmAttributes;
#define UE_XFERTYPE         ((uByte)0x03U)
#define UE_CONTROL          ((uByte)0x00U)
#define UE_ISOCHRONOUS      ((uByte)0x01U)
#define UE_BULK             ((uByte)0x02U)
#define UE_INTERRUPT        ((uByte)0x03U)
#define UE_GET_XFERTYPE(a)  ((a) & UE_XFERTYPE)
#define UE_ISO_TYPE         ((uByte)0x0cU)
#define UE_ISO_ASYNC        ((uByte)0x04U)
#define UE_ISO_ADAPT        ((uByte)0x08U)
#define UE_ISO_SYNC         ((uByte)0x0cU)
#define UE_GET_ISO_TYPE(a)  ((a) & UE_ISO_TYPE)
    uWord       wMaxPacketSize;         
    uByte       bInterval;              
} UPACKED usb_endpoint_descriptor_t;
#define USB_ENDPOINT_DESCRIPTOR_SIZE 7
 
typedef struct ss_endpoint_companion_descriptor {
    uByte bLength;
    uByte bDescriptorType;
    uByte bMaxBurst;
#define USSE_GET_MAX_STREAMS(a)     ((a) & 0x1fU)
#define USSE_SET_MAX_STREAMS(a, b)  ((a) | ((b) & 0x1f))
#define USSE_GET_MAX_PACKET_NUM(a)  ((a) & 0x03U)
#define USSE_SET_MAX_PACKET_NUM(a, b)   ((a) | ((b) & 0x03))
    uByte bmAttributes;
    uWord wBytesPerInterval;
} UPACKED ss_endpoint_companion_descriptor_t;
#define USB_SS_ENDPOINT_COMPANION_DESCRIPTOR_SIZE 6
 
typedef struct {
    uByte       bLength;
    uByte       bDescriptorType;
    uWord       bString[127];
} UPACKED usb_string_descriptor_t;
#define USB_MAX_STRING_LEN 128
#define USB_LANGUAGE_TABLE 0    /* # of the string language id table */
 
/* Hub specific request */
#define UR_GET_BUS_STATE    0x02
#define UR_CLEAR_TT_BUFFER  0x08
#define UR_RESET_TT     0x09
#define UR_GET_TT_STATE     0x0a
#define UR_STOP_TT      0x0b
 
/* Hub features */
#define UHF_C_HUB_LOCAL_POWER   0
#define UHF_C_HUB_OVER_CURRENT  1
#define UHF_PORT_CONNECTION 0
#define UHF_PORT_ENABLE     1
#define UHF_PORT_SUSPEND    2
#define UHF_PORT_OVER_CURRENT   3
#define UHF_PORT_RESET      4
#define UHF_PORT_L1     5
#define UHF_PORT_POWER      8
#define UHF_PORT_LOW_SPEED  9
#define UHF_PORT_HIGH_SPEED 10
#define UHF_C_PORT_CONNECTION   16
#define UHF_C_PORT_ENABLE   17
#define UHF_C_PORT_SUSPEND  18
#define UHF_C_PORT_OVER_CURRENT 19
#define UHF_C_PORT_RESET    20
#define UHF_C_PORT_L1       23
#define UHF_PORT_TEST       21
#define UHF_PORT_INDICATOR  22
 
typedef struct {
    uByte       bDescLength;
    uByte       bDescriptorType;
    uByte       bNbrPorts;
    uWord       wHubCharacteristics;
#define UHD_PWR         0x0003
#define  UHD_PWR_GANGED     0x0000
#define  UHD_PWR_INDIVIDUAL 0x0001
#define  UHD_PWR_NO_SWITCH  0x0002
#define UHD_COMPOUND        0x0004
#define UHD_OC          0x0018
#define  UHD_OC_GLOBAL      0x0000
#define  UHD_OC_INDIVIDUAL  0x0008
#define  UHD_OC_NONE        0x0010
#define UHD_TT_THINK        0x0060
#define  UHD_TT_THINK_8     0x0000
#define  UHD_TT_THINK_16    0x0020
#define  UHD_TT_THINK_24    0x0040
#define  UHD_TT_THINK_32    0x0060
#define UHD_PORT_IND        0x0080
    uByte       bPwrOn2PwrGood; /* delay in 2 ms units */
#define UHD_PWRON_FACTOR 2
    uByte       bHubContrCurrent;
    uByte       DeviceRemovable[32]; /* max 255 ports */
#define UHD_NOT_REMOV(desc, i) \
    (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
    /* deprecated */ uByte      PortPowerCtrlMask[1];
} UPACKED usb_hub_descriptor_t;
#define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */
 
typedef struct {
    uByte       bLength;
    uByte       bDescriptorType;
    uWord       bcdUSB;
    uByte       bDeviceClass;
    uByte       bDeviceSubClass;
    uByte       bDeviceProtocol;
    uByte       bMaxPacketSize0;
    uByte       bNumConfigurations;
    uByte       bReserved;
} UPACKED usb_device_qualifier_t;
#define USB_DEVICE_QUALIFIER_SIZE 10
 
typedef struct {
    uByte       bLength;
    uByte       bDescriptorType;
    uByte       bmAttributes;
#define UOTG_SRP    0x01
#define UOTG_HNP    0x02
} UPACKED usb_otg_descriptor_t;
 
/* OTG feature selectors */
#define UOTG_B_HNP_ENABLE   3
#define UOTG_A_HNP_SUPPORT  4
#define UOTG_A_ALT_HNP_SUPPORT  5
#define UOTG_NTF_HOST_REL   51
#define UOTG_B3_RSP_ENABLE  52
 
typedef struct {
    uWord       wStatus;
/* Device status flags */
#define UDS_SELF_POWERED        0x0001
#define UDS_REMOTE_WAKEUP       0x0002
/* Endpoint status flags */
#define UES_HALT            0x0001
} UPACKED usb_status_t;
 
typedef struct {
    uWord       wHubStatus;
#define UHS_LOCAL_POWER         0x0001
#define UHS_OVER_CURRENT        0x0002
    uWord       wHubChange;
} UPACKED usb_hub_status_t;
 
typedef struct {
    uWord       wPortStatus;
#define UPS_CURRENT_CONNECT_STATUS  0x0001
#define UPS_PORT_ENABLED        0x0002
#define UPS_SUSPEND         0x0004
#define UPS_OVERCURRENT_INDICATOR   0x0008
#define UPS_RESET           0x0010
#define UPS_PORT_POWER          0x0100
#define UPS_LOW_SPEED           0x0200
#define UPS_HIGH_SPEED          0x0400
#define UPS_PORT_TEST           0x0800
#define UPS_PORT_INDICATOR      0x1000
    uWord       wPortChange;
#define UPS_C_CONNECT_STATUS        0x0001
#define UPS_C_PORT_ENABLED      0x0002
#define UPS_C_SUSPEND           0x0004
#define UPS_C_OVERCURRENT_INDICATOR 0x0008
#define UPS_C_PORT_RESET        0x0010
} UPACKED usb_port_status_t;
 
#ifdef _MSC_VER
#include <poppack.h>
#endif
 
/* Device class codes */
#define UDCLASS_IN_INTERFACE    0x00
#define UDCLASS_COMM        0x02
#define UDCLASS_HUB     0x09
#define  UDSUBCLASS_HUB     0x00
#define  UDPROTO_FSHUB      0x00
#define  UDPROTO_HSHUBSTT   0x01
#define  UDPROTO_HSHUBMTT   0x02
#define UDCLASS_DIAGNOSTIC  0xdc
#define UDCLASS_WIRELESS    0xe0
#define  UDSUBCLASS_RF      0x01
#define   UDPROTO_BLUETOOTH 0x01
#define UDCLASS_VENDOR      0xff
 
/* Interface class codes */
#define UICLASS_UNSPEC      0x00
 
#define UICLASS_AUDIO       0x01
#define  UISUBCLASS_AUDIOCONTROL    1
#define  UISUBCLASS_AUDIOSTREAM     2
#define  UISUBCLASS_MIDISTREAM      3
 
#define UICLASS_CDC     0x02 /* communication */
#define  UISUBCLASS_DIRECT_LINE_CONTROL_MODEL   1
#define  UISUBCLASS_ABSTRACT_CONTROL_MODEL  2
#define  UISUBCLASS_TELEPHONE_CONTROL_MODEL 3
#define  UISUBCLASS_MULTICHANNEL_CONTROL_MODEL  4
#define  UISUBCLASS_CAPI_CONTROLMODEL       5
#define  UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
#define  UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
#define   UIPROTO_CDC_AT            1
 
#define UICLASS_HID     0x03
#define  UISUBCLASS_BOOT    1
#define  UIPROTO_BOOT_KEYBOARD  1
 
#define UICLASS_PHYSICAL    0x05
 
#define UICLASS_IMAGE       0x06
 
#define UICLASS_PRINTER     0x07
#define  UISUBCLASS_PRINTER 1
#define  UIPROTO_PRINTER_UNI    1
#define  UIPROTO_PRINTER_BI 2
#define  UIPROTO_PRINTER_1284   3
 
#define UICLASS_MASS        0x08
#define  UISUBCLASS_RBC     1
#define  UISUBCLASS_SFF8020I    2
#define  UISUBCLASS_QIC157  3
#define  UISUBCLASS_UFI     4
#define  UISUBCLASS_SFF8070I    5
#define  UISUBCLASS_SCSI    6
#define  UIPROTO_MASS_CBI_I 0
#define  UIPROTO_MASS_CBI   1
#define  UIPROTO_MASS_BBB_OLD   2   /* Not in the spec anymore */
#define  UIPROTO_MASS_BBB   80  /* 'P' for the Iomega Zip drive */
 
#define UICLASS_HUB     0x09
#define  UISUBCLASS_HUB     0
#define  UIPROTO_FSHUB      0
#define  UIPROTO_HSHUBSTT   0 /* Yes, same as previous */
#define  UIPROTO_HSHUBMTT   1
 
#define UICLASS_CDC_DATA    0x0a
#define  UISUBCLASS_DATA        0
#define   UIPROTO_DATA_ISDNBRI      0x30    /* Physical iface */
#define   UIPROTO_DATA_HDLC     0x31    /* HDLC */
#define   UIPROTO_DATA_TRANSPARENT  0x32    /* Transparent */
#define   UIPROTO_DATA_Q921M        0x50    /* Management for Q921 */
#define   UIPROTO_DATA_Q921     0x51    /* Data for Q921 */
#define   UIPROTO_DATA_Q921TM       0x52    /* TEI multiplexer for Q921 */
#define   UIPROTO_DATA_V42BIS       0x90    /* Data compression */
#define   UIPROTO_DATA_Q931     0x91    /* Euro-ISDN */
#define   UIPROTO_DATA_V120     0x92    /* V.24 rate adaption */
#define   UIPROTO_DATA_CAPI     0x93    /* CAPI 2.0 commands */
#define   UIPROTO_DATA_HOST_BASED   0xfd    /* Host based driver */
#define   UIPROTO_DATA_PUF      0xfe    /* see Prot. Unit Func. Desc.*/
#define   UIPROTO_DATA_VENDOR       0xff    /* Vendor specific */
 
#define UICLASS_SMARTCARD   0x0b
 
/*#define UICLASS_FIRM_UPD  0x0c*/
 
#define UICLASS_SECURITY    0x0d
 
#define UICLASS_DIAGNOSTIC  0xdc
 
#define UICLASS_WIRELESS    0xe0
#define  UISUBCLASS_RF          0x01
#define   UIPROTO_BLUETOOTH     0x01
 
#define UICLASS_APPL_SPEC   0xfe
#define  UISUBCLASS_FIRMWARE_DOWNLOAD   1
#define  UISUBCLASS_IRDA        2
#define  UIPROTO_IRDA           0
 
#define UICLASS_VENDOR      0xff
 
#define USB_HUB_MAX_DEPTH 5
 
/*
 * Minimum time a device needs to be powered down to go through
 * a power cycle.  XXX Are these time in the spec?
 */
#define USB_POWER_DOWN_TIME 200 /* ms */
#define USB_PORT_POWER_DOWN_TIME    100 /* ms */
 
#if 0
/* These are the values from the spec. */
#define USB_PORT_RESET_DELAY    10  /* ms */
#define USB_PORT_ROOT_RESET_DELAY 50  /* ms */
#define USB_PORT_RESET_RECOVERY 10  /* ms */
#define USB_PORT_POWERUP_DELAY  100 /* ms */
#define USB_SET_ADDRESS_SETTLE  2   /* ms */
#define USB_RESUME_DELAY    (20*5)  /* ms */
#define USB_RESUME_WAIT     10  /* ms */
#define USB_RESUME_RECOVERY 10  /* ms */
#define USB_EXTRA_POWER_UP_TIME 0   /* ms */
#else
/* Allow for marginal (i.e. non-conforming) devices. */
#define USB_PORT_RESET_DELAY    50  /* ms */
#define USB_PORT_ROOT_RESET_DELAY 250  /* ms */
#define USB_PORT_RESET_RECOVERY 250  /* ms */
#define USB_PORT_POWERUP_DELAY  300 /* ms */
#define USB_SET_ADDRESS_SETTLE  10  /* ms */
#define USB_RESUME_DELAY    (50*5)  /* ms */
#define USB_RESUME_WAIT     50  /* ms */
#define USB_RESUME_RECOVERY 50  /* ms */
#define USB_EXTRA_POWER_UP_TIME 20  /* ms */
#endif
 
#define USB_MIN_POWER       100 /* mA */
#define USB_MAX_POWER       500 /* mA */
 
#define USB_BUS_RESET_DELAY 100 /* ms XXX?*/
 
#define USB_UNCONFIG_NO 0
#define USB_UNCONFIG_INDEX (-1)
 
/*** ioctl() related stuff ***/
 
struct usb_ctl_request {
    int ucr_addr;
    usb_device_request_t ucr_request;
    void    *ucr_data;
    int ucr_flags;
#define USBD_SHORT_XFER_OK  0x04    /* allow short reads */
    int ucr_actlen;     /* actual length transferred */
};
 
struct usb_alt_interface {
    int uai_config_index;
    int uai_interface_index;
    int uai_alt_no;
};
 
#define USB_CURRENT_CONFIG_INDEX (-1)
#define USB_CURRENT_ALT_INDEX (-1)
 
struct usb_config_desc {
    int ucd_config_index;
    usb_config_descriptor_t ucd_desc;
};
 
struct usb_interface_desc {
    int uid_config_index;
    int uid_interface_index;
    int uid_alt_index;
    usb_interface_descriptor_t uid_desc;
};
 
struct usb_endpoint_desc {
    int ued_config_index;
    int ued_interface_index;
    int ued_alt_index;
    int ued_endpoint_index;
    usb_endpoint_descriptor_t ued_desc;
};
 
struct usb_full_desc {
    int ufd_config_index;
    u_int   ufd_size;
    u_char  *ufd_data;
};
 
struct usb_string_desc {
    int usd_string_index;
    int usd_language_id;
    usb_string_descriptor_t usd_desc;
};
 
struct usb_ctl_report_desc {
    int ucrd_size;
    u_char  ucrd_data[1024];    /* filled data size will vary */
};
 
typedef struct { u32 cookie; } usb_event_cookie_t;
 
#define USB_MAX_DEVNAMES 4
#define USB_MAX_DEVNAMELEN 16
struct usb_device_info {
    u8  udi_bus;
    u8  udi_addr;   /* device address */
    usb_event_cookie_t udi_cookie;
    char        udi_product[USB_MAX_STRING_LEN];
    char        udi_vendor[USB_MAX_STRING_LEN];
    char        udi_release[8];
    u16 udi_productNo;
    u16 udi_vendorNo;
    u16 udi_releaseNo;
    u8  udi_class;
    u8  udi_subclass;
    u8  udi_protocol;
    u8  udi_config;
    u8  udi_speed;
#define USB_SPEED_UNKNOWN       0U      
#define USB_SPEED_LOW           1U      
#define USB_SPEED_FULL          2U      
#define USB_SPEED_HIGH          3U      
#define USB_SPEED_VARIABLE      4U      
#define USB_SPEED_SUPER         5U      
    int     udi_power;  /* power consumption in mA, 0 if selfpowered */
    int     udi_nports;
    char        udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN];
    u8  udi_ports[16];/* hub only: addresses of devices on ports */
#define USB_PORT_ENABLED 0xff
#define USB_PORT_SUSPENDED 0xfe
#define USB_PORT_POWERED 0xfd
#define USB_PORT_DISABLED 0xfc
};
 
struct usb_ctl_report {
    int ucr_report;
    u_char  ucr_data[1024]; /* filled data size will vary */
};
 
struct usb_device_stats {
    u_long  uds_requests[4];    /* indexed by transfer type UE_* */
};
 
#define WUSB_MIN_IE                 0x80U
#define WUSB_WCTA_IE                0x80U
#define WUSB_WCONNECTACK_IE         0x81U
#define WUSB_WHOSTINFO_IE           0x82U
#define  WUHI_GET_CA(_bmAttributes_) ((_bmAttributes_) & 0x3U)
#define   WUHI_CA_RECONN            0x00U
#define   WUHI_CA_LIMITED           0x01U
#define   WUHI_CA_ALL               0x03U
#define  WUHI_GET_MLSI(_bmAttributes_) (((_bmAttributes_) & 0x38U) >> 3)
#define WUSB_WCHCHANGEANNOUNCE_IE   0x83U
#define WUSB_WDEV_DISCONNECT_IE     0x84U
#define WUSB_WHOST_DISCONNECT_IE    0x85U
#define WUSB_WRELEASE_CHANNEL_IE    0x86U
#define WUSB_WWORK_IE               0x87U
#define WUSB_WCHANNEL_STOP_IE       0x88U
#define WUSB_WDEV_KEEPALIVE_IE      0x89U
#define WUSB_WISOCH_DISCARD_IE      0x8AU
#define WUSB_WRESETDEVICE_IE        0x8BU
#define WUSB_WXMIT_PACKET_ADJUST_IE 0x8CU
#define WUSB_MAX_IE                 0x8CU
 
/* Device Notification Types */
 
#define WUSB_DN_MIN                 0x01U
#define WUSB_DN_CONNECT             0x01U
#define WUSB_DA_OLDCONN             0x00U
#define WUSB_DA_NEWCONN             0x01U
#define WUSB_DA_SELF_BEACON         0x02U
#define WUSB_DA_DIR_BEACON          0x04U
#define WUSB_DA_NO_BEACON           0x06U
#define WUSB_DN_DISCONNECT          0x02U
#define WUSB_DN_EPRDY               0x03U
#define WUSB_DN_MASAVAILCHANGED     0x04U
#define WUSB_DN_REMOTEWAKEUP        0x05U
#define WUSB_DN_SLEEP               0x06U
#define WUSB_DN_ALIVE               0x07U
#define WUSB_DN_MAX                 0x07U
 
#ifdef _MSC_VER
#include <pshpack1.h>
#endif
 
/* WUSB Handshake Data.  Used during the SET/GET HANDSHAKE requests */
typedef struct wusb_hndshk_data {
    uByte bMessageNumber;
    uByte bStatus;
    uByte tTKID[3];
    uByte bReserved;
    uByte CDID[16];
    uByte Nonce[16];
    uByte MIC[8];
} UPACKED wusb_hndshk_data_t;
#define WUSB_HANDSHAKE_LEN_FOR_MIC  38
 
/* WUSB Connection Context */
typedef struct wusb_conn_context {
    uByte CHID [16];
    uByte CDID [16];
    uByte CK [16];
} UPACKED wusb_conn_context_t;
 
/* WUSB Security Descriptor */
typedef struct wusb_security_desc {
    uByte bLength;
    uByte bDescriptorType;
    uWord wTotalLength;
    uByte bNumEncryptionTypes;
} UPACKED wusb_security_desc_t;
 
/* WUSB Encryption Type Descriptor */
typedef struct wusb_encrypt_type_desc {
    uByte bLength;
    uByte bDescriptorType;
 
    uByte bEncryptionType;
#define WUETD_UNSECURE      0
#define WUETD_WIRED     1
#define WUETD_CCM_1     2
#define WUETD_RSA_1     3
 
    uByte bEncryptionValue;
    uByte bAuthKeyIndex;
} UPACKED wusb_encrypt_type_desc_t;
 
/* WUSB Key Descriptor */
typedef struct wusb_key_desc {
    uByte bLength;
    uByte bDescriptorType;
    uByte tTKID[3];
    uByte bReserved;
    uByte KeyData[1];   /* variable length */
} UPACKED wusb_key_desc_t;
 
/* WUSB BOS Descriptor (Binary device Object Store) */
typedef struct wusb_bos_desc {
    uByte bLength;
    uByte bDescriptorType;
    uWord wTotalLength;
    uByte bNumDeviceCaps;
} UPACKED wusb_bos_desc_t;
 
#define USB_DEVICE_CAPABILITY_20_EXTENSION  0x02
typedef struct usb_dev_cap_20_ext_desc {
    uByte bLength;
    uByte bDescriptorType;
    uByte bDevCapabilityType;
#define USB_20_EXT_LPM                      0x02U
#define USB_20_EXT_BESL                     0x04U
#define USB_20_EXT_BASELINE_BESL_VALID      0x08U
#define USB_20_EXT_DEEP_BESL_VALID          0x10U
#define USB_20_EXT_BASELINE_BESL_BITS       0x00f00U
#define USB_20_EXT_BASELINE_BESL_SHIFT      8U
#define USB_20_EXT_DEEP_BESL_BITS           0x0f000U
#define USB_20_EXT_DEEP_BESL_SHIFT          12U
    uDWord bmAttributes;
} UPACKED usb_dev_cap_20_ext_desc_t;
 
#define USB_DEVICE_CAPABILITY_SS_USB        0x03U
typedef struct usb_dev_cap_ss_usb {
    uByte bLength;
    uByte bDescriptorType;
    uByte bDevCapabilityType;
#define USB_DC_SS_USB_LTM_CAPABLE           0x02U
    uByte bmAttributes;
#define USB_DC_SS_USB_SPEED_SUPPORT_LOW     0x01U
#define USB_DC_SS_USB_SPEED_SUPPORT_FULL    0x02U
#define USB_DC_SS_USB_SPEED_SUPPORT_HIGH    0x04U
#define USB_DC_SS_USB_SPEED_SUPPORT_SS      0x08U
    uWord wSpeedsSupported;
    uByte bFunctionalitySupport;
    uByte bU1DevExitLat;
    uWord wU2DevExitLat;
} UPACKED usb_dev_cap_ss_usb_t;
 
#define USB_DEVICE_CAPABILITY_CONTAINER_ID  0x04U
typedef struct usb_dev_cap_container_id {
    uByte bLength;
    uByte bDescriptorType;
    uByte bDevCapabilityType;
    uByte bReserved;
    uByte containerID[16];
} UPACKED usb_dev_cap_container_id_t;
 
/* Device Capability Type Codes */
#define WUSB_DEVICE_CAPABILITY_WIRELESS_USB 0x01U
 
/* Device Capability Descriptor */
typedef struct wusb_dev_cap_desc {
    uByte bLength;
    uByte bDescriptorType;
    uByte bDevCapabilityType;
    uByte caps[1];  /* Variable length */
} UPACKED wusb_dev_cap_desc_t;
 
/* Device Capability Descriptor */
typedef struct wusb_dev_cap_uwb_desc {
    uByte bLength;
    uByte bDescriptorType;
    uByte bDevCapabilityType;
    uByte bmAttributes;
    uWord wPHYRates;    /* Bitmap */
    uByte bmTFITXPowerInfo;
    uByte bmFFITXPowerInfo;
    uWord bmBandGroup;
    uByte bReserved;
} UPACKED wusb_dev_cap_uwb_desc_t;
 
/* Wireless USB Endpoint Companion Descriptor */
typedef struct wusb_endpoint_companion_desc {
    uByte bLength;
    uByte bDescriptorType;
    uByte bMaxBurst;
    uByte bMaxSequence;
    uWord wMaxStreamDelay;
    uWord wOverTheAirPacketSize;
    uByte bOverTheAirInterval;
    uByte bmCompAttributes;
} UPACKED wusb_endpoint_companion_desc_t;
 
/* Wireless USB Numeric Association M1 Data Structure */
typedef struct wusb_m1_data {
    uByte version;
    uWord langId;
    uByte deviceFriendlyNameLength;
    uByte sha_256_m3[32];
    uByte deviceFriendlyName[256];
} UPACKED wusb_m1_data_t;
 
typedef struct wusb_m2_data {
    uByte version;
    uWord langId;
    uByte hostFriendlyNameLength;
    uByte pkh[384];
    uByte hostFriendlyName[256];
} UPACKED wusb_m2_data_t;
 
typedef struct wusb_m3_data {
    uByte pkd[384];
    uByte nd;
} UPACKED wusb_m3_data_t;
 
typedef struct wusb_m4_data {
    uDWord _attributeTypeIdAndLength_1;
    uWord  associationTypeId;
 
    uDWord _attributeTypeIdAndLength_2;
    uWord  associationSubTypeId;
 
    uDWord _attributeTypeIdAndLength_3;
    uDWord length;
 
    uDWord _attributeTypeIdAndLength_4;
    uDWord associationStatus;
 
    uDWord _attributeTypeIdAndLength_5;
    uByte  chid[16];
 
    uDWord _attributeTypeIdAndLength_6;
    uByte  cdid[16];
 
    uDWord _attributeTypeIdAndLength_7;
    uByte  bandGroups[2];
} UPACKED wusb_m4_data_t;
 
#ifdef _MSC_VER
#include <poppack.h>
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* _USB_H_ */