1 /* 2 * (C) Copyright 2001 3 * Denis Peter, MPL AG Switzerland 4 * 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License as 8 * published by the Free Software Foundation; either version 2 of 9 * the License, or (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, 19 * MA 02111-1307 USA 20 * 21 * Note: Part of this code has been derived from linux 22 * 23 */ 24 #ifndef _USB_DEFS_H_ 25 #define _USB_DEFS_H_ 26 27 /* USB constants */ 28 29 /* Device and/or Interface Class codes */ 30 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */ 31 #define USB_CLASS_AUDIO 1 32 #define USB_CLASS_COMM 2 33 #define USB_CLASS_HID 3 34 #define USB_CLASS_PRINTER 7 35 #define USB_CLASS_MASS_STORAGE 8 36 #define USB_CLASS_HUB 9 37 #define USB_CLASS_DATA 10 38 #define USB_CLASS_VENDOR_SPEC 0xff 39 40 /* some HID sub classes */ 41 #define USB_SUB_HID_NONE 0 42 #define USB_SUB_HID_BOOT 1 43 44 /* some UID Protocols */ 45 #define USB_PROT_HID_NONE 0 46 #define USB_PROT_HID_KEYBOARD 1 47 #define USB_PROT_HID_MOUSE 2 48 49 50 /* Sub STORAGE Classes */ 51 #define US_SC_RBC 1 /* Typically, flash devices */ 52 #define US_SC_8020 2 /* CD-ROM */ 53 #define US_SC_QIC 3 /* QIC-157 Tapes */ 54 #define US_SC_UFI 4 /* Floppy */ 55 #define US_SC_8070 5 /* Removable media */ 56 #define US_SC_SCSI 6 /* Transparent */ 57 #define US_SC_MIN US_SC_RBC 58 #define US_SC_MAX US_SC_SCSI 59 60 /* STORAGE Protocols */ 61 #define US_PR_CB 1 /* Control/Bulk w/o interrupt */ 62 #define US_PR_CBI 0 /* Control/Bulk/Interrupt */ 63 #define US_PR_BULK 0x50 /* bulk only */ 64 65 /* USB types */ 66 #define USB_TYPE_STANDARD (0x00 << 5) 67 #define USB_TYPE_CLASS (0x01 << 5) 68 #define USB_TYPE_VENDOR (0x02 << 5) 69 #define USB_TYPE_RESERVED (0x03 << 5) 70 71 /* USB recipients */ 72 #define USB_RECIP_DEVICE 0x00 73 #define USB_RECIP_INTERFACE 0x01 74 #define USB_RECIP_ENDPOINT 0x02 75 #define USB_RECIP_OTHER 0x03 76 77 /* USB directions */ 78 #define USB_DIR_OUT 0 79 #define USB_DIR_IN 0x80 80 81 /* USB device speeds */ 82 #define USB_SPEED_FULL 0x0 /* 12Mbps */ 83 #define USB_SPEED_LOW 0x1 /* 1.5Mbps */ 84 #define USB_SPEED_HIGH 0x2 /* 480Mbps */ 85 #define USB_SPEED_RESERVED 0x3 86 87 /* Descriptor types */ 88 #define USB_DT_DEVICE 0x01 89 #define USB_DT_CONFIG 0x02 90 #define USB_DT_STRING 0x03 91 #define USB_DT_INTERFACE 0x04 92 #define USB_DT_ENDPOINT 0x05 93 94 #define USB_DT_HID (USB_TYPE_CLASS | 0x01) 95 #define USB_DT_REPORT (USB_TYPE_CLASS | 0x02) 96 #define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03) 97 #define USB_DT_HUB (USB_TYPE_CLASS | 0x09) 98 99 /* Descriptor sizes per descriptor type */ 100 #define USB_DT_DEVICE_SIZE 18 101 #define USB_DT_CONFIG_SIZE 9 102 #define USB_DT_INTERFACE_SIZE 9 103 #define USB_DT_ENDPOINT_SIZE 7 104 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ 105 #define USB_DT_HUB_NONVAR_SIZE 7 106 #define USB_DT_HID_SIZE 9 107 108 /* Endpoints */ 109 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ 110 #define USB_ENDPOINT_DIR_MASK 0x80 111 112 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ 113 #define USB_ENDPOINT_XFER_CONTROL 0 114 #define USB_ENDPOINT_XFER_ISOC 1 115 #define USB_ENDPOINT_XFER_BULK 2 116 #define USB_ENDPOINT_XFER_INT 3 117 118 /* USB Packet IDs (PIDs) */ 119 #define USB_PID_UNDEF_0 0xf0 120 #define USB_PID_OUT 0xe1 121 #define USB_PID_ACK 0xd2 122 #define USB_PID_DATA0 0xc3 123 #define USB_PID_UNDEF_4 0xb4 124 #define USB_PID_SOF 0xa5 125 #define USB_PID_UNDEF_6 0x96 126 #define USB_PID_UNDEF_7 0x87 127 #define USB_PID_UNDEF_8 0x78 128 #define USB_PID_IN 0x69 129 #define USB_PID_NAK 0x5a 130 #define USB_PID_DATA1 0x4b 131 #define USB_PID_PREAMBLE 0x3c 132 #define USB_PID_SETUP 0x2d 133 #define USB_PID_STALL 0x1e 134 #define USB_PID_UNDEF_F 0x0f 135 136 /* Standard requests */ 137 #define USB_REQ_GET_STATUS 0x00 138 #define USB_REQ_CLEAR_FEATURE 0x01 139 #define USB_REQ_SET_FEATURE 0x03 140 #define USB_REQ_SET_ADDRESS 0x05 141 #define USB_REQ_GET_DESCRIPTOR 0x06 142 #define USB_REQ_SET_DESCRIPTOR 0x07 143 #define USB_REQ_GET_CONFIGURATION 0x08 144 #define USB_REQ_SET_CONFIGURATION 0x09 145 #define USB_REQ_GET_INTERFACE 0x0A 146 #define USB_REQ_SET_INTERFACE 0x0B 147 #define USB_REQ_SYNCH_FRAME 0x0C 148 149 /* HID requests */ 150 #define USB_REQ_GET_REPORT 0x01 151 #define USB_REQ_GET_IDLE 0x02 152 #define USB_REQ_GET_PROTOCOL 0x03 153 #define USB_REQ_SET_REPORT 0x09 154 #define USB_REQ_SET_IDLE 0x0A 155 #define USB_REQ_SET_PROTOCOL 0x0B 156 157 158 /* "pipe" definitions */ 159 160 #define PIPE_ISOCHRONOUS 0 161 #define PIPE_INTERRUPT 1 162 #define PIPE_CONTROL 2 163 #define PIPE_BULK 3 164 #define PIPE_DEVEP_MASK 0x0007ff00 165 166 #define USB_ISOCHRONOUS 0 167 #define USB_INTERRUPT 1 168 #define USB_CONTROL 2 169 #define USB_BULK 3 170 171 /* USB-status codes: */ 172 #define USB_ST_ACTIVE 0x1 /* TD is active */ 173 #define USB_ST_STALLED 0x2 /* TD is stalled */ 174 #define USB_ST_BUF_ERR 0x4 /* buffer error */ 175 #define USB_ST_BABBLE_DET 0x8 /* Babble detected */ 176 #define USB_ST_NAK_REC 0x10 /* NAK Received*/ 177 #define USB_ST_CRC_ERR 0x20 /* CRC/timeout Error */ 178 #define USB_ST_BIT_ERR 0x40 /* Bitstuff error */ 179 #define USB_ST_NOT_PROC 0x80000000L /* Not yet processed */ 180 181 182 /************************************************************************* 183 * Hub defines 184 */ 185 186 /* 187 * Hub request types 188 */ 189 190 #define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE) 191 #define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER) 192 193 /* 194 * Hub Class feature numbers 195 */ 196 #define C_HUB_LOCAL_POWER 0 197 #define C_HUB_OVER_CURRENT 1 198 199 /* 200 * Port feature numbers 201 */ 202 #define USB_PORT_FEAT_CONNECTION 0 203 #define USB_PORT_FEAT_ENABLE 1 204 #define USB_PORT_FEAT_SUSPEND 2 205 #define USB_PORT_FEAT_OVER_CURRENT 3 206 #define USB_PORT_FEAT_RESET 4 207 #define USB_PORT_FEAT_POWER 8 208 #define USB_PORT_FEAT_LOWSPEED 9 209 #define USB_PORT_FEAT_HIGHSPEED 10 210 #define USB_PORT_FEAT_C_CONNECTION 16 211 #define USB_PORT_FEAT_C_ENABLE 17 212 #define USB_PORT_FEAT_C_SUSPEND 18 213 #define USB_PORT_FEAT_C_OVER_CURRENT 19 214 #define USB_PORT_FEAT_C_RESET 20 215 216 /* wPortStatus bits */ 217 #define USB_PORT_STAT_CONNECTION 0x0001 218 #define USB_PORT_STAT_ENABLE 0x0002 219 #define USB_PORT_STAT_SUSPEND 0x0004 220 #define USB_PORT_STAT_OVERCURRENT 0x0008 221 #define USB_PORT_STAT_RESET 0x0010 222 #define USB_PORT_STAT_POWER 0x0100 223 #define USB_PORT_STAT_LOW_SPEED 0x0200 224 #define USB_PORT_STAT_HIGH_SPEED 0x0400 /* support for EHCI */ 225 #define USB_PORT_STAT_SPEED \ 226 (USB_PORT_STAT_LOW_SPEED | USB_PORT_STAT_HIGH_SPEED) 227 228 /* wPortChange bits */ 229 #define USB_PORT_STAT_C_CONNECTION 0x0001 230 #define USB_PORT_STAT_C_ENABLE 0x0002 231 #define USB_PORT_STAT_C_SUSPEND 0x0004 232 #define USB_PORT_STAT_C_OVERCURRENT 0x0008 233 #define USB_PORT_STAT_C_RESET 0x0010 234 235 /* wHubCharacteristics (masks) */ 236 #define HUB_CHAR_LPSM 0x0003 237 #define HUB_CHAR_COMPOUND 0x0004 238 #define HUB_CHAR_OCPM 0x0018 239 240 /* 241 *Hub Status & Hub Change bit masks 242 */ 243 #define HUB_STATUS_LOCAL_POWER 0x0001 244 #define HUB_STATUS_OVERCURRENT 0x0002 245 246 #define HUB_CHANGE_LOCAL_POWER 0x0001 247 #define HUB_CHANGE_OVERCURRENT 0x0002 248 249 #endif /*_USB_DEFS_H_ */ 250