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 * @class_dev: driver model's class view of this device.
111 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
112 * allowed unless the counter is 0.
114 * USB device drivers attach to interfaces on a physical device. Each
115 * interface encapsulates a single high level function, such as feeding
116 * an audio stream to a speaker or reporting a change in a volume control.
117 * Many USB devices only have one interface. The protocol used to talk to
118 * an interface's endpoints can be defined in a usb "class" specification,
119 * or by a product's vendor. The (default) control endpoint is part of
120 * every interface, but is never listed among the interface's descriptors.
122 * The driver that is bound to the interface can use standard driver model
123 * calls such as dev_get_drvdata() on the dev member of this structure.
125 * Each interface may have alternate settings. The initial configuration
126 * of a device sets altsetting 0, but the device driver can change
127 * that setting using usb_set_interface(). Alternate settings are often
128 * used to control the the use of periodic endpoints, such as by having
129 * different endpoints use different amounts of reserved USB bandwidth.
130 * All standards-conformant USB devices that use isochronous endpoints
131 * will use them in non-default settings.
133 * The USB specification says that alternate setting numbers must run from
134 * 0 to one less than the total number of alternate settings. But some
135 * devices manage to mess this up, and the structures aren't necessarily
136 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
137 * look up an alternate setting in the altsetting array based on its number.
139 struct usb_interface
{
140 /* array of alternate settings for this interface,
141 * stored in no particular order */
142 struct usb_host_interface
*altsetting
;
144 struct usb_host_interface
*cur_altsetting
; /* the currently
145 * active alternate setting */
146 unsigned num_altsetting
; /* number of alternate settings */
148 int minor
; /* minor number this interface is
150 enum usb_interface_condition condition
; /* state of binding */
151 unsigned is_active
:1; /* the interface is not suspended */
152 unsigned needs_remote_wakeup
:1; /* driver requires remote wakeup */
154 struct device dev
; /* interface specific device info */
155 struct class_device
*class_dev
;
156 int pm_usage_cnt
; /* usage counter for autosuspend */
158 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
159 #define interface_to_usbdev(intf) \
160 container_of(intf->dev.parent, struct usb_device, dev)
162 static inline void *usb_get_intfdata (struct usb_interface
*intf
)
164 return dev_get_drvdata (&intf
->dev
);
167 static inline void usb_set_intfdata (struct usb_interface
*intf
, void *data
)
169 dev_set_drvdata(&intf
->dev
, data
);
172 struct usb_interface
*usb_get_intf(struct usb_interface
*intf
);
173 void usb_put_intf(struct usb_interface
*intf
);
175 /* this maximum is arbitrary */
176 #define USB_MAXINTERFACES 32
179 * struct usb_interface_cache - long-term representation of a device interface
180 * @num_altsetting: number of altsettings defined.
181 * @ref: reference counter.
182 * @altsetting: variable-length array of interface structures, one for
183 * each alternate setting that may be selected. Each one includes a
184 * set of endpoint configurations. They will be in no particular order.
186 * These structures persist for the lifetime of a usb_device, unlike
187 * struct usb_interface (which persists only as long as its configuration
188 * is installed). The altsetting arrays can be accessed through these
189 * structures at any time, permitting comparison of configurations and
190 * providing support for the /proc/bus/usb/devices pseudo-file.
192 struct usb_interface_cache
{
193 unsigned num_altsetting
; /* number of alternate settings */
194 struct kref ref
; /* reference counter */
196 /* variable-length array of alternate settings for this interface,
197 * stored in no particular order */
198 struct usb_host_interface altsetting
[0];
200 #define ref_to_usb_interface_cache(r) \
201 container_of(r, struct usb_interface_cache, ref)
202 #define altsetting_to_usb_interface_cache(a) \
203 container_of(a, struct usb_interface_cache, altsetting[0])
206 * struct usb_host_config - representation of a device's configuration
207 * @desc: the device's configuration descriptor.
208 * @string: pointer to the cached version of the iConfiguration string, if
209 * present for this configuration.
210 * @interface: array of pointers to usb_interface structures, one for each
211 * interface in the configuration. The number of interfaces is stored
212 * in desc.bNumInterfaces. These pointers are valid only while the
213 * the configuration is active.
214 * @intf_cache: array of pointers to usb_interface_cache structures, one
215 * for each interface in the configuration. These structures exist
216 * for the entire life of the device.
217 * @extra: pointer to buffer containing all extra descriptors associated
218 * with this configuration (those preceding the first interface
220 * @extralen: length of the extra descriptors buffer.
222 * USB devices may have multiple configurations, but only one can be active
223 * at any time. Each encapsulates a different operational environment;
224 * for example, a dual-speed device would have separate configurations for
225 * full-speed and high-speed operation. The number of configurations
226 * available is stored in the device descriptor as bNumConfigurations.
228 * A configuration can contain multiple interfaces. Each corresponds to
229 * a different function of the USB device, and all are available whenever
230 * the configuration is active. The USB standard says that interfaces
231 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
232 * of devices get this wrong. In addition, the interface array is not
233 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
234 * look up an interface entry based on its number.
236 * Device drivers should not attempt to activate configurations. The choice
237 * of which configuration to install is a policy decision based on such
238 * considerations as available power, functionality provided, and the user's
239 * desires (expressed through userspace tools). However, drivers can call
240 * usb_reset_configuration() to reinitialize the current configuration and
241 * all its interfaces.
243 struct usb_host_config
{
244 struct usb_config_descriptor desc
;
246 char *string
; /* iConfiguration string, if present */
247 /* the interfaces associated with this configuration,
248 * stored in no particular order */
249 struct usb_interface
*interface
[USB_MAXINTERFACES
];
251 /* Interface information available even when this is not the
252 * active configuration */
253 struct usb_interface_cache
*intf_cache
[USB_MAXINTERFACES
];
255 unsigned char *extra
; /* Extra descriptors */
259 int __usb_get_extra_descriptor(char *buffer
, unsigned size
,
260 unsigned char type
, void **ptr
);
261 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
262 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
265 /* ----------------------------------------------------------------------- */
267 /* USB device number allocation bitmap */
269 unsigned long devicemap
[128 / (8*sizeof(unsigned long))];
273 * Allocated per bus (tree of devices) we have:
276 struct device
*controller
; /* host/master side hardware */
277 int busnum
; /* Bus number (in order of reg) */
278 char *bus_name
; /* stable id (PCI slot_name etc) */
279 u8 uses_dma
; /* Does the host controller use DMA? */
280 u8 otg_port
; /* 0, or number of OTG/HNP port */
281 unsigned is_b_host
:1; /* true during some HNP roleswitches */
282 unsigned b_hnp_enable
:1; /* OTG: did A-Host enable HNP? */
284 int devnum_next
; /* Next open device number in
285 * round-robin allocation */
287 struct usb_devmap devmap
; /* device address allocation map */
288 struct usb_device
*root_hub
; /* Root hub */
289 struct list_head bus_list
; /* list of busses */
291 int bandwidth_allocated
; /* on this bus: how much of the time
292 * reserved for periodic (intr/iso)
293 * requests is used, on average?
294 * Units: microseconds/frame.
295 * Limits: Full/low speed reserve 90%,
296 * while high speed reserves 80%.
298 int bandwidth_int_reqs
; /* number of Interrupt requests */
299 int bandwidth_isoc_reqs
; /* number of Isoc. requests */
301 struct dentry
*usbfs_dentry
; /* usbfs dentry entry for the bus */
303 struct class_device
*class_dev
; /* class device for this bus */
305 #if defined(CONFIG_USB_MON)
306 struct mon_bus
*mon_bus
; /* non-null when associated */
307 int monitored
; /* non-zero when monitored */
311 /* ----------------------------------------------------------------------- */
313 /* This is arbitrary.
314 * From USB 2.0 spec Table 11-13, offset 7, a hub can
315 * have up to 255 ports. The most yet reported is 10.
317 * Current Wireless USB host hardware (Intel i1480 for example) allows
318 * up to 22 devices to connect. Upcoming hardware might raise that
319 * limit. Because the arrays need to add a bit for hub status data, we
320 * do 31, so plus one evens out to four bytes.
322 #define USB_MAXCHILDREN (31)
327 * struct usb_device - kernel's representation of a USB device
329 * FIXME: Write the kerneldoc!
331 * Usbcore drivers should not set usbdev->state directly. Instead use
332 * usb_set_device_state().
335 int devnum
; /* Address on USB bus */
336 char devpath
[16]; /* Use in messages: /port/port/... */
337 enum usb_device_state state
; /* configured, not attached, etc */
338 enum usb_device_speed speed
; /* high/full/low (or error) */
340 struct usb_tt
*tt
; /* low/full speed dev, highspeed hub */
341 int ttport
; /* device port on that tt hub */
343 unsigned int toggle
[2]; /* one bit for each endpoint
344 * ([0] = IN, [1] = OUT) */
346 struct usb_device
*parent
; /* our hub, unless we're the root */
347 struct usb_bus
*bus
; /* Bus we're part of */
348 struct usb_host_endpoint ep0
;
350 struct device dev
; /* Generic device interface */
352 struct usb_device_descriptor descriptor
;/* Descriptor */
353 struct usb_host_config
*config
; /* All of the configs */
355 struct usb_host_config
*actconfig
;/* the active configuration */
356 struct usb_host_endpoint
*ep_in
[16];
357 struct usb_host_endpoint
*ep_out
[16];
359 char **rawdescriptors
; /* Raw descriptors for each config */
361 unsigned short bus_mA
; /* Current available from the bus */
362 u8 portnum
; /* Parent port number (origin 1) */
363 u8 level
; /* Number of USB hub ancestors */
365 int have_langid
; /* whether string_langid is valid */
366 int string_langid
; /* language ID for strings */
368 /* static strings from the device */
369 char *product
; /* iProduct string, if present */
370 char *manufacturer
; /* iManufacturer string, if present */
371 char *serial
; /* iSerialNumber string, if present */
373 struct list_head filelist
;
374 struct class_device
*class_dev
;
375 struct dentry
*usbfs_dentry
; /* usbfs dentry entry for the device */
378 * Child devices - these can be either new devices
379 * (if this is a hub device), or different instances
380 * of this same device.
382 * Each instance needs its own set of data structures.
385 int maxchild
; /* Number of ports if hub */
386 struct usb_device
*children
[USB_MAXCHILDREN
];
388 int pm_usage_cnt
; /* usage counter for autosuspend */
390 struct work_struct autosuspend
; /* for delayed autosuspends */
391 struct mutex pm_mutex
; /* protects PM operations */
393 unsigned auto_pm
:1; /* autosuspend/resume in progress */
394 unsigned do_remote_wakeup
:1; /* remote wakeup should be enabled */
397 #define to_usb_device(d) container_of(d, struct usb_device, dev)
399 extern struct usb_device
*usb_get_dev(struct usb_device
*dev
);
400 extern void usb_put_dev(struct usb_device
*dev
);
402 /* USB device locking */
403 #define usb_lock_device(udev) down(&(udev)->dev.sem)
404 #define usb_unlock_device(udev) up(&(udev)->dev.sem)
405 #define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
406 extern int usb_lock_device_for_reset(struct usb_device
*udev
,
407 const struct usb_interface
*iface
);
409 /* USB port reset for device reinitialization */
410 extern int usb_reset_device(struct usb_device
*dev
);
411 extern int usb_reset_composite_device(struct usb_device
*dev
,
412 struct usb_interface
*iface
);
414 extern struct usb_device
*usb_find_device(u16 vendor_id
, u16 product_id
);
416 /* USB autosuspend and autoresume */
417 #ifdef CONFIG_USB_SUSPEND
418 extern int usb_autopm_set_interface(struct usb_interface
*intf
);
419 extern int usb_autopm_get_interface(struct usb_interface
*intf
);
420 extern void usb_autopm_put_interface(struct usb_interface
*intf
);
422 static inline void usb_autopm_enable(struct usb_interface
*intf
)
424 intf
->pm_usage_cnt
= 0;
425 usb_autopm_set_interface(intf
);
428 static inline void usb_autopm_disable(struct usb_interface
*intf
)
430 intf
->pm_usage_cnt
= 1;
431 usb_autopm_set_interface(intf
);
436 static inline int usb_autopm_set_interface(struct usb_interface
*intf
)
439 static inline int usb_autopm_get_interface(struct usb_interface
*intf
)
442 static inline void usb_autopm_put_interface(struct usb_interface
*intf
)
444 static inline void usb_autopm_enable(struct usb_interface
*intf
)
446 static inline void usb_autopm_disable(struct usb_interface
*intf
)
450 /*-------------------------------------------------------------------------*/
452 /* for drivers using iso endpoints */
453 extern int usb_get_current_frame_number (struct usb_device
*usb_dev
);
455 /* used these for multi-interface device registration */
456 extern int usb_driver_claim_interface(struct usb_driver
*driver
,
457 struct usb_interface
*iface
, void* priv
);
460 * usb_interface_claimed - returns true iff an interface is claimed
461 * @iface: the interface being checked
463 * Returns true (nonzero) iff the interface is claimed, else false (zero).
464 * Callers must own the driver model's usb bus readlock. So driver
465 * probe() entries don't need extra locking, but other call contexts
466 * may need to explicitly claim that lock.
469 static inline int usb_interface_claimed(struct usb_interface
*iface
) {
470 return (iface
->dev
.driver
!= NULL
);
473 extern void usb_driver_release_interface(struct usb_driver
*driver
,
474 struct usb_interface
*iface
);
475 const struct usb_device_id
*usb_match_id(struct usb_interface
*interface
,
476 const struct usb_device_id
*id
);
478 extern struct usb_interface
*usb_find_interface(struct usb_driver
*drv
,
480 extern struct usb_interface
*usb_ifnum_to_if(const struct usb_device
*dev
,
482 extern struct usb_host_interface
*usb_altnum_to_altsetting(
483 const struct usb_interface
*intf
, unsigned int altnum
);
487 * usb_make_path - returns stable device path in the usb tree
488 * @dev: the device whose path is being constructed
489 * @buf: where to put the string
490 * @size: how big is "buf"?
492 * Returns length of the string (> 0) or negative if size was too small.
494 * This identifier is intended to be "stable", reflecting physical paths in
495 * hardware such as physical bus addresses for host controllers or ports on
496 * USB hubs. That makes it stay the same until systems are physically
497 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
498 * controllers. Adding and removing devices, including virtual root hubs
499 * in host controller driver modules, does not change these path identifers;
500 * neither does rebooting or re-enumerating. These are more useful identifiers
501 * than changeable ("unstable") ones like bus numbers or device addresses.
503 * With a partial exception for devices connected to USB 2.0 root hubs, these
504 * identifiers are also predictable. So long as the device tree isn't changed,
505 * plugging any USB device into a given hub port always gives it the same path.
506 * Because of the use of "companion" controllers, devices connected to ports on
507 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
508 * high speed, and a different one if they are full or low speed.
510 static inline int usb_make_path (struct usb_device
*dev
, char *buf
,
514 actual
= snprintf (buf
, size
, "usb-%s-%s", dev
->bus
->bus_name
,
516 return (actual
>= (int)size
) ? -1 : actual
;
519 /*-------------------------------------------------------------------------*/
522 * usb_endpoint_dir_in - check if the endpoint has IN direction
523 * @epd: endpoint to be checked
525 * Returns true if the endpoint is of type IN, otherwise it returns false.
527 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor
*epd
)
529 return ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_IN
);
533 * usb_endpoint_dir_out - check if the endpoint has OUT direction
534 * @epd: endpoint to be checked
536 * Returns true if the endpoint is of type OUT, otherwise it returns false.
538 static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor
*epd
)
540 return ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
);
544 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
545 * @epd: endpoint to be checked
547 * Returns true if the endpoint is of type bulk, otherwise it returns false.
549 static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor
*epd
)
551 return ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
552 USB_ENDPOINT_XFER_BULK
);
556 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
557 * @epd: endpoint to be checked
559 * Returns true if the endpoint is of type interrupt, otherwise it returns
562 static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor
*epd
)
564 return ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
565 USB_ENDPOINT_XFER_INT
);
569 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
570 * @epd: endpoint to be checked
572 * Returns true if the endpoint is of type isochronous, otherwise it returns
575 static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor
*epd
)
577 return ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) ==
578 USB_ENDPOINT_XFER_ISOC
);
582 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
583 * @epd: endpoint to be checked
585 * Returns true if the endpoint has bulk transfer type and IN direction,
586 * otherwise it returns false.
588 static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor
*epd
)
590 return (usb_endpoint_xfer_bulk(epd
) && usb_endpoint_dir_in(epd
));
594 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
595 * @epd: endpoint to be checked
597 * Returns true if the endpoint has bulk transfer type and OUT direction,
598 * otherwise it returns false.
600 static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor
*epd
)
602 return (usb_endpoint_xfer_bulk(epd
) && usb_endpoint_dir_out(epd
));
606 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
607 * @epd: endpoint to be checked
609 * Returns true if the endpoint has interrupt transfer type and IN direction,
610 * otherwise it returns false.
612 static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor
*epd
)
614 return (usb_endpoint_xfer_int(epd
) && usb_endpoint_dir_in(epd
));
618 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
619 * @epd: endpoint to be checked
621 * Returns true if the endpoint has interrupt transfer type and OUT direction,
622 * otherwise it returns false.
624 static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor
*epd
)
626 return (usb_endpoint_xfer_int(epd
) && usb_endpoint_dir_out(epd
));
630 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
631 * @epd: endpoint to be checked
633 * Returns true if the endpoint has isochronous transfer type and IN direction,
634 * otherwise it returns false.
636 static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor
*epd
)
638 return (usb_endpoint_xfer_isoc(epd
) && usb_endpoint_dir_in(epd
));
642 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
643 * @epd: endpoint to be checked
645 * Returns true if the endpoint has isochronous transfer type and OUT direction,
646 * otherwise it returns false.
648 static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor
*epd
)
650 return (usb_endpoint_xfer_isoc(epd
) && usb_endpoint_dir_out(epd
));
653 /*-------------------------------------------------------------------------*/
655 #define USB_DEVICE_ID_MATCH_DEVICE \
656 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
657 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
658 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
659 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
660 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
661 #define USB_DEVICE_ID_MATCH_DEV_INFO \
662 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
663 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
664 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
665 #define USB_DEVICE_ID_MATCH_INT_INFO \
666 (USB_DEVICE_ID_MATCH_INT_CLASS | \
667 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
668 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
671 * USB_DEVICE - macro used to describe a specific usb device
672 * @vend: the 16 bit USB Vendor ID
673 * @prod: the 16 bit USB Product ID
675 * This macro is used to create a struct usb_device_id that matches a
678 #define USB_DEVICE(vend,prod) \
679 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
682 * USB_DEVICE_VER - macro used to describe a specific usb device with a
684 * @vend: the 16 bit USB Vendor ID
685 * @prod: the 16 bit USB Product ID
686 * @lo: the bcdDevice_lo value
687 * @hi: the bcdDevice_hi value
689 * This macro is used to create a struct usb_device_id that matches a
690 * specific device, with a version range.
692 #define USB_DEVICE_VER(vend,prod,lo,hi) \
693 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
694 .idVendor = (vend), .idProduct = (prod), \
695 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
698 * USB_DEVICE_INFO - macro used to describe a class of usb devices
699 * @cl: bDeviceClass value
700 * @sc: bDeviceSubClass value
701 * @pr: bDeviceProtocol value
703 * This macro is used to create a struct usb_device_id that matches a
704 * specific class of devices.
706 #define USB_DEVICE_INFO(cl,sc,pr) \
707 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
708 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
711 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
712 * @cl: bInterfaceClass value
713 * @sc: bInterfaceSubClass value
714 * @pr: bInterfaceProtocol value
716 * This macro is used to create a struct usb_device_id that matches a
717 * specific class of interfaces.
719 #define USB_INTERFACE_INFO(cl,sc,pr) \
720 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
721 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
723 /* ----------------------------------------------------------------------- */
727 struct list_head list
;
731 * struct usbdrv_wrap - wrapper for driver-model structure
732 * @driver: The driver-model core driver structure.
733 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
736 struct device_driver driver
;
741 * struct usb_driver - identifies USB interface driver to usbcore
742 * @name: The driver name should be unique among USB drivers,
743 * and should normally be the same as the module name.
744 * @probe: Called to see if the driver is willing to manage a particular
745 * interface on a device. If it is, probe returns zero and uses
746 * dev_set_drvdata() to associate driver-specific data with the
747 * interface. It may also use usb_set_interface() to specify the
748 * appropriate altsetting. If unwilling to manage the interface,
749 * return a negative errno value.
750 * @disconnect: Called when the interface is no longer accessible, usually
751 * because its device has been (or is being) disconnected or the
752 * driver module is being unloaded.
753 * @ioctl: Used for drivers that want to talk to userspace through
754 * the "usbfs" filesystem. This lets devices provide ways to
755 * expose information to user space regardless of where they
756 * do (or don't) show up otherwise in the filesystem.
757 * @suspend: Called when the device is going to be suspended by the system.
758 * @resume: Called when the device is being resumed by the system.
759 * @pre_reset: Called by usb_reset_composite_device() when the device
760 * is about to be reset.
761 * @post_reset: Called by usb_reset_composite_device() after the device
763 * @id_table: USB drivers use ID table to support hotplugging.
764 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
765 * or your driver's probe function will never get called.
766 * @dynids: used internally to hold the list of dynamically added device
767 * ids for this driver.
768 * @drvwrap: Driver-model core structure wrapper.
769 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
770 * added to this driver by preventing the sysfs file from being created.
771 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
772 * for interfaces bound to this driver.
774 * USB interface drivers must provide a name, probe() and disconnect()
775 * methods, and an id_table. Other driver fields are optional.
777 * The id_table is used in hotplugging. It holds a set of descriptors,
778 * and specialized data may be associated with each entry. That table
779 * is used by both user and kernel mode hotplugging support.
781 * The probe() and disconnect() methods are called in a context where
782 * they can sleep, but they should avoid abusing the privilege. Most
783 * work to connect to a device should be done when the device is opened,
784 * and undone at the last close. The disconnect code needs to address
785 * concurrency issues with respect to open() and close() methods, as
786 * well as forcing all pending I/O requests to complete (by unlinking
787 * them as necessary, and blocking until the unlinks complete).
792 int (*probe
) (struct usb_interface
*intf
,
793 const struct usb_device_id
*id
);
795 void (*disconnect
) (struct usb_interface
*intf
);
797 int (*ioctl
) (struct usb_interface
*intf
, unsigned int code
,
800 int (*suspend
) (struct usb_interface
*intf
, pm_message_t message
);
801 int (*resume
) (struct usb_interface
*intf
);
803 void (*pre_reset
) (struct usb_interface
*intf
);
804 void (*post_reset
) (struct usb_interface
*intf
);
806 const struct usb_device_id
*id_table
;
808 struct usb_dynids dynids
;
809 struct usbdrv_wrap drvwrap
;
810 unsigned int no_dynamic_id
:1;
811 unsigned int supports_autosuspend
:1;
813 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
816 * struct usb_device_driver - identifies USB device driver to usbcore
817 * @name: The driver name should be unique among USB drivers,
818 * and should normally be the same as the module name.
819 * @probe: Called to see if the driver is willing to manage a particular
820 * device. If it is, probe returns zero and uses dev_set_drvdata()
821 * to associate driver-specific data with the device. If unwilling
822 * to manage the device, return a negative errno value.
823 * @disconnect: Called when the device is no longer accessible, usually
824 * because it has been (or is being) disconnected or the driver's
825 * module is being unloaded.
826 * @suspend: Called when the device is going to be suspended by the system.
827 * @resume: Called when the device is being resumed by the system.
828 * @drvwrap: Driver-model core structure wrapper.
829 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
830 * for devices bound to this driver.
832 * USB drivers must provide all the fields listed above except drvwrap.
834 struct usb_device_driver
{
837 int (*probe
) (struct usb_device
*udev
);
838 void (*disconnect
) (struct usb_device
*udev
);
840 int (*suspend
) (struct usb_device
*udev
, pm_message_t message
);
841 int (*resume
) (struct usb_device
*udev
);
842 struct usbdrv_wrap drvwrap
;
843 unsigned int supports_autosuspend
:1;
845 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
848 extern struct bus_type usb_bus_type
;
851 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
852 * @name: the usb class device name for this driver. Will show up in sysfs.
853 * @fops: pointer to the struct file_operations of this driver.
854 * @minor_base: the start of the minor range for this driver.
856 * This structure is used for the usb_register_dev() and
857 * usb_unregister_dev() functions, to consolidate a number of the
858 * parameters used for them.
860 struct usb_class_driver
{
862 const struct file_operations
*fops
;
867 * use these in module_init()/module_exit()
868 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
870 extern int usb_register_driver(struct usb_driver
*, struct module
*);
871 static inline int usb_register(struct usb_driver
*driver
)
873 return usb_register_driver(driver
, THIS_MODULE
);
875 extern void usb_deregister(struct usb_driver
*);
877 extern int usb_register_device_driver(struct usb_device_driver
*,
879 extern void usb_deregister_device_driver(struct usb_device_driver
*);
881 extern int usb_register_dev(struct usb_interface
*intf
,
882 struct usb_class_driver
*class_driver
);
883 extern void usb_deregister_dev(struct usb_interface
*intf
,
884 struct usb_class_driver
*class_driver
);
886 extern int usb_disabled(void);
888 /* ----------------------------------------------------------------------- */
891 * URB support, for asynchronous request completions
895 * urb->transfer_flags:
897 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
898 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
900 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
901 #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
902 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
903 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
904 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
907 struct usb_iso_packet_descriptor
{
909 unsigned int length
; /* expected length */
910 unsigned int actual_length
;
916 typedef void (*usb_complete_t
)(struct urb
*);
919 * struct urb - USB Request Block
920 * @urb_list: For use by current owner of the URB.
921 * @pipe: Holds endpoint number, direction, type, and more.
922 * Create these values with the eight macros available;
923 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
924 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
925 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
926 * numbers range from zero to fifteen. Note that "in" endpoint two
927 * is a different endpoint (and pipe) from "out" endpoint two.
928 * The current configuration controls the existence, type, and
929 * maximum packet size of any given endpoint.
930 * @dev: Identifies the USB device to perform the request.
931 * @status: This is read in non-iso completion functions to get the
932 * status of the particular request. ISO requests only use it
933 * to tell whether the URB was unlinked; detailed status for
934 * each frame is in the fields of the iso_frame-desc.
935 * @transfer_flags: A variety of flags may be used to affect how URB
936 * submission, unlinking, or operation are handled. Different
937 * kinds of URB can use different flags.
938 * @transfer_buffer: This identifies the buffer to (or from) which
939 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
940 * is set). This buffer must be suitable for DMA; allocate it with
941 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
942 * of this buffer will be modified. This buffer is used for the data
943 * stage of control transfers.
944 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
945 * the device driver is saying that it provided this DMA address,
946 * which the host controller driver should use in preference to the
948 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
949 * be broken up into chunks according to the current maximum packet
950 * size for the endpoint, which is a function of the configuration
951 * and is encoded in the pipe. When the length is zero, neither
952 * transfer_buffer nor transfer_dma is used.
953 * @actual_length: This is read in non-iso completion functions, and
954 * it tells how many bytes (out of transfer_buffer_length) were
955 * transferred. It will normally be the same as requested, unless
956 * either an error was reported or a short read was performed.
957 * The URB_SHORT_NOT_OK transfer flag may be used to make such
958 * short reads be reported as errors.
959 * @setup_packet: Only used for control transfers, this points to eight bytes
960 * of setup data. Control transfers always start by sending this data
961 * to the device. Then transfer_buffer is read or written, if needed.
962 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
963 * device driver has provided this DMA address for the setup packet.
964 * The host controller driver should use this in preference to
966 * @start_frame: Returns the initial frame for isochronous transfers.
967 * @number_of_packets: Lists the number of ISO transfer buffers.
968 * @interval: Specifies the polling interval for interrupt or isochronous
969 * transfers. The units are frames (milliseconds) for for full and low
970 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
971 * @error_count: Returns the number of ISO transfers that reported errors.
972 * @context: For use in completion functions. This normally points to
973 * request-specific driver context.
974 * @complete: Completion handler. This URB is passed as the parameter to the
975 * completion function. The completion function may then do what
976 * it likes with the URB, including resubmitting or freeing it.
977 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
978 * collect the transfer status for each buffer.
980 * This structure identifies USB transfer requests. URBs must be allocated by
981 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
982 * Initialization may be done using various usb_fill_*_urb() functions. URBs
983 * are submitted using usb_submit_urb(), and pending requests may be canceled
984 * using usb_unlink_urb() or usb_kill_urb().
986 * Data Transfer Buffers:
988 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
989 * taken from the general page pool. That is provided by transfer_buffer
990 * (control requests also use setup_packet), and host controller drivers
991 * perform a dma mapping (and unmapping) for each buffer transferred. Those
992 * mapping operations can be expensive on some platforms (perhaps using a dma
993 * bounce buffer or talking to an IOMMU),
994 * although they're cheap on commodity x86 and ppc hardware.
996 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
997 * which tell the host controller driver that no such mapping is needed since
998 * the device driver is DMA-aware. For example, a device driver might
999 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1000 * When these transfer flags are provided, host controller drivers will
1001 * attempt to use the dma addresses found in the transfer_dma and/or
1002 * setup_dma fields rather than determining a dma address themselves. (Note
1003 * that transfer_buffer and setup_packet must still be set because not all
1004 * host controllers use DMA, nor do virtual root hubs).
1008 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1009 * zero), and complete fields. All URBs must also initialize
1010 * transfer_buffer and transfer_buffer_length. They may provide the
1011 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1012 * to be treated as errors; that flag is invalid for write requests.
1015 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1016 * should always terminate with a short packet, even if it means adding an
1017 * extra zero length packet.
1019 * Control URBs must provide a setup_packet. The setup_packet and
1020 * transfer_buffer may each be mapped for DMA or not, independently of
1021 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1022 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1023 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1025 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1026 * or, for highspeed devices, 125 microsecond units)
1027 * to poll for transfers. After the URB has been submitted, the interval
1028 * field reflects how the transfer was actually scheduled.
1029 * The polling interval may be more frequent than requested.
1030 * For example, some controllers have a maximum interval of 32 milliseconds,
1031 * while others support intervals of up to 1024 milliseconds.
1032 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1033 * endpoints, as well as high speed interrupt endpoints, the encoding of
1034 * the transfer interval in the endpoint descriptor is logarithmic.
1035 * Device drivers must convert that value to linear units themselves.)
1037 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1038 * the host controller to schedule the transfer as soon as bandwidth
1039 * utilization allows, and then set start_frame to reflect the actual frame
1040 * selected during submission. Otherwise drivers must specify the start_frame
1041 * and handle the case where the transfer can't begin then. However, drivers
1042 * won't know how bandwidth is currently allocated, and while they can
1043 * find the current frame using usb_get_current_frame_number () they can't
1044 * know the range for that frame number. (Ranges for frame counter values
1045 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1047 * Isochronous URBs have a different data transfer model, in part because
1048 * the quality of service is only "best effort". Callers provide specially
1049 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1050 * at the end. Each such packet is an individual ISO transfer. Isochronous
1051 * URBs are normally queued, submitted by drivers to arrange that
1052 * transfers are at least double buffered, and then explicitly resubmitted
1053 * in completion handlers, so
1054 * that data (such as audio or video) streams at as constant a rate as the
1055 * host controller scheduler can support.
1057 * Completion Callbacks:
1059 * The completion callback is made in_interrupt(), and one of the first
1060 * things that a completion handler should do is check the status field.
1061 * The status field is provided for all URBs. It is used to report
1062 * unlinked URBs, and status for all non-ISO transfers. It should not
1063 * be examined before the URB is returned to the completion handler.
1065 * The context field is normally used to link URBs back to the relevant
1066 * driver or request state.
1068 * When the completion callback is invoked for non-isochronous URBs, the
1069 * actual_length field tells how many bytes were transferred. This field
1070 * is updated even when the URB terminated with an error or was unlinked.
1072 * ISO transfer status is reported in the status and actual_length fields
1073 * of the iso_frame_desc array, and the number of errors is reported in
1074 * error_count. Completion callbacks for ISO transfers will normally
1075 * (re)submit URBs to ensure a constant transfer rate.
1077 * Note that even fields marked "public" should not be touched by the driver
1078 * when the urb is owned by the hcd, that is, since the call to
1079 * usb_submit_urb() till the entry into the completion routine.
1083 /* private: usb core and host controller only fields in the urb */
1084 struct kref kref
; /* reference count of the URB */
1085 spinlock_t lock
; /* lock for the URB */
1086 void *hcpriv
; /* private data for host controller */
1087 int bandwidth
; /* bandwidth for INT/ISO request */
1088 atomic_t use_count
; /* concurrent submissions counter */
1089 u8 reject
; /* submissions will fail */
1091 /* public: documented fields in the urb that can be used by drivers */
1092 struct list_head urb_list
; /* list head for use by the urb's
1094 struct usb_device
*dev
; /* (in) pointer to associated device */
1095 unsigned int pipe
; /* (in) pipe information */
1096 int status
; /* (return) non-ISO status */
1097 unsigned int transfer_flags
; /* (in) URB_SHORT_NOT_OK | ...*/
1098 void *transfer_buffer
; /* (in) associated data buffer */
1099 dma_addr_t transfer_dma
; /* (in) dma addr for transfer_buffer */
1100 int transfer_buffer_length
; /* (in) data buffer length */
1101 int actual_length
; /* (return) actual transfer length */
1102 unsigned char *setup_packet
; /* (in) setup packet (control only) */
1103 dma_addr_t setup_dma
; /* (in) dma addr for setup_packet */
1104 int start_frame
; /* (modify) start frame (ISO) */
1105 int number_of_packets
; /* (in) number of ISO packets */
1106 int interval
; /* (modify) transfer interval
1108 int error_count
; /* (return) number of ISO errors */
1109 void *context
; /* (in) context for completion */
1110 usb_complete_t complete
; /* (in) completion routine */
1111 struct usb_iso_packet_descriptor iso_frame_desc
[0];
1115 /* ----------------------------------------------------------------------- */
1118 * usb_fill_control_urb - initializes a control urb
1119 * @urb: pointer to the urb to initialize.
1120 * @dev: pointer to the struct usb_device for this urb.
1121 * @pipe: the endpoint pipe
1122 * @setup_packet: pointer to the setup_packet buffer
1123 * @transfer_buffer: pointer to the transfer buffer
1124 * @buffer_length: length of the transfer buffer
1125 * @complete_fn: pointer to the usb_complete_t function
1126 * @context: what to set the urb context to.
1128 * Initializes a control urb with the proper information needed to submit
1131 static inline void usb_fill_control_urb (struct urb
*urb
,
1132 struct usb_device
*dev
,
1134 unsigned char *setup_packet
,
1135 void *transfer_buffer
,
1137 usb_complete_t complete_fn
,
1140 spin_lock_init(&urb
->lock
);
1143 urb
->setup_packet
= setup_packet
;
1144 urb
->transfer_buffer
= transfer_buffer
;
1145 urb
->transfer_buffer_length
= buffer_length
;
1146 urb
->complete
= complete_fn
;
1147 urb
->context
= context
;
1151 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1152 * @urb: pointer to the urb to initialize.
1153 * @dev: pointer to the struct usb_device for this urb.
1154 * @pipe: the endpoint pipe
1155 * @transfer_buffer: pointer to the transfer buffer
1156 * @buffer_length: length of the transfer buffer
1157 * @complete_fn: pointer to the usb_complete_t function
1158 * @context: what to set the urb context to.
1160 * Initializes a bulk urb with the proper information needed to submit it
1163 static inline void usb_fill_bulk_urb (struct urb
*urb
,
1164 struct usb_device
*dev
,
1166 void *transfer_buffer
,
1168 usb_complete_t complete_fn
,
1171 spin_lock_init(&urb
->lock
);
1174 urb
->transfer_buffer
= transfer_buffer
;
1175 urb
->transfer_buffer_length
= buffer_length
;
1176 urb
->complete
= complete_fn
;
1177 urb
->context
= context
;
1181 * usb_fill_int_urb - macro to help initialize a interrupt urb
1182 * @urb: pointer to the urb to initialize.
1183 * @dev: pointer to the struct usb_device for this urb.
1184 * @pipe: the endpoint pipe
1185 * @transfer_buffer: pointer to the transfer buffer
1186 * @buffer_length: length of the transfer buffer
1187 * @complete_fn: pointer to the usb_complete_t function
1188 * @context: what to set the urb context to.
1189 * @interval: what to set the urb interval to, encoded like
1190 * the endpoint descriptor's bInterval value.
1192 * Initializes a interrupt urb with the proper information needed to submit
1194 * Note that high speed interrupt endpoints use a logarithmic encoding of
1195 * the endpoint interval, and express polling intervals in microframes
1196 * (eight per millisecond) rather than in frames (one per millisecond).
1198 static inline void usb_fill_int_urb (struct urb
*urb
,
1199 struct usb_device
*dev
,
1201 void *transfer_buffer
,
1203 usb_complete_t complete_fn
,
1207 spin_lock_init(&urb
->lock
);
1210 urb
->transfer_buffer
= transfer_buffer
;
1211 urb
->transfer_buffer_length
= buffer_length
;
1212 urb
->complete
= complete_fn
;
1213 urb
->context
= context
;
1214 if (dev
->speed
== USB_SPEED_HIGH
)
1215 urb
->interval
= 1 << (interval
- 1);
1217 urb
->interval
= interval
;
1218 urb
->start_frame
= -1;
1221 extern void usb_init_urb(struct urb
*urb
);
1222 extern struct urb
*usb_alloc_urb(int iso_packets
, gfp_t mem_flags
);
1223 extern void usb_free_urb(struct urb
*urb
);
1224 #define usb_put_urb usb_free_urb
1225 extern struct urb
*usb_get_urb(struct urb
*urb
);
1226 extern int usb_submit_urb(struct urb
*urb
, gfp_t mem_flags
);
1227 extern int usb_unlink_urb(struct urb
*urb
);
1228 extern void usb_kill_urb(struct urb
*urb
);
1230 void *usb_buffer_alloc (struct usb_device
*dev
, size_t size
,
1231 gfp_t mem_flags
, dma_addr_t
*dma
);
1232 void usb_buffer_free (struct usb_device
*dev
, size_t size
,
1233 void *addr
, dma_addr_t dma
);
1236 struct urb
*usb_buffer_map (struct urb
*urb
);
1237 void usb_buffer_dmasync (struct urb
*urb
);
1238 void usb_buffer_unmap (struct urb
*urb
);
1242 int usb_buffer_map_sg(const struct usb_device
*dev
, unsigned pipe
,
1243 struct scatterlist
*sg
, int nents
);
1245 void usb_buffer_dmasync_sg(const struct usb_device
*dev
, unsigned pipe
,
1246 struct scatterlist
*sg
, int n_hw_ents
);
1248 void usb_buffer_unmap_sg(const struct usb_device
*dev
, unsigned pipe
,
1249 struct scatterlist
*sg
, int n_hw_ents
);
1251 /*-------------------------------------------------------------------*
1252 * SYNCHRONOUS CALL SUPPORT *
1253 *-------------------------------------------------------------------*/
1255 extern int usb_control_msg(struct usb_device
*dev
, unsigned int pipe
,
1256 __u8 request
, __u8 requesttype
, __u16 value
, __u16 index
,
1257 void *data
, __u16 size
, int timeout
);
1258 extern int usb_interrupt_msg(struct usb_device
*usb_dev
, unsigned int pipe
,
1259 void *data
, int len
, int *actual_length
, int timeout
);
1260 extern int usb_bulk_msg(struct usb_device
*usb_dev
, unsigned int pipe
,
1261 void *data
, int len
, int *actual_length
,
1264 /* wrappers around usb_control_msg() for the most common standard requests */
1265 extern int usb_get_descriptor(struct usb_device
*dev
, unsigned char desctype
,
1266 unsigned char descindex
, void *buf
, int size
);
1267 extern int usb_get_status(struct usb_device
*dev
,
1268 int type
, int target
, void *data
);
1269 extern int usb_string(struct usb_device
*dev
, int index
,
1270 char *buf
, size_t size
);
1272 /* wrappers that also update important state inside usbcore */
1273 extern int usb_clear_halt(struct usb_device
*dev
, int pipe
);
1274 extern int usb_reset_configuration(struct usb_device
*dev
);
1275 extern int usb_set_interface(struct usb_device
*dev
, int ifnum
, int alternate
);
1277 /* this request isn't really synchronous, but it belongs with the others */
1278 extern int usb_driver_set_configuration(struct usb_device
*udev
, int config
);
1281 * timeouts, in milliseconds, used for sending/receiving control messages
1282 * they typically complete within a few frames (msec) after they're issued
1283 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1284 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1286 #define USB_CTRL_GET_TIMEOUT 5000
1287 #define USB_CTRL_SET_TIMEOUT 5000
1291 * struct usb_sg_request - support for scatter/gather I/O
1292 * @status: zero indicates success, else negative errno
1293 * @bytes: counts bytes transferred.
1295 * These requests are initialized using usb_sg_init(), and then are used
1296 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1297 * members of the request object aren't for driver access.
1299 * The status and bytecount values are valid only after usb_sg_wait()
1300 * returns. If the status is zero, then the bytecount matches the total
1303 * After an error completion, drivers may need to clear a halt condition
1306 struct usb_sg_request
{
1311 * members below are private: to usbcore,
1312 * and are not provided for driver access!
1316 struct usb_device
*dev
;
1318 struct scatterlist
*sg
;
1325 struct completion complete
;
1329 struct usb_sg_request
*io
,
1330 struct usb_device
*dev
,
1333 struct scatterlist
*sg
,
1338 void usb_sg_cancel (struct usb_sg_request
*io
);
1339 void usb_sg_wait (struct usb_sg_request
*io
);
1342 /* ----------------------------------------------------------------------- */
1345 * For various legacy reasons, Linux has a small cookie that's paired with
1346 * a struct usb_device to identify an endpoint queue. Queue characteristics
1347 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1348 * an unsigned int encoded as:
1350 * - direction: bit 7 (0 = Host-to-Device [Out],
1351 * 1 = Device-to-Host [In] ...
1352 * like endpoint bEndpointAddress)
1353 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1354 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1355 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1356 * 10 = control, 11 = bulk)
1358 * Given the device address and endpoint descriptor, pipes are redundant.
1361 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1362 /* (yet ... they're the values used by usbfs) */
1363 #define PIPE_ISOCHRONOUS 0
1364 #define PIPE_INTERRUPT 1
1365 #define PIPE_CONTROL 2
1368 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1369 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1371 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1372 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1374 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1375 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1376 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1377 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1378 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1380 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1381 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1382 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
1383 #define usb_settoggle(dev, ep, out, bit) \
1384 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1388 static inline unsigned int __create_pipe(struct usb_device
*dev
,
1389 unsigned int endpoint
)
1391 return (dev
->devnum
<< 8) | (endpoint
<< 15);
1394 /* Create various pipes... */
1395 #define usb_sndctrlpipe(dev,endpoint) \
1396 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1397 #define usb_rcvctrlpipe(dev,endpoint) \
1398 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1399 #define usb_sndisocpipe(dev,endpoint) \
1400 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1401 #define usb_rcvisocpipe(dev,endpoint) \
1402 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1403 #define usb_sndbulkpipe(dev,endpoint) \
1404 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1405 #define usb_rcvbulkpipe(dev,endpoint) \
1406 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1407 #define usb_sndintpipe(dev,endpoint) \
1408 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1409 #define usb_rcvintpipe(dev,endpoint) \
1410 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1412 /*-------------------------------------------------------------------------*/
1415 usb_maxpacket(struct usb_device
*udev
, int pipe
, int is_out
)
1417 struct usb_host_endpoint
*ep
;
1418 unsigned epnum
= usb_pipeendpoint(pipe
);
1421 WARN_ON(usb_pipein(pipe
));
1422 ep
= udev
->ep_out
[epnum
];
1424 WARN_ON(usb_pipeout(pipe
));
1425 ep
= udev
->ep_in
[epnum
];
1430 /* NOTE: only 0x07ff bits are for packet size... */
1431 return le16_to_cpu(ep
->desc
.wMaxPacketSize
);
1434 /* ----------------------------------------------------------------------- */
1436 /* Events from the usb core */
1437 #define USB_DEVICE_ADD 0x0001
1438 #define USB_DEVICE_REMOVE 0x0002
1439 #define USB_BUS_ADD 0x0003
1440 #define USB_BUS_REMOVE 0x0004
1441 extern void usb_register_notify(struct notifier_block
*nb
);
1442 extern void usb_unregister_notify(struct notifier_block
*nb
);
1445 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1448 #define dbg(format, arg...) do {} while (0)
1451 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1453 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1455 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1459 #endif /* __KERNEL__ */