[BACK]Return to usb.h CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / sys / dev / usb

Annotation of src/sys/dev/usb/usb.h, Revision 1.69.6.4

1.69.6.4! skrll       1: /*     $NetBSD: usb.h,v 1.69.6.3 2004/09/21 13:33:49 skrll Exp $       */
1.39      augustss    2: /*     $FreeBSD: src/sys/dev/usb/usb.h,v 1.14 1999/11/17 22:33:46 n_hibma Exp $        */
1.1       augustss    3:
                      4: /*
                      5:  * Copyright (c) 1998 The NetBSD Foundation, Inc.
                      6:  * All rights reserved.
                      7:  *
1.4       augustss    8:  * This code is derived from software contributed to The NetBSD Foundation
1.48      augustss    9:  * by Lennart Augustsson (lennart@augustsson.net) at
1.4       augustss   10:  * Carlstedt Research & Technology.
1.1       augustss   11:  *
                     12:  * Redistribution and use in source and binary forms, with or without
                     13:  * modification, are permitted provided that the following conditions
                     14:  * are met:
                     15:  * 1. Redistributions of source code must retain the above copyright
                     16:  *    notice, this list of conditions and the following disclaimer.
                     17:  * 2. Redistributions in binary form must reproduce the above copyright
                     18:  *    notice, this list of conditions and the following disclaimer in the
                     19:  *    documentation and/or other materials provided with the distribution.
                     20:  * 3. All advertising materials mentioning features or use of this software
                     21:  *    must display the following acknowledgement:
                     22:  *        This product includes software developed by the NetBSD
                     23:  *        Foundation, Inc. and its contributors.
                     24:  * 4. Neither the name of The NetBSD Foundation nor the names of its
                     25:  *    contributors may be used to endorse or promote products derived
                     26:  *    from this software without specific prior written permission.
                     27:  *
                     28:  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
                     29:  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
                     30:  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
                     31:  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
                     32:  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
                     33:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
                     34:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
                     35:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
                     36:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
                     37:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
                     38:  * POSSIBILITY OF SUCH DAMAGE.
                     39:  */
                     40:
                     41:
                     42: #ifndef _USB_H_
                     43: #define _USB_H_
                     44:
                     45: #include <sys/types.h>
1.37      augustss   46: #include <sys/time.h>
1.36      augustss   47:
1.25      augustss   48: #if defined(__NetBSD__) || defined(__OpenBSD__)
1.1       augustss   49: #include <sys/ioctl.h>
1.65      augustss   50: #endif
                     51: #if defined(__FreeBSD__)
                     52: /* These two defines are used by usbd to autoload the usb kld */
                     53: #define USB_KLD                "usb"           /* name of usb module */
                     54: #define USB_UHUB       "usb/uhub"      /* root hub */
1.63      augustss   55: #endif
1.8       augustss   56:
                     57: #if defined(_KERNEL)
                     58: #include <dev/usb/usb_port.h>
                     59: #endif /* _KERNEL */
                     60:
1.63      augustss   61: #define USB_STACK_VERSION 2
1.1       augustss   62:
                     63: #define USB_MAX_DEVICES 128
                     64: #define USB_START_ADDR 0
                     65:
                     66: #define USB_CONTROL_ENDPOINT 0
                     67: #define USB_MAX_ENDPOINTS 16
                     68:
1.10      augustss   69: #define USB_FRAMES_PER_SECOND 1000
                     70:
1.1       augustss   71: /*
                     72:  * The USB records contain some unaligned little-endian word
                     73:  * components.  The U[SG]ETW macros take care of both the alignment
1.50      augustss   74:  * and endian problem and should always be used to access non-byte
1.1       augustss   75:  * values.
                     76:  */
                     77: typedef u_int8_t uByte;
                     78: typedef u_int8_t uWord[2];
1.50      augustss   79: typedef u_int8_t uDWord[4];
                     80:
                     81: #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h))
                     82:
                     83: #if 1
1.1       augustss   84: #define UGETW(w) ((w)[0] | ((w)[1] << 8))
                     85: #define USETW(w,v) ((w)[0] = (u_int8_t)(v), (w)[1] = (u_int8_t)((v) >> 8))
1.16      augustss   86: #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24))
                     87: #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \
                     88:                     (w)[1] = (u_int8_t)((v) >> 8), \
                     89:                     (w)[2] = (u_int8_t)((v) >> 16), \
                     90:                     (w)[3] = (u_int8_t)((v) >> 24))
1.50      augustss   91: #else
1.66      augustss   92: /*
1.1       augustss   93:  * On little-endian machines that can handle unanliged accesses
                     94:  * (e.g. i386) these macros can be replaced by the following.
                     95:  */
                     96: #define UGETW(w) (*(u_int16_t *)(w))
                     97: #define USETW(w,v) (*(u_int16_t *)(w) = (v))
1.50      augustss   98: #define UGETDW(w) (*(u_int32_t *)(w))
                     99: #define USETDW(w,v) (*(u_int32_t *)(w) = (v))
