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