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