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 */
65 * struct usb_interface - what usb device drivers talk to
66 * @altsetting: array of interface structures, one for each alternate
67 * setting that may be selected. Each one includes a set of
68 * endpoint configurations. They will be in no particular order.
69 * @num_altsetting: number of altsettings defined.
70 * @cur_altsetting: the current altsetting.
71 * @driver: the USB driver that is bound to this interface.
72 * @minor: the minor number assigned to this interface, if this
73 * interface is bound to a driver that uses the USB major number.
74 * If this interface does not use the USB major, this field should
75 * be unused. The driver should set this value in the probe()
76 * function of the driver, after it has been assigned a minor
77 * number from the USB core by calling usb_register_dev().
78 * @dev: driver model's view of this device
79 * @class_dev: driver model's class view of this device.
81 * USB device drivers attach to interfaces on a physical device. Each
82 * interface encapsulates a single high level function, such as feeding
83 * an audio stream to a speaker or reporting a change in a volume control.
84 * Many USB devices only have one interface. The protocol used to talk to
85 * an interface's endpoints can be defined in a usb "class" specification,
86 * or by a product's vendor. The (default) control endpoint is part of
87 * every interface, but is never listed among the interface's descriptors.
89 * The driver that is bound to the interface can use standard driver model
90 * calls such as dev_get_drvdata() on the dev member of this structure.
92 * Each interface may have alternate settings. The initial configuration
93 * of a device sets altsetting 0, but the device driver can change
94 * that setting using usb_set_interface(). Alternate settings are often
95 * used to control the the use of periodic endpoints, such as by having
96 * different endpoints use different amounts of reserved USB bandwidth.
97 * All standards-conformant USB devices that use isochronous endpoints
98 * will use them in non-default settings.
100 * The USB specification says that alternate setting numbers must run from
101 * 0 to one less than the total number of alternate settings. But some
102 * devices manage to mess this up, and the structures aren't necessarily
103 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
104 * look up an alternate setting in the altsetting array based on its number.
106 struct usb_interface {
107 /* array of alternate settings for this interface,
108 * stored in no particular order */
109 struct usb_host_interface *altsetting;
111 struct usb_host_interface *cur_altsetting; /* the currently
112 * active alternate setting */
113 unsigned num_altsetting; /* number of alternate settings */
115 int minor; /* minor number this interface is bound to */
116 struct device dev; /* interface specific device info */
117 struct class_device *class_dev;
119 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
120 #define interface_to_usbdev(intf) \
121 container_of(intf->dev.parent, struct usb_device, dev)
123 static inline void *usb_get_intfdata (struct usb_interface *intf)
125 return dev_get_drvdata (&intf->dev);
128 static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
130 dev_set_drvdata(&intf->dev, data);
133 struct usb_interface *usb_get_intf(struct usb_interface *intf);
134 void usb_put_intf(struct usb_interface *intf);
136 /* this maximum is arbitrary */
137 #define USB_MAXINTERFACES 32
140 * struct usb_interface_cache - long-term representation of a device interface
141 * @num_altsetting: number of altsettings defined.
142 * @ref: reference counter.
143 * @altsetting: variable-length array of interface structures, one for
144 * each alternate setting that may be selected. Each one includes a
145 * set of endpoint configurations. They will be in no particular order.
147 * These structures persist for the lifetime of a usb_device, unlike
148 * struct usb_interface (which persists only as long as its configuration
149 * is installed). The altsetting arrays can be accessed through these
150 * structures at any time, permitting comparison of configurations and
151 * providing support for the /proc/bus/usb/devices pseudo-file.
153 struct usb_interface_cache {
154 unsigned num_altsetting; /* number of alternate settings */
155 struct kref ref; /* reference counter */
157 /* variable-length array of alternate settings for this interface,
158 * stored in no particular order */
159 struct usb_host_interface altsetting[0];
161 #define ref_to_usb_interface_cache(r) \
162 container_of(r, struct usb_interface_cache, ref)
163 #define altsetting_to_usb_interface_cache(a) \
164 container_of(a, struct usb_interface_cache, altsetting[0])
167 * struct usb_host_config - representation of a device's configuration
168 * @desc: the device's configuration descriptor.
169 * @interface: array of pointers to usb_interface structures, one for each
170 * interface in the configuration. The number of interfaces is stored
171 * in desc.bNumInterfaces. These pointers are valid only while the
172 * the configuration is active.
173 * @intf_cache: array of pointers to usb_interface_cache structures, one
174 * for each interface in the configuration. These structures exist
175 * for the entire life of the device.
176 * @extra: pointer to buffer containing all extra descriptors associated
177 * with this configuration (those preceding the first interface
179 * @extralen: length of the extra descriptors buffer.
181 * USB devices may have multiple configurations, but only one can be active
182 * at any time. Each encapsulates a different operational environment;
183 * for example, a dual-speed device would have separate configurations for
184 * full-speed and high-speed operation. The number of configurations
185 * available is stored in the device descriptor as bNumConfigurations.
187 * A configuration can contain multiple interfaces. Each corresponds to
188 * a different function of the USB device, and all are available whenever
189 * the configuration is active. The USB standard says that interfaces
190 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
191 * of devices get this wrong. In addition, the interface array is not
192 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
193 * look up an interface entry based on its number.
195 * Device drivers should not attempt to activate configurations. The choice
196 * of which configuration to install is a policy decision based on such
197 * considerations as available power, functionality provided, and the user's
198 * desires (expressed through hotplug scripts). However, drivers can call
199 * usb_reset_configuration() to reinitialize the current configuration and
200 * all its interfaces.
202 struct usb_host_config {
203 struct usb_config_descriptor desc;
205 /* the interfaces associated with this configuration,
206 * stored in no particular order */
207 struct usb_interface *interface[USB_MAXINTERFACES];
209 /* Interface information available even when this is not the
210 * active configuration */
211 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
213 unsigned char *extra; /* Extra descriptors */
217 // FIXME remove; exported only for drivers/usb/misc/auserwald.c
218 // prefer usb_device->epnum[0..31]
219 extern struct usb_endpoint_descriptor *
220 usb_epnum_to_ep_desc(struct usb_device *dev, unsigned epnum);
222 int __usb_get_extra_descriptor(char *buffer, unsigned size,
223 unsigned char type, void **ptr);
224 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
225 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
228 /* -------------------------------------------------------------------------- */
230 struct usb_operations;
232 /* USB device number allocation bitmap */
234 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
238 * Allocated per bus (tree of devices) we have:
241 struct device *controller; /* host/master side hardware */
242 int busnum; /* Bus number (in order of reg) */
243 char *bus_name; /* stable id (PCI slot_name etc) */
244 u8 otg_port; /* 0, or number of OTG/HNP port */
245 unsigned is_b_host:1; /* true during some HNP roleswitches */
246 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
248 int devnum_next; /* Next open device number in round-robin allocation */
250 struct usb_devmap devmap; /* device address allocation map */
251 struct usb_operations *op; /* Operations (specific to the HC) */
252 struct usb_device *root_hub; /* Root hub */
253 struct list_head bus_list; /* list of busses */
254 void *hcpriv; /* Host Controller private data */
256 int bandwidth_allocated; /* on this bus: how much of the time
257 * reserved for periodic (intr/iso)
258 * requests is used, on average?
259 * Units: microseconds/frame.
260 * Limits: Full/low speed reserve 90%,
261 * while high speed reserves 80%.
263 int bandwidth_int_reqs; /* number of Interrupt requests */
264 int bandwidth_isoc_reqs; /* number of Isoc. requests */
266 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
267 struct dentry *usbdevfs_dentry; /* usbdevfs dentry entry for the bus */
269 struct class_device class_dev; /* class device for this bus */
270 void (*release)(struct usb_bus *bus); /* function to destroy this bus's memory */
272 #define to_usb_bus(d) container_of(d, struct usb_bus, class_dev)
275 /* -------------------------------------------------------------------------- */
277 /* This is arbitrary.
278 * From USB 2.0 spec Table 11-13, offset 7, a hub can
279 * have up to 255 ports. The most yet reported is 10.
281 #define USB_MAXCHILDREN (16)
286 int devnum; /* Address on USB bus */
287 char devpath [16]; /* Use in messages: /port/port/... */
288 enum usb_device_state state; /* configured, not attached, etc */
289 enum usb_device_speed speed; /* high/full/low (or error) */
291 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
292 int ttport; /* device port on that tt hub */
294 struct semaphore serialize;
296 unsigned int toggle[2]; /* one bit for each endpoint ([0] = IN, [1] = OUT) */
297 unsigned int halted[2]; /* endpoint halts; one bit per endpoint # & direction; */
298 /* [0] = IN, [1] = OUT */
299 int epmaxpacketin[16]; /* INput endpoint specific maximums */
300 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
302 struct usb_device *parent; /* our hub, unless we're the root */
303 struct usb_bus *bus; /* Bus we're part of */
305 struct device dev; /* Generic device interface */
307 struct usb_device_descriptor descriptor;/* Descriptor */
308 struct usb_host_config *config; /* All of the configs */
309 struct usb_host_config *actconfig;/* the active configuration */
311 char **rawdescriptors; /* Raw descriptors for each config */
313 int have_langid; /* whether string_langid is valid yet */
314 int string_langid; /* language ID for strings */
316 void *hcpriv; /* Host Controller private data */
318 struct list_head filelist;
319 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
320 struct dentry *usbdevfs_dentry; /* usbdevfs dentry entry for the device */
323 * Child devices - these can be either new devices
324 * (if this is a hub device), or different instances
325 * of this same device.
327 * Each instance needs its own set of data structures.
330 int maxchild; /* Number of ports if hub */
331 struct usb_device *children[USB_MAXCHILDREN];
333 #define to_usb_device(d) container_of(d, struct usb_device, dev)
335 extern struct usb_device *usb_get_dev(struct usb_device *dev);
336 extern void usb_put_dev(struct usb_device *dev);
338 /* mostly for devices emulating SCSI over USB */
339 extern int usb_reset_device(struct usb_device *dev);
340 extern int __usb_reset_device(struct usb_device *dev);
342 extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
344 /* for drivers using iso endpoints */
345 extern int usb_get_current_frame_number (struct usb_device *usb_dev);
347 /* used these for multi-interface device registration */
348 extern int usb_driver_claim_interface(struct usb_driver *driver,
349 struct usb_interface *iface, void* priv);
352 * usb_interface_claimed - returns true iff an interface is claimed
353 * @iface: the interface being checked
355 * Returns true (nonzero) iff the interface is claimed, else false (zero).
356 * Callers must own the driver model's usb bus readlock. So driver
357 * probe() entries don't need extra locking, but other call contexts
358 * may need to explicitly claim that lock.
361 static inline int usb_interface_claimed(struct usb_interface *iface) {
362 return (iface->dev.driver != NULL);
365 extern void usb_driver_release_interface(struct usb_driver *driver,
366 struct usb_interface *iface);
367 const struct usb_device_id *usb_match_id(struct usb_interface *interface,
368 const struct usb_device_id *id);
370 extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
372 extern struct usb_interface *usb_ifnum_to_if(struct usb_device *dev,
374 extern struct usb_host_interface *usb_altnum_to_altsetting(
375 struct usb_interface *intf, unsigned int altnum);
379 * usb_make_path - returns stable device path in the usb tree
380 * @dev: the device whose path is being constructed
381 * @buf: where to put the string
382 * @size: how big is "buf"?
384 * Returns length of the string (> 0) or negative if size was too small.
386 * This identifier is intended to be "stable", reflecting physical paths in
387 * hardware such as physical bus addresses for host controllers or ports on
388 * USB hubs. That makes it stay the same until systems are physically
389 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
390 * controllers. Adding and removing devices, including virtual root hubs
391 * in host controller driver modules, does not change these path identifers;
392 * neither does rebooting or re-enumerating. These are more useful identifiers
393 * than changeable ("unstable") ones like bus numbers or device addresses.
395 * With a partial exception for devices connected to USB 2.0 root hubs, these
396 * identifiers are also predictable. So long as the device tree isn't changed,
397 * plugging any USB device into a given hub port always gives it the same path.
398 * Because of the use of "companion" controllers, devices connected to ports on
399 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
400 * high speed, and a different one if they are full or low speed.
402 static inline int usb_make_path (struct usb_device *dev, char *buf, size_t size)
405 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name, dev->devpath);
406 return (actual >= (int)size) ? -1 : actual;
409 /*-------------------------------------------------------------------------*/
411 #define USB_DEVICE_ID_MATCH_DEVICE (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
412 #define USB_DEVICE_ID_MATCH_DEV_RANGE (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
413 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
414 #define USB_DEVICE_ID_MATCH_DEV_INFO \
415 (USB_DEVICE_ID_MATCH_DEV_CLASS | USB_DEVICE_ID_MATCH_DEV_SUBCLASS | USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
416 #define USB_DEVICE_ID_MATCH_INT_INFO \
417 (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS | USB_DEVICE_ID_MATCH_INT_PROTOCOL)
420 * USB_DEVICE - macro used to describe a specific usb device
421 * @vend: the 16 bit USB Vendor ID
422 * @prod: the 16 bit USB Product ID
424 * This macro is used to create a struct usb_device_id that matches a
427 #define USB_DEVICE(vend,prod) \
428 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), .idProduct = (prod)
430 * USB_DEVICE_VER - macro used to describe a specific usb device with a version range
431 * @vend: the 16 bit USB Vendor ID
432 * @prod: the 16 bit USB Product ID
433 * @lo: the bcdDevice_lo value
434 * @hi: the bcdDevice_hi value
436 * This macro is used to create a struct usb_device_id that matches a
437 * specific device, with a version range.
439 #define USB_DEVICE_VER(vend,prod,lo,hi) \
440 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, .idVendor = (vend), .idProduct = (prod), .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
443 * USB_DEVICE_INFO - macro used to describe a class of usb devices
444 * @cl: bDeviceClass value
445 * @sc: bDeviceSubClass value
446 * @pr: bDeviceProtocol value
448 * This macro is used to create a struct usb_device_id that matches a
449 * specific class of devices.
451 #define USB_DEVICE_INFO(cl,sc,pr) \
452 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
455 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
456 * @cl: bInterfaceClass value
457 * @sc: bInterfaceSubClass value
458 * @pr: bInterfaceProtocol value
460 * This macro is used to create a struct usb_device_id that matches a
461 * specific class of interfaces.
463 #define USB_INTERFACE_INFO(cl,sc,pr) \
464 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
466 /* -------------------------------------------------------------------------- */
469 * struct usb_driver - identifies USB driver to usbcore
470 * @owner: Pointer to the module owner of this driver; initialize
471 * it using THIS_MODULE.
472 * @name: The driver name should be unique among USB drivers,
473 * and should normally be the same as the module name.
474 * @probe: Called to see if the driver is willing to manage a particular
475 * interface on a device. If it is, probe returns zero and uses
476 * dev_set_drvdata() to associate driver-specific data with the
477 * interface. It may also use usb_set_interface() to specify the
478 * appropriate altsetting. If unwilling to manage the interface,
479 * return a negative errno value.
480 * @disconnect: Called when the interface is no longer accessible, usually
481 * because its device has been (or is being) disconnected or the
482 * driver module is being unloaded.
483 * @ioctl: Used for drivers that want to talk to userspace through
484 * the "usbfs" filesystem. This lets devices provide ways to
485 * expose information to user space regardless of where they
486 * do (or don't) show up otherwise in the filesystem.
487 * @suspend: Called when the device is going to be suspended by the system.
488 * @resume: Called when the device is being resumed by the system.
489 * @id_table: USB drivers use ID table to support hotplugging.
490 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
491 * or your driver's probe function will never get called.
492 * @driver: the driver model core driver structure.
494 * USB drivers must provide a name, probe() and disconnect() methods,
495 * and an id_table. Other driver fields are optional.
497 * The id_table is used in hotplugging. It holds a set of descriptors,
498 * and specialized data may be associated with each entry. That table
499 * is used by both user and kernel mode hotplugging support.
501 * The probe() and disconnect() methods are called in a context where
502 * they can sleep, but they should avoid abusing the privilege. Most
503 * work to connect to a device should be done when the device is opened,
504 * and undone at the last close. The disconnect code needs to address
505 * concurrency issues with respect to open() and close() methods, as
506 * well as forcing all pending I/O requests to complete (by unlinking
507 * them as necessary, and blocking until the unlinks complete).
510 struct module *owner;
514 int (*probe) (struct usb_interface *intf,
515 const struct usb_device_id *id);
517 void (*disconnect) (struct usb_interface *intf);
519 int (*ioctl) (struct usb_interface *intf, unsigned int code, void *buf);
521 int (*suspend) (struct usb_interface *intf, u32 state);
522 int (*resume) (struct usb_interface *intf);
524 const struct usb_device_id *id_table;
526 struct device_driver driver;
528 #define to_usb_driver(d) container_of(d, struct usb_driver, driver)
530 extern struct bus_type usb_bus_type;
533 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
534 * @name: devfs name for this driver. Will also be used by the driver
535 * class code to create a usb class device.
536 * @fops: pointer to the struct file_operations of this driver.
537 * @mode: the mode for the devfs file to be created for this driver.
538 * @minor_base: the start of the minor range for this driver.
540 * This structure is used for the usb_register_dev() and
541 * usb_unregister_dev() functions, to consolidate a number of the
542 * parameters used for them.
544 struct usb_class_driver {
546 struct file_operations *fops;
552 * use these in module_init()/module_exit()
553 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
555 extern int usb_register(struct usb_driver *);
556 extern void usb_deregister(struct usb_driver *);
558 extern int usb_register_dev(struct usb_interface *intf,
559 struct usb_class_driver *class_driver);
560 extern void usb_deregister_dev(struct usb_interface *intf,
561 struct usb_class_driver *class_driver);
563 extern int usb_disabled(void);
565 /* -------------------------------------------------------------------------- */
568 * URB support, for asynchronous request completions
572 * urb->transfer_flags:
574 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
575 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame ignored */
576 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
577 #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
578 #define URB_ASYNC_UNLINK 0x0010 /* usb_unlink_urb() returns asap */
579 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
580 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUTs with short packet */
581 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt needed */
583 struct usb_iso_packet_descriptor {
585 unsigned int length; /* expected length */
586 unsigned int actual_length;
593 typedef void (*usb_complete_t)(struct urb *, struct pt_regs *);
596 * struct urb - USB Request Block
597 * @urb_list: For use by current owner of the URB.
598 * @pipe: Holds endpoint number, direction, type, and more.
599 * Create these values with the eight macros available;
600 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
601 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
602 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
603 * numbers range from zero to fifteen. Note that "in" endpoint two
604 * is a different endpoint (and pipe) from "out" endpoint two.
605 * The current configuration controls the existence, type, and
606 * maximum packet size of any given endpoint.
607 * @dev: Identifies the USB device to perform the request.
608 * @status: This is read in non-iso completion functions to get the
609 * status of the particular request. ISO requests only use it
610 * to tell whether the URB was unlinked; detailed status for
611 * each frame is in the fields of the iso_frame-desc.
612 * @transfer_flags: A variety of flags may be used to affect how URB
613 * submission, unlinking, or operation are handled. Different
614 * kinds of URB can use different flags.
615 * @transfer_buffer: This identifies the buffer to (or from) which
616 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
617 * is set). This buffer must be suitable for DMA; allocate it with
618 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
619 * of this buffer will be modified. This buffer is used for the data
620 * stage of control transfers.
621 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
622 * the device driver is saying that it provided this DMA address,
623 * which the host controller driver should use in preference to the
625 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
626 * be broken up into chunks according to the current maximum packet
627 * size for the endpoint, which is a function of the configuration
628 * and is encoded in the pipe. When the length is zero, neither
629 * transfer_buffer nor transfer_dma is used.
630 * @actual_length: This is read in non-iso completion functions, and
631 * it tells how many bytes (out of transfer_buffer_length) were
632 * transferred. It will normally be the same as requested, unless
633 * either an error was reported or a short read was performed.
634 * The URB_SHORT_NOT_OK transfer flag may be used to make such
635 * short reads be reported as errors.
636 * @setup_packet: Only used for control transfers, this points to eight bytes
637 * of setup data. Control transfers always start by sending this data
638 * to the device. Then transfer_buffer is read or written, if needed.
639 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
640 * device driver has provided this DMA address for the setup packet.
641 * The host controller driver should use this in preference to
643 * @start_frame: Returns the initial frame for isochronous transfers.
644 * @number_of_packets: Lists the number of ISO transfer buffers.
645 * @interval: Specifies the polling interval for interrupt or isochronous
646 * transfers. The units are frames (milliseconds) for for full and low
647 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
648 * @error_count: Returns the number of ISO transfers that reported errors.
649 * @context: For use in completion functions. This normally points to
650 * request-specific driver context.
651 * @complete: Completion handler. This URB is passed as the parameter to the
652 * completion function. The completion function may then do what
653 * it likes with the URB, including resubmitting or freeing it.
654 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
655 * collect the transfer status for each buffer.
656 * @timeout: If set to zero, the urb will never timeout. Otherwise this is
657 * the time in jiffies that this urb will timeout in.
659 * This structure identifies USB transfer requests. URBs must be allocated by
660 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
661 * Initialization may be done using various usb_fill_*_urb() functions. URBs
662 * are submitted using usb_submit_urb(), and pending requests may be canceled
663 * using usb_unlink_urb() or usb_kill_urb().
665 * Data Transfer Buffers:
667 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
668 * taken from the general page pool. That is provided by transfer_buffer
669 * (control requests also use setup_packet), and host controller drivers
670 * perform a dma mapping (and unmapping) for each buffer transferred. Those
671 * mapping operations can be expensive on some platforms (perhaps using a dma
672 * bounce buffer or talking to an IOMMU),
673 * although they're cheap on commodity x86 and ppc hardware.
675 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
676 * which tell the host controller driver that no such mapping is needed since
677 * the device driver is DMA-aware. For example, a device driver might
678 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
679 * When these transfer flags are provided, host controller drivers will
680 * attempt to use the dma addresses found in the transfer_dma and/or
681 * setup_dma fields rather than determining a dma address themselves. (Note
682 * that transfer_buffer and setup_packet must still be set because not all
683 * host controllers use DMA, nor do virtual root hubs).
687 * All URBs submitted must initialize dev, pipe,
688 * transfer_flags (may be zero), complete, timeout (may be zero).
689 * The URB_ASYNC_UNLINK transfer flag affects later invocations of
690 * the usb_unlink_urb() routine. Note: Failure to set URB_ASYNC_UNLINK
691 * with usb_unlink_urb() is deprecated. For synchronous unlinks use
692 * usb_kill_urb() instead.
694 * All URBs must also initialize
695 * transfer_buffer and transfer_buffer_length. They may provide the
696 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
697 * to be treated as errors; that flag is invalid for write requests.
700 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
701 * should always terminate with a short packet, even if it means adding an
702 * extra zero length packet.
704 * Control URBs must provide a setup_packet. The setup_packet and
705 * transfer_buffer may each be mapped for DMA or not, independently of
706 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
707 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
708 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
710 * Interrupt URBs must provide an interval, saying how often (in milliseconds
711 * or, for highspeed devices, 125 microsecond units)
712 * to poll for transfers. After the URB has been submitted, the interval
713 * field reflects how the transfer was actually scheduled.
714 * The polling interval may be more frequent than requested.
715 * For example, some controllers have a maximum interval of 32 microseconds,
716 * while others support intervals of up to 1024 microseconds.
717 * Isochronous URBs also have transfer intervals. (Note that for isochronous
718 * endpoints, as well as high speed interrupt endpoints, the encoding of
719 * the transfer interval in the endpoint descriptor is logarithmic.
720 * Device drivers must convert that value to linear units themselves.)
722 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
723 * the host controller to schedule the transfer as soon as bandwidth
724 * utilization allows, and then set start_frame to reflect the actual frame
725 * selected during submission. Otherwise drivers must specify the start_frame
726 * and handle the case where the transfer can't begin then. However, drivers
727 * won't know how bandwidth is currently allocated, and while they can
728 * find the current frame using usb_get_current_frame_number () they can't
729 * know the range for that frame number. (Ranges for frame counter values
730 * are HC-specific, and can go from 256 to 65536 frames from "now".)
732 * Isochronous URBs have a different data transfer model, in part because
733 * the quality of service is only "best effort". Callers provide specially
734 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
735 * at the end. Each such packet is an individual ISO transfer. Isochronous
736 * URBs are normally queued, submitted by drivers to arrange that
737 * transfers are at least double buffered, and then explicitly resubmitted
738 * in completion handlers, so
739 * that data (such as audio or video) streams at as constant a rate as the
740 * host controller scheduler can support.
742 * Completion Callbacks:
744 * The completion callback is made in_interrupt(), and one of the first
745 * things that a completion handler should do is check the status field.
746 * The status field is provided for all URBs. It is used to report
747 * unlinked URBs, and status for all non-ISO transfers. It should not
748 * be examined before the URB is returned to the completion handler.
750 * The context field is normally used to link URBs back to the relevant
751 * driver or request state.
753 * When the completion callback is invoked for non-isochronous URBs, the
754 * actual_length field tells how many bytes were transferred. This field
755 * is updated even when the URB terminated with an error or was unlinked.
757 * ISO transfer status is reported in the status and actual_length fields
758 * of the iso_frame_desc array, and the number of errors is reported in
759 * error_count. Completion callbacks for ISO transfers will normally
760 * (re)submit URBs to ensure a constant transfer rate.
764 /* private, usb core and host controller only fields in the urb */
765 struct kref kref; /* reference count of the URB */
766 spinlock_t lock; /* lock for the URB */
767 void *hcpriv; /* private data for host controller */
768 struct list_head urb_list; /* list pointer to all active urbs */
769 int bandwidth; /* bandwidth for INT/ISO request */
770 atomic_t use_count; /* concurrent submissions counter */
771 u8 reject; /* submissions will fail */
773 /* public, documented fields in the urb that can be used by drivers */
774 struct usb_device *dev; /* (in) pointer to associated device */
775 unsigned int pipe; /* (in) pipe information */
776 int status; /* (return) non-ISO status */
777 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
778 void *transfer_buffer; /* (in) associated data buffer */
779 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
780 int transfer_buffer_length; /* (in) data buffer length */
781 int actual_length; /* (return) actual transfer length */
782 unsigned char *setup_packet; /* (in) setup packet (control only) */
783 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
784 int start_frame; /* (modify) start frame (ISO) */
785 int number_of_packets; /* (in) number of ISO packets */
786 int interval; /* (modify) transfer interval (INT/ISO) */
787 int error_count; /* (return) number of ISO errors */
788 int timeout; /* (in) timeout, in jiffies */
789 void *context; /* (in) context for completion */
790 usb_complete_t complete; /* (in) completion routine */
791 struct usb_iso_packet_descriptor iso_frame_desc[0]; /* (in) ISO ONLY */
794 /* -------------------------------------------------------------------------- */
797 * usb_fill_control_urb - initializes a control urb
798 * @urb: pointer to the urb to initialize.
799 * @dev: pointer to the struct usb_device for this urb.
800 * @pipe: the endpoint pipe
801 * @setup_packet: pointer to the setup_packet buffer
802 * @transfer_buffer: pointer to the transfer buffer
803 * @buffer_length: length of the transfer buffer
804 * @complete: pointer to the usb_complete_t function
805 * @context: what to set the urb context to.
807 * Initializes a control urb with the proper information needed to submit
810 static inline void usb_fill_control_urb (struct urb *urb,
811 struct usb_device *dev,
813 unsigned char *setup_packet,
814 void *transfer_buffer,
816 usb_complete_t complete,
819 spin_lock_init(&urb->lock);
822 urb->setup_packet = setup_packet;
823 urb->transfer_buffer = transfer_buffer;
824 urb->transfer_buffer_length = buffer_length;
825 urb->complete = complete;
826 urb->context = context;
830 * usb_fill_bulk_urb - macro to help initialize a bulk 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 * @transfer_buffer: pointer to the transfer buffer
835 * @buffer_length: length of the transfer buffer
836 * @complete: pointer to the usb_complete_t function
837 * @context: what to set the urb context to.
839 * Initializes a bulk urb with the proper information needed to submit it
842 static inline void usb_fill_bulk_urb (struct urb *urb,
843 struct usb_device *dev,
845 void *transfer_buffer,
847 usb_complete_t complete,
850 spin_lock_init(&urb->lock);
853 urb->transfer_buffer = transfer_buffer;
854 urb->transfer_buffer_length = buffer_length;
855 urb->complete = complete;
856 urb->context = context;
860 * usb_fill_int_urb - macro to help initialize a interrupt urb
861 * @urb: pointer to the urb to initialize.
862 * @dev: pointer to the struct usb_device for this urb.
863 * @pipe: the endpoint pipe
864 * @transfer_buffer: pointer to the transfer buffer
865 * @buffer_length: length of the transfer buffer
866 * @complete: pointer to the usb_complete_t function
867 * @context: what to set the urb context to.
868 * @interval: what to set the urb interval to, encoded like
869 * the endpoint descriptor's bInterval value.
871 * Initializes a interrupt urb with the proper information needed to submit
873 * Note that high speed interrupt endpoints use a logarithmic encoding of
874 * the endpoint interval, and express polling intervals in microframes
875 * (eight per millisecond) rather than in frames (one per millisecond).
877 static inline void usb_fill_int_urb (struct urb *urb,
878 struct usb_device *dev,
880 void *transfer_buffer,
882 usb_complete_t complete,
886 spin_lock_init(&urb->lock);
889 urb->transfer_buffer = transfer_buffer;
890 urb->transfer_buffer_length = buffer_length;
891 urb->complete = complete;
892 urb->context = context;
893 if (dev->speed == USB_SPEED_HIGH)
894 urb->interval = 1 << (interval - 1);
896 urb->interval = interval;
897 urb->start_frame = -1;
900 extern void usb_init_urb(struct urb *urb);
901 extern struct urb *usb_alloc_urb(int iso_packets, int mem_flags);
902 extern void usb_free_urb(struct urb *urb);
903 #define usb_put_urb usb_free_urb
904 extern struct urb *usb_get_urb(struct urb *urb);
905 extern int usb_submit_urb(struct urb *urb, int mem_flags);
906 extern int usb_unlink_urb(struct urb *urb);
907 extern void usb_kill_urb(struct urb *urb);
909 #define HAVE_USB_BUFFERS
910 void *usb_buffer_alloc (struct usb_device *dev, size_t size,
911 int mem_flags, dma_addr_t *dma);
912 void usb_buffer_free (struct usb_device *dev, size_t size,
913 void *addr, dma_addr_t dma);
915 struct urb *usb_buffer_map (struct urb *urb);
917 void usb_buffer_dmasync (struct urb *urb);
919 void usb_buffer_unmap (struct urb *urb);
922 int usb_buffer_map_sg (struct usb_device *dev, unsigned pipe,
923 struct scatterlist *sg, int nents);
925 void usb_buffer_dmasync_sg (struct usb_device *dev, unsigned pipe,
926 struct scatterlist *sg, int n_hw_ents);
928 void usb_buffer_unmap_sg (struct usb_device *dev, unsigned pipe,
929 struct scatterlist *sg, int n_hw_ents);
931 /*-------------------------------------------------------------------*
932 * SYNCHRONOUS CALL SUPPORT *
933 *-------------------------------------------------------------------*/
935 extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
936 __u8 request, __u8 requesttype, __u16 value, __u16 index,
937 void *data, __u16 size, int timeout);
938 extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
939 void *data, int len, int *actual_length,
942 /* selective suspend/resume */
943 extern int usb_suspend_device(struct usb_device *dev, u32 state);
944 extern int usb_resume_device(struct usb_device *dev);
947 /* wrappers around usb_control_msg() for the most common standard requests */
948 extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
949 unsigned char descindex, void *buf, int size);
950 extern int usb_get_status(struct usb_device *dev,
951 int type, int target, void *data);
952 extern int usb_get_string(struct usb_device *dev,
953 unsigned short langid, unsigned char index, void *buf, int size);
954 extern int usb_string(struct usb_device *dev, int index,
955 char *buf, size_t size);
957 /* wrappers that also update important state inside usbcore */
958 extern int usb_clear_halt(struct usb_device *dev, int pipe);
959 extern int usb_reset_configuration(struct usb_device *dev);
960 extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
963 * timeouts, in seconds, used for sending/receiving control messages
964 * they typically complete within a few frames (msec) after they're issued
965 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
966 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
968 #define USB_CTRL_GET_TIMEOUT 5
969 #define USB_CTRL_SET_TIMEOUT 5
973 * struct usb_sg_request - support for scatter/gather I/O
974 * @status: zero indicates success, else negative errno
975 * @bytes: counts bytes transferred.
977 * These requests are initialized using usb_sg_init(), and then are used
978 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
979 * members of the request object aren't for driver access.
981 * The status and bytecount values are valid only after usb_sg_wait()
982 * returns. If the status is zero, then the bytecount matches the total
985 * After an error completion, drivers may need to clear a halt condition
988 struct usb_sg_request {
993 * members below are private to usbcore,
994 * and are not provided for driver access!
998 struct usb_device *dev;
1000 struct scatterlist *sg;
1007 struct completion complete;
1011 struct usb_sg_request *io,
1012 struct usb_device *dev,
1015 struct scatterlist *sg,
1020 void usb_sg_cancel (struct usb_sg_request *io);
1021 void usb_sg_wait (struct usb_sg_request *io);
1024 /* -------------------------------------------------------------------------- */
1027 * Calling this entity a "pipe" is glorifying it. A USB pipe
1028 * is something embarrassingly simple: it basically consists
1029 * of the following information:
1030 * - device number (7 bits)
1031 * - endpoint number (4 bits)
1032 * - current Data0/1 state (1 bit) [Historical; now gone]
1033 * - direction (1 bit)
1034 * - speed (1 bit) [Historical and specific to USB 1.1; now gone.]
1035 * - max packet size (2 bits: 8, 16, 32 or 64) [Historical; now gone.]
1036 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
1038 * That's 18 bits. Really. Nothing more. And the USB people have
1039 * documented these eighteen bits as some kind of glorious
1040 * virtual data structure.
1042 * Let's not fall in that trap. We'll just encode it as a simple
1043 * unsigned int. The encoding is:
1045 * - max size: bits 0-1 [Historical; now gone.]
1046 * - direction: bit 7 (0 = Host-to-Device [Out],
1047 * 1 = Device-to-Host [In] ...
1048 * like endpoint bEndpointAddress)
1049 * - device: bits 8-14 ... bit positions known to uhci-hcd
1050 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1051 * - Data0/1: bit 19 [Historical; now gone. ]
1052 * - lowspeed: bit 26 [Historical; now gone. ]
1053 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1054 * 10 = control, 11 = bulk)
1056 * Why? Because it's arbitrary, and whatever encoding we select is really
1057 * up to us. This one happens to share a lot of bit positions with the UHCI
1058 * specification, so that much of the uhci driver can just mask the bits
1062 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1063 #define PIPE_ISOCHRONOUS 0
1064 #define PIPE_INTERRUPT 1
1065 #define PIPE_CONTROL 2
1068 #define usb_maxpacket(dev, pipe, out) (out \
1069 ? (dev)->epmaxpacketout[usb_pipeendpoint(pipe)] \
1070 : (dev)->epmaxpacketin [usb_pipeendpoint(pipe)] )
1072 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1073 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1074 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1075 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1076 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1077 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1078 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1079 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1080 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1082 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1083 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1084 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
1085 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | ((bit) << (ep)))
1087 /* Endpoint halt control/status ... likewise USE WITH CAUTION */
1088 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
1089 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
1092 static inline unsigned int __create_pipe(struct usb_device *dev, unsigned int endpoint)
1094 return (dev->devnum << 8) | (endpoint << 15);
1097 /* Create various pipes... */
1098 #define usb_sndctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1099 #define usb_rcvctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1100 #define usb_sndisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1101 #define usb_rcvisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1102 #define usb_sndbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1103 #define usb_rcvbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1104 #define usb_sndintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1105 #define usb_rcvintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1107 /* -------------------------------------------------------------------------- */
1110 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , __FILE__ , ## arg)
1112 #define dbg(format, arg...) do {} while (0)
1115 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , __FILE__ , ## arg)
1116 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , __FILE__ , ## arg)
1117 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , __FILE__ , ## arg)
1120 #endif /* __KERNEL__ */