Blame view
include/linux/usb.h
61.6 KB
1da177e4c
|
1 2 3 4 |
#ifndef __LINUX_USB_H #define __LINUX_USB_H #include <linux/mod_devicetable.h> |
5f8481377
|
5 |
#include <linux/usb/ch9.h> |
1da177e4c
|
6 7 |
#define USB_MAJOR 180 |
fbf82fd2e
|
8 |
#define USB_DEVICE_MAJOR 189 |
1da177e4c
|
9 10 11 |
#ifdef __KERNEL__ |
1da177e4c
|
12 13 14 15 16 17 18 19 20 |
#include <linux/errno.h> /* for -ENODEV */ #include <linux/delay.h> /* for mdelay() */ #include <linux/interrupt.h> /* for in_interrupt() */ #include <linux/list.h> /* for struct list_head */ #include <linux/kref.h> /* for struct kref */ #include <linux/device.h> /* for struct device */ #include <linux/fs.h> /* for struct file_operations */ #include <linux/completion.h> /* for struct completion */ #include <linux/sched.h> /* for current && schedule_timeout */ |
645daaab0
|
21 |
#include <linux/mutex.h> /* for struct mutex */ |
6ddf27cdb
|
22 |
#include <linux/pm_runtime.h> /* for runtime PM */ |
1da177e4c
|
23 24 25 |
struct usb_device; struct usb_driver; |
b1d8dfb0e
|
26 |
struct wusb_dev; |
1da177e4c
|
27 28 29 30 31 32 33 34 35 36 37 38 |
/*-------------------------------------------------------------------------*/ /* * Host-side wrappers for standard USB descriptors ... these are parsed * from the data provided by devices. Parsing turns them from a flat * sequence of descriptors into a hierarchy: * * - devices have one (usually) or more configs; * - configs have one (often) or more interfaces; * - interfaces have one (usually) or more settings; * - each interface setting has zero or (usually) more endpoints. |
663c30d08
|
39 |
* - a SuperSpeed endpoint has a companion descriptor |
1da177e4c
|
40 41 42 43 44 |
* * And there might be other descriptors mixed in with those. * * Devices may also have class-specific or vendor-specific descriptors. */ |
9bde7497e
|
45 |
struct ep_device; |
1da177e4c
|
46 47 48 |
/** * struct usb_host_endpoint - host-side endpoint descriptor and queue * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder |
842f16905
|
49 |
* @ss_ep_comp: SuperSpeed companion descriptor for this endpoint |
1da177e4c
|
50 51 52 |
* @urb_list: urbs queued to this endpoint; maintained by usbcore * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH) * with one or more transfer descriptors (TDs) per urb |
7fac9a334
|
53 |
* @ep_dev: ep_device for sysfs info |
1da177e4c
|
54 55 |
* @extra: descriptors following this endpoint in the configuration * @extralen: how many bytes of "extra" are valid |
bdd016ba6
|
56 |
* @enabled: URBs may be submitted to this endpoint |
1da177e4c
|
57 58 59 60 61 |
* * USB requests are always queued to a given endpoint, identified by a * descriptor within an active interface in a given USB configuration. */ struct usb_host_endpoint { |
842f16905
|
62 63 |
struct usb_endpoint_descriptor desc; struct usb_ss_ep_comp_descriptor ss_ep_comp; |
1da177e4c
|
64 65 |
struct list_head urb_list; void *hcpriv; |
812219ab8
|
66 |
struct ep_device *ep_dev; /* For sysfs info */ |
1da177e4c
|
67 68 69 |
unsigned char *extra; /* Extra descriptors */ int extralen; |
bdd016ba6
|
70 |
int enabled; |
1da177e4c
|
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
}; /* host-side wrapper for one interface setting's parsed descriptors */ struct usb_host_interface { struct usb_interface_descriptor desc; /* array of desc.bNumEndpoint endpoints associated with this * interface setting. these will be in no particular order. */ struct usb_host_endpoint *endpoint; char *string; /* iInterface string, if present */ unsigned char *extra; /* Extra descriptors */ int extralen; }; enum usb_interface_condition { USB_INTERFACE_UNBOUND = 0, USB_INTERFACE_BINDING, USB_INTERFACE_BOUND, USB_INTERFACE_UNBINDING, }; /** * struct usb_interface - what usb device drivers talk to * @altsetting: array of interface structures, one for each alternate |
812219ab8
|
97 98 |
* setting that may be selected. Each one includes a set of * endpoint configurations. They will be in no particular order. |
1da177e4c
|
99 |
* @cur_altsetting: the current altsetting. |
d6d914f52
|
100 |
* @num_altsetting: number of altsettings defined. |
3f423787e
|
101 |
* @intf_assoc: interface association descriptor |
1da177e4c
|
102 103 104 105 106 107 108 109 |
* @minor: the minor number assigned to this interface, if this * interface is bound to a driver that uses the USB major number. * If this interface does not use the USB major, this field should * be unused. The driver should set this value in the probe() * function of the driver, after it has been assigned a minor * number from the USB core by calling usb_register_dev(). * @condition: binding state of the interface: not bound, binding * (in probe()), bound to a driver, or unbinding (in disconnect()) |
f88ed90d8
|
110 |
* @sysfs_files_created: sysfs attributes exist |
3b23dd6f8
|
111 |
* @ep_devs_created: endpoint child pseudo-devices exist |
352d02633
|
112 |
* @unregistering: flag set when the interface is being unregistered |
645daaab0
|
113 114 |
* @needs_remote_wakeup: flag set when the driver requires remote-wakeup * capability during autosuspend. |
55151d7da
|
115 116 |
* @needs_altsetting0: flag set when a set-interface request for altsetting 0 * has been deferred. |
f4f4d5873
|
117 118 |
* @needs_binding: flag set when the driver should be re-probed or unbound * following a reset or suspend operation it doesn't support. |
1da177e4c
|
119 |
* @dev: driver model's view of this device |
0873c7648
|
120 121 |
* @usb_dev: if an interface is bound to the USB major, this will point * to the sysfs representation for that device. |
9bbdf1e0a
|
122 |
* @pm_usage_cnt: PM usage counter for this interface |
dc023dcee
|
123 124 125 126 127 |
* @reset_ws: Used for scheduling resets from atomic context. * @reset_running: set to 1 if the interface is currently running a * queued reset so that usb_cancel_queued_reset() doesn't try to * remove from the workqueue when running inside the worker * thread. See __usb_queue_reset_device(). |
c6ba1c2af
|
128 129 |
* @resetting_device: USB core reset the device, so use alt setting 0 as * current; needs bandwidth alloc after reset. |
1da177e4c
|
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
* * USB device drivers attach to interfaces on a physical device. Each * interface encapsulates a single high level function, such as feeding * an audio stream to a speaker or reporting a change in a volume control. * Many USB devices only have one interface. The protocol used to talk to * an interface's endpoints can be defined in a usb "class" specification, * or by a product's vendor. The (default) control endpoint is part of * every interface, but is never listed among the interface's descriptors. * * The driver that is bound to the interface can use standard driver model * calls such as dev_get_drvdata() on the dev member of this structure. * * Each interface may have alternate settings. The initial configuration * of a device sets altsetting 0, but the device driver can change * that setting using usb_set_interface(). Alternate settings are often |
59c51591a
|
145 |
* used to control the use of periodic endpoints, such as by having |
1da177e4c
|
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
* different endpoints use different amounts of reserved USB bandwidth. * All standards-conformant USB devices that use isochronous endpoints * will use them in non-default settings. * * The USB specification says that alternate setting numbers must run from * 0 to one less than the total number of alternate settings. But some * devices manage to mess this up, and the structures aren't necessarily * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to * look up an alternate setting in the altsetting array based on its number. */ struct usb_interface { /* array of alternate settings for this interface, * stored in no particular order */ struct usb_host_interface *altsetting; struct usb_host_interface *cur_altsetting; /* the currently * active alternate setting */ unsigned num_altsetting; /* number of alternate settings */ |
165fe97ed
|
164 165 166 |
/* If there is an interface association descriptor then it will list * the associated interfaces */ struct usb_interface_assoc_descriptor *intf_assoc; |
b724ae779
|
167 168 |
int minor; /* minor number this interface is * bound to */ |
1da177e4c
|
169 |
enum usb_interface_condition condition; /* state of binding */ |
7e61559f6
|
170 |
unsigned sysfs_files_created:1; /* the sysfs attributes exist */ |
3b23dd6f8
|
171 |
unsigned ep_devs_created:1; /* endpoint "devices" exist */ |
352d02633
|
172 |
unsigned unregistering:1; /* unregistration is in progress */ |
645daaab0
|
173 |
unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */ |
55151d7da
|
174 |
unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */ |
78d9a487e
|
175 |
unsigned needs_binding:1; /* needs delayed unbind/rebind */ |
dc023dcee
|
176 |
unsigned reset_running:1; |
04a723ea9
|
177 |
unsigned resetting_device:1; /* true: bandwidth alloc after reset */ |
4d064c080
|
178 |
|
1da177e4c
|
179 |
struct device dev; /* interface specific device info */ |
969ab2ee9
|
180 |
struct device *usb_dev; |
ccf5b801c
|
181 |
atomic_t pm_usage_cnt; /* usage counter for autosuspend */ |
dc023dcee
|
182 |
struct work_struct reset_ws; /* for resets in atomic context */ |
1da177e4c
|
183 184 |
}; #define to_usb_interface(d) container_of(d, struct usb_interface, dev) |
1da177e4c
|
185 |
|
969ab2ee9
|
186 |
static inline void *usb_get_intfdata(struct usb_interface *intf) |
1da177e4c
|
187 |
{ |
969ab2ee9
|
188 |
return dev_get_drvdata(&intf->dev); |
1da177e4c
|
189 |
} |
969ab2ee9
|
190 |
static inline void usb_set_intfdata(struct usb_interface *intf, void *data) |
1da177e4c
|
191 192 193 194 195 196 197 198 199 |
{ dev_set_drvdata(&intf->dev, data); } struct usb_interface *usb_get_intf(struct usb_interface *intf); void usb_put_intf(struct usb_interface *intf); /* this maximum is arbitrary */ #define USB_MAXINTERFACES 32 |
812219ab8
|
200 |
#define USB_MAXIADS (USB_MAXINTERFACES/2) |
1da177e4c
|
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
/** * struct usb_interface_cache - long-term representation of a device interface * @num_altsetting: number of altsettings defined. * @ref: reference counter. * @altsetting: variable-length array of interface structures, one for * each alternate setting that may be selected. Each one includes a * set of endpoint configurations. They will be in no particular order. * * These structures persist for the lifetime of a usb_device, unlike * struct usb_interface (which persists only as long as its configuration * is installed). The altsetting arrays can be accessed through these * structures at any time, permitting comparison of configurations and * providing support for the /proc/bus/usb/devices pseudo-file. */ struct usb_interface_cache { unsigned num_altsetting; /* number of alternate settings */ struct kref ref; /* reference counter */ /* variable-length array of alternate settings for this interface, * stored in no particular order */ struct usb_host_interface altsetting[0]; }; #define ref_to_usb_interface_cache(r) \ container_of(r, struct usb_interface_cache, ref) #define altsetting_to_usb_interface_cache(a) \ container_of(a, struct usb_interface_cache, altsetting[0]) /** * struct usb_host_config - representation of a device's configuration * @desc: the device's configuration descriptor. * @string: pointer to the cached version of the iConfiguration string, if * present for this configuration. |
3f423787e
|
234 |
* @intf_assoc: list of any interface association descriptors in this config |
1da177e4c
|
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
* @interface: array of pointers to usb_interface structures, one for each * interface in the configuration. The number of interfaces is stored * in desc.bNumInterfaces. These pointers are valid only while the * the configuration is active. * @intf_cache: array of pointers to usb_interface_cache structures, one * for each interface in the configuration. These structures exist * for the entire life of the device. * @extra: pointer to buffer containing all extra descriptors associated * with this configuration (those preceding the first interface * descriptor). * @extralen: length of the extra descriptors buffer. * * USB devices may have multiple configurations, but only one can be active * at any time. Each encapsulates a different operational environment; * for example, a dual-speed device would have separate configurations for * full-speed and high-speed operation. The number of configurations * available is stored in the device descriptor as bNumConfigurations. * * A configuration can contain multiple interfaces. Each corresponds to * a different function of the USB device, and all are available whenever * the configuration is active. The USB standard says that interfaces * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot * of devices get this wrong. In addition, the interface array is not * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to * look up an interface entry based on its number. * * Device drivers should not attempt to activate configurations. The choice * of which configuration to install is a policy decision based on such * considerations as available power, functionality provided, and the user's |
312c004d3
|
264 |
* desires (expressed through userspace tools). However, drivers can call |
1da177e4c
|
265 266 267 268 269 |
* usb_reset_configuration() to reinitialize the current configuration and * all its interfaces. */ struct usb_host_config { struct usb_config_descriptor desc; |
4f62efe67
|
270 |
char *string; /* iConfiguration string, if present */ |
165fe97ed
|
271 272 273 274 |
/* List of any Interface Association Descriptors in this * configuration. */ struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS]; |
1da177e4c
|
275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
/* the interfaces associated with this configuration, * stored in no particular order */ struct usb_interface *interface[USB_MAXINTERFACES]; /* Interface information available even when this is not the * active configuration */ struct usb_interface_cache *intf_cache[USB_MAXINTERFACES]; unsigned char *extra; /* Extra descriptors */ int extralen; }; int __usb_get_extra_descriptor(char *buffer, unsigned size, unsigned char type, void **ptr); |
969ab2ee9
|
289 290 291 292 |
#define usb_get_extra_descriptor(ifpoint, type, ptr) \ __usb_get_extra_descriptor((ifpoint)->extra, \ (ifpoint)->extralen, \ type, (void **)ptr) |
1da177e4c
|
293 |
|
b724ae779
|
294 |
/* ----------------------------------------------------------------------- */ |
1da177e4c
|
295 |
|
1da177e4c
|
296 297 298 299 300 301 302 303 304 305 306 |
/* USB device number allocation bitmap */ struct usb_devmap { unsigned long devicemap[128 / (8*sizeof(unsigned long))]; }; /* * Allocated per bus (tree of devices) we have: */ struct usb_bus { struct device *controller; /* host/master side hardware */ int busnum; /* Bus number (in order of reg) */ |
1b26da151
|
307 |
const char *bus_name; /* stable id (PCI slot_name etc) */ |
dd990f16a
|
308 |
u8 uses_dma; /* Does the host controller use DMA? */ |
07a8cdd2b
|
309 310 311 312 |
u8 uses_pio_for_control; /* * Does the host controller use PIO * for control transfers? */ |
1da177e4c
|
313 314 315 |
u8 otg_port; /* 0, or number of OTG/HNP port */ unsigned is_b_host:1; /* true during some HNP roleswitches */ unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */ |
4c1bd3d7a
|
316 |
unsigned sg_tablesize; /* 0 or largest number of sg list entries */ |
1da177e4c
|
317 |
|
b724ae779
|
318 319 |
int devnum_next; /* Next open device number in * round-robin allocation */ |
1da177e4c
|
320 321 |
struct usb_devmap devmap; /* device address allocation map */ |
1da177e4c
|
322 |
struct usb_device *root_hub; /* Root hub */ |
6d19c009c
|
323 |
struct usb_bus *hs_companion; /* Companion EHCI bus, if any */ |
1da177e4c
|
324 |
struct list_head bus_list; /* list of busses */ |
1da177e4c
|
325 326 327 328 329 330 331 332 333 334 |
int bandwidth_allocated; /* on this bus: how much of the time * reserved for periodic (intr/iso) * requests is used, on average? * Units: microseconds/frame. * Limits: Full/low speed reserve 90%, * while high speed reserves 80%. */ int bandwidth_int_reqs; /* number of Interrupt requests */ int bandwidth_isoc_reqs; /* number of Isoc. requests */ |
9f8b17e64
|
335 |
#ifdef CONFIG_USB_DEVICEFS |
1da177e4c
|
336 |
struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */ |
9f8b17e64
|
337 |
#endif |
b724ae779
|
338 |
|
f150fa1af
|
339 |
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE) |
1da177e4c
|
340 341 342 343 |
struct mon_bus *mon_bus; /* non-null when associated */ int monitored; /* non-zero when monitored */ #endif }; |
1da177e4c
|
344 |
|
b724ae779
|
345 |
/* ----------------------------------------------------------------------- */ |
1da177e4c
|
346 347 348 349 |
/* This is arbitrary. * From USB 2.0 spec Table 11-13, offset 7, a hub can * have up to 255 ports. The most yet reported is 10. |
437052516
|
350 351 352 353 354 |
* * Current Wireless USB host hardware (Intel i1480 for example) allows * up to 22 devices to connect. Upcoming hardware might raise that * limit. Because the arrays need to add a bit for hub status data, we * do 31, so plus one evens out to four bytes. |
1da177e4c
|
355 |
*/ |
437052516
|
356 |
#define USB_MAXCHILDREN (31) |
1da177e4c
|
357 358 |
struct usb_tt; |
f476fbaba
|
359 |
/** |
1da177e4c
|
360 |
* struct usb_device - kernel's representation of a USB device |
f476fbaba
|
361 362 |
* @devnum: device number; address on a USB bus * @devpath: device ID string for use in messages (e.g., /port/...) |
7206b0016
|
363 |
* @route: tree topology hex string for use with xHCI |
f476fbaba
|
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
* @state: device state: configured, not attached, etc. * @speed: device speed: high/full/low (or error) * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub * @ttport: device port on that tt hub * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints * @parent: our hub, unless we're the root * @bus: bus we're part of * @ep0: endpoint 0 data (default control pipe) * @dev: generic device interface * @descriptor: USB device descriptor * @config: all of the device's configs * @actconfig: the active configuration * @ep_in: array of IN endpoints * @ep_out: array of OUT endpoints * @rawdescriptors: raw descriptors for each config * @bus_mA: Current available from the bus * @portnum: parent port number (origin 1) * @level: number of USB hub ancestors * @can_submit: URBs may be submitted |
f476fbaba
|
383 384 385 386 387 388 389 |
* @persist_enabled: USB_PERSIST enabled for this device * @have_langid: whether string_langid is valid * @authorized: policy has said we can use it; * (user space) policy determines if we authorize this device to be * used or not. By default, wired USB devices are authorized. * WUSB devices are not, until we authorize them from user space. * FIXME -- complete doc |
3b52f128a
|
390 |
* @authenticated: Crypto authentication passed |
f476fbaba
|
391 392 393 394 395 396 397 398 399 400 401 |
* @wusb: device is Wireless USB * @string_langid: language ID for strings * @product: iProduct string, if present (static) * @manufacturer: iManufacturer string, if present (static) * @serial: iSerialNumber string, if present (static) * @filelist: usbfs files that are open to this device * @usb_classdev: USB class device that was created for usbfs device * access from userspace * @usbfs_dentry: usbfs dentry entry for the device * @maxchild: number of ports if hub * @children: child devices - USB devices that are attached to this hub |
f476fbaba
|
402 403 404 |
* @quirks: quirks of the whole device * @urbnum: number of URBs submitted for the whole device * @active_duration: total time device is not suspended |
f476fbaba
|
405 |
* @connect_time: time device was first connected |
f476fbaba
|
406 407 |
* @do_remote_wakeup: remote wakeup should be enabled * @reset_resume: needs reset instead of resume |
11e76ae0f
|
408 409 |
* @wusb_dev: if this is a Wireless USB device, link to the WUSB * specific data for the device. |
c6515272b
|
410 |
* @slot_id: Slot ID assigned by xHCI |
1da177e4c
|
411 |
* |
f476fbaba
|
412 |
* Notes: |
1da177e4c
|
413 414 415 416 |
* Usbcore drivers should not set usbdev->state directly. Instead use * usb_set_device_state(). */ struct usb_device { |
f476fbaba
|
417 |
int devnum; |
812219ab8
|
418 |
char devpath[16]; |
7206b0016
|
419 |
u32 route; |
f476fbaba
|
420 421 |
enum usb_device_state state; enum usb_device_speed speed; |
1da177e4c
|
422 |
|
f476fbaba
|
423 424 |
struct usb_tt *tt; int ttport; |
1da177e4c
|
425 |
|
f476fbaba
|
426 |
unsigned int toggle[2]; |
1da177e4c
|
427 |
|
f476fbaba
|
428 429 |
struct usb_device *parent; struct usb_bus *bus; |
1da177e4c
|
430 |
struct usb_host_endpoint ep0; |
f476fbaba
|
431 |
struct device dev; |
1da177e4c
|
432 |
|
f476fbaba
|
433 434 |
struct usb_device_descriptor descriptor; struct usb_host_config *config; |
1da177e4c
|
435 |
|
f476fbaba
|
436 |
struct usb_host_config *actconfig; |
1da177e4c
|
437 438 |
struct usb_host_endpoint *ep_in[16]; struct usb_host_endpoint *ep_out[16]; |
f476fbaba
|
439 |
char **rawdescriptors; |
1da177e4c
|
440 |
|
f476fbaba
|
441 442 443 |
unsigned short bus_mA; u8 portnum; u8 level; |
55c527187
|
444 |
|
f476fbaba
|
445 |
unsigned can_submit:1; |
f476fbaba
|
446 447 448 |
unsigned persist_enabled:1; unsigned have_langid:1; unsigned authorized:1; |
812219ab8
|
449 |
unsigned authenticated:1; |
f476fbaba
|
450 451 |
unsigned wusb:1; int string_langid; |
1da177e4c
|
452 |
|
4f62efe67
|
453 |
/* static strings from the device */ |
f476fbaba
|
454 455 456 |
char *product; char *manufacturer; char *serial; |
4f62efe67
|
457 |
|
1da177e4c
|
458 |
struct list_head filelist; |
9f8b17e64
|
459 460 461 462 |
#ifdef CONFIG_USB_DEVICE_CLASS struct device *usb_classdev; #endif #ifdef CONFIG_USB_DEVICEFS |
f476fbaba
|
463 |
struct dentry *usbfs_dentry; |
9f8b17e64
|
464 |
#endif |
1da177e4c
|
465 |
|
f476fbaba
|
466 |
int maxchild; |
1da177e4c
|
467 |
struct usb_device *children[USB_MAXCHILDREN]; |
645daaab0
|
468 |
|
f476fbaba
|
469 470 |
u32 quirks; atomic_t urbnum; |
b5e795f8d
|
471 |
|
f476fbaba
|
472 |
unsigned long active_duration; |
151230068
|
473 |
|
645daaab0
|
474 |
#ifdef CONFIG_PM |
f476fbaba
|
475 |
unsigned long connect_time; |
f476fbaba
|
476 477 |
unsigned do_remote_wakeup:1; unsigned reset_resume:1; |
645daaab0
|
478 |
#endif |
b1d8dfb0e
|
479 |
struct wusb_dev *wusb_dev; |
c6515272b
|
480 |
int slot_id; |
1da177e4c
|
481 482 |
}; #define to_usb_device(d) container_of(d, struct usb_device, dev) |
1e429018b
|
483 484 485 486 |
static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf) { return to_usb_device(intf->dev.parent); } |
1da177e4c
|
487 488 |
extern struct usb_device *usb_get_dev(struct usb_device *dev); extern void usb_put_dev(struct usb_device *dev); |
9ad3d6ccf
|
489 |
/* USB device locking */ |
8e9394ce2
|
490 491 492 |
#define usb_lock_device(udev) device_lock(&(udev)->dev) #define usb_unlock_device(udev) device_unlock(&(udev)->dev) #define usb_trylock_device(udev) device_trylock(&(udev)->dev) |
1da177e4c
|
493 |
extern int usb_lock_device_for_reset(struct usb_device *udev, |
095bc3353
|
494 |
const struct usb_interface *iface); |
1da177e4c
|
495 496 497 |
/* USB port reset for device reinitialization */ extern int usb_reset_device(struct usb_device *dev); |
dc023dcee
|
498 |
extern void usb_queue_reset_device(struct usb_interface *dev); |
1da177e4c
|
499 |
|
1da177e4c
|
500 |
|
645daaab0
|
501 502 |
/* USB autosuspend and autoresume */ #ifdef CONFIG_USB_SUSPEND |
9e18c8216
|
503 504 |
extern void usb_enable_autosuspend(struct usb_device *udev); extern void usb_disable_autosuspend(struct usb_device *udev); |
088f7fec8
|
505 |
|
645daaab0
|
506 507 |
extern int usb_autopm_get_interface(struct usb_interface *intf); extern void usb_autopm_put_interface(struct usb_interface *intf); |
9ac39f28b
|
508 509 |
extern int usb_autopm_get_interface_async(struct usb_interface *intf); extern void usb_autopm_put_interface_async(struct usb_interface *intf); |
9bbdf1e0a
|
510 511 |
extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf); extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf); |
692a186c9
|
512 |
|
1941044aa
|
513 514 |
static inline void usb_mark_last_busy(struct usb_device *udev) { |
6ddf27cdb
|
515 |
pm_runtime_mark_last_busy(&udev->dev); |
1941044aa
|
516 |
} |
645daaab0
|
517 |
#else |
645daaab0
|
518 |
|
088f7fec8
|
519 520 521 522 |
static inline int usb_enable_autosuspend(struct usb_device *udev) { return 0; } static inline int usb_disable_autosuspend(struct usb_device *udev) { return 0; } |
692a186c9
|
523 524 |
static inline int usb_autopm_get_interface(struct usb_interface *intf) { return 0; } |
9ac39f28b
|
525 526 |
static inline int usb_autopm_get_interface_async(struct usb_interface *intf) { return 0; } |
692a186c9
|
527 528 |
static inline void usb_autopm_put_interface(struct usb_interface *intf) { } |
9ac39f28b
|
529 530 |
static inline void usb_autopm_put_interface_async(struct usb_interface *intf) { } |
8e4ceb38e
|
531 532 |
static inline void usb_autopm_get_interface_no_resume( struct usb_interface *intf) |
692a186c9
|
533 |
{ } |
8e4ceb38e
|
534 535 |
static inline void usb_autopm_put_interface_no_suspend( struct usb_interface *intf) |
692a186c9
|
536 |
{ } |
1941044aa
|
537 538 |
static inline void usb_mark_last_busy(struct usb_device *udev) { } |
692a186c9
|
539 |
#endif |
645daaab0
|
540 |
|
1da177e4c
|
541 542 543 |
/*-------------------------------------------------------------------------*/ /* for drivers using iso endpoints */ |
969ab2ee9
|
544 |
extern int usb_get_current_frame_number(struct usb_device *usb_dev); |
1da177e4c
|
545 |
|
eab1cafc3
|
546 547 548 549 550 551 552 553 554 |
/* Sets up a group of bulk endpoints to support multiple stream IDs. */ extern int usb_alloc_streams(struct usb_interface *interface, struct usb_host_endpoint **eps, unsigned int num_eps, unsigned int num_streams, gfp_t mem_flags); /* Reverts a group of bulk endpoints back to not using stream IDs. */ extern void usb_free_streams(struct usb_interface *interface, struct usb_host_endpoint **eps, unsigned int num_eps, gfp_t mem_flags); |
1da177e4c
|
555 556 |
/* used these for multi-interface device registration */ extern int usb_driver_claim_interface(struct usb_driver *driver, |
969ab2ee9
|
557 |
struct usb_interface *iface, void *priv); |
1da177e4c
|
558 559 560 561 562 563 564 565 566 567 568 |
/** * usb_interface_claimed - returns true iff an interface is claimed * @iface: the interface being checked * * Returns true (nonzero) iff the interface is claimed, else false (zero). * Callers must own the driver model's usb bus readlock. So driver * probe() entries don't need extra locking, but other call contexts * may need to explicitly claim that lock. * */ |
969ab2ee9
|
569 570 |
static inline int usb_interface_claimed(struct usb_interface *iface) { |
1da177e4c
|
571 572 573 574 575 576 577 |
return (iface->dev.driver != NULL); } extern void usb_driver_release_interface(struct usb_driver *driver, struct usb_interface *iface); const struct usb_device_id *usb_match_id(struct usb_interface *interface, const struct usb_device_id *id); |
93bacefc4
|
578 579 |
extern int usb_match_one_id(struct usb_interface *interface, const struct usb_device_id *id); |
1da177e4c
|
580 581 582 |
extern struct usb_interface *usb_find_interface(struct usb_driver *drv, int minor); |
095bc3353
|
583 |
extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev, |
1da177e4c
|
584 585 |
unsigned ifnum); extern struct usb_host_interface *usb_altnum_to_altsetting( |
095bc3353
|
586 |
const struct usb_interface *intf, unsigned int altnum); |
91017f9cf
|
587 588 589 590 |
extern struct usb_host_interface *usb_find_alt_setting( struct usb_host_config *config, unsigned int iface_num, unsigned int alt_num); |
1da177e4c
|
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 |
/** * usb_make_path - returns stable device path in the usb tree * @dev: the device whose path is being constructed * @buf: where to put the string * @size: how big is "buf"? * * Returns length of the string (> 0) or negative if size was too small. * * This identifier is intended to be "stable", reflecting physical paths in * hardware such as physical bus addresses for host controllers or ports on * USB hubs. That makes it stay the same until systems are physically * reconfigured, by re-cabling a tree of USB devices or by moving USB host * controllers. Adding and removing devices, including virtual root hubs * in host controller driver modules, does not change these path identifers; * neither does rebooting or re-enumerating. These are more useful identifiers * than changeable ("unstable") ones like bus numbers or device addresses. * * With a partial exception for devices connected to USB 2.0 root hubs, these * identifiers are also predictable. So long as the device tree isn't changed, * plugging any USB device into a given hub port always gives it the same path. * Because of the use of "companion" controllers, devices connected to ports on * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are * high speed, and a different one if they are full or low speed. */ |
969ab2ee9
|
617 |
static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size) |
1da177e4c
|
618 619 |
{ int actual; |
969ab2ee9
|
620 621 |
actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name, dev->devpath); |
1da177e4c
|
622 623 624 625 |
return (actual >= (int)size) ? -1 : actual; } /*-------------------------------------------------------------------------*/ |
b724ae779
|
626 627 628 629 630 631 |
#define USB_DEVICE_ID_MATCH_DEVICE \ (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT) #define USB_DEVICE_ID_MATCH_DEV_RANGE \ (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI) #define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \ (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE) |
1da177e4c
|
632 |
#define USB_DEVICE_ID_MATCH_DEV_INFO \ |
b724ae779
|
633 634 635 |
(USB_DEVICE_ID_MATCH_DEV_CLASS | \ USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \ USB_DEVICE_ID_MATCH_DEV_PROTOCOL) |
1da177e4c
|
636 |
#define USB_DEVICE_ID_MATCH_INT_INFO \ |
b724ae779
|
637 638 639 |
(USB_DEVICE_ID_MATCH_INT_CLASS | \ USB_DEVICE_ID_MATCH_INT_SUBCLASS | \ USB_DEVICE_ID_MATCH_INT_PROTOCOL) |
1da177e4c
|
640 641 642 643 644 645 646 647 648 |
/** * USB_DEVICE - macro used to describe a specific usb device * @vend: the 16 bit USB Vendor ID * @prod: the 16 bit USB Product ID * * This macro is used to create a struct usb_device_id that matches a * specific device. */ |
812219ab8
|
649 |
#define USB_DEVICE(vend, prod) \ |
969ab2ee9
|
650 651 652 |
.match_flags = USB_DEVICE_ID_MATCH_DEVICE, \ .idVendor = (vend), \ .idProduct = (prod) |
1da177e4c
|
653 |
/** |
d0bcabcd7
|
654 |
* USB_DEVICE_VER - describe a specific usb device with a version range |
1da177e4c
|
655 656 657 658 659 660 661 662 |
* @vend: the 16 bit USB Vendor ID * @prod: the 16 bit USB Product ID * @lo: the bcdDevice_lo value * @hi: the bcdDevice_hi value * * This macro is used to create a struct usb_device_id that matches a * specific device, with a version range. */ |
969ab2ee9
|
663 |
#define USB_DEVICE_VER(vend, prod, lo, hi) \ |
b724ae779
|
664 |
.match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \ |
969ab2ee9
|
665 666 667 668 |
.idVendor = (vend), \ .idProduct = (prod), \ .bcdDevice_lo = (lo), \ .bcdDevice_hi = (hi) |
1da177e4c
|
669 670 |
/** |
d0bcabcd7
|
671 |
* USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol |
f836ac808
|
672 673 674 675 676 677 678 |
* @vend: the 16 bit USB Vendor ID * @prod: the 16 bit USB Product ID * @pr: bInterfaceProtocol value * * This macro is used to create a struct usb_device_id that matches a * specific interface protocol of devices. */ |
969ab2ee9
|
679 680 681 |
#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \ .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \ USB_DEVICE_ID_MATCH_INT_PROTOCOL, \ |
f836ac808
|
682 683 684 685 686 |
.idVendor = (vend), \ .idProduct = (prod), \ .bInterfaceProtocol = (pr) /** |
1da177e4c
|
687 688 689 690 691 692 693 694 |
* USB_DEVICE_INFO - macro used to describe a class of usb devices * @cl: bDeviceClass value * @sc: bDeviceSubClass value * @pr: bDeviceProtocol value * * This macro is used to create a struct usb_device_id that matches a * specific class of devices. */ |
969ab2ee9
|
695 696 697 698 699 |
#define USB_DEVICE_INFO(cl, sc, pr) \ .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \ .bDeviceClass = (cl), \ .bDeviceSubClass = (sc), \ .bDeviceProtocol = (pr) |
1da177e4c
|
700 701 |
/** |
969ab2ee9
|
702 |
* USB_INTERFACE_INFO - macro used to describe a class of usb interfaces |
1da177e4c
|
703 704 705 706 707 708 709 |
* @cl: bInterfaceClass value * @sc: bInterfaceSubClass value * @pr: bInterfaceProtocol value * * This macro is used to create a struct usb_device_id that matches a * specific class of interfaces. */ |
969ab2ee9
|
710 711 712 713 714 |
#define USB_INTERFACE_INFO(cl, sc, pr) \ .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \ .bInterfaceClass = (cl), \ .bInterfaceSubClass = (sc), \ .bInterfaceProtocol = (pr) |
8538f96ae
|
715 716 |
/** |
d0bcabcd7
|
717 |
* USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces |
8538f96ae
|
718 719 720 721 722 723 724 725 726 727 728 729 |
* @vend: the 16 bit USB Vendor ID * @prod: the 16 bit USB Product ID * @cl: bInterfaceClass value * @sc: bInterfaceSubClass value * @pr: bInterfaceProtocol value * * This macro is used to create a struct usb_device_id that matches a * specific device with a specific class of interfaces. * * This is especially useful when explicitly matching devices that have * vendor specific bDeviceClass values, but standards-compliant interfaces. */ |
969ab2ee9
|
730 |
#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \ |
8538f96ae
|
731 732 |
.match_flags = USB_DEVICE_ID_MATCH_INT_INFO \ | USB_DEVICE_ID_MATCH_DEVICE, \ |
969ab2ee9
|
733 734 |
.idVendor = (vend), \ .idProduct = (prod), \ |
8538f96ae
|
735 |
.bInterfaceClass = (cl), \ |
969ab2ee9
|
736 737 |
.bInterfaceSubClass = (sc), \ .bInterfaceProtocol = (pr) |
1da177e4c
|
738 |
|
b724ae779
|
739 |
/* ----------------------------------------------------------------------- */ |
1da177e4c
|
740 |
|
93bacefc4
|
741 |
/* Stuff for dynamic usb ids */ |
733260ff9
|
742 743 744 745 |
struct usb_dynids { spinlock_t lock; struct list_head list; }; |
93bacefc4
|
746 747 748 749 750 751 752 753 |
struct usb_dynid { struct list_head node; struct usb_device_id id; }; extern ssize_t usb_store_new_id(struct usb_dynids *dynids, struct device_driver *driver, const char *buf, size_t count); |
1da177e4c
|
754 |
/** |
8bb54ab57
|
755 756 757 758 759 760 761 762 763 764 765 |
* struct usbdrv_wrap - wrapper for driver-model structure * @driver: The driver-model core driver structure. * @for_devices: Non-zero for device drivers, 0 for interface drivers. */ struct usbdrv_wrap { struct device_driver driver; int for_devices; }; /** * struct usb_driver - identifies USB interface driver to usbcore |
1da177e4c
|
766 767 768 769 |
* @name: The driver name should be unique among USB drivers, * and should normally be the same as the module name. * @probe: Called to see if the driver is willing to manage a particular * interface on a device. If it is, probe returns zero and uses |
7ef4f0600
|
770 |
* usb_set_intfdata() to associate driver-specific data with the |
1da177e4c
|
771 772 |
* interface. It may also use usb_set_interface() to specify the * appropriate altsetting. If unwilling to manage the interface, |
7ef4f0600
|
773 774 |
* return -ENODEV, if genuine IO errors occured, an appropriate * negative errno value. |
1da177e4c
|
775 776 777 |
* @disconnect: Called when the interface is no longer accessible, usually * because its device has been (or is being) disconnected or the * driver module is being unloaded. |
a91be2acc
|
778 |
* @unlocked_ioctl: Used for drivers that want to talk to userspace through |
1da177e4c
|
779 780 781 782 783 |
* the "usbfs" filesystem. This lets devices provide ways to * expose information to user space regardless of where they * do (or don't) show up otherwise in the filesystem. * @suspend: Called when the device is going to be suspended by the system. * @resume: Called when the device is being resumed by the system. |
f07600cf9
|
784 785 |
* @reset_resume: Called when the suspended device has been reset instead * of being resumed. |
742120c63
|
786 |
* @pre_reset: Called by usb_reset_device() when the device |
79efa097e
|
787 |
* is about to be reset. |
742120c63
|
788 |
* @post_reset: Called by usb_reset_device() after the device |
7ef4f0600
|
789 |
* has been reset |
1da177e4c
|
790 791 792 |
* @id_table: USB drivers use ID table to support hotplugging. * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set * or your driver's probe function will never get called. |
733260ff9
|
793 794 |
* @dynids: used internally to hold the list of dynamically added device * ids for this driver. |
8bb54ab57
|
795 |
* @drvwrap: Driver-model core structure wrapper. |
ba9dc657a
|
796 797 |
* @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be * added to this driver by preventing the sysfs file from being created. |
645daaab0
|
798 799 |
* @supports_autosuspend: if set to 0, the USB core will not allow autosuspend * for interfaces bound to this driver. |
9da82bd46
|
800 801 |
* @soft_unbind: if set to 1, the USB core will not kill URBs and disable * endpoints before calling the driver's disconnect method. |
1da177e4c
|
802 |
* |
8bb54ab57
|
803 804 |
* USB interface drivers must provide a name, probe() and disconnect() * methods, and an id_table. Other driver fields are optional. |
1da177e4c
|
805 806 807 808 809 810 811 812 813 814 815 816 817 818 |
* * The id_table is used in hotplugging. It holds a set of descriptors, * and specialized data may be associated with each entry. That table * is used by both user and kernel mode hotplugging support. * * The probe() and disconnect() methods are called in a context where * they can sleep, but they should avoid abusing the privilege. Most * work to connect to a device should be done when the device is opened, * and undone at the last close. The disconnect code needs to address * concurrency issues with respect to open() and close() methods, as * well as forcing all pending I/O requests to complete (by unlinking * them as necessary, and blocking until the unlinks complete). */ struct usb_driver { |
1da177e4c
|
819 820 821 822 823 824 |
const char *name; int (*probe) (struct usb_interface *intf, const struct usb_device_id *id); void (*disconnect) (struct usb_interface *intf); |
c532b29a6
|
825 |
int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code, |
b724ae779
|
826 |
void *buf); |
1da177e4c
|
827 |
|
27d72e857
|
828 |
int (*suspend) (struct usb_interface *intf, pm_message_t message); |
1da177e4c
|
829 |
int (*resume) (struct usb_interface *intf); |
f07600cf9
|
830 |
int (*reset_resume)(struct usb_interface *intf); |
1da177e4c
|
831 |
|
f07600cf9
|
832 833 |
int (*pre_reset)(struct usb_interface *intf); int (*post_reset)(struct usb_interface *intf); |
79efa097e
|
834 |
|
1da177e4c
|
835 |
const struct usb_device_id *id_table; |
733260ff9
|
836 |
struct usb_dynids dynids; |
8bb54ab57
|
837 |
struct usbdrv_wrap drvwrap; |
ba9dc657a
|
838 |
unsigned int no_dynamic_id:1; |
645daaab0
|
839 |
unsigned int supports_autosuspend:1; |
9da82bd46
|
840 |
unsigned int soft_unbind:1; |
1da177e4c
|
841 |
}; |
8bb54ab57
|
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 |
#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver) /** * struct usb_device_driver - identifies USB device driver to usbcore * @name: The driver name should be unique among USB drivers, * and should normally be the same as the module name. * @probe: Called to see if the driver is willing to manage a particular * device. If it is, probe returns zero and uses dev_set_drvdata() * to associate driver-specific data with the device. If unwilling * to manage the device, return a negative errno value. * @disconnect: Called when the device is no longer accessible, usually * because it has been (or is being) disconnected or the driver's * module is being unloaded. * @suspend: Called when the device is going to be suspended by the system. * @resume: Called when the device is being resumed by the system. * @drvwrap: Driver-model core structure wrapper. |
645daaab0
|
858 859 |
* @supports_autosuspend: if set to 0, the USB core will not allow autosuspend * for devices bound to this driver. |
8bb54ab57
|
860 861 862 863 864 865 866 867 868 869 |
* * USB drivers must provide all the fields listed above except drvwrap. */ struct usb_device_driver { const char *name; int (*probe) (struct usb_device *udev); void (*disconnect) (struct usb_device *udev); int (*suspend) (struct usb_device *udev, pm_message_t message); |
65bfd2967
|
870 |
int (*resume) (struct usb_device *udev, pm_message_t message); |
8bb54ab57
|
871 |
struct usbdrv_wrap drvwrap; |
645daaab0
|
872 |
unsigned int supports_autosuspend:1; |
8bb54ab57
|
873 874 875 |
}; #define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \ drvwrap.driver) |
1da177e4c
|
876 877 878 879 880 |
extern struct bus_type usb_bus_type; /** * struct usb_class_driver - identifies a USB driver that wants to use the USB major number |
d6e5bcf4a
|
881 |
* @name: the usb class device name for this driver. Will show up in sysfs. |
e454cea20
|
882 |
* @devnode: Callback to provide a naming hint for a possible |
e376bbbb6
|
883 |
* device node to create. |
1da177e4c
|
884 |
* @fops: pointer to the struct file_operations of this driver. |
1da177e4c
|
885 886 887 888 889 890 891 892 |
* @minor_base: the start of the minor range for this driver. * * This structure is used for the usb_register_dev() and * usb_unregister_dev() functions, to consolidate a number of the * parameters used for them. */ struct usb_class_driver { char *name; |
e454cea20
|
893 |
char *(*devnode)(struct device *dev, mode_t *mode); |
99ac48f54
|
894 |
const struct file_operations *fops; |
d6e5bcf4a
|
895 |
int minor_base; |
1da177e4c
|
896 897 898 899 900 901 |
}; /* * use these in module_init()/module_exit() * and don't forget MODULE_DEVICE_TABLE(usb, ...) */ |
80f745fb1
|
902 903 |
extern int usb_register_driver(struct usb_driver *, struct module *, const char *); |
2143acc6d
|
904 905 |
static inline int usb_register(struct usb_driver *driver) { |
80f745fb1
|
906 |
return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME); |
2143acc6d
|
907 |
} |
1da177e4c
|
908 |
extern void usb_deregister(struct usb_driver *); |
8bb54ab57
|
909 910 911 |
extern int usb_register_device_driver(struct usb_device_driver *, struct module *); extern void usb_deregister_device_driver(struct usb_device_driver *); |
1da177e4c
|
912 913 914 915 916 917 |
extern int usb_register_dev(struct usb_interface *intf, struct usb_class_driver *class_driver); extern void usb_deregister_dev(struct usb_interface *intf, struct usb_class_driver *class_driver); extern int usb_disabled(void); |
b724ae779
|
918 |
/* ----------------------------------------------------------------------- */ |
1da177e4c
|
919 920 921 922 923 924 925 |
/* * URB support, for asynchronous request completions */ /* * urb->transfer_flags: |
fea340911
|
926 927 |
* * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb(). |
1da177e4c
|
928 929 |
*/ #define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */ |
b724ae779
|
930 931 |
#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame * ignored */ |
1da177e4c
|
932 |
#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */ |
1da177e4c
|
933 |
#define URB_NO_FSBR 0x0020 /* UHCI-specific */ |
b724ae779
|
934 935 936 |
#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */ #define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt * needed */ |
8b3b01c89
|
937 |
#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */ |
1da177e4c
|
938 |
|
ff9c895f0
|
939 |
/* The following flags are used internally by usbcore and HCDs */ |
fea340911
|
940 941 942 |
#define URB_DIR_IN 0x0200 /* Transfer from device to host */ #define URB_DIR_OUT 0 #define URB_DIR_MASK URB_DIR_IN |
ff9c895f0
|
943 944 945 946 947 948 949 |
#define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */ #define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */ #define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */ #define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */ #define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */ #define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */ #define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */ |
1da177e4c
|
950 951 952 953 |
struct usb_iso_packet_descriptor { unsigned int offset; unsigned int length; /* expected length */ unsigned int actual_length; |
d1bbb6000
|
954 |
int status; |
1da177e4c
|
955 956 957 |
}; struct urb; |
1da177e4c
|
958 |
|
51a2f077c
|
959 960 961 962 |
struct usb_anchor { struct list_head urb_list; wait_queue_head_t wait; spinlock_t lock; |
6a2839bed
|
963 |
unsigned int poisoned:1; |
51a2f077c
|
964 965 966 967 968 969 970 971 |
}; static inline void init_usb_anchor(struct usb_anchor *anchor) { INIT_LIST_HEAD(&anchor->urb_list); init_waitqueue_head(&anchor->wait); spin_lock_init(&anchor->lock); } |
7d12e780e
|
972 |
typedef void (*usb_complete_t)(struct urb *); |
1da177e4c
|
973 974 975 976 |
/** * struct urb - USB Request Block * @urb_list: For use by current owner of the URB. |
51a2f077c
|
977 978 |
* @anchor_list: membership in the list of an anchor * @anchor: to anchor URBs to a common mooring |
5b653c79c
|
979 980 |
* @ep: Points to the endpoint's data structure. Will eventually * replace @pipe. |
1da177e4c
|
981 982 983 984 985 986 987 988 989 |
* @pipe: Holds endpoint number, direction, type, and more. * Create these values with the eight macros available; * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl" * (control), "bulk", "int" (interrupt), or "iso" (isochronous). * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint * numbers range from zero to fifteen. Note that "in" endpoint two * is a different endpoint (and pipe) from "out" endpoint two. * The current configuration controls the existence, type, and * maximum packet size of any given endpoint. |
c6ba1c2af
|
990 |
* @stream_id: the endpoint's stream ID for bulk streams |
1da177e4c
|
991 992 993 994 995 996 997 998 |
* @dev: Identifies the USB device to perform the request. * @status: This is read in non-iso completion functions to get the * status of the particular request. ISO requests only use it * to tell whether the URB was unlinked; detailed status for * each frame is in the fields of the iso_frame-desc. * @transfer_flags: A variety of flags may be used to affect how URB * submission, unlinking, or operation are handled. Different * kinds of URB can use different flags. |
4e9e92003
|
999 1000 1001 1002 |
* @transfer_buffer: This identifies the buffer to (or from) which the I/O * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set * (however, do not leave garbage in transfer_buffer even then). * This buffer must be suitable for DMA; allocate it with |
1da177e4c
|
1003 1004 1005 1006 1007 1008 1009 |
* kmalloc() or equivalent. For transfers to "in" endpoints, contents * of this buffer will be modified. This buffer is used for the data * stage of control transfers. * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP, * the device driver is saying that it provided this DMA address, * which the host controller driver should use in preference to the * transfer_buffer. |
e376bbbb6
|
1010 1011 |
* @sg: scatter gather buffer list * @num_sgs: number of entries in the sg list |
1da177e4c
|
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 |
* @transfer_buffer_length: How big is transfer_buffer. The transfer may * be broken up into chunks according to the current maximum packet * size for the endpoint, which is a function of the configuration * and is encoded in the pipe. When the length is zero, neither * transfer_buffer nor transfer_dma is used. * @actual_length: This is read in non-iso completion functions, and * it tells how many bytes (out of transfer_buffer_length) were * transferred. It will normally be the same as requested, unless * either an error was reported or a short read was performed. * The URB_SHORT_NOT_OK transfer flag may be used to make such |
969ab2ee9
|
1022 |
* short reads be reported as errors. |
1da177e4c
|
1023 1024 1025 |
* @setup_packet: Only used for control transfers, this points to eight bytes * of setup data. Control transfers always start by sending this data * to the device. Then transfer_buffer is read or written, if needed. |
85bcb5ee8
|
1026 1027 |
* @setup_dma: DMA pointer for the setup packet. The caller must not use * this field; setup_packet must point to a valid buffer. |
1da177e4c
|
1028 1029 1030 |
* @start_frame: Returns the initial frame for isochronous transfers. * @number_of_packets: Lists the number of ISO transfer buffers. * @interval: Specifies the polling interval for interrupt or isochronous |
411c94038
|
1031 |
* transfers. The units are frames (milliseconds) for full and low |
f09a15e6e
|
1032 1033 |
* speed devices, and microframes (1/8 millisecond) for highspeed * and SuperSpeed devices. |
1da177e4c
|
1034 1035 1036 1037 1038 1039 |
* @error_count: Returns the number of ISO transfers that reported errors. * @context: For use in completion functions. This normally points to * request-specific driver context. * @complete: Completion handler. This URB is passed as the parameter to the * completion function. The completion function may then do what * it likes with the URB, including resubmitting or freeing it. |
969ab2ee9
|
1040 |
* @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to |
1da177e4c
|
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 |
* collect the transfer status for each buffer. * * This structure identifies USB transfer requests. URBs must be allocated by * calling usb_alloc_urb() and freed with a call to usb_free_urb(). * Initialization may be done using various usb_fill_*_urb() functions. URBs * are submitted using usb_submit_urb(), and pending requests may be canceled * using usb_unlink_urb() or usb_kill_urb(). * * Data Transfer Buffers: * * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise * taken from the general page pool. That is provided by transfer_buffer * (control requests also use setup_packet), and host controller drivers * perform a dma mapping (and unmapping) for each buffer transferred. Those * mapping operations can be expensive on some platforms (perhaps using a dma * bounce buffer or talking to an IOMMU), * although they're cheap on commodity x86 and ppc hardware. * |
85bcb5ee8
|
1059 1060 1061 |
* Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag, * which tells the host controller driver that no such mapping is needed for * the transfer_buffer since |
1da177e4c
|
1062 |
* the device driver is DMA-aware. For example, a device driver might |
073900a28
|
1063 |
* allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map(). |
85bcb5ee8
|
1064 1065 1066 |
* When this transfer flag is provided, host controller drivers will * attempt to use the dma address found in the transfer_dma * field rather than determining a dma address themselves. |
4e9e92003
|
1067 1068 1069 1070 1071 1072 1073 1074 |
* * Note that transfer_buffer must still be set if the controller * does not support DMA (as indicated by bus.uses_dma) and when talking * to root hub. If you have to trasfer between highmem zone and the device * on such controller, create a bounce buffer or bail out with an error. * If transfer_buffer cannot be set (is in highmem) and the controller is DMA * capable, assign NULL to it, so that usbmon knows not to use the value. * The setup_packet must always be set, so it cannot be located in highmem. |
1da177e4c
|
1075 1076 1077 1078 |
* * Initialization: * * All URBs submitted must initialize the dev, pipe, transfer_flags (may be |
b375a0495
|
1079 |
* zero), and complete fields. All URBs must also initialize |
1da177e4c
|
1080 1081 1082 1083 1084 1085 1086 1087 1088 |
* transfer_buffer and transfer_buffer_length. They may provide the * URB_SHORT_NOT_OK transfer flag, indicating that short reads are * to be treated as errors; that flag is invalid for write requests. * * Bulk URBs may * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers * should always terminate with a short packet, even if it means adding an * extra zero length packet. * |
85bcb5ee8
|
1089 1090 1091 |
* Control URBs must provide a valid pointer in the setup_packet field. * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA * beforehand. |
1da177e4c
|
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 |
* * Interrupt URBs must provide an interval, saying how often (in milliseconds * or, for highspeed devices, 125 microsecond units) * to poll for transfers. After the URB has been submitted, the interval * field reflects how the transfer was actually scheduled. * The polling interval may be more frequent than requested. * For example, some controllers have a maximum interval of 32 milliseconds, * while others support intervals of up to 1024 milliseconds. * Isochronous URBs also have transfer intervals. (Note that for isochronous * endpoints, as well as high speed interrupt endpoints, the encoding of * the transfer interval in the endpoint descriptor is logarithmic. * Device drivers must convert that value to linear units themselves.) * * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling * the host controller to schedule the transfer as soon as bandwidth * utilization allows, and then set start_frame to reflect the actual frame * selected during submission. Otherwise drivers must specify the start_frame * and handle the case where the transfer can't begin then. However, drivers * won't know how bandwidth is currently allocated, and while they can * find the current frame using usb_get_current_frame_number () they can't * know the range for that frame number. (Ranges for frame counter values * are HC-specific, and can go from 256 to 65536 frames from "now".) * * Isochronous URBs have a different data transfer model, in part because * the quality of service is only "best effort". Callers provide specially * allocated URBs, with number_of_packets worth of iso_frame_desc structures * at the end. Each such packet is an individual ISO transfer. Isochronous * URBs are normally queued, submitted by drivers to arrange that * transfers are at least double buffered, and then explicitly resubmitted * in completion handlers, so * that data (such as audio or video) streams at as constant a rate as the * host controller scheduler can support. * * Completion Callbacks: * * The completion callback is made in_interrupt(), and one of the first * things that a completion handler should do is check the status field. * The status field is provided for all URBs. It is used to report * unlinked URBs, and status for all non-ISO transfers. It should not * be examined before the URB is returned to the completion handler. * * The context field is normally used to link URBs back to the relevant * driver or request state. * * When the completion callback is invoked for non-isochronous URBs, the * actual_length field tells how many bytes were transferred. This field * is updated even when the URB terminated with an error or was unlinked. * * ISO transfer status is reported in the status and actual_length fields * of the iso_frame_desc array, and the number of errors is reported in * error_count. Completion callbacks for ISO transfers will normally * (re)submit URBs to ensure a constant transfer rate. |
719df469c
|
1144 1145 1146 1147 |
* * Note that even fields marked "public" should not be touched by the driver * when the urb is owned by the hcd, that is, since the call to * usb_submit_urb() till the entry into the completion routine. |
1da177e4c
|
1148 |
*/ |
969ab2ee9
|
1149 |
struct urb { |
aeec46b97
|
1150 |
/* private: usb core and host controller only fields in the urb */ |
1da177e4c
|
1151 |
struct kref kref; /* reference count of the URB */ |
1da177e4c
|
1152 |
void *hcpriv; /* private data for host controller */ |
1da177e4c
|
1153 |
atomic_t use_count; /* concurrent submissions counter */ |
49367d8f1
|
1154 |
atomic_t reject; /* submissions will fail */ |
eb2310546
|
1155 |
int unlinked; /* unlink error code */ |
1da177e4c
|
1156 |
|
aeec46b97
|
1157 |
/* public: documented fields in the urb that can be used by drivers */ |
b724ae779
|
1158 1159 |
struct list_head urb_list; /* list head for use by the urb's * current owner */ |
969ab2ee9
|
1160 |
struct list_head anchor_list; /* the URB may be anchored */ |
51a2f077c
|
1161 |
struct usb_anchor *anchor; |
812219ab8
|
1162 |
struct usb_device *dev; /* (in) pointer to associated device */ |
969ab2ee9
|
1163 |
struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */ |
1da177e4c
|
1164 |
unsigned int pipe; /* (in) pipe information */ |
94af12209
|
1165 |
unsigned int stream_id; /* (in) stream ID */ |
1da177e4c
|
1166 1167 1168 1169 |
int status; /* (return) non-ISO status */ unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/ void *transfer_buffer; /* (in) associated data buffer */ dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */ |
910f8d0ce
|
1170 |
struct scatterlist *sg; /* (in) scatter gather buffer list */ |
e04748e3a
|
1171 |
int num_sgs; /* (in) number of entries in the sg list */ |
16e2e5f63
|
1172 |
u32 transfer_buffer_length; /* (in) data buffer length */ |
8c209e678
|
1173 |
u32 actual_length; /* (return) actual transfer length */ |
1da177e4c
|
1174 1175 1176 1177 |
unsigned char *setup_packet; /* (in) setup packet (control only) */ dma_addr_t setup_dma; /* (in) dma addr for setup_packet */ int start_frame; /* (modify) start frame (ISO) */ int number_of_packets; /* (in) number of ISO packets */ |
b724ae779
|
1178 1179 |
int interval; /* (modify) transfer interval * (INT/ISO) */ |
1da177e4c
|
1180 1181 1182 |
int error_count; /* (return) number of ISO errors */ void *context; /* (in) context for completion */ usb_complete_t complete; /* (in) completion routine */ |
b724ae779
|
1183 1184 |
struct usb_iso_packet_descriptor iso_frame_desc[0]; /* (in) ISO ONLY */ |
1da177e4c
|
1185 |
}; |
b724ae779
|
1186 |
/* ----------------------------------------------------------------------- */ |
1da177e4c
|
1187 1188 1189 1190 1191 1192 1193 1194 1195 |
/** * usb_fill_control_urb - initializes a control urb * @urb: pointer to the urb to initialize. * @dev: pointer to the struct usb_device for this urb. * @pipe: the endpoint pipe * @setup_packet: pointer to the setup_packet buffer * @transfer_buffer: pointer to the transfer buffer * @buffer_length: length of the transfer buffer |
3d5b2510f
|
1196 |
* @complete_fn: pointer to the usb_complete_t function |
1da177e4c
|
1197 1198 1199 1200 1201 |
* @context: what to set the urb context to. * * Initializes a control urb with the proper information needed to submit * it to a device. */ |
969ab2ee9
|
1202 1203 1204 1205 1206 1207 1208 1209 |
static inline void usb_fill_control_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe, unsigned char *setup_packet, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context) |
1da177e4c
|
1210 |
{ |
1da177e4c
|
1211 1212 1213 1214 1215 |
urb->dev = dev; urb->pipe = pipe; urb->setup_packet = setup_packet; urb->transfer_buffer = transfer_buffer; urb->transfer_buffer_length = buffer_length; |
3d5b2510f
|
1216 |
urb->complete = complete_fn; |
1da177e4c
|
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 |
urb->context = context; } /** * usb_fill_bulk_urb - macro to help initialize a bulk urb * @urb: pointer to the urb to initialize. * @dev: pointer to the struct usb_device for this urb. * @pipe: the endpoint pipe * @transfer_buffer: pointer to the transfer buffer * @buffer_length: length of the transfer buffer |
3d5b2510f
|
1227 |
* @complete_fn: pointer to the usb_complete_t function |
1da177e4c
|
1228 1229 1230 1231 1232 |
* @context: what to set the urb context to. * * Initializes a bulk urb with the proper information needed to submit it * to a device. */ |
969ab2ee9
|
1233 1234 1235 1236 1237 1238 1239 |
static inline void usb_fill_bulk_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context) |
1da177e4c
|
1240 |
{ |
1da177e4c
|
1241 1242 1243 1244 |
urb->dev = dev; urb->pipe = pipe; urb->transfer_buffer = transfer_buffer; urb->transfer_buffer_length = buffer_length; |
3d5b2510f
|
1245 |
urb->complete = complete_fn; |
1da177e4c
|
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 |
urb->context = context; } /** * usb_fill_int_urb - macro to help initialize a interrupt urb * @urb: pointer to the urb to initialize. * @dev: pointer to the struct usb_device for this urb. * @pipe: the endpoint pipe * @transfer_buffer: pointer to the transfer buffer * @buffer_length: length of the transfer buffer |
3d5b2510f
|
1256 |
* @complete_fn: pointer to the usb_complete_t function |
1da177e4c
|
1257 1258 1259 1260 1261 1262 |
* @context: what to set the urb context to. * @interval: what to set the urb interval to, encoded like * the endpoint descriptor's bInterval value. * * Initializes a interrupt urb with the proper information needed to submit * it to a device. |
f09a15e6e
|
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
* * Note that High Speed and SuperSpeed interrupt endpoints use a logarithmic * encoding of the endpoint interval, and express polling intervals in * microframes (eight per millisecond) rather than in frames (one per * millisecond). * * Wireless USB also uses the logarithmic encoding, but specifies it in units of * 128us instead of 125us. For Wireless USB devices, the interval is passed * through to the host controller, rather than being translated into microframe * units. |
1da177e4c
|
1273 |
*/ |
969ab2ee9
|
1274 1275 1276 1277 1278 1279 1280 1281 |
static inline void usb_fill_int_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context, int interval) |
1da177e4c
|
1282 |
{ |
1da177e4c
|
1283 1284 1285 1286 |
urb->dev = dev; urb->pipe = pipe; urb->transfer_buffer = transfer_buffer; urb->transfer_buffer_length = buffer_length; |
3d5b2510f
|
1287 |
urb->complete = complete_fn; |
1da177e4c
|
1288 |
urb->context = context; |
f09a15e6e
|
1289 |
if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER) |
1da177e4c
|
1290 1291 1292 1293 1294 1295 1296 |
urb->interval = 1 << (interval - 1); else urb->interval = interval; urb->start_frame = -1; } extern void usb_init_urb(struct urb *urb); |
55016f10e
|
1297 |
extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags); |
1da177e4c
|
1298 1299 1300 |
extern void usb_free_urb(struct urb *urb); #define usb_put_urb usb_free_urb extern struct urb *usb_get_urb(struct urb *urb); |
55016f10e
|
1301 |
extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags); |
1da177e4c
|
1302 1303 |
extern int usb_unlink_urb(struct urb *urb); extern void usb_kill_urb(struct urb *urb); |
55b447bf7
|
1304 1305 |
extern void usb_poison_urb(struct urb *urb); extern void usb_unpoison_urb(struct urb *urb); |
51a2f077c
|
1306 |
extern void usb_kill_anchored_urbs(struct usb_anchor *anchor); |
6a2839bed
|
1307 |
extern void usb_poison_anchored_urbs(struct usb_anchor *anchor); |
856395d6e
|
1308 |
extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor); |
eda769593
|
1309 |
extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor); |
51a2f077c
|
1310 1311 1312 1313 |
extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor); extern void usb_unanchor_urb(struct urb *urb); extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor, unsigned int timeout); |
198762522
|
1314 1315 1316 |
extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor); extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor); extern int usb_anchor_empty(struct usb_anchor *anchor); |
1da177e4c
|
1317 |
|
fea340911
|
1318 1319 1320 1321 1322 1323 1324 1325 1326 |
/** * usb_urb_dir_in - check if an URB describes an IN transfer * @urb: URB to be checked * * Returns 1 if @urb describes an IN transfer (device-to-host), * otherwise 0. */ static inline int usb_urb_dir_in(struct urb *urb) { |
d617bc83f
|
1327 |
return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN; |
fea340911
|
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 |
} /** * usb_urb_dir_out - check if an URB describes an OUT transfer * @urb: URB to be checked * * Returns 1 if @urb describes an OUT transfer (host-to-device), * otherwise 0. */ static inline int usb_urb_dir_out(struct urb *urb) { return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT; } |
073900a28
|
1341 |
void *usb_alloc_coherent(struct usb_device *dev, size_t size, |
55016f10e
|
1342 |
gfp_t mem_flags, dma_addr_t *dma); |
073900a28
|
1343 |
void usb_free_coherent(struct usb_device *dev, size_t size, |
1da177e4c
|
1344 1345 1346 |
void *addr, dma_addr_t dma); #if 0 |
969ab2ee9
|
1347 1348 1349 |
struct urb *usb_buffer_map(struct urb *urb); void usb_buffer_dmasync(struct urb *urb); void usb_buffer_unmap(struct urb *urb); |
1da177e4c
|
1350 1351 1352 |
#endif struct scatterlist; |
5e60a1613
|
1353 |
int usb_buffer_map_sg(const struct usb_device *dev, int is_in, |
095bc3353
|
1354 |
struct scatterlist *sg, int nents); |
1da177e4c
|
1355 |
#if 0 |
5e60a1613
|
1356 |
void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in, |
095bc3353
|
1357 |
struct scatterlist *sg, int n_hw_ents); |
1da177e4c
|
1358 |
#endif |
5e60a1613
|
1359 |
void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in, |
095bc3353
|
1360 |
struct scatterlist *sg, int n_hw_ents); |
1da177e4c
|
1361 1362 1363 1364 1365 1366 1367 1368 |
/*-------------------------------------------------------------------* * SYNCHRONOUS CALL SUPPORT * *-------------------------------------------------------------------*/ extern int usb_control_msg(struct usb_device *dev, unsigned int pipe, __u8 request, __u8 requesttype, __u16 value, __u16 index, void *data, __u16 size, int timeout); |
782a7a632
|
1369 1370 |
extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout); |
1da177e4c
|
1371 1372 1373 |
extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout); |
1da177e4c
|
1374 1375 1376 1377 1378 |
/* wrappers around usb_control_msg() for the most common standard requests */ extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype, unsigned char descindex, void *buf, int size); extern int usb_get_status(struct usb_device *dev, int type, int target, void *data); |
1da177e4c
|
1379 1380 1381 1382 1383 1384 1385 |
extern int usb_string(struct usb_device *dev, int index, char *buf, size_t size); /* wrappers that also update important state inside usbcore */ extern int usb_clear_halt(struct usb_device *dev, int pipe); extern int usb_reset_configuration(struct usb_device *dev); extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate); |
3444b26af
|
1386 |
extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr); |
1da177e4c
|
1387 |
|
088dc270e
|
1388 1389 |
/* this request isn't really synchronous, but it belongs with the others */ extern int usb_driver_set_configuration(struct usb_device *udev, int config); |
1da177e4c
|
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 |
/* * timeouts, in milliseconds, used for sending/receiving control messages * they typically complete within a few frames (msec) after they're issued * USB identifies 5 second timeouts, maybe more in a few cases, and a few * slow devices (like some MGE Ellipse UPSes) actually push that limit. */ #define USB_CTRL_GET_TIMEOUT 5000 #define USB_CTRL_SET_TIMEOUT 5000 /** * struct usb_sg_request - support for scatter/gather I/O * @status: zero indicates success, else negative errno * @bytes: counts bytes transferred. * * These requests are initialized using usb_sg_init(), and then are used * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most * members of the request object aren't for driver access. * * The status and bytecount values are valid only after usb_sg_wait() * returns. If the status is zero, then the bytecount matches the total * from the request. * * After an error completion, drivers may need to clear a halt condition * on the endpoint. */ struct usb_sg_request { int status; size_t bytes; |
bf92c1906
|
1419 1420 |
/* private: * members below are private to usbcore, |
1da177e4c
|
1421 1422 1423 1424 1425 1426 |
* and are not provided for driver access! */ spinlock_t lock; struct usb_device *dev; int pipe; |
1da177e4c
|
1427 1428 1429 1430 1431 1432 1433 |
int entries; struct urb **urbs; int count; struct completion complete; }; |
969ab2ee9
|
1434 |
int usb_sg_init( |
1da177e4c
|
1435 1436 |
struct usb_sg_request *io, struct usb_device *dev, |
969ab2ee9
|
1437 |
unsigned pipe, |
1da177e4c
|
1438 1439 1440 1441 |
unsigned period, struct scatterlist *sg, int nents, size_t length, |
55016f10e
|
1442 |
gfp_t mem_flags |
1da177e4c
|
1443 |
); |
969ab2ee9
|
1444 1445 |
void usb_sg_cancel(struct usb_sg_request *io); void usb_sg_wait(struct usb_sg_request *io); |
1da177e4c
|
1446 |
|
b724ae779
|
1447 |
/* ----------------------------------------------------------------------- */ |
1da177e4c
|
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 |
/* * For various legacy reasons, Linux has a small cookie that's paired with * a struct usb_device to identify an endpoint queue. Queue characteristics * are defined by the endpoint's descriptor. This cookie is called a "pipe", * an unsigned int encoded as: * * - direction: bit 7 (0 = Host-to-Device [Out], * 1 = Device-to-Host [In] ... * like endpoint bEndpointAddress) * - device address: bits 8-14 ... bit positions known to uhci-hcd * - endpoint: bits 15-18 ... bit positions known to uhci-hcd * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, * 10 = control, 11 = bulk) * * Given the device address and endpoint descriptor, pipes are redundant. */ /* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */ /* (yet ... they're the values used by usbfs) */ #define PIPE_ISOCHRONOUS 0 #define PIPE_INTERRUPT 1 #define PIPE_CONTROL 2 #define PIPE_BULK 3 #define usb_pipein(pipe) ((pipe) & USB_DIR_IN) #define usb_pipeout(pipe) (!usb_pipein(pipe)) #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) #define usb_pipetype(pipe) (((pipe) >> 30) & 3) #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) |
b724ae779
|
1484 1485 |
static inline unsigned int __create_pipe(struct usb_device *dev, unsigned int endpoint) |
1da177e4c
|
1486 1487 1488 1489 1490 |
{ return (dev->devnum << 8) | (endpoint << 15); } /* Create various pipes... */ |
812219ab8
|
1491 |
#define usb_sndctrlpipe(dev, endpoint) \ |
969ab2ee9
|
1492 |
((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint)) |
812219ab8
|
1493 |
#define usb_rcvctrlpipe(dev, endpoint) \ |
969ab2ee9
|
1494 |
((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN) |
812219ab8
|
1495 |
#define usb_sndisocpipe(dev, endpoint) \ |
969ab2ee9
|
1496 |
((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint)) |
812219ab8
|
1497 |
#define usb_rcvisocpipe(dev, endpoint) \ |
969ab2ee9
|
1498 |
((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN) |
812219ab8
|
1499 |
#define usb_sndbulkpipe(dev, endpoint) \ |
969ab2ee9
|
1500 |
((PIPE_BULK << 30) | __create_pipe(dev, endpoint)) |
812219ab8
|
1501 |
#define usb_rcvbulkpipe(dev, endpoint) \ |
969ab2ee9
|
1502 |
((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN) |
812219ab8
|
1503 |
#define usb_sndintpipe(dev, endpoint) \ |
969ab2ee9
|
1504 |
((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint)) |
812219ab8
|
1505 |
#define usb_rcvintpipe(dev, endpoint) \ |
969ab2ee9
|
1506 |
((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN) |
1da177e4c
|
1507 |
|
fe54b058d
|
1508 1509 1510 1511 1512 1513 1514 |
static inline struct usb_host_endpoint * usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe) { struct usb_host_endpoint **eps; eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out; return eps[usb_pipeendpoint(pipe)]; } |
1da177e4c
|
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 |
/*-------------------------------------------------------------------------*/ static inline __u16 usb_maxpacket(struct usb_device *udev, int pipe, int is_out) { struct usb_host_endpoint *ep; unsigned epnum = usb_pipeendpoint(pipe); if (is_out) { WARN_ON(usb_pipein(pipe)); ep = udev->ep_out[epnum]; } else { WARN_ON(usb_pipeout(pipe)); ep = udev->ep_in[epnum]; } if (!ep) return 0; /* NOTE: only 0x07ff bits are for packet size... */ return le16_to_cpu(ep->desc.wMaxPacketSize); } |
b724ae779
|
1536 |
/* ----------------------------------------------------------------------- */ |
1da177e4c
|
1537 |
|
3099e75a7
|
1538 1539 1540 1541 1542 1543 1544 |
/* Events from the usb core */ #define USB_DEVICE_ADD 0x0001 #define USB_DEVICE_REMOVE 0x0002 #define USB_BUS_ADD 0x0003 #define USB_BUS_REMOVE 0x0004 extern void usb_register_notify(struct notifier_block *nb); extern void usb_unregister_notify(struct notifier_block *nb); |
1da177e4c
|
1545 |
#ifdef DEBUG |
efcbd3df0
|
1546 1547 1548 |
#define dbg(format, arg...) \ printk(KERN_DEBUG "%s: " format " ", __FILE__, ##arg) |
1da177e4c
|
1549 |
#else |
efcbd3df0
|
1550 1551 1552 1553 1554 1555 |
#define dbg(format, arg...) \ do { \ if (0) \ printk(KERN_DEBUG "%s: " format " ", __FILE__, ##arg); \ } while (0) |
1da177e4c
|
1556 |
#endif |
efcbd3df0
|
1557 1558 1559 |
#define err(format, arg...) \ printk(KERN_ERR KBUILD_MODNAME ": " format " ", ##arg) |
1da177e4c
|
1560 |
|
00048b8bd
|
1561 1562 |
/* debugfs stuff */ extern struct dentry *usb_debug_root; |
1da177e4c
|
1563 1564 1565 |
#endif /* __KERNEL__ */ #endif |