4 #include <linux/mod_devicetable.h>
5 #include <linux/usb_ch9.h>
8 #define USB_DEVICE_MAJOR 189
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 */
26 /*-------------------------------------------------------------------------*/
29 * Host-side wrappers for standard USB descriptors ... these are parsed
30 * from the data provided by devices. Parsing turns them from a flat
31 * sequence of descriptors into a hierarchy:
33 * - devices have one (usually) or more configs;
34 * - configs have one (often) or more interfaces;
35 * - interfaces have one (usually) or more settings;
36 * - each interface setting has zero or (usually) more endpoints.
38 * And there might be other descriptors mixed in with those.
40 * Devices may also have class-specific or vendor-specific descriptors.
44 * struct usb_host_endpoint - host-side endpoint descriptor and queue
45 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
46 * @urb_list: urbs queued to this endpoint; maintained by usbcore
47 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
48 * with one or more transfer descriptors (TDs) per urb
49 * @kobj: kobject for sysfs info
50 * @extra: descriptors following this endpoint in the configuration
51 * @extralen: how many bytes of "extra" are valid
53 * USB requests are always queued to a given endpoint, identified by a
54 * descriptor within an active interface in a given USB configuration.
56 struct usb_host_endpoint {
57 struct usb_endpoint_descriptor desc;
58 struct list_head urb_list;
60 struct kobject *kobj; /* For sysfs info */
62 unsigned char *extra; /* Extra descriptors */
66 /* host-side wrapper for one interface setting's parsed descriptors */
67 struct usb_host_interface {
68 struct usb_interface_descriptor desc;
70 /* array of desc.bNumEndpoint endpoints associated with this
71 * interface setting. these will be in no particular order.
73 struct usb_host_endpoint *endpoint;
75 char *string; /* iInterface string, if present */
76 unsigned char *extra; /* Extra descriptors */
80 enum usb_interface_condition {
81 USB_INTERFACE_UNBOUND = 0,
82 USB_INTERFACE_BINDING,
84 USB_INTERFACE_UNBINDING,
88 * struct usb_interface - what usb device drivers talk to
89 * @altsetting: array of interface structures, one for each alternate
90 * setting that may be selected. Each one includes a set of
91 * endpoint configurations. They will be in no particular order.
92 * @num_altsetting: number of altsettings defined.
93 * @cur_altsetting: the current altsetting.
94 * @driver: the USB driver that is bound to this interface.
95 * @minor: the minor number assigned to this interface, if this
96 * interface is bound to a driver that uses the USB major number.
97 * If this interface does not use the USB major, this field should
98 * be unused. The driver should set this value in the probe()
99 * function of the driver, after it has been assigned a minor
100 * number from the USB core by calling usb_register_dev().
101 * @condition: binding state of the interface: not bound, binding
102 * (in probe()), bound to a driver, or unbinding (in disconnect())
103 * @dev: driver model's view of this device
104 * @class_dev: driver model's class view of this device.
106 * USB device drivers attach to interfaces on a physical device. Each
107 * interface encapsulates a single high level function, such as feeding
108 * an audio stream to a speaker or reporting a change in a volume control.
109 * Many USB devices only have one interface. The protocol used to talk to
110 * an interface's endpoints can be defined in a usb "class" specification,
111 * or by a product's vendor. The (default) control endpoint is part of
112 * every interface, but is never listed among the interface's descriptors.
114 * The driver that is bound to the interface can use standard driver model
115 * calls such as dev_get_drvdata() on the dev member of this structure.
117 * Each interface may have alternate settings. The initial configuration
118 * of a device sets altsetting 0, but the device driver can change
119 * that setting using usb_set_interface(). Alternate settings are often
120 * used to control the the use of periodic endpoints, such as by having
121 * different endpoints use different amounts of reserved USB bandwidth.
122 * All standards-conformant USB devices that use isochronous endpoints
123 * will use them in non-default settings.
125 * The USB specification says that alternate setting numbers must run from
126 * 0 to one less than the total number of alternate settings. But some
127 * devices manage to mess this up, and the structures aren't necessarily
128 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
129 * look up an alternate setting in the altsetting array based on its number.
131 struct usb_interface {
132 /* array of alternate settings for this interface,
133 * stored in no particular order */
134 struct usb_host_interface *altsetting;
136 struct usb_host_interface *cur_altsetting; /* the currently
137 * active alternate setting */
138 unsigned num_altsetting; /* number of alternate settings */
140 int minor; /* minor number this interface is
142 enum usb_interface_condition condition; /* state of binding */
143 struct device dev; /* interface specific device info */
144 struct class_device *class_dev;
146 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
147 #define interface_to_usbdev(intf) \
148 container_of(intf->dev.parent, struct usb_device, dev)
150 static inline void *usb_get_intfdata (struct usb_interface *intf)
152 return dev_get_drvdata (&intf->dev);
155 static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
157 dev_set_drvdata(&intf->dev, data);
160 struct usb_interface *usb_get_intf(struct usb_interface *intf);
161 void usb_put_intf(struct usb_interface *intf);
163 /* this maximum is arbitrary */
164 #define USB_MAXINTERFACES 32
167 * struct usb_interface_cache - long-term representation of a device interface
168 * @num_altsetting: number of altsettings defined.
169 * @ref: reference counter.
170 * @altsetting: variable-length array of interface structures, one for
171 * each alternate setting that may be selected. Each one includes a
172 * set of endpoint configurations. They will be in no particular order.
174 * These structures persist for the lifetime of a usb_device, unlike
175 * struct usb_interface (which persists only as long as its configuration
176 * is installed). The altsetting arrays can be accessed through these
177 * structures at any time, permitting comparison of configurations and
178 * providing support for the /proc/bus/usb/devices pseudo-file.
180 struct usb_interface_cache {
181 unsigned num_altsetting; /* number of alternate settings */
182 struct kref ref; /* reference counter */
184 /* variable-length array of alternate settings for this interface,
185 * stored in no particular order */
186 struct usb_host_interface altsetting[0];
188 #define ref_to_usb_interface_cache(r) \
189 container_of(r, struct usb_interface_cache, ref)
190 #define altsetting_to_usb_interface_cache(a) \
191 container_of(a, struct usb_interface_cache, altsetting[0])
194 * struct usb_host_config - representation of a device's configuration
195 * @desc: the device's configuration descriptor.
196 * @string: pointer to the cached version of the iConfiguration string, if
197 * present for this configuration.
198 * @interface: array of pointers to usb_interface structures, one for each
199 * interface in the configuration. The number of interfaces is stored
200 * in desc.bNumInterfaces. These pointers are valid only while the
201 * the configuration is active.
202 * @intf_cache: array of pointers to usb_interface_cache structures, one
203 * for each interface in the configuration. These structures exist
204 * for the entire life of the device.
205 * @extra: pointer to buffer containing all extra descriptors associated
206 * with this configuration (those preceding the first interface
208 * @extralen: length of the extra descriptors buffer.
210 * USB devices may have multiple configurations, but only one can be active
211 * at any time. Each encapsulates a different operational environment;
212 * for example, a dual-speed device would have separate configurations for
213 * full-speed and high-speed operation. The number of configurations
214 * available is stored in the device descriptor as bNumConfigurations.
216 * A configuration can contain multiple interfaces. Each corresponds to
217 * a different function of the USB device, and all are available whenever
218 * the configuration is active. The USB standard says that interfaces
219 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
220 * of devices get this wrong. In addition, the interface array is not
221 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
222 * look up an interface entry based on its number.
224 * Device drivers should not attempt to activate configurations. The choice
225 * of which configuration to install is a policy decision based on such
226 * considerations as available power, functionality provided, and the user's
227 * desires (expressed through userspace tools). However, drivers can call
228 * usb_reset_configuration() to reinitialize the current configuration and
229 * all its interfaces.
231 struct usb_host_config {
232 struct usb_config_descriptor desc;
234 char *string; /* iConfiguration string, if present */
235 /* the interfaces associated with this configuration,
236 * stored in no particular order */
237 struct usb_interface *interface[USB_MAXINTERFACES];
239 /* Interface information available even when this is not the
240 * active configuration */
241 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
243 unsigned char *extra; /* Extra descriptors */
247 int __usb_get_extra_descriptor(char *buffer, unsigned size,
248 unsigned char type, void **ptr);
249 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
250 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
253 /* ----------------------------------------------------------------------- */
255 struct usb_operations;
257 /* USB device number allocation bitmap */
259 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
263 * Allocated per bus (tree of devices) we have:
266 struct device *controller; /* host/master side hardware */
267 int busnum; /* Bus number (in order of reg) */
268 char *bus_name; /* stable id (PCI slot_name etc) */
269 u8 otg_port; /* 0, or number of OTG/HNP port */
270 unsigned is_b_host:1; /* true during some HNP roleswitches */
271 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
273 int devnum_next; /* Next open device number in
274 * round-robin allocation */
276 struct usb_devmap devmap; /* device address allocation map */
277 struct usb_operations *op; /* Operations (specific to the HC) */
278 struct usb_device *root_hub; /* Root hub */
279 struct list_head bus_list; /* list of busses */
280 void *hcpriv; /* Host Controller private data */
282 int bandwidth_allocated; /* on this bus: how much of the time
283 * reserved for periodic (intr/iso)
284 * requests is used, on average?
285 * Units: microseconds/frame.
286 * Limits: Full/low speed reserve 90%,
287 * while high speed reserves 80%.
289 int bandwidth_int_reqs; /* number of Interrupt requests */
290 int bandwidth_isoc_reqs; /* number of Isoc. requests */
292 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
294 struct class_device *class_dev; /* class device for this bus */
295 struct kref kref; /* reference counting for this bus */
296 void (*release)(struct usb_bus *bus);
298 #if defined(CONFIG_USB_MON)
299 struct mon_bus *mon_bus; /* non-null when associated */
300 int monitored; /* non-zero when monitored */
304 /* ----------------------------------------------------------------------- */
306 /* This is arbitrary.
307 * From USB 2.0 spec Table 11-13, offset 7, a hub can
308 * have up to 255 ports. The most yet reported is 10.
310 #define USB_MAXCHILDREN (16)
315 * struct usb_device - kernel's representation of a USB device
317 * FIXME: Write the kerneldoc!
319 * Usbcore drivers should not set usbdev->state directly. Instead use
320 * usb_set_device_state().
323 int devnum; /* Address on USB bus */
324 char devpath [16]; /* Use in messages: /port/port/... */
325 enum usb_device_state state; /* configured, not attached, etc */
326 enum usb_device_speed speed; /* high/full/low (or error) */
328 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
329 int ttport; /* device port on that tt hub */
331 unsigned int toggle[2]; /* one bit for each endpoint
332 * ([0] = IN, [1] = OUT) */
334 struct usb_device *parent; /* our hub, unless we're the root */
335 struct usb_bus *bus; /* Bus we're part of */
336 struct usb_host_endpoint ep0;
338 struct device dev; /* Generic device interface */
340 struct usb_device_descriptor descriptor;/* Descriptor */
341 struct usb_host_config *config; /* All of the configs */
343 struct usb_host_config *actconfig;/* the active configuration */
344 struct usb_host_endpoint *ep_in[16];
345 struct usb_host_endpoint *ep_out[16];
347 char **rawdescriptors; /* Raw descriptors for each config */
349 unsigned short bus_mA; /* Current available from the bus */
350 u8 portnum; /* Parent port number (origin 1) */
352 int have_langid; /* whether string_langid is valid */
353 int string_langid; /* language ID for strings */
355 /* static strings from the device */
356 char *product; /* iProduct string, if present */
357 char *manufacturer; /* iManufacturer string, if present */
358 char *serial; /* iSerialNumber string, if present */
360 struct list_head filelist;
361 struct class_device *class_dev;
362 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
365 * Child devices - these can be either new devices
366 * (if this is a hub device), or different instances
367 * of this same device.
369 * Each instance needs its own set of data structures.
372 int maxchild; /* Number of ports if hub */
373 struct usb_device *children[USB_MAXCHILDREN];
375 #define to_usb_device(d) container_of(d, struct usb_device, dev)
377 extern struct usb_device *usb_get_dev(struct usb_device *dev);
378 extern void usb_put_dev(struct usb_device *dev);
380 /* USB device locking */
381 #define usb_lock_device(udev) down(&(udev)->dev.sem)
382 #define usb_unlock_device(udev) up(&(udev)->dev.sem)
383 #define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
384 extern int usb_lock_device_for_reset(struct usb_device *udev,
385 struct usb_interface *iface);
387 /* USB port reset for device reinitialization */
388 extern int usb_reset_device(struct usb_device *dev);
389 extern int usb_reset_composite_device(struct usb_device *dev,
390 struct usb_interface *iface);
392 extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
394 /*-------------------------------------------------------------------------*/
396 /* for drivers using iso endpoints */
397 extern int usb_get_current_frame_number (struct usb_device *usb_dev);
399 /* used these for multi-interface device registration */
400 extern int usb_driver_claim_interface(struct usb_driver *driver,
401 struct usb_interface *iface, void* priv);
404 * usb_interface_claimed - returns true iff an interface is claimed
405 * @iface: the interface being checked
407 * Returns true (nonzero) iff the interface is claimed, else false (zero).
408 * Callers must own the driver model's usb bus readlock. So driver
409 * probe() entries don't need extra locking, but other call contexts
410 * may need to explicitly claim that lock.
413 static inline int usb_interface_claimed(struct usb_interface *iface) {
414 return (iface->dev.driver != NULL);
417 extern void usb_driver_release_interface(struct usb_driver *driver,
418 struct usb_interface *iface);
419 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
420 const struct usb_device_id *id);
422 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
424 extern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev,
426 extern struct usb_host_interface *usb_altnum_to_altsetting(
427 struct usb_interface *intf, unsigned int altnum);
431 * usb_make_path - returns stable device path in the usb tree
432 * @dev: the device whose path is being constructed
433 * @buf: where to put the string
434 * @size: how big is "buf"?
436 * Returns length of the string (> 0) or negative if size was too small.
438 * This identifier is intended to be "stable", reflecting physical paths in
439 * hardware such as physical bus addresses for host controllers or ports on
440 * USB hubs. That makes it stay the same until systems are physically
441 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
442 * controllers. Adding and removing devices, including virtual root hubs
443 * in host controller driver modules, does not change these path identifers;
444 * neither does rebooting or re-enumerating. These are more useful identifiers
445 * than changeable ("unstable") ones like bus numbers or device addresses.
447 * With a partial exception for devices connected to USB 2.0 root hubs, these
448 * identifiers are also predictable. So long as the device tree isn't changed,
449 * plugging any USB device into a given hub port always gives it the same path.
450 * Because of the use of "companion" controllers, devices connected to ports on
451 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
452 * high speed, and a different one if they are full or low speed.
454 static inline int usb_make_path (struct usb_device *dev, char *buf,
458 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
460 return (actual >= (int)size) ? -1 : actual;
463 /*-------------------------------------------------------------------------*/
465 #define USB_DEVICE_ID_MATCH_DEVICE \
466 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
467 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
468 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
469 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
470 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
471 #define USB_DEVICE_ID_MATCH_DEV_INFO \
472 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
473 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
474 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
475 #define USB_DEVICE_ID_MATCH_INT_INFO \
476 (USB_DEVICE_ID_MATCH_INT_CLASS | \
477 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
478 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
481 * USB_DEVICE - macro used to describe a specific usb device
482 * @vend: the 16 bit USB Vendor ID
483 * @prod: the 16 bit USB Product ID
485 * This macro is used to create a struct usb_device_id that matches a
488 #define USB_DEVICE(vend,prod) \
489 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
492 * USB_DEVICE_VER - macro used to describe a specific usb device with a
494 * @vend: the 16 bit USB Vendor ID
495 * @prod: the 16 bit USB Product ID
496 * @lo: the bcdDevice_lo value
497 * @hi: the bcdDevice_hi value
499 * This macro is used to create a struct usb_device_id that matches a
500 * specific device, with a version range.
502 #define USB_DEVICE_VER(vend,prod,lo,hi) \
503 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
504 .idVendor = (vend), .idProduct = (prod), \
505 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
508 * USB_DEVICE_INFO - macro used to describe a class of usb devices
509 * @cl: bDeviceClass value
510 * @sc: bDeviceSubClass value
511 * @pr: bDeviceProtocol value
513 * This macro is used to create a struct usb_device_id that matches a
514 * specific class of devices.
516 #define USB_DEVICE_INFO(cl,sc,pr) \
517 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
518 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
521 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
522 * @cl: bInterfaceClass value
523 * @sc: bInterfaceSubClass value
524 * @pr: bInterfaceProtocol value
526 * This macro is used to create a struct usb_device_id that matches a
527 * specific class of interfaces.
529 #define USB_INTERFACE_INFO(cl,sc,pr) \
530 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
531 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
533 /* ----------------------------------------------------------------------- */
537 struct list_head list;
541 * struct usb_driver - identifies USB driver to usbcore
542 * @name: The driver name should be unique among USB drivers,
543 * and should normally be the same as the module name.
544 * @probe: Called to see if the driver is willing to manage a particular
545 * interface on a device. If it is, probe returns zero and uses
546 * dev_set_drvdata() to associate driver-specific data with the
547 * interface. It may also use usb_set_interface() to specify the
548 * appropriate altsetting. If unwilling to manage the interface,
549 * return a negative errno value.
550 * @disconnect: Called when the interface is no longer accessible, usually
551 * because its device has been (or is being) disconnected or the
552 * driver module is being unloaded.
553 * @ioctl: Used for drivers that want to talk to userspace through
554 * the "usbfs" filesystem. This lets devices provide ways to
555 * expose information to user space regardless of where they
556 * do (or don't) show up otherwise in the filesystem.
557 * @suspend: Called when the device is going to be suspended by the system.
558 * @resume: Called when the device is being resumed by the system.
559 * @pre_reset: Called by usb_reset_composite_device() when the device
560 * is about to be reset.
561 * @post_reset: Called by usb_reset_composite_device() after the device
563 * @id_table: USB drivers use ID table to support hotplugging.
564 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
565 * or your driver's probe function will never get called.
566 * @dynids: used internally to hold the list of dynamically added device
567 * ids for this driver.
568 * @driver: the driver model core driver structure.
569 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
570 * added to this driver by preventing the sysfs file from being created.
572 * USB drivers must provide a name, probe() and disconnect() methods,
573 * and an id_table. Other driver fields are optional.
575 * The id_table is used in hotplugging. It holds a set of descriptors,
576 * and specialized data may be associated with each entry. That table
577 * is used by both user and kernel mode hotplugging support.
579 * The probe() and disconnect() methods are called in a context where
580 * they can sleep, but they should avoid abusing the privilege. Most
581 * work to connect to a device should be done when the device is opened,
582 * and undone at the last close. The disconnect code needs to address
583 * concurrency issues with respect to open() and close() methods, as
584 * well as forcing all pending I/O requests to complete (by unlinking
585 * them as necessary, and blocking until the unlinks complete).
590 int (*probe) (struct usb_interface *intf,
591 const struct usb_device_id *id);
593 void (*disconnect) (struct usb_interface *intf);
595 int (*ioctl) (struct usb_interface *intf, unsigned int code,
598 int (*suspend) (struct usb_interface *intf, pm_message_t message);
599 int (*resume) (struct usb_interface *intf);
601 void (*pre_reset) (struct usb_interface *intf);
602 void (*post_reset) (struct usb_interface *intf);
604 const struct usb_device_id *id_table;
606 struct usb_dynids dynids;
607 struct device_driver driver;
608 unsigned int no_dynamic_id:1;
610 #define to_usb_driver(d) container_of(d, struct usb_driver, driver)
612 extern struct bus_type usb_bus_type;
615 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
616 * @name: the usb class device name for this driver. Will show up in sysfs.
617 * @fops: pointer to the struct file_operations of this driver.
618 * @minor_base: the start of the minor range for this driver.
620 * This structure is used for the usb_register_dev() and
621 * usb_unregister_dev() functions, to consolidate a number of the
622 * parameters used for them.
624 struct usb_class_driver {
626 const struct file_operations *fops;
631 * use these in module_init()/module_exit()
632 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
634 int usb_register_driver(struct usb_driver *, struct module *);
635 static inline int usb_register(struct usb_driver *driver)
637 return usb_register_driver(driver, THIS_MODULE);
639 extern void usb_deregister(struct usb_driver *);
641 extern int usb_register_dev(struct usb_interface *intf,
642 struct usb_class_driver *class_driver);
643 extern void usb_deregister_dev(struct usb_interface *intf,
644 struct usb_class_driver *class_driver);
646 extern int usb_disabled(void);
648 /* ----------------------------------------------------------------------- */
651 * URB support, for asynchronous request completions
655 * urb->transfer_flags:
657 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
658 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
660 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
661 #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
662 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
663 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
664 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
667 struct usb_iso_packet_descriptor {
669 unsigned int length; /* expected length */
670 unsigned int actual_length;
677 typedef void (*usb_complete_t)(struct urb *, struct pt_regs *);
680 * struct urb - USB Request Block
681 * @urb_list: For use by current owner of the URB.
682 * @pipe: Holds endpoint number, direction, type, and more.
683 * Create these values with the eight macros available;
684 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
685 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
686 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
687 * numbers range from zero to fifteen. Note that "in" endpoint two
688 * is a different endpoint (and pipe) from "out" endpoint two.
689 * The current configuration controls the existence, type, and
690 * maximum packet size of any given endpoint.
691 * @dev: Identifies the USB device to perform the request.
692 * @status: This is read in non-iso completion functions to get the
693 * status of the particular request. ISO requests only use it
694 * to tell whether the URB was unlinked; detailed status for
695 * each frame is in the fields of the iso_frame-desc.
696 * @transfer_flags: A variety of flags may be used to affect how URB
697 * submission, unlinking, or operation are handled. Different
698 * kinds of URB can use different flags.
699 * @transfer_buffer: This identifies the buffer to (or from) which
700 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
701 * is set). This buffer must be suitable for DMA; allocate it with
702 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
703 * of this buffer will be modified. This buffer is used for the data
704 * stage of control transfers.
705 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
706 * the device driver is saying that it provided this DMA address,
707 * which the host controller driver should use in preference to the
709 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
710 * be broken up into chunks according to the current maximum packet
711 * size for the endpoint, which is a function of the configuration
712 * and is encoded in the pipe. When the length is zero, neither
713 * transfer_buffer nor transfer_dma is used.
714 * @actual_length: This is read in non-iso completion functions, and
715 * it tells how many bytes (out of transfer_buffer_length) were
716 * transferred. It will normally be the same as requested, unless
717 * either an error was reported or a short read was performed.
718 * The URB_SHORT_NOT_OK transfer flag may be used to make such
719 * short reads be reported as errors.
720 * @setup_packet: Only used for control transfers, this points to eight bytes
721 * of setup data. Control transfers always start by sending this data
722 * to the device. Then transfer_buffer is read or written, if needed.
723 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
724 * device driver has provided this DMA address for the setup packet.
725 * The host controller driver should use this in preference to
727 * @start_frame: Returns the initial frame for isochronous transfers.
728 * @number_of_packets: Lists the number of ISO transfer buffers.
729 * @interval: Specifies the polling interval for interrupt or isochronous
730 * transfers. The units are frames (milliseconds) for for full and low
731 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
732 * @error_count: Returns the number of ISO transfers that reported errors.
733 * @context: For use in completion functions. This normally points to
734 * request-specific driver context.
735 * @complete: Completion handler. This URB is passed as the parameter to the
736 * completion function. The completion function may then do what
737 * it likes with the URB, including resubmitting or freeing it.
738 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
739 * collect the transfer status for each buffer.
741 * This structure identifies USB transfer requests. URBs must be allocated by
742 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
743 * Initialization may be done using various usb_fill_*_urb() functions. URBs
744 * are submitted using usb_submit_urb(), and pending requests may be canceled
745 * using usb_unlink_urb() or usb_kill_urb().
747 * Data Transfer Buffers:
749 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
750 * taken from the general page pool. That is provided by transfer_buffer
751 * (control requests also use setup_packet), and host controller drivers
752 * perform a dma mapping (and unmapping) for each buffer transferred. Those
753 * mapping operations can be expensive on some platforms (perhaps using a dma
754 * bounce buffer or talking to an IOMMU),
755 * although they're cheap on commodity x86 and ppc hardware.
757 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
758 * which tell the host controller driver that no such mapping is needed since
759 * the device driver is DMA-aware. For example, a device driver might
760 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
761 * When these transfer flags are provided, host controller drivers will
762 * attempt to use the dma addresses found in the transfer_dma and/or
763 * setup_dma fields rather than determining a dma address themselves. (Note
764 * that transfer_buffer and setup_packet must still be set because not all
765 * host controllers use DMA, nor do virtual root hubs).
769 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
770 * zero), and complete fields. All URBs must also initialize
771 * transfer_buffer and transfer_buffer_length. They may provide the
772 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
773 * to be treated as errors; that flag is invalid for write requests.
776 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
777 * should always terminate with a short packet, even if it means adding an
778 * extra zero length packet.
780 * Control URBs must provide a setup_packet. The setup_packet and
781 * transfer_buffer may each be mapped for DMA or not, independently of
782 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
783 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
784 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
786 * Interrupt URBs must provide an interval, saying how often (in milliseconds
787 * or, for highspeed devices, 125 microsecond units)
788 * to poll for transfers. After the URB has been submitted, the interval
789 * field reflects how the transfer was actually scheduled.
790 * The polling interval may be more frequent than requested.
791 * For example, some controllers have a maximum interval of 32 milliseconds,
792 * while others support intervals of up to 1024 milliseconds.
793 * Isochronous URBs also have transfer intervals. (Note that for isochronous
794 * endpoints, as well as high speed interrupt endpoints, the encoding of
795 * the transfer interval in the endpoint descriptor is logarithmic.
796 * Device drivers must convert that value to linear units themselves.)
798 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
799 * the host controller to schedule the transfer as soon as bandwidth
800 * utilization allows, and then set start_frame to reflect the actual frame
801 * selected during submission. Otherwise drivers must specify the start_frame
802 * and handle the case where the transfer can't begin then. However, drivers
803 * won't know how bandwidth is currently allocated, and while they can
804 * find the current frame using usb_get_current_frame_number () they can't
805 * know the range for that frame number. (Ranges for frame counter values
806 * are HC-specific, and can go from 256 to 65536 frames from "now".)
808 * Isochronous URBs have a different data transfer model, in part because
809 * the quality of service is only "best effort". Callers provide specially
810 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
811 * at the end. Each such packet is an individual ISO transfer. Isochronous
812 * URBs are normally queued, submitted by drivers to arrange that
813 * transfers are at least double buffered, and then explicitly resubmitted
814 * in completion handlers, so
815 * that data (such as audio or video) streams at as constant a rate as the
816 * host controller scheduler can support.
818 * Completion Callbacks:
820 * The completion callback is made in_interrupt(), and one of the first
821 * things that a completion handler should do is check the status field.
822 * The status field is provided for all URBs. It is used to report
823 * unlinked URBs, and status for all non-ISO transfers. It should not
824 * be examined before the URB is returned to the completion handler.
826 * The context field is normally used to link URBs back to the relevant
827 * driver or request state.
829 * When the completion callback is invoked for non-isochronous URBs, the
830 * actual_length field tells how many bytes were transferred. This field
831 * is updated even when the URB terminated with an error or was unlinked.
833 * ISO transfer status is reported in the status and actual_length fields
834 * of the iso_frame_desc array, and the number of errors is reported in
835 * error_count. Completion callbacks for ISO transfers will normally
836 * (re)submit URBs to ensure a constant transfer rate.
838 * Note that even fields marked "public" should not be touched by the driver
839 * when the urb is owned by the hcd, that is, since the call to
840 * usb_submit_urb() till the entry into the completion routine.
844 /* private: usb core and host controller only fields in the urb */
845 struct kref kref; /* reference count of the URB */
846 spinlock_t lock; /* lock for the URB */
847 void *hcpriv; /* private data for host controller */
848 int bandwidth; /* bandwidth for INT/ISO request */
849 atomic_t use_count; /* concurrent submissions counter */
850 u8 reject; /* submissions will fail */
852 /* public: documented fields in the urb that can be used by drivers */
853 struct list_head urb_list; /* list head for use by the urb's
855 struct usb_device *dev; /* (in) pointer to associated device */
856 unsigned int pipe; /* (in) pipe information */
857 int status; /* (return) non-ISO status */
858 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
859 void *transfer_buffer; /* (in) associated data buffer */
860 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
861 int transfer_buffer_length; /* (in) data buffer length */
862 int actual_length; /* (return) actual transfer length */
863 unsigned char *setup_packet; /* (in) setup packet (control only) */
864 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
865 int start_frame; /* (modify) start frame (ISO) */
866 int number_of_packets; /* (in) number of ISO packets */
867 int interval; /* (modify) transfer interval
869 int error_count; /* (return) number of ISO errors */
870 void *context; /* (in) context for completion */
871 usb_complete_t complete; /* (in) completion routine */
872 struct usb_iso_packet_descriptor iso_frame_desc[0];
876 /* ----------------------------------------------------------------------- */
879 * usb_fill_control_urb - initializes a control urb
880 * @urb: pointer to the urb to initialize.
881 * @dev: pointer to the struct usb_device for this urb.
882 * @pipe: the endpoint pipe
883 * @setup_packet: pointer to the setup_packet buffer
884 * @transfer_buffer: pointer to the transfer buffer
885 * @buffer_length: length of the transfer buffer
886 * @complete: pointer to the usb_complete_t function
887 * @context: what to set the urb context to.
889 * Initializes a control urb with the proper information needed to submit
892 static inline void usb_fill_control_urb (struct urb *urb,
893 struct usb_device *dev,
895 unsigned char *setup_packet,
896 void *transfer_buffer,
898 usb_complete_t complete,
901 spin_lock_init(&urb->lock);
904 urb->setup_packet = setup_packet;
905 urb->transfer_buffer = transfer_buffer;
906 urb->transfer_buffer_length = buffer_length;
907 urb->complete = complete;
908 urb->context = context;
912 * usb_fill_bulk_urb - macro to help initialize a bulk urb
913 * @urb: pointer to the urb to initialize.
914 * @dev: pointer to the struct usb_device for this urb.
915 * @pipe: the endpoint pipe
916 * @transfer_buffer: pointer to the transfer buffer
917 * @buffer_length: length of the transfer buffer
918 * @complete: pointer to the usb_complete_t function
919 * @context: what to set the urb context to.
921 * Initializes a bulk urb with the proper information needed to submit it
924 static inline void usb_fill_bulk_urb (struct urb *urb,
925 struct usb_device *dev,
927 void *transfer_buffer,
929 usb_complete_t complete,
932 spin_lock_init(&urb->lock);
935 urb->transfer_buffer = transfer_buffer;
936 urb->transfer_buffer_length = buffer_length;
937 urb->complete = complete;
938 urb->context = context;
942 * usb_fill_int_urb - macro to help initialize a interrupt urb
943 * @urb: pointer to the urb to initialize.
944 * @dev: pointer to the struct usb_device for this urb.
945 * @pipe: the endpoint pipe
946 * @transfer_buffer: pointer to the transfer buffer
947 * @buffer_length: length of the transfer buffer
948 * @complete: pointer to the usb_complete_t function
949 * @context: what to set the urb context to.
950 * @interval: what to set the urb interval to, encoded like
951 * the endpoint descriptor's bInterval value.
953 * Initializes a interrupt urb with the proper information needed to submit
955 * Note that high speed interrupt endpoints use a logarithmic encoding of
956 * the endpoint interval, and express polling intervals in microframes
957 * (eight per millisecond) rather than in frames (one per millisecond).
959 static inline void usb_fill_int_urb (struct urb *urb,
960 struct usb_device *dev,
962 void *transfer_buffer,
964 usb_complete_t complete,
968 spin_lock_init(&urb->lock);
971 urb->transfer_buffer = transfer_buffer;
972 urb->transfer_buffer_length = buffer_length;
973 urb->complete = complete;
974 urb->context = context;
975 if (dev->speed == USB_SPEED_HIGH)
976 urb->interval = 1 << (interval - 1);
978 urb->interval = interval;
979 urb->start_frame = -1;
982 extern void usb_init_urb(struct urb *urb);
983 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
984 extern void usb_free_urb(struct urb *urb);
985 #define usb_put_urb usb_free_urb
986 extern struct urb *usb_get_urb(struct urb *urb);
987 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
988 extern int usb_unlink_urb(struct urb *urb);
989 extern void usb_kill_urb(struct urb *urb);
991 #define HAVE_USB_BUFFERS
992 void *usb_buffer_alloc (struct usb_device *dev, size_t size,
993 gfp_t mem_flags, dma_addr_t *dma);
994 void usb_buffer_free (struct usb_device *dev, size_t size,
995 void *addr, dma_addr_t dma);
998 struct urb *usb_buffer_map (struct urb *urb);
999 void usb_buffer_dmasync (struct urb *urb);
1000 void usb_buffer_unmap (struct urb *urb);
1004 int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
1005 struct scatterlist *sg, int nents);
1007 void usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe,
1008 struct scatterlist *sg, int n_hw_ents);
1010 void usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe,
1011 struct scatterlist *sg, int n_hw_ents);
1013 /*-------------------------------------------------------------------*
1014 * SYNCHRONOUS CALL SUPPORT *
1015 *-------------------------------------------------------------------*/
1017 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1018 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1019 void *data, __u16 size, int timeout);
1020 extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1021 void *data, int len, int *actual_length, int timeout);
1022 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1023 void *data, int len, int *actual_length,
1026 /* wrappers around usb_control_msg() for the most common standard requests */
1027 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1028 unsigned char descindex, void *buf, int size);
1029 extern int usb_get_status(struct usb_device *dev,
1030 int type, int target, void *data);
1031 extern int usb_string(struct usb_device *dev, int index,
1032 char *buf, size_t size);
1034 /* wrappers that also update important state inside usbcore */
1035 extern int usb_clear_halt(struct usb_device *dev, int pipe);
1036 extern int usb_reset_configuration(struct usb_device *dev);
1037 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1040 * timeouts, in milliseconds, used for sending/receiving control messages
1041 * they typically complete within a few frames (msec) after they're issued
1042 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1043 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1045 #define USB_CTRL_GET_TIMEOUT 5000
1046 #define USB_CTRL_SET_TIMEOUT 5000
1050 * struct usb_sg_request - support for scatter/gather I/O
1051 * @status: zero indicates success, else negative errno
1052 * @bytes: counts bytes transferred.
1054 * These requests are initialized using usb_sg_init(), and then are used
1055 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1056 * members of the request object aren't for driver access.
1058 * The status and bytecount values are valid only after usb_sg_wait()
1059 * returns. If the status is zero, then the bytecount matches the total
1062 * After an error completion, drivers may need to clear a halt condition
1065 struct usb_sg_request {
1070 * members below are private: to usbcore,
1071 * and are not provided for driver access!
1075 struct usb_device *dev;
1077 struct scatterlist *sg;
1084 struct completion complete;
1088 struct usb_sg_request *io,
1089 struct usb_device *dev,
1092 struct scatterlist *sg,
1097 void usb_sg_cancel (struct usb_sg_request *io);
1098 void usb_sg_wait (struct usb_sg_request *io);
1101 /* ----------------------------------------------------------------------- */
1104 * For various legacy reasons, Linux has a small cookie that's paired with
1105 * a struct usb_device to identify an endpoint queue. Queue characteristics
1106 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1107 * an unsigned int encoded as:
1109 * - direction: bit 7 (0 = Host-to-Device [Out],
1110 * 1 = Device-to-Host [In] ...
1111 * like endpoint bEndpointAddress)
1112 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1113 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1114 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1115 * 10 = control, 11 = bulk)
1117 * Given the device address and endpoint descriptor, pipes are redundant.
1120 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1121 /* (yet ... they're the values used by usbfs) */
1122 #define PIPE_ISOCHRONOUS 0
1123 #define PIPE_INTERRUPT 1
1124 #define PIPE_CONTROL 2
1127 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1128 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1130 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1131 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1133 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1134 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1135 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1136 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1137 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1139 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1140 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1141 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
1142 #define usb_settoggle(dev, ep, out, bit) \
1143 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1147 static inline unsigned int __create_pipe(struct usb_device *dev,
1148 unsigned int endpoint)
1150 return (dev->devnum << 8) | (endpoint << 15);
1153 /* Create various pipes... */
1154 #define usb_sndctrlpipe(dev,endpoint) \
1155 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1156 #define usb_rcvctrlpipe(dev,endpoint) \
1157 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1158 #define usb_sndisocpipe(dev,endpoint) \
1159 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1160 #define usb_rcvisocpipe(dev,endpoint) \
1161 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1162 #define usb_sndbulkpipe(dev,endpoint) \
1163 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1164 #define usb_rcvbulkpipe(dev,endpoint) \
1165 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1166 #define usb_sndintpipe(dev,endpoint) \
1167 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1168 #define usb_rcvintpipe(dev,endpoint) \
1169 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1171 /*-------------------------------------------------------------------------*/
1174 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1176 struct usb_host_endpoint *ep;
1177 unsigned epnum = usb_pipeendpoint(pipe);
1180 WARN_ON(usb_pipein(pipe));
1181 ep = udev->ep_out[epnum];
1183 WARN_ON(usb_pipeout(pipe));
1184 ep = udev->ep_in[epnum];
1189 /* NOTE: only 0x07ff bits are for packet size... */
1190 return le16_to_cpu(ep->desc.wMaxPacketSize);
1193 /* ----------------------------------------------------------------------- */
1195 /* Events from the usb core */
1196 #define USB_DEVICE_ADD 0x0001
1197 #define USB_DEVICE_REMOVE 0x0002
1198 #define USB_BUS_ADD 0x0003
1199 #define USB_BUS_REMOVE 0x0004
1200 extern void usb_register_notify(struct notifier_block *nb);
1201 extern void usb_unregister_notify(struct notifier_block *nb);
1204 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1207 #define dbg(format, arg...) do {} while (0)
1210 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1212 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1214 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1218 #endif /* __KERNEL__ */