1.1       augustss  100: #endif
                    101:
1.49      augustss  102: #define UPACKED __attribute__((__packed__))
                    103:
1.1       augustss  104: typedef struct {
                    105:        uByte           bmRequestType;
                    106:        uByte           bRequest;
                    107:        uWord           wValue;
                    108:        uWord           wIndex;
                    109:        uWord           wLength;
1.49      augustss  110: } UPACKED usb_device_request_t;
1.1       augustss  111:
                    112: #define UT_WRITE               0x00
                    113: #define UT_READ                        0x80
                    114: #define UT_STANDARD            0x00
                    115: #define UT_CLASS               0x20
                    116: #define UT_VENDOR              0x40
                    117: #define UT_DEVICE              0x00
                    118: #define UT_INTERFACE           0x01
                    119: #define UT_ENDPOINT            0x02
                    120: #define UT_OTHER               0x03
                    121:
                    122: #define UT_READ_DEVICE         (UT_READ  | UT_STANDARD | UT_DEVICE)
                    123: #define UT_READ_INTERFACE      (UT_READ  | UT_STANDARD | UT_INTERFACE)
                    124: #define UT_READ_ENDPOINT       (UT_READ  | UT_STANDARD | UT_ENDPOINT)
                    125: #define UT_WRITE_DEVICE                (UT_WRITE | UT_STANDARD | UT_DEVICE)
                    126: #define UT_WRITE_INTERFACE     (UT_WRITE | UT_STANDARD | UT_INTERFACE)
                    127: #define UT_WRITE_ENDPOINT      (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
                    128: #define UT_READ_CLASS_DEVICE   (UT_READ  | UT_CLASS | UT_DEVICE)
                    129: #define UT_READ_CLASS_INTERFACE        (UT_READ  | UT_CLASS | UT_INTERFACE)
                    130: #define UT_READ_CLASS_OTHER    (UT_READ  | UT_CLASS | UT_OTHER)
1.30      augustss  131: #define UT_READ_CLASS_ENDPOINT (UT_READ  | UT_CLASS | UT_ENDPOINT)
1.1       augustss  132: #define UT_WRITE_CLASS_DEVICE  (UT_WRITE | UT_CLASS | UT_DEVICE)
                    133: #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
                    134: #define UT_WRITE_CLASS_OTHER   (UT_WRITE | UT_CLASS | UT_OTHER)
1.30      augustss  135: #define UT_WRITE_CLASS_ENDPOINT        (UT_WRITE | UT_CLASS | UT_ENDPOINT)
1.13      augustss  136: #define UT_READ_VENDOR_DEVICE  (UT_READ  | UT_VENDOR | UT_DEVICE)
                    137: #define UT_READ_VENDOR_INTERFACE (UT_READ  | UT_VENDOR | UT_INTERFACE)
                    138: #define UT_READ_VENDOR_OTHER   (UT_READ  | UT_VENDOR | UT_OTHER)
1.30      augustss  139: #define UT_READ_VENDOR_ENDPOINT        (UT_READ  | UT_VENDOR | UT_ENDPOINT)
1.13      augustss  140: #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE)
                    141: #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
                    142: #define UT_WRITE_VENDOR_OTHER  (UT_WRITE | UT_VENDOR | UT_OTHER)
1.30      augustss  143: #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
1.1       augustss  144:
                    145: /* Requests */
                    146: #define UR_GET_STATUS          0x00
                    147: #define UR_CLEAR_FEATURE       0x01
                    148: #define UR_SET_FEATURE         0x03
                    149: #define UR_SET_ADDRESS         0x05
                    150: #define UR_GET_DESCRIPTOR      0x06
1.36      augustss  151: #define  UDESC_DEVICE          0x01
                    152: #define  UDESC_CONFIG          0x02
                    153: #define  UDESC_STRING          0x03
                    154: #define  UDESC_INTERFACE       0x04
                    155: #define  UDESC_ENDPOINT                0x05
1.53      augustss  156: #define  UDESC_DEVICE_QUALIFIER        0x06
                    157: #define  UDESC_OTHER_SPEED_CONFIGURATION 0x07
                    158: #define  UDESC_INTERFACE_POWER 0x08
1.60      augustss  159: #define  UDESC_OTG             0x09
1.36      augustss  160: #define  UDESC_CS_DEVICE       0x21    /* class specific */
                    161: #define  UDESC_CS_CONFIG       0x22
                    162: #define  UDESC_CS_STRING       0x23
                    163: #define  UDESC_CS_INTERFACE    0x24
                    164: #define  UDESC_CS_ENDPOINT     0x25
                    165: #define  UDESC_HUB             0x29
1.1       augustss  166: #define UR_SET_DESCRIPTOR      0x07
                    167: #define UR_GET_CONFIG          0x08
                    168: #define UR_SET_CONFIG          0x09
                    169: #define UR_GET_INTERFACE       0x0a
                    170: #define UR_SET_INTERFACE       0x0b
                    171: #define UR_SYNCH_FRAME         0x0c
                    172:
                    173: /* Feature numbers */
