3 * Gerry Hamel, geh@ti.com, Texas Instruments
5 * Based on linux/drivers/usbd/usbd.h
7 * Copyright (c) 2000, 2001, 2002 Lineo
8 * Copyright (c) 2001 Hewlett Packard
11 * Stuart Lynne <sl@lineo.com>,
12 * Tom Rushworth <tbr@lineo.com>,
13 * Bruce Balden <balden@lineo.com>
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
31 #ifndef __USBDCORE_H__
32 #define __USBDCORE_H__
35 #include "usbdescriptors.h"
38 #define MAX_URBS_QUEUED 5
42 #define usberr(fmt,args...) serial_printf("ERROR: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
44 #define usberr(fmt,args...) do{}while(0)
48 #define usbdbg(fmt,args...) serial_printf("debug: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
50 #define usbdbg(fmt,args...) do{}while(0)
54 #define usbinfo(fmt,args...) serial_printf("info: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
56 #define usbinfo(fmt,args...) do{}while(0)
60 #define le16_to_cpu(x) (x)
64 #define inb(p) (*(volatile u8*)(p))
68 #define outb(val,p) (*(volatile u8*)(p) = (val))
72 #define inw(p) (*(volatile u16*)(p))
76 #define outw(val,p) (*(volatile u16*)(p) = (val))
80 #define inl(p) (*(volatile u32*)(p))
84 #define outl(val,p) (*(volatile u32*)(p) = (val))
88 #define insw(p,to,len) mmio_insw(p,to,len)
92 #define outsw(p,from,len) mmio_outsw(p,from,len)
96 #define insb(p,to,len) mmio_insb(p,to,len)
100 #define mmio_insw(r,b,l) ({ int __i ; \
103 for (__i = 0; __i < l; __i++) { \
104 *(__b2 + __i) = inw(r); \
110 #define mmio_outsw(r,b,l) ({ int __i; \
113 for (__i = 0; __i < l; __i++) { \
114 outw( *(__b2 + __i), r); \
120 #define mmio_insb(r,b,l) ({ int __i ; \
123 for (__i = 0; __i < l; __i++) { \
124 *(__b2 + __i) = inb(r); \
130 #define MIN(a,b) ((a) < (b) ? (a) : (b))
133 #define MAX(a,b) ((a) > (b) ? (a) : (b))
138 * Structure member address manipulation macros.
139 * These are used by client code (code using the urb_link routines), since
140 * the urb_link structure is embedded in the client data structures.
142 * Note: a macro offsetof equivalent to member_offset is defined in stddef.h
143 * but this is kept here for the sake of portability.
145 * p2surround returns a pointer to the surrounding structure given
146 * type of the surrounding structure, the name memb of the structure
147 * member pointed at by ptr. For example, if you have:
155 * char *cp = &thingy.z;
159 * &thingy == p2surround(struct foo, z, cp)
163 #define _cv_(ptr) ((char*)(void*)(ptr))
164 #define member_offset(type,memb) (_cv_(&(((type*)0)->memb))-(char*)0)
165 #define p2surround(type,memb,ptr) ((type*)(void*)(_cv_(ptr)-member_offset(type,memb)))
169 struct usb_endpoint_instance;
170 struct usb_interface_instance;
171 struct usb_configuration_instance;
172 struct usb_device_instance;
173 struct usb_bus_instance;
176 * Device and/or Interface Class codes
178 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
179 #define USB_CLASS_AUDIO 1
180 #define USB_CLASS_COMM 2
181 #define USB_CLASS_HID 3
182 #define USB_CLASS_PHYSICAL 5
183 #define USB_CLASS_PRINTER 7
184 #define USB_CLASS_MASS_STORAGE 8
185 #define USB_CLASS_HUB 9
186 #define USB_CLASS_DATA 10
187 #define USB_CLASS_APP_SPEC 0xfe
188 #define USB_CLASS_VENDOR_SPEC 0xff
193 #define USB_TYPE_STANDARD (0x00 << 5)
194 #define USB_TYPE_CLASS (0x01 << 5)
195 #define USB_TYPE_VENDOR (0x02 << 5)
196 #define USB_TYPE_RESERVED (0x03 << 5)
201 #define USB_RECIP_DEVICE 0x00
202 #define USB_RECIP_INTERFACE 0x01
203 #define USB_RECIP_ENDPOINT 0x02
204 #define USB_RECIP_OTHER 0x03
209 #define USB_DIR_OUT 0
210 #define USB_DIR_IN 0x80
215 #define USB_DT_DEVICE 0x01
216 #define USB_DT_CONFIG 0x02
217 #define USB_DT_STRING 0x03
218 #define USB_DT_INTERFACE 0x04
219 #define USB_DT_ENDPOINT 0x05
221 #define USB_DT_HID (USB_TYPE_CLASS | 0x01)
222 #define USB_DT_REPORT (USB_TYPE_CLASS | 0x02)
223 #define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
224 #define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
227 * Descriptor sizes per descriptor type
229 #define USB_DT_DEVICE_SIZE 18
230 #define USB_DT_CONFIG_SIZE 9
231 #define USB_DT_INTERFACE_SIZE 9
232 #define USB_DT_ENDPOINT_SIZE 7
233 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
234 #define USB_DT_HUB_NONVAR_SIZE 7
235 #define USB_DT_HID_SIZE 9
240 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
241 #define USB_ENDPOINT_DIR_MASK 0x80
243 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
244 #define USB_ENDPOINT_XFER_CONTROL 0
245 #define USB_ENDPOINT_XFER_ISOC 1
246 #define USB_ENDPOINT_XFER_BULK 2
247 #define USB_ENDPOINT_XFER_INT 3
250 * USB Packet IDs (PIDs)
252 #define USB_PID_UNDEF_0 0xf0
253 #define USB_PID_OUT 0xe1
254 #define USB_PID_ACK 0xd2
255 #define USB_PID_DATA0 0xc3
256 #define USB_PID_PING 0xb4 /* USB 2.0 */
257 #define USB_PID_SOF 0xa5
258 #define USB_PID_NYET 0x96 /* USB 2.0 */
259 #define USB_PID_DATA2 0x87 /* USB 2.0 */
260 #define USB_PID_SPLIT 0x78 /* USB 2.0 */
261 #define USB_PID_IN 0x69
262 #define USB_PID_NAK 0x5a
263 #define USB_PID_DATA1 0x4b
264 #define USB_PID_PREAMBLE 0x3c /* Token mode */
265 #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
266 #define USB_PID_SETUP 0x2d
267 #define USB_PID_STALL 0x1e
268 #define USB_PID_MDATA 0x0f /* USB 2.0 */
273 #define USB_REQ_GET_STATUS 0x00
274 #define USB_REQ_CLEAR_FEATURE 0x01
275 #define USB_REQ_SET_FEATURE 0x03
276 #define USB_REQ_SET_ADDRESS 0x05
277 #define USB_REQ_GET_DESCRIPTOR 0x06
278 #define USB_REQ_SET_DESCRIPTOR 0x07
279 #define USB_REQ_GET_CONFIGURATION 0x08
280 #define USB_REQ_SET_CONFIGURATION 0x09
281 #define USB_REQ_GET_INTERFACE 0x0A
282 #define USB_REQ_SET_INTERFACE 0x0B
283 #define USB_REQ_SYNCH_FRAME 0x0C
285 #define USBD_DEVICE_REQUESTS(x) (((unsigned int)x <= USB_REQ_SYNCH_FRAME) ? usbd_device_requests[x] : "UNKNOWN")
290 #define USB_REQ_GET_REPORT 0x01
291 #define USB_REQ_GET_IDLE 0x02
292 #define USB_REQ_GET_PROTOCOL 0x03
293 #define USB_REQ_SET_REPORT 0x09
294 #define USB_REQ_SET_IDLE 0x0A
295 #define USB_REQ_SET_PROTOCOL 0x0B
299 * USB Spec Release number
302 #define USB_BCD_VERSION 0x0110
306 * Device Requests (c.f Table 9-2)
309 #define USB_REQ_DIRECTION_MASK 0x80
310 #define USB_REQ_TYPE_MASK 0x60
311 #define USB_REQ_RECIPIENT_MASK 0x1f
313 #define USB_REQ_DEVICE2HOST 0x80
314 #define USB_REQ_HOST2DEVICE 0x00
316 #define USB_REQ_TYPE_STANDARD 0x00
317 #define USB_REQ_TYPE_CLASS 0x20
318 #define USB_REQ_TYPE_VENDOR 0x40
320 #define USB_REQ_RECIPIENT_DEVICE 0x00
321 #define USB_REQ_RECIPIENT_INTERFACE 0x01
322 #define USB_REQ_RECIPIENT_ENDPOINT 0x02
323 #define USB_REQ_RECIPIENT_OTHER 0x03
329 #define USB_STATUS_SELFPOWERED 0x01
330 #define USB_STATUS_REMOTEWAKEUP 0x02
332 #define USB_STATUS_HALT 0x01
338 #define USB_DESCRIPTOR_TYPE_DEVICE 0x01
339 #define USB_DESCRIPTOR_TYPE_CONFIGURATION 0x02
340 #define USB_DESCRIPTOR_TYPE_STRING 0x03
341 #define USB_DESCRIPTOR_TYPE_INTERFACE 0x04
342 #define USB_DESCRIPTOR_TYPE_ENDPOINT 0x05
343 #define USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER 0x06
344 #define USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION 0x07
345 #define USB_DESCRIPTOR_TYPE_INTERFACE_POWER 0x08
346 #define USB_DESCRIPTOR_TYPE_HID 0x21
347 #define USB_DESCRIPTOR_TYPE_REPORT 0x22
349 #define USBD_DEVICE_DESCRIPTORS(x) (((unsigned int)x <= USB_DESCRIPTOR_TYPE_INTERFACE_POWER) ? \
350 usbd_device_descriptors[x] : "UNKNOWN")
353 * standard feature selectors
355 #define USB_ENDPOINT_HALT 0x00
356 #define USB_DEVICE_REMOTE_WAKEUP 0x01
357 #define USB_TEST_MODE 0x02
364 struct usb_device_request {
370 } __attribute__ ((packed));
376 typedef enum urb_send_status {
386 * Device State (c.f USB Spec 2.0 Figure 9-1)
388 * What state the usb device is in.
390 * Note the state does not change if the device is suspended, we simply set a
391 * flag to show that it is suspended.
394 typedef enum usb_device_state {
395 STATE_INIT, /* just initialized */
396 STATE_CREATED, /* just created */
397 STATE_ATTACHED, /* we are attached */
398 STATE_POWERED, /* we have seen power indication (electrical bus signal) */
399 STATE_DEFAULT, /* we been reset */
400 STATE_ADDRESSED, /* we have been addressed (in default configuration) */
401 STATE_CONFIGURED, /* we have seen a set configuration device command */
402 STATE_UNKNOWN, /* destroyed */
403 } usb_device_state_t;
405 #define USBD_DEVICE_STATE(x) (((unsigned int)x <= STATE_UNKNOWN) ? usbd_device_states[x] : "UNKNOWN")
412 typedef enum usb_device_status {
413 USBD_OPENING, /* we are currently opening */
414 USBD_OK, /* ok to use */
415 USBD_SUSPENDED, /* we are currently suspended */
416 USBD_CLOSING, /* we are currently closing */
417 } usb_device_status_t;
419 #define USBD_DEVICE_STATUS(x) (((unsigned int)x <= USBD_CLOSING) ? usbd_device_status[x] : "UNKNOWN")
424 * These are defined in the USB Spec (c.f USB Spec 2.0 Figure 9-1).
426 * There are additional events defined to handle some extra actions we need
430 typedef enum usb_device_event {
432 DEVICE_UNKNOWN, /* bi - unknown event */
433 DEVICE_INIT, /* bi - initialize */
434 DEVICE_CREATE, /* bi - */
435 DEVICE_HUB_CONFIGURED, /* bi - bus has been plugged int */
436 DEVICE_RESET, /* bi - hub has powered our port */
438 DEVICE_ADDRESS_ASSIGNED, /* ep0 - set address setup received */
439 DEVICE_CONFIGURED, /* ep0 - set configure setup received */
440 DEVICE_SET_INTERFACE, /* ep0 - set interface setup received */
442 DEVICE_SET_FEATURE, /* ep0 - set feature setup received */
443 DEVICE_CLEAR_FEATURE, /* ep0 - clear feature setup received */
445 DEVICE_DE_CONFIGURED, /* ep0 - set configure setup received for ?? */
447 DEVICE_BUS_INACTIVE, /* bi - bus in inactive (no SOF packets) */
448 DEVICE_BUS_ACTIVITY, /* bi - bus is active again */
450 DEVICE_POWER_INTERRUPTION, /* bi - hub has depowered our port */
451 DEVICE_HUB_RESET, /* bi - bus has been unplugged */
452 DEVICE_DESTROY, /* bi - device instance should be destroyed */
454 DEVICE_HOTPLUG, /* bi - a hotplug event has occured */
456 DEVICE_FUNCTION_PRIVATE, /* function - private */
458 } usb_device_event_t;
461 typedef struct urb_link {
462 struct urb_link *next;
463 struct urb_link *prev;
466 /* USB Data structure - for passing data around.
468 * This is used for both sending and receiving data.
470 * The callback function is used to let the function driver know when
471 * transmitted data has been sent.
473 * The callback function is set by the alloc_recv function when an urb is
474 * allocated for receiving data for an endpoint and used to call the
475 * function driver to inform it that data has arrived.
478 #define URB_BUF_SIZE 128 /* in linux we'd malloc this, but in u-boot we prefer static data */
481 struct usb_endpoint_instance *endpoint;
482 struct usb_device_instance *device;
484 struct usb_device_request device_request; /* contents of received SETUP packet */
486 struct urb_link link; /* embedded struct for circular doubly linked list of urbs */
489 unsigned int buffer_length;
490 unsigned int actual_length;
492 urb_send_status_t status;
495 u16 buffer_data[URB_BUF_SIZE]; /* data received (OUT) or being sent (IN) */
498 /* Endpoint configuration
500 * Per endpoint configuration data. Used to track which function driver owns
504 struct usb_endpoint_instance {
505 int endpoint_address; /* logical endpoint address */
508 int status; /* halted */
509 int state; /* available for use by bus interface driver */
512 struct urb_link rcv; /* received urbs */
513 struct urb_link rdy; /* empty urbs ready to receive */
514 struct urb *rcv_urb; /* active urb */
515 int rcv_attributes; /* copy of bmAttributes from endpoint descriptor */
516 int rcv_packetSize; /* maximum packet size from endpoint descriptor */
517 int rcv_transferSize; /* maximum transfer size from function driver */
521 struct urb_link tx; /* urbs ready to transmit */
522 struct urb_link done; /* transmitted urbs */
523 struct urb *tx_urb; /* active urb */
524 int tx_attributes; /* copy of bmAttributes from endpoint descriptor */
525 int tx_packetSize; /* maximum packet size from endpoint descriptor */
526 int tx_transferSize; /* maximum transfer size from function driver */
529 int sent; /* data already sent */
530 int last; /* data sent in last packet XXX do we need this */
533 struct usb_alternate_instance {
534 struct usb_interface_descriptor *interface_descriptor;
537 int *endpoint_transfersize_array;
538 struct usb_endpoint_descriptor **endpoints_descriptor_array;
541 struct usb_interface_instance {
543 struct usb_alternate_instance *alternates_instance_array;
546 struct usb_configuration_instance {
548 struct usb_configuration_descriptor *configuration_descriptor;
549 struct usb_interface_instance *interface_instance_array;
553 /* USB Device Instance
555 * For each physical bus interface we create a logical device structure. This
556 * tracks all of the required state to track the USB HOST's view of the device.
558 * Keep track of the device configuration for a real physical bus interface,
559 * this includes the bus interface, multiple function drivers, the current
560 * configuration and the current state.
563 * the specific bus interface driver
564 * the default endpoint 0 driver
565 * the configured function driver
571 struct usb_device_instance {
575 struct usb_device_descriptor *device_descriptor; /* per device descriptor */
577 void (*event) (struct usb_device_instance *device, usb_device_event_t event, int data);
579 /* Do cdc device specific control requests */
580 int (*cdc_recv_setup)(struct usb_device_request *request, struct urb *urb);
583 struct usb_bus_instance *bus; /* which bus interface driver */
585 /* configuration descriptors */
587 struct usb_configuration_instance *configuration_instance_array;
590 usb_device_state_t device_state; /* current USB Device state */
591 usb_device_state_t device_previous_state; /* current USB Device state */
593 u8 address; /* current address (zero is default) */
594 u8 configuration; /* current show configuration (zero is default) */
595 u8 interface; /* current interface (zero is default) */
596 u8 alternate; /* alternate flag */
598 usb_device_status_t status; /* device status */
600 int urbs_queued; /* number of submitted urbs */
602 /* Shouldn't need to make this atomic, all we need is a change indicator */
603 unsigned long usbd_rxtx_timestamp;
604 unsigned long usbd_last_rxtx_timestamp;
608 /* Bus Interface configuration structure
610 * This is allocated for each configured instance of a bus interface driver.
612 * The privdata pointer may be used by the bus interface driver to store private
613 * per instance state information.
615 struct usb_bus_instance {
617 struct usb_device_instance *device;
618 struct usb_endpoint_instance *endpoint_array; /* array of available configured endpoints */
620 int max_endpoints; /* maximimum number of rx enpoints */
621 unsigned char maxpacketsize;
623 unsigned int serial_number;
624 char *serial_number_str;
625 void *privdata; /* private data for the bus interface */
629 extern char *usbd_device_events[];
630 extern char *usbd_device_states[];
631 extern char *usbd_device_status[];
632 extern char *usbd_device_requests[];
633 extern char *usbd_device_descriptors[];
635 void urb_link_init (urb_link * ul);
636 void urb_detach (struct urb *urb);
637 urb_link *first_urb_link (urb_link * hd);
638 struct urb *first_urb (urb_link * hd);
639 struct urb *first_urb_detached (urb_link * hd);
640 void urb_append (urb_link * hd, struct urb *urb);
642 struct urb *usbd_alloc_urb (struct usb_device_instance *device, struct usb_endpoint_instance *endpoint);
643 void usbd_dealloc_urb (struct urb *urb);
646 * usbd_device_event is used by bus interface drivers to tell the higher layers that
647 * certain events have taken place.
649 void usbd_device_event_irq (struct usb_device_instance *conf, usb_device_event_t, int);
650 void usbd_device_event (struct usb_device_instance *conf, usb_device_event_t, int);
654 * Various ways of finding descriptors based on the current device and any
655 * possible configuration / interface / endpoint for it.
657 struct usb_configuration_descriptor *usbd_device_configuration_descriptor (struct usb_device_instance *, int, int);
658 struct usb_function_instance *usbd_device_function_instance (struct usb_device_instance *, unsigned int);
659 struct usb_interface_instance *usbd_device_interface_instance (struct usb_device_instance *, int, int, int);
660 struct usb_alternate_instance *usbd_device_alternate_instance (struct usb_device_instance *, int, int, int, int);
661 struct usb_interface_descriptor *usbd_device_interface_descriptor (struct usb_device_instance *, int, int, int, int);
662 struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
663 struct usb_class_descriptor *usbd_device_class_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
664 struct usb_class_report_descriptor *usbd_device_class_report_descriptor_index( struct usb_device_instance *, int , int , int , int , int );
665 struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor (struct usb_device_instance *, int, int, int, int, int);
666 int usbd_device_endpoint_transfersize (struct usb_device_instance *, int, int, int, int, int);
667 struct usb_string_descriptor *usbd_get_string (u8);
668 struct usb_device_descriptor *usbd_device_device_descriptor (struct usb_device_instance *, int);
670 int usbd_endpoint_halted (struct usb_device_instance *device, int endpoint);
671 void usbd_rcv_complete(struct usb_endpoint_instance *endpoint, int len, int urb_bad);
672 void usbd_tx_complete (struct usb_endpoint_instance *endpoint);