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