include/usbdevice.h

   1 /*
   2  * (C) Copyright 2003
   3  * Gerry Hamel, geh@ti.com, Texas Instruments
   4  *
   5  * Based on linux/drivers/usbd/usbd.h
   6  *
   7  * Copyright (c) 2000, 2001, 2002 Lineo
   8  * Copyright (c) 2001 Hewlett Packard
   9  *
  10  * By:
  11  *      Stuart Lynne <sl@lineo.com>,
  12  *      Tom Rushworth <tbr@lineo.com>,
  13  *      Bruce Balden <balden@lineo.com>
  14  *
  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.
  19  *
  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.
  24  *
  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.
  28  *
  29  */
  30
  31 #ifndef __USBDCORE_H__
  32 #define __USBDCORE_H__
  33
  34 #include <common.h>
  35 #include "usbdescriptors.h"
  36
  37
  38 #define MAX_URBS_QUEUED 5
  39
  40
  41 #if 1
  42 #define usberr(fmt,args...) serial_printf("ERROR: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
  43 #else
  44 #define usberr(fmt,args...) do{}while(0)
  45 #endif
  46
  47 #if 0
  48 #define usbdbg(fmt,args...) serial_printf("debug: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
  49 #else
  50 #define usbdbg(fmt,args...) do{}while(0)
  51 #endif
  52
  53 #if 0
  54 #define usbinfo(fmt,args...) serial_printf("info: %s(), %d: "fmt"\n",__FUNCTION__,__LINE__,##args)
  55 #else
  56 #define usbinfo(fmt,args...) do{}while(0)
  57 #endif
  58
  59 #ifndef le16_to_cpu
  60 #define le16_to_cpu(x)  (x)
  61 #endif
  62
  63 #ifndef inb
  64 #define inb(p)       (*(volatile u8*)(p))
  65 #endif
  66
  67 #ifndef outb
  68 #define outb(val,p)  (*(volatile u8*)(p) = (val))
  69 #endif
  70
  71 #ifndef inw
  72 #define inw(p)       (*(volatile u16*)(p))
  73 #endif
  74
  75 #ifndef outw
  76 #define outw(val,p)  (*(volatile u16*)(p) = (val))
  77 #endif
  78
  79 #ifndef inl
  80 #define inl(p)       (*(volatile u32*)(p))
  81 #endif
  82
  83 #ifndef outl
  84 #define outl(val,p)  (*(volatile u32*)(p) = (val))
  85 #endif
  86
  87 #ifndef insw
  88 #define insw(p,to,len)     mmio_insw(p,to,len)
  89 #endif
  90
  91 #ifndef outsw
  92 #define outsw(p,from,len)  mmio_outsw(p,from,len)
  93 #endif
  94
  95 #ifndef insb
  96 #define insb(p,to,len)     mmio_insb(p,to,len)
  97 #endif
  98
  99 #ifndef mmio_insw
 100 #define mmio_insw(r,b,l)        ({      int __i ;  \
 101                                         u16 *__b2;  \
 102                                         __b2 = (u16 *) b;  \
 103                                         for (__i = 0; __i < l; __i++) {  \
 104                                           *(__b2 + __i) = inw(r);  \
 105                                         };  \
 106                                 })
 107 #endif
 108
 109 #ifndef mmio_outsw
 110 #define mmio_outsw(r,b,l)       ({      int __i; \
 111                                         u16 *__b2; \
 112                                         __b2 = (u16 *) b; \
 113                                         for (__i = 0; __i < l; __i++) { \
 114                                             outw( *(__b2 + __i), r); \
 115                                         } \
 116                                 })
 117 #endif
 118
 119 #ifndef mmio_insb
 120 #define mmio_insb(r,b,l)        ({      int __i ;  \
 121                                         u8 *__b2;  \
 122                                         __b2 = (u8 *) b;  \
 123                                         for (__i = 0; __i < l; __i++) {  \
 124                                           *(__b2 + __i) = inb(r);  \
 125                                         };  \
 126                                 })
 127 #endif
 128
 129 /*
 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.
 133  *
 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.
 136  *
 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:
 140  *
 141  *      struct foo {
 142  *          int x;
 143  *          float y;
 144  *          char z;
 145  *      } thingy;
 146  *
 147  *      char *cp = &thingy.z;
 148  *
 149  * then
 150  *
 151  *      &thingy == p2surround(struct foo, z, cp)
 152  *
 153  * Clear?
 154  */
 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)))
 158
 159 struct urb;
 160
 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;
 166
 167 /*
 168  * Device and/or Interface Class codes
 169  */
 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
 181
 182 /*
 183  * USB types
 184  */
 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)
 189
 190 /*
 191  * USB recipients
 192  */
 193 #define USB_RECIP_DEVICE                0x00
 194 #define USB_RECIP_INTERFACE             0x01
 195 #define USB_RECIP_ENDPOINT              0x02
 196 #define USB_RECIP_OTHER                 0x03
 197
 198 /*
 199  * USB directions
 200  */
 201 #define USB_DIR_OUT                     0
 202 #define USB_DIR_IN                      0x80
 203
 204 /*
 205  * Descriptor types
 206  */
 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
 212
 213 #if defined(CONFIG_USBD_HS)
 214 #define USB_DT_QUAL                     0x06
 215 #endif
 216
 217 #define USB_DT_HID                      (USB_TYPE_CLASS | 0x01)
 218 #define USB_DT_REPORT                   (USB_TYPE_CLASS | 0x02)
 219 #define USB_DT_PHYSICAL                 (USB_TYPE_CLASS | 0x03)
 220 #define USB_DT_HUB                      (USB_TYPE_CLASS | 0x09)
 221
 222 /*
 223  * Descriptor sizes per descriptor type
 224  */
 225 #define USB_DT_DEVICE_SIZE              18
 226 #define USB_DT_CONFIG_SIZE              9
 227 #define USB_DT_INTERFACE_SIZE           9
 228 #define USB_DT_ENDPOINT_SIZE            7
 229 #define USB_DT_ENDPOINT_AUDIO_SIZE      9       /* Audio extension */
 230 #define USB_DT_HUB_NONVAR_SIZE          7
 231 #define USB_DT_HID_SIZE                 9
 232
 233 /*
 234  * Endpoints
 235  */
 236 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
 237 #define USB_ENDPOINT_DIR_MASK           0x80
 238
 239 #define USB_ENDPOINT_XFERTYPE_MASK      0x03    /* in bmAttributes */
 240 #define USB_ENDPOINT_XFER_CONTROL       0
 241 #define USB_ENDPOINT_XFER_ISOC          1
 242 #define USB_ENDPOINT_XFER_BULK          2
 243 #define USB_ENDPOINT_XFER_INT           3
 244
 245 /*
 246  * USB Packet IDs (PIDs)
 247  */
 248 #define USB_PID_UNDEF_0                        0xf0
 249 #define USB_PID_OUT                            0xe1
 250 #define USB_PID_ACK                            0xd2
 251 #define USB_PID_DATA0                          0xc3
 252 #define USB_PID_PING                           0xb4     /* USB 2.0 */
 253 #define USB_PID_SOF                            0xa5
 254 #define USB_PID_NYET                           0x96     /* USB 2.0 */
 255 #define USB_PID_DATA2                          0x87     /* USB 2.0 */
 256 #define USB_PID_SPLIT                          0x78     /* USB 2.0 */
 257 #define USB_PID_IN                             0x69
 258 #define USB_PID_NAK                            0x5a
 259 #define USB_PID_DATA1                          0x4b
 260 #define USB_PID_PREAMBLE                       0x3c     /* Token mode */
 261 #define USB_PID_ERR                            0x3c     /* USB 2.0: handshake mode */
 262 #define USB_PID_SETUP                          0x2d
 263 #define USB_PID_STALL                          0x1e
 264 #define USB_PID_MDATA                          0x0f     /* USB 2.0 */
 265
 266 /*
 267  * Standard requests
 268  */
 269 #define USB_REQ_GET_STATUS              0x00
 270 #define USB_REQ_CLEAR_FEATURE           0x01
 271 #define USB_REQ_SET_FEATURE             0x03
 272 #define USB_REQ_SET_ADDRESS             0x05
 273 #define USB_REQ_GET_DESCRIPTOR          0x06
 274 #define USB_REQ_SET_DESCRIPTOR          0x07
 275 #define USB_REQ_GET_CONFIGURATION       0x08
 276 #define USB_REQ_SET_CONFIGURATION       0x09
 277 #define USB_REQ_GET_INTERFACE           0x0A
 278 #define USB_REQ_SET_INTERFACE           0x0B
 279 #define USB_REQ_SYNCH_FRAME             0x0C
 280
 281 #define USBD_DEVICE_REQUESTS(x) (((unsigned int)x <= USB_REQ_SYNCH_FRAME) ? usbd_device_requests[x] : "UNKNOWN")
 282
 283 /*
 284  * HID requests
 285  */
 286 #define USB_REQ_GET_REPORT              0x01
 287 #define USB_REQ_GET_IDLE                0x02
 288 #define USB_REQ_GET_PROTOCOL            0x03
 289 #define USB_REQ_SET_REPORT              0x09
 290 #define USB_REQ_SET_IDLE                0x0A
 291 #define USB_REQ_SET_PROTOCOL            0x0B
 292
 293
 294 /*
 295  * USB Spec Release number
 296  */
 297
 298 #if defined(CONFIG_USBD_HS)
 299 #define USB_BCD_VERSION                 0x0200
 300 #else
 301 #define USB_BCD_VERSION                 0x0110
 302 #endif
 303
 304
 305 /*
 306  * Device Requests      (c.f Table 9-2)
 307  */
 308
 309 #define USB_REQ_DIRECTION_MASK          0x80
 310 #define USB_REQ_TYPE_MASK               0x60
 311 #define USB_REQ_RECIPIENT_MASK          0x1f
 312
 313 #define USB_REQ_DEVICE2HOST             0x80
 314 #define USB_REQ_HOST2DEVICE             0x00
 315
 316 #define USB_REQ_TYPE_STANDARD           0x00
 317 #define USB_REQ_TYPE_CLASS              0x20
 318 #define USB_REQ_TYPE_VENDOR             0x40
 319
 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
 324
 325 /*
 326  * get status bits
 327  */
 328
 329 #define USB_STATUS_SELFPOWERED          0x01
 330 #define USB_STATUS_REMOTEWAKEUP         0x02
 331
 332 #define USB_STATUS_HALT                 0x01
 333
 334 /*
 335  * descriptor types
 336  */
 337
 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
 348
 349 #define USBD_DEVICE_DESCRIPTORS(x) (((unsigned int)x <= USB_DESCRIPTOR_TYPE_INTERFACE_POWER) ? \
 350                 usbd_device_descriptors[x] : "UNKNOWN")
 351
 352 /*
 353  * standard feature selectors
 354  */
 355 #define USB_ENDPOINT_HALT               0x00
 356 #define USB_DEVICE_REMOTE_WAKEUP        0x01
 357 #define USB_TEST_MODE                   0x02
 358
 359
 360 /* USB Requests
 361  *
 362  */
 363
 364 struct usb_device_request {
 365         u8 bmRequestType;
 366         u8 bRequest;
 367         u16 wValue;
 368         u16 wIndex;
 369         u16 wLength;
 370 } __attribute__ ((packed));
 371
 372
 373 /* USB Status
 374  *
 375  */
 376 typedef enum urb_send_status {
 377         SEND_IN_PROGRESS,
 378         SEND_FINISHED_OK,
 379         SEND_FINISHED_ERROR,
 380         RECV_READY,
 381         RECV_OK,
 382         RECV_ERROR
 383 } urb_send_status_t;
 384
 385 /*
 386  * Device State (c.f USB Spec 2.0 Figure 9-1)
 387  *
 388  * What state the usb device is in.
 389  *
 390  * Note the state does not change if the device is suspended, we simply set a
 391  * flag to show that it is suspended.
 392  *
 393  */
 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;
 404
 405 #define USBD_DEVICE_STATE(x) (((unsigned int)x <= STATE_UNKNOWN) ? usbd_device_states[x] : "UNKNOWN")
 406
 407 /*
 408  * Device status
 409  *
 410  * Overall state
 411  */
 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;
 418
 419 #define USBD_DEVICE_STATUS(x) (((unsigned int)x <= USBD_CLOSING) ? usbd_device_status[x] : "UNKNOWN")
 420
 421 /*
 422  * Device Events
 423  *
 424  * These are defined in the USB Spec (c.f USB Spec 2.0 Figure 9-1).
 425  *
 426  * There are additional events defined to handle some extra actions we need
 427  * to have handled.
 428  *
 429  */
 430 typedef enum usb_device_event {
 431
 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 */
 437
 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 */
 441
 442         DEVICE_SET_FEATURE,     /* ep0 - set feature setup received */
 443         DEVICE_CLEAR_FEATURE,   /* ep0 - clear feature setup received */
 444
 445         DEVICE_DE_CONFIGURED,   /* ep0 - set configure setup received for ?? */
 446
 447         DEVICE_BUS_INACTIVE,    /* bi  - bus in inactive (no SOF packets) */
 448         DEVICE_BUS_ACTIVITY,    /* bi  - bus is active again */
 449
 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 */
 453
 454         DEVICE_HOTPLUG,         /* bi  - a hotplug event has occured */
 455
 456         DEVICE_FUNCTION_PRIVATE,        /* function - private */
 457
 458 } usb_device_event_t;
 459
 460
 461 typedef struct urb_link {
 462         struct urb_link *next;
 463         struct urb_link *prev;
 464 } urb_link;
 465
 466 /* USB Data structure - for passing data around.
 467  *
 468  * This is used for both sending and receiving data.
 469  *
 470  * The callback function is used to let the function driver know when
 471  * transmitted data has been sent.
 472  *
 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.
 476  */
 477
 478 #define URB_BUF_SIZE 128 /* in linux we'd malloc this, but in u-boot we prefer static data */
 479 struct urb {
 480
 481         struct usb_endpoint_instance *endpoint;
 482         struct usb_device_instance *device;
 483
 484         struct usb_device_request device_request;       /* contents of received SETUP packet */
 485
 486         struct urb_link link;   /* embedded struct for circular doubly linked list of urbs */
 487
 488         u8* buffer;
 489         unsigned int buffer_length;
 490         unsigned int actual_length;
 491
 492         urb_send_status_t status;
 493         int data;
 494
 495         u16 buffer_data[URB_BUF_SIZE];  /* data received (OUT) or being sent (IN) */
 496 };
 497
 498 /* Endpoint configuration
 499  *
 500  * Per endpoint configuration data. Used to track which function driver owns
 501  * an endpoint.
 502  *
 503  */
 504 struct usb_endpoint_instance {
 505         int endpoint_address;   /* logical endpoint address */
 506
 507         /* control */
 508         int status;             /* halted */
 509         int state;              /* available for use by bus interface driver */
 510
 511         /* receive side */
 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 */
 518         int rcv_queue;
 519
 520         /* transmit side */
 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 */
 527         int tx_queue;
 528
 529         int sent;               /* data already sent */
 530         int last;               /* data sent in last packet XXX do we need this */
 531 };
 532
 533 struct usb_alternate_instance {
 534         struct usb_interface_descriptor *interface_descriptor;
 535
 536         int endpoints;
 537         int *endpoint_transfersize_array;
 538         struct usb_endpoint_descriptor **endpoints_descriptor_array;
 539 };
 540
 541 struct usb_interface_instance {
 542         int alternates;
 543         struct usb_alternate_instance *alternates_instance_array;
 544 };
 545
 546 struct usb_configuration_instance {
 547         int interfaces;
 548         struct usb_configuration_descriptor *configuration_descriptor;
 549         struct usb_interface_instance *interface_instance_array;
 550 };
 551
 552
 553 /* USB Device Instance
 554  *
 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.
 557  *
 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.
 561  *
 562  * This will show:
 563  *      the specific bus interface driver
 564  *      the default endpoint 0 driver
 565  *      the configured function driver
 566  *      device state
 567  *      device status
 568  *      endpoint list
 569  */
 570
 571 struct usb_device_instance {
 572
 573         /* generic */
 574         char *name;
 575         struct usb_device_descriptor *device_descriptor;        /* per device descriptor */
 576 #if defined(CONFIG_USBD_HS)
 577         struct usb_qualifier_descriptor *qualifier_descriptor;
 578 #endif
 579
 580         void (*event) (struct usb_device_instance *device, usb_device_event_t event, int data);
 581
 582         /* Do cdc device specific control requests */
 583         int (*cdc_recv_setup)(struct usb_device_request *request, struct urb *urb);
 584
 585         /* bus interface */
 586         struct usb_bus_instance *bus;   /* which bus interface driver */
 587
 588         /* configuration descriptors */
 589         int configurations;
 590         struct usb_configuration_instance *configuration_instance_array;
 591
 592         /* device state */
 593         usb_device_state_t device_state;        /* current USB Device state */
 594         usb_device_state_t device_previous_state;       /* current USB Device state */
 595
 596         u8 address;             /* current address (zero is default) */
 597         u8 configuration;       /* current show configuration (zero is default) */
 598         u8 interface;           /* current interface (zero is default) */
 599         u8 alternate;           /* alternate flag */
 600
 601         usb_device_status_t status;     /* device status */
 602
 603         int urbs_queued;        /* number of submitted urbs */
 604
 605         /* Shouldn't need to make this atomic, all we need is a change indicator */
 606         unsigned long usbd_rxtx_timestamp;
 607         unsigned long usbd_last_rxtx_timestamp;
 608
 609 };
 610
 611 /* Bus Interface configuration structure
 612  *
 613  * This is allocated for each configured instance of a bus interface driver.
 614  *
 615  * The privdata pointer may be used by the bus interface driver to store private
 616  * per instance state information.
 617  */
 618 struct usb_bus_instance {
 619
 620         struct usb_device_instance *device;
 621         struct usb_endpoint_instance *endpoint_array;   /* array of available configured endpoints */
 622
 623         int max_endpoints;      /* maximimum number of rx enpoints */
 624         unsigned char                   maxpacketsize;
 625
 626         unsigned int serial_number;
 627         char *serial_number_str;
 628         void *privdata;         /* private data for the bus interface */
 629
 630 };
 631
 632 extern char *usbd_device_events[];
 633 extern char *usbd_device_states[];
 634 extern char *usbd_device_status[];
 635 extern char *usbd_device_requests[];
 636 extern char *usbd_device_descriptors[];
 637
 638 void urb_link_init (urb_link * ul);
 639 void urb_detach (struct urb *urb);
 640 urb_link *first_urb_link (urb_link * hd);
 641 struct urb *first_urb (urb_link * hd);
 642 struct urb *first_urb_detached (urb_link * hd);
 643 void urb_append (urb_link * hd, struct urb *urb);
 644
 645 struct urb *usbd_alloc_urb (struct usb_device_instance *device, struct usb_endpoint_instance *endpoint);
 646 void        usbd_dealloc_urb (struct urb *urb);
 647
 648 /*
 649  * usbd_device_event is used by bus interface drivers to tell the higher layers that
 650  * certain events have taken place.
 651  */
 652 void usbd_device_event_irq (struct usb_device_instance *conf, usb_device_event_t, int);
 653 void usbd_device_event (struct usb_device_instance *conf, usb_device_event_t, int);
 654
 655 /* descriptors
 656  *
 657  * Various ways of finding descriptors based on the current device and any
 658  * possible configuration / interface / endpoint for it.
 659  */
 660 struct usb_configuration_descriptor *usbd_device_configuration_descriptor (struct usb_device_instance *, int, int);
 661 struct usb_function_instance *usbd_device_function_instance (struct usb_device_instance *, unsigned int);
 662 struct usb_interface_instance *usbd_device_interface_instance (struct usb_device_instance *, int, int, int);
 663 struct usb_alternate_instance *usbd_device_alternate_instance (struct usb_device_instance *, int, int, int, int);
 664 struct usb_interface_descriptor *usbd_device_interface_descriptor (struct usb_device_instance *, int, int, int, int);
 665 struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
 666 struct usb_class_descriptor *usbd_device_class_descriptor_index (struct usb_device_instance *, int, int, int, int, int);
 667 struct usb_class_report_descriptor *usbd_device_class_report_descriptor_index( struct usb_device_instance *, int , int , int , int , int );
 668 struct usb_endpoint_descriptor *usbd_device_endpoint_descriptor (struct usb_device_instance *, int, int, int, int, int);
 669 int                             usbd_device_endpoint_transfersize (struct usb_device_instance *, int, int, int, int, int);
 670 struct usb_string_descriptor *usbd_get_string (u8);
 671 struct usb_device_descriptor *usbd_device_device_descriptor(struct
 672                 usb_device_instance *, int);
 673
 674 #if defined(CONFIG_USBD_HS)
 675 /*
 676  * is_usbd_high_speed routine needs to be defined by specific gadget driver
 677  * It returns TRUE if device enumerates at High speed
 678  * Retuns FALSE otherwise
 679  */
 680 int is_usbd_high_speed(void);
 681 #endif
 682 int usbd_endpoint_halted (struct usb_device_instance *device, int endpoint);
 683 void usbd_rcv_complete(struct usb_endpoint_instance *endpoint, int len, int urb_bad);
 684 void usbd_tx_complete (struct usb_endpoint_instance *endpoint);
 685
 686 /* These are macros used in debugging */
 687 #ifdef DEBUG
 688 static inline void print_urb(struct urb *u)
 689 {
 690         serial_printf("urb %p\n", (u));
 691         serial_printf("\tendpoint %p\n", u->endpoint);
 692         serial_printf("\tdevice %p\n", u->device);
 693         serial_printf("\tbuffer %p\n", u->buffer);
 694         serial_printf("\tbuffer_length %d\n", u->buffer_length);
 695         serial_printf("\tactual_length %d\n", u->actual_length);
 696         serial_printf("\tstatus %d\n", u->status);
 697         serial_printf("\tdata %d\n", u->data);
 698 }
 699
 700 static inline void print_usb_device_request(struct usb_device_request *r)
 701 {
 702         serial_printf("usb request\n");
 703         serial_printf("\tbmRequestType 0x%2.2x\n", r->bmRequestType);
 704         if ((r->bmRequestType & USB_REQ_DIRECTION_MASK) == 0)
 705                 serial_printf("\t\tDirection : To device\n");
 706         else
 707                 serial_printf("\t\tDirection : To host\n");
 708         if ((r->bmRequestType & USB_TYPE_STANDARD) == USB_TYPE_STANDARD)
 709                 serial_printf("\t\tType      : Standard\n");
 710         if ((r->bmRequestType & USB_TYPE_CLASS) == USB_TYPE_CLASS)
 711                 serial_printf("\t\tType      : Standard\n");
 712         if ((r->bmRequestType & USB_TYPE_VENDOR) == USB_TYPE_VENDOR)
 713                 serial_printf("\t\tType      : Standard\n");
 714         if ((r->bmRequestType & USB_TYPE_RESERVED) == USB_TYPE_RESERVED)
 715                 serial_printf("\t\tType      : Standard\n");
 716         if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
 717             USB_REQ_RECIPIENT_DEVICE)
 718                 serial_printf("\t\tRecipient : Device\n");
 719         if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
 720             USB_REQ_RECIPIENT_INTERFACE)
 721                 serial_printf("\t\tRecipient : Interface\n");
 722         if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
 723             USB_REQ_RECIPIENT_ENDPOINT)
 724                 serial_printf("\t\tRecipient : Endpoint\n");
 725         if ((r->bmRequestType & USB_REQ_RECIPIENT_MASK) ==
 726             USB_REQ_RECIPIENT_OTHER)
 727                 serial_printf("\t\tRecipient : Other\n");
 728         serial_printf("\tbRequest      0x%2.2x\n", r->bRequest);
 729         if (r->bRequest == USB_REQ_GET_STATUS)
 730                 serial_printf("\t\tGET_STATUS\n");
 731         else if (r->bRequest == USB_REQ_SET_ADDRESS)
 732                 serial_printf("\t\tSET_ADDRESS\n");
 733         else if (r->bRequest == USB_REQ_SET_FEATURE)
 734                 serial_printf("\t\tSET_FEATURE\n");
 735         else if (r->bRequest == USB_REQ_GET_DESCRIPTOR)
 736                 serial_printf("\t\tGET_DESCRIPTOR\n");
 737         else if (r->bRequest == USB_REQ_SET_CONFIGURATION)
 738                 serial_printf("\t\tSET_CONFIGURATION\n");
 739         else if (r->bRequest == USB_REQ_SET_INTERFACE)
 740                 serial_printf("\t\tUSB_REQ_SET_INTERFACE\n");
 741         else
 742                 serial_printf("\tUNKNOWN %d\n", r->bRequest);
 743         serial_printf("\twValue        0x%4.4x\n", r->wValue);
 744         if (r->bRequest == USB_REQ_GET_DESCRIPTOR) {
 745                 switch (r->wValue >> 8) {
 746                 case USB_DESCRIPTOR_TYPE_DEVICE:
 747                         serial_printf("\tDEVICE\n");
 748                         break;
 749                 case USB_DESCRIPTOR_TYPE_CONFIGURATION:
 750                         serial_printf("\tCONFIGURATION\n");
 751                         break;
 752                 case USB_DESCRIPTOR_TYPE_STRING:
 753                         serial_printf("\tSTRING\n");
 754                         break;
 755                 case USB_DESCRIPTOR_TYPE_INTERFACE:
 756                         serial_printf("\tINTERFACE\n");
 757                         break;
 758                 case USB_DESCRIPTOR_TYPE_ENDPOINT:
 759                         serial_printf("\tENDPOINT\n");
 760                         break;
 761                 case USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER:
 762                         serial_printf("\tDEVICE_QUALIFIER\n");
 763                         break;
 764                 case USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION:
 765                         serial_printf("\tOTHER_SPEED_CONFIGURATION\n");
 766                         break;
 767                 case USB_DESCRIPTOR_TYPE_INTERFACE_POWER:
 768                         serial_printf("\tINTERFACE_POWER\n");
 769                         break;
 770                 case USB_DESCRIPTOR_TYPE_HID:
 771                         serial_printf("\tHID\n");
 772                         break;
 773                 case USB_DESCRIPTOR_TYPE_REPORT:
 774                         serial_printf("\tREPORT\n");
 775                         break;
 776                 default:
 777                         serial_printf("\tUNKNOWN TYPE\n");
 778                         break;
 779                 }
 780         }
 781         serial_printf("\twIndex        0x%4.4x\n", r->wIndex);
 782         serial_printf("\twLength       0x%4.4x\n", r->wLength);
 783 }
 784 #else
 785 /* stubs */
 786 #define print_urb(u)
 787 #define print_usb_device_request(r)
 788 #endif /* DEBUG */
 789 #endif