4 #include <linux/mod_devicetable.h>
5 #include <linux/usb_ch9.h>
8 #define USB_DEVICE_MAJOR 189
13 #include <linux/config.h>
14 #include <linux/errno.h> /* for -ENODEV */
15 #include <linux/delay.h> /* for mdelay() */
16 #include <linux/interrupt.h> /* for in_interrupt() */
17 #include <linux/list.h> /* for struct list_head */
18 #include <linux/kref.h> /* for struct kref */
19 #include <linux/device.h> /* for struct device */
20 #include <linux/fs.h> /* for struct file_operations */
21 #include <linux/completion.h> /* for struct completion */
22 #include <linux/sched.h> /* for current && schedule_timeout */
27 /*-------------------------------------------------------------------------*/
30 * Host-side wrappers for standard USB descriptors ... these are parsed
31 * from the data provided by devices. Parsing turns them from a flat
32 * sequence of descriptors into a hierarchy:
34 * - devices have one (usually) or more configs;
35 * - configs have one (often) or more interfaces;
36 * - interfaces have one (usually) or more settings;
37 * - each interface setting has zero or (usually) more endpoints.
39 * And there might be other descriptors mixed in with those.
41 * Devices may also have class-specific or vendor-specific descriptors.
45 * struct usb_host_endpoint - host-side endpoint descriptor and queue
46 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
47 * @urb_list: urbs queued to this endpoint; maintained by usbcore
48 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
49 * with one or more transfer descriptors (TDs) per urb
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 bound to */
141 enum usb_interface_condition condition; /* state of binding */
142 struct device dev; /* interface specific device info */
143 struct class_device *class_dev;
145 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
146 #define interface_to_usbdev(intf) \
147 container_of(intf->dev.parent, struct usb_device, dev)
149 static inline void *usb_get_intfdata (struct usb_interface *intf)
151 return dev_get_drvdata (&intf->dev);
154 static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
156 dev_set_drvdata(&intf->dev, data);
159 struct usb_interface *usb_get_intf(struct usb_interface *intf);
160 void usb_put_intf(struct usb_interface *intf);
162 /* this maximum is arbitrary */
163 #define USB_MAXINTERFACES 32
166 * struct usb_interface_cache - long-term representation of a device interface
167 * @num_altsetting: number of altsettings defined.
168 * @ref: reference counter.
169 * @altsetting: variable-length array of interface structures, one for
170 * each alternate setting that may be selected. Each one includes a
171 * set of endpoint configurations. They will be in no particular order.
173 * These structures persist for the lifetime of a usb_device, unlike
174 * struct usb_interface (which persists only as long as its configuration
175 * is installed). The altsetting arrays can be accessed through these
176 * structures at any time, permitting comparison of configurations and
177 * providing support for the /proc/bus/usb/devices pseudo-file.
179 struct usb_interface_cache {
180 unsigned num_altsetting; /* number of alternate settings */
181 struct kref ref; /* reference counter */
183 /* variable-length array of alternate settings for this interface,
184 * stored in no particular order */
185 struct usb_host_interface altsetting[0];
187 #define ref_to_usb_interface_cache(r) \
188 container_of(r, struct usb_interface_cache, ref)
189 #define altsetting_to_usb_interface_cache(a) \
190 container_of(a, struct usb_interface_cache, altsetting[0])
193 * struct usb_host_config - representation of a device's configuration
194 * @desc: the device's configuration descriptor.
195 * @string: pointer to the cached version of the iConfiguration string, if
196 * present for this configuration.
197 * @interface: array of pointers to usb_interface structures, one for each
198 * interface in the configuration. The number of interfaces is stored
199 * in desc.bNumInterfaces. These pointers are valid only while the
200 * the configuration is active.
201 * @intf_cache: array of pointers to usb_interface_cache structures, one
202 * for each interface in the configuration. These structures exist
203 * for the entire life of the device.
204 * @extra: pointer to buffer containing all extra descriptors associated
205 * with this configuration (those preceding the first interface
207 * @extralen: length of the extra descriptors buffer.
209 * USB devices may have multiple configurations, but only one can be active
210 * at any time. Each encapsulates a different operational environment;
211 * for example, a dual-speed device would have separate configurations for
212 * full-speed and high-speed operation. The number of configurations
213 * available is stored in the device descriptor as bNumConfigurations.
215 * A configuration can contain multiple interfaces. Each corresponds to
216 * a different function of the USB device, and all are available whenever
217 * the configuration is active. The USB standard says that interfaces
218 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
219 * of devices get this wrong. In addition, the interface array is not
220 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
221 * look up an interface entry based on its number.
223 * Device drivers should not attempt to activate configurations. The choice
224 * of which configuration to install is a policy decision based on such
225 * considerations as available power, functionality provided, and the user's
226 * desires (expressed through hotplug scripts). However, drivers can call
227 * usb_reset_configuration() to reinitialize the current configuration and
228 * all its interfaces.
230 struct usb_host_config {
231 struct usb_config_descriptor desc;
234 /* the interfaces associated with this configuration,
235 * stored in no particular order */
236 struct usb_interface *interface[USB_MAXINTERFACES];
238 /* Interface information available even when this is not the
239 * active configuration */
240 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
242 unsigned char *extra; /* Extra descriptors */
246 int __usb_get_extra_descriptor(char *buffer, unsigned size,
247 unsigned char type, void **ptr);
248 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
249 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
252 /* -------------------------------------------------------------------------- */
254 struct usb_operations;
256 /* USB device number allocation bitmap */
258 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
262 * Allocated per bus (tree of devices) we have:
265 struct device *controller; /* host/master side hardware */
266 int busnum; /* Bus number (in order of reg) */
267 char *bus_name; /* stable id (PCI slot_name etc) */
268 u8 otg_port; /* 0, or number of OTG/HNP port */
269 unsigned is_b_host:1; /* true during some HNP roleswitches */
270 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
272 int devnum_next; /* Next open device number in round-robin allocation */
274 struct usb_devmap devmap; /* device address allocation map */
275 struct usb_operations *op; /* Operations (specific to the HC) */
276 struct usb_device *root_hub; /* Root hub */
277 struct list_head bus_list; /* list of busses */
278 void *hcpriv; /* Host Controller private data */
280 int bandwidth_allocated; /* on this bus: how much of the time
281 * reserved for periodic (intr/iso)
282 * requests is used, on average?
283 * Units: microseconds/frame.
284 * Limits: Full/low speed reserve 90%,
285 * while high speed reserves 80%.
287 int bandwidth_int_reqs; /* number of Interrupt requests */
288 int bandwidth_isoc_reqs; /* number of Isoc. requests */
290 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
292 struct class_device *class_dev; /* class device for this bus */
293 struct kref kref; /* handles reference counting this bus */
294 void (*release)(struct usb_bus *bus); /* function to destroy this bus's memory */
295 #if defined(CONFIG_USB_MON)
296 struct mon_bus *mon_bus; /* non-null when associated */
297 int monitored; /* non-zero when monitored */
301 /* -------------------------------------------------------------------------- */
303 /* This is arbitrary.
304 * From USB 2.0 spec Table 11-13, offset 7, a hub can
305 * have up to 255 ports. The most yet reported is 10.
307 #define USB_MAXCHILDREN (16)
312 * struct usb_device - kernel's representation of a USB device
314 * FIXME: Write the kerneldoc!
316 * Usbcore drivers should not set usbdev->state directly. Instead use
317 * usb_set_device_state().
320 int devnum; /* Address on USB bus */
321 char devpath [16]; /* Use in messages: /port/port/... */
322 enum usb_device_state state; /* configured, not attached, etc */
323 enum usb_device_speed speed; /* high/full/low (or error) */
325 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
326 int ttport; /* device port on that tt hub */
328 struct semaphore serialize;
330 unsigned int toggle[2]; /* one bit for each endpoint ([0] = IN, [1] = OUT) */
332 struct usb_device *parent; /* our hub, unless we're the root */
333 struct usb_bus *bus; /* Bus we're part of */
334 struct usb_host_endpoint ep0;
336 struct device dev; /* Generic device interface */
338 struct usb_device_descriptor descriptor;/* Descriptor */
339 struct usb_host_config *config; /* All of the configs */
341 struct usb_host_config *actconfig;/* the active configuration */
342 struct usb_host_endpoint *ep_in[16];
343 struct usb_host_endpoint *ep_out[16];
345 char **rawdescriptors; /* Raw descriptors for each config */
347 int have_langid; /* whether string_langid is valid yet */
348 int string_langid; /* language ID for strings */
352 char *serial; /* static strings from the device */
353 struct list_head filelist;
354 struct class_device *class_dev;
355 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
358 * Child devices - these can be either new devices
359 * (if this is a hub device), or different instances
360 * of this same device.
362 * Each instance needs its own set of data structures.
365 int maxchild; /* Number of ports if hub */
366 struct usb_device *children[USB_MAXCHILDREN];
368 #define to_usb_device(d) container_of(d, struct usb_device, dev)
370 extern struct usb_device *usb_get_dev(struct usb_device *dev);
371 extern void usb_put_dev(struct usb_device *dev);
373 extern void usb_lock_device(struct usb_device *udev);
374 extern int usb_trylock_device(struct usb_device *udev);
375 extern int usb_lock_device_for_reset(struct usb_device *udev,
376 struct usb_interface *iface);
377 extern void usb_unlock_device(struct usb_device *udev);
379 /* USB port reset for device reinitialization */
380 extern int usb_reset_device(struct usb_device *dev);
382 extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
384 /*-------------------------------------------------------------------------*/
386 /* for drivers using iso endpoints */
387 extern int usb_get_current_frame_number (struct usb_device *usb_dev);
389 /* used these for multi-interface device registration */
390 extern int usb_driver_claim_interface(struct usb_driver *driver,
391 struct usb_interface *iface, void* priv);
394 * usb_interface_claimed - returns true iff an interface is claimed
395 * @iface: the interface being checked
397 * Returns true (nonzero) iff the interface is claimed, else false (zero).
398 * Callers must own the driver model's usb bus readlock. So driver
399 * probe() entries don't need extra locking, but other call contexts
400 * may need to explicitly claim that lock.
403 static inline int usb_interface_claimed(struct usb_interface *iface) {
404 return (iface->dev.driver != NULL);
407 extern void usb_driver_release_interface(struct usb_driver *driver,
408 struct usb_interface *iface);
409 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
410 const struct usb_device_id *id);
412 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
414 extern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev,
416 extern struct usb_host_interface *usb_altnum_to_altsetting(
417 struct usb_interface *intf, unsigned int altnum);
421 * usb_make_path - returns stable device path in the usb tree
422 * @dev: the device whose path is being constructed
423 * @buf: where to put the string
424 * @size: how big is "buf"?
426 * Returns length of the string (> 0) or negative if size was too small.
428 * This identifier is intended to be "stable", reflecting physical paths in
429 * hardware such as physical bus addresses for host controllers or ports on
430 * USB hubs. That makes it stay the same until systems are physically
431 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
432 * controllers. Adding and removing devices, including virtual root hubs
433 * in host controller driver modules, does not change these path identifers;
434 * neither does rebooting or re-enumerating. These are more useful identifiers
435 * than changeable ("unstable") ones like bus numbers or device addresses.
437 * With a partial exception for devices connected to USB 2.0 root hubs, these
438 * identifiers are also predictable. So long as the device tree isn't changed,
439 * plugging any USB device into a given hub port always gives it the same path.
440 * Because of the use of "companion" controllers, devices connected to ports on
441 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
442 * high speed, and a different one if they are full or low speed.
444 static inline int usb_make_path (struct usb_device *dev, char *buf, size_t size)
447 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name, dev->devpath);
448 return (actual >= (int)size) ? -1 : actual;
451 /*-------------------------------------------------------------------------*/
453 #define USB_DEVICE_ID_MATCH_DEVICE (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
454 #define USB_DEVICE_ID_MATCH_DEV_RANGE (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
455 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
456 #define USB_DEVICE_ID_MATCH_DEV_INFO \
457 (USB_DEVICE_ID_MATCH_DEV_CLASS | USB_DEVICE_ID_MATCH_DEV_SUBCLASS | USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
458 #define USB_DEVICE_ID_MATCH_INT_INFO \
459 (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS | USB_DEVICE_ID_MATCH_INT_PROTOCOL)
462 * USB_DEVICE - macro used to describe a specific usb device
463 * @vend: the 16 bit USB Vendor ID
464 * @prod: the 16 bit USB Product ID
466 * This macro is used to create a struct usb_device_id that matches a
469 #define USB_DEVICE(vend,prod) \
470 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), .idProduct = (prod)
472 * USB_DEVICE_VER - macro used to describe a specific usb device with a version range
473 * @vend: the 16 bit USB Vendor ID
474 * @prod: the 16 bit USB Product ID
475 * @lo: the bcdDevice_lo value
476 * @hi: the bcdDevice_hi value
478 * This macro is used to create a struct usb_device_id that matches a
479 * specific device, with a version range.
481 #define USB_DEVICE_VER(vend,prod,lo,hi) \
482 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, .idVendor = (vend), .idProduct = (prod), .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
485 * USB_DEVICE_INFO - macro used to describe a class of usb devices
486 * @cl: bDeviceClass value
487 * @sc: bDeviceSubClass value
488 * @pr: bDeviceProtocol value
490 * This macro is used to create a struct usb_device_id that matches a
491 * specific class of devices.
493 #define USB_DEVICE_INFO(cl,sc,pr) \
494 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
497 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
498 * @cl: bInterfaceClass value
499 * @sc: bInterfaceSubClass value
500 * @pr: bInterfaceProtocol value
502 * This macro is used to create a struct usb_device_id that matches a
503 * specific class of interfaces.
505 #define USB_INTERFACE_INFO(cl,sc,pr) \
506 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
508 /* -------------------------------------------------------------------------- */
511 * struct usb_driver - identifies USB driver to usbcore
512 * @owner: Pointer to the module owner of this driver; initialize
513 * it using THIS_MODULE.
514 * @name: The driver name should be unique among USB drivers,
515 * and should normally be the same as the module name.
516 * @probe: Called to see if the driver is willing to manage a particular
517 * interface on a device. If it is, probe returns zero and uses
518 * dev_set_drvdata() to associate driver-specific data with the
519 * interface. It may also use usb_set_interface() to specify the
520 * appropriate altsetting. If unwilling to manage the interface,
521 * return a negative errno value.
522 * @disconnect: Called when the interface is no longer accessible, usually
523 * because its device has been (or is being) disconnected or the
524 * driver module is being unloaded.
525 * @ioctl: Used for drivers that want to talk to userspace through
526 * the "usbfs" filesystem. This lets devices provide ways to
527 * expose information to user space regardless of where they
528 * do (or don't) show up otherwise in the filesystem.
529 * @suspend: Called when the device is going to be suspended by the system.
530 * @resume: Called when the device is being resumed by the system.
531 * @id_table: USB drivers use ID table to support hotplugging.
532 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
533 * or your driver's probe function will never get called.
534 * @driver: the driver model core driver structure.
536 * USB drivers must provide a name, probe() and disconnect() methods,
537 * and an id_table. Other driver fields are optional.
539 * The id_table is used in hotplugging. It holds a set of descriptors,
540 * and specialized data may be associated with each entry. That table
541 * is used by both user and kernel mode hotplugging support.
543 * The probe() and disconnect() methods are called in a context where
544 * they can sleep, but they should avoid abusing the privilege. Most
545 * work to connect to a device should be done when the device is opened,
546 * and undone at the last close. The disconnect code needs to address
547 * concurrency issues with respect to open() and close() methods, as
548 * well as forcing all pending I/O requests to complete (by unlinking
549 * them as necessary, and blocking until the unlinks complete).
552 struct module *owner;
556 int (*probe) (struct usb_interface *intf,
557 const struct usb_device_id *id);
559 void (*disconnect) (struct usb_interface *intf);
561 int (*ioctl) (struct usb_interface *intf, unsigned int code, void *buf);
563 int (*suspend) (struct usb_interface *intf, pm_message_t message);
564 int (*resume) (struct usb_interface *intf);
566 const struct usb_device_id *id_table;
568 struct device_driver driver;
570 #define to_usb_driver(d) container_of(d, struct usb_driver, driver)
572 extern struct bus_type usb_bus_type;
575 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
576 * @name: the usb class device name for this driver. Will show up in sysfs.
577 * @fops: pointer to the struct file_operations of this driver.
578 * @minor_base: the start of the minor range for this driver.
580 * This structure is used for the usb_register_dev() and
581 * usb_unregister_dev() functions, to consolidate a number of the
582 * parameters used for them.
584 struct usb_class_driver {
586 struct file_operations *fops;
591 * use these in module_init()/module_exit()
592 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
594 extern int usb_register(struct usb_driver *);
595 extern void usb_deregister(struct usb_driver *);
597 extern int usb_register_dev(struct usb_interface *intf,
598 struct usb_class_driver *class_driver);
599 extern void usb_deregister_dev(struct usb_interface *intf,
600 struct usb_class_driver *class_driver);
602 extern int usb_disabled(void);
604 /* -------------------------------------------------------------------------- */
607 * URB support, for asynchronous request completions
611 * urb->transfer_flags:
613 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
614 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame ignored */
615 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
616 #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
617 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
618 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUTs with short packet */
619 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt needed */
621 struct usb_iso_packet_descriptor {
623 unsigned int length; /* expected length */
624 unsigned int actual_length;
631 typedef void (*usb_complete_t)(struct urb *, struct pt_regs *);
634 * struct urb - USB Request Block
635 * @urb_list: For use by current owner of the URB.
636 * @pipe: Holds endpoint number, direction, type, and more.
637 * Create these values with the eight macros available;
638 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
639 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
640 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
641 * numbers range from zero to fifteen. Note that "in" endpoint two
642 * is a different endpoint (and pipe) from "out" endpoint two.
643 * The current configuration controls the existence, type, and
644 * maximum packet size of any given endpoint.
645 * @dev: Identifies the USB device to perform the request.
646 * @status: This is read in non-iso completion functions to get the
647 * status of the particular request. ISO requests only use it
648 * to tell whether the URB was unlinked; detailed status for
649 * each frame is in the fields of the iso_frame-desc.
650 * @transfer_flags: A variety of flags may be used to affect how URB
651 * submission, unlinking, or operation are handled. Different
652 * kinds of URB can use different flags.
653 * @transfer_buffer: This identifies the buffer to (or from) which
654 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
655 * is set). This buffer must be suitable for DMA; allocate it with
656 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
657 * of this buffer will be modified. This buffer is used for the data
658 * stage of control transfers.
659 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
660 * the device driver is saying that it provided this DMA address,
661 * which the host controller driver should use in preference to the
663 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
664 * be broken up into chunks according to the current maximum packet
665 * size for the endpoint, which is a function of the configuration
666 * and is encoded in the pipe. When the length is zero, neither
667 * transfer_buffer nor transfer_dma is used.
668 * @actual_length: This is read in non-iso completion functions, and
669 * it tells how many bytes (out of transfer_buffer_length) were
670 * transferred. It will normally be the same as requested, unless
671 * either an error was reported or a short read was performed.
672 * The URB_SHORT_NOT_OK transfer flag may be used to make such
673 * short reads be reported as errors.
674 * @setup_packet: Only used for control transfers, this points to eight bytes
675 * of setup data. Control transfers always start by sending this data
676 * to the device. Then transfer_buffer is read or written, if needed.
677 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
678 * device driver has provided this DMA address for the setup packet.
679 * The host controller driver should use this in preference to
681 * @start_frame: Returns the initial frame for isochronous transfers.
682 * @number_of_packets: Lists the number of ISO transfer buffers.
683 * @interval: Specifies the polling interval for interrupt or isochronous
684 * transfers. The units are frames (milliseconds) for for full and low
685 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
686 * @error_count: Returns the number of ISO transfers that reported errors.
687 * @context: For use in completion functions. This normally points to
688 * request-specific driver context.
689 * @complete: Completion handler. This URB is passed as the parameter to the
690 * completion function. The completion function may then do what
691 * it likes with the URB, including resubmitting or freeing it.
692 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
693 * collect the transfer status for each buffer.
695 * This structure identifies USB transfer requests. URBs must be allocated by
696 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
697 * Initialization may be done using various usb_fill_*_urb() functions. URBs
698 * are submitted using usb_submit_urb(), and pending requests may be canceled
699 * using usb_unlink_urb() or usb_kill_urb().
701 * Data Transfer Buffers:
703 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
704 * taken from the general page pool. That is provided by transfer_buffer
705 * (control requests also use setup_packet), and host controller drivers
706 * perform a dma mapping (and unmapping) for each buffer transferred. Those
707 * mapping operations can be expensive on some platforms (perhaps using a dma
708 * bounce buffer or talking to an IOMMU),
709 * although they're cheap on commodity x86 and ppc hardware.
711 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
712 * which tell the host controller driver that no such mapping is needed since
713 * the device driver is DMA-aware. For example, a device driver might
714 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
715 * When these transfer flags are provided, host controller drivers will
716 * attempt to use the dma addresses found in the transfer_dma and/or
717 * setup_dma fields rather than determining a dma address themselves. (Note
718 * that transfer_buffer and setup_packet must still be set because not all
719 * host controllers use DMA, nor do virtual root hubs).
723 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
724 * zero), and complete fields. All URBs must also initialize
725 * transfer_buffer and transfer_buffer_length. They may provide the
726 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
727 * to be treated as errors; that flag is invalid for write requests.
730 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
731 * should always terminate with a short packet, even if it means adding an
732 * extra zero length packet.
734 * Control URBs must provide a setup_packet. The setup_packet and
735 * transfer_buffer may each be mapped for DMA or not, independently of
736 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
737 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
738 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
740 * Interrupt URBs must provide an interval, saying how often (in milliseconds
741 * or, for highspeed devices, 125 microsecond units)
742 * to poll for transfers. After the URB has been submitted, the interval
743 * field reflects how the transfer was actually scheduled.
744 * The polling interval may be more frequent than requested.
745 * For example, some controllers have a maximum interval of 32 milliseconds,
746 * while others support intervals of up to 1024 milliseconds.
747 * Isochronous URBs also have transfer intervals. (Note that for isochronous
748 * endpoints, as well as high speed interrupt endpoints, the encoding of
749 * the transfer interval in the endpoint descriptor is logarithmic.
750 * Device drivers must convert that value to linear units themselves.)
752 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
753 * the host controller to schedule the transfer as soon as bandwidth
754 * utilization allows, and then set start_frame to reflect the actual frame
755 * selected during submission. Otherwise drivers must specify the start_frame
756 * and handle the case where the transfer can't begin then. However, drivers
757 * won't know how bandwidth is currently allocated, and while they can
758 * find the current frame using usb_get_current_frame_number () they can't
759 * know the range for that frame number. (Ranges for frame counter values
760 * are HC-specific, and can go from 256 to 65536 frames from "now".)
762 * Isochronous URBs have a different data transfer model, in part because
763 * the quality of service is only "best effort". Callers provide specially
764 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
765 * at the end. Each such packet is an individual ISO transfer. Isochronous
766 * URBs are normally queued, submitted by drivers to arrange that
767 * transfers are at least double buffered, and then explicitly resubmitted
768 * in completion handlers, so
769 * that data (such as audio or video) streams at as constant a rate as the
770 * host controller scheduler can support.
772 * Completion Callbacks:
774 * The completion callback is made in_interrupt(), and one of the first
775 * things that a completion handler should do is check the status field.
776 * The status field is provided for all URBs. It is used to report
777 * unlinked URBs, and status for all non-ISO transfers. It should not
778 * be examined before the URB is returned to the completion handler.
780 * The context field is normally used to link URBs back to the relevant
781 * driver or request state.
783 * When the completion callback is invoked for non-isochronous URBs, the
784 * actual_length field tells how many bytes were transferred. This field
785 * is updated even when the URB terminated with an error or was unlinked.
787 * ISO transfer status is reported in the status and actual_length fields
788 * of the iso_frame_desc array, and the number of errors is reported in
789 * error_count. Completion callbacks for ISO transfers will normally
790 * (re)submit URBs to ensure a constant transfer rate.
792 * Note that even fields marked "public" should not be touched by the driver
793 * when the urb is owned by the hcd, that is, since the call to
794 * usb_submit_urb() till the entry into the completion routine.
798 /* private, usb core and host controller only fields in the urb */
799 struct kref kref; /* reference count of the URB */
800 spinlock_t lock; /* lock for the URB */
801 void *hcpriv; /* private data for host controller */
802 int bandwidth; /* bandwidth for INT/ISO request */
803 atomic_t use_count; /* concurrent submissions counter */
804 u8 reject; /* submissions will fail */
806 /* public, documented fields in the urb that can be used by drivers */
807 struct list_head urb_list; /* list head for use by the urb owner */
808 struct usb_device *dev; /* (in) pointer to associated device */
809 unsigned int pipe; /* (in) pipe information */
810 int status; /* (return) non-ISO status */
811 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
812 void *transfer_buffer; /* (in) associated data buffer */
813 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
814 int transfer_buffer_length; /* (in) data buffer length */
815 int actual_length; /* (return) actual transfer length */
816 unsigned char *setup_packet; /* (in) setup packet (control only) */
817 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
818 int start_frame; /* (modify) start frame (ISO) */
819 int number_of_packets; /* (in) number of ISO packets */
820 int interval; /* (modify) transfer interval (INT/ISO) */
821 int error_count; /* (return) number of ISO errors */
822 void *context; /* (in) context for completion */
823 usb_complete_t complete; /* (in) completion routine */
824 struct usb_iso_packet_descriptor iso_frame_desc[0]; /* (in) ISO ONLY */
827 /* -------------------------------------------------------------------------- */
830 * usb_fill_control_urb - initializes a control urb
831 * @urb: pointer to the urb to initialize.
832 * @dev: pointer to the struct usb_device for this urb.
833 * @pipe: the endpoint pipe
834 * @setup_packet: pointer to the setup_packet buffer
835 * @transfer_buffer: pointer to the transfer buffer
836 * @buffer_length: length of the transfer buffer
837 * @complete: pointer to the usb_complete_t function
838 * @context: what to set the urb context to.
840 * Initializes a control urb with the proper information needed to submit
843 static inline void usb_fill_control_urb (struct urb *urb,
844 struct usb_device *dev,
846 unsigned char *setup_packet,
847 void *transfer_buffer,
849 usb_complete_t complete,
852 spin_lock_init(&urb->lock);
855 urb->setup_packet = setup_packet;
856 urb->transfer_buffer = transfer_buffer;
857 urb->transfer_buffer_length = buffer_length;
858 urb->complete = complete;
859 urb->context = context;
863 * usb_fill_bulk_urb - macro to help initialize a bulk urb
864 * @urb: pointer to the urb to initialize.
865 * @dev: pointer to the struct usb_device for this urb.
866 * @pipe: the endpoint pipe
867 * @transfer_buffer: pointer to the transfer buffer
868 * @buffer_length: length of the transfer buffer
869 * @complete: pointer to the usb_complete_t function
870 * @context: what to set the urb context to.
872 * Initializes a bulk urb with the proper information needed to submit it
875 static inline void usb_fill_bulk_urb (struct urb *urb,
876 struct usb_device *dev,
878 void *transfer_buffer,
880 usb_complete_t complete,
883 spin_lock_init(&urb->lock);
886 urb->transfer_buffer = transfer_buffer;
887 urb->transfer_buffer_length = buffer_length;
888 urb->complete = complete;
889 urb->context = context;
893 * usb_fill_int_urb - macro to help initialize a interrupt urb
894 * @urb: pointer to the urb to initialize.
895 * @dev: pointer to the struct usb_device for this urb.
896 * @pipe: the endpoint pipe
897 * @transfer_buffer: pointer to the transfer buffer
898 * @buffer_length: length of the transfer buffer
899 * @complete: pointer to the usb_complete_t function
900 * @context: what to set the urb context to.
901 * @interval: what to set the urb interval to, encoded like
902 * the endpoint descriptor's bInterval value.
904 * Initializes a interrupt urb with the proper information needed to submit
906 * Note that high speed interrupt endpoints use a logarithmic encoding of
907 * the endpoint interval, and express polling intervals in microframes
908 * (eight per millisecond) rather than in frames (one per millisecond).
910 static inline void usb_fill_int_urb (struct urb *urb,
911 struct usb_device *dev,
913 void *transfer_buffer,
915 usb_complete_t complete,
919 spin_lock_init(&urb->lock);
922 urb->transfer_buffer = transfer_buffer;
923 urb->transfer_buffer_length = buffer_length;
924 urb->complete = complete;
925 urb->context = context;
926 if (dev->speed == USB_SPEED_HIGH)
927 urb->interval = 1 << (interval - 1);
929 urb->interval = interval;
930 urb->start_frame = -1;
933 extern void usb_init_urb(struct urb *urb);
934 extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
935 extern void usb_free_urb(struct urb *urb);
936 #define usb_put_urb usb_free_urb
937 extern struct urb *usb_get_urb(struct urb *urb);
938 extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
939 extern int usb_unlink_urb(struct urb *urb);
940 extern void usb_kill_urb(struct urb *urb);
942 #define HAVE_USB_BUFFERS
943 void *usb_buffer_alloc (struct usb_device *dev, size_t size,
944 gfp_t mem_flags, dma_addr_t *dma);
945 void usb_buffer_free (struct usb_device *dev, size_t size,
946 void *addr, dma_addr_t dma);
949 struct urb *usb_buffer_map (struct urb *urb);
950 void usb_buffer_dmasync (struct urb *urb);
951 void usb_buffer_unmap (struct urb *urb);
955 int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
956 struct scatterlist *sg, int nents);
958 void usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe,
959 struct scatterlist *sg, int n_hw_ents);
961 void usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe,
962 struct scatterlist *sg, int n_hw_ents);
964 /*-------------------------------------------------------------------*
965 * SYNCHRONOUS CALL SUPPORT *
966 *-------------------------------------------------------------------*/
968 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
969 __u8 request, __u8 requesttype, __u16 value, __u16 index,
970 void *data, __u16 size, int timeout);
971 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
972 void *data, int len, int *actual_length,
975 /* wrappers around usb_control_msg() for the most common standard requests */
976 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
977 unsigned char descindex, void *buf, int size);
978 extern int usb_get_status(struct usb_device *dev,
979 int type, int target, void *data);
980 extern int usb_get_string(struct usb_device *dev,
981 unsigned short langid, unsigned char index, void *buf, int size);
982 extern int usb_string(struct usb_device *dev, int index,
983 char *buf, size_t size);
985 /* wrappers that also update important state inside usbcore */
986 extern int usb_clear_halt(struct usb_device *dev, int pipe);
987 extern int usb_reset_configuration(struct usb_device *dev);
988 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
991 * timeouts, in milliseconds, used for sending/receiving control messages
992 * they typically complete within a few frames (msec) after they're issued
993 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
994 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
996 #define USB_CTRL_GET_TIMEOUT 5000
997 #define USB_CTRL_SET_TIMEOUT 5000
1001 * struct usb_sg_request - support for scatter/gather I/O
1002 * @status: zero indicates success, else negative errno
1003 * @bytes: counts bytes transferred.
1005 * These requests are initialized using usb_sg_init(), and then are used
1006 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1007 * members of the request object aren't for driver access.
1009 * The status and bytecount values are valid only after usb_sg_wait()
1010 * returns. If the status is zero, then the bytecount matches the total
1013 * After an error completion, drivers may need to clear a halt condition
1016 struct usb_sg_request {
1021 * members below are private to usbcore,
1022 * and are not provided for driver access!
1026 struct usb_device *dev;
1028 struct scatterlist *sg;
1035 struct completion complete;
1039 struct usb_sg_request *io,
1040 struct usb_device *dev,
1043 struct scatterlist *sg,
1048 void usb_sg_cancel (struct usb_sg_request *io);
1049 void usb_sg_wait (struct usb_sg_request *io);
1052 /* -------------------------------------------------------------------------- */
1055 * For various legacy reasons, Linux has a small cookie that's paired with
1056 * a struct usb_device to identify an endpoint queue. Queue characteristics
1057 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1058 * an unsigned int encoded as:
1060 * - direction: bit 7 (0 = Host-to-Device [Out],
1061 * 1 = Device-to-Host [In] ...
1062 * like endpoint bEndpointAddress)
1063 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1064 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1065 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1066 * 10 = control, 11 = bulk)
1068 * Given the device address and endpoint descriptor, pipes are redundant.
1071 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1072 /* (yet ... they're the values used by usbfs) */
1073 #define PIPE_ISOCHRONOUS 0
1074 #define PIPE_INTERRUPT 1
1075 #define PIPE_CONTROL 2
1078 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1079 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1081 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1082 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1084 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1085 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1086 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1087 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1088 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1090 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1091 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1092 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
1093 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | ((bit) << (ep)))
1096 static inline unsigned int __create_pipe(struct usb_device *dev, unsigned int endpoint)
1098 return (dev->devnum << 8) | (endpoint << 15);
1101 /* Create various pipes... */
1102 #define usb_sndctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1103 #define usb_rcvctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1104 #define usb_sndisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1105 #define usb_rcvisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1106 #define usb_sndbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1107 #define usb_rcvbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1108 #define usb_sndintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1109 #define usb_rcvintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1111 /*-------------------------------------------------------------------------*/
1114 usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1116 struct usb_host_endpoint *ep;
1117 unsigned epnum = usb_pipeendpoint(pipe);
1120 WARN_ON(usb_pipein(pipe));
1121 ep = udev->ep_out[epnum];
1123 WARN_ON(usb_pipeout(pipe));
1124 ep = udev->ep_in[epnum];
1129 /* NOTE: only 0x07ff bits are for packet size... */
1130 return le16_to_cpu(ep->desc.wMaxPacketSize);
1133 /* -------------------------------------------------------------------------- */
1135 /* Events from the usb core */
1136 #define USB_DEVICE_ADD 0x0001
1137 #define USB_DEVICE_REMOVE 0x0002
1138 #define USB_BUS_ADD 0x0003
1139 #define USB_BUS_REMOVE 0x0004
1140 extern void usb_register_notify(struct notifier_block *nb);
1141 extern void usb_unregister_notify(struct notifier_block *nb);
1144 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg)
1146 #define dbg(format, arg...) do {} while (0)
1149 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , __FILE__ , ## arg)
1150 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , __FILE__ , ## arg)
1151 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , __FILE__ , ## arg)
1154 #endif /* __KERNEL__ */