1.8       augustss  174: #define UF_ENDPOINT_HALT       0
1.1       augustss  175: #define UF_DEVICE_REMOTE_WAKEUP        1
1.57      augustss  176: #define UF_TEST_MODE           2
1.1       augustss  177:
                    178: #define USB_MAX_IPACKET                8 /* maximum size of the initial packet */
                    179:
1.56      augustss  180: #define USB_2_MAX_CTRL_PACKET  64
                    181: #define USB_2_MAX_BULK_PACKET  512
                    182:
1.1       augustss  183: typedef struct {
                    184:        uByte           bLength;
                    185:        uByte           bDescriptorType;
                    186:        uByte           bDescriptorSubtype;
1.49      augustss  187: } UPACKED usb_descriptor_t;
1.1       augustss  188:
                    189: typedef struct {
                    190:        uByte           bLength;
                    191:        uByte           bDescriptorType;
                    192:        uWord           bcdUSB;
1.53      augustss  193: #define UD_USB_2_0             0x0200
                    194: #define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0)
1.1       augustss  195:        uByte           bDeviceClass;
                    196:        uByte           bDeviceSubClass;
                    197:        uByte           bDeviceProtocol;
                    198:        uByte           bMaxPacketSize;
                    199:        /* The fields below are not part of the initial descriptor. */
                    200:        uWord           idVendor;
                    201:        uWord           idProduct;
                    202:        uWord           bcdDevice;
                    203:        uByte           iManufacturer;
                    204:        uByte           iProduct;
                    205:        uByte           iSerialNumber;
                    206:        uByte           bNumConfigurations;
1.49      augustss  207: } UPACKED usb_device_descriptor_t;
1.1       augustss  208: #define USB_DEVICE_DESCRIPTOR_SIZE 18
                    209:
                    210: typedef struct {
                    211:        uByte           bLength;
                    212:        uByte           bDescriptorType;
                    213:        uWord           wTotalLength;
                    214:        uByte           bNumInterface;
                    215:        uByte           bConfigurationValue;
                    216:        uByte           iConfiguration;
                    217:        uByte           bmAttributes;
                    218: #define UC_BUS_POWERED         0x80
                    219: #define UC_SELF_POWERED                0x40
                    220: #define UC_REMOTE_WAKEUP       0x20
                    221:        uByte           bMaxPower; /* max current in 2 mA units */
                    222: #define UC_POWER_FACTOR 2
1.49      augustss  223: } UPACKED usb_config_descriptor_t;
1.1       augustss  224: #define USB_CONFIG_DESCRIPTOR_SIZE 9
                    225:
                    226: typedef struct {
                    227:        uByte           bLength;
                    228:        uByte           bDescriptorType;
                    229:        uByte           bInterfaceNumber;
                    230:        uByte           bAlternateSetting;
                    231:        uByte           bNumEndpoints;
                    232:        uByte           bInterfaceClass;
                    233:        uByte           bInterfaceSubClass;
                    234:        uByte           bInterfaceProtocol;
                    235:        uByte           iInterface;
1.49      augustss  236: } UPACKED usb_interface_descriptor_t;
1.1       augustss  237: #define USB_INTERFACE_DESCRIPTOR_SIZE 9
                    238:
                    239: typedef struct {
                    240:        uByte           bLength;
                    241:        uByte           bDescriptorType;
                    242:        uByte           bEndpointAddress;
1.31      augustss  243: #define UE_GET_DIR(a)  ((a) & 0x80)
1.36      augustss  244: #define UE_SET_DIR(a,d)        ((a) | (((d)&1) << 7))
1.31      augustss  245: #define UE_DIR_IN      0x80
                    246: #define UE_DIR_OUT     0x00
1.1       augustss  247: #define UE_ADDR                0x0f
1.6       augustss  248: #define UE_GET_ADDR(a) ((a) & UE_ADDR)
1.1       augustss  249:        uByte           bmAttributes;
                    250: #define UE_XFERTYPE    0x03
1.10      augustss  251: #define  UE_CONTROL    0x00
                    252: #define  UE_ISOCHRONOUS        0x01
                    253: #define  UE_BULK       0x02
                    254: #define  UE_INTERRUPT  0x03
1.36      augustss  255: #define UE_GET_XFERTYPE(a)     ((a) & UE_XFERTYPE)
1.10      augustss  256: #define UE_ISO_TYPE    0x0c
                    257: #define  UE_ISO_ASYNC  0x04
                    258: #define  UE_ISO_ADAPT  0x08
                    259: #define  UE_ISO_SYNC   0x0c
1.38      augustss  260: #define UE_GET_ISO_TYPE(a)     ((a) & UE_ISO_TYPE)
1.1       augustss  261:        uWord           wMaxPacketSize;
                    262:        uByte           bInterval;
1.49      augustss  263: } UPACKED usb_endpoint_descriptor_t;
1.1       augustss  264: #define USB_ENDPOINT_DESCRIPTOR_SIZE 7
                    265:
                    266: typedef struct {
                    267:        uByte           bLength;
                    268:        uByte           bDescriptorType;
                    269:        uWord           bString[127];
1.49      augustss  270: } UPACKED usb_string_descriptor_t;
1.1       augustss  271: #define USB_MAX_STRING_LEN 128
1.15      augustss  272: #define USB_LANGUAGE_TABLE 0   /* # of the string language id table */
1.69.6.4! skrll     273: #define USB_MAX_ENCODED_STRING_LEN (USB_MAX_STRING_LEN * 3) /* UTF8 */
1.1       augustss  274:
                    275: /* Hub specific request */
                    276: #define UR_GET_BUS_STATE       0x02
