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 #include <linux/usb/ch9.h> 31 32 /* 33 * The EHCI spec says that we must align to at least 32 bytes. However, 34 * some platforms require larger alignment. 35 */ 36 #if ARCH_DMA_MINALIGN > 32 37 #define USB_DMA_MINALIGN ARCH_DMA_MINALIGN 38 #else 39 #define USB_DMA_MINALIGN 32 40 #endif 41 42 /* Everything is aribtrary */ 43 #define USB_ALTSETTINGALLOC 4 44 #define USB_MAXALTSETTING 128 /* Hard limit */ 45 46 #define USB_MAX_DEVICE 32 47 #define USB_MAXCONFIG 8 48 #define USB_MAXINTERFACES 8 49 #define USB_MAXENDPOINTS 16 50 #define USB_MAXCHILDREN 8 /* This is arbitrary */ 51 #define USB_MAX_HUB 16 52 53 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */ 54 55 /* 56 * This is the timeout to allow for submitting an urb in ms. We allow more 57 * time for a BULK device to react - some are slow. 58 */ 59 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000) 60 61 /* device request (setup) */ 62 struct devrequest { 63 unsigned char requesttype; 64 unsigned char request; 65 unsigned short value; 66 unsigned short index; 67 unsigned short length; 68 } __attribute__ ((packed)); 69 70 /* Interface */ 71 struct usb_interface { 72 struct usb_interface_descriptor desc; 73 74 unsigned char no_of_ep; 75 unsigned char num_altsetting; 76 unsigned char act_altsetting; 77 78 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS]; 79 } __attribute__ ((packed)); 80 81 /* Configuration information.. */ 82 struct usb_config { 83 struct usb_config_descriptor desc; 84 85 unsigned char no_of_if; /* number of interfaces */ 86 struct usb_interface if_desc[USB_MAXINTERFACES]; 87 } __attribute__ ((packed)); 88 89 enum { 90 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */ 91 PACKET_SIZE_8 = 0, 92 PACKET_SIZE_16 = 1, 93 PACKET_SIZE_32 = 2, 94 PACKET_SIZE_64 = 3, 95 }; 96 97 struct usb_device { 98 int devnum; /* Device number on USB bus */ 99 int speed; /* full/low/high */ 100 char mf[32]; /* manufacturer */ 101 char prod[32]; /* product */ 102 char serial[32]; /* serial number */ 103 104 /* Maximum packet size; one of: PACKET_SIZE_* */ 105 int maxpacketsize; 106 /* one bit for each endpoint ([0] = IN, [1] = OUT) */ 107 unsigned int toggle[2]; 108 /* endpoint halts; one bit per endpoint # & direction; 109 * [0] = IN, [1] = OUT 110 */ 111 unsigned int halted[2]; 112 int epmaxpacketin[16]; /* INput endpoint specific maximums */ 113 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */ 114 115 int configno; /* selected config number */ 116 /* Device Descriptor */ 117 struct usb_device_descriptor descriptor 118 __attribute__((aligned(ARCH_DMA_MINALIGN))); 119 struct usb_config config; /* config descriptor */ 120 121 int have_langid; /* whether string_langid is valid yet */ 122 int string_langid; /* language ID for strings */ 123 int (*irq_handle)(struct usb_device *dev); 124 unsigned long irq_status; 125 int irq_act_len; /* transfered bytes */ 126 void *privptr; 127 /* 128 * Child devices - if this is a hub device 129 * Each instance needs its own set of data structures. 130 */ 131 unsigned long status; 132 int act_len; /* transfered bytes */ 133 int maxchild; /* Number of ports if hub */ 134 int portnr; 135 struct usb_device *parent; 136 struct usb_device *children[USB_MAXCHILDREN]; 137 138 void *controller; /* hardware controller private data */ 139 }; 140 141 /********************************************************************** 142 * this is how the lowlevel part communicate with the outer world 143 */ 144 145 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \ 146 defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \ 147 defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \ 148 defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \ 149 defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \ 150 defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \ 151 defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) 152 153 int usb_lowlevel_init(int index, void **controller); 154 int usb_lowlevel_stop(int index); 155 156 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, 157 void *buffer, int transfer_len); 158 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer, 159 int transfer_len, struct devrequest *setup); 160 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer, 161 int transfer_len, int interval); 162 163 /* Defines */ 164 #define USB_UHCI_VEND_ID 0x8086 165 #define USB_UHCI_DEV_ID 0x7112 166 167 /* 168 * PXA25x can only act as USB device. There are drivers 169 * which works with USB CDC gadgets implementations. 170 * Some of them have common routines which can be used 171 * in boards init functions e.g. udc_disconnect() used for 172 * forced device disconnection from host. 173 */ 174 #elif defined(CONFIG_USB_GADGET_PXA2XX) 175 176 extern void udc_disconnect(void); 177 178 #else 179 #error USB Lowlevel not defined 180 #endif 181 182 #ifdef CONFIG_USB_STORAGE 183 184 #define USB_MAX_STOR_DEV 5 185 block_dev_desc_t *usb_stor_get_dev(int index); 186 int usb_stor_scan(int mode); 187 int usb_stor_info(void); 188 189 #endif 190 191 #ifdef CONFIG_USB_HOST_ETHER 192 193 #define USB_MAX_ETH_DEV 5 194 int usb_host_eth_scan(int mode); 195 196 #endif 197 198 #ifdef CONFIG_USB_KEYBOARD 199 200 int drv_usb_kbd_init(void); 201 int usb_kbd_deregister(void); 202 203 #endif 204 /* routines */ 205 int usb_init(void); /* initialize the USB Controller */ 206 int usb_stop(void); /* stop the USB Controller */ 207 208 209 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol); 210 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, 211 int report_id); 212 struct usb_device *usb_get_dev_index(int index); 213 int usb_control_msg(struct usb_device *dev, unsigned int pipe, 214 unsigned char request, unsigned char requesttype, 215 unsigned short value, unsigned short index, 216 void *data, unsigned short size, int timeout); 217 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe, 218 void *data, int len, int *actual_length, int timeout); 219 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe, 220 void *buffer, int transfer_len, int interval); 221 int usb_disable_asynch(int disable); 222 int usb_maxpacket(struct usb_device *dev, unsigned long pipe); 223 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer, 224 int cfgno); 225 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, 226 unsigned char id, void *buf, int size); 227 int usb_get_class_descriptor(struct usb_device *dev, int ifnum, 228 unsigned char type, unsigned char id, void *buf, 229 int size); 230 int usb_clear_halt(struct usb_device *dev, int pipe); 231 int usb_string(struct usb_device *dev, int index, char *buf, size_t size); 232 int usb_set_interface(struct usb_device *dev, int interface, int alternate); 233 234 /* big endian -> little endian conversion */ 235 /* some CPUs are already little endian e.g. the ARM920T */ 236 #define __swap_16(x) \ 237 ({ unsigned short x_ = (unsigned short)x; \ 238 (unsigned short)( \ 239 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \ 240 }) 241 #define __swap_32(x) \ 242 ({ unsigned long x_ = (unsigned long)x; \ 243 (unsigned long)( \ 244 ((x_ & 0x000000FFUL) << 24) | \ 245 ((x_ & 0x0000FF00UL) << 8) | \ 246 ((x_ & 0x00FF0000UL) >> 8) | \ 247 ((x_ & 0xFF000000UL) >> 24)); \ 248 }) 249 250 #ifdef __LITTLE_ENDIAN 251 # define swap_16(x) (x) 252 # define swap_32(x) (x) 253 #else 254 # define swap_16(x) __swap_16(x) 255 # define swap_32(x) __swap_32(x) 256 #endif 257 258 /* 259 * Calling this entity a "pipe" is glorifying it. A USB pipe 260 * is something embarrassingly simple: it basically consists 261 * of the following information: 262 * - device number (7 bits) 263 * - endpoint number (4 bits) 264 * - current Data0/1 state (1 bit) 265 * - direction (1 bit) 266 * - speed (2 bits) 267 * - max packet size (2 bits: 8, 16, 32 or 64) 268 * - pipe type (2 bits: control, interrupt, bulk, isochronous) 269 * 270 * That's 18 bits. Really. Nothing more. And the USB people have 271 * documented these eighteen bits as some kind of glorious 272 * virtual data structure. 273 * 274 * Let's not fall in that trap. We'll just encode it as a simple 275 * unsigned int. The encoding is: 276 * 277 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64) 278 * - direction: bit 7 (0 = Host-to-Device [Out], 279 * (1 = Device-to-Host [In]) 280 * - device: bits 8-14 281 * - endpoint: bits 15-18 282 * - Data0/1: bit 19 283 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 284 * 10 = control, 11 = bulk) 285 * 286 * Why? Because it's arbitrary, and whatever encoding we select is really 287 * up to us. This one happens to share a lot of bit positions with the UHCI 288 * specification, so that much of the uhci driver can just mask the bits 289 * appropriately. 290 */ 291 /* Create various pipes... */ 292 #define create_pipe(dev,endpoint) \ 293 (((dev)->devnum << 8) | ((endpoint) << 15) | \ 294 (dev)->maxpacketsize) 295 #define default_pipe(dev) ((dev)->speed << 26) 296 297 #define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ 298 create_pipe(dev, endpoint)) 299 #define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ 300 create_pipe(dev, endpoint) | \ 301 USB_DIR_IN) 302 #define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ 303 create_pipe(dev, endpoint)) 304 #define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ 305 create_pipe(dev, endpoint) | \ 306 USB_DIR_IN) 307 #define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ 308 create_pipe(dev, endpoint)) 309 #define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ 310 create_pipe(dev, endpoint) | \ 311 USB_DIR_IN) 312 #define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ 313 create_pipe(dev, endpoint)) 314 #define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ 315 create_pipe(dev, endpoint) | \ 316 USB_DIR_IN) 317 #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \ 318 default_pipe(dev)) 319 #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \ 320 default_pipe(dev) | \ 321 USB_DIR_IN) 322 323 /* The D0/D1 toggle bits */ 324 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1) 325 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep)) 326 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \ 327 ((dev)->toggle[out] & \ 328 ~(1 << ep)) | ((bit) << ep)) 329 330 /* Endpoint halt control/status */ 331 #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1) 332 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep))) 333 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep))) 334 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep))) 335 336 #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \ 337 USB_PID_OUT) 338 339 #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1) 340 #define usb_pipein(pipe) (((pipe) >> 7) & 1) 341 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) 342 #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff) 343 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) 344 #define usb_pipedata(pipe) (((pipe) >> 19) & 1) 345 #define usb_pipetype(pipe) (((pipe) >> 30) & 3) 346 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) 347 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) 348 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) 349 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) 350 351 352 /************************************************************************* 353 * Hub Stuff 354 */ 355 struct usb_port_status { 356 unsigned short wPortStatus; 357 unsigned short wPortChange; 358 } __attribute__ ((packed)); 359 360 struct usb_hub_status { 361 unsigned short wHubStatus; 362 unsigned short wHubChange; 363 } __attribute__ ((packed)); 364 365 366 /* Hub descriptor */ 367 struct usb_hub_descriptor { 368 unsigned char bLength; 369 unsigned char bDescriptorType; 370 unsigned char bNbrPorts; 371 unsigned short wHubCharacteristics; 372 unsigned char bPwrOn2PwrGood; 373 unsigned char bHubContrCurrent; 374 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8]; 375 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8]; 376 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length 377 bitmaps that hold max 255 entries. (bit0 is ignored) */ 378 } __attribute__ ((packed)); 379 380 381 struct usb_hub_device { 382 struct usb_device *pusb_dev; 383 struct usb_hub_descriptor desc; 384 }; 385 386 int usb_hub_probe(struct usb_device *dev, int ifnum); 387 void usb_hub_reset(void); 388 int hub_port_reset(struct usb_device *dev, int port, 389 unsigned short *portstat); 390 391 struct usb_device *usb_alloc_new_device(void *controller); 392 393 int usb_new_device(struct usb_device *dev); 394 395 #endif /*_USB_H_ */ 396