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 */
26 /*-------------------------------------------------------------------------*/
29 * Host-side wrappers for standard USB descriptors ... these are parsed
30 * from the data provided by devices. Parsing turns them from a flat
31 * sequence of descriptors into a hierarchy:
33 * - devices have one (usually) or more configs;
34 * - configs have one (often) or more interfaces;
35 * - interfaces have one (usually) or more settings;
36 * - each interface setting has zero or (usually) more endpoints.
38 * And there might be other descriptors mixed in with those.
40 * Devices may also have class-specific or vendor-specific descriptors.
46 * struct usb_host_endpoint - host-side endpoint descriptor and queue
47 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
48 * @urb_list: urbs queued to this endpoint; maintained by usbcore
49 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
50 * with one or more transfer descriptors (TDs) per urb
51 * @ep_dev: ep_device for sysfs info
52 * @extra: descriptors following this endpoint in the configuration
53 * @extralen: how many bytes of "extra" are valid
55 * USB requests are always queued to a given endpoint, identified by a
56 * descriptor within an active interface in a given USB configuration.
58 struct usb_host_endpoint
{
59 struct usb_endpoint_descriptor desc
;
60 struct list_head urb_list
;
62 struct ep_device
*ep_dev
; /* For sysfs info */
64 unsigned char *extra
; /* Extra descriptors */
68 /* host-side wrapper for one interface setting's parsed descriptors */
69 struct usb_host_interface
{
70 struct usb_interface_descriptor desc
;
72 /* array of desc.bNumEndpoint endpoints associated with this
73 * interface setting. these will be in no particular order.
75 struct usb_host_endpoint
*endpoint
;
77 char *string
; /* iInterface string, if present */
78 unsigned char *extra
; /* Extra descriptors */
82 enum usb_interface_condition
{
83 USB_INTERFACE_UNBOUND
= 0,
84 USB_INTERFACE_BINDING
,
86 USB_INTERFACE_UNBINDING
,
90 * struct usb_interface - what usb device drivers talk to
91 * @altsetting: array of interface structures, one for each alternate
92 * setting that may be selected. Each one includes a set of
93 * endpoint configurations. They will be in no particular order.
94 * @num_altsetting: number of altsettings defined.
95 * @cur_altsetting: the current altsetting.
96 * @driver: the USB driver that is bound to this interface.
97 * @minor: the minor number assigned to this interface, if this
98 * interface is bound to a driver that uses the USB major number.
99 * If this interface does not use the USB major, this field should
100 * be unused. The driver should set this value in the probe()
101 * function of the driver, after it has been assigned a minor
102 * number from the USB core by calling usb_register_dev().
103 * @condition: binding state of the interface: not bound, binding
104 * (in probe()), bound to a driver, or unbinding (in disconnect())
105 * @is_active: flag set when the interface is bound and not suspended.
106 * @dev: driver model's view of this device
107 * @class_dev: driver model's class view of this device.
109 * USB device drivers attach to interfaces on a physical device. Each
110 * interface encapsulates a single high level function, such as feeding
111 * an audio stream to a speaker or reporting a change in a volume control.
112 * Many USB devices only have one interface. The protocol used to talk to
113 * an interface's endpoints can be defined in a usb "class" specification,
114 * or by a product's vendor. The (default) control endpoint is part of
115 * every interface, but is never listed among the interface's descriptors.
117 * The driver that is bound to the interface can use standard driver model
118 * calls such as dev_get_drvdata() on the dev member of this structure.
120 * Each interface may have alternate settings. The initial configuration
121 * of a device sets altsetting 0, but the device driver can change
122 * that setting using usb_set_interface(). Alternate settings are often
123 * used to control the the use of periodic endpoints, such as by having
124 * different endpoints use different amounts of reserved USB bandwidth.
125 * All standards-conformant USB devices that use isochronous endpoints
126 * will use them in non-default settings.
128 * The USB specification says that alternate setting numbers must run from
129 * 0 to one less than the total number of alternate settings. But some
130 * devices manage to mess this up, and the structures aren't necessarily
131 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
132 * look up an alternate setting in the altsetting array based on its number.
134 struct usb_interface
{
135 /* array of alternate settings for this interface,
136 * stored in no particular order */
137 struct usb_host_interface
*altsetting
;
139 struct usb_host_interface
*cur_altsetting
; /* the currently
140 * active alternate setting */
141 unsigned num_altsetting
; /* number of alternate settings */
143 int minor
; /* minor number this interface is
145 enum usb_interface_condition condition
; /* state of binding */
146 unsigned is_active
:1; /* the interface is not suspended */
148 struct device dev
; /* interface specific device info */
149 struct class_device
*class_dev
;
151 #define to_usb_interface(d) container_of(d, struct usb_interface, dev)
152 #define interface_to_usbdev(intf) \
153 container_of(intf->dev.parent, struct usb_device, dev)
155 static inline void *usb_get_intfdata (struct usb_interface
*intf
)
157 return dev_get_drvdata (&intf
->dev
);
160 static inline void usb_set_intfdata (struct usb_interface
*intf
, void *data
)
162 dev_set_drvdata(&intf
->dev
, data
);
165 struct usb_interface
*usb_get_intf(struct usb_interface
*intf
);
166 void usb_put_intf(struct usb_interface
*intf
);
168 /* this maximum is arbitrary */
169 #define USB_MAXINTERFACES 32
172 * struct usb_interface_cache - long-term representation of a device interface
173 * @num_altsetting: number of altsettings defined.
174 * @ref: reference counter.
175 * @altsetting: variable-length array of interface structures, one for
176 * each alternate setting that may be selected. Each one includes a
177 * set of endpoint configurations. They will be in no particular order.
179 * These structures persist for the lifetime of a usb_device, unlike
180 * struct usb_interface (which persists only as long as its configuration
181 * is installed). The altsetting arrays can be accessed through these
182 * structures at any time, permitting comparison of configurations and
183 * providing support for the /proc/bus/usb/devices pseudo-file.
185 struct usb_interface_cache
{
186 unsigned num_altsetting
; /* number of alternate settings */
187 struct kref ref
; /* reference counter */
189 /* variable-length array of alternate settings for this interface,
190 * stored in no particular order */
191 struct usb_host_interface altsetting
[0];
193 #define ref_to_usb_interface_cache(r) \
194 container_of(r, struct usb_interface_cache, ref)
195 #define altsetting_to_usb_interface_cache(a) \
196 container_of(a, struct usb_interface_cache, altsetting[0])
199 * struct usb_host_config - representation of a device's configuration
200 * @desc: the device's configuration descriptor.
201 * @string: pointer to the cached version of the iConfiguration string, if
202 * present for this configuration.
203 * @interface: array of pointers to usb_interface structures, one for each
204 * interface in the configuration. The number of interfaces is stored
205 * in desc.bNumInterfaces. These pointers are valid only while the
206 * the configuration is active.
207 * @intf_cache: array of pointers to usb_interface_cache structures, one
208 * for each interface in the configuration. These structures exist
209 * for the entire life of the device.
210 * @extra: pointer to buffer containing all extra descriptors associated
211 * with this configuration (those preceding the first interface
213 * @extralen: length of the extra descriptors buffer.
215 * USB devices may have multiple configurations, but only one can be active
216 * at any time. Each encapsulates a different operational environment;
217 * for example, a dual-speed device would have separate configurations for
218 * full-speed and high-speed operation. The number of configurations
219 * available is stored in the device descriptor as bNumConfigurations.
221 * A configuration can contain multiple interfaces. Each corresponds to
222 * a different function of the USB device, and all are available whenever
223 * the configuration is active. The USB standard says that interfaces
224 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
225 * of devices get this wrong. In addition, the interface array is not
226 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
227 * look up an interface entry based on its number.
229 * Device drivers should not attempt to activate configurations. The choice
230 * of which configuration to install is a policy decision based on such
231 * considerations as available power, functionality provided, and the user's
232 * desires (expressed through userspace tools). However, drivers can call
233 * usb_reset_configuration() to reinitialize the current configuration and
234 * all its interfaces.
236 struct usb_host_config
{
237 struct usb_config_descriptor desc
;
239 char *string
; /* iConfiguration string, if present */
240 /* the interfaces associated with this configuration,
241 * stored in no particular order */
242 struct usb_interface
*interface
[USB_MAXINTERFACES
];
244 /* Interface information available even when this is not the
245 * active configuration */
246 struct usb_interface_cache
*intf_cache
[USB_MAXINTERFACES
];
248 unsigned char *extra
; /* Extra descriptors */
252 int __usb_get_extra_descriptor(char *buffer
, unsigned size
,
253 unsigned char type
, void **ptr
);
254 #define usb_get_extra_descriptor(ifpoint,type,ptr)\
255 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
258 /* ----------------------------------------------------------------------- */
260 struct usb_operations
;
262 /* USB device number allocation bitmap */
264 unsigned long devicemap
[128 / (8*sizeof(unsigned long))];
268 * Allocated per bus (tree of devices) we have:
271 struct device
*controller
; /* host/master side hardware */
272 int busnum
; /* Bus number (in order of reg) */
273 char *bus_name
; /* stable id (PCI slot_name etc) */
274 u8 otg_port
; /* 0, or number of OTG/HNP port */
275 unsigned is_b_host
:1; /* true during some HNP roleswitches */
276 unsigned b_hnp_enable
:1; /* OTG: did A-Host enable HNP? */
278 int devnum_next
; /* Next open device number in
279 * round-robin allocation */
281 struct usb_devmap devmap
; /* device address allocation map */
282 struct usb_operations
*op
; /* Operations (specific to the HC) */
283 struct usb_device
*root_hub
; /* Root hub */
284 struct list_head bus_list
; /* list of busses */
285 void *hcpriv
; /* Host Controller private data */
287 int bandwidth_allocated
; /* on this bus: how much of the time
288 * reserved for periodic (intr/iso)
289 * requests is used, on average?
290 * Units: microseconds/frame.
291 * Limits: Full/low speed reserve 90%,
292 * while high speed reserves 80%.
294 int bandwidth_int_reqs
; /* number of Interrupt requests */
295 int bandwidth_isoc_reqs
; /* number of Isoc. requests */
297 struct dentry
*usbfs_dentry
; /* usbfs dentry entry for the bus */
299 struct class_device
*class_dev
; /* class device for this bus */
300 struct kref kref
; /* reference counting for this bus */
301 void (*release
)(struct usb_bus
*bus
);
303 #if defined(CONFIG_USB_MON)
304 struct mon_bus
*mon_bus
; /* non-null when associated */
305 int monitored
; /* non-zero when monitored */
309 /* ----------------------------------------------------------------------- */
311 /* This is arbitrary.
312 * From USB 2.0 spec Table 11-13, offset 7, a hub can
313 * have up to 255 ports. The most yet reported is 10.
315 #define USB_MAXCHILDREN (16)
320 * struct usb_device - kernel's representation of a USB device
322 * FIXME: Write the kerneldoc!
324 * Usbcore drivers should not set usbdev->state directly. Instead use
325 * usb_set_device_state().
328 int devnum
; /* Address on USB bus */
329 char devpath
[16]; /* Use in messages: /port/port/... */
330 enum usb_device_state state
; /* configured, not attached, etc */
331 enum usb_device_speed speed
; /* high/full/low (or error) */
333 struct usb_tt
*tt
; /* low/full speed dev, highspeed hub */
334 int ttport
; /* device port on that tt hub */
336 unsigned int toggle
[2]; /* one bit for each endpoint
337 * ([0] = IN, [1] = OUT) */
339 struct usb_device
*parent
; /* our hub, unless we're the root */
340 struct usb_bus
*bus
; /* Bus we're part of */
341 struct usb_host_endpoint ep0
;
343 struct device dev
; /* Generic device interface */
345 struct usb_device_descriptor descriptor
;/* Descriptor */
346 struct usb_host_config
*config
; /* All of the configs */
348 struct usb_host_config
*actconfig
;/* the active configuration */
349 struct usb_host_endpoint
*ep_in
[16];
350 struct usb_host_endpoint
*ep_out
[16];
352 char **rawdescriptors
; /* Raw descriptors for each config */
354 unsigned short bus_mA
; /* Current available from the bus */
355 u8 portnum
; /* Parent port number (origin 1) */
357 int have_langid
; /* whether string_langid is valid */
358 int string_langid
; /* language ID for strings */
360 /* static strings from the device */
361 char *product
; /* iProduct string, if present */
362 char *manufacturer
; /* iManufacturer string, if present */
363 char *serial
; /* iSerialNumber string, if present */
365 struct list_head filelist
;
366 struct class_device
*class_dev
;
367 struct dentry
*usbfs_dentry
; /* usbfs dentry entry for the device */
370 * Child devices - these can be either new devices
371 * (if this is a hub device), or different instances
372 * of this same device.
374 * Each instance needs its own set of data structures.
377 int maxchild
; /* Number of ports if hub */
378 struct usb_device
*children
[USB_MAXCHILDREN
];
380 #define to_usb_device(d) container_of(d, struct usb_device, dev)
382 extern struct usb_device
*usb_get_dev(struct usb_device
*dev
);
383 extern void usb_put_dev(struct usb_device
*dev
);
385 /* USB device locking */
386 #define usb_lock_device(udev) down(&(udev)->dev.sem)
387 #define usb_unlock_device(udev) up(&(udev)->dev.sem)
388 #define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
389 extern int usb_lock_device_for_reset(struct usb_device
*udev
,
390 const struct usb_interface
*iface
);
392 /* USB port reset for device reinitialization */
393 extern int usb_reset_device(struct usb_device
*dev
);
394 extern int usb_reset_composite_device(struct usb_device
*dev
,
395 struct usb_interface
*iface
);
397 extern struct usb_device
*usb_find_device(u16 vendor_id
, u16 product_id
);
399 /*-------------------------------------------------------------------------*/
401 /* for drivers using iso endpoints */
402 extern int usb_get_current_frame_number (struct usb_device
*usb_dev
);
404 /* used these for multi-interface device registration */
405 extern int usb_driver_claim_interface(struct usb_driver
*driver
,
406 struct usb_interface
*iface
, void* priv
);
409 * usb_interface_claimed - returns true iff an interface is claimed
410 * @iface: the interface being checked
412 * Returns true (nonzero) iff the interface is claimed, else false (zero).
413 * Callers must own the driver model's usb bus readlock. So driver
414 * probe() entries don't need extra locking, but other call contexts
415 * may need to explicitly claim that lock.
418 static inline int usb_interface_claimed(struct usb_interface
*iface
) {
419 return (iface
->dev
.driver
!= NULL
);
422 extern void usb_driver_release_interface(struct usb_driver
*driver
,
423 struct usb_interface
*iface
);
424 const struct usb_device_id
*usb_match_id(struct usb_interface
*interface
,
425 const struct usb_device_id
*id
);
427 extern struct usb_interface
*usb_find_interface(struct usb_driver
*drv
,
429 extern struct usb_interface
*usb_ifnum_to_if(const struct usb_device
*dev
,
431 extern struct usb_host_interface
*usb_altnum_to_altsetting(
432 const struct usb_interface
*intf
, unsigned int altnum
);
436 * usb_make_path - returns stable device path in the usb tree
437 * @dev: the device whose path is being constructed
438 * @buf: where to put the string
439 * @size: how big is "buf"?
441 * Returns length of the string (> 0) or negative if size was too small.
443 * This identifier is intended to be "stable", reflecting physical paths in
444 * hardware such as physical bus addresses for host controllers or ports on
445 * USB hubs. That makes it stay the same until systems are physically
446 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
447 * controllers. Adding and removing devices, including virtual root hubs
448 * in host controller driver modules, does not change these path identifers;
449 * neither does rebooting or re-enumerating. These are more useful identifiers
450 * than changeable ("unstable") ones like bus numbers or device addresses.
452 * With a partial exception for devices connected to USB 2.0 root hubs, these
453 * identifiers are also predictable. So long as the device tree isn't changed,
454 * plugging any USB device into a given hub port always gives it the same path.
455 * Because of the use of "companion" controllers, devices connected to ports on
456 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
457 * high speed, and a different one if they are full or low speed.
459 static inline int usb_make_path (struct usb_device
*dev
, char *buf
,
463 actual
= snprintf (buf
, size
, "usb-%s-%s", dev
->bus
->bus_name
,
465 return (actual
>= (int)size
) ? -1 : actual
;
468 /*-------------------------------------------------------------------------*/
470 extern int usb_endpoint_dir_in(const struct usb_endpoint_descriptor
*epd
);
471 extern int usb_endpoint_dir_out(const struct usb_endpoint_descriptor
*epd
);
472 extern int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor
*epd
);
473 extern int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor
*epd
);
474 extern int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor
*epd
);
475 extern int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor
*epd
);
476 extern int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor
*epd
);
477 extern int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor
*epd
);
478 extern int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor
*epd
);
479 extern int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor
*epd
);
480 extern int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor
*epd
);
482 /*-------------------------------------------------------------------------*/
484 #define USB_DEVICE_ID_MATCH_DEVICE \
485 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
486 #define USB_DEVICE_ID_MATCH_DEV_RANGE \
487 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
488 #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
489 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
490 #define USB_DEVICE_ID_MATCH_DEV_INFO \
491 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
492 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
493 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
494 #define USB_DEVICE_ID_MATCH_INT_INFO \
495 (USB_DEVICE_ID_MATCH_INT_CLASS | \
496 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
497 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
500 * USB_DEVICE - macro used to describe a specific usb device
501 * @vend: the 16 bit USB Vendor ID
502 * @prod: the 16 bit USB Product ID
504 * This macro is used to create a struct usb_device_id that matches a
507 #define USB_DEVICE(vend,prod) \
508 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
511 * USB_DEVICE_VER - macro used to describe a specific usb device with a
513 * @vend: the 16 bit USB Vendor ID
514 * @prod: the 16 bit USB Product ID
515 * @lo: the bcdDevice_lo value
516 * @hi: the bcdDevice_hi value
518 * This macro is used to create a struct usb_device_id that matches a
519 * specific device, with a version range.
521 #define USB_DEVICE_VER(vend,prod,lo,hi) \
522 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
523 .idVendor = (vend), .idProduct = (prod), \
524 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
527 * USB_DEVICE_INFO - macro used to describe a class of usb devices
528 * @cl: bDeviceClass value
529 * @sc: bDeviceSubClass value
530 * @pr: bDeviceProtocol value
532 * This macro is used to create a struct usb_device_id that matches a
533 * specific class of devices.
535 #define USB_DEVICE_INFO(cl,sc,pr) \
536 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
537 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
540 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
541 * @cl: bInterfaceClass value
542 * @sc: bInterfaceSubClass value
543 * @pr: bInterfaceProtocol value
545 * This macro is used to create a struct usb_device_id that matches a
546 * specific class of interfaces.
548 #define USB_INTERFACE_INFO(cl,sc,pr) \
549 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
550 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
552 /* ----------------------------------------------------------------------- */
556 struct list_head list
;
560 * struct usbdrv_wrap - wrapper for driver-model structure
561 * @driver: The driver-model core driver structure.
562 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
565 struct device_driver driver
;
570 * struct usb_driver - identifies USB interface driver to usbcore
571 * @name: The driver name should be unique among USB drivers,
572 * and should normally be the same as the module name.
573 * @probe: Called to see if the driver is willing to manage a particular
574 * interface on a device. If it is, probe returns zero and uses
575 * dev_set_drvdata() to associate driver-specific data with the
576 * interface. It may also use usb_set_interface() to specify the
577 * appropriate altsetting. If unwilling to manage the interface,
578 * return a negative errno value.
579 * @disconnect: Called when the interface is no longer accessible, usually
580 * because its device has been (or is being) disconnected or the
581 * driver module is being unloaded.
582 * @ioctl: Used for drivers that want to talk to userspace through
583 * the "usbfs" filesystem. This lets devices provide ways to
584 * expose information to user space regardless of where they
585 * do (or don't) show up otherwise in the filesystem.
586 * @suspend: Called when the device is going to be suspended by the system.
587 * @resume: Called when the device is being resumed by the system.
588 * @pre_reset: Called by usb_reset_composite_device() when the device
589 * is about to be reset.
590 * @post_reset: Called by usb_reset_composite_device() after the device
592 * @id_table: USB drivers use ID table to support hotplugging.
593 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
594 * or your driver's probe function will never get called.
595 * @dynids: used internally to hold the list of dynamically added device
596 * ids for this driver.
597 * @drvwrap: Driver-model core structure wrapper.
598 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
599 * added to this driver by preventing the sysfs file from being created.
601 * USB interface drivers must provide a name, probe() and disconnect()
602 * methods, and an id_table. Other driver fields are optional.
604 * The id_table is used in hotplugging. It holds a set of descriptors,
605 * and specialized data may be associated with each entry. That table
606 * is used by both user and kernel mode hotplugging support.
608 * The probe() and disconnect() methods are called in a context where
609 * they can sleep, but they should avoid abusing the privilege. Most
610 * work to connect to a device should be done when the device is opened,
611 * and undone at the last close. The disconnect code needs to address
612 * concurrency issues with respect to open() and close() methods, as
613 * well as forcing all pending I/O requests to complete (by unlinking
614 * them as necessary, and blocking until the unlinks complete).
619 int (*probe
) (struct usb_interface
*intf
,
620 const struct usb_device_id
*id
);
622 void (*disconnect
) (struct usb_interface
*intf
);
624 int (*ioctl
) (struct usb_interface
*intf
, unsigned int code
,
627 int (*suspend
) (struct usb_interface
*intf
, pm_message_t message
);
628 int (*resume
) (struct usb_interface
*intf
);
630 void (*pre_reset
) (struct usb_interface
*intf
);
631 void (*post_reset
) (struct usb_interface
*intf
);
633 const struct usb_device_id
*id_table
;
635 struct usb_dynids dynids
;
636 struct usbdrv_wrap drvwrap
;
637 unsigned int no_dynamic_id
:1;
639 #define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
642 * struct usb_device_driver - identifies USB device driver to usbcore
643 * @name: The driver name should be unique among USB drivers,
644 * and should normally be the same as the module name.
645 * @probe: Called to see if the driver is willing to manage a particular
646 * device. If it is, probe returns zero and uses dev_set_drvdata()
647 * to associate driver-specific data with the device. If unwilling
648 * to manage the device, return a negative errno value.
649 * @disconnect: Called when the device is no longer accessible, usually
650 * because it has been (or is being) disconnected or the driver's
651 * module is being unloaded.
652 * @suspend: Called when the device is going to be suspended by the system.
653 * @resume: Called when the device is being resumed by the system.
654 * @drvwrap: Driver-model core structure wrapper.
656 * USB drivers must provide all the fields listed above except drvwrap.
658 struct usb_device_driver
{
661 int (*probe
) (struct usb_device
*udev
);
662 void (*disconnect
) (struct usb_device
*udev
);
664 int (*suspend
) (struct usb_device
*udev
, pm_message_t message
);
665 int (*resume
) (struct usb_device
*udev
);
666 struct usbdrv_wrap drvwrap
;
668 #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
671 extern struct bus_type usb_bus_type
;
674 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
675 * @name: the usb class device name for this driver. Will show up in sysfs.
676 * @fops: pointer to the struct file_operations of this driver.
677 * @minor_base: the start of the minor range for this driver.
679 * This structure is used for the usb_register_dev() and
680 * usb_unregister_dev() functions, to consolidate a number of the
681 * parameters used for them.
683 struct usb_class_driver
{
685 const struct file_operations
*fops
;
690 * use these in module_init()/module_exit()
691 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
693 extern int usb_register_driver(struct usb_driver
*, struct module
*);
694 static inline int usb_register(struct usb_driver
*driver
)
696 return usb_register_driver(driver
, THIS_MODULE
);
698 extern void usb_deregister(struct usb_driver
*);
700 extern int usb_register_device_driver(struct usb_device_driver
*,
702 extern void usb_deregister_device_driver(struct usb_device_driver
*);
704 extern int usb_register_dev(struct usb_interface
*intf
,
705 struct usb_class_driver
*class_driver
);
706 extern void usb_deregister_dev(struct usb_interface
*intf
,
707 struct usb_class_driver
*class_driver
);
709 extern int usb_disabled(void);
711 /* ----------------------------------------------------------------------- */
714 * URB support, for asynchronous request completions
718 * urb->transfer_flags:
720 #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
721 #define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
723 #define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
724 #define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
725 #define URB_NO_FSBR 0x0020 /* UHCI-specific */
726 #define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
727 #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
730 struct usb_iso_packet_descriptor
{
732 unsigned int length
; /* expected length */
733 unsigned int actual_length
;
740 typedef void (*usb_complete_t
)(struct urb
*, struct pt_regs
*);
743 * struct urb - USB Request Block
744 * @urb_list: For use by current owner of the URB.
745 * @pipe: Holds endpoint number, direction, type, and more.
746 * Create these values with the eight macros available;
747 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
748 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
749 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
750 * numbers range from zero to fifteen. Note that "in" endpoint two
751 * is a different endpoint (and pipe) from "out" endpoint two.
752 * The current configuration controls the existence, type, and
753 * maximum packet size of any given endpoint.
754 * @dev: Identifies the USB device to perform the request.
755 * @status: This is read in non-iso completion functions to get the
756 * status of the particular request. ISO requests only use it
757 * to tell whether the URB was unlinked; detailed status for
758 * each frame is in the fields of the iso_frame-desc.
759 * @transfer_flags: A variety of flags may be used to affect how URB
760 * submission, unlinking, or operation are handled. Different
761 * kinds of URB can use different flags.
762 * @transfer_buffer: This identifies the buffer to (or from) which
763 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
764 * is set). This buffer must be suitable for DMA; allocate it with
765 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
766 * of this buffer will be modified. This buffer is used for the data
767 * stage of control transfers.
768 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
769 * the device driver is saying that it provided this DMA address,
770 * which the host controller driver should use in preference to the
772 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
773 * be broken up into chunks according to the current maximum packet
774 * size for the endpoint, which is a function of the configuration
775 * and is encoded in the pipe. When the length is zero, neither
776 * transfer_buffer nor transfer_dma is used.
777 * @actual_length: This is read in non-iso completion functions, and
778 * it tells how many bytes (out of transfer_buffer_length) were
779 * transferred. It will normally be the same as requested, unless
780 * either an error was reported or a short read was performed.
781 * The URB_SHORT_NOT_OK transfer flag may be used to make such
782 * short reads be reported as errors.
783 * @setup_packet: Only used for control transfers, this points to eight bytes
784 * of setup data. Control transfers always start by sending this data
785 * to the device. Then transfer_buffer is read or written, if needed.
786 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
787 * device driver has provided this DMA address for the setup packet.
788 * The host controller driver should use this in preference to
790 * @start_frame: Returns the initial frame for isochronous transfers.
791 * @number_of_packets: Lists the number of ISO transfer buffers.
792 * @interval: Specifies the polling interval for interrupt or isochronous
793 * transfers. The units are frames (milliseconds) for for full and low
794 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
795 * @error_count: Returns the number of ISO transfers that reported errors.
796 * @context: For use in completion functions. This normally points to
797 * request-specific driver context.
798 * @complete: Completion handler. This URB is passed as the parameter to the
799 * completion function. The completion function may then do what
800 * it likes with the URB, including resubmitting or freeing it.
801 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
802 * collect the transfer status for each buffer.
804 * This structure identifies USB transfer requests. URBs must be allocated by
805 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
806 * Initialization may be done using various usb_fill_*_urb() functions. URBs
807 * are submitted using usb_submit_urb(), and pending requests may be canceled
808 * using usb_unlink_urb() or usb_kill_urb().
810 * Data Transfer Buffers:
812 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
813 * taken from the general page pool. That is provided by transfer_buffer
814 * (control requests also use setup_packet), and host controller drivers
815 * perform a dma mapping (and unmapping) for each buffer transferred. Those
816 * mapping operations can be expensive on some platforms (perhaps using a dma
817 * bounce buffer or talking to an IOMMU),
818 * although they're cheap on commodity x86 and ppc hardware.
820 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
821 * which tell the host controller driver that no such mapping is needed since
822 * the device driver is DMA-aware. For example, a device driver might
823 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
824 * When these transfer flags are provided, host controller drivers will
825 * attempt to use the dma addresses found in the transfer_dma and/or
826 * setup_dma fields rather than determining a dma address themselves. (Note
827 * that transfer_buffer and setup_packet must still be set because not all
828 * host controllers use DMA, nor do virtual root hubs).
832 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
833 * zero), and complete fields. All URBs must also initialize
834 * transfer_buffer and transfer_buffer_length. They may provide the
835 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
836 * to be treated as errors; that flag is invalid for write requests.
839 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
840 * should always terminate with a short packet, even if it means adding an
841 * extra zero length packet.
843 * Control URBs must provide a setup_packet. The setup_packet and
844 * transfer_buffer may each be mapped for DMA or not, independently of
845 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
846 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
847 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
849 * Interrupt URBs must provide an interval, saying how often (in milliseconds
850 * or, for highspeed devices, 125 microsecond units)
851 * to poll for transfers. After the URB has been submitted, the interval
852 * field reflects how the transfer was actually scheduled.
853 * The polling interval may be more frequent than requested.
854 * For example, some controllers have a maximum interval of 32 milliseconds,
855 * while others support intervals of up to 1024 milliseconds.
856 * Isochronous URBs also have transfer intervals. (Note that for isochronous
857 * endpoints, as well as high speed interrupt endpoints, the encoding of
858 * the transfer interval in the endpoint descriptor is logarithmic.
859 * Device drivers must convert that value to linear units themselves.)
861 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
862 * the host controller to schedule the transfer as soon as bandwidth
863 * utilization allows, and then set start_frame to reflect the actual frame
864 * selected during submission. Otherwise drivers must specify the start_frame
865 * and handle the case where the transfer can't begin then. However, drivers
866 * won't know how bandwidth is currently allocated, and while they can
867 * find the current frame using usb_get_current_frame_number () they can't
868 * know the range for that frame number. (Ranges for frame counter values
869 * are HC-specific, and can go from 256 to 65536 frames from "now".)
871 * Isochronous URBs have a different data transfer model, in part because
872 * the quality of service is only "best effort". Callers provide specially
873 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
874 * at the end. Each such packet is an individual ISO transfer. Isochronous
875 * URBs are normally queued, submitted by drivers to arrange that
876 * transfers are at least double buffered, and then explicitly resubmitted
877 * in completion handlers, so
878 * that data (such as audio or video) streams at as constant a rate as the
879 * host controller scheduler can support.
881 * Completion Callbacks:
883 * The completion callback is made in_interrupt(), and one of the first
884 * things that a completion handler should do is check the status field.
885 * The status field is provided for all URBs. It is used to report
886 * unlinked URBs, and status for all non-ISO transfers. It should not
887 * be examined before the URB is returned to the completion handler.
889 * The context field is normally used to link URBs back to the relevant
890 * driver or request state.
892 * When the completion callback is invoked for non-isochronous URBs, the
893 * actual_length field tells how many bytes were transferred. This field
894 * is updated even when the URB terminated with an error or was unlinked.
896 * ISO transfer status is reported in the status and actual_length fields
897 * of the iso_frame_desc array, and the number of errors is reported in
898 * error_count. Completion callbacks for ISO transfers will normally
899 * (re)submit URBs to ensure a constant transfer rate.
901 * Note that even fields marked "public" should not be touched by the driver
902 * when the urb is owned by the hcd, that is, since the call to
903 * usb_submit_urb() till the entry into the completion routine.
907 /* private: usb core and host controller only fields in the urb */
908 struct kref kref
; /* reference count of the URB */
909 spinlock_t lock
; /* lock for the URB */
910 void *hcpriv
; /* private data for host controller */
911 int bandwidth
; /* bandwidth for INT/ISO request */
912 atomic_t use_count
; /* concurrent submissions counter */
913 u8 reject
; /* submissions will fail */
915 /* public: documented fields in the urb that can be used by drivers */
916 struct list_head urb_list
; /* list head for use by the urb's
918 struct usb_device
*dev
; /* (in) pointer to associated device */
919 unsigned int pipe
; /* (in) pipe information */
920 int status
; /* (return) non-ISO status */
921 unsigned int transfer_flags
; /* (in) URB_SHORT_NOT_OK | ...*/
922 void *transfer_buffer
; /* (in) associated data buffer */
923 dma_addr_t transfer_dma
; /* (in) dma addr for transfer_buffer */
924 int transfer_buffer_length
; /* (in) data buffer length */
925 int actual_length
; /* (return) actual transfer length */
926 unsigned char *setup_packet
; /* (in) setup packet (control only) */
927 dma_addr_t setup_dma
; /* (in) dma addr for setup_packet */
928 int start_frame
; /* (modify) start frame (ISO) */
929 int number_of_packets
; /* (in) number of ISO packets */
930 int interval
; /* (modify) transfer interval
932 int error_count
; /* (return) number of ISO errors */
933 void *context
; /* (in) context for completion */
934 usb_complete_t complete
; /* (in) completion routine */
935 struct usb_iso_packet_descriptor iso_frame_desc
[0];
939 /* ----------------------------------------------------------------------- */
942 * usb_fill_control_urb - initializes a control urb
943 * @urb: pointer to the urb to initialize.
944 * @dev: pointer to the struct usb_device for this urb.
945 * @pipe: the endpoint pipe
946 * @setup_packet: pointer to the setup_packet buffer
947 * @transfer_buffer: pointer to the transfer buffer
948 * @buffer_length: length of the transfer buffer
949 * @complete_fn: pointer to the usb_complete_t function
950 * @context: what to set the urb context to.
952 * Initializes a control urb with the proper information needed to submit
955 static inline void usb_fill_control_urb (struct urb
*urb
,
956 struct usb_device
*dev
,
958 unsigned char *setup_packet
,
959 void *transfer_buffer
,
961 usb_complete_t complete_fn
,
964 spin_lock_init(&urb
->lock
);
967 urb
->setup_packet
= setup_packet
;
968 urb
->transfer_buffer
= transfer_buffer
;
969 urb
->transfer_buffer_length
= buffer_length
;
970 urb
->complete
= complete_fn
;
971 urb
->context
= context
;
975 * usb_fill_bulk_urb - macro to help initialize a bulk urb
976 * @urb: pointer to the urb to initialize.
977 * @dev: pointer to the struct usb_device for this urb.
978 * @pipe: the endpoint pipe
979 * @transfer_buffer: pointer to the transfer buffer
980 * @buffer_length: length of the transfer buffer
981 * @complete_fn: pointer to the usb_complete_t function
982 * @context: what to set the urb context to.
984 * Initializes a bulk urb with the proper information needed to submit it
987 static inline void usb_fill_bulk_urb (struct urb
*urb
,
988 struct usb_device
*dev
,
990 void *transfer_buffer
,
992 usb_complete_t complete_fn
,
995 spin_lock_init(&urb
->lock
);
998 urb
->transfer_buffer
= transfer_buffer
;
999 urb
->transfer_buffer_length
= buffer_length
;
1000 urb
->complete
= complete_fn
;
1001 urb
->context
= context
;
1005 * usb_fill_int_urb - macro to help initialize a interrupt urb
1006 * @urb: pointer to the urb to initialize.
1007 * @dev: pointer to the struct usb_device for this urb.
1008 * @pipe: the endpoint pipe
1009 * @transfer_buffer: pointer to the transfer buffer
1010 * @buffer_length: length of the transfer buffer
1011 * @complete_fn: pointer to the usb_complete_t function
1012 * @context: what to set the urb context to.
1013 * @interval: what to set the urb interval to, encoded like
1014 * the endpoint descriptor's bInterval value.
1016 * Initializes a interrupt urb with the proper information needed to submit
1018 * Note that high speed interrupt endpoints use a logarithmic encoding of
1019 * the endpoint interval, and express polling intervals in microframes
1020 * (eight per millisecond) rather than in frames (one per millisecond).
1022 static inline void usb_fill_int_urb (struct urb
*urb
,
1023 struct usb_device
*dev
,
1025 void *transfer_buffer
,
1027 usb_complete_t complete_fn
,
1031 spin_lock_init(&urb
->lock
);
1034 urb
->transfer_buffer
= transfer_buffer
;
1035 urb
->transfer_buffer_length
= buffer_length
;
1036 urb
->complete
= complete_fn
;
1037 urb
->context
= context
;
1038 if (dev
->speed
== USB_SPEED_HIGH
)
1039 urb
->interval
= 1 << (interval
- 1);
1041 urb
->interval
= interval
;
1042 urb
->start_frame
= -1;
1045 extern void usb_init_urb(struct urb
*urb
);
1046 extern struct urb
*usb_alloc_urb(int iso_packets
, gfp_t mem_flags
);
1047 extern void usb_free_urb(struct urb
*urb
);
1048 #define usb_put_urb usb_free_urb
1049 extern struct urb
*usb_get_urb(struct urb
*urb
);
1050 extern int usb_submit_urb(struct urb
*urb
, gfp_t mem_flags
);
1051 extern int usb_unlink_urb(struct urb
*urb
);
1052 extern void usb_kill_urb(struct urb
*urb
);
1054 #define HAVE_USB_BUFFERS
1055 void *usb_buffer_alloc (struct usb_device
*dev
, size_t size
,
1056 gfp_t mem_flags
, dma_addr_t
*dma
);
1057 void usb_buffer_free (struct usb_device
*dev
, size_t size
,
1058 void *addr
, dma_addr_t dma
);
1061 struct urb
*usb_buffer_map (struct urb
*urb
);
1062 void usb_buffer_dmasync (struct urb
*urb
);
1063 void usb_buffer_unmap (struct urb
*urb
);
1067 int usb_buffer_map_sg(const struct usb_device
*dev
, unsigned pipe
,
1068 struct scatterlist
*sg
, int nents
);
1070 void usb_buffer_dmasync_sg(const struct usb_device
*dev
, unsigned pipe
,
1071 struct scatterlist
*sg
, int n_hw_ents
);
1073 void usb_buffer_unmap_sg(const struct usb_device
*dev
, unsigned pipe
,
1074 struct scatterlist
*sg
, int n_hw_ents
);
1076 /*-------------------------------------------------------------------*
1077 * SYNCHRONOUS CALL SUPPORT *
1078 *-------------------------------------------------------------------*/
1080 extern int usb_control_msg(struct usb_device
*dev
, unsigned int pipe
,
1081 __u8 request
, __u8 requesttype
, __u16 value
, __u16 index
,
1082 void *data
, __u16 size
, int timeout
);
1083 extern int usb_interrupt_msg(struct usb_device
*usb_dev
, unsigned int pipe
,
1084 void *data
, int len
, int *actual_length
, int timeout
);
1085 extern int usb_bulk_msg(struct usb_device
*usb_dev
, unsigned int pipe
,
1086 void *data
, int len
, int *actual_length
,
1089 /* wrappers around usb_control_msg() for the most common standard requests */
1090 extern int usb_get_descriptor(struct usb_device
*dev
, unsigned char desctype
,
1091 unsigned char descindex
, void *buf
, int size
);
1092 extern int usb_get_status(struct usb_device
*dev
,
1093 int type
, int target
, void *data
);
1094 extern int usb_string(struct usb_device
*dev
, int index
,
1095 char *buf
, size_t size
);
1097 /* wrappers that also update important state inside usbcore */
1098 extern int usb_clear_halt(struct usb_device
*dev
, int pipe
);
1099 extern int usb_reset_configuration(struct usb_device
*dev
);
1100 extern int usb_set_interface(struct usb_device
*dev
, int ifnum
, int alternate
);
1102 /* this request isn't really synchronous, but it belongs with the others */
1103 extern int usb_driver_set_configuration(struct usb_device
*udev
, int config
);
1106 * timeouts, in milliseconds, used for sending/receiving control messages
1107 * they typically complete within a few frames (msec) after they're issued
1108 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1109 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1111 #define USB_CTRL_GET_TIMEOUT 5000
1112 #define USB_CTRL_SET_TIMEOUT 5000
1116 * struct usb_sg_request - support for scatter/gather I/O
1117 * @status: zero indicates success, else negative errno
1118 * @bytes: counts bytes transferred.
1120 * These requests are initialized using usb_sg_init(), and then are used
1121 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1122 * members of the request object aren't for driver access.
1124 * The status and bytecount values are valid only after usb_sg_wait()
1125 * returns. If the status is zero, then the bytecount matches the total
1128 * After an error completion, drivers may need to clear a halt condition
1131 struct usb_sg_request
{
1136 * members below are private: to usbcore,
1137 * and are not provided for driver access!
1141 struct usb_device
*dev
;
1143 struct scatterlist
*sg
;
1150 struct completion complete
;
1154 struct usb_sg_request
*io
,
1155 struct usb_device
*dev
,
1158 struct scatterlist
*sg
,
1163 void usb_sg_cancel (struct usb_sg_request
*io
);
1164 void usb_sg_wait (struct usb_sg_request
*io
);
1167 /* ----------------------------------------------------------------------- */
1170 * For various legacy reasons, Linux has a small cookie that's paired with
1171 * a struct usb_device to identify an endpoint queue. Queue characteristics
1172 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1173 * an unsigned int encoded as:
1175 * - direction: bit 7 (0 = Host-to-Device [Out],
1176 * 1 = Device-to-Host [In] ...
1177 * like endpoint bEndpointAddress)
1178 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1179 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1180 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1181 * 10 = control, 11 = bulk)
1183 * Given the device address and endpoint descriptor, pipes are redundant.
1186 /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1187 /* (yet ... they're the values used by usbfs) */
1188 #define PIPE_ISOCHRONOUS 0
1189 #define PIPE_INTERRUPT 1
1190 #define PIPE_CONTROL 2
1193 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1194 #define usb_pipeout(pipe) (!usb_pipein(pipe))
1196 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1197 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1199 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1200 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1201 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1202 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1203 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1205 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1206 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1207 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
1208 #define usb_settoggle(dev, ep, out, bit) \
1209 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1213 static inline unsigned int __create_pipe(struct usb_device
*dev
,
1214 unsigned int endpoint
)
1216 return (dev
->devnum
<< 8) | (endpoint
<< 15);
1219 /* Create various pipes... */
1220 #define usb_sndctrlpipe(dev,endpoint) \
1221 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1222 #define usb_rcvctrlpipe(dev,endpoint) \
1223 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1224 #define usb_sndisocpipe(dev,endpoint) \
1225 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1226 #define usb_rcvisocpipe(dev,endpoint) \
1227 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1228 #define usb_sndbulkpipe(dev,endpoint) \
1229 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1230 #define usb_rcvbulkpipe(dev,endpoint) \
1231 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1232 #define usb_sndintpipe(dev,endpoint) \
1233 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1234 #define usb_rcvintpipe(dev,endpoint) \
1235 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1237 /*-------------------------------------------------------------------------*/
1240 usb_maxpacket(struct usb_device
*udev
, int pipe
, int is_out
)
1242 struct usb_host_endpoint
*ep
;
1243 unsigned epnum
= usb_pipeendpoint(pipe
);
1246 WARN_ON(usb_pipein(pipe
));
1247 ep
= udev
->ep_out
[epnum
];
1249 WARN_ON(usb_pipeout(pipe
));
1250 ep
= udev
->ep_in
[epnum
];
1255 /* NOTE: only 0x07ff bits are for packet size... */
1256 return le16_to_cpu(ep
->desc
.wMaxPacketSize
);
1259 /* ----------------------------------------------------------------------- */
1261 /* Events from the usb core */
1262 #define USB_DEVICE_ADD 0x0001
1263 #define USB_DEVICE_REMOVE 0x0002
1264 #define USB_BUS_ADD 0x0003
1265 #define USB_BUS_REMOVE 0x0004
1266 extern void usb_register_notify(struct notifier_block
*nb
);
1267 extern void usb_unregister_notify(struct notifier_block
*nb
);
1270 #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1273 #define dbg(format, arg...) do {} while (0)
1276 #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1278 #define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1280 #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1284 #endif /* __KERNEL__ */