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 * Structure member address manipulation macros.
131 * These are used by client code (code using the urb_link routines), since
132 * the urb_link structure is embedded in the client data structures.
134 * Note: a macro offsetof equivalent to member_offset is defined in stddef.h
135 * but this is kept here for the sake of portability.
137 * p2surround returns a pointer to the surrounding structure given
138 * type of the surrounding structure, the name memb of the structure
139 * member pointed at by ptr. For example, if you have:
147 * char *cp = &thingy.z;
151 * &thingy == p2surround(struct foo, z, cp)
155 #define _cv_(ptr) ((char*)(void*)(ptr))
156 #define member_offset(type,memb) (_cv_(&(((type*)0)->memb))-(char*)0)
157 #define p2surround(type,memb,ptr) ((type*)(void*)(_cv_(ptr)-member_offset(type,memb)))
161 struct usb_endpoint_instance;
162 struct usb_interface_instance;
163 struct usb_configuration_instance;
164 struct usb_device_instance;
165 struct usb_bus_instance;
168 * Device and/or Interface Class codes
170 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
171 #define USB_CLASS_AUDIO 1
172 #define USB_CLASS_COMM 2
173 #define USB_CLASS_HID 3
174 #define USB_CLASS_PHYSICAL 5
175 #define USB_CLASS_PRINTER 7
176 #define USB_CLASS_MASS_STORAGE 8
177 #define USB_CLASS_HUB 9
178 #define USB_CLASS_DATA 10
179 #define USB_CLASS_APP_SPEC 0xfe
180 #define USB_CLASS_VENDOR_SPEC 0xff
185 #define USB_TYPE_STANDARD (0x00 << 5)
186 #define USB_TYPE_CLASS (0x01 << 5)
187 #define USB_TYPE_VENDOR (0x02 << 5)
188 #define USB_TYPE_RESERVED (0x03 << 5)
193 #define USB_RECIP_DEVICE 0x00
194 #define USB_RECIP_INTERFACE 0x01
195 #define USB_RECIP_ENDPOINT 0x02
196 #define USB_RECIP_OTHER 0x03
201 #define USB_DIR_OUT 0
202 #define USB_DIR_IN 0x80
207 #define USB_DT_DEVICE 0x01
208 #define USB_DT_CONFIG 0x02
209 #define USB_DT_STRING 0x03
210 #define USB_DT_INTERFACE 0x04
211 #define USB_DT_ENDPOINT 0x05
213 #define USB_DT_HID (USB_TYPE_CLASS | 0x01)
214 #define USB_DT_REPORT (USB_TYPE_CLASS | 0x02)
215 #define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
216 #define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
219 * Descriptor sizes per descriptor type
221 #define USB_DT_DEVICE_SIZE 18
222 #define USB_DT_CONFIG_SIZE 9
223 #define USB_DT_INTERFACE_SIZE 9
224 #define USB_DT_ENDPOINT_SIZE 7
225 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
226 #define USB_DT_HUB_NONVAR_SIZE 7
227 #define USB_DT_HID_SIZE 9
232 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
233 #define USB_ENDPOINT_DIR_MASK 0x80
235 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
236 #define USB_ENDPOINT_XFER_CONTROL 0
237 #define USB_ENDPOINT_XFER_ISOC 1
238 #define USB_ENDPOINT_XFER_BULK 2
239 #define USB_ENDPOINT_XFER_INT 3
242 * USB Packet IDs (PIDs)
244 #define USB_PID_UNDEF_0 0xf0
245 #define USB_PID_OUT 0xe1
246 #define USB_PID_ACK 0xd2
247 #define USB_PID_DATA0 0xc3
248 #define USB_PID_PING 0xb4 /* USB 2.0 */
249 #define USB_PID_SOF 0xa5
250 #define USB_PID_NYET 0x96 /* USB 2.0 */
251 #define USB_PID_DATA2 0x87 /* USB 2.0 */
252 #define USB_PID_SPLIT 0x78 /* USB 2.0 */
253 #define USB_PID_IN 0x69
254 #define USB_PID_NAK 0x5a
255 #define USB_PID_DATA1 0x4b
256 #define USB_PID_PREAMBLE 0x3c /* Token mode */
257 #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */
258 #define USB_PID_SETUP 0x2d
259 #define USB_PID_STALL 0x1e
260 #define USB_PID_MDATA 0x0f /* USB 2.0 */
265 #define USB_REQ_GET_STATUS 0x00
266 #define USB_REQ_CLEAR_FEATURE 0x01
267 #define USB_REQ_SET_FEATURE 0x03
268 #define USB_REQ_SET_ADDRESS 0x05
269 #define USB_REQ_GET_DESCRIPTOR 0x06
270 #define USB_REQ_SET_DESCRIPTOR 0x07
271 #define USB_REQ_GET_CONFIGURATION 0x08
272 #define USB_REQ_SET_CONFIGURATION 0x09
273 #define USB_REQ_GET_INTERFACE 0x0A
274 #define USB_REQ_SET_INTERFACE 0x0B
275 #define USB_REQ_SYNCH_FRAME 0x0C
277 #define USBD_DEVICE_REQUESTS(x) (((unsigned int)x <= USB_REQ_SYNCH_FRAME) ? usbd_device_requests[x] : "UNKNOWN")
282 #define USB_REQ_GET_REPORT 0x01
283 #define USB_REQ_GET_IDLE 0x02
284 #define USB_REQ_GET_PROTOCOL 0x03
285 #define USB_REQ_SET_REPORT 0x09
286 #define USB_REQ_SET_IDLE 0x0A
287 #define USB_REQ_SET_PROTOCOL 0x0B
291 * USB Spec Release number
294 #define USB_BCD_VERSION 0x0110
298 * Device Requests (c.f Table 9-2)
301 #define USB_REQ_DIRECTION_MASK 0x80
302 #define USB_REQ_TYPE_MASK 0x60
303 #define USB_REQ_RECIPIENT_MASK 0x1f
305 #define USB_REQ_DEVICE2HOST 0x80
306 #define USB_REQ_HOST2DEVICE 0x00
308 #define USB_REQ_TYPE_STANDARD 0x00
309 #define USB_REQ_TYPE_CLASS 0x20
310 #define USB_REQ_TYPE_VENDOR 0x40
312 #define USB_REQ_RECIPIENT_DEVICE 0x00
313 #define USB_REQ_RECIPIENT_INTERFACE 0x01
314 #define USB_REQ_RECIPIENT_ENDPOINT 0x02
315 #define USB_REQ_RECIPIENT_OTHER 0x03
321 #define USB_STATUS_SELFPOWERED 0x01
322 #define USB_STATUS_REMOTEWAKEUP 0x02
324 #define USB_STATUS_HALT 0x01
330 #define USB_DESCRIPTOR_TYPE_DEVICE 0x01
331 #define USB_DESCRIPTOR_TYPE_CONFIGURATION 0x02
332 #define USB_DESCRIPTOR_TYPE_STRING 0x03
333 #define USB_DESCRIPTOR_TYPE_INTERFACE 0x04
334 #define USB_DESCRIPTOR_TYPE_ENDPOINT 0x05
335 #define USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER 0x06
336 #define USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION 0x07
337 #define USB_DESCRIPTOR_TYPE_INTERFACE_POWER 0x08
338 #define USB_DESCRIPTOR_TYPE_HID 0x21
339 #define USB_DESCRIPTOR_TYPE_REPORT 0x22
341 #define USBD_DEVICE_DESCRIPTORS(x) (((unsigned int)x <= USB_DESCRIPTOR_TYPE_INTERFACE_POWER) ? \
342 usbd_device_descriptors[x] : "UNKNOWN")
345 * standard feature selectors
347 #define USB_ENDPOINT_HALT 0x00
348 #define USB_DEVICE_REMOTE_WAKEUP 0x01
349 #define USB_TEST_MODE 0x02
356 struct usb_device_request {
362 } __attribute__ ((packed));
368 typedef enum urb_send_status {
378 * Device State (c.f USB Spec 2.0 Figure 9-1)
380 * What state the usb device is in.
382 * Note the state does not change if the device is suspended, we simply set a
383 * flag to show that it is suspended.
386 typedef enum usb_device_state {
387 STATE_INIT, /* just initialized */
388 STATE_CREATED, /* just created */
389 STATE_ATTACHED, /* we are attached */
390 STATE_POWERED, /* we have seen power indication (electrical bus signal) */
391 STATE_DEFAULT, /* we been reset */
392 STATE_ADDRESSED, /* we have been addressed (in default configuration) */
393 STATE_CONFIGURED, /* we have seen a set configuration device command */
394 STATE_UNKNOWN, /* destroyed */
395 } usb_device_state_t;
397 #define USBD_DEVICE_STATE(x) (((unsigned int)x <= STATE_UNKNOWN) ? usbd_device_states[x] : "UNKNOWN")
404 typedef enum usb_device_status {
405 USBD_OPENING, /* we are currently opening */
406 USBD_OK, /* ok to use */
407 USBD_SUSPENDED, /* we are currently suspended */
408 USBD_CLOSING, /* we are currently closing */
409 } usb_device_status_t;
411 #define USBD_DEVICE_STATUS(x) (((unsigned int)x <= USBD_CLOSING) ? usbd_device_status[x] : "UNKNOWN")
416 * These are defined in the USB Spec (c.f USB Spec 2.0 Figure 9-1).
418 * There are additional events defined to handle some extra actions we need
422 typedef enum usb_device_event {
424 DEVICE_UNKNOWN, /* bi - unknown event */
425 DEVICE_INIT, /* bi - initialize */
426 DEVICE_CREATE, /* bi - */
427 DEVICE_HUB_CONFIGURED, /* bi - bus has been plugged int */
428 DEVICE_RESET, /* bi - hub has powered our port */
430 DEVICE_ADDRESS_ASSIGNED, /* ep0 - set address setup received */
431 DEVICE_CONFIGURED, /* ep0 - set configure setup received */
432 DEVICE_SET_INTERFACE, /* ep0 - set interface setup received */
434 DEVICE_SET_FEATURE, /* ep0 - set feature setup received */
435 DEVICE_CLEAR_FEATURE, /* ep0 - clear feature setup received */
437 DEVICE_DE_CONFIGURED, /* ep0 - set configure setup received for ?? */
439 DEVICE_BUS_INACTIVE, /* bi - bus in inactive (no SOF packets) */
440 DEVICE_BUS_ACTIVITY, /* bi - bus is active again */
442 DEVICE_POWER_INTERRUPTION, /* bi - hub has depowered our port */
443 DEVICE_HUB_RESET, /* bi - bus has been unplugged */
444 DEVICE_DESTROY, /* bi - device instance should be destroyed */
446 DEVICE_HOTPLUG, /* bi - a hotplug event has occured */
448 DEVICE_FUNCTION_PRIVATE, /* function - private */
450 } usb_device_event_t;
453 typedef struct urb_link {
454 struct urb_link *next;
455 struct urb_link *prev;
458 /* USB Data structure - for passing data around.
460 * This is used for both sending and receiving data.
462 * The callback function is used to let the function driver know when
463 * transmitted data has been sent.
465 * The callback function is set by the alloc_recv function when an urb is
466 * allocated for receiving data for an endpoint and used to call the
467 * function driver to inform it that data has arrived.
470 #define URB_BUF_SIZE 128 /* in linux we'd malloc this, but in u-boot we prefer static data */
473 struct usb_endpoint_instance *endpoint;
474 struct usb_device_instance *device;
476 struct usb_device_request device_request; /* contents of received SETUP packet */
478 struct urb_link link; /* embedded struct for circular doubly linked list of urbs */
481 unsigned int buffer_length;
482 unsigned int actual_length;
484 urb_send_status_t status;
487 u16 buffer_data[URB_BUF_SIZE]; /* data received (OUT) or being sent (IN) */
490 /* Endpoint configuration
492 * Per endpoint configuration data. Used to track which function driver owns
496 struct usb_endpoint_instance {
497 int endpoint_address; /* logical endpoint address */
500 int status; /* halted */
501 int state; /* available for use by bus interface driver */
504 struct urb_link rcv; /* received urbs */
505 struct urb_link rdy; /* empty urbs ready to receive */
506 struct urb *rcv_urb; /* active urb */
507 int rcv_attributes; /* copy of bmAttributes from endpoint descriptor */
508 int rcv_packetSize; /* maximum packet size from endpoint descriptor */
509 int rcv_transferSize; /* maximum transfer size from function driver */
513 struct urb_link tx; /* urbs ready to transmit */
514 struct urb_link done; /* transmitted urbs */
515 struct urb *tx_urb; /* active urb */
516 int tx_attributes; /* copy of bmAttributes from endpoint descriptor */
517 int tx_packetSize; /* maximum packet size from endpoint descriptor */
518 int tx_transferSize; /* maximum transfer size from function driver */
521 int sent; /* data already sent */
522 int last; /* data sent in last packet XXX do we need this */
525 struct usb_alternate_instance {
526 struct usb_interface_descriptor *interface_descriptor;
529 int *endpoint_transfersize_array;
530 struct usb_endpoint_descriptor **endpoints_descriptor_array;
533 struct usb_interface_instance {
535 struct usb_alternate_instance *alternates_instance_array;
538 struct usb_configuration_instance {
540 struct usb_configuration_descriptor *configuration_descriptor;
541 struct usb_interface_instance *interface_instance_array;
545 /* USB Device Instance
547 * For each physical bus interface we create a logical device structure. This
548 * tracks all of the required state to track the USB HOST's view of the device.
550 * Keep track of the device configuration for a real physical bus interface,
551 * this includes the bus interface, multiple function drivers, the current
552 * configuration and the current state.
555 * the specific bus interface driver
556 * the default endpoint 0 driver
557 * the configured function driver
563 struct usb_device_instance {
567 struct usb_device_descriptor *device_descriptor; /* per device descriptor */
569 void (*event) (struct usb_device_instance *device, usb_device_event_t event, int data);
571 /* Do cdc device specific control requests */
572 int (*cdc_recv_setup)(struct usb_device_request *request, struct urb *urb);
575 struct usb_bus_instance *bus; /* which bus interface driver */
577 /* configuration descriptors */
579 struct usb_configuration_instance *configuration_instance_array;
582 usb_device_state_t device_state; /* current USB Device state */
583 usb_device_state_t device_previous_state; /* current USB Device state */
585 u8 address; /* current address (zero is default) */
586 u8 configuration; /* current show configuration (zero is default) */
587 u8 interface; /* current interface (zero is default) */
588 u8 alternate; /* alternate flag */
590 usb_device_status_t status; /* device status */
592 int urbs_queued; /* number of submitted urbs */
594 /* Shouldn't need to make this atomic, all we need is a change indicator */
595 unsigned long usbd_rxtx_timestamp;
596 unsigned long usbd_last_rxtx_timestamp;
600 /* Bus Interface configuration structure
602 * This is allocated for each configured instance of a bus interface driver.
604 * The privdata pointer may be used by the bus interface driver to store private
605 * per instance state information.
607 struct usb_bus_instance {
609 struct usb_device_instance *device;
610 struct usb_endpoint_instance *endpoint_array; /* array of available configured endpoints */
612 int max_endpoints; /* maximimum number of rx enpoints */
613 unsigned char maxpacketsize;
615 unsigned int serial_number;
616 char *serial_number_str;
617 void *privdata; /* private data for the bus interface */
621 extern char *usbd_device_events[];
622 extern char *usbd_device_states[];
623 extern char *usbd_device_status[];
624 extern char *usbd_device_requests[];
625 extern char *usbd_device_descriptors[];
627 void urb_link_init (urb_link * ul);
628 void urb_detach (struct urb *urb);
629 urb_link *first_urb_link (urb_link * hd);
630 struct urb *first_urb (urb_link * hd);
631 struct urb *first_urb_detached (urb_link * hd);
632 void urb_append (urb_link * hd, struct urb *urb);
634 struct urb *usbd_alloc_urb (struct usb_device_instance *device, struct usb_endpoint_instance *endpoint);
635 void usbd_dealloc_urb (struct urb *urb);
638 * usbd_device_event is used by bus interface drivers to tell the higher layers that
639 * certain events have taken place.
641 void usbd_device_event_irq (struct usb_device_instance *conf, usb_device_event_t, int);
642 void usbd_device_event (struct usb_device_instance *conf, usb_device_event_t, int);
646 * Various ways of finding descriptors based on the current device and any
647 * possible configuration / interface / endpoint for it.
649 struct usb_configuration_descriptor *usbd_device_configuration_descriptor (struct usb_device_instance *, int, int);
650 struct usb_function_instance *usbd_device_function_instance (struct usb_device_instance *, unsigned int);
651 struct usb_interface_instance *usbd_device_interface_instance (struct usb_device_instance *, int, int, int);
652 struct usb_alternate_instance *usbd_device_alternate_instance (struct usb_device_instance *, int, int, int, int);
653 struct usb_interface_descriptor *usbd_device_interface_descriptor (struct usb_device_instance *, int, int, int, int);
654 struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
655 struct usb_class_descriptor *usbd_device_class_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
656 struct usb_class_report_descriptor *usbd_device_class_report_descriptor_index( struct usb_device_instance *, int , int , int , int , int );
657 struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor (struct usb_device_instance *, int, int, int, int, int);
658 int usbd_device_endpoint_transfersize (struct usb_device_instance *, int, int, int, int, int);
659 struct usb_string_descriptor *usbd_get_string (u8);
660 struct usb_device_descriptor *usbd_device_device_descriptor (struct usb_device_instance *, int);
662 int usbd_endpoint_halted (struct usb_device_instance *device, int endpoint);
663 void usbd_rcv_complete(struct usb_endpoint_instance *endpoint, int len, int urb_bad);
664 void usbd_tx_complete (struct usb_endpoint_instance *endpoint);