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