1.55      augustss  277: #define UR_CLEAR_TT_BUFFER     0x08
                    278: #define UR_RESET_TT            0x09
                    279: #define UR_GET_TT_STATE                0x0a
                    280: #define UR_STOP_TT             0x0b
1.1       augustss  281:
                    282: /* Hub features */
                    283: #define UHF_C_HUB_LOCAL_POWER  0
                    284: #define UHF_C_HUB_OVER_CURRENT 1
                    285: #define UHF_PORT_CONNECTION    0
                    286: #define UHF_PORT_ENABLE                1
                    287: #define UHF_PORT_SUSPEND       2
                    288: #define UHF_PORT_OVER_CURRENT  3
                    289: #define UHF_PORT_RESET         4
                    290: #define UHF_PORT_POWER         8
                    291: #define UHF_PORT_LOW_SPEED     9
                    292: #define UHF_C_PORT_CONNECTION  16
                    293: #define UHF_C_PORT_ENABLE      17
                    294: #define UHF_C_PORT_SUSPEND     18
                    295: #define UHF_C_PORT_OVER_CURRENT        19
                    296: #define UHF_C_PORT_RESET       20
1.55      augustss  297: #define UHF_PORT_TEST          21
                    298: #define UHF_PORT_INDICATOR     22
1.1       augustss  299:
                    300: typedef struct {
                    301:        uByte           bDescLength;
                    302:        uByte           bDescriptorType;
                    303:        uByte           bNbrPorts;
1.8       augustss  304:        uWord           wHubCharacteristics;
1.55      augustss  305: #define UHD_PWR                        0x0003
                    306: #define  UHD_PWR_GANGED                0x0000
                    307: #define  UHD_PWR_INDIVIDUAL    0x0001
                    308: #define  UHD_PWR_NO_SWITCH     0x0002
                    309: #define UHD_COMPOUND           0x0004
                    310: #define UHD_OC                 0x0018
                    311: #define  UHD_OC_GLOBAL         0x0000
                    312: #define  UHD_OC_INDIVIDUAL     0x0008
                    313: #define  UHD_OC_NONE           0x0010
                    314: #define UHD_TT_THINK           0x0060
                    315: #define  UHD_TT_THINK_8                0x0000
                    316: #define  UHD_TT_THINK_16       0x0020
                    317: #define  UHD_TT_THINK_24       0x0040
                    318: #define  UHD_TT_THINK_32       0x0060
                    319: #define UHD_PORT_IND           0x0080
1.1       augustss  320:        uByte           bPwrOn2PwrGood; /* delay in 2 ms units */
                    321: #define UHD_PWRON_FACTOR 2
                    322:        uByte           bHubContrCurrent;
1.8       augustss  323:        uByte           DeviceRemovable[32]; /* max 255 ports */
                    324: #define UHD_NOT_REMOV(desc, i) \
                    325:     (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
1.46      augustss  326:        /* deprecated */ uByte          PortPowerCtrlMask[1];
1.49      augustss  327: } UPACKED usb_hub_descriptor_t;
1.46      augustss  328: #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */
1.1       augustss  329:
                    330: typedef struct {
1.53      augustss  331:        uByte           bLength;
                    332:        uByte           bDescriptorType;
                    333:        uWord           bcdUSB;
                    334:        uByte           bDeviceClass;
                    335:        uByte           bDeviceSubClass;
                    336:        uByte           bDeviceProtocol;
                    337:        uByte           bMaxPacketSize0;
                    338:        uByte           bNumConfigurations;
                    339:        uByte           bReserved;
                    340: } UPACKED usb_device_qualifier_t;
                    341: #define USB_DEVICE_QUALIFIER_SIZE 10
1.60      augustss  342:
                    343: typedef struct {
                    344:        uByte           bLength;
                    345:        uByte           bDescriptorType;
                    346:        uByte           bmAttributes;
                    347: #define UOTG_SRP       0x01
                    348: #define UOTG_HNP       0x02
                    349: } UPACKED usb_otg_descriptor_t;
                    350:
                    351: /* OTG feature selectors */
                    352: #define UOTG_B_HNP_ENABLE      3
                    353: #define UOTG_A_HNP_SUPPORT     4
                    354: #define UOTG_A_ALT_HNP_SUPPORT 5
1.53      augustss  355:
                    356: typedef struct {
1.1       augustss  357:        uWord           wStatus;
                    358: /* Device status flags */
                    359: #define UDS_SELF_POWERED               0x0001
                    360: #define UDS_REMOTE_WAKEUP              0x0002
1.8       augustss  361: /* Endpoint status flags */
                    362: #define UES_HALT                       0x0001
1.49      augustss  363: } UPACKED usb_status_t;
1.1       augustss  364:
                    365: typedef struct {
                    366:        uWord           wHubStatus;
                    367: #define UHS_LOCAL_POWER                        0x0001
                    368: #define UHS_OVER_CURRENT               0x0002
                    369:        uWord           wHubChange;
1.49      augustss  370: } UPACKED usb_hub_status_t;
1.1       augustss  371:
                    372: typedef struct {
                    373:        uWord           wPortStatus;
                    374: #define UPS_CURRENT_CONNECT_STATUS     0x0001
                    375: #define UPS_PORT_ENABLED               0x0002
                    376: #define UPS_SUSPEND                    0x0004
                    377: #define UPS_OVERCURRENT_INDICATOR      0x0008
                    378: #define UPS_RESET                      0x0010
                    379: #define UPS_PORT_POWER                 0x0100
                    380: #define UPS_LOW_SPEED                  0x0200
1.55      augustss  381: #define UPS_HIGH_SPEED                 0x0400
                    382: #define UPS_PORT_TEST                  0x0800
                    383: #define UPS_PORT_INDICATOR             0x1000
1.1       augustss  384:        uWord           wPortChange;
                    385: #define UPS_C_CONNECT_STATUS           0x0001
                    386: #define UPS_C_PORT_ENABLED             0x0002
                    387: #define UPS_C_SUSPEND                  0x0004
                    388: #define UPS_C_OVERCURRENT_INDICATOR    0x0008
                    389: #define UPS_C_PORT_RESET               0x0010
1.49      augustss  390: } UPACKED usb_port_status_t;
1.1       augustss  391:
1.41      augustss  392: /* Device class codes */
1.68      augustss  393: #define UDCLASS_IN_INTERFACE   0x00
1.41      augustss  394: #define UDCLASS_COMM           0x02
                    395: #define UDCLASS_HUB            0x09
1.67      augustss  396: #define  UDSUBCLASS_HUB                0x00
                    397: #define  UDPROTO_FSHUB         0x00
                    398: #define  UDPROTO_HSHUBSTT      0x01
                    399: #define  UDPROTO_HSHUBMTT      0x02
1.68      augustss  400: #define UDCLASS_DIAGNOSTIC     0xdc
1.67      augustss  401: #define UDCLASS_WIRELESS       0xe0
                    402: #define  UDSUBCLASS_RF         0x01
                    403: #define   UDPROTO_BLUETOOTH    0x01
1.68      augustss  404: #define UDCLASS_VENDOR         0xff
1.41      augustss  405:
                    406: /* Interface class codes */
                    407: #define UICLASS_UNSPEC         0x00
                    408:
                    409: #define UICLASS_AUDIO          0x01
                    410: #define  UISUBCLASS_AUDIOCONTROL       1
                    411: #define  UISUBCLASS_AUDIOSTREAM                2
                    412: #define  UISUBCLASS_MIDISTREAM         3
                    413:
                    414: #define UICLASS_CDC            0x02 /* communication */
                    415: #define         UISUBCLASS_DIRECT_LINE_CONTROL_MODEL   1
                    416: #define  UISUBCLASS_ABSTRACT_CONTROL_MODEL     2
                    417: #define         UISUBCLASS_TELEPHONE_CONTROL_MODEL     3
                    418: #define         UISUBCLASS_MULTICHANNEL_CONTROL_MODEL  4
                    419: #define         UISUBCLASS_CAPI_CONTROLMODEL           5
                    420: #define         UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
                    421: #define         UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
                    422: #define   UIPROTO_CDC_AT                       1
                    423:
                    424: #define UICLASS_HID            0x03
                    425: #define  UISUBCLASS_BOOT       1
                    426: #define  UIPROTO_BOOT_KEYBOARD 1
                    427:
                    428: #define UICLASS_PHYSICAL       0x05
                    429:
1.68      augustss  430: #define UICLASS_IMAGE          0x06
                    431:
1.41      augustss  432: #define UICLASS_PRINTER                0x07
                    433: #define  UISUBCLASS_PRINTER    1
                    434: #define  UIPROTO_PRINTER_UNI   1
                    435: #define  UIPROTO_PRINTER_BI    2
1.52      nathanw   436: #define  UIPROTO_PRINTER_1284  3
1.41      augustss  437:
                    438: #define UICLASS_MASS           0x08
                    439: #define  UISUBCLASS_RBC                1
                    440: #define  UISUBCLASS_SFF8020I   2
                    441: #define  UISUBCLASS_QIC157     3
                    442: #define  UISUBCLASS_UFI                4
                    443: #define  UISUBCLASS_SFF8070I   5
                    444: #define  UISUBCLASS_SCSI       6
                    445: #define  UIPROTO_MASS_CBI_I    0
                    446: #define  UIPROTO_MASS_CBI      1
1.58      augustss  447: #define  UIPROTO_MASS_BBB_OLD  2       /* Not in the spec anymore */
                    448: #define  UIPROTO_MASS_BBB      80      /* 'P' for the Iomega Zip drive */
1.41      augustss  449:
                    450: #define UICLASS_HUB            0x09
                    451: #define  UISUBCLASS_HUB                0
1.55      augustss  452: #define  UIPROTO_FSHUB         0
                    453: #define  UIPROTO_HSHUBSTT      0 /* Yes, same as previous */
                    454: #define  UIPROTO_HSHUBMTT      1
1.41      augustss  455:
                    456: #define UICLASS_CDC_DATA       0x0a
                    457: #define  UISUBCLASS_DATA               0
                    458: #define   UIPROTO_DATA_ISDNBRI         0x30    /* Physical iface */
                    459: #define   UIPROTO_DATA_HDLC            0x31    /* HDLC */
                    460: #define   UIPROTO_DATA_TRANSPARENT     0x32    /* Transparent */
                    461: #define   UIPROTO_DATA_Q921M           0x50    /* Management for Q921 */
                    462: #define   UIPROTO_DATA_Q921            0x51    /* Data for Q921 */
                    463: #define   UIPROTO_DATA_Q921TM          0x52    /* TEI multiplexer for Q921 */
1.66      augustss  464: #define   UIPROTO_DATA_V42BIS          0x90    /* Data compression */
1.41      augustss  465: #define   UIPROTO_DATA_Q931            0x91    /* Euro-ISDN */
                    466: #define   UIPROTO_DATA_V120            0x92    /* V.24 rate adaption */
                    467: #define   UIPROTO_DATA_CAPI            0x93    /* CAPI 2.0 commands */
                    468: #define   UIPROTO_DATA_HOST_BASED      0xfd    /* Host based driver */
                    469: #define   UIPROTO_DATA_PUF             0xfe    /* see Prot. Unit Func. Desc.*/
                    470: #define   UIPROTO_DATA_VENDOR          0xff    /* Vendor specific */
                    471:
1.68      augustss  472: #define UICLASS_SMARTCARD      0x0b
                    473:
                    474: /*#define UICLASS_FIRM_UPD     0x0c*/
                    475:
                    476: #define UICLASS_SECURITY       0x0d
                    477:
                    478: #define UICLASS_DIAGNOSTIC     0xdc
1.67      augustss  479:
                    480: #define UICLASS_WIRELESS       0xe0
                    481: #define  UISUBCLASS_RF                 0x01
                    482: #define   UIPROTO_BLUETOOTH            0x01
1.41      augustss  483:
                    484: #define UICLASS_APPL_SPEC      0xfe
1.61      augustss  485: #define  UISUBCLASS_FIRMWARE_DOWNLOAD  1
1.59      augustss  486: #define  UISUBCLASS_IRDA               2
                    487: #define  UIPROTO_IRDA                  0
                    488:
1.41      augustss  489: #define UICLASS_VENDOR         0xff
1.36      augustss  490:
1.1       augustss  491:
                    492: #define USB_HUB_MAX_DEPTH 5
                    493:
1.66      augustss  494: /*
                    495:  * Minimum time a device needs to be powered down to go through
1.11      augustss  496:  * a power cycle.  XXX Are these time in the spec?
1.6       augustss  497:  */
1.11      augustss  498: #define USB_POWER_DOWN_TIME    200 /* ms */
1.9       augustss  499: #define USB_PORT_POWER_DOWN_TIME       100 /* ms */
1.6       augustss  500:
1.8       augustss  501: #if 0
1.9       augustss  502: /* These are the values from the spec. */
1.1       augustss  503: #define USB_PORT_RESET_DELAY   10  /* ms */
1.56      augustss  504: #define USB_PORT_ROOT_RESET_DELAY 50  /* ms */
1.69      augustss  505: #define USB_PORT_RESET_RECOVERY        10  /* ms */
1.1       augustss  506: #define USB_PORT_POWERUP_DELAY 100 /* ms */
1.8       augustss  507: #define USB_SET_ADDRESS_SETTLE 2   /* ms */
1.44      augustss  508: #define USB_RESUME_DELAY       (20*5)  /* ms */
1.22      augustss  509: #define USB_RESUME_WAIT                10  /* ms */
                    510: #define USB_RESUME_RECOVERY    10  /* ms */
1.45      augustss  511: #define USB_EXTRA_POWER_UP_TIME        0   /* ms */
1.8       augustss  512: #else
1.9       augustss  513: /* Allow for marginal (i.e. non-conforming) devices. */
1.18      augustss  514: #define USB_PORT_RESET_DELAY   50  /* ms */
1.56      augustss  515: #define USB_PORT_ROOT_RESET_DELAY 250  /* ms */
1.69      augustss  516: #define USB_PORT_RESET_RECOVERY        250  /* ms */
1.56      augustss  517: #define USB_PORT_POWERUP_DELAY 300 /* ms */
1.8       augustss  518: #define USB_SET_ADDRESS_SETTLE 10  /* ms */
1.22      augustss  519: #define USB_RESUME_DELAY       (50*5)  /* ms */
                    520: #define USB_RESUME_WAIT                50  /* ms */
                    521: #define USB_RESUME_RECOVERY    50  /* ms */
1.45      augustss  522: #define USB_EXTRA_POWER_UP_TIME        20  /* ms */
1.8       augustss  523: #endif
1.1       augustss  524:
                    525: #define USB_MIN_POWER          100 /* mA */
                    526: #define USB_MAX_POWER          500 /* mA */
                    527:
1.11      augustss  528: #define USB_BUS_RESET_DELAY    100 /* ms XXX?*/
1.47      augustss  529:
                    530:
                    531: #define USB_UNCONFIG_NO 0
                    532: #define USB_UNCONFIG_INDEX (-1)
1.1       augustss  533:
                    534: /*** ioctl() related stuff ***/
                    535:
                    536: struct usb_ctl_request {
1.62      christos  537:        int     ucr_addr;
                    538:        usb_device_request_t ucr_request;
                    539:        void    *ucr_data;
                    540:        int     ucr_flags;
1.33      augustss  541: #define USBD_SHORT_XFER_OK     0x04    /* allow short reads */
1.62      christos  542:        int     ucr_actlen;             /* actual length transferred */
1.1       augustss  543: };
                    544:
1.6       augustss  545: struct usb_alt_interface {
1.62      christos  546:        int     uai_config_index;
                    547:        int     uai_interface_index;
                    548:        int     uai_alt_no;
1.6       augustss  549: };
                    550:
                    551: #define USB_CURRENT_CONFIG_INDEX (-1)
                    552: #define USB_CURRENT_ALT_INDEX (-1)
                    553:
                    554: struct usb_config_desc {
1.62      christos  555:        int     ucd_config_index;
                    556:        usb_config_descriptor_t ucd_desc;
1.6       augustss  557: };
                    558:
                    559: struct usb_interface_desc {
1.62      christos  560:        int     uid_config_index;
                    561:        int     uid_interface_index;
                    562:        int     uid_alt_index;
                    563:        usb_interface_descriptor_t uid_desc;
1.6       augustss  564: };
                    565:
                    566: struct usb_endpoint_desc {
1.62      christos  567:        int     ued_config_index;
                    568:        int     ued_interface_index;
                    569:        int     ued_alt_index;
                    570:        int     ued_endpoint_index;
                    571:        usb_endpoint_descriptor_t ued_desc;
1.6       augustss  572: };
                    573:
                    574: struct usb_full_desc {
1.62      christos  575:        int     ufd_config_index;
                    576:        u_int   ufd_size;
                    577:        u_char  *ufd_data;
1.1       augustss  578: };
                    579:
1.7       augustss  580: struct usb_string_desc {
1.62      christos  581:        int     usd_string_index;
                    582:        int     usd_language_id;
                    583:        usb_string_descriptor_t usd_desc;
1.7       augustss  584: };
                    585:
1.1       augustss  586: struct usb_ctl_report_desc {
1.62      christos  587:        int     ucrd_size;
                    588:        u_char  ucrd_data[1024];        /* filled data size will vary */
1.1       augustss  589: };
                    590:
1.40      augustss  591: typedef struct { u_int32_t cookie; } usb_event_cookie_t;
                    592:
                    593: #define USB_MAX_DEVNAMES 4
                    594: #define USB_MAX_DEVNAMELEN 16
1.1       augustss  595: struct usb_device_info {
1.62      christos  596:        u_int8_t        udi_bus;
                    597:        u_int8_t        udi_addr;       /* device address */
                    598:        usb_event_cookie_t udi_cookie;
1.69.6.4! skrll     599:        char            udi_product[USB_MAX_ENCODED_STRING_LEN];
        !           600:        char            udi_vendor[USB_MAX_ENCODED_STRING_LEN];
1.62      christos  601:        char            udi_release[8];
1.69.6.4! skrll     602:        char            udi_serial[USB_MAX_ENCODED_STRING_LEN];
1.62      christos  603:        u_int16_t       udi_productNo;
                    604:        u_int16_t       udi_vendorNo;
                    605:        u_int16_t       udi_releaseNo;
                    606:        u_int8_t        udi_class;
                    607:        u_int8_t        udi_subclass;
                    608:        u_int8_t        udi_protocol;
                    609:        u_int8_t        udi_config;
                    610:        u_int8_t        udi_speed;
1.54      augustss  611: #define USB_SPEED_LOW  1
                    612: #define USB_SPEED_FULL 2
                    613: #define USB_SPEED_HIGH 3
1.62      christos  614:        int             udi_power;      /* power consumption in mA, 0 if selfpowered */
                    615:        int             udi_nports;
                    616:        char            udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN];
                    617:        u_int8_t        udi_ports[16];/* hub only: addresses of devices on ports */
1.1       augustss  618: #define USB_PORT_ENABLED 0xff
                    619: #define USB_PORT_SUSPENDED 0xfe
                    620: #define USB_PORT_POWERED 0xfd
                    621: #define USB_PORT_DISABLED 0xfc
                    622: };
                    623:
