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