include/linux/usb.h

   1 #ifndef __LINUX_USB_H
   2 #define __LINUX_USB_H
   3
   4 #include <linux/mod_devicetable.h>
   5 #include <linux/usb/ch9.h>
   6
   7 #define USB_MAJOR                       180
   8 #define USB_DEVICE_MAJOR                189
   9
  10
  11 #ifdef __KERNEL__
  12
  13 #include <linux/errno.h>        /* for -ENODEV */
  14 #include <linux/delay.h>        /* for mdelay() */
  15 #include <linux/interrupt.h>    /* for in_interrupt() */
  16 #include <linux/list.h>         /* for struct list_head */
  17 #include <linux/kref.h>         /* for struct kref */
  18 #include <linux/device.h>       /* for struct device */
  19 #include <linux/fs.h>           /* for struct file_operations */
  20 #include <linux/completion.h>   /* for struct completion */
  21 #include <linux/sched.h>        /* for current && schedule_timeout */
  22 #include <linux/mutex.h>        /* for struct mutex */
  23
  24 struct usb_device;
  25 struct usb_driver;
  26
  27 /*-------------------------------------------------------------------------*/
  28
  29 /*
  30  * Host-side wrappers for standard USB descriptors ... these are parsed
  31  * from the data provided by devices.  Parsing turns them from a flat
  32  * sequence of descriptors into a hierarchy:
  33  *
  34  *  - devices have one (usually) or more configs;
  35  *  - configs have one (often) or more interfaces;
  36  *  - interfaces have one (usually) or more settings;
  37  *  - each interface setting has zero or (usually) more endpoints.
  38  *
  39  * And there might be other descriptors mixed in with those.
  40  *
  41  * Devices may also have class-specific or vendor-specific descriptors.
  42  */
  43
  44 struct ep_device;
  45
  46 /**
  47  * struct usb_host_endpoint - host-side endpoint descriptor and queue
  48  * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
  49  * @urb_list: urbs queued to this endpoint; maintained by usbcore
  50  * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
  51  *      with one or more transfer descriptors (TDs) per urb
  52  * @ep_dev: ep_device for sysfs info
  53  * @extra: descriptors following this endpoint in the configuration
  54  * @extralen: how many bytes of "extra" are valid
  55  *
  56  * USB requests are always queued to a given endpoint, identified by a
  57  * descriptor within an active interface in a given USB configuration.
  58  */
  59 struct usb_host_endpoint {
  60         struct usb_endpoint_descriptor  desc;
  61         struct list_head                urb_list;
  62         void                            *hcpriv;
  63         struct ep_device                *ep_dev;        /* For sysfs info */
  64
  65         unsigned char *extra;   /* Extra descriptors */
  66         int extralen;
  67 };
  68
  69 /* host-side wrapper for one interface setting's parsed descriptors */
  70 struct usb_host_interface {
  71         struct usb_interface_descriptor desc;
  72
  73         /* array of desc.bNumEndpoint endpoints associated with this
  74          * interface setting.  these will be in no particular order.
  75          */
  76         struct usb_host_endpoint *endpoint;
  77
  78         char *string;           /* iInterface string, if present */
  79         unsigned char *extra;   /* Extra descriptors */
  80         int extralen;
  81 };
  82
  83 enum usb_interface_condition {
  84         USB_INTERFACE_UNBOUND = 0,
  85         USB_INTERFACE_BINDING,
  86         USB_INTERFACE_BOUND,
  87         USB_INTERFACE_UNBINDING,
  88 };
  89
  90 /**
  91  * struct usb_interface - what usb device drivers talk to
  92  * @altsetting: array of interface structures, one for each alternate
  93  *      setting that may be selected.  Each one includes a set of
  94  *      endpoint configurations.  They will be in no particular order.
  95  * @num_altsetting: number of altsettings defined.
  96  * @cur_altsetting: the current altsetting.
  97  * @driver: the USB driver that is bound to this interface.
  98  * @minor: the minor number assigned to this interface, if this
  99  *      interface is bound to a driver that uses the USB major number.
 100  *      If this interface does not use the USB major, this field should
 101  *      be unused.  The driver should set this value in the probe()
 102  *      function of the driver, after it has been assigned a minor
 103  *      number from the USB core by calling usb_register_dev().
 104  * @condition: binding state of the interface: not bound, binding
 105  *      (in probe()), bound to a driver, or unbinding (in disconnect())
 106  * @is_active: flag set when the interface is bound and not suspended.
 107  * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
 108  *      capability during autosuspend.
 109  * @dev: driver model's view of this device
 110  * @usb_dev: if an interface is bound to the USB major, this will point
 111  *      to the sysfs representation for that device.
 112  * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
 113  *      allowed unless the counter is 0.
 114  *
 115  * USB device drivers attach to interfaces on a physical device.  Each
 116  * interface encapsulates a single high level function, such as feeding
 117  * an audio stream to a speaker or reporting a change in a volume control.
 118  * Many USB devices only have one interface.  The protocol used to talk to
 119  * an interface's endpoints can be defined in a usb "class" specification,
 120  * or by a product's vendor.  The (default) control endpoint is part of
 121  * every interface, but is never listed among the interface's descriptors.
 122  *
 123  * The driver that is bound to the interface can use standard driver model
 124  * calls such as dev_get_drvdata() on the dev member of this structure.
 125  *
 126  * Each interface may have alternate settings.  The initial configuration
 127  * of a device sets altsetting 0, but the device driver can change
 128  * that setting using usb_set_interface().  Alternate settings are often
 129  * used to control the the use of periodic endpoints, such as by having
 130  * different endpoints use different amounts of reserved USB bandwidth.
 131  * All standards-conformant USB devices that use isochronous endpoints
 132  * will use them in non-default settings.
 133  *
 134  * The USB specification says that alternate setting numbers must run from
 135  * 0 to one less than the total number of alternate settings.  But some
 136  * devices manage to mess this up, and the structures aren't necessarily
 137  * stored in numerical order anyhow.  Use usb_altnum_to_altsetting() to
 138  * look up an alternate setting in the altsetting array based on its number.
 139  */
 140 struct usb_interface {
 141         /* array of alternate settings for this interface,
 142          * stored in no particular order */
 143         struct usb_host_interface *altsetting;
 144
 145         struct usb_host_interface *cur_altsetting;      /* the currently
 146                                          * active alternate setting */
 147         unsigned num_altsetting;        /* number of alternate settings */
 148
 149         int minor;                      /* minor number this interface is
 150                                          * bound to */
 151         enum usb_interface_condition condition;         /* state of binding */
 152         unsigned is_active:1;           /* the interface is not suspended */
 153         unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
 154
 155         struct device dev;              /* interface specific device info */
 156         struct device *usb_dev;         /* pointer to the usb class's device, if any */
 157         int pm_usage_cnt;               /* usage counter for autosuspend */
 158 };
 159 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
 160 #define interface_to_usbdev(intf) \
 161         container_of(intf->dev.parent, struct usb_device, dev)
 162
 163 static inline void *usb_get_intfdata (struct usb_interface *intf)
 164 {
 165         return dev_get_drvdata (&intf->dev);
 166 }
 167
 168 static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
 169 {
 170         dev_set_drvdata(&intf->dev, data);
 171 }
 172
 173 struct usb_interface *usb_get_intf(struct usb_interface *intf);
 174 void usb_put_intf(struct usb_interface *intf);
 175
 176 /* this maximum is arbitrary */
 177 #define USB_MAXINTERFACES       32
 178
 179 /**
 180  * struct usb_interface_cache - long-term representation of a device interface
 181  * @num_altsetting: number of altsettings defined.
 182  * @ref: reference counter.
 183  * @altsetting: variable-length array of interface structures, one for
 184  *      each alternate setting that may be selected.  Each one includes a
 185  *      set of endpoint configurations.  They will be in no particular order.
 186  *
 187  * These structures persist for the lifetime of a usb_device, unlike
 188  * struct usb_interface (which persists only as long as its configuration
 189  * is installed).  The altsetting arrays can be accessed through these
 190  * structures at any time, permitting comparison of configurations and
 191  * providing support for the /proc/bus/usb/devices pseudo-file.
 192  */
 193 struct usb_interface_cache {
 194         unsigned num_altsetting;        /* number of alternate settings */
 195         struct kref ref;                /* reference counter */
 196
 197         /* variable-length array of alternate settings for this interface,
 198          * stored in no particular order */
 199         struct usb_host_interface altsetting[0];
 200 };
 201 #define ref_to_usb_interface_cache(r) \
 202                 container_of(r, struct usb_interface_cache, ref)
 203 #define altsetting_to_usb_interface_cache(a) \
 204                 container_of(a, struct usb_interface_cache, altsetting[0])
 205
 206 /**
 207  * struct usb_host_config - representation of a device's configuration
 208  * @desc: the device's configuration descriptor.
 209  * @string: pointer to the cached version of the iConfiguration string, if
 210  *      present for this configuration.
 211  * @interface: array of pointers to usb_interface structures, one for each
 212  *      interface in the configuration.  The number of interfaces is stored
 213  *      in desc.bNumInterfaces.  These pointers are valid only while the
 214  *      the configuration is active.
 215  * @intf_cache: array of pointers to usb_interface_cache structures, one
 216  *      for each interface in the configuration.  These structures exist
 217  *      for the entire life of the device.
 218  * @extra: pointer to buffer containing all extra descriptors associated
 219  *      with this configuration (those preceding the first interface
 220  *      descriptor).
 221  * @extralen: length of the extra descriptors buffer.
 222  *
 223  * USB devices may have multiple configurations, but only one can be active
 224  * at any time.  Each encapsulates a different operational environment;
 225  * for example, a dual-speed device would have separate configurations for
 226  * full-speed and high-speed operation.  The number of configurations
 227  * available is stored in the device descriptor as bNumConfigurations.
 228  *
 229  * A configuration can contain multiple interfaces.  Each corresponds to
 230  * a different function of the USB device, and all are available whenever
 231  * the configuration is active.  The USB standard says that interfaces
 232  * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
 233  * of devices get this wrong.  In addition, the interface array is not
 234  * guaranteed to be sorted in numerical order.  Use usb_ifnum_to_if() to
 235  * look up an interface entry based on its number.
 236  *
 237  * Device drivers should not attempt to activate configurations.  The choice
 238  * of which configuration to install is a policy decision based on such
 239  * considerations as available power, functionality provided, and the user's
 240  * desires (expressed through userspace tools).  However, drivers can call
 241  * usb_reset_configuration() to reinitialize the current configuration and
 242  * all its interfaces.
 243  */
 244 struct usb_host_config {
 245         struct usb_config_descriptor    desc;
 246
 247         char *string;           /* iConfiguration string, if present */
 248         /* the interfaces associated with this configuration,
 249          * stored in no particular order */
 250         struct usb_interface *interface[USB_MAXINTERFACES];
 251
 252         /* Interface information available even when this is not the
 253          * active configuration */
 254         struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
 255
 256         unsigned char *extra;   /* Extra descriptors */
 257         int extralen;
 258 };
 259
 260 int __usb_get_extra_descriptor(char *buffer, unsigned size,
 261         unsigned char type, void **ptr);
 262 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
 263         __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
 264                 type,(void**)ptr)
 265
 266 /* ----------------------------------------------------------------------- */
 267
 268 /* USB device number allocation bitmap */
 269 struct usb_devmap {
 270         unsigned long devicemap[128 / (8*sizeof(unsigned long))];
 271 };
 272
 273 /*
 274  * Allocated per bus (tree of devices) we have:
 275  */
 276 struct usb_bus {
 277         struct device *controller;      /* host/master side hardware */
 278         int busnum;                     /* Bus number (in order of reg) */
 279         char *bus_name;                 /* stable id (PCI slot_name etc) */
 280         u8 uses_dma;                    /* Does the host controller use DMA? */
 281         u8 otg_port;                    /* 0, or number of OTG/HNP port */
 282         unsigned is_b_host:1;           /* true during some HNP roleswitches */
 283         unsigned b_hnp_enable:1;        /* OTG: did A-Host enable HNP? */
 284
 285         int devnum_next;                /* Next open device number in
 286                                          * round-robin allocation */
 287
 288         struct usb_devmap devmap;       /* device address allocation map */
 289         struct usb_device *root_hub;    /* Root hub */
 290         struct list_head bus_list;      /* list of busses */
 291
 292         int bandwidth_allocated;        /* on this bus: how much of the time
 293                                          * reserved for periodic (intr/iso)
 294                                          * requests is used, on average?
 295                                          * Units: microseconds/frame.
 296                                          * Limits: Full/low speed reserve 90%,
 297                                          * while high speed reserves 80%.
 298                                          */
 299         int bandwidth_int_reqs;         /* number of Interrupt requests */
 300         int bandwidth_isoc_reqs;        /* number of Isoc. requests */
 301
 302         struct dentry *usbfs_dentry;    /* usbfs dentry entry for the bus */
 303
 304         struct class_device *class_dev; /* class device for this bus */
 305
 306 #if defined(CONFIG_USB_MON)
 307         struct mon_bus *mon_bus;        /* non-null when associated */
 308         int monitored;                  /* non-zero when monitored */
 309 #endif
 310 };
 311
 312 /* ----------------------------------------------------------------------- */
 313
 314 /* This is arbitrary.
 315  * From USB 2.0 spec Table 11-13, offset 7, a hub can
 316  * have up to 255 ports. The most yet reported is 10.
 317  *
 318  * Current Wireless USB host hardware (Intel i1480 for example) allows
 319  * up to 22 devices to connect. Upcoming hardware might raise that
 320  * limit. Because the arrays need to add a bit for hub status data, we
 321  * do 31, so plus one evens out to four bytes.
 322  */
 323 #define USB_MAXCHILDREN         (31)
 324
 325 struct usb_tt;
 326
 327 /*
 328  * struct usb_device - kernel's representation of a USB device
 329  *
 330  * FIXME: Write the kerneldoc!
 331  *
 332  * Usbcore drivers should not set usbdev->state directly.  Instead use
 333  * usb_set_device_state().
 334  */
 335 struct usb_device {
 336         int             devnum;         /* Address on USB bus */
 337         char            devpath [16];   /* Use in messages: /port/port/... */
 338         enum usb_device_state   state;  /* configured, not attached, etc */
 339         enum usb_device_speed   speed;  /* high/full/low (or error) */
 340
 341         struct usb_tt   *tt;            /* low/full speed dev, highspeed hub */
 342         int             ttport;         /* device port on that tt hub */
 343
 344         unsigned int toggle[2];         /* one bit for each endpoint
 345                                          * ([0] = IN, [1] = OUT) */
 346
 347         struct usb_device *parent;      /* our hub, unless we're the root */
 348         struct usb_bus *bus;            /* Bus we're part of */
 349         struct usb_host_endpoint ep0;
 350
 351         struct device dev;              /* Generic device interface */
 352
 353         struct usb_device_descriptor descriptor;/* Descriptor */
 354         struct usb_host_config *config; /* All of the configs */
 355
 356         struct usb_host_config *actconfig;/* the active configuration */
 357         struct usb_host_endpoint *ep_in[16];
 358         struct usb_host_endpoint *ep_out[16];
 359
 360         char **rawdescriptors;          /* Raw descriptors for each config */
 361
 362         unsigned short bus_mA;          /* Current available from the bus */
 363         u8 portnum;                     /* Parent port number (origin 1) */
 364         u8 level;                       /* Number of USB hub ancestors */
 365
 366         unsigned discon_suspended:1;    /* Disconnected while suspended */
 367         unsigned have_langid:1;         /* whether string_langid is valid */
 368         int string_langid;              /* language ID for strings */
 369
 370         /* static strings from the device */
 371         char *product;                  /* iProduct string, if present */
 372         char *manufacturer;             /* iManufacturer string, if present */
 373         char *serial;                   /* iSerialNumber string, if present */
 374
 375         struct list_head filelist;
 376         struct device *usbfs_dev;
 377         struct dentry *usbfs_dentry;    /* usbfs dentry entry for the device */
 378
 379         /*
 380          * Child devices - these can be either new devices
 381          * (if this is a hub device), or different instances
 382          * of this same device.
 383          *
 384          * Each instance needs its own set of data structures.
 385          */
 386
 387         int maxchild;                   /* Number of ports if hub */
 388         struct usb_device *children[USB_MAXCHILDREN];
 389
 390         int pm_usage_cnt;               /* usage counter for autosuspend */
 391         u32 quirks;                     /* quirks of the whole device */
 392
 393 #ifdef CONFIG_PM
 394         struct delayed_work autosuspend; /* for delayed autosuspends */
 395         struct mutex pm_mutex;          /* protects PM operations */
 396
 397         int autosuspend_delay;          /* in jiffies */
 398
 399         unsigned auto_pm:1;             /* autosuspend/resume in progress */
 400         unsigned do_remote_wakeup:1;    /* remote wakeup should be enabled */
 401         unsigned autosuspend_disabled:1; /* autosuspend and autoresume */
 402         unsigned autoresume_disabled:1;  /*  disabled by the user */
 403 #endif
 404 };
 405 #define to_usb_device(d) container_of(d, struct usb_device, dev)
 406
 407 extern struct usb_device *usb_get_dev(struct usb_device *dev);
 408 extern void usb_put_dev(struct usb_device *dev);
 409
 410 /* USB device locking */
 411 #define usb_lock_device(udev)           down(&(udev)->dev.sem)
 412 #define usb_unlock_device(udev)         up(&(udev)->dev.sem)
 413 #define usb_trylock_device(udev)        down_trylock(&(udev)->dev.sem)
 414 extern int usb_lock_device_for_reset(struct usb_device *udev,
 415                                      const struct usb_interface *iface);
 416
 417 /* USB port reset for device reinitialization */
 418 extern int usb_reset_device(struct usb_device *dev);
 419 extern int usb_reset_composite_device(struct usb_device *dev,
 420                 struct usb_interface *iface);
 421
 422 extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
 423
 424 /* USB autosuspend and autoresume */
 425 #ifdef CONFIG_USB_SUSPEND
 426 extern int usb_autopm_set_interface(struct usb_interface *intf);
 427 extern int usb_autopm_get_interface(struct usb_interface *intf);
 428 extern void usb_autopm_put_interface(struct usb_interface *intf);
 429
 430 static inline void usb_autopm_enable(struct usb_interface *intf)
 431 {
 432         intf->pm_usage_cnt = 0;
 433         usb_autopm_set_interface(intf);
 434 }
 435
 436 static inline void usb_autopm_disable(struct usb_interface *intf)
 437 {
 438         intf->pm_usage_cnt = 1;
 439         usb_autopm_set_interface(intf);
 440 }
 441
 442 #else
 443
 444 static inline int usb_autopm_set_interface(struct usb_interface *intf)
 445 { return 0; }
 446
 447 static inline int usb_autopm_get_interface(struct usb_interface *intf)
 448 { return 0; }
 449
 450 static inline void usb_autopm_put_interface(struct usb_interface *intf)
 451 { }
 452 static inline void usb_autopm_enable(struct usb_interface *intf)
 453 { }
 454 static inline void usb_autopm_disable(struct usb_interface *intf)
 455 { }
 456 #endif
 457
 458 /*-------------------------------------------------------------------------*/
 459
 460 /* for drivers using iso endpoints */
 461 extern int usb_get_current_frame_number (struct usb_device *usb_dev);
 462
 463 /* used these for multi-interface device registration */
 464 extern int usb_driver_claim_interface(struct usb_driver *driver,
 465                         struct usb_interface *iface, void* priv);
 466
 467 /**
 468  * usb_interface_claimed - returns true iff an interface is claimed
 469  * @iface: the interface being checked
 470  *
 471  * Returns true (nonzero) iff the interface is claimed, else false (zero).
 472  * Callers must own the driver model's usb bus readlock.  So driver
 473  * probe() entries don't need extra locking, but other call contexts
 474  * may need to explicitly claim that lock.
 475  *
 476  */
 477 static inline int usb_interface_claimed(struct usb_interface *iface) {
 478         return (iface->dev.driver != NULL);
 479 }
 480
 481 extern void usb_driver_release_interface(struct usb_driver *driver,
 482                         struct usb_interface *iface);
 483 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
 484                                          const struct usb_device_id *id);
 485 extern int usb_match_one_id(struct usb_interface *interface,
 486                             const struct usb_device_id *id);
 487
 488 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
 489                 int minor);
 490 extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
 491                 unsigned ifnum);
 492 extern struct usb_host_interface *usb_altnum_to_altsetting(
 493                 const struct usb_interface *intf, unsigned int altnum);
 494
 495
 496 /**
 497  * usb_make_path - returns stable device path in the usb tree
 498  * @dev: the device whose path is being constructed
 499  * @buf: where to put the string
 500  * @size: how big is "buf"?
 501  *
 502  * Returns length of the string (> 0) or negative if size was too small.
 503  *
 504  * This identifier is intended to be "stable", reflecting physical paths in
 505  * hardware such as physical bus addresses for host controllers or ports on
 506  * USB hubs.  That makes it stay the same until systems are physically
 507  * reconfigured, by re-cabling a tree of USB devices or by moving USB host
 508  * controllers.  Adding and removing devices, including virtual root hubs
 509  * in host controller driver modules, does not change these path identifers;
 510  * neither does rebooting or re-enumerating.  These are more useful identifiers
 511  * than changeable ("unstable") ones like bus numbers or device addresses.
 512  *
 513  * With a partial exception for devices connected to USB 2.0 root hubs, these
 514  * identifiers are also predictable.  So long as the device tree isn't changed,
 515  * plugging any USB device into a given hub port always gives it the same path.
 516  * Because of the use of "companion" controllers, devices connected to ports on
 517  * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
 518  * high speed, and a different one if they are full or low speed.
 519  */
 520 static inline int usb_make_path (struct usb_device *dev, char *buf,
 521                 size_t size)
 522 {
 523         int actual;
 524         actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
 525                         dev->devpath);
 526         return (actual >= (int)size) ? -1 : actual;
 527 }
 528
 529 /*-------------------------------------------------------------------------*/
 530
 531 /**
 532  * usb_endpoint_dir_in - check if the endpoint has IN direction
 533  * @epd: endpoint to be checked
 534  *
 535  * Returns true if the endpoint is of type IN, otherwise it returns false.
 536  */
 537 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
 538 {
 539         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
 540 }
 541
 542 /**
 543  * usb_endpoint_dir_out - check if the endpoint has OUT direction
 544  * @epd: endpoint to be checked
 545  *
 546  * Returns true if the endpoint is of type OUT, otherwise it returns false.
 547  */
 548 static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor *epd)
 549 {
 550         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
 551 }
 552
 553 /**
 554  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
 555  * @epd: endpoint to be checked
 556  *
 557  * Returns true if the endpoint is of type bulk, otherwise it returns false.
 558  */
 559 static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor *epd)
 560 {
 561         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 562                 USB_ENDPOINT_XFER_BULK);
 563 }
 564
 565 /**
 566  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
 567  * @epd: endpoint to be checked
 568  *
 569  * Returns true if the endpoint is of type control, otherwise it returns false.
 570  */
 571 static inline int usb_endpoint_xfer_control(const struct usb_endpoint_descriptor *epd)
 572 {
 573         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 574                 USB_ENDPOINT_XFER_CONTROL);
 575 }
 576
 577 /**
 578  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
 579  * @epd: endpoint to be checked
 580  *
 581  * Returns true if the endpoint is of type interrupt, otherwise it returns
 582  * false.
 583  */
 584 static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor *epd)
 585 {
 586         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 587                 USB_ENDPOINT_XFER_INT);
 588 }
 589
 590 /**
 591  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
 592  * @epd: endpoint to be checked
 593  *
 594  * Returns true if the endpoint is of type isochronous, otherwise it returns
 595  * false.
 596  */
 597 static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor *epd)
 598 {
 599         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 600                 USB_ENDPOINT_XFER_ISOC);
 601 }
 602
 603 /**
 604  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
 605  * @epd: endpoint to be checked
 606  *
 607  * Returns true if the endpoint has bulk transfer type and IN direction,
 608  * otherwise it returns false.
 609  */
 610 static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor *epd)
 611 {
 612         return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
 613 }
 614
 615 /**
 616  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
 617  * @epd: endpoint to be checked
 618  *
 619  * Returns true if the endpoint has bulk transfer type and OUT direction,
 620  * otherwise it returns false.
 621  */
 622 static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor *epd)
 623 {
 624         return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
 625 }
 626
 627 /**
 628  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
 629  * @epd: endpoint to be checked
 630  *
 631  * Returns true if the endpoint has interrupt transfer type and IN direction,
 632  * otherwise it returns false.
 633  */
 634 static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor *epd)
 635 {
 636         return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
 637 }
 638
 639 /**
 640  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
 641  * @epd: endpoint to be checked
 642  *
 643  * Returns true if the endpoint has interrupt transfer type and OUT direction,
 644  * otherwise it returns false.
 645  */
 646 static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor *epd)
 647 {
 648         return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
 649 }
 650
 651 /**
 652  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
 653  * @epd: endpoint to be checked
 654  *
 655  * Returns true if the endpoint has isochronous transfer type and IN direction,
 656  * otherwise it returns false.
 657  */
 658 static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor *epd)
 659 {
 660         return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
 661 }
 662
 663 /**
 664  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
 665  * @epd: endpoint to be checked
 666  *
 667  * Returns true if the endpoint has isochronous transfer type and OUT direction,
 668  * otherwise it returns false.
 669  */
 670 static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor *epd)
 671 {
 672         return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
 673 }
 674
 675 /*-------------------------------------------------------------------------*/
 676
 677 #define USB_DEVICE_ID_MATCH_DEVICE \
 678                 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
 679 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
 680                 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
 681 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
 682                 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
 683 #define USB_DEVICE_ID_MATCH_DEV_INFO \
 684                 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
 685                 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
 686                 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
 687 #define USB_DEVICE_ID_MATCH_INT_INFO \
 688                 (USB_DEVICE_ID_MATCH_INT_CLASS | \
 689                 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
 690                 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
 691
 692 /**
 693  * USB_DEVICE - macro used to describe a specific usb device
 694  * @vend: the 16 bit USB Vendor ID
 695  * @prod: the 16 bit USB Product ID
 696  *
 697  * This macro is used to create a struct usb_device_id that matches a
 698  * specific device.
 699  */
 700 #define USB_DEVICE(vend,prod) \
 701         .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
 702                         .idProduct = (prod)
 703 /**
 704  * USB_DEVICE_VER - macro used to describe a specific usb device with a
 705  *              version range
 706  * @vend: the 16 bit USB Vendor ID
 707  * @prod: the 16 bit USB Product ID
 708  * @lo: the bcdDevice_lo value
 709  * @hi: the bcdDevice_hi value
 710  *
 711  * This macro is used to create a struct usb_device_id that matches a
 712  * specific device, with a version range.
 713  */
 714 #define USB_DEVICE_VER(vend,prod,lo,hi) \
 715         .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
 716         .idVendor = (vend), .idProduct = (prod), \
 717         .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
 718
 719 /**
 720  * USB_DEVICE_INFO - macro used to describe a class of usb devices
 721  * @cl: bDeviceClass value
 722  * @sc: bDeviceSubClass value
 723  * @pr: bDeviceProtocol value
 724  *
 725  * This macro is used to create a struct usb_device_id that matches a
 726  * specific class of devices.
 727  */
 728 #define USB_DEVICE_INFO(cl,sc,pr) \
 729         .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
 730         .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
 731
 732 /**
 733  * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
 734  * @cl: bInterfaceClass value
 735  * @sc: bInterfaceSubClass value
 736  * @pr: bInterfaceProtocol value
 737  *
 738  * This macro is used to create a struct usb_device_id that matches a
 739  * specific class of interfaces.
 740  */
 741 #define USB_INTERFACE_INFO(cl,sc,pr) \
 742         .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
 743         .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
 744
 745 /* ----------------------------------------------------------------------- */
 746
 747 /* Stuff for dynamic usb ids */
 748 struct usb_dynids {
 749         spinlock_t lock;
 750         struct list_head list;
 751 };
 752
 753 struct usb_dynid {
 754         struct list_head node;
 755         struct usb_device_id id;
 756 };
 757
 758 extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
 759                                 struct device_driver *driver,
 760                                 const char *buf, size_t count);
 761
 762 /**
 763  * struct usbdrv_wrap - wrapper for driver-model structure
 764  * @driver: The driver-model core driver structure.
 765  * @for_devices: Non-zero for device drivers, 0 for interface drivers.
 766  */
 767 struct usbdrv_wrap {
 768         struct device_driver driver;
 769         int for_devices;
 770 };
 771
 772 /**
 773  * struct usb_driver - identifies USB interface driver to usbcore
 774  * @name: The driver name should be unique among USB drivers,
 775  *      and should normally be the same as the module name.
 776  * @probe: Called to see if the driver is willing to manage a particular
 777  *      interface on a device.  If it is, probe returns zero and uses
 778  *      dev_set_drvdata() to associate driver-specific data with the
 779  *      interface.  It may also use usb_set_interface() to specify the
 780  *      appropriate altsetting.  If unwilling to manage the interface,
 781  *      return a negative errno value.
 782  * @disconnect: Called when the interface is no longer accessible, usually
 783  *      because its device has been (or is being) disconnected or the
 784  *      driver module is being unloaded.
 785  * @ioctl: Used for drivers that want to talk to userspace through
 786  *      the "usbfs" filesystem.  This lets devices provide ways to
 787  *      expose information to user space regardless of where they
 788  *      do (or don't) show up otherwise in the filesystem.
 789  * @suspend: Called when the device is going to be suspended by the system.
 790  * @resume: Called when the device is being resumed by the system.
 791  * @pre_reset: Called by usb_reset_composite_device() when the device
 792  *      is about to be reset.
 793  * @post_reset: Called by usb_reset_composite_device() after the device
 794  *      has been reset.
 795  * @id_table: USB drivers use ID table to support hotplugging.
 796  *      Export this with MODULE_DEVICE_TABLE(usb,...).  This must be set
 797  *      or your driver's probe function will never get called.
 798  * @dynids: used internally to hold the list of dynamically added device
 799  *      ids for this driver.
 800  * @drvwrap: Driver-model core structure wrapper.
 801  * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
 802  *      added to this driver by preventing the sysfs file from being created.
 803  * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
 804  *      for interfaces bound to this driver.
 805  *
 806  * USB interface drivers must provide a name, probe() and disconnect()
 807  * methods, and an id_table.  Other driver fields are optional.
 808  *
 809  * The id_table is used in hotplugging.  It holds a set of descriptors,
 810  * and specialized data may be associated with each entry.  That table
 811  * is used by both user and kernel mode hotplugging support.
 812  *
 813  * The probe() and disconnect() methods are called in a context where
 814  * they can sleep, but they should avoid abusing the privilege.  Most
 815  * work to connect to a device should be done when the device is opened,
 816  * and undone at the last close.  The disconnect code needs to address
 817  * concurrency issues with respect to open() and close() methods, as
 818  * well as forcing all pending I/O requests to complete (by unlinking
 819  * them as necessary, and blocking until the unlinks complete).
 820  */
 821 struct usb_driver {
 822         const char *name;
 823
 824         int (*probe) (struct usb_interface *intf,
 825                       const struct usb_device_id *id);
 826
 827         void (*disconnect) (struct usb_interface *intf);
 828
 829         int (*ioctl) (struct usb_interface *intf, unsigned int code,
 830                         void *buf);
 831
 832         int (*suspend) (struct usb_interface *intf, pm_message_t message);
 833         int (*resume) (struct usb_interface *intf);
 834
 835         void (*pre_reset) (struct usb_interface *intf);
 836         void (*post_reset) (struct usb_interface *intf);
 837
 838         const struct usb_device_id *id_table;
 839
 840         struct usb_dynids dynids;
 841         struct usbdrv_wrap drvwrap;
 842         unsigned int no_dynamic_id:1;
 843         unsigned int supports_autosuspend:1;
 844 };
 845 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
 846
 847 /**
 848  * struct usb_device_driver - identifies USB device driver to usbcore
 849  * @name: The driver name should be unique among USB drivers,
 850  *      and should normally be the same as the module name.
 851  * @probe: Called to see if the driver is willing to manage a particular
 852  *      device.  If it is, probe returns zero and uses dev_set_drvdata()
 853  *      to associate driver-specific data with the device.  If unwilling
 854  *      to manage the device, return a negative errno value.
 855  * @disconnect: Called when the device is no longer accessible, usually
 856  *      because it has been (or is being) disconnected or the driver's
 857  *      module is being unloaded.
 858  * @suspend: Called when the device is going to be suspended by the system.
 859  * @resume: Called when the device is being resumed by the system.
 860  * @drvwrap: Driver-model core structure wrapper.
 861  * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
 862  *      for devices bound to this driver.
 863  *
 864  * USB drivers must provide all the fields listed above except drvwrap.
 865  */
 866 struct usb_device_driver {
 867         const char *name;
 868
 869         int (*probe) (struct usb_device *udev);
 870         void (*disconnect) (struct usb_device *udev);
 871
 872         int (*suspend) (struct usb_device *udev, pm_message_t message);
 873         int (*resume) (struct usb_device *udev);
 874         struct usbdrv_wrap drvwrap;
 875         unsigned int supports_autosuspend:1;
 876 };
 877 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
 878                 drvwrap.driver)
 879
 880 extern struct bus_type usb_bus_type;
 881
 882 /**
 883  * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
 884  * @name: the usb class device name for this driver.  Will show up in sysfs.
 885  * @fops: pointer to the struct file_operations of this driver.
 886  * @minor_base: the start of the minor range for this driver.
 887  *
 888  * This structure is used for the usb_register_dev() and
 889  * usb_unregister_dev() functions, to consolidate a number of the
 890  * parameters used for them.
 891  */
 892 struct usb_class_driver {
 893         char *name;
 894         const struct file_operations *fops;
 895         int minor_base;
 896 };
 897
 898 /*
 899  * use these in module_init()/module_exit()
 900  * and don't forget MODULE_DEVICE_TABLE(usb, ...)
 901  */
 902 extern int usb_register_driver(struct usb_driver *, struct module *,
 903                                const char *);
 904 static inline int usb_register(struct usb_driver *driver)
 905 {
 906         return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
 907 }
 908 extern void usb_deregister(struct usb_driver *);
 909
 910 extern int usb_register_device_driver(struct usb_device_driver *,
 911                         struct module *);
 912 extern void usb_deregister_device_driver(struct usb_device_driver *);
 913
 914 extern int usb_register_dev(struct usb_interface *intf,
 915                             struct usb_class_driver *class_driver);
 916 extern void usb_deregister_dev(struct usb_interface *intf,
 917                                struct usb_class_driver *class_driver);
 918
 919 extern int usb_disabled(void);
 920
 921 /* ----------------------------------------------------------------------- */
 922
 923 /*
 924  * URB support, for asynchronous request completions
 925  */
 926
 927 /*
 928  * urb->transfer_flags:
 929  */
 930 #define URB_SHORT_NOT_OK        0x0001  /* report short reads as errors */
 931 #define URB_ISO_ASAP            0x0002  /* iso-only, urb->start_frame
 932                                          * ignored */
 933 #define URB_NO_TRANSFER_DMA_MAP 0x0004  /* urb->transfer_dma valid on submit */
 934 #define URB_NO_SETUP_DMA_MAP    0x0008  /* urb->setup_dma valid on submit */
 935 #define URB_NO_FSBR             0x0020  /* UHCI-specific */
 936 #define URB_ZERO_PACKET         0x0040  /* Finish bulk OUT with short packet */
 937 #define URB_NO_INTERRUPT        0x0080  /* HINT: no non-error interrupt
 938                                          * needed */
 939
 940 struct usb_iso_packet_descriptor {
 941         unsigned int offset;
 942         unsigned int length;            /* expected length */
 943         unsigned int actual_length;
 944         int status;
 945 };
 946
 947 struct urb;
 948
 949 typedef void (*usb_complete_t)(struct urb *);
 950
 951 /**
 952  * struct urb - USB Request Block
 953  * @urb_list: For use by current owner of the URB.
 954  * @pipe: Holds endpoint number, direction, type, and more.
 955  *      Create these values with the eight macros available;
 956  *      usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
 957  *      (control), "bulk", "int" (interrupt), or "iso" (isochronous).
 958  *      For example usb_sndbulkpipe() or usb_rcvintpipe().  Endpoint
 959  *      numbers range from zero to fifteen.  Note that "in" endpoint two
 960  *      is a different endpoint (and pipe) from "out" endpoint two.
 961  *      The current configuration controls the existence, type, and
 962  *      maximum packet size of any given endpoint.
 963  * @dev: Identifies the USB device to perform the request.
 964  * @status: This is read in non-iso completion functions to get the
 965  *      status of the particular request.  ISO requests only use it
 966  *      to tell whether the URB was unlinked; detailed status for
 967  *      each frame is in the fields of the iso_frame-desc.
 968  * @transfer_flags: A variety of flags may be used to affect how URB
 969  *      submission, unlinking, or operation are handled.  Different
 970  *      kinds of URB can use different flags.
 971  * @transfer_buffer:  This identifies the buffer to (or from) which
 972  *      the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
 973  *      is set).  This buffer must be suitable for DMA; allocate it with
 974  *      kmalloc() or equivalent.  For transfers to "in" endpoints, contents
 975  *      of this buffer will be modified.  This buffer is used for the data
 976  *      stage of control transfers.
 977  * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
 978  *      the device driver is saying that it provided this DMA address,
 979  *      which the host controller driver should use in preference to the
 980  *      transfer_buffer.
 981  * @transfer_buffer_length: How big is transfer_buffer.  The transfer may
 982  *      be broken up into chunks according to the current maximum packet
 983  *      size for the endpoint, which is a function of the configuration
 984  *      and is encoded in the pipe.  When the length is zero, neither
 985  *      transfer_buffer nor transfer_dma is used.
 986  * @actual_length: This is read in non-iso completion functions, and
 987  *      it tells how many bytes (out of transfer_buffer_length) were
 988  *      transferred.  It will normally be the same as requested, unless
 989  *      either an error was reported or a short read was performed.
 990  *      The URB_SHORT_NOT_OK transfer flag may be used to make such
 991  *      short reads be reported as errors.
 992  * @setup_packet: Only used for control transfers, this points to eight bytes
 993  *      of setup data.  Control transfers always start by sending this data
 994  *      to the device.  Then transfer_buffer is read or written, if needed.
 995  * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
 996  *      device driver has provided this DMA address for the setup packet.
 997  *      The host controller driver should use this in preference to
 998  *      setup_packet.
 999  * @start_frame: Returns the initial frame for isochronous transfers.
1000  * @number_of_packets: Lists the number of ISO transfer buffers.
1001  * @interval: Specifies the polling interval for interrupt or isochronous
1002  *      transfers.  The units are frames (milliseconds) for for full and low
1003  *      speed devices, and microframes (1/8 millisecond) for highspeed ones.
1004  * @error_count: Returns the number of ISO transfers that reported errors.
1005  * @context: For use in completion functions.  This normally points to
1006  *      request-specific driver context.
1007  * @complete: Completion handler. This URB is passed as the parameter to the
1008  *      completion function.  The completion function may then do what
1009  *      it likes with the URB, including resubmitting or freeing it.
1010  * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1011  *      collect the transfer status for each buffer.
1012  *
1013  * This structure identifies USB transfer requests.  URBs must be allocated by
1014  * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1015  * Initialization may be done using various usb_fill_*_urb() functions.  URBs
1016  * are submitted using usb_submit_urb(), and pending requests may be canceled
1017  * using usb_unlink_urb() or usb_kill_urb().
1018  *
1019  * Data Transfer Buffers:
1020  *
1021  * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1022  * taken from the general page pool.  That is provided by transfer_buffer
1023  * (control requests also use setup_packet), and host controller drivers
1024  * perform a dma mapping (and unmapping) for each buffer transferred.  Those
1025  * mapping operations can be expensive on some platforms (perhaps using a dma
1026  * bounce buffer or talking to an IOMMU),
1027  * although they're cheap on commodity x86 and ppc hardware.
1028  *
1029  * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1030  * which tell the host controller driver that no such mapping is needed since
1031  * the device driver is DMA-aware.  For example, a device driver might
1032  * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1033  * When these transfer flags are provided, host controller drivers will
1034  * attempt to use the dma addresses found in the transfer_dma and/or
1035  * setup_dma fields rather than determining a dma address themselves.  (Note
1036  * that transfer_buffer and setup_packet must still be set because not all
1037  * host controllers use DMA, nor do virtual root hubs).
1038  *
1039  * Initialization:
1040  *
1041  * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1042  * zero), and complete fields.  All URBs must also initialize
1043  * transfer_buffer and transfer_buffer_length.  They may provide the
1044  * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1045  * to be treated as errors; that flag is invalid for write requests.
1046  *
1047  * Bulk URBs may
1048  * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1049  * should always terminate with a short packet, even if it means adding an
1050  * extra zero length packet.
1051  *
1052  * Control URBs must provide a setup_packet.  The setup_packet and
1053  * transfer_buffer may each be mapped for DMA or not, independently of
1054  * the other.  The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1055  * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1056  * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1057  *
1058  * Interrupt URBs must provide an interval, saying how often (in milliseconds
1059  * or, for highspeed devices, 125 microsecond units)
1060  * to poll for transfers.  After the URB has been submitted, the interval
1061  * field reflects how the transfer was actually scheduled.
1062  * The polling interval may be more frequent than requested.
1063  * For example, some controllers have a maximum interval of 32 milliseconds,
1064  * while others support intervals of up to 1024 milliseconds.
1065  * Isochronous URBs also have transfer intervals.  (Note that for isochronous
1066  * endpoints, as well as high speed interrupt endpoints, the encoding of
1067  * the transfer interval in the endpoint descriptor is logarithmic.
1068  * Device drivers must convert that value to linear units themselves.)
1069  *
1070  * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1071  * the host controller to schedule the transfer as soon as bandwidth
1072  * utilization allows, and then set start_frame to reflect the actual frame
1073  * selected during submission.  Otherwise drivers must specify the start_frame
1074  * and handle the case where the transfer can't begin then.  However, drivers
1075  * won't know how bandwidth is currently allocated, and while they can
1076  * find the current frame using usb_get_current_frame_number () they can't
1077  * know the range for that frame number.  (Ranges for frame counter values
1078  * are HC-specific, and can go from 256 to 65536 frames from "now".)
1079  *
1080  * Isochronous URBs have a different data transfer model, in part because
1081  * the quality of service is only "best effort".  Callers provide specially
1082  * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1083  * at the end.  Each such packet is an individual ISO transfer.  Isochronous
1084  * URBs are normally queued, submitted by drivers to arrange that
1085  * transfers are at least double buffered, and then explicitly resubmitted
1086  * in completion handlers, so
1087  * that data (such as audio or video) streams at as constant a rate as the
1088  * host controller scheduler can support.
1089  *
1090  * Completion Callbacks:
1091  *
1092  * The completion callback is made in_interrupt(), and one of the first
1093  * things that a completion handler should do is check the status field.
1094  * The status field is provided for all URBs.  It is used to report
1095  * unlinked URBs, and status for all non-ISO transfers.  It should not
1096  * be examined before the URB is returned to the completion handler.
1097  *
1098  * The context field is normally used to link URBs back to the relevant
1099  * driver or request state.
1100  *
1101  * When the completion callback is invoked for non-isochronous URBs, the
1102  * actual_length field tells how many bytes were transferred.  This field
1103  * is updated even when the URB terminated with an error or was unlinked.
1104  *
1105  * ISO transfer status is reported in the status and actual_length fields
1106  * of the iso_frame_desc array, and the number of errors is reported in
1107  * error_count.  Completion callbacks for ISO transfers will normally
1108  * (re)submit URBs to ensure a constant transfer rate.
1109  *
1110  * Note that even fields marked "public" should not be touched by the driver
1111  * when the urb is owned by the hcd, that is, since the call to
1112  * usb_submit_urb() till the entry into the completion routine.
1113  */
1114 struct urb
1115 {
1116         /* private: usb core and host controller only fields in the urb */
1117         struct kref kref;               /* reference count of the URB */
1118         spinlock_t lock;                /* lock for the URB */
1119         void *hcpriv;                   /* private data for host controller */
1120         atomic_t use_count;             /* concurrent submissions counter */
1121         u8 reject;                      /* submissions will fail */
1122
1123         /* public: documented fields in the urb that can be used by drivers */
1124         struct list_head urb_list;      /* list head for use by the urb's
1125                                          * current owner */
1126         struct usb_device *dev;         /* (in) pointer to associated device */
1127         unsigned int pipe;              /* (in) pipe information */
1128         int status;                     /* (return) non-ISO status */
1129         unsigned int transfer_flags;    /* (in) URB_SHORT_NOT_OK | ...*/
1130         void *transfer_buffer;          /* (in) associated data buffer */
1131         dma_addr_t transfer_dma;        /* (in) dma addr for transfer_buffer */
1132         int transfer_buffer_length;     /* (in) data buffer length */
1133         int actual_length;              /* (return) actual transfer length */
1134         unsigned char *setup_packet;    /* (in) setup packet (control only) */
1135         dma_addr_t setup_dma;           /* (in) dma addr for setup_packet */
1136         int start_frame;                /* (modify) start frame (ISO) */
1137         int number_of_packets;          /* (in) number of ISO packets */
1138         int interval;                   /* (modify) transfer interval
1139                                          * (INT/ISO) */
1140         int error_count;                /* (return) number of ISO errors */
1141         void *context;                  /* (in) context for completion */
1142         usb_complete_t complete;        /* (in) completion routine */
1143         struct usb_iso_packet_descriptor iso_frame_desc[0];
1144                                         /* (in) ISO ONLY */
1145 };
1146
1147 /* ----------------------------------------------------------------------- */
1148
1149 /**
1150  * usb_fill_control_urb - initializes a control urb
1151  * @urb: pointer to the urb to initialize.
1152  * @dev: pointer to the struct usb_device for this urb.
1153  * @pipe: the endpoint pipe
1154  * @setup_packet: pointer to the setup_packet buffer
1155  * @transfer_buffer: pointer to the transfer buffer
1156  * @buffer_length: length of the transfer buffer
1157  * @complete_fn: pointer to the usb_complete_t function
1158  * @context: what to set the urb context to.
1159  *
1160  * Initializes a control urb with the proper information needed to submit
1161  * it to a device.
1162  */
1163 static inline void usb_fill_control_urb (struct urb *urb,
1164                                          struct usb_device *dev,
1165                                          unsigned int pipe,
1166                                          unsigned char *setup_packet,
1167                                          void *transfer_buffer,
1168                                          int buffer_length,
1169                                          usb_complete_t complete_fn,
1170                                          void *context)
1171 {
1172         spin_lock_init(&urb->lock);
1173         urb->dev = dev;
1174         urb->pipe = pipe;
1175         urb->setup_packet = setup_packet;
1176         urb->transfer_buffer = transfer_buffer;
1177         urb->transfer_buffer_length = buffer_length;
1178         urb->complete = complete_fn;
1179         urb->context = context;
1180 }
1181
1182 /**
1183  * usb_fill_bulk_urb - macro to help initialize a bulk urb
1184  * @urb: pointer to the urb to initialize.
1185  * @dev: pointer to the struct usb_device for this urb.
1186  * @pipe: the endpoint pipe
1187  * @transfer_buffer: pointer to the transfer buffer
1188  * @buffer_length: length of the transfer buffer
1189  * @complete_fn: pointer to the usb_complete_t function
1190  * @context: what to set the urb context to.
1191  *
1192  * Initializes a bulk urb with the proper information needed to submit it
1193  * to a device.
1194  */
1195 static inline void usb_fill_bulk_urb (struct urb *urb,
1196                                       struct usb_device *dev,
1197                                       unsigned int pipe,
1198                                       void *transfer_buffer,
1199                                       int buffer_length,
1200                                       usb_complete_t complete_fn,
1201                                       void *context)
1202 {
1203         spin_lock_init(&urb->lock);
1204         urb->dev = dev;
1205         urb->pipe = pipe;
1206         urb->transfer_buffer = transfer_buffer;
1207         urb->transfer_buffer_length = buffer_length;
1208         urb->complete = complete_fn;
1209         urb->context = context;
1210 }
1211
1212 /**
1213  * usb_fill_int_urb - macro to help initialize a interrupt urb
1214  * @urb: pointer to the urb to initialize.
1215  * @dev: pointer to the struct usb_device for this urb.
1216  * @pipe: the endpoint pipe
1217  * @transfer_buffer: pointer to the transfer buffer
1218  * @buffer_length: length of the transfer buffer
1219  * @complete_fn: pointer to the usb_complete_t function
1220  * @context: what to set the urb context to.
1221  * @interval: what to set the urb interval to, encoded like
1222  *      the endpoint descriptor's bInterval value.
1223  *
1224  * Initializes a interrupt urb with the proper information needed to submit
1225  * it to a device.
1226  * Note that high speed interrupt endpoints use a logarithmic encoding of
1227  * the endpoint interval, and express polling intervals in microframes
1228  * (eight per millisecond) rather than in frames (one per millisecond).
1229  */
1230 static inline void usb_fill_int_urb (struct urb *urb,
1231                                      struct usb_device *dev,
1232                                      unsigned int pipe,
1233                                      void *transfer_buffer,
1234                                      int buffer_length,
1235                                      usb_complete_t complete_fn,
1236                                      void *context,
1237                                      int interval)
1238 {
1239         spin_lock_init(&urb->lock);
1240         urb->dev = dev;
1241         urb->pipe = pipe;
1242         urb->transfer_buffer = transfer_buffer;
1243         urb->transfer_buffer_length = buffer_length;
1244         urb->complete = complete_fn;
1245         urb->context = context;
1246         if (dev->speed == USB_SPEED_HIGH)
1247                 urb->interval = 1 << (interval - 1);
1248         else
1249                 urb->interval = interval;
1250         urb->start_frame = -1;
1251 }
1252
1253 extern void usb_init_urb(struct urb *urb);
1254 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
1255 extern void usb_free_urb(struct urb *urb);
1256 #define usb_put_urb usb_free_urb
1257 extern struct urb *usb_get_urb(struct urb *urb);
1258 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
1259 extern int usb_unlink_urb(struct urb *urb);
1260 extern void usb_kill_urb(struct urb *urb);
1261
1262 void *usb_buffer_alloc (struct usb_device *dev, size_t size,
1263         gfp_t mem_flags, dma_addr_t *dma);
1264 void usb_buffer_free (struct usb_device *dev, size_t size,
1265         void *addr, dma_addr_t dma);
1266
1267 #if 0
1268 struct urb *usb_buffer_map (struct urb *urb);
1269 void usb_buffer_dmasync (struct urb *urb);
1270 void usb_buffer_unmap (struct urb *urb);
1271 #endif
1272
1273 struct scatterlist;
1274 int usb_buffer_map_sg(const struct usb_device *dev, unsigned pipe,
1275                       struct scatterlist *sg, int nents);
1276 #if 0
1277 void usb_buffer_dmasync_sg(const struct usb_device *dev, unsigned pipe,
1278                            struct scatterlist *sg, int n_hw_ents);
1279 #endif
1280 void usb_buffer_unmap_sg(const struct usb_device *dev, unsigned pipe,
1281                          struct scatterlist *sg, int n_hw_ents);
1282
1283 /*-------------------------------------------------------------------*
1284  *                         SYNCHRONOUS CALL SUPPORT                  *
1285  *-------------------------------------------------------------------*/
1286
1287 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1288         __u8 request, __u8 requesttype, __u16 value, __u16 index,
1289         void *data, __u16 size, int timeout);
1290 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1291         void *data, int len, int *actual_length, int timeout);
1292 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1293         void *data, int len, int *actual_length,
1294         int timeout);
1295
1296 /* wrappers around usb_control_msg() for the most common standard requests */
1297 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1298         unsigned char descindex, void *buf, int size);
1299 extern int usb_get_status(struct usb_device *dev,
1300         int type, int target, void *data);
1301 extern int usb_string(struct usb_device *dev, int index,
1302         char *buf, size_t size);
1303
1304 /* wrappers that also update important state inside usbcore */
1305 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1306 extern int usb_reset_configuration(struct usb_device *dev);
1307 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1308
1309 /* this request isn't really synchronous, but it belongs with the others */
1310 extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1311
1312 /*
1313  * timeouts, in milliseconds, used for sending/receiving control messages
1314  * they typically complete within a few frames (msec) after they're issued
1315  * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1316  * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1317  */
1318 #define USB_CTRL_GET_TIMEOUT    5000
1319 #define USB_CTRL_SET_TIMEOUT    5000
1320
1321
1322 /**
1323  * struct usb_sg_request - support for scatter/gather I/O
1324  * @status: zero indicates success, else negative errno
1325  * @bytes: counts bytes transferred.
1326  *
1327  * These requests are initialized using usb_sg_init(), and then are used
1328  * as request handles passed to usb_sg_wait() or usb_sg_cancel().  Most
1329  * members of the request object aren't for driver access.
1330  *
1331  * The status and bytecount values are valid only after usb_sg_wait()
1332  * returns.  If the status is zero, then the bytecount matches the total
1333  * from the request.
1334  *
1335  * After an error completion, drivers may need to clear a halt condition
1336  * on the endpoint.
1337  */
1338 struct usb_sg_request {
1339         int                     status;
1340         size_t                  bytes;
1341
1342         /*
1343          * members below are private: to usbcore,
1344          * and are not provided for driver access!
1345          */
1346         spinlock_t              lock;
1347
1348         struct usb_device       *dev;
1349         int                     pipe;
1350         struct scatterlist      *sg;
1351         int                     nents;
1352
1353         int                     entries;
1354         struct urb              **urbs;
1355
1356         int                     count;
1357         struct completion       complete;
1358 };
1359
1360 int usb_sg_init (
1361         struct usb_sg_request   *io,
1362         struct usb_device       *dev,
1363         unsigned                pipe,
1364         unsigned                period,
1365         struct scatterlist      *sg,
1366         int                     nents,
1367         size_t                  length,
1368         gfp_t                   mem_flags
1369 );
1370 void usb_sg_cancel (struct usb_sg_request *io);
1371 void usb_sg_wait (struct usb_sg_request *io);
1372
1373
1374 /* ----------------------------------------------------------------------- */
1375
1376 /*
1377  * For various legacy reasons, Linux has a small cookie that's paired with
1378  * a struct usb_device to identify an endpoint queue.  Queue characteristics
1379  * are defined by the endpoint's descriptor.  This cookie is called a "pipe",
1380  * an unsigned int encoded as:
1381  *
1382  *  - direction:        bit 7           (0 = Host-to-Device [Out],
1383  *                                       1 = Device-to-Host [In] ...
1384  *                                      like endpoint bEndpointAddress)
1385  *  - device address:   bits 8-14       ... bit positions known to uhci-hcd
1386  *  - endpoint:         bits 15-18      ... bit positions known to uhci-hcd
1387  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt,
1388  *                                       10 = control, 11 = bulk)
1389  *
1390  * Given the device address and endpoint descriptor, pipes are redundant.
1391  */
1392
1393 /* NOTE:  these are not the standard USB_ENDPOINT_XFER_* values!! */
1394 /* (yet ... they're the values used by usbfs) */
1395 #define PIPE_ISOCHRONOUS                0
1396 #define PIPE_INTERRUPT                  1
1397 #define PIPE_CONTROL                    2
1398 #define PIPE_BULK                       3
1399
1400 #define usb_pipein(pipe)        ((pipe) & USB_DIR_IN)
1401 #define usb_pipeout(pipe)       (!usb_pipein(pipe))
1402
1403 #define usb_pipedevice(pipe)    (((pipe) >> 8) & 0x7f)
1404 #define usb_pipeendpoint(pipe)  (((pipe) >> 15) & 0xf)
1405
1406 #define usb_pipetype(pipe)      (((pipe) >> 30) & 3)
1407 #define usb_pipeisoc(pipe)      (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1408 #define usb_pipeint(pipe)       (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1409 #define usb_pipecontrol(pipe)   (usb_pipetype((pipe)) == PIPE_CONTROL)
1410 #define usb_pipebulk(pipe)      (usb_pipetype((pipe)) == PIPE_BULK)
1411
1412 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1413 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1414 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << (ep)))
1415 #define usb_settoggle(dev, ep, out, bit) \
1416                 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1417                  ((bit) << (ep)))
1418
1419
1420 static inline unsigned int __create_pipe(struct usb_device *dev,
1421                 unsigned int endpoint)
1422 {
1423         return (dev->devnum << 8) | (endpoint << 15);
1424 }
1425
1426 /* Create various pipes... */
1427 #define usb_sndctrlpipe(dev,endpoint)   \
1428         ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1429 #define usb_rcvctrlpipe(dev,endpoint)   \
1430         ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1431 #define usb_sndisocpipe(dev,endpoint)   \
1432         ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1433 #define usb_rcvisocpipe(dev,endpoint)   \
1434         ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1435 #define usb_sndbulkpipe(dev,endpoint)   \
1436         ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1437 #define usb_rcvbulkpipe(dev,endpoint)   \
1438         ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1439 #define usb_sndintpipe(dev,endpoint)    \
1440         ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1441 #define usb_rcvintpipe(dev,endpoint)    \
1442         ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1443
1444 /*-------------------------------------------------------------------------*/
1445
1446 static inline __u16
1447 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1448 {
1449         struct usb_host_endpoint        *ep;
1450         unsigned                        epnum = usb_pipeendpoint(pipe);
1451
1452         if (is_out) {
1453                 WARN_ON(usb_pipein(pipe));
1454                 ep = udev->ep_out[epnum];
1455         } else {
1456                 WARN_ON(usb_pipeout(pipe));
1457                 ep = udev->ep_in[epnum];
1458         }
1459         if (!ep)
1460                 return 0;
1461
1462         /* NOTE:  only 0x07ff bits are for packet size... */
1463         return le16_to_cpu(ep->desc.wMaxPacketSize);
1464 }
1465
1466 /* ----------------------------------------------------------------------- */
1467
1468 /* Events from the usb core */
1469 #define USB_DEVICE_ADD          0x0001
1470 #define USB_DEVICE_REMOVE       0x0002
1471 #define USB_BUS_ADD             0x0003
1472 #define USB_BUS_REMOVE          0x0004
1473 extern void usb_register_notify(struct notifier_block *nb);
1474 extern void usb_unregister_notify(struct notifier_block *nb);
1475
1476 #ifdef DEBUG
1477 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1478         __FILE__ , ## arg)
1479 #else
1480 #define dbg(format, arg...) do {} while (0)
1481 #endif
1482
1483 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1484         __FILE__ , ## arg)
1485 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1486         __FILE__ , ## arg)
1487 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1488         __FILE__ , ## arg)
1489
1490
1491 #endif  /* __KERNEL__ */
1492
1493 #endif