1.2       augustss  624: struct usb_ctl_report {
1.62      christos  625:        int     ucr_report;
                    626:        u_char  ucr_data[1024]; /* filled data size will vary */
1.2       augustss  627: };
                    628:
1.3       augustss  629: struct usb_device_stats {
1.62      christos  630:        u_long  uds_requests[4];        /* indexed by transfer type UE_* */
1.35      augustss  631: };
                    632:
                    633: /* Events that can be read from /dev/usb */
                    634: struct usb_event {
                    635:        int                     ue_type;
1.40      augustss  636: #define USB_EVENT_CTRLR_ATTACH 1
                    637: #define USB_EVENT_CTRLR_DETACH 2
                    638: #define USB_EVENT_DEVICE_ATTACH 3
                    639: #define USB_EVENT_DEVICE_DETACH 4
                    640: #define USB_EVENT_DRIVER_ATTACH 5
                    641: #define USB_EVENT_DRIVER_DETACH 6
1.51      augustss  642: #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH)
1.64      augustss  643: #define USB_EVENT_IS_DETACH(n) ((n) == USB_EVENT_CTRLR_DETACH || (n) == USB_EVENT_DEVICE_DETACH || (n) == USB_EVENT_DRIVER_DETACH)
1.35      augustss  644:        struct timespec         ue_time;
1.40      augustss  645:        union {
                    646:                struct {
                    647:                        int                     ue_bus;
                    648:                } ue_ctrlr;
                    649:                struct usb_device_info          ue_device;
                    650:                struct {
                    651:                        usb_event_cookie_t      ue_cookie;
                    652:                        char                    ue_devname[16];
1.66      augustss  653:                } ue_driver;
1.40      augustss  654:        } u;
1.3       augustss  655: };
                    656:
