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
55 * @enabled: URBs may be submitted to this endpoint
57 * USB requests are always queued to a given endpoint, identified by a
58 * descriptor within an active interface in a given USB configuration.
60 struct usb_host_endpoint
{
61 struct usb_endpoint_descriptor desc
;
62 struct list_head urb_list
;
64 struct ep_device
*ep_dev
; /* For sysfs info */
66 unsigned char *extra
; /* Extra descriptors */
71 /* host-side wrapper for one interface setting's parsed descriptors */
72 struct usb_host_interface
{
73 struct usb_interface_descriptor desc
;
75 /* array of desc.bNumEndpoint endpoints associated with this
76 * interface setting. these will be in no particular order.
78 struct usb_host_endpoint
*endpoint
;
80 char *string
; /* iInterface string, if present */
81 unsigned char *extra
; /* Extra descriptors */
85 enum usb_interface_condition
{
86 USB_INTERFACE_UNBOUND
= 0,
87 USB_INTERFACE_BINDING
,
89 USB_INTERFACE_UNBINDING
,
93 * struct usb_interface - what usb device drivers talk to
94 * @altsetting: array of interface structures, one for each alternate
95 * setting that may be selected. Each one includes a set of
96 * endpoint configurations. They will be in no particular order.
97 * @num_altsetting: number of altsettings defined.
98 * @cur_altsetting: the current altsetting.
99 * @intf_assoc: interface association descriptor
100 * @driver: the USB driver that is bound to this interface.
101 * @minor: the minor number assigned to this interface, if this
102 * interface is bound to a driver that uses the USB major number.
103 * If this interface does not use the USB major, this field should
104 * be unused. The driver should set this value in the probe()
105 * function of the driver, after it has been assigned a minor
106 * number from the USB core by calling usb_register_dev().
107 * @condition: binding state of the interface: not bound, binding
108 * (in probe()), bound to a driver, or unbinding (in disconnect())
109 * @is_active: flag set when the interface is bound and not suspended.
110 * @unregistering: flag set when the interface is being unregistered
111 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
112 * capability during autosuspend.
113 * @needs_binding: flag set when the driver should be re-probed or unbound
114 * following a reset or suspend operation it doesn't support.
115 * @dev: driver model's view of this device
116 * @usb_dev: if an interface is bound to the USB major, this will point
117 * to the sysfs representation for that device.
118 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
119 * allowed unless the counter is 0.
120 * @reset_ws: Used for scheduling resets from atomic context.
121 * @reset_running: set to 1 if the interface is currently running a
122 * queued reset so that usb_cancel_queued_reset() doesn't try to
123 * remove from the workqueue when running inside the worker
124 * thread. See __usb_queue_reset_device().
126 * USB device drivers attach to interfaces on a physical device. Each
127 * interface encapsulates a single high level function, such as feeding
128 * an audio stream to a speaker or reporting a change in a volume control.
129 * Many USB devices only have one interface. The protocol used to talk to
130 * an interface's endpoints can be defined in a usb "class" specification,
131 * or by a product's vendor. The (default) control endpoint is part of
132 * every interface, but is never listed among the interface's descriptors.
134 * The driver that is bound to the interface can use standard driver model
135 * calls such as dev_get_drvdata() on the dev member of this structure.
137 * Each interface may have alternate settings. The initial configuration
138 * of a device sets altsetting 0, but the device driver can change
139 * that setting using usb_set_interface(). Alternate settings are often
140 * used to control the use of periodic endpoints, such as by having
141 * different endpoints use different amounts of reserved USB bandwidth.
142 * All standards-conformant USB devices that use isochronous endpoints
143 * will use them in non-default settings.
145 * The USB specification says that alternate setting numbers must run from
146 * 0 to one less than the total number of alternate settings. But some
147 * devices manage to mess this up, and the structures aren't necessarily
148 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
149 * look up an alternate setting in the altsetting array based on its number.
151 struct usb_interface
{
152 /* array of alternate settings for this interface,
153 * stored in no particular order */
154 struct usb_host_interface
*altsetting
;
156 struct usb_host_interface
*cur_altsetting
; /* the currently
157 * active alternate setting */
158 unsigned num_altsetting
; /* number of alternate settings */
160 /* If there is an interface association descriptor then it will list
161 * the associated interfaces */
162 struct usb_interface_assoc_descriptor
*intf_assoc
;
164 int minor
; /* minor number this interface is
166 enum usb_interface_condition condition
; /* state of binding */
167 unsigned is_active
:1; /* the interface is not suspended */
168 unsigned sysfs_files_created
:1; /* the sysfs attributes exist */
169 unsigned unregistering
:1; /* unregistration is in progress */
170 unsigned needs_remote_wakeup
:1; /* driver requires remote wakeup */
171 unsigned needs_binding
:1; /* needs delayed unbind/rebind */
172 unsigned reset_running
:1;
174 struct device dev
; /* interface specific device info */
175 struct device
*usb_dev
; /* pointer to the usb class's device, if any */
176 int pm_usage_cnt
; /* usage counter for autosuspend */
177 struct work_struct reset_ws
; /* for resets in atomic context */
179 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
180 #define interface_to_usbdev(intf) \
181 container_of(intf->dev.parent, struct usb_device, dev)
183 static inline void *usb_get_intfdata (struct usb_interface
*intf
)
185 return dev_get_drvdata (&intf
->dev
);
188 static inline void usb_set_intfdata (struct usb_interface
*intf
, void *data
)
190 dev_set_drvdata(&intf
->dev
, data
);
193 struct usb_interface
*usb_get_intf(struct usb_interface
*intf
);
194 void usb_put_intf(struct usb_interface
*intf
);
196 /* this maximum is arbitrary */
197 #define USB_MAXINTERFACES 32
198 #define USB_MAXIADS USB_MAXINTERFACES/2
201 * struct usb_interface_cache - long-term representation of a device interface
202 * @num_altsetting: number of altsettings defined.
203 * @ref: reference counter.
204 * @altsetting: variable-length array of interface structures, one for
205 * each alternate setting that may be selected. Each one includes a
206 * set of endpoint configurations. They will be in no particular order.
208 * These structures persist for the lifetime of a usb_device, unlike
209 * struct usb_interface (which persists only as long as its configuration
210 * is installed). The altsetting arrays can be accessed through these
211 * structures at any time, permitting comparison of configurations and
212 * providing support for the /proc/bus/usb/devices pseudo-file.
214 struct usb_interface_cache
{
215 unsigned num_altsetting
; /* number of alternate settings */
216 struct kref ref
; /* reference counter */
218 /* variable-length array of alternate settings for this interface,
219 * stored in no particular order */
220 struct usb_host_interface altsetting
[0];
222 #define ref_to_usb_interface_cache(r) \
223 container_of(r, struct usb_interface_cache, ref)
224 #define altsetting_to_usb_interface_cache(a) \
225 container_of(a, struct usb_interface_cache, altsetting[0])
228 * struct usb_host_config - representation of a device's configuration
229 * @desc: the device's configuration descriptor.
230 * @string: pointer to the cached version of the iConfiguration string, if
231 * present for this configuration.
232 * @intf_assoc: list of any interface association descriptors in this config
233 * @interface: array of pointers to usb_interface structures, one for each
234 * interface in the configuration. The number of interfaces is stored
235 * in desc.bNumInterfaces. These pointers are valid only while the
236 * the configuration is active.
237 * @intf_cache: array of pointers to usb_interface_cache structures, one
238 * for each interface in the configuration. These structures exist
239 * for the entire life of the device.
240 * @extra: pointer to buffer containing all extra descriptors associated
241 * with this configuration (those preceding the first interface
243 * @extralen: length of the extra descriptors buffer.
245 * USB devices may have multiple configurations, but only one can be active
246 * at any time. Each encapsulates a different operational environment;
247 * for example, a dual-speed device would have separate configurations for
248 * full-speed and high-speed operation. The number of configurations
249 * available is stored in the device descriptor as bNumConfigurations.
251 * A configuration can contain multiple interfaces. Each corresponds to
252 * a different function of the USB device, and all are available whenever
253 * the configuration is active. The USB standard says that interfaces
254 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
255 * of devices get this wrong. In addition, the interface array is not
256 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
257 * look up an interface entry based on its number.
259 * Device drivers should not attempt to activate configurations. The choice
260 * of which configuration to install is a policy decision based on such
261 * considerations as available power, functionality provided, and the user's
262 * desires (expressed through userspace tools). However, drivers can call
263 * usb_reset_configuration() to reinitialize the current configuration and
264 * all its interfaces.
266 struct usb_host_config
{
267 struct usb_config_descriptor desc
;
269 char *string
; /* iConfiguration string, if present */
271 /* List of any Interface Association Descriptors in this
273 struct usb_interface_assoc_descriptor
*intf_assoc
[USB_MAXIADS
];
275 /* the interfaces associated with this configuration,
276 * stored in no particular order */
277 struct usb_interface
*interface
[USB_MAXINTERFACES
];
279 /* Interface information available even when this is not the
280 * active configuration */
281 struct usb_interface_cache
*intf_cache
[USB_MAXINTERFACES
];
283 unsigned char *extra
; /* Extra descriptors */
287 int __usb_get_extra_descriptor(char *buffer
, unsigned size
,
288 unsigned char type
, void **ptr
);
289 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
290 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
293 /* ----------------------------------------------------------------------- */
295 /* USB device number allocation bitmap */
297 unsigned long devicemap
[128 / (8*sizeof(unsigned long))];
301 * Allocated per bus (tree of devices) we have:
304 struct device
*controller
; /* host/master side hardware */
305 int busnum
; /* Bus number (in order of reg) */
306 char *bus_name
; /* stable id (PCI slot_name etc) */
307 u8 uses_dma
; /* Does the host controller use DMA? */
308 u8 otg_port
; /* 0, or number of OTG/HNP port */
309 unsigned is_b_host
:1; /* true during some HNP roleswitches */
310 unsigned b_hnp_enable
:1; /* OTG: did A-Host enable HNP? */
312 int devnum_next
; /* Next open device number in
313 * round-robin allocation */
315 struct usb_devmap devmap
; /* device address allocation map */
316 struct usb_device
*root_hub
; /* Root hub */
317 struct list_head bus_list
; /* list of busses */
319 int bandwidth_allocated
; /* on this bus: how much of the time
320 * reserved for periodic (intr/iso)
321 * requests is used, on average?
322 * Units: microseconds/frame.
323 * Limits: Full/low speed reserve 90%,
324 * while high speed reserves 80%.
326 int bandwidth_int_reqs
; /* number of Interrupt requests */
327 int bandwidth_isoc_reqs
; /* number of Isoc. requests */
329 #ifdef CONFIG_USB_DEVICEFS
330 struct dentry
*usbfs_dentry
; /* usbfs dentry entry for the bus */
332 struct device
*dev
; /* device for this bus */
334 #if defined(CONFIG_USB_MON)
335 struct mon_bus
*mon_bus
; /* non-null when associated */
336 int monitored
; /* non-zero when monitored */
340 /* ----------------------------------------------------------------------- */
342 /* This is arbitrary.
343 * From USB 2.0 spec Table 11-13, offset 7, a hub can
344 * have up to 255 ports. The most yet reported is 10.
346 * Current Wireless USB host hardware (Intel i1480 for example) allows
347 * up to 22 devices to connect. Upcoming hardware might raise that
348 * limit. Because the arrays need to add a bit for hub status data, we
349 * do 31, so plus one evens out to four bytes.
351 #define USB_MAXCHILDREN (31)
356 * struct usb_device - kernel's representation of a USB device
358 * FIXME: Write the kerneldoc!
360 * Usbcore drivers should not set usbdev->state directly. Instead use
361 * usb_set_device_state().
364 int devnum
; /* Address on USB bus */
365 char devpath
[16]; /* Use in messages: /port/port/... */
366 enum usb_device_state state
; /* configured, not attached, etc */
367 enum usb_device_speed speed
; /* high/full/low (or error) */
369 struct usb_tt
*tt
; /* low/full speed dev, highspeed hub */
370 int ttport
; /* device port on that tt hub */
372 unsigned int toggle
[2]; /* one bit for each endpoint
373 * ([0] = IN, [1] = OUT) */
375 struct usb_device
*parent
; /* our hub, unless we're the root */
376 struct usb_bus
*bus
; /* Bus we're part of */
377 struct usb_host_endpoint ep0
;
379 struct device dev
; /* Generic device interface */
381 struct usb_device_descriptor descriptor
;/* Descriptor */
382 struct usb_host_config
*config
; /* All of the configs */
384 struct usb_host_config
*actconfig
;/* the active configuration */
385 struct usb_host_endpoint
*ep_in
[16];
386 struct usb_host_endpoint
*ep_out
[16];
388 char **rawdescriptors
; /* Raw descriptors for each config */
390 unsigned short bus_mA
; /* Current available from the bus */
391 u8 portnum
; /* Parent port number (origin 1) */
392 u8 level
; /* Number of USB hub ancestors */
394 unsigned can_submit
:1; /* URBs may be submitted */
395 unsigned discon_suspended
:1; /* Disconnected while suspended */
396 unsigned persist_enabled
:1; /* USB_PERSIST enabled for this dev */
397 unsigned have_langid
:1; /* whether string_langid is valid */
398 int string_langid
; /* language ID for strings */
400 /* static strings from the device */
401 char *product
; /* iProduct string, if present */
402 char *manufacturer
; /* iManufacturer string, if present */
403 char *serial
; /* iSerialNumber string, if present */
405 struct list_head filelist
;
406 #ifdef CONFIG_USB_DEVICE_CLASS
407 struct device
*usb_classdev
;
409 #ifdef CONFIG_USB_DEVICEFS
410 struct dentry
*usbfs_dentry
; /* usbfs dentry entry for the device */
413 * Child devices - these can be either new devices
414 * (if this is a hub device), or different instances
415 * of this same device.
417 * Each instance needs its own set of data structures.
420 int maxchild
; /* Number of ports if hub */
421 struct usb_device
*children
[USB_MAXCHILDREN
];
423 int pm_usage_cnt
; /* usage counter for autosuspend */
424 u32 quirks
; /* quirks of the whole device */
425 atomic_t urbnum
; /* number of URBs submitted for the whole device */
427 unsigned long active_duration
; /* total time device is not suspended */
430 struct delayed_work autosuspend
; /* for delayed autosuspends */
431 struct mutex pm_mutex
; /* protects PM operations */
433 unsigned long last_busy
; /* time of last use */
434 int autosuspend_delay
; /* in jiffies */
435 unsigned long connect_time
; /* time device was first connected */
437 unsigned auto_pm
:1; /* autosuspend/resume in progress */
438 unsigned do_remote_wakeup
:1; /* remote wakeup should be enabled */
439 unsigned reset_resume
:1; /* needs reset instead of resume */
440 unsigned autosuspend_disabled
:1; /* autosuspend and autoresume */
441 unsigned autoresume_disabled
:1; /* disabled by the user */
442 unsigned skip_sys_resume
:1; /* skip the next system resume */
445 #define to_usb_device(d) container_of(d, struct usb_device, dev)
447 extern struct usb_device
*usb_get_dev(struct usb_device
*dev
);
448 extern void usb_put_dev(struct usb_device
*dev
);
450 /* USB device locking */
451 #define usb_lock_device(udev) down(&(udev)->dev.sem)
452 #define usb_unlock_device(udev) up(&(udev)->dev.sem)
453 #define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
454 extern int usb_lock_device_for_reset(struct usb_device
*udev
,
455 const struct usb_interface
*iface
);
457 /* USB port reset for device reinitialization */
458 extern int usb_reset_device(struct usb_device
*dev
);
459 extern void usb_queue_reset_device(struct usb_interface
*dev
);
461 extern struct usb_device
*usb_find_device(u16 vendor_id
, u16 product_id
);
462 extern struct usb_device
*usb_find_device_by_name(const char *name
);
464 /* USB autosuspend and autoresume */
465 #ifdef CONFIG_USB_SUSPEND
466 extern int usb_autopm_set_interface(struct usb_interface
*intf
);
467 extern int usb_autopm_get_interface(struct usb_interface
*intf
);
468 extern void usb_autopm_put_interface(struct usb_interface
*intf
);
470 static inline void usb_autopm_enable(struct usb_interface
*intf
)
472 intf
->pm_usage_cnt
= 0;
473 usb_autopm_set_interface(intf
);
476 static inline void usb_autopm_disable(struct usb_interface
*intf
)
478 intf
->pm_usage_cnt
= 1;
479 usb_autopm_set_interface(intf
);
482 static inline void usb_mark_last_busy(struct usb_device
*udev
)
484 udev
->last_busy
= jiffies
;
489 static inline int usb_autopm_set_interface(struct usb_interface
*intf
)
492 static inline int usb_autopm_get_interface(struct usb_interface
*intf
)
495 static inline void usb_autopm_put_interface(struct usb_interface
*intf
)
497 static inline void usb_autopm_enable(struct usb_interface
*intf
)
499 static inline void usb_autopm_disable(struct usb_interface
*intf
)
501 static inline void usb_mark_last_busy(struct usb_device
*udev
)
505 /*-------------------------------------------------------------------------*/
507 /* for drivers using iso endpoints */
508 extern int usb_get_current_frame_number (struct usb_device
*usb_dev
);
510 /* used these for multi-interface device registration */
511 extern int usb_driver_claim_interface(struct usb_driver
*driver
,
512 struct usb_interface
*iface
, void* priv
);
515 * usb_interface_claimed - returns true iff an interface is claimed
516 * @iface: the interface being checked
518 * Returns true (nonzero) iff the interface is claimed, else false (zero).
519 * Callers must own the driver model's usb bus readlock. So driver
520 * probe() entries don't need extra locking, but other call contexts
521 * may need to explicitly claim that lock.
524 static inline int usb_interface_claimed(struct usb_interface
*iface
) {
525 return (iface
->dev
.driver
!= NULL
);
528 extern void usb_driver_release_interface(struct usb_driver
*driver
,
529 struct usb_interface
*iface
);
530 const struct usb_device_id
*usb_match_id(struct usb_interface
*interface
,
531 const struct usb_device_id
*id
);
532 extern int usb_match_one_id(struct usb_interface
*interface
,
533 const struct usb_device_id
*id
);
535 extern struct usb_interface
*usb_find_interface(struct usb_driver
*drv
,
537 extern struct usb_interface
*usb_ifnum_to_if(const struct usb_device
*dev
,
539 extern struct usb_host_interface
*usb_altnum_to_altsetting(
540 const struct usb_interface
*intf
, unsigned int altnum
);
544 * usb_make_path - returns stable device path in the usb tree
545 * @dev: the device whose path is being constructed
546 * @buf: where to put the string
547 * @size: how big is "buf"?
549 * Returns length of the string (> 0) or negative if size was too small.
551 * This identifier is intended to be "stable", reflecting physical paths in
552 * hardware such as physical bus addresses for host controllers or ports on
553 * USB hubs. That makes it stay the same until systems are physically
554 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
555 * controllers. Adding and removing devices, including virtual root hubs
556 * in host controller driver modules, does not change these path identifers;
557 * neither does rebooting or re-enumerating. These are more useful identifiers
558 * than changeable ("unstable") ones like bus numbers or device addresses.
560 * With a partial exception for devices connected to USB 2.0 root hubs, these
561 * identifiers are also predictable. So long as the device tree isn't changed,
562 * plugging any USB device into a given hub port always gives it the same path.
563 * Because of the use of "companion" controllers, devices connected to ports on
564 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
565 * high speed, and a different one if they are full or low speed.
567 static inline int usb_make_path (struct usb_device
*dev
, char *buf
,
571 actual
= snprintf (buf
, size
, "usb-%s-%s", dev
->bus
->bus_name
,
573 return (actual
>= (int)size
) ? -1 : actual
;
576 /*-------------------------------------------------------------------------*/
579 * usb_endpoint_num - get the endpoint's number
580 * @epd: endpoint to be checked
582 * Returns @epd's number: 0 to 15.
584 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor
*epd
)
586 return epd
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
590 * usb_endpoint_type - get the endpoint's transfer type
591 * @epd: endpoint to be checked
593 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
594 * to @epd's transfer type.
596 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor
*epd
)
598 return epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
;
602 * usb_endpoint_dir_in - check if the endpoint has IN direction
603 * @epd: endpoint to be checked
605 * Returns true if the endpoint is of type IN, otherwise it returns false.
607 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor
*epd
)
609 return ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_IN
);
613 * usb_endpoint_dir_out - check if the endpoint has OUT direction
614 * @epd: endpoint to be checked
616 * Returns true if the endpoint is of type OUT, otherwise it returns false.
618 static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor
*epd
)
620 return ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
);
624 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
625 * @epd: endpoint to be checked
627 * Returns true if the endpoint is of type bulk, otherwise it returns false.
629 static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor
*epd
)
631 return ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
632 USB_ENDPOINT_XFER_BULK
);
636 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
637 * @epd: endpoint to be checked
639 * Returns true if the endpoint is of type control, otherwise it returns false.
641 static inline int usb_endpoint_xfer_control(const struct usb_endpoint_descriptor
*epd
)
643 return ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
644 USB_ENDPOINT_XFER_CONTROL
);
648 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
649 * @epd: endpoint to be checked
651 * Returns true if the endpoint is of type interrupt, otherwise it returns
654 static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor
*epd
)
656 return ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
657 USB_ENDPOINT_XFER_INT
);
661 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
662 * @epd: endpoint to be checked
664 * Returns true if the endpoint is of type isochronous, otherwise it returns
667 static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor
*epd
)
669 return ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
670 USB_ENDPOINT_XFER_ISOC
);
674 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
675 * @epd: endpoint to be checked
677 * Returns true if the endpoint has bulk transfer type and IN direction,
678 * otherwise it returns false.
680 static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor
*epd
)
682 return (usb_endpoint_xfer_bulk(epd
) && usb_endpoint_dir_in(epd
));
686 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
687 * @epd: endpoint to be checked
689 * Returns true if the endpoint has bulk transfer type and OUT direction,
690 * otherwise it returns false.
692 static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor
*epd
)
694 return (usb_endpoint_xfer_bulk(epd
) && usb_endpoint_dir_out(epd
));
698 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
699 * @epd: endpoint to be checked
701 * Returns true if the endpoint has interrupt transfer type and IN direction,
702 * otherwise it returns false.
704 static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor
*epd
)
706 return (usb_endpoint_xfer_int(epd
) && usb_endpoint_dir_in(epd
));
710 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
711 * @epd: endpoint to be checked
713 * Returns true if the endpoint has interrupt transfer type and OUT direction,
714 * otherwise it returns false.
716 static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor
*epd
)
718 return (usb_endpoint_xfer_int(epd
) && usb_endpoint_dir_out(epd
));
722 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
723 * @epd: endpoint to be checked
725 * Returns true if the endpoint has isochronous transfer type and IN direction,
726 * otherwise it returns false.
728 static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor
*epd
)
730 return (usb_endpoint_xfer_isoc(epd
) && usb_endpoint_dir_in(epd
));
734 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
735 * @epd: endpoint to be checked
737 * Returns true if the endpoint has isochronous transfer type and OUT direction,
738 * otherwise it returns false.
740 static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor
*epd
)
742 return (usb_endpoint_xfer_isoc(epd
) && usb_endpoint_dir_out(epd
));
745 /*-------------------------------------------------------------------------*/
747 #define USB_DEVICE_ID_MATCH_DEVICE \
748 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
749 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
750 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
751 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
752 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
753 #define USB_DEVICE_ID_MATCH_DEV_INFO \
754 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
755 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
756 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
757 #define USB_DEVICE_ID_MATCH_INT_INFO \
758 (USB_DEVICE_ID_MATCH_INT_CLASS | \
759 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
760 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
763 * USB_DEVICE - macro used to describe a specific usb device
764 * @vend: the 16 bit USB Vendor ID
765 * @prod: the 16 bit USB Product ID
767 * This macro is used to create a struct usb_device_id that matches a
770 #define USB_DEVICE(vend,prod) \
771 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
774 * USB_DEVICE_VER - macro used to describe a specific usb device with a
776 * @vend: the 16 bit USB Vendor ID
777 * @prod: the 16 bit USB Product ID
778 * @lo: the bcdDevice_lo value
779 * @hi: the bcdDevice_hi value
781 * This macro is used to create a struct usb_device_id that matches a
782 * specific device, with a version range.
784 #define USB_DEVICE_VER(vend,prod,lo,hi) \
785 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
786 .idVendor = (vend), .idProduct = (prod), \
787 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
790 * USB_DEVICE_INTERFACE_PROTOCOL - macro used to describe a usb
791 * device with a specific interface protocol
792 * @vend: the 16 bit USB Vendor ID
793 * @prod: the 16 bit USB Product ID
794 * @pr: bInterfaceProtocol value
796 * This macro is used to create a struct usb_device_id that matches a
797 * specific interface protocol of devices.
799 #define USB_DEVICE_INTERFACE_PROTOCOL(vend,prod,pr) \
800 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
801 .idVendor = (vend), \
802 .idProduct = (prod), \
803 .bInterfaceProtocol = (pr)
806 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
807 * @vend: the 16 bit USB Vendor ID
808 * @prod: the 16 bit USB Product ID
809 * @num: bInterfaceNumber value
811 * This macro is used to create a struct usb_device_id that matches a
812 * specific interface number of devices.
814 #define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
815 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
816 USB_DEVICE_ID_MATCH_INT_NUMBER, \
817 .idVendor = (vend), \
818 .idProduct = (prod), \
819 .bInterfaceNumber = (num)
822 * USB_DEVICE_INFO - macro used to describe a class of usb devices
823 * @cl: bDeviceClass value
824 * @sc: bDeviceSubClass value
825 * @pr: bDeviceProtocol value
827 * This macro is used to create a struct usb_device_id that matches a
828 * specific class of devices.
830 #define USB_DEVICE_INFO(cl,sc,pr) \
831 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
832 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
835 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
836 * @cl: bInterfaceClass value
837 * @sc: bInterfaceSubClass value
838 * @pr: bInterfaceProtocol value
840 * This macro is used to create a struct usb_device_id that matches a
841 * specific class of interfaces.
843 #define USB_INTERFACE_INFO(cl,sc,pr) \
844 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
845 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
848 * USB_DEVICE_AND_INTERFACE_INFO - macro used to describe a specific usb device
849 * with a class of usb interfaces
850 * @vend: the 16 bit USB Vendor ID
851 * @prod: the 16 bit USB Product ID
852 * @cl: bInterfaceClass value
853 * @sc: bInterfaceSubClass value
854 * @pr: bInterfaceProtocol value
856 * This macro is used to create a struct usb_device_id that matches a
857 * specific device with a specific class of interfaces.
859 * This is especially useful when explicitly matching devices that have
860 * vendor specific bDeviceClass values, but standards-compliant interfaces.
862 #define USB_DEVICE_AND_INTERFACE_INFO(vend,prod,cl,sc,pr) \
863 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
864 | USB_DEVICE_ID_MATCH_DEVICE, \
865 .idVendor = (vend), .idProduct = (prod), \
866 .bInterfaceClass = (cl), \
867 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
870 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
871 * @vend: the 16 bit USB Vendor ID
872 * @cl: bInterfaceClass value
873 * @sc: bInterfaceSubClass value
874 * @pr: bInterfaceProtocol value
876 * This macro is used to create a struct usb_device_id that matches a
877 * specific vendor with a specific class of interfaces.
879 * This is especially useful when explicitly matching devices that have
880 * vendor specific bDeviceClass values, but standards-compliant interfaces.
882 #define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
883 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
884 | USB_DEVICE_ID_MATCH_VENDOR, \
885 .idVendor = (vend), \
886 .bInterfaceClass = (cl), \
887 .bInterfaceSubClass = (sc), \
888 .bInterfaceProtocol = (pr)
890 /* ----------------------------------------------------------------------- */
892 /* Stuff for dynamic usb ids */
895 struct list_head list
;
899 struct list_head node
;
900 struct usb_device_id id
;
903 extern ssize_t
usb_store_new_id(struct usb_dynids
*dynids
,
904 struct device_driver
*driver
,
905 const char *buf
, size_t count
);
908 * struct usbdrv_wrap - wrapper for driver-model structure
909 * @driver: The driver-model core driver structure.
910 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
913 struct device_driver driver
;
918 * struct usb_driver - identifies USB interface driver to usbcore
919 * @name: The driver name should be unique among USB drivers,
920 * and should normally be the same as the module name.
921 * @probe: Called to see if the driver is willing to manage a particular
922 * interface on a device. If it is, probe returns zero and uses
923 * dev_set_drvdata() to associate driver-specific data with the
924 * interface. It may also use usb_set_interface() to specify the
925 * appropriate altsetting. If unwilling to manage the interface,
926 * return a negative errno value.
927 * @disconnect: Called when the interface is no longer accessible, usually
928 * because its device has been (or is being) disconnected or the
929 * driver module is being unloaded.
930 * @ioctl: Used for drivers that want to talk to userspace through
931 * the "usbfs" filesystem. This lets devices provide ways to
932 * expose information to user space regardless of where they
933 * do (or don't) show up otherwise in the filesystem.
934 * @suspend: Called when the device is going to be suspended by the system.
935 * @resume: Called when the device is being resumed by the system.
936 * @reset_resume: Called when the suspended device has been reset instead
938 * @pre_reset: Called by usb_reset_device() when the device
939 * is about to be reset.
940 * @post_reset: Called by usb_reset_device() after the device
941 * has been reset, or in lieu of @resume following a reset-resume
942 * (i.e., the device is reset instead of being resumed, as might
943 * happen if power was lost). The second argument tells which is
945 * @id_table: USB drivers use ID table to support hotplugging.
946 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
947 * or your driver's probe function will never get called.
948 * @dynids: used internally to hold the list of dynamically added device
949 * ids for this driver.
950 * @drvwrap: Driver-model core structure wrapper.
951 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
952 * added to this driver by preventing the sysfs file from being created.
953 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
954 * for interfaces bound to this driver.
955 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
956 * endpoints before calling the driver's disconnect method.
958 * USB interface drivers must provide a name, probe() and disconnect()
959 * methods, and an id_table. Other driver fields are optional.
961 * The id_table is used in hotplugging. It holds a set of descriptors,
962 * and specialized data may be associated with each entry. That table
963 * is used by both user and kernel mode hotplugging support.
965 * The probe() and disconnect() methods are called in a context where
966 * they can sleep, but they should avoid abusing the privilege. Most
967 * work to connect to a device should be done when the device is opened,
968 * and undone at the last close. The disconnect code needs to address
969 * concurrency issues with respect to open() and close() methods, as
970 * well as forcing all pending I/O requests to complete (by unlinking
971 * them as necessary, and blocking until the unlinks complete).
976 int (*probe
) (struct usb_interface
*intf
,
977 const struct usb_device_id
*id
);
979 void (*disconnect
) (struct usb_interface
*intf
);
981 int (*ioctl
) (struct usb_interface
*intf
, unsigned int code
,
984 int (*suspend
) (struct usb_interface
*intf
, pm_message_t message
);
985 int (*resume
) (struct usb_interface
*intf
);
986 int (*reset_resume
)(struct usb_interface
*intf
);
988 int (*pre_reset
)(struct usb_interface
*intf
);
989 int (*post_reset
)(struct usb_interface
*intf
);
991 const struct usb_device_id
*id_table
;
993 struct usb_dynids dynids
;
994 struct usbdrv_wrap drvwrap
;
995 unsigned int no_dynamic_id
:1;
996 unsigned int supports_autosuspend
:1;
997 unsigned int soft_unbind
:1;
999 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
1002 * struct usb_device_driver - identifies USB device driver to usbcore
1003 * @name: The driver name should be unique among USB drivers,
1004 * and should normally be the same as the module name.
1005 * @probe: Called to see if the driver is willing to manage a particular
1006 * device. If it is, probe returns zero and uses dev_set_drvdata()
1007 * to associate driver-specific data with the device. If unwilling
1008 * to manage the device, return a negative errno value.
1009 * @disconnect: Called when the device is no longer accessible, usually
1010 * because it has been (or is being) disconnected or the driver's
1011 * module is being unloaded.
1012 * @suspend: Called when the device is going to be suspended by the system.
1013 * @resume: Called when the device is being resumed by the system.
1014 * @drvwrap: Driver-model core structure wrapper.
1015 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
1016 * for devices bound to this driver.
1018 * USB drivers must provide all the fields listed above except drvwrap.
1020 struct usb_device_driver
{
1023 int (*probe
) (struct usb_device
*udev
);
1024 void (*disconnect
) (struct usb_device
*udev
);
1026 int (*suspend
) (struct usb_device
*udev
, pm_message_t message
);
1027 int (*resume
) (struct usb_device
*udev
);
1028 struct usbdrv_wrap drvwrap
;
1029 unsigned int supports_autosuspend
:1;
1031 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
1034 extern struct bus_type usb_bus_type
;
1037 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
1038 * @name: the usb class device name for this driver. Will show up in sysfs.
1039 * @fops: pointer to the struct file_operations of this driver.
1040 * @minor_base: the start of the minor range for this driver.
1042 * This structure is used for the usb_register_dev() and
1043 * usb_unregister_dev() functions, to consolidate a number of the
1044 * parameters used for them.
1046 struct usb_class_driver
{
1048 const struct file_operations
*fops
;
1053 * use these in module_init()/module_exit()
1054 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
1056 extern int usb_register_driver(struct usb_driver
*, struct module
*,
1058 static inline int usb_register(struct usb_driver
*driver
)
1060 return usb_register_driver(driver
, THIS_MODULE
, KBUILD_MODNAME
);
1062 extern void usb_deregister(struct usb_driver
*);
1064 extern int usb_register_device_driver(struct usb_device_driver
*,
1066 extern void usb_deregister_device_driver(struct usb_device_driver
*);
1068 extern int usb_register_dev(struct usb_interface
*intf
,
1069 struct usb_class_driver
*class_driver
);
1070 extern void usb_deregister_dev(struct usb_interface
*intf
,
1071 struct usb_class_driver
*class_driver
);
1073 extern int usb_disabled(void);
1075 /* ----------------------------------------------------------------------- */
1078 * URB support, for asynchronous request completions
1082 * urb->transfer_flags:
1084 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
1086 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
1087 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
1089 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
1090 #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
1091 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
1092 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
1093 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
1095 #define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
1097 #define URB_DIR_IN 0x0200 /* Transfer from device to host */
1098 #define URB_DIR_OUT 0
1099 #define URB_DIR_MASK URB_DIR_IN
1101 struct usb_iso_packet_descriptor
{
1102 unsigned int offset
;
1103 unsigned int length
; /* expected length */
1104 unsigned int actual_length
;
1111 struct list_head urb_list
;
1112 wait_queue_head_t wait
;
1114 unsigned int poisoned
:1;
1117 static inline void init_usb_anchor(struct usb_anchor
*anchor
)
1119 INIT_LIST_HEAD(&anchor
->urb_list
);
1120 init_waitqueue_head(&anchor
->wait
);
1121 spin_lock_init(&anchor
->lock
);
1124 typedef void (*usb_complete_t
)(struct urb
*);
1127 * struct urb - USB Request Block
1128 * @urb_list: For use by current owner of the URB.
1129 * @anchor_list: membership in the list of an anchor
1130 * @anchor: to anchor URBs to a common mooring
1131 * @ep: Points to the endpoint's data structure. Will eventually
1133 * @pipe: Holds endpoint number, direction, type, and more.
1134 * Create these values with the eight macros available;
1135 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1136 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1137 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1138 * numbers range from zero to fifteen. Note that "in" endpoint two
1139 * is a different endpoint (and pipe) from "out" endpoint two.
1140 * The current configuration controls the existence, type, and
1141 * maximum packet size of any given endpoint.
1142 * @dev: Identifies the USB device to perform the request.
1143 * @status: This is read in non-iso completion functions to get the
1144 * status of the particular request. ISO requests only use it
1145 * to tell whether the URB was unlinked; detailed status for
1146 * each frame is in the fields of the iso_frame-desc.
1147 * @transfer_flags: A variety of flags may be used to affect how URB
1148 * submission, unlinking, or operation are handled. Different
1149 * kinds of URB can use different flags.
1150 * @transfer_buffer: This identifies the buffer to (or from) which
1151 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
1152 * is set). This buffer must be suitable for DMA; allocate it with
1153 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1154 * of this buffer will be modified. This buffer is used for the data
1155 * stage of control transfers.
1156 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1157 * the device driver is saying that it provided this DMA address,
1158 * which the host controller driver should use in preference to the
1160 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1161 * be broken up into chunks according to the current maximum packet
1162 * size for the endpoint, which is a function of the configuration
1163 * and is encoded in the pipe. When the length is zero, neither
1164 * transfer_buffer nor transfer_dma is used.
1165 * @actual_length: This is read in non-iso completion functions, and
1166 * it tells how many bytes (out of transfer_buffer_length) were
1167 * transferred. It will normally be the same as requested, unless
1168 * either an error was reported or a short read was performed.
1169 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1170 * short reads be reported as errors.
1171 * @setup_packet: Only used for control transfers, this points to eight bytes
1172 * of setup data. Control transfers always start by sending this data
1173 * to the device. Then transfer_buffer is read or written, if needed.
1174 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1175 * device driver has provided this DMA address for the setup packet.
1176 * The host controller driver should use this in preference to
1178 * @start_frame: Returns the initial frame for isochronous transfers.
1179 * @number_of_packets: Lists the number of ISO transfer buffers.
1180 * @interval: Specifies the polling interval for interrupt or isochronous
1181 * transfers. The units are frames (milliseconds) for for full and low
1182 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
1183 * @error_count: Returns the number of ISO transfers that reported errors.
1184 * @context: For use in completion functions. This normally points to
1185 * request-specific driver context.
1186 * @complete: Completion handler. This URB is passed as the parameter to the
1187 * completion function. The completion function may then do what
1188 * it likes with the URB, including resubmitting or freeing it.
1189 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1190 * collect the transfer status for each buffer.
1192 * This structure identifies USB transfer requests. URBs must be allocated by
1193 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1194 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1195 * are submitted using usb_submit_urb(), and pending requests may be canceled
1196 * using usb_unlink_urb() or usb_kill_urb().
1198 * Data Transfer Buffers:
1200 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1201 * taken from the general page pool. That is provided by transfer_buffer
1202 * (control requests also use setup_packet), and host controller drivers
1203 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1204 * mapping operations can be expensive on some platforms (perhaps using a dma
1205 * bounce buffer or talking to an IOMMU),
1206 * although they're cheap on commodity x86 and ppc hardware.
1208 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1209 * which tell the host controller driver that no such mapping is needed since
1210 * the device driver is DMA-aware. For example, a device driver might
1211 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1212 * When these transfer flags are provided, host controller drivers will
1213 * attempt to use the dma addresses found in the transfer_dma and/or
1214 * setup_dma fields rather than determining a dma address themselves. (Note
1215 * that transfer_buffer and setup_packet must still be set because not all
1216 * host controllers use DMA, nor do virtual root hubs).
1220 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1221 * zero), and complete fields. All URBs must also initialize
1222 * transfer_buffer and transfer_buffer_length. They may provide the
1223 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1224 * to be treated as errors; that flag is invalid for write requests.
1227 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1228 * should always terminate with a short packet, even if it means adding an
1229 * extra zero length packet.
1231 * Control URBs must provide a setup_packet. The setup_packet and
1232 * transfer_buffer may each be mapped for DMA or not, independently of
1233 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1234 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1235 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1237 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1238 * or, for highspeed devices, 125 microsecond units)
1239 * to poll for transfers. After the URB has been submitted, the interval
1240 * field reflects how the transfer was actually scheduled.
1241 * The polling interval may be more frequent than requested.
1242 * For example, some controllers have a maximum interval of 32 milliseconds,
1243 * while others support intervals of up to 1024 milliseconds.
1244 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1245 * endpoints, as well as high speed interrupt endpoints, the encoding of
1246 * the transfer interval in the endpoint descriptor is logarithmic.
1247 * Device drivers must convert that value to linear units themselves.)
1249 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1250 * the host controller to schedule the transfer as soon as bandwidth
1251 * utilization allows, and then set start_frame to reflect the actual frame
1252 * selected during submission. Otherwise drivers must specify the start_frame
1253 * and handle the case where the transfer can't begin then. However, drivers
1254 * won't know how bandwidth is currently allocated, and while they can
1255 * find the current frame using usb_get_current_frame_number () they can't
1256 * know the range for that frame number. (Ranges for frame counter values
1257 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1259 * Isochronous URBs have a different data transfer model, in part because
1260 * the quality of service is only "best effort". Callers provide specially
1261 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1262 * at the end. Each such packet is an individual ISO transfer. Isochronous
1263 * URBs are normally queued, submitted by drivers to arrange that
1264 * transfers are at least double buffered, and then explicitly resubmitted
1265 * in completion handlers, so
1266 * that data (such as audio or video) streams at as constant a rate as the
1267 * host controller scheduler can support.
1269 * Completion Callbacks:
1271 * The completion callback is made in_interrupt(), and one of the first
1272 * things that a completion handler should do is check the status field.
1273 * The status field is provided for all URBs. It is used to report
1274 * unlinked URBs, and status for all non-ISO transfers. It should not
1275 * be examined before the URB is returned to the completion handler.
1277 * The context field is normally used to link URBs back to the relevant
1278 * driver or request state.
1280 * When the completion callback is invoked for non-isochronous URBs, the
1281 * actual_length field tells how many bytes were transferred. This field
1282 * is updated even when the URB terminated with an error or was unlinked.
1284 * ISO transfer status is reported in the status and actual_length fields
1285 * of the iso_frame_desc array, and the number of errors is reported in
1286 * error_count. Completion callbacks for ISO transfers will normally
1287 * (re)submit URBs to ensure a constant transfer rate.
1289 * Note that even fields marked "public" should not be touched by the driver
1290 * when the urb is owned by the hcd, that is, since the call to
1291 * usb_submit_urb() till the entry into the completion routine.
1295 /* private: usb core and host controller only fields in the urb */
1296 struct kref kref
; /* reference count of the URB */
1297 void *hcpriv
; /* private data for host controller */
1298 atomic_t use_count
; /* concurrent submissions counter */
1299 atomic_t reject
; /* submissions will fail */
1300 int unlinked
; /* unlink error code */
1302 /* public: documented fields in the urb that can be used by drivers */
1303 struct list_head urb_list
; /* list head for use by the urb's
1305 struct list_head anchor_list
; /* the URB may be anchored by the driver */
1306 struct usb_anchor
*anchor
;
1307 struct usb_device
*dev
; /* (in) pointer to associated device */
1308 struct usb_host_endpoint
*ep
; /* (internal) pointer to endpoint struct */
1309 unsigned int pipe
; /* (in) pipe information */
1310 int status
; /* (return) non-ISO status */
1311 unsigned int transfer_flags
; /* (in) URB_SHORT_NOT_OK | ...*/
1312 void *transfer_buffer
; /* (in) associated data buffer */
1313 dma_addr_t transfer_dma
; /* (in) dma addr for transfer_buffer */
1314 u32 transfer_buffer_length
; /* (in) data buffer length */
1315 u32 actual_length
; /* (return) actual transfer length */
1316 unsigned char *setup_packet
; /* (in) setup packet (control only) */
1317 dma_addr_t setup_dma
; /* (in) dma addr for setup_packet */
1318 int start_frame
; /* (modify) start frame (ISO) */
1319 int number_of_packets
; /* (in) number of ISO packets */
1320 int interval
; /* (modify) transfer interval
1322 int error_count
; /* (return) number of ISO errors */
1323 void *context
; /* (in) context for completion */
1324 usb_complete_t complete
; /* (in) completion routine */
1325 struct usb_iso_packet_descriptor iso_frame_desc
[0];
1329 /* ----------------------------------------------------------------------- */
1332 * usb_fill_control_urb - initializes a control urb
1333 * @urb: pointer to the urb to initialize.
1334 * @dev: pointer to the struct usb_device for this urb.
1335 * @pipe: the endpoint pipe
1336 * @setup_packet: pointer to the setup_packet buffer
1337 * @transfer_buffer: pointer to the transfer buffer
1338 * @buffer_length: length of the transfer buffer
1339 * @complete_fn: pointer to the usb_complete_t function
1340 * @context: what to set the urb context to.
1342 * Initializes a control urb with the proper information needed to submit
1345 static inline void usb_fill_control_urb (struct urb
*urb
,
1346 struct usb_device
*dev
,
1348 unsigned char *setup_packet
,
1349 void *transfer_buffer
,
1351 usb_complete_t complete_fn
,
1356 urb
->setup_packet
= setup_packet
;
1357 urb
->transfer_buffer
= transfer_buffer
;
1358 urb
->transfer_buffer_length
= buffer_length
;
1359 urb
->complete
= complete_fn
;
1360 urb
->context
= context
;
1364 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1365 * @urb: pointer to the urb to initialize.
1366 * @dev: pointer to the struct usb_device for this urb.
1367 * @pipe: the endpoint pipe
1368 * @transfer_buffer: pointer to the transfer buffer
1369 * @buffer_length: length of the transfer buffer
1370 * @complete_fn: pointer to the usb_complete_t function
1371 * @context: what to set the urb context to.
1373 * Initializes a bulk urb with the proper information needed to submit it
1376 static inline void usb_fill_bulk_urb (struct urb
*urb
,
1377 struct usb_device
*dev
,
1379 void *transfer_buffer
,
1381 usb_complete_t complete_fn
,
1386 urb
->transfer_buffer
= transfer_buffer
;
1387 urb
->transfer_buffer_length
= buffer_length
;
1388 urb
->complete
= complete_fn
;
1389 urb
->context
= context
;
1393 * usb_fill_int_urb - macro to help initialize a interrupt urb
1394 * @urb: pointer to the urb to initialize.
1395 * @dev: pointer to the struct usb_device for this urb.
1396 * @pipe: the endpoint pipe
1397 * @transfer_buffer: pointer to the transfer buffer
1398 * @buffer_length: length of the transfer buffer
1399 * @complete_fn: pointer to the usb_complete_t function
1400 * @context: what to set the urb context to.
1401 * @interval: what to set the urb interval to, encoded like
1402 * the endpoint descriptor's bInterval value.
1404 * Initializes a interrupt urb with the proper information needed to submit
1406 * Note that high speed interrupt endpoints use a logarithmic encoding of
1407 * the endpoint interval, and express polling intervals in microframes
1408 * (eight per millisecond) rather than in frames (one per millisecond).
1410 static inline void usb_fill_int_urb (struct urb
*urb
,
1411 struct usb_device
*dev
,
1413 void *transfer_buffer
,
1415 usb_complete_t complete_fn
,
1421 urb
->transfer_buffer
= transfer_buffer
;
1422 urb
->transfer_buffer_length
= buffer_length
;
1423 urb
->complete
= complete_fn
;
1424 urb
->context
= context
;
1425 if (dev
->speed
== USB_SPEED_HIGH
)
1426 urb
->interval
= 1 << (interval
- 1);
1428 urb
->interval
= interval
;
1429 urb
->start_frame
= -1;
1432 extern void usb_init_urb(struct urb
*urb
);
1433 extern struct urb
*usb_alloc_urb(int iso_packets
, gfp_t mem_flags
);
1434 extern void usb_free_urb(struct urb
*urb
);
1435 #define usb_put_urb usb_free_urb
1436 extern struct urb
*usb_get_urb(struct urb
*urb
);
1437 extern int usb_submit_urb(struct urb
*urb
, gfp_t mem_flags
);
1438 extern int usb_unlink_urb(struct urb
*urb
);
1439 extern void usb_kill_urb(struct urb
*urb
);
1440 extern void usb_poison_urb(struct urb
*urb
);
1441 extern void usb_unpoison_urb(struct urb
*urb
);
1442 extern void usb_kill_anchored_urbs(struct usb_anchor
*anchor
);
1443 extern void usb_poison_anchored_urbs(struct usb_anchor
*anchor
);
1444 extern void usb_unpoison_anchored_urbs(struct usb_anchor
*anchor
);
1445 extern void usb_unlink_anchored_urbs(struct usb_anchor
*anchor
);
1446 extern void usb_anchor_urb(struct urb
*urb
, struct usb_anchor
*anchor
);
1447 extern void usb_unanchor_urb(struct urb
*urb
);
1448 extern int usb_wait_anchor_empty_timeout(struct usb_anchor
*anchor
,
1449 unsigned int timeout
);
1450 extern struct urb
*usb_get_from_anchor(struct usb_anchor
*anchor
);
1451 extern void usb_scuttle_anchored_urbs(struct usb_anchor
*anchor
);
1452 extern int usb_anchor_empty(struct usb_anchor
*anchor
);
1455 * usb_urb_dir_in - check if an URB describes an IN transfer
1456 * @urb: URB to be checked
1458 * Returns 1 if @urb describes an IN transfer (device-to-host),
1461 static inline int usb_urb_dir_in(struct urb
*urb
)
1463 return (urb
->transfer_flags
& URB_DIR_MASK
) == URB_DIR_IN
;
1467 * usb_urb_dir_out - check if an URB describes an OUT transfer
1468 * @urb: URB to be checked
1470 * Returns 1 if @urb describes an OUT transfer (host-to-device),
1473 static inline int usb_urb_dir_out(struct urb
*urb
)
1475 return (urb
->transfer_flags
& URB_DIR_MASK
) == URB_DIR_OUT
;
1478 void *usb_buffer_alloc (struct usb_device
*dev
, size_t size
,
1479 gfp_t mem_flags
, dma_addr_t
*dma
);
1480 void usb_buffer_free (struct usb_device
*dev
, size_t size
,
1481 void *addr
, dma_addr_t dma
);
1484 struct urb
*usb_buffer_map (struct urb
*urb
);
1485 void usb_buffer_dmasync (struct urb
*urb
);
1486 void usb_buffer_unmap (struct urb
*urb
);
1490 int usb_buffer_map_sg(const struct usb_device
*dev
, int is_in
,
1491 struct scatterlist
*sg
, int nents
);
1493 void usb_buffer_dmasync_sg(const struct usb_device
*dev
, int is_in
,
1494 struct scatterlist
*sg
, int n_hw_ents
);
1496 void usb_buffer_unmap_sg(const struct usb_device
*dev
, int is_in
,
1497 struct scatterlist
*sg
, int n_hw_ents
);
1499 /*-------------------------------------------------------------------*
1500 * SYNCHRONOUS CALL SUPPORT *
1501 *-------------------------------------------------------------------*/
1503 extern int usb_control_msg(struct usb_device
*dev
, unsigned int pipe
,
1504 __u8 request
, __u8 requesttype
, __u16 value
, __u16 index
,
1505 void *data
, __u16 size
, int timeout
);
1506 extern int usb_interrupt_msg(struct usb_device
*usb_dev
, unsigned int pipe
,
1507 void *data
, int len
, int *actual_length
, int timeout
);
1508 extern int usb_bulk_msg(struct usb_device
*usb_dev
, unsigned int pipe
,
1509 void *data
, int len
, int *actual_length
,
1512 /* wrappers around usb_control_msg() for the most common standard requests */
1513 extern int usb_get_descriptor(struct usb_device
*dev
, unsigned char desctype
,
1514 unsigned char descindex
, void *buf
, int size
);
1515 extern int usb_get_status(struct usb_device
*dev
,
1516 int type
, int target
, void *data
);
1517 extern int usb_string(struct usb_device
*dev
, int index
,
1518 char *buf
, size_t size
);
1520 /* wrappers that also update important state inside usbcore */
1521 extern int usb_clear_halt(struct usb_device
*dev
, int pipe
);
1522 extern int usb_reset_configuration(struct usb_device
*dev
);
1523 extern int usb_set_interface(struct usb_device
*dev
, int ifnum
, int alternate
);
1525 /* this request isn't really synchronous, but it belongs with the others */
1526 extern int usb_driver_set_configuration(struct usb_device
*udev
, int config
);
1529 * timeouts, in milliseconds, used for sending/receiving control messages
1530 * they typically complete within a few frames (msec) after they're issued
1531 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1532 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1534 #define USB_CTRL_GET_TIMEOUT 5000
1535 #define USB_CTRL_SET_TIMEOUT 5000
1539 * struct usb_sg_request - support for scatter/gather I/O
1540 * @status: zero indicates success, else negative errno
1541 * @bytes: counts bytes transferred.
1543 * These requests are initialized using usb_sg_init(), and then are used
1544 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1545 * members of the request object aren't for driver access.
1547 * The status and bytecount values are valid only after usb_sg_wait()
1548 * returns. If the status is zero, then the bytecount matches the total
1551 * After an error completion, drivers may need to clear a halt condition
1554 struct usb_sg_request
{
1559 * members below are private: to usbcore,
1560 * and are not provided for driver access!
1564 struct usb_device
*dev
;
1566 struct scatterlist
*sg
;
1573 struct completion complete
;
1577 struct usb_sg_request
*io
,
1578 struct usb_device
*dev
,
1581 struct scatterlist
*sg
,
1586 void usb_sg_cancel (struct usb_sg_request
*io
);
1587 void usb_sg_wait (struct usb_sg_request
*io
);
1590 /* ----------------------------------------------------------------------- */
1593 * For various legacy reasons, Linux has a small cookie that's paired with
1594 * a struct usb_device to identify an endpoint queue. Queue characteristics
1595 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1596 * an unsigned int encoded as:
1598 * - direction: bit 7 (0 = Host-to-Device [Out],
1599 * 1 = Device-to-Host [In] ...
1600 * like endpoint bEndpointAddress)
1601 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1602 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1603 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1604 * 10 = control, 11 = bulk)
1606 * Given the device address and endpoint descriptor, pipes are redundant.
1609 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1610 /* (yet ... they're the values used by usbfs) */
1611 #define PIPE_ISOCHRONOUS 0
1612 #define PIPE_INTERRUPT 1
1613 #define PIPE_CONTROL 2
1616 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1617 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1619 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1620 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1622 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1623 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1624 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1625 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1626 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1628 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1629 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1630 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
1631 #define usb_settoggle(dev, ep, out, bit) \
1632 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1636 static inline unsigned int __create_pipe(struct usb_device
*dev
,
1637 unsigned int endpoint
)
1639 return (dev
->devnum
<< 8) | (endpoint
<< 15);
1642 /* Create various pipes... */
1643 #define usb_sndctrlpipe(dev,endpoint) \
1644 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1645 #define usb_rcvctrlpipe(dev,endpoint) \
1646 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1647 #define usb_sndisocpipe(dev,endpoint) \
1648 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1649 #define usb_rcvisocpipe(dev,endpoint) \
1650 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1651 #define usb_sndbulkpipe(dev,endpoint) \
1652 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1653 #define usb_rcvbulkpipe(dev,endpoint) \
1654 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1655 #define usb_sndintpipe(dev,endpoint) \
1656 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1657 #define usb_rcvintpipe(dev,endpoint) \
1658 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1660 /*-------------------------------------------------------------------------*/
1663 usb_maxpacket(struct usb_device
*udev
, int pipe
, int is_out
)
1665 struct usb_host_endpoint
*ep
;
1666 unsigned epnum
= usb_pipeendpoint(pipe
);
1669 WARN_ON(usb_pipein(pipe
));
1670 ep
= udev
->ep_out
[epnum
];
1672 WARN_ON(usb_pipeout(pipe
));
1673 ep
= udev
->ep_in
[epnum
];
1678 /* NOTE: only 0x07ff bits are for packet size... */
1679 return le16_to_cpu(ep
->desc
.wMaxPacketSize
);
1682 /* ----------------------------------------------------------------------- */
1684 /* translate USB error codes to codes user space understands */
1685 static inline int usb_translate_errors(int error_code
)
1687 switch (error_code
) {
1698 /* ----------------------------------------------------------------------- */
1700 /* Events from the usb core */
1701 #define USB_DEVICE_ADD 0x0001
1702 #define USB_DEVICE_REMOVE 0x0002
1703 #define USB_BUS_ADD 0x0003
1704 #define USB_BUS_REMOVE 0x0004
1705 extern void usb_register_notify(struct notifier_block
*nb
);
1706 extern void usb_unregister_notify(struct notifier_block
*nb
);
1709 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1712 #define dbg(format, arg...) do {} while (0)
1715 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1717 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1719 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1723 #endif /* __KERNEL__ */