include/linux/usb.h

   1 #ifndef __LINUX_USB_H
   2 #define __LINUX_USB_H
   3
   4 /* USB constants */
   5
   6 /*
   7  * Device and/or Interface Class codes
   8  */
   9 #define USB_CLASS_PER_INTERFACE         0       /* for DeviceClass */
  10 #define USB_CLASS_AUDIO                 1
  11 #define USB_CLASS_COMM                  2
  12 #define USB_CLASS_HID                   3
  13 #define USB_CLASS_PHYSICAL              5
  14 #define USB_CLASS_PRINTER               7
  15 #define USB_CLASS_MASS_STORAGE          8
  16 #define USB_CLASS_HUB                   9
  17 #define USB_CLASS_DATA                  10
  18 #define USB_CLASS_APP_SPEC              0xfe
  19 #define USB_CLASS_VENDOR_SPEC           0xff
  20
  21 /*
  22  * USB types
  23  */
  24 #define USB_TYPE_STANDARD               (0x00 << 5)
  25 #define USB_TYPE_CLASS                  (0x01 << 5)
  26 #define USB_TYPE_VENDOR                 (0x02 << 5)
  27 #define USB_TYPE_RESERVED               (0x03 << 5)
  28
  29 /*
  30  * USB recipients
  31  */
  32 #define USB_RECIP_DEVICE                0x00
  33 #define USB_RECIP_INTERFACE             0x01
  34 #define USB_RECIP_ENDPOINT              0x02
  35 #define USB_RECIP_OTHER                 0x03
  36
  37 /*
  38  * USB directions
  39  */
  40 #define USB_DIR_OUT                     0
  41 #define USB_DIR_IN                      0x80
  42
  43 /*
  44  * Descriptor types
  45  */
  46 #define USB_DT_DEVICE                   0x01
  47 #define USB_DT_CONFIG                   0x02
  48 #define USB_DT_STRING                   0x03
  49 #define USB_DT_INTERFACE                0x04
  50 #define USB_DT_ENDPOINT                 0x05
  51
  52 #define USB_DT_HID                      (USB_TYPE_CLASS | 0x01)
  53 #define USB_DT_REPORT                   (USB_TYPE_CLASS | 0x02)
  54 #define USB_DT_PHYSICAL                 (USB_TYPE_CLASS | 0x03)
  55 #define USB_DT_HUB                      (USB_TYPE_CLASS | 0x09)
  56
  57 /*
  58  * Descriptor sizes per descriptor type
  59  */
  60 #define USB_DT_DEVICE_SIZE              18
  61 #define USB_DT_CONFIG_SIZE              9
  62 #define USB_DT_INTERFACE_SIZE           9
  63 #define USB_DT_ENDPOINT_SIZE            7
  64 #define USB_DT_ENDPOINT_AUDIO_SIZE      9       /* Audio extension */
  65 #define USB_DT_HUB_NONVAR_SIZE          7
  66 #define USB_DT_HID_SIZE                 9
  67
  68 /*
  69  * Endpoints
  70  */
  71 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
  72 #define USB_ENDPOINT_DIR_MASK           0x80
  73
  74 #define USB_ENDPOINT_XFERTYPE_MASK      0x03    /* in bmAttributes */
  75 #define USB_ENDPOINT_XFER_CONTROL       0
  76 #define USB_ENDPOINT_XFER_ISOC          1
  77 #define USB_ENDPOINT_XFER_BULK          2
  78 #define USB_ENDPOINT_XFER_INT           3
  79
  80 /*
  81  * USB Packet IDs (PIDs)
  82  */
  83 #define USB_PID_UNDEF_0                        0xf0
  84 #define USB_PID_OUT                            0xe1
  85 #define USB_PID_ACK                            0xd2
  86 #define USB_PID_DATA0                          0xc3
  87 #define USB_PID_PING                           0xb4     /* USB 2.0 */
  88 #define USB_PID_SOF                            0xa5
  89 #define USB_PID_NYET                           0x96     /* USB 2.0 */
  90 #define USB_PID_DATA2                          0x87     /* USB 2.0 */
  91 #define USB_PID_SPLIT                          0x78     /* USB 2.0 */
  92 #define USB_PID_IN                             0x69
  93 #define USB_PID_NAK                            0x5a
  94 #define USB_PID_DATA1                          0x4b
  95 #define USB_PID_PREAMBLE                       0x3c     /* Token mode */
  96 #define USB_PID_ERR                            0x3c     /* USB 2.0: handshake mode */
  97 #define USB_PID_SETUP                          0x2d
  98 #define USB_PID_STALL                          0x1e
  99 #define USB_PID_MDATA                          0x0f     /* USB 2.0 */
 100
 101 /*
 102  * Standard requests
 103  */
 104 #define USB_REQ_GET_STATUS              0x00
 105 #define USB_REQ_CLEAR_FEATURE           0x01
 106 #define USB_REQ_SET_FEATURE             0x03
 107 #define USB_REQ_SET_ADDRESS             0x05
 108 #define USB_REQ_GET_DESCRIPTOR          0x06
 109 #define USB_REQ_SET_DESCRIPTOR          0x07
 110 #define USB_REQ_GET_CONFIGURATION       0x08
 111 #define USB_REQ_SET_CONFIGURATION       0x09
 112 #define USB_REQ_GET_INTERFACE           0x0A
 113 #define USB_REQ_SET_INTERFACE           0x0B
 114 #define USB_REQ_SYNCH_FRAME             0x0C
 115
 116 /*
 117  * HID requests
 118  */
 119 #define USB_REQ_GET_REPORT              0x01
 120 #define USB_REQ_GET_IDLE                0x02
 121 #define USB_REQ_GET_PROTOCOL            0x03
 122 #define USB_REQ_SET_REPORT              0x09
 123 #define USB_REQ_SET_IDLE                0x0A
 124 #define USB_REQ_SET_PROTOCOL            0x0B
 125
 126
 127 #ifdef __KERNEL__
 128
 129 #include <linux/types.h>
 130 #include <linux/ioctl.h>
 131 #include <linux/version.h>
 132 #include <linux/sched.h>
 133 #include <linux/delay.h>
 134 #include <linux/interrupt.h>    /* for in_interrupt() */
 135 #include <linux/config.h>
 136 #include <linux/list.h>
 137
 138 #define USB_MAJOR 180
 139
 140 static __inline__ void wait_ms(unsigned int ms)
 141 {
 142         if(!in_interrupt()) {
 143                 current->state = TASK_UNINTERRUPTIBLE;
 144                 schedule_timeout(1 + ms * HZ / 1000);
 145         }
 146         else
 147                 mdelay(ms);
 148 }
 149
 150 typedef struct {
 151         __u8 requesttype;
 152         __u8 request;
 153         __u16 value;
 154         __u16 index;
 155         __u16 length;
 156 } devrequest __attribute__ ((packed));
 157
 158 /*
 159  * USB-status codes:
 160  * USB_ST* maps to -E* and should go away in the future
 161  */
 162
 163 #define USB_ST_NOERROR          0
 164 #define USB_ST_CRC              (-EILSEQ)
 165 #define USB_ST_BITSTUFF         (-EPROTO)
 166 #define USB_ST_NORESPONSE       (-ETIMEDOUT)                    /* device not responding/handshaking */
 167 #define USB_ST_DATAOVERRUN      (-EOVERFLOW)
 168 #define USB_ST_DATAUNDERRUN     (-EREMOTEIO)
 169 #define USB_ST_BUFFEROVERRUN    (-ECOMM)
 170 #define USB_ST_BUFFERUNDERRUN   (-ENOSR)
 171 #define USB_ST_INTERNALERROR    (-EPROTO)                       /* unknown error */
 172 #define USB_ST_SHORT_PACKET     (-EREMOTEIO)
 173 #define USB_ST_PARTIAL_ERROR    (-EXDEV)                        /* ISO transfer only partially completed */
 174 #define USB_ST_URB_KILLED       (-ENOENT)                       /* URB canceled by user */
 175 #define USB_ST_URB_PENDING       (-EINPROGRESS)
 176 #define USB_ST_REMOVED          (-ENODEV)                       /* device not existing or removed */
 177 #define USB_ST_TIMEOUT          (-ETIMEDOUT)                    /* communication timed out, also in urb->status**/
 178 #define USB_ST_NOTSUPPORTED     (-ENOSYS)
 179 #define USB_ST_BANDWIDTH_ERROR  (-ENOSPC)                       /* too much bandwidth used */
 180 #define USB_ST_URB_INVALID_ERROR  (-EINVAL)                     /* invalid value/transfer type */
 181 #define USB_ST_URB_REQUEST_ERROR  (-ENXIO)                      /* invalid endpoint */
 182 #define USB_ST_STALL            (-EPIPE)                        /* pipe stalled, also in urb->status*/
 183
 184 /*
 185  * USB device number allocation bitmap. There's one bitmap
 186  * per USB tree.
 187  */
 188 struct usb_devmap {
 189         unsigned long devicemap[128 / (8*sizeof(unsigned long))];
 190 };
 191
 192 #define USB_MAXBUS              64
 193
 194 struct usb_busmap {
 195         unsigned long busmap[USB_MAXBUS / (8*sizeof(unsigned long))];
 196 };
 197
 198 /*
 199  * This is a USB device descriptor.
 200  *
 201  * USB device information
 202  */
 203
 204 /* Everything but the endpoint maximums are aribtrary */
 205 #define USB_MAXCONFIG           8
 206 #define USB_ALTSETTINGALLOC     4
 207 #define USB_MAXALTSETTING       128  /* Hard limit */
 208 #define USB_MAXINTERFACES       32
 209 #define USB_MAXENDPOINTS        32
 210
 211 /* All standard descriptors have these 2 fields in common */
 212 struct usb_descriptor_header {
 213         __u8  bLength;
 214         __u8  bDescriptorType;
 215 } __attribute__ ((packed));
 216
 217 /* Device descriptor */
 218 struct usb_device_descriptor {
 219         __u8  bLength;
 220         __u8  bDescriptorType;
 221         __u16 bcdUSB;
 222         __u8  bDeviceClass;
 223         __u8  bDeviceSubClass;
 224         __u8  bDeviceProtocol;
 225         __u8  bMaxPacketSize0;
 226         __u16 idVendor;
 227         __u16 idProduct;
 228         __u16 bcdDevice;
 229         __u8  iManufacturer;
 230         __u8  iProduct;
 231         __u8  iSerialNumber;
 232         __u8  bNumConfigurations;
 233 } __attribute__ ((packed));
 234
 235 /* Endpoint descriptor */
 236 struct usb_endpoint_descriptor {
 237         __u8  bLength;
 238         __u8  bDescriptorType;
 239         __u8  bEndpointAddress;
 240         __u8  bmAttributes;
 241         __u16 wMaxPacketSize;
 242         __u8  bInterval;
 243         __u8  bRefresh;
 244         __u8  bSynchAddress;
 245
 246         unsigned char *extra;   /* Extra descriptors */
 247         int extralen;
 248 } __attribute__ ((packed));
 249
 250 /* Interface descriptor */
 251 struct usb_interface_descriptor {
 252         __u8  bLength;
 253         __u8  bDescriptorType;
 254         __u8  bInterfaceNumber;
 255         __u8  bAlternateSetting;
 256         __u8  bNumEndpoints;
 257         __u8  bInterfaceClass;
 258         __u8  bInterfaceSubClass;
 259         __u8  bInterfaceProtocol;
 260         __u8  iInterface;
 261
 262         struct usb_endpoint_descriptor *endpoint;
 263
 264         unsigned char *extra;
 265         int extralen;
 266 } __attribute__ ((packed));
 267
 268 struct usb_interface {
 269         struct usb_interface_descriptor *altsetting;
 270
 271         int act_altsetting;             /* active alternate setting */
 272         int num_altsetting;             /* number of alternate settings */
 273         int max_altsetting;             /* total memory allocated */
 274
 275         struct usb_driver *driver;      /* driver */
 276         void *private_data;
 277 };
 278
 279 /* Configuration descriptor information.. */
 280 struct usb_config_descriptor {
 281         __u8  bLength;
 282         __u8  bDescriptorType;
 283         __u16 wTotalLength;
 284         __u8  bNumInterfaces;
 285         __u8  bConfigurationValue;
 286         __u8  iConfiguration;
 287         __u8  bmAttributes;
 288         __u8  MaxPower;
 289
 290         struct usb_interface *interface;
 291 } __attribute__ ((packed));
 292
 293 /* String descriptor */
 294 struct usb_string_descriptor {
 295         __u8  bLength;
 296         __u8  bDescriptorType;
 297         __u16 wData[1];
 298 } __attribute__ ((packed));
 299
 300 struct usb_device;
 301
 302 struct usb_driver {
 303         const char *name;
 304
 305         void * (*probe)(struct usb_device *, unsigned int);
 306         void (*disconnect)(struct usb_device *, void *);
 307
 308         struct list_head driver_list;
 309
 310         struct file_operations *fops;
 311         int minor;
 312
 313         struct semaphore serialize;
 314
 315         int (*ioctl)(struct usb_device *dev, unsigned int code, void *buf);
 316 };
 317
 318 /*
 319  * Pointer to a device endpoint interrupt function -greg
 320  *   Parameters:
 321  *     int status - This needs to be defined.  Right now each HCD
 322  *         passes different transfer status bits back.  Don't use it
 323  *         until we come up with a common meaning.
 324  *     void *buffer - This is a pointer to the data used in this
 325  *         USB transfer.
 326  *     int length - This is the number of bytes transferred in or out
 327  *         of the buffer by this transfer.  (-1 = unknown/unsupported)
 328  *     void *dev_id - This is a user defined pointer set when the IRQ
 329  *         is requested that is passed back.
 330  *
 331  *   Special Cases:
 332  *     if (status == USB_ST_REMOVED), don't trust buffer or len.
 333  */
 334 typedef int (*usb_device_irq)(int, void *, int, void *);
 335
 336 /*----------------------------------------------------------------------------*
 337  * New USB Structures                                                         *
 338  *----------------------------------------------------------------------------*/
 339
 340 /*
 341  * urb->transfer_flags:
 342  */
 343 #define USB_DISABLE_SPD         0x0001
 344 #define USB_ISO_ASAP            0x0002
 345 #define USB_URB_EARLY_COMPLETE  0x0004
 346 #define USB_ASYNC_UNLINK        0x0008
 347 #define USB_QUEUE_BULK          0x0010
 348 #define USB_TIMEOUT_KILLED      0x1000  // only set by HCD!
 349
 350 typedef struct
 351 {
 352         unsigned int offset;
 353         unsigned int length;            // expected length
 354         unsigned int actual_length;
 355         unsigned int status;
 356 } iso_packet_descriptor_t, *piso_packet_descriptor_t;
 357
 358 struct urb;
 359 typedef void (*usb_complete_t)(struct urb *);
 360
 361 typedef struct urb
 362 {
 363         spinlock_t lock;                // lock for the URB
 364         void *hcpriv;                   // private data for host controller
 365         struct list_head urb_list;      // list pointer to all active urbs
 366         struct urb *next;               // pointer to next URB
 367         struct usb_device *dev;         // pointer to associated USB device
 368         unsigned int pipe;              // pipe information
 369         int status;                     // returned status
 370         unsigned int transfer_flags;    // USB_DISABLE_SPD | USB_ISO_ASAP | USB_URB_EARLY_COMPLETE
 371         void *transfer_buffer;          // associated data buffer
 372         int transfer_buffer_length;     // data buffer length
 373         int actual_length;              // actual data buffer length
 374         int bandwidth;                  // bandwidth for this transfer request (INT or ISO)
 375         unsigned char *setup_packet;    // setup packet (control only)
 376         //
 377         int start_frame;                // start frame (iso/irq only)
 378         int number_of_packets;          // number of packets in this request (iso)
 379         int interval;                   // polling interval (irq only)
 380         int error_count;                // number of errors in this transfer (iso only)
 381         int timeout;                    // timeout (in jiffies)
 382         //
 383         void *context;                  // context for completion routine
 384         usb_complete_t complete;        // pointer to completion routine
 385         //
 386         iso_packet_descriptor_t  iso_frame_desc[0];
 387 } urb_t, *purb_t;
 388
 389 #define FILL_CONTROL_URB(a,aa,b,c,d,e,f,g) \
 390     do {\
 391         spin_lock_init(&(a)->lock);\
 392         (a)->dev=aa;\
 393         (a)->pipe=b;\
 394         (a)->setup_packet=c;\
 395         (a)->transfer_buffer=d;\
 396         (a)->transfer_buffer_length=e;\
 397         (a)->complete=f;\
 398         (a)->context=g;\
 399     } while (0)
 400
 401 #define FILL_BULK_URB(a,aa,b,c,d,e,f) \
 402     do {\
 403         spin_lock_init(&(a)->lock);\
 404         (a)->dev=aa;\
 405         (a)->pipe=b;\
 406         (a)->transfer_buffer=c;\
 407         (a)->transfer_buffer_length=d;\
 408         (a)->complete=e;\
 409         (a)->context=f;\
 410     } while (0)
 411
 412 #define FILL_INT_URB(a,aa,b,c,d,e,f,g) \
 413     do {\
 414         spin_lock_init(&(a)->lock);\
 415         (a)->dev=aa;\
 416         (a)->pipe=b;\
 417         (a)->transfer_buffer=c;\
 418         (a)->transfer_buffer_length=d;\
 419         (a)->complete=e;\
 420         (a)->context=f;\
 421         (a)->interval=g;\
 422         (a)->start_frame=-1;\
 423     } while (0)
 424
 425 #define FILL_CONTROL_URB_TO(a,aa,b,c,d,e,f,g,h) \
 426     do {\
 427         spin_lock_init(&(a)->lock);\
 428         (a)->dev=aa;\
 429         (a)->pipe=b;\
 430         (a)->setup_packet=c;\
 431         (a)->transfer_buffer=d;\
 432         (a)->transfer_buffer_length=e;\
 433         (a)->complete=f;\
 434         (a)->context=g;\
 435         (a)->timeout=h;\
 436     } while (0)
 437
 438 #define FILL_BULK_URB_TO(a,aa,b,c,d,e,f,g) \
 439     do {\
 440         spin_lock_init(&(a)->lock);\
 441         (a)->dev=aa;\
 442         (a)->pipe=b;\
 443         (a)->transfer_buffer=c;\
 444         (a)->transfer_buffer_length=d;\
 445         (a)->complete=e;\
 446         (a)->context=f;\
 447         (a)->timeout=g;\
 448     } while (0)
 449
 450 purb_t usb_alloc_urb(int iso_packets);
 451 void usb_free_urb (purb_t purb);
 452 int usb_submit_urb(purb_t purb);
 453 int usb_unlink_urb(purb_t purb);
 454 int usb_internal_control_msg(struct usb_device *usb_dev, unsigned int pipe, devrequest *cmd,  void *data, int len, int timeout);
 455 int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout);
 456
 457 /*-------------------------------------------------------------------*
 458  *                         COMPATIBILITY STUFF                       *
 459  *-------------------------------------------------------------------*/
 460 typedef struct
 461 {
 462   wait_queue_head_t *wakeup;
 463
 464   usb_device_irq handler;
 465   void* stuff;
 466   /* more to follow */
 467 } api_wrapper_data;
 468
 469 struct irq_wrapper_data {
 470         void *context;
 471         usb_device_irq handler;
 472 };
 473
 474 /* -------------------------------------------------------------------------- */
 475
 476 struct usb_operations {
 477         int (*allocate)(struct usb_device *);
 478         int (*deallocate)(struct usb_device *);
 479         int (*get_frame_number) (struct usb_device *usb_dev);
 480         int (*submit_urb) (struct urb* purb);
 481         int (*unlink_urb) (struct urb* purb);
 482 };
 483
 484 /*
 485  * Allocated per bus we have
 486  */
 487 struct usb_bus {
 488         int busnum;                     /* Bus number (in order of reg) */
 489
 490         struct usb_devmap devmap;       /* Device map */
 491         struct usb_operations *op;      /* Operations (specific to the HC) */
 492         struct usb_device *root_hub;    /* Root hub */
 493         struct list_head bus_list;
 494         void *hcpriv;                   /* Host Controller private data */
 495
 496         int bandwidth_allocated;        /* on this Host Controller; */
 497                                           /* applies to Int. and Isoc. pipes; */
 498                                           /* measured in microseconds/frame; */
 499                                           /* range is 0..900, where 900 = */
 500                                           /* 90% of a 1-millisecond frame */
 501         int bandwidth_int_reqs;         /* number of Interrupt requesters */
 502         int bandwidth_isoc_reqs;        /* number of Isoc. requesters */
 503
 504         /* usbdevfs inode list */
 505         struct list_head inodes;
 506 };
 507
 508 #define USB_MAXCHILDREN (8)     /* This is arbitrary */
 509
 510 struct usb_device {
 511         int devnum;                     /* Device number on USB bus */
 512         int slow;                       /* Slow device? */
 513
 514         atomic_t refcnt;                /* Reference count */
 515
 516         unsigned int toggle[2];         /* one bit for each endpoint ([0] = IN, [1] = OUT) */
 517         unsigned int halted[2];         /* endpoint halts; one bit per endpoint # & direction; */
 518                                         /* [0] = IN, [1] = OUT */
 519         int epmaxpacketin[16];          /* INput endpoint specific maximums */
 520         int epmaxpacketout[16];         /* OUTput endpoint specific maximums */
 521
 522         struct usb_device *parent;
 523         struct usb_bus *bus;            /* Bus we're part of */
 524
 525         struct usb_device_descriptor descriptor;/* Descriptor */
 526         struct usb_config_descriptor *config;   /* All of the configs */
 527         struct usb_config_descriptor *actconfig;/* the active configuration */
 528
 529         char **rawdescriptors;          /* Raw descriptors for each config */
 530
 531         int have_langid;                /* whether string_langid is valid yet */
 532         int string_langid;              /* language ID for strings */
 533
 534         void *hcpriv;                   /* Host Controller private data */
 535
 536         /* usbdevfs inode list */
 537         struct list_head inodes;
 538         struct list_head filelist;
 539
 540         /*
 541          * Child devices - these can be either new devices
 542          * (if this is a hub device), or different instances
 543          * of this same device.
 544          *
 545          * Each instance needs its own set of data structures.
 546          */
 547
 548         int maxchild;                   /* Number of ports if hub */
 549         struct usb_device *children[USB_MAXCHILDREN];
 550 };
 551
 552 extern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, unsigned ifnum);
 553
 554 extern int usb_register(struct usb_driver *);
 555 extern void usb_deregister(struct usb_driver *);
 556 extern void usb_scan_devices(void);
 557
 558 /* used these for multi-interface device registration */
 559 extern void usb_driver_claim_interface(struct usb_driver *driver, struct usb_interface *iface, void* priv);
 560 extern int usb_interface_claimed(struct usb_interface *iface);
 561 extern void usb_driver_release_interface(struct usb_driver *driver, struct usb_interface *iface);
 562
 563 extern struct usb_bus *usb_alloc_bus(struct usb_operations *);
 564 extern void usb_free_bus(struct usb_bus *);
 565 extern void usb_register_bus(struct usb_bus *);
 566 extern void usb_deregister_bus(struct usb_bus *);
 567
 568 extern struct usb_device *usb_alloc_dev(struct usb_device *parent, struct usb_bus *);
 569 extern void usb_free_dev(struct usb_device *);
 570 extern void usb_inc_dev_use(struct usb_device *);
 571 #define usb_dec_dev_use usb_free_dev
 572
 573 extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
 574 extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb, int bustime, int isoc);
 575 extern void usb_release_bandwidth(struct usb_device *dev, struct urb *urb, int isoc);
 576
 577 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe, __u8 request, __u8 requesttype, __u16 value, __u16 index, void *data, __u16 size, int timeout);
 578
 579 extern int usb_root_hub_string(int id, int serial, char *type, __u8 *data, int len);
 580 extern void usb_connect(struct usb_device *dev);
 581 extern void usb_disconnect(struct usb_device **);
 582
 583 extern void usb_destroy_configuration(struct usb_device *dev);
 584
 585 int usb_get_current_frame_number (struct usb_device *usb_dev);
 586
 587 /*
 588  * Calling this entity a "pipe" is glorifying it. A USB pipe
 589  * is something embarrassingly simple: it basically consists
 590  * of the following information:
 591  *  - device number (7 bits)
 592  *  - endpoint number (4 bits)
 593  *  - current Data0/1 state (1 bit)
 594  *  - direction (1 bit)
 595  *  - speed (1 bit)
 596  *  - max packet size (2 bits: 8, 16, 32 or 64) [Historical; now gone.]
 597  *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
 598  *
 599  * That's 18 bits. Really. Nothing more. And the USB people have
 600  * documented these eighteen bits as some kind of glorious
 601  * virtual data structure.
 602  *
 603  * Let's not fall in that trap. We'll just encode it as a simple
 604  * unsigned int. The encoding is:
 605  *
 606  *  - max size:         bits 0-1        (00 = 8, 01 = 16, 10 = 32, 11 = 64) [Historical; now gone.]
 607  *  - direction:        bit 7           (0 = Host-to-Device [Out], 1 = Device-to-Host [In])
 608  *  - device:           bits 8-14
 609  *  - endpoint:         bits 15-18
 610  *  - Data0/1:          bit 19
 611  *  - speed:            bit 26          (0 = Full, 1 = Low Speed)
 612  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt, 10 = control, 11 = bulk)
 613  *
 614  * Why? Because it's arbitrary, and whatever encoding we select is really
 615  * up to us. This one happens to share a lot of bit positions with the UHCI
 616  * specification, so that much of the uhci driver can just mask the bits
 617  * appropriately.
 618  */
 619
 620 #define PIPE_ISOCHRONOUS                0
 621 #define PIPE_INTERRUPT                  1
 622 #define PIPE_CONTROL                    2
 623 #define PIPE_BULK                       3
 624
 625 #define usb_maxpacket(dev, pipe, out)   (out \
 626                                 ? (dev)->epmaxpacketout[usb_pipeendpoint(pipe)] \
 627                                 : (dev)->epmaxpacketin [usb_pipeendpoint(pipe)] )
 628 #define usb_packetid(pipe)      (((pipe) & USB_DIR_IN) ? USB_PID_IN : USB_PID_OUT)
 629
 630 #define usb_pipeout(pipe)       ((((pipe) >> 7) & 1) ^ 1)
 631 #define usb_pipein(pipe)        (((pipe) >> 7) & 1)
 632 #define usb_pipedevice(pipe)    (((pipe) >> 8) & 0x7f)
 633 #define usb_pipe_endpdev(pipe)  (((pipe) >> 8) & 0x7ff)
 634 #define usb_pipeendpoint(pipe)  (((pipe) >> 15) & 0xf)
 635 #define usb_pipedata(pipe)      (((pipe) >> 19) & 1)
 636 #define usb_pipeslow(pipe)      (((pipe) >> 26) & 1)
 637 #define usb_pipetype(pipe)      (((pipe) >> 30) & 3)
 638 #define usb_pipeisoc(pipe)      (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
 639 #define usb_pipeint(pipe)       (usb_pipetype((pipe)) == PIPE_INTERRUPT)
 640 #define usb_pipecontrol(pipe)   (usb_pipetype((pipe)) == PIPE_CONTROL)
 641 #define usb_pipebulk(pipe)      (usb_pipetype((pipe)) == PIPE_BULK)
 642
 643 #define PIPE_DEVEP_MASK         0x0007ff00
 644
 645 /* The D0/D1 toggle bits */
 646 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
 647 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
 648 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << ep)) | ((bit) << ep))
 649
 650 /* Endpoint halt control/status */
 651 #define usb_endpoint_out(ep_dir)        (((ep_dir >> 7) & 1) ^ 1)
 652 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
 653 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
 654 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
 655
 656 static inline unsigned int __create_pipe(struct usb_device *dev, unsigned int endpoint)
 657 {
 658         return (dev->devnum << 8) | (endpoint << 15) | (dev->slow << 26);
 659 }
 660
 661 static inline unsigned int __default_pipe(struct usb_device *dev)
 662 {
 663         return (dev->slow << 26);
 664 }
 665
 666 /* Create various pipes... */
 667 #define usb_sndctrlpipe(dev,endpoint)   ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
 668 #define usb_rcvctrlpipe(dev,endpoint)   ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
 669 #define usb_sndisocpipe(dev,endpoint)   ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
 670 #define usb_rcvisocpipe(dev,endpoint)   ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
 671 #define usb_sndbulkpipe(dev,endpoint)   ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
 672 #define usb_rcvbulkpipe(dev,endpoint)   ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
 673 #define usb_sndintpipe(dev,endpoint)    ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
 674 #define usb_rcvintpipe(dev,endpoint)    ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
 675 #define usb_snddefctrl(dev)             ((PIPE_CONTROL << 30) | __default_pipe(dev))
 676 #define usb_rcvdefctrl(dev)             ((PIPE_CONTROL << 30) | __default_pipe(dev) | USB_DIR_IN)
 677
 678 /*
 679  * Send and receive control messages..
 680  */
 681 int usb_new_device(struct usb_device *dev);
 682 int usb_reset_device(struct usb_device *dev);
 683 int usb_set_address(struct usb_device *dev);
 684 int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
 685         unsigned char descindex, void *buf, int size);
 686 int usb_get_class_descriptor(struct usb_device *dev, int ifnum, unsigned char desctype,
 687         unsigned char descindex, void *buf, int size);
 688 int usb_get_device_descriptor(struct usb_device *dev);
 689 int __usb_get_extra_descriptor(char *buffer, unsigned size, unsigned char type, void **ptr);
 690 int usb_get_status(struct usb_device *dev, int type, int target, void *data);
 691 int usb_get_configuration(struct usb_device *dev);
 692 int usb_get_protocol(struct usb_device *dev, int ifnum);
 693 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
 694 int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
 695 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id);
 696 int usb_set_configuration(struct usb_device *dev, int configuration);
 697 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
 698         unsigned char id, void *buf, int size);
 699 int usb_set_report(struct usb_device *dev, int ifnum, unsigned char type,
 700         unsigned char id, void *buf, int size);
 701 int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
 702 int usb_clear_halt(struct usb_device *dev, int pipe);
 703 void usb_set_maxpacket(struct usb_device *dev);
 704
 705 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
 706         __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,type,(void**)ptr)
 707
 708 /*
 709  * Some USB bandwidth allocation constants.
 710  */
 711 #define BW_HOST_DELAY   1000L           /* nanoseconds */
 712 #define BW_HUB_LS_SETUP 333L            /* nanoseconds */
 713                         /* 4 full-speed bit times (est.) */
 714
 715 #define FRAME_TIME_BITS         12000L          /* frame = 1 millisecond */
 716 #define FRAME_TIME_MAX_BITS_ALLOC       (90L * FRAME_TIME_BITS / 100L)
 717 #define FRAME_TIME_USECS        1000L
 718 #define FRAME_TIME_MAX_USECS_ALLOC      (90L * FRAME_TIME_USECS / 100L)
 719
 720 #define BitTime(bytecount)  (7 * 8 * bytecount / 6)  /* with integer truncation */
 721                 /* Trying not to use worst-case bit-stuffing
 722                    of (7/6 * 8 * bytecount) = 9.33 * bytecount */
 723                 /* bytecount = data payload byte count */
 724
 725 #define NS_TO_US(ns)    ((ns + 500L) / 1000L)
 726                         /* convert & round nanoseconds to microseconds */
 727
 728 /*
 729  * Debugging helpers..
 730  */
 731 void usb_show_device_descriptor(struct usb_device_descriptor *);
 732 void usb_show_config_descriptor(struct usb_config_descriptor *);
 733 void usb_show_interface_descriptor(struct usb_interface_descriptor *);
 734 void usb_show_endpoint_descriptor(struct usb_endpoint_descriptor *);
 735 void usb_show_device(struct usb_device *);
 736 void usb_show_string(struct usb_device *dev, char *id, int index);
 737
 738 #ifdef DEBUG
 739 #define dbg(format, arg...) printk(KERN_DEBUG __FILE__ ": " format "\n" , ## arg)
 740 #else
 741 #define dbg(format, arg...) do {} while (0)
 742 #endif
 743 #define err(format, arg...) printk(KERN_ERR __FILE__ ": " format "\n" , ## arg)
 744 #define info(format, arg...) printk(KERN_INFO __FILE__ ": " format "\n" , ## arg)
 745 #define warn(format, arg...) printk(KERN_WARNING __FILE__ ": " format "\n" , ## arg)
 746
 747
 748 /*
 749  * bus and driver list
 750  */
 751
 752 extern struct list_head usb_driver_list;
 753 extern struct list_head usb_bus_list;
 754
 755 /*
 756  * USB device fs stuff
 757  */
 758
 759 #ifdef CONFIG_USB_DEVICEFS
 760
 761 /*
 762  * these are expected to be called from the USB core/hub thread
 763  * with the kernel lock held
 764  */
 765 extern void usbdevfs_add_bus(struct usb_bus *bus);
 766 extern void usbdevfs_remove_bus(struct usb_bus *bus);
 767 extern void usbdevfs_add_device(struct usb_device *dev);
 768 extern void usbdevfs_remove_device(struct usb_device *dev);
 769
 770 extern int usbdevfs_init(void);
 771 extern void usbdevfs_cleanup(void);
 772
 773 #else /* CONFIG_USB_DEVICEFS */
 774
 775 extern inline void usbdevfs_add_bus(struct usb_bus *bus) {}
 776 extern inline void usbdevfs_remove_bus(struct usb_bus *bus) {}
 777 extern inline void usbdevfs_add_device(struct usb_device *dev) {}
 778 extern inline void usbdevfs_remove_device(struct usb_device *dev) {}
 779
 780 extern inline int usbdevfs_init(void) { return 0; }
 781 extern inline void usbdevfs_cleanup(void) { }
 782
 783 #endif /* CONFIG_USB_DEVICEFS */
 784
 785 #endif  /* __KERNEL__ */
 786
 787 #endif