1.1       augustss  657: /* USB controller */
                    658: #define USB_REQUEST            _IOWR('U', 1, struct usb_ctl_request)
                    659: #define USB_SETDEBUG           _IOW ('U', 2, int)
                    660: #define USB_DISCOVER           _IO  ('U', 3)
                    661: #define USB_DEVICEINFO         _IOWR('U', 4, struct usb_device_info)
1.3       augustss  662: #define USB_DEVICESTATS                _IOR ('U', 5, struct usb_device_stats)
1.1       augustss  663:
                    664: /* Generic HID device */
                    665: #define USB_GET_REPORT_DESC    _IOR ('U', 21, struct usb_ctl_report_desc)
1.2       augustss  666: #define USB_SET_IMMED          _IOW ('U', 22, int)
                    667: #define USB_GET_REPORT         _IOWR('U', 23, struct usb_ctl_report)
1.42      augustss  668: #define USB_SET_REPORT         _IOW ('U', 24, struct usb_ctl_report)
1.53      augustss  669: #define USB_GET_REPORT_ID      _IOR ('U', 25, int)
1.1       augustss  670:
                    671: /* Generic USB device */
1.6       augustss  672: #define USB_GET_CONFIG         _IOR ('U', 100, int)
                    673: #define USB_SET_CONFIG         _IOW ('U', 101, int)
                    674: #define USB_GET_ALTINTERFACE   _IOWR('U', 102, struct usb_alt_interface)
