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