1 /* 2 * (C) Copyright 2001 3 * Denis Peter, MPL AG Switzerland 4 * 5 * See file CREDITS for list of people who contributed to this 6 * project. 7 * 8 * This program is free software; you can redistribute it and/or 9 * modify it under the terms of the GNU General Public License as 10 * published by the Free Software Foundation; either version 2 of 11 * the License, or (at your option) any later version. 12 * 13 * This program is distributed in the hope that it will be useful, 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * GNU General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21 * MA 02111-1307 USA 22 * 23 * Note: Part of this code has been derived from linux 24 * 25 */ 26 #ifndef _USB_H_ 27 #define _USB_H_ 28 29 #include <usb_defs.h> 30 31 /* Everything is aribtrary */ 32 #define USB_ALTSETTINGALLOC 4 33 #define USB_MAXALTSETTING 128 /* Hard limit */ 34 35 #define USB_MAX_DEVICE 32 36 #define USB_MAXCONFIG 8 37 #define USB_MAXINTERFACES 8 38 #define USB_MAXENDPOINTS 16 39 #define USB_MAXCHILDREN 8 /* This is arbitrary */ 40 #define USB_MAX_HUB 16 41 42 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */ 43 44 /* String descriptor */ 45 struct usb_string_descriptor { 46 unsigned char bLength; 47 unsigned char bDescriptorType; 48 unsigned short wData[1]; 49 } __attribute__ ((packed)); 50 51 /* device request (setup) */ 52 struct devrequest { 53 unsigned char requesttype; 54 unsigned char request; 55 unsigned short value; 56 unsigned short index; 57 unsigned short length; 58 } __attribute__ ((packed)); 59 60 61 /* All standard descriptors have these 2 fields in common */ 62 struct usb_descriptor_header { 63 unsigned char bLength; 64 unsigned char bDescriptorType; 65 } __attribute__ ((packed)); 66 67 /* Device descriptor */ 68 struct usb_device_descriptor { 69 unsigned char bLength; 70 unsigned char bDescriptorType; 71 unsigned short bcdUSB; 72 unsigned char bDeviceClass; 73 unsigned char bDeviceSubClass; 74 unsigned char bDeviceProtocol; 75 unsigned char bMaxPacketSize0; 76 unsigned short idVendor; 77 unsigned short idProduct; 78 unsigned short bcdDevice; 79 unsigned char iManufacturer; 80 unsigned char iProduct; 81 unsigned char iSerialNumber; 82 unsigned char bNumConfigurations; 83 } __attribute__ ((packed)); 84 85 86 /* Endpoint descriptor */ 87 struct usb_endpoint_descriptor { 88 unsigned char bLength; 89 unsigned char bDescriptorType; 90 unsigned char bEndpointAddress; 91 unsigned char bmAttributes; 92 unsigned short wMaxPacketSize; 93 unsigned char bInterval; 94 unsigned char bRefresh; 95 unsigned char bSynchAddress; 96 97 } __attribute__ ((packed)); 98 /* Interface descriptor */ 99 struct usb_interface_descriptor { 100 unsigned char bLength; 101 unsigned char bDescriptorType; 102 unsigned char bInterfaceNumber; 103 unsigned char bAlternateSetting; 104 unsigned char bNumEndpoints; 105 unsigned char bInterfaceClass; 106 unsigned char bInterfaceSubClass; 107 unsigned char bInterfaceProtocol; 108 unsigned char iInterface; 109 110 unsigned char no_of_ep; 111 unsigned char num_altsetting; 112 unsigned char act_altsetting; 113 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS]; 114 } __attribute__ ((packed)); 115 116 117 /* Configuration descriptor information.. */ 118 struct usb_config_descriptor { 119 unsigned char bLength; 120 unsigned char bDescriptorType; 121 unsigned short wTotalLength; 122 unsigned char bNumInterfaces; 123 unsigned char bConfigurationValue; 124 unsigned char iConfiguration; 125 unsigned char bmAttributes; 126 unsigned char MaxPower; 127 128 unsigned char no_of_if; /* number of interfaces */ 129 struct usb_interface_descriptor if_desc[USB_MAXINTERFACES]; 130 } __attribute__ ((packed)); 131 132 enum { 133 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */ 134 PACKET_SIZE_8 = 0, 135 PACKET_SIZE_16 = 1, 136 PACKET_SIZE_32 = 2, 137 PACKET_SIZE_64 = 3, 138 }; 139 140 struct usb_device { 141 int devnum; /* Device number on USB bus */ 142 int slow; /* Slow device? */ 143 char mf[32]; /* manufacturer */ 144 char prod[32]; /* product */ 145 char serial[32]; /* serial number */ 146 147 /* Maximum packet size; one of: PACKET_SIZE_* */ 148 int maxpacketsize; 149 /* one bit for each endpoint ([0] = IN, [1] = OUT) */ 150 unsigned int toggle[2]; 151 /* endpoint halts; one bit per endpoint # & direction; */ 152 unsigned int halted[2]; 153 /* [0] = IN, [1] = OUT */ 154 int epmaxpacketin[16]; /* INput endpoint specific maximums */ 155 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */ 156 157 int configno; /* selected config number */ 158 struct usb_device_descriptor descriptor; /* Device Descriptor */ 159 struct usb_config_descriptor config; /* config descriptor */ 160 161 int have_langid; /* whether string_langid is valid yet */ 162 int string_langid; /* language ID for strings */ 163 int (*irq_handle)(struct usb_device *dev); 164 unsigned long irq_status; 165 int irq_act_len; /* transfered bytes */ 166 void *privptr; 167 /* 168 * Child devices - if this is a hub device 169 * Each instance needs its own set of data structures. 170 */ 171 unsigned long status; 172 int act_len; /* transfered bytes */ 173 int maxchild; /* Number of ports if hub */ 174 struct usb_device *parent; 175 struct usb_device *children[USB_MAXCHILDREN]; 176 }; 177 178 /********************************************************************** 179 * this is how the lowlevel part communicate with the outer world 180 */ 181 182 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \ 183 defined(CONFIG_USB_OHCI_NEW) || defined (CONFIG_USB_SL811HS) || \ 184 defined(CONFIG_USB_ISP116X_HCD) || defined(CONFIG_USB_R8A66597_HCD) 185 186 int usb_lowlevel_init(void); 187 int usb_lowlevel_stop(void); 188 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, void *buffer,int transfer_len); 189 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer, 190 int transfer_len,struct devrequest *setup); 191 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer, 192 int transfer_len, int interval); 193 void usb_event_poll(void); 194 195 /* Defines */ 196 #define USB_UHCI_VEND_ID 0x8086 197 #define USB_UHCI_DEV_ID 0x7112 198 199 #else 200 #error USB Lowlevel not defined 201 #endif 202 203 #ifdef CONFIG_USB_STORAGE 204 205 #define USB_MAX_STOR_DEV 5 206 block_dev_desc_t *usb_stor_get_dev(int index); 207 int usb_stor_scan(int mode); 208 int usb_stor_info(void); 209 210 #endif 211 212 #ifdef CONFIG_USB_KEYBOARD 213 214 int drv_usb_kbd_init(void); 215 int usb_kbd_deregister(void); 216 217 #endif 218 /* routines */ 219 int usb_init(void); /* initialize the USB Controller */ 220 int usb_stop(void); /* stop the USB Controller */ 221 222 223 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol); 224 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id); 225 struct usb_device * usb_get_dev_index(int index); 226 int usb_control_msg(struct usb_device *dev, unsigned int pipe, 227 unsigned char request, unsigned char requesttype, 228 unsigned short value, unsigned short index, 229 void *data, unsigned short size, int timeout); 230 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe, 231 void *data, int len, int *actual_length, int timeout); 232 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe, 233 void *buffer,int transfer_len, int interval); 234 void usb_disable_asynch(int disable); 235 int usb_maxpacket(struct usb_device *dev,unsigned long pipe); 236 void __inline__ wait_ms(unsigned long ms); 237 int usb_get_configuration_no(struct usb_device *dev,unsigned char *buffer,int cfgno); 238 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size); 239 int usb_get_class_descriptor(struct usb_device *dev, int ifnum, 240 unsigned char type, unsigned char id, void *buf, int size); 241 int usb_clear_halt(struct usb_device *dev, int pipe); 242 int usb_string(struct usb_device *dev, int index, char *buf, size_t size); 243 int usb_set_interface(struct usb_device *dev, int interface, int alternate); 244 245 /* big endian -> little endian conversion */ 246 /* some CPUs are already little endian e.g. the ARM920T */ 247 #define __swap_16(x) \ 248 ({ unsigned short x_ = (unsigned short)x; \ 249 (unsigned short)( \ 250 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8) ); \ 251 }) 252 #define __swap_32(x) \ 253 ({ unsigned long x_ = (unsigned long)x; \ 254 (unsigned long)( \ 255 ((x_ & 0x000000FFUL) << 24) | \ 256 ((x_ & 0x0000FF00UL) << 8) | \ 257 ((x_ & 0x00FF0000UL) >> 8) | \ 258 ((x_ & 0xFF000000UL) >> 24) ); \ 259 }) 260 261 #ifdef LITTLEENDIAN 262 # define swap_16(x) (x) 263 # define swap_32(x) (x) 264 #else 265 # define swap_16(x) __swap_16(x) 266 # define swap_32(x) __swap_32(x) 267 #endif /* LITTLEENDIAN */ 268 269 /* 270 * Calling this entity a "pipe" is glorifying it. A USB pipe 271 * is something embarrassingly simple: it basically consists 272 * of the following information: 273 * - device number (7 bits) 274 * - endpoint number (4 bits) 275 * - current Data0/1 state (1 bit) 276 * - direction (1 bit) 277 * - speed (1 bit) 278 * - max packet size (2 bits: 8, 16, 32 or 64) 279 * - pipe type (2 bits: control, interrupt, bulk, isochronous) 280 * 281 * That's 18 bits. Really. Nothing more. And the USB people have 282 * documented these eighteen bits as some kind of glorious 283 * virtual data structure. 284 * 285 * Let's not fall in that trap. We'll just encode it as a simple 286 * unsigned int. The encoding is: 287 * 288 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64) 289 * - direction: bit 7 (0 = Host-to-Device [Out], 1 = Device-to-Host [In]) 290 * - device: bits 8-14 291 * - endpoint: bits 15-18 292 * - Data0/1: bit 19 293 * - speed: bit 26 (0 = Full, 1 = Low Speed) 294 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 10 = control, 11 = bulk) 295 * 296 * Why? Because it's arbitrary, and whatever encoding we select is really 297 * up to us. This one happens to share a lot of bit positions with the UHCI 298 * specification, so that much of the uhci driver can just mask the bits 299 * appropriately. 300 */ 301 /* Create various pipes... */ 302 #define create_pipe(dev,endpoint) \ 303 (((dev)->devnum << 8) | (endpoint << 15) | ((dev)->slow << 26) | (dev)->maxpacketsize) 304 #define default_pipe(dev) ((dev)->slow <<26) 305 306 #define usb_sndctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | create_pipe(dev,endpoint)) 307 #define usb_rcvctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | create_pipe(dev,endpoint) | USB_DIR_IN) 308 #define usb_sndisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | create_pipe(dev,endpoint)) 309 #define usb_rcvisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | create_pipe(dev,endpoint) | USB_DIR_IN) 310 #define usb_sndbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | create_pipe(dev,endpoint)) 311 #define usb_rcvbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | create_pipe(dev,endpoint) | USB_DIR_IN) 312 #define usb_sndintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | create_pipe(dev,endpoint)) 313 #define usb_rcvintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | create_pipe(dev,endpoint) | USB_DIR_IN) 314 #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | default_pipe(dev)) 315 #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | default_pipe(dev) | USB_DIR_IN) 316 317 /* The D0/D1 toggle bits */ 318 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1) 319 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep)) 320 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << ep)) | ((bit) << ep)) 321 322 /* Endpoint halt control/status */ 323 #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1) 324 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep))) 325 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep))) 326 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep))) 327 328 #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : USB_PID_OUT) 329 330 #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1) 331 #define usb_pipein(pipe) (((pipe) >> 7) & 1) 332 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) 333 #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff) 334 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) 335 #define usb_pipedata(pipe) (((pipe) >> 19) & 1) 336 #define usb_pipeslow(pipe) (((pipe) >> 26) & 1) 337 #define usb_pipetype(pipe) (((pipe) >> 30) & 3) 338 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) 339 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) 340 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) 341 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) 342 343 344 /************************************************************************* 345 * Hub Stuff 346 */ 347 struct usb_port_status { 348 unsigned short wPortStatus; 349 unsigned short wPortChange; 350 } __attribute__ ((packed)); 351 352 struct usb_hub_status { 353 unsigned short wHubStatus; 354 unsigned short wHubChange; 355 } __attribute__ ((packed)); 356 357 358 /* Hub descriptor */ 359 struct usb_hub_descriptor { 360 unsigned char bLength; 361 unsigned char bDescriptorType; 362 unsigned char bNbrPorts; 363 unsigned short wHubCharacteristics; 364 unsigned char bPwrOn2PwrGood; 365 unsigned char bHubContrCurrent; 366 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8]; 367 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8]; 368 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length 369 bitmaps that hold max 255 entries. (bit0 is ignored) */ 370 } __attribute__ ((packed)); 371 372 373 struct usb_hub_device { 374 struct usb_device *pusb_dev; 375 struct usb_hub_descriptor desc; 376 }; 377 378 #endif /*_USB_H_ */ 379