1.7       augustss  675: #define USB_SET_ALTINTERFACE   _IOWR('U', 103, struct usb_alt_interface)
1.6       augustss  676: #define USB_GET_NO_ALT         _IOWR('U', 104, struct usb_alt_interface)
                    677: #define USB_GET_DEVICE_DESC    _IOR ('U', 105, usb_device_descriptor_t)
1.7       augustss  678: #define USB_GET_CONFIG_DESC    _IOWR('U', 106, struct usb_config_desc)
1.6       augustss  679: #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc)
                    680: #define USB_GET_ENDPOINT_DESC  _IOWR('U', 108, struct usb_endpoint_desc)
1.7       augustss  681: #define USB_GET_FULL_DESC      _IOWR('U', 109, struct usb_full_desc)
                    682: #define USB_GET_STRING_DESC    _IOWR('U', 110, struct usb_string_desc)
                    683: #define USB_DO_REQUEST         _IOWR('U', 111, struct usb_ctl_request)
                    684: #define USB_GET_DEVICEINFO     _IOR ('U', 112, struct usb_device_info)
1.16      augustss  685: #define USB_SET_SHORT_XFER     _IOW ('U', 113, int)
1.29      augustss  686: #define USB_SET_TIMEOUT                _IOW ('U', 114, int)
1.24      augustss  687:
                    688: /* Modem device */
                    689: #define USB_GET_CM_OVER_DATA   _IOR ('U', 130, int)
                    690: #define USB_SET_CM_OVER_DATA   _IOW ('U', 131, int)
1.1       augustss  691:
                    692: #endif /* _USB_H_ */

CVSweb <webmaster@jp.NetBSD.org>