4 #include <linux/mod_devicetable.h>
5 #include <linux/usb_ch9.h>
12 #include <linux/config.h>
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.
43 /* host-side wrapper for parsed endpoint descriptors */
44 struct usb_host_endpoint {
45 struct usb_endpoint_descriptor desc;
47 unsigned char *extra; /* Extra descriptors */
51 /* host-side wrapper for one interface setting's parsed descriptors */
52 struct usb_host_interface {
53 struct usb_interface_descriptor desc;
55 /* array of desc.bNumEndpoint endpoints associated with this
56 * interface setting. these will be in no particular order.
58 struct usb_host_endpoint *endpoint;
60 unsigned char *extra; /* Extra descriptors */
64 enum usb_interface_condition {
65 USB_INTERFACE_UNBOUND = 0,
66 USB_INTERFACE_BINDING,
68 USB_INTERFACE_UNBINDING,
72 * struct usb_interface - what usb device drivers talk to
73 * @altsetting: array of interface structures, one for each alternate
74 * setting that may be selected. Each one includes a set of
75 * endpoint configurations. They will be in no particular order.
76 * @num_altsetting: number of altsettings defined.
77 * @cur_altsetting: the current altsetting.
78 * @driver: the USB driver that is bound to this interface.
79 * @minor: the minor number assigned to this interface, if this
80 * interface is bound to a driver that uses the USB major number.
81 * If this interface does not use the USB major, this field should
82 * be unused. The driver should set this value in the probe()
83 * function of the driver, after it has been assigned a minor
84 * number from the USB core by calling usb_register_dev().
85 * @condition: binding state of the interface: not bound, binding
86 * (in probe()), bound to a driver, or unbinding (in disconnect())
87 * @dev: driver model's view of this device
88 * @class_dev: driver model's class view of this device.
90 * USB device drivers attach to interfaces on a physical device. Each
91 * interface encapsulates a single high level function, such as feeding
92 * an audio stream to a speaker or reporting a change in a volume control.
93 * Many USB devices only have one interface. The protocol used to talk to
94 * an interface's endpoints can be defined in a usb "class" specification,
95 * or by a product's vendor. The (default) control endpoint is part of
96 * every interface, but is never listed among the interface's descriptors.
98 * The driver that is bound to the interface can use standard driver model
99 * calls such as dev_get_drvdata() on the dev member of this structure.
101 * Each interface may have alternate settings. The initial configuration
102 * of a device sets altsetting 0, but the device driver can change
103 * that setting using usb_set_interface(). Alternate settings are often
104 * used to control the the use of periodic endpoints, such as by having
105 * different endpoints use different amounts of reserved USB bandwidth.
106 * All standards-conformant USB devices that use isochronous endpoints
107 * will use them in non-default settings.
109 * The USB specification says that alternate setting numbers must run from
110 * 0 to one less than the total number of alternate settings. But some
111 * devices manage to mess this up, and the structures aren't necessarily
112 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
113 * look up an alternate setting in the altsetting array based on its number.
115 struct usb_interface {
116 /* array of alternate settings for this interface,
117 * stored in no particular order */
118 struct usb_host_interface *altsetting;
120 struct usb_host_interface *cur_altsetting; /* the currently
121 * active alternate setting */
122 unsigned num_altsetting; /* number of alternate settings */
124 int minor; /* minor number this interface is bound to */
125 enum usb_interface_condition condition; /* state of binding */
126 struct device dev; /* interface specific device info */
127 struct class_device *class_dev;
129 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
130 #define interface_to_usbdev(intf) \
131 container_of(intf->dev.parent, struct usb_device, dev)
133 static inline void *usb_get_intfdata (struct usb_interface *intf)
135 return dev_get_drvdata (&intf->dev);
138 static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
140 dev_set_drvdata(&intf->dev, data);
143 struct usb_interface *usb_get_intf(struct usb_interface *intf);
144 void usb_put_intf(struct usb_interface *intf);
146 /* this maximum is arbitrary */
147 #define USB_MAXINTERFACES 32
150 * struct usb_interface_cache - long-term representation of a device interface
151 * @num_altsetting: number of altsettings defined.
152 * @ref: reference counter.
153 * @altsetting: variable-length array of interface structures, one for
154 * each alternate setting that may be selected. Each one includes a
155 * set of endpoint configurations. They will be in no particular order.
157 * These structures persist for the lifetime of a usb_device, unlike
158 * struct usb_interface (which persists only as long as its configuration
159 * is installed). The altsetting arrays can be accessed through these
160 * structures at any time, permitting comparison of configurations and
161 * providing support for the /proc/bus/usb/devices pseudo-file.
163 struct usb_interface_cache {
164 unsigned num_altsetting; /* number of alternate settings */
165 struct kref ref; /* reference counter */
167 /* variable-length array of alternate settings for this interface,
168 * stored in no particular order */
169 struct usb_host_interface altsetting[0];
171 #define ref_to_usb_interface_cache(r) \
172 container_of(r, struct usb_interface_cache, ref)
173 #define altsetting_to_usb_interface_cache(a) \
174 container_of(a, struct usb_interface_cache, altsetting[0])
177 * struct usb_host_config - representation of a device's configuration
178 * @desc: the device's configuration descriptor.
179 * @interface: array of pointers to usb_interface structures, one for each
180 * interface in the configuration. The number of interfaces is stored
181 * in desc.bNumInterfaces. These pointers are valid only while the
182 * the configuration is active.
183 * @intf_cache: array of pointers to usb_interface_cache structures, one
184 * for each interface in the configuration. These structures exist
185 * for the entire life of the device.
186 * @extra: pointer to buffer containing all extra descriptors associated
187 * with this configuration (those preceding the first interface
189 * @extralen: length of the extra descriptors buffer.
191 * USB devices may have multiple configurations, but only one can be active
192 * at any time. Each encapsulates a different operational environment;
193 * for example, a dual-speed device would have separate configurations for
194 * full-speed and high-speed operation. The number of configurations
195 * available is stored in the device descriptor as bNumConfigurations.
197 * A configuration can contain multiple interfaces. Each corresponds to
198 * a different function of the USB device, and all are available whenever
199 * the configuration is active. The USB standard says that interfaces
200 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
201 * of devices get this wrong. In addition, the interface array is not
202 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
203 * look up an interface entry based on its number.
205 * Device drivers should not attempt to activate configurations. The choice
206 * of which configuration to install is a policy decision based on such
207 * considerations as available power, functionality provided, and the user's
208 * desires (expressed through hotplug scripts). However, drivers can call
209 * usb_reset_configuration() to reinitialize the current configuration and
210 * all its interfaces.
212 struct usb_host_config {
213 struct usb_config_descriptor desc;
215 /* the interfaces associated with this configuration,
216 * stored in no particular order */
217 struct usb_interface *interface[USB_MAXINTERFACES];
219 /* Interface information available even when this is not the
220 * active configuration */
221 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
223 unsigned char *extra; /* Extra descriptors */
227 // FIXME remove; exported only for drivers/usb/misc/auserwald.c
228 // prefer usb_device->epnum[0..31]
229 extern struct usb_endpoint_descriptor *
230 usb_epnum_to_ep_desc(struct usb_device *dev, unsigned epnum);
232 int __usb_get_extra_descriptor(char *buffer, unsigned size,
233 unsigned char type, void **ptr);
234 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
235 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
238 /* -------------------------------------------------------------------------- */
240 struct usb_operations;
242 /* USB device number allocation bitmap */
244 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
248 * Allocated per bus (tree of devices) we have:
251 struct device *controller; /* host/master side hardware */
252 int busnum; /* Bus number (in order of reg) */
253 char *bus_name; /* stable id (PCI slot_name etc) */
254 u8 otg_port; /* 0, or number of OTG/HNP port */
255 unsigned is_b_host:1; /* true during some HNP roleswitches */
256 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
258 int devnum_next; /* Next open device number in round-robin allocation */
260 struct usb_devmap devmap; /* device address allocation map */
261 struct usb_operations *op; /* Operations (specific to the HC) */
262 struct usb_device *root_hub; /* Root hub */
263 struct list_head bus_list; /* list of busses */
264 void *hcpriv; /* Host Controller private data */
266 int bandwidth_allocated; /* on this bus: how much of the time
267 * reserved for periodic (intr/iso)
268 * requests is used, on average?
269 * Units: microseconds/frame.
270 * Limits: Full/low speed reserve 90%,
271 * while high speed reserves 80%.
273 int bandwidth_int_reqs; /* number of Interrupt requests */
274 int bandwidth_isoc_reqs; /* number of Isoc. requests */
276 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
278 struct class_device class_dev; /* class device for this bus */
279 void (*release)(struct usb_bus *bus); /* function to destroy this bus's memory */
281 #define to_usb_bus(d) container_of(d, struct usb_bus, class_dev)
284 /* -------------------------------------------------------------------------- */
286 /* This is arbitrary.
287 * From USB 2.0 spec Table 11-13, offset 7, a hub can
288 * have up to 255 ports. The most yet reported is 10.
290 #define USB_MAXCHILDREN (16)
295 * struct usb_device - kernel's representation of a USB device
297 * FIXME: Write the kerneldoc!
299 * Usbcore drivers should not set usbdev->state directly. Instead use
300 * usb_set_device_state().
303 int devnum; /* Address on USB bus */
304 char devpath [16]; /* Use in messages: /port/port/... */
305 enum usb_device_state state; /* configured, not attached, etc */
306 enum usb_device_speed speed; /* high/full/low (or error) */
308 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
309 int ttport; /* device port on that tt hub */
311 struct semaphore serialize;
313 unsigned int toggle[2]; /* one bit for each endpoint ([0] = IN, [1] = OUT) */
314 int epmaxpacketin[16]; /* INput endpoint specific maximums */
315 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
317 struct usb_device *parent; /* our hub, unless we're the root */
318 struct usb_bus *bus; /* Bus we're part of */
320 struct device dev; /* Generic device interface */
322 struct usb_device_descriptor descriptor;/* Descriptor */
323 struct usb_host_config *config; /* All of the configs */
324 struct usb_host_config *actconfig;/* the active configuration */
326 char **rawdescriptors; /* Raw descriptors for each config */
328 int have_langid; /* whether string_langid is valid yet */
329 int string_langid; /* language ID for strings */
331 void *hcpriv; /* Host Controller private data */
333 struct list_head filelist;
334 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
337 * Child devices - these can be either new devices
338 * (if this is a hub device), or different instances
339 * of this same device.
341 * Each instance needs its own set of data structures.
344 int maxchild; /* Number of ports if hub */
345 struct usb_device *children[USB_MAXCHILDREN];
347 #define to_usb_device(d) container_of(d, struct usb_device, dev)
349 extern struct usb_device *usb_get_dev(struct usb_device *dev);
350 extern void usb_put_dev(struct usb_device *dev);
352 extern void usb_lock_device(struct usb_device *udev);
353 extern int usb_trylock_device(struct usb_device *udev);
354 extern int usb_lock_device_for_reset(struct usb_device *udev,
355 struct usb_interface *iface);
356 extern void usb_unlock_device(struct usb_device *udev);
358 /* USB port reset for device reinitialization */
359 extern int usb_reset_device(struct usb_device *dev);
361 extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
363 /* for drivers using iso endpoints */
364 extern int usb_get_current_frame_number (struct usb_device *usb_dev);
366 /* used these for multi-interface device registration */
367 extern int usb_driver_claim_interface(struct usb_driver *driver,
368 struct usb_interface *iface, void* priv);
371 * usb_interface_claimed - returns true iff an interface is claimed
372 * @iface: the interface being checked
374 * Returns true (nonzero) iff the interface is claimed, else false (zero).
375 * Callers must own the driver model's usb bus readlock. So driver
376 * probe() entries don't need extra locking, but other call contexts
377 * may need to explicitly claim that lock.
380 static inline int usb_interface_claimed(struct usb_interface *iface) {
381 return (iface->dev.driver != NULL);
384 extern void usb_driver_release_interface(struct usb_driver *driver,
385 struct usb_interface *iface);
386 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
387 const struct usb_device_id *id);
389 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
391 extern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev,
393 extern struct usb_host_interface *usb_altnum_to_altsetting(
394 struct usb_interface *intf, unsigned int altnum);
398 * usb_make_path - returns stable device path in the usb tree
399 * @dev: the device whose path is being constructed
400 * @buf: where to put the string
401 * @size: how big is "buf"?
403 * Returns length of the string (> 0) or negative if size was too small.
405 * This identifier is intended to be "stable", reflecting physical paths in
406 * hardware such as physical bus addresses for host controllers or ports on
407 * USB hubs. That makes it stay the same until systems are physically
408 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
409 * controllers. Adding and removing devices, including virtual root hubs
410 * in host controller driver modules, does not change these path identifers;
411 * neither does rebooting or re-enumerating. These are more useful identifiers
412 * than changeable ("unstable") ones like bus numbers or device addresses.
414 * With a partial exception for devices connected to USB 2.0 root hubs, these
415 * identifiers are also predictable. So long as the device tree isn't changed,
416 * plugging any USB device into a given hub port always gives it the same path.
417 * Because of the use of "companion" controllers, devices connected to ports on
418 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
419 * high speed, and a different one if they are full or low speed.
421 static inline int usb_make_path (struct usb_device *dev, char *buf, size_t size)
424 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name, dev->devpath);
425 return (actual >= (int)size) ? -1 : actual;
428 /*-------------------------------------------------------------------------*/
430 #define USB_DEVICE_ID_MATCH_DEVICE (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
431 #define USB_DEVICE_ID_MATCH_DEV_RANGE (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
432 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
433 #define USB_DEVICE_ID_MATCH_DEV_INFO \
434 (USB_DEVICE_ID_MATCH_DEV_CLASS | USB_DEVICE_ID_MATCH_DEV_SUBCLASS | USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
435 #define USB_DEVICE_ID_MATCH_INT_INFO \
436 (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS | USB_DEVICE_ID_MATCH_INT_PROTOCOL)
439 * USB_DEVICE - macro used to describe a specific usb device
440 * @vend: the 16 bit USB Vendor ID
441 * @prod: the 16 bit USB Product ID
443 * This macro is used to create a struct usb_device_id that matches a
446 #define USB_DEVICE(vend,prod) \
447 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), .idProduct = (prod)
449 * USB_DEVICE_VER - macro used to describe a specific usb device with a version range
450 * @vend: the 16 bit USB Vendor ID
451 * @prod: the 16 bit USB Product ID
452 * @lo: the bcdDevice_lo value
453 * @hi: the bcdDevice_hi value
455 * This macro is used to create a struct usb_device_id that matches a
456 * specific device, with a version range.
458 #define USB_DEVICE_VER(vend,prod,lo,hi) \
459 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, .idVendor = (vend), .idProduct = (prod), .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
462 * USB_DEVICE_INFO - macro used to describe a class of usb devices
463 * @cl: bDeviceClass value
464 * @sc: bDeviceSubClass value
465 * @pr: bDeviceProtocol value
467 * This macro is used to create a struct usb_device_id that matches a
468 * specific class of devices.
470 #define USB_DEVICE_INFO(cl,sc,pr) \
471 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
474 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
475 * @cl: bInterfaceClass value
476 * @sc: bInterfaceSubClass value
477 * @pr: bInterfaceProtocol value
479 * This macro is used to create a struct usb_device_id that matches a
480 * specific class of interfaces.
482 #define USB_INTERFACE_INFO(cl,sc,pr) \
483 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
485 /* -------------------------------------------------------------------------- */
488 * struct usb_driver - identifies USB driver to usbcore
489 * @owner: Pointer to the module owner of this driver; initialize
490 * it using THIS_MODULE.
491 * @name: The driver name should be unique among USB drivers,
492 * and should normally be the same as the module name.
493 * @probe: Called to see if the driver is willing to manage a particular
494 * interface on a device. If it is, probe returns zero and uses
495 * dev_set_drvdata() to associate driver-specific data with the
496 * interface. It may also use usb_set_interface() to specify the
497 * appropriate altsetting. If unwilling to manage the interface,
498 * return a negative errno value.
499 * @disconnect: Called when the interface is no longer accessible, usually
500 * because its device has been (or is being) disconnected or the
501 * driver module is being unloaded.
502 * @ioctl: Used for drivers that want to talk to userspace through
503 * the "usbfs" filesystem. This lets devices provide ways to
504 * expose information to user space regardless of where they
505 * do (or don't) show up otherwise in the filesystem.
506 * @suspend: Called when the device is going to be suspended by the system.
507 * @resume: Called when the device is being resumed by the system.
508 * @id_table: USB drivers use ID table to support hotplugging.
509 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
510 * or your driver's probe function will never get called.
511 * @driver: the driver model core driver structure.
513 * USB drivers must provide a name, probe() and disconnect() methods,
514 * and an id_table. Other driver fields are optional.
516 * The id_table is used in hotplugging. It holds a set of descriptors,
517 * and specialized data may be associated with each entry. That table
518 * is used by both user and kernel mode hotplugging support.
520 * The probe() and disconnect() methods are called in a context where
521 * they can sleep, but they should avoid abusing the privilege. Most
522 * work to connect to a device should be done when the device is opened,
523 * and undone at the last close. The disconnect code needs to address
524 * concurrency issues with respect to open() and close() methods, as
525 * well as forcing all pending I/O requests to complete (by unlinking
526 * them as necessary, and blocking until the unlinks complete).
529 struct module *owner;
533 int (*probe) (struct usb_interface *intf,
534 const struct usb_device_id *id);
536 void (*disconnect) (struct usb_interface *intf);
538 int (*ioctl) (struct usb_interface *intf, unsigned int code, void *buf);
540 int (*suspend) (struct usb_interface *intf, u32 state);
541 int (*resume) (struct usb_interface *intf);
543 const struct usb_device_id *id_table;
545 struct device_driver driver;
547 #define to_usb_driver(d) container_of(d, struct usb_driver, driver)
549 extern struct bus_type usb_bus_type;
552 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
553 * @name: devfs name for this driver. Will also be used by the driver
554 * class code to create a usb class device.
555 * @fops: pointer to the struct file_operations of this driver.
556 * @mode: the mode for the devfs file to be created for this driver.
557 * @minor_base: the start of the minor range for this driver.
559 * This structure is used for the usb_register_dev() and
560 * usb_unregister_dev() functions, to consolidate a number of the
561 * parameters used for them.
563 struct usb_class_driver {
565 struct file_operations *fops;
571 * use these in module_init()/module_exit()
572 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
574 extern int usb_register(struct usb_driver *);
575 extern void usb_deregister(struct usb_driver *);
577 extern int usb_register_dev(struct usb_interface *intf,
578 struct usb_class_driver *class_driver);
579 extern void usb_deregister_dev(struct usb_interface *intf,
580 struct usb_class_driver *class_driver);
582 extern int usb_disabled(void);
584 /* -------------------------------------------------------------------------- */
587 * URB support, for asynchronous request completions
591 * urb->transfer_flags:
593 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
594 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame ignored */
595 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
596 #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
597 #define URB_ASYNC_UNLINK 0x0010 /* usb_unlink_urb() returns asap */
598 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
599 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUTs with short packet */
600 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt needed */
602 struct usb_iso_packet_descriptor {
604 unsigned int length; /* expected length */
605 unsigned int actual_length;
612 typedef void (*usb_complete_t)(struct urb *, struct pt_regs *);
615 * struct urb - USB Request Block
616 * @urb_list: For use by current owner of the URB.
617 * @pipe: Holds endpoint number, direction, type, and more.
618 * Create these values with the eight macros available;
619 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
620 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
621 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
622 * numbers range from zero to fifteen. Note that "in" endpoint two
623 * is a different endpoint (and pipe) from "out" endpoint two.
624 * The current configuration controls the existence, type, and
625 * maximum packet size of any given endpoint.
626 * @dev: Identifies the USB device to perform the request.
627 * @status: This is read in non-iso completion functions to get the
628 * status of the particular request. ISO requests only use it
629 * to tell whether the URB was unlinked; detailed status for
630 * each frame is in the fields of the iso_frame-desc.
631 * @transfer_flags: A variety of flags may be used to affect how URB
632 * submission, unlinking, or operation are handled. Different
633 * kinds of URB can use different flags.
634 * @transfer_buffer: This identifies the buffer to (or from) which
635 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
636 * is set). This buffer must be suitable for DMA; allocate it with
637 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
638 * of this buffer will be modified. This buffer is used for the data
639 * stage of control transfers.
640 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
641 * the device driver is saying that it provided this DMA address,
642 * which the host controller driver should use in preference to the
644 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
645 * be broken up into chunks according to the current maximum packet
646 * size for the endpoint, which is a function of the configuration
647 * and is encoded in the pipe. When the length is zero, neither
648 * transfer_buffer nor transfer_dma is used.
649 * @actual_length: This is read in non-iso completion functions, and
650 * it tells how many bytes (out of transfer_buffer_length) were
651 * transferred. It will normally be the same as requested, unless
652 * either an error was reported or a short read was performed.
653 * The URB_SHORT_NOT_OK transfer flag may be used to make such
654 * short reads be reported as errors.
655 * @setup_packet: Only used for control transfers, this points to eight bytes
656 * of setup data. Control transfers always start by sending this data
657 * to the device. Then transfer_buffer is read or written, if needed.
658 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
659 * device driver has provided this DMA address for the setup packet.
660 * The host controller driver should use this in preference to
662 * @start_frame: Returns the initial frame for isochronous transfers.
663 * @number_of_packets: Lists the number of ISO transfer buffers.
664 * @interval: Specifies the polling interval for interrupt or isochronous
665 * transfers. The units are frames (milliseconds) for for full and low
666 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
667 * @error_count: Returns the number of ISO transfers that reported errors.
668 * @context: For use in completion functions. This normally points to
669 * request-specific driver context.
670 * @complete: Completion handler. This URB is passed as the parameter to the
671 * completion function. The completion function may then do what
672 * it likes with the URB, including resubmitting or freeing it.
673 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
674 * collect the transfer status for each buffer.
676 * This structure identifies USB transfer requests. URBs must be allocated by
677 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
678 * Initialization may be done using various usb_fill_*_urb() functions. URBs
679 * are submitted using usb_submit_urb(), and pending requests may be canceled
680 * using usb_unlink_urb() or usb_kill_urb().
682 * Data Transfer Buffers:
684 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
685 * taken from the general page pool. That is provided by transfer_buffer
686 * (control requests also use setup_packet), and host controller drivers
687 * perform a dma mapping (and unmapping) for each buffer transferred. Those
688 * mapping operations can be expensive on some platforms (perhaps using a dma
689 * bounce buffer or talking to an IOMMU),
690 * although they're cheap on commodity x86 and ppc hardware.
692 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
693 * which tell the host controller driver that no such mapping is needed since
694 * the device driver is DMA-aware. For example, a device driver might
695 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
696 * When these transfer flags are provided, host controller drivers will
697 * attempt to use the dma addresses found in the transfer_dma and/or
698 * setup_dma fields rather than determining a dma address themselves. (Note
699 * that transfer_buffer and setup_packet must still be set because not all
700 * host controllers use DMA, nor do virtual root hubs).
704 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
705 * zero), and complete fields.
706 * The URB_ASYNC_UNLINK transfer flag affects later invocations of
707 * the usb_unlink_urb() routine. Note: Failure to set URB_ASYNC_UNLINK
708 * with usb_unlink_urb() is deprecated. For synchronous unlinks use
709 * usb_kill_urb() instead.
711 * All URBs must also initialize
712 * transfer_buffer and transfer_buffer_length. They may provide the
713 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
714 * to be treated as errors; that flag is invalid for write requests.
717 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
718 * should always terminate with a short packet, even if it means adding an
719 * extra zero length packet.
721 * Control URBs must provide a setup_packet. The setup_packet and
722 * transfer_buffer may each be mapped for DMA or not, independently of
723 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
724 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
725 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
727 * Interrupt URBs must provide an interval, saying how often (in milliseconds
728 * or, for highspeed devices, 125 microsecond units)
729 * to poll for transfers. After the URB has been submitted, the interval
730 * field reflects how the transfer was actually scheduled.
731 * The polling interval may be more frequent than requested.
732 * For example, some controllers have a maximum interval of 32 microseconds,
733 * while others support intervals of up to 1024 microseconds.
734 * Isochronous URBs also have transfer intervals. (Note that for isochronous
735 * endpoints, as well as high speed interrupt endpoints, the encoding of
736 * the transfer interval in the endpoint descriptor is logarithmic.
737 * Device drivers must convert that value to linear units themselves.)
739 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
740 * the host controller to schedule the transfer as soon as bandwidth
741 * utilization allows, and then set start_frame to reflect the actual frame
742 * selected during submission. Otherwise drivers must specify the start_frame
743 * and handle the case where the transfer can't begin then. However, drivers
744 * won't know how bandwidth is currently allocated, and while they can
745 * find the current frame using usb_get_current_frame_number () they can't
746 * know the range for that frame number. (Ranges for frame counter values
747 * are HC-specific, and can go from 256 to 65536 frames from "now".)
749 * Isochronous URBs have a different data transfer model, in part because
750 * the quality of service is only "best effort". Callers provide specially
751 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
752 * at the end. Each such packet is an individual ISO transfer. Isochronous
753 * URBs are normally queued, submitted by drivers to arrange that
754 * transfers are at least double buffered, and then explicitly resubmitted
755 * in completion handlers, so
756 * that data (such as audio or video) streams at as constant a rate as the
757 * host controller scheduler can support.
759 * Completion Callbacks:
761 * The completion callback is made in_interrupt(), and one of the first
762 * things that a completion handler should do is check the status field.
763 * The status field is provided for all URBs. It is used to report
764 * unlinked URBs, and status for all non-ISO transfers. It should not
765 * be examined before the URB is returned to the completion handler.
767 * The context field is normally used to link URBs back to the relevant
768 * driver or request state.
770 * When the completion callback is invoked for non-isochronous URBs, the
771 * actual_length field tells how many bytes were transferred. This field
772 * is updated even when the URB terminated with an error or was unlinked.
774 * ISO transfer status is reported in the status and actual_length fields
775 * of the iso_frame_desc array, and the number of errors is reported in
776 * error_count. Completion callbacks for ISO transfers will normally
777 * (re)submit URBs to ensure a constant transfer rate.
781 /* private, usb core and host controller only fields in the urb */
782 struct kref kref; /* reference count of the URB */
783 spinlock_t lock; /* lock for the URB */
784 void *hcpriv; /* private data for host controller */
785 struct list_head urb_list; /* list pointer to all active urbs */
786 int bandwidth; /* bandwidth for INT/ISO request */
787 atomic_t use_count; /* concurrent submissions counter */
788 u8 reject; /* submissions will fail */
790 /* public, documented fields in the urb that can be used by drivers */
791 struct usb_device *dev; /* (in) pointer to associated device */
792 unsigned int pipe; /* (in) pipe information */
793 int status; /* (return) non-ISO status */
794 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
795 void *transfer_buffer; /* (in) associated data buffer */
796 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
797 int transfer_buffer_length; /* (in) data buffer length */
798 int actual_length; /* (return) actual transfer length */
799 unsigned char *setup_packet; /* (in) setup packet (control only) */
800 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
801 int start_frame; /* (modify) start frame (ISO) */
802 int number_of_packets; /* (in) number of ISO packets */
803 int interval; /* (modify) transfer interval (INT/ISO) */
804 int error_count; /* (return) number of ISO errors */
805 void *context; /* (in) context for completion */
806 usb_complete_t complete; /* (in) completion routine */
807 struct usb_iso_packet_descriptor iso_frame_desc[0]; /* (in) ISO ONLY */
810 /* -------------------------------------------------------------------------- */
813 * usb_fill_control_urb - initializes a control urb
814 * @urb: pointer to the urb to initialize.
815 * @dev: pointer to the struct usb_device for this urb.
816 * @pipe: the endpoint pipe
817 * @setup_packet: pointer to the setup_packet buffer
818 * @transfer_buffer: pointer to the transfer buffer
819 * @buffer_length: length of the transfer buffer
820 * @complete: pointer to the usb_complete_t function
821 * @context: what to set the urb context to.
823 * Initializes a control urb with the proper information needed to submit
826 static inline void usb_fill_control_urb (struct urb *urb,
827 struct usb_device *dev,
829 unsigned char *setup_packet,
830 void *transfer_buffer,
832 usb_complete_t complete,
835 spin_lock_init(&urb->lock);
838 urb->setup_packet = setup_packet;
839 urb->transfer_buffer = transfer_buffer;
840 urb->transfer_buffer_length = buffer_length;
841 urb->complete = complete;
842 urb->context = context;
846 * usb_fill_bulk_urb - macro to help initialize a bulk urb
847 * @urb: pointer to the urb to initialize.
848 * @dev: pointer to the struct usb_device for this urb.
849 * @pipe: the endpoint pipe
850 * @transfer_buffer: pointer to the transfer buffer
851 * @buffer_length: length of the transfer buffer
852 * @complete: pointer to the usb_complete_t function
853 * @context: what to set the urb context to.
855 * Initializes a bulk urb with the proper information needed to submit it
858 static inline void usb_fill_bulk_urb (struct urb *urb,
859 struct usb_device *dev,
861 void *transfer_buffer,
863 usb_complete_t complete,
866 spin_lock_init(&urb->lock);
869 urb->transfer_buffer = transfer_buffer;
870 urb->transfer_buffer_length = buffer_length;
871 urb->complete = complete;
872 urb->context = context;
876 * usb_fill_int_urb - macro to help initialize a interrupt urb
877 * @urb: pointer to the urb to initialize.
878 * @dev: pointer to the struct usb_device for this urb.
879 * @pipe: the endpoint pipe
880 * @transfer_buffer: pointer to the transfer buffer
881 * @buffer_length: length of the transfer buffer
882 * @complete: pointer to the usb_complete_t function
883 * @context: what to set the urb context to.
884 * @interval: what to set the urb interval to, encoded like
885 * the endpoint descriptor's bInterval value.
887 * Initializes a interrupt urb with the proper information needed to submit
889 * Note that high speed interrupt endpoints use a logarithmic encoding of
890 * the endpoint interval, and express polling intervals in microframes
891 * (eight per millisecond) rather than in frames (one per millisecond).
893 static inline void usb_fill_int_urb (struct urb *urb,
894 struct usb_device *dev,
896 void *transfer_buffer,
898 usb_complete_t complete,
902 spin_lock_init(&urb->lock);
905 urb->transfer_buffer = transfer_buffer;
906 urb->transfer_buffer_length = buffer_length;
907 urb->complete = complete;
908 urb->context = context;
909 if (dev->speed == USB_SPEED_HIGH)
910 urb->interval = 1 << (interval - 1);
912 urb->interval = interval;
913 urb->start_frame = -1;
916 extern void usb_init_urb(struct urb *urb);
917 extern struct urb *usb_alloc_urb(int iso_packets, int mem_flags);
918 extern void usb_free_urb(struct urb *urb);
919 #define usb_put_urb usb_free_urb
920 extern struct urb *usb_get_urb(struct urb *urb);
921 extern int usb_submit_urb(struct urb *urb, int mem_flags);
922 extern int usb_unlink_urb(struct urb *urb);
923 extern void usb_kill_urb(struct urb *urb);
925 #define HAVE_USB_BUFFERS
926 void *usb_buffer_alloc (struct usb_device *dev, size_t size,
927 int mem_flags, dma_addr_t *dma);
928 void usb_buffer_free (struct usb_device *dev, size_t size,
929 void *addr, dma_addr_t dma);
931 struct urb *usb_buffer_map (struct urb *urb);
933 void usb_buffer_dmasync (struct urb *urb);
935 void usb_buffer_unmap (struct urb *urb);
938 int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
939 struct scatterlist *sg, int nents);
941 void usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe,
942 struct scatterlist *sg, int n_hw_ents);
944 void usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe,
945 struct scatterlist *sg, int n_hw_ents);
947 /*-------------------------------------------------------------------*
948 * SYNCHRONOUS CALL SUPPORT *
949 *-------------------------------------------------------------------*/
951 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
952 __u8 request, __u8 requesttype, __u16 value, __u16 index,
953 void *data, __u16 size, int timeout);
954 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
955 void *data, int len, int *actual_length,
958 /* selective suspend/resume */
959 extern int usb_suspend_device(struct usb_device *dev, u32 state);
960 extern int usb_resume_device(struct usb_device *dev);
963 /* wrappers around usb_control_msg() for the most common standard requests */
964 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
965 unsigned char descindex, void *buf, int size);
966 extern int usb_get_status(struct usb_device *dev,
967 int type, int target, void *data);
968 extern int usb_get_string(struct usb_device *dev,
969 unsigned short langid, unsigned char index, void *buf, int size);
970 extern int usb_string(struct usb_device *dev, int index,
971 char *buf, size_t size);
973 /* wrappers that also update important state inside usbcore */
974 extern int usb_clear_halt(struct usb_device *dev, int pipe);
975 extern int usb_reset_configuration(struct usb_device *dev);
976 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
979 * timeouts, in seconds, used for sending/receiving control messages
980 * they typically complete within a few frames (msec) after they're issued
981 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
982 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
984 #define USB_CTRL_GET_TIMEOUT 5
985 #define USB_CTRL_SET_TIMEOUT 5
989 * struct usb_sg_request - support for scatter/gather I/O
990 * @status: zero indicates success, else negative errno
991 * @bytes: counts bytes transferred.
993 * These requests are initialized using usb_sg_init(), and then are used
994 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
995 * members of the request object aren't for driver access.
997 * The status and bytecount values are valid only after usb_sg_wait()
998 * returns. If the status is zero, then the bytecount matches the total
1001 * After an error completion, drivers may need to clear a halt condition
1004 struct usb_sg_request {
1009 * members below are private to usbcore,
1010 * and are not provided for driver access!
1014 struct usb_device *dev;
1016 struct scatterlist *sg;
1023 struct completion complete;
1027 struct usb_sg_request *io,
1028 struct usb_device *dev,
1031 struct scatterlist *sg,
1036 void usb_sg_cancel (struct usb_sg_request *io);
1037 void usb_sg_wait (struct usb_sg_request *io);
1040 /* -------------------------------------------------------------------------- */
1043 * Calling this entity a "pipe" is glorifying it. A USB pipe
1044 * is something embarrassingly simple: it basically consists
1045 * of the following information:
1046 * - device number (7 bits)
1047 * - endpoint number (4 bits)
1048 * - current Data0/1 state (1 bit) [Historical; now gone]
1049 * - direction (1 bit)
1050 * - speed (1 bit) [Historical and specific to USB 1.1; now gone.]
1051 * - max packet size (2 bits: 8, 16, 32 or 64) [Historical; now gone.]
1052 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
1054 * That's 18 bits. Really. Nothing more. And the USB people have
1055 * documented these eighteen bits as some kind of glorious
1056 * virtual data structure.
1058 * Let's not fall in that trap. We'll just encode it as a simple
1059 * unsigned int. The encoding is:
1061 * - max size: bits 0-1 [Historical; now gone.]
1062 * - direction: bit 7 (0 = Host-to-Device [Out],
1063 * 1 = Device-to-Host [In] ...
1064 * like endpoint bEndpointAddress)
1065 * - device: bits 8-14 ... bit positions known to uhci-hcd
1066 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1067 * - Data0/1: bit 19 [Historical; now gone. ]
1068 * - lowspeed: bit 26 [Historical; now gone. ]
1069 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1070 * 10 = control, 11 = bulk)
1072 * Why? Because it's arbitrary, and whatever encoding we select is really
1073 * up to us. This one happens to share a lot of bit positions with the UHCI
1074 * specification, so that much of the uhci driver can just mask the bits
1078 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1079 #define PIPE_ISOCHRONOUS 0
1080 #define PIPE_INTERRUPT 1
1081 #define PIPE_CONTROL 2
1084 #define usb_maxpacket(dev, pipe, out) (out \
1085 ? (dev)->epmaxpacketout[usb_pipeendpoint(pipe)] \
1086 : (dev)->epmaxpacketin [usb_pipeendpoint(pipe)] )
1088 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1089 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1090 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1091 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1092 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1093 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1094 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1095 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1096 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1098 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1099 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1100 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
1101 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | ((bit) << (ep)))
1104 static inline unsigned int __create_pipe(struct usb_device *dev, unsigned int endpoint)
1106 return (dev->devnum << 8) | (endpoint << 15);
1109 /* Create various pipes... */
1110 #define usb_sndctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1111 #define usb_rcvctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1112 #define usb_sndisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1113 #define usb_rcvisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1114 #define usb_sndbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1115 #define usb_rcvbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1116 #define usb_sndintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1117 #define usb_rcvintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1119 /* -------------------------------------------------------------------------- */
1122 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg)
1124 #define dbg(format, arg...) do {} while (0)
1127 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , __FILE__ , ## arg)
1128 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , __FILE__ , ## arg)
1129 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , __FILE__ , ## arg)
1132 #endif /* __KERNEL__ */