blob: 533c32374e01e58e36509a86695608060adf4761 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_USB_H
2#define __LINUX_USB_H
3
4#include <linux/mod_devicetable.h>
David Brownell5f848132006-12-16 15:34:53 -08005#include <linux/usb/ch9.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7#define USB_MAJOR 180
Kay Sieversfbf82fd2005-07-31 01:05:53 +02008#define USB_DEVICE_MAJOR 189
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10
11#ifdef __KERNEL__
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#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 */
Alan Stern645daaa2006-08-30 15:47:02 -040022#include <linux/mutex.h> /* for struct mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24struct usb_device;
25struct 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
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070044struct ep_device;
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046/**
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
Randy Dunlap7fac9a32006-06-22 15:12:41 -070052 * @ep_dev: ep_device for sysfs info
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * @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 */
59struct usb_host_endpoint {
60 struct usb_endpoint_descriptor desc;
61 struct list_head urb_list;
62 void *hcpriv;
Greg Kroah-Hartman9bde7492006-06-14 12:14:34 -070063 struct ep_device *ep_dev; /* For sysfs info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65 unsigned char *extra; /* Extra descriptors */
66 int extralen;
67};
68
69/* host-side wrapper for one interface setting's parsed descriptors */
70struct 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
83enum 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.
97 * @driver: the USB driver that is bound to this interface.
98 * @minor: the minor number assigned to this interface, if this
99 * interface is bound to a driver that uses the USB major number.
100 * If this interface does not use the USB major, this field should
101 * be unused. The driver should set this value in the probe()
102 * function of the driver, after it has been assigned a minor
103 * number from the USB core by calling usb_register_dev().
104 * @condition: binding state of the interface: not bound, binding
105 * (in probe()), bound to a driver, or unbinding (in disconnect())
Alan Stern4d064c02006-07-01 22:11:44 -0400106 * @is_active: flag set when the interface is bound and not suspended.
Alan Stern645daaa2006-08-30 15:47:02 -0400107 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
108 * capability during autosuspend.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 * @dev: driver model's view of this device
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700110 * @usb_dev: if an interface is bound to the USB major, this will point
111 * to the sysfs representation for that device.
Alan Stern645daaa2006-08-30 15:47:02 -0400112 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
113 * allowed unless the counter is 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 *
115 * USB device drivers attach to interfaces on a physical device. Each
116 * interface encapsulates a single high level function, such as feeding
117 * an audio stream to a speaker or reporting a change in a volume control.
118 * Many USB devices only have one interface. The protocol used to talk to
119 * an interface's endpoints can be defined in a usb "class" specification,
120 * or by a product's vendor. The (default) control endpoint is part of
121 * every interface, but is never listed among the interface's descriptors.
122 *
123 * The driver that is bound to the interface can use standard driver model
124 * calls such as dev_get_drvdata() on the dev member of this structure.
125 *
126 * Each interface may have alternate settings. The initial configuration
127 * of a device sets altsetting 0, but the device driver can change
128 * that setting using usb_set_interface(). Alternate settings are often
Michael Opdenacker59c51592007-05-09 08:57:56 +0200129 * used to control the use of periodic endpoints, such as by having
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 * different endpoints use different amounts of reserved USB bandwidth.
131 * All standards-conformant USB devices that use isochronous endpoints
132 * will use them in non-default settings.
133 *
134 * The USB specification says that alternate setting numbers must run from
135 * 0 to one less than the total number of alternate settings. But some
136 * devices manage to mess this up, and the structures aren't necessarily
137 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to
138 * look up an alternate setting in the altsetting array based on its number.
139 */
140struct usb_interface {
141 /* array of alternate settings for this interface,
142 * stored in no particular order */
143 struct usb_host_interface *altsetting;
144
145 struct usb_host_interface *cur_altsetting; /* the currently
146 * active alternate setting */
147 unsigned num_altsetting; /* number of alternate settings */
148
Alan Sternb724ae72005-10-24 15:36:00 -0400149 int minor; /* minor number this interface is
150 * bound to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 enum usb_interface_condition condition; /* state of binding */
Alan Stern4d064c02006-07-01 22:11:44 -0400152 unsigned is_active:1; /* the interface is not suspended */
Alan Stern645daaa2006-08-30 15:47:02 -0400153 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
Alan Stern4d064c02006-07-01 22:11:44 -0400154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 struct device dev; /* interface specific device info */
Greg Kroah-Hartman0873c762006-06-20 13:09:50 -0700156 struct device *usb_dev; /* pointer to the usb class's device, if any */
Alan Stern645daaa2006-08-30 15:47:02 -0400157 int pm_usage_cnt; /* usage counter for autosuspend */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158};
159#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
160#define interface_to_usbdev(intf) \
161 container_of(intf->dev.parent, struct usb_device, dev)
162
163static inline void *usb_get_intfdata (struct usb_interface *intf)
164{
165 return dev_get_drvdata (&intf->dev);
166}
167
168static inline void usb_set_intfdata (struct usb_interface *intf, void *data)
169{
170 dev_set_drvdata(&intf->dev, data);
171}
172
173struct usb_interface *usb_get_intf(struct usb_interface *intf);
174void usb_put_intf(struct usb_interface *intf);
175
176/* this maximum is arbitrary */
177#define USB_MAXINTERFACES 32
178
179/**
180 * struct usb_interface_cache - long-term representation of a device interface
181 * @num_altsetting: number of altsettings defined.
182 * @ref: reference counter.
183 * @altsetting: variable-length array of interface structures, one for
184 * each alternate setting that may be selected. Each one includes a
185 * set of endpoint configurations. They will be in no particular order.
186 *
187 * These structures persist for the lifetime of a usb_device, unlike
188 * struct usb_interface (which persists only as long as its configuration
189 * is installed). The altsetting arrays can be accessed through these
190 * structures at any time, permitting comparison of configurations and
191 * providing support for the /proc/bus/usb/devices pseudo-file.
192 */
193struct usb_interface_cache {
194 unsigned num_altsetting; /* number of alternate settings */
195 struct kref ref; /* reference counter */
196
197 /* variable-length array of alternate settings for this interface,
198 * stored in no particular order */
199 struct usb_host_interface altsetting[0];
200};
201#define ref_to_usb_interface_cache(r) \
202 container_of(r, struct usb_interface_cache, ref)
203#define altsetting_to_usb_interface_cache(a) \
204 container_of(a, struct usb_interface_cache, altsetting[0])
205
206/**
207 * struct usb_host_config - representation of a device's configuration
208 * @desc: the device's configuration descriptor.
209 * @string: pointer to the cached version of the iConfiguration string, if
210 * present for this configuration.
211 * @interface: array of pointers to usb_interface structures, one for each
212 * interface in the configuration. The number of interfaces is stored
213 * in desc.bNumInterfaces. These pointers are valid only while the
214 * the configuration is active.
215 * @intf_cache: array of pointers to usb_interface_cache structures, one
216 * for each interface in the configuration. These structures exist
217 * for the entire life of the device.
218 * @extra: pointer to buffer containing all extra descriptors associated
219 * with this configuration (those preceding the first interface
220 * descriptor).
221 * @extralen: length of the extra descriptors buffer.
222 *
223 * USB devices may have multiple configurations, but only one can be active
224 * at any time. Each encapsulates a different operational environment;
225 * for example, a dual-speed device would have separate configurations for
226 * full-speed and high-speed operation. The number of configurations
227 * available is stored in the device descriptor as bNumConfigurations.
228 *
229 * A configuration can contain multiple interfaces. Each corresponds to
230 * a different function of the USB device, and all are available whenever
231 * the configuration is active. The USB standard says that interfaces
232 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
233 * of devices get this wrong. In addition, the interface array is not
234 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to
235 * look up an interface entry based on its number.
236 *
237 * Device drivers should not attempt to activate configurations. The choice
238 * of which configuration to install is a policy decision based on such
239 * considerations as available power, functionality provided, and the user's
Kay Sievers312c0042005-11-16 09:00:00 +0100240 * desires (expressed through userspace tools). However, drivers can call
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 * usb_reset_configuration() to reinitialize the current configuration and
242 * all its interfaces.
243 */
244struct usb_host_config {
245 struct usb_config_descriptor desc;
246
Alan Stern4f62efe2005-10-24 16:24:14 -0400247 char *string; /* iConfiguration string, if present */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 /* the interfaces associated with this configuration,
249 * stored in no particular order */
250 struct usb_interface *interface[USB_MAXINTERFACES];
251
252 /* Interface information available even when this is not the
253 * active configuration */
254 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];
255
256 unsigned char *extra; /* Extra descriptors */
257 int extralen;
258};
259
260int __usb_get_extra_descriptor(char *buffer, unsigned size,
261 unsigned char type, void **ptr);
262#define usb_get_extra_descriptor(ifpoint,type,ptr)\
263 __usb_get_extra_descriptor((ifpoint)->extra,(ifpoint)->extralen,\
264 type,(void**)ptr)
265
Alan Sternb724ae72005-10-24 15:36:00 -0400266/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268/* USB device number allocation bitmap */
269struct usb_devmap {
270 unsigned long devicemap[128 / (8*sizeof(unsigned long))];
271};
272
273/*
274 * Allocated per bus (tree of devices) we have:
275 */
276struct usb_bus {
277 struct device *controller; /* host/master side hardware */
278 int busnum; /* Bus number (in order of reg) */
279 char *bus_name; /* stable id (PCI slot_name etc) */
Alan Sterndd990f12006-08-30 11:29:56 -0400280 u8 uses_dma; /* Does the host controller use DMA? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 u8 otg_port; /* 0, or number of OTG/HNP port */
282 unsigned is_b_host:1; /* true during some HNP roleswitches */
283 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */
284
Alan Sternb724ae72005-10-24 15:36:00 -0400285 int devnum_next; /* Next open device number in
286 * round-robin allocation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
288 struct usb_devmap devmap; /* device address allocation map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 struct usb_device *root_hub; /* Root hub */
290 struct list_head bus_list; /* list of busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 int bandwidth_allocated; /* on this bus: how much of the time
293 * reserved for periodic (intr/iso)
294 * requests is used, on average?
295 * Units: microseconds/frame.
296 * Limits: Full/low speed reserve 90%,
297 * while high speed reserves 80%.
298 */
299 int bandwidth_int_reqs; /* number of Interrupt requests */
300 int bandwidth_isoc_reqs; /* number of Isoc. requests */
301
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100302#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 struct dentry *usbfs_dentry; /* usbfs dentry entry for the bus */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100304#endif
gregkh@suse.de8561b102005-03-15 15:10:13 -0800305 struct class_device *class_dev; /* class device for this bus */
Alan Sternb724ae72005-10-24 15:36:00 -0400306
Adrian Bunk4749f322005-06-23 11:36:56 +0200307#if defined(CONFIG_USB_MON)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 struct mon_bus *mon_bus; /* non-null when associated */
309 int monitored; /* non-zero when monitored */
310#endif
311};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Alan Sternb724ae72005-10-24 15:36:00 -0400313/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315/* This is arbitrary.
316 * From USB 2.0 spec Table 11-13, offset 7, a hub can
317 * have up to 255 ports. The most yet reported is 10.
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700318 *
319 * Current Wireless USB host hardware (Intel i1480 for example) allows
320 * up to 22 devices to connect. Upcoming hardware might raise that
321 * limit. Because the arrays need to add a bit for hub status data, we
322 * do 31, so plus one evens out to four bytes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 */
inaky@linux.intel.com43705252006-10-11 20:05:58 -0700324#define USB_MAXCHILDREN (31)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326struct usb_tt;
327
328/*
329 * struct usb_device - kernel's representation of a USB device
330 *
331 * FIXME: Write the kerneldoc!
332 *
333 * Usbcore drivers should not set usbdev->state directly. Instead use
334 * usb_set_device_state().
335 */
336struct usb_device {
337 int devnum; /* Address on USB bus */
338 char devpath [16]; /* Use in messages: /port/port/... */
339 enum usb_device_state state; /* configured, not attached, etc */
340 enum usb_device_speed speed; /* high/full/low (or error) */
341
342 struct usb_tt *tt; /* low/full speed dev, highspeed hub */
343 int ttport; /* device port on that tt hub */
344
Alan Sternb724ae72005-10-24 15:36:00 -0400345 unsigned int toggle[2]; /* one bit for each endpoint
346 * ([0] = IN, [1] = OUT) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348 struct usb_device *parent; /* our hub, unless we're the root */
349 struct usb_bus *bus; /* Bus we're part of */
350 struct usb_host_endpoint ep0;
351
352 struct device dev; /* Generic device interface */
353
354 struct usb_device_descriptor descriptor;/* Descriptor */
355 struct usb_host_config *config; /* All of the configs */
356
357 struct usb_host_config *actconfig;/* the active configuration */
358 struct usb_host_endpoint *ep_in[16];
359 struct usb_host_endpoint *ep_out[16];
360
361 char **rawdescriptors; /* Raw descriptors for each config */
362
Alan Stern55c52712005-11-23 12:03:12 -0500363 unsigned short bus_mA; /* Current available from the bus */
Alan Stern12c3da32005-11-23 12:09:52 -0500364 u8 portnum; /* Parent port number (origin 1) */
Alan Sternb6956ff2006-08-30 15:46:48 -0400365 u8 level; /* Number of USB hub ancestors */
Alan Stern55c52712005-11-23 12:03:12 -0500366
Alan Sternee49fb52006-11-22 16:55:54 -0500367 unsigned discon_suspended:1; /* Disconnected while suspended */
Alan Sternce361582006-11-20 11:12:22 -0500368 unsigned have_langid:1; /* whether string_langid is valid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 int string_langid; /* language ID for strings */
370
Alan Stern4f62efe2005-10-24 16:24:14 -0400371 /* static strings from the device */
372 char *product; /* iProduct string, if present */
373 char *manufacturer; /* iManufacturer string, if present */
374 char *serial; /* iSerialNumber string, if present */
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 struct list_head filelist;
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100377#ifdef CONFIG_USB_DEVICE_CLASS
378 struct device *usb_classdev;
379#endif
380#ifdef CONFIG_USB_DEVICEFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 struct dentry *usbfs_dentry; /* usbfs dentry entry for the device */
Kay Sievers9f8b17e2007-03-13 15:59:31 +0100382#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 /*
384 * Child devices - these can be either new devices
385 * (if this is a hub device), or different instances
386 * of this same device.
387 *
388 * Each instance needs its own set of data structures.
389 */
390
391 int maxchild; /* Number of ports if hub */
392 struct usb_device *children[USB_MAXCHILDREN];
Alan Stern645daaa2006-08-30 15:47:02 -0400393
Alan Sterne0318eb2006-09-26 14:50:20 -0400394 int pm_usage_cnt; /* usage counter for autosuspend */
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100395 u32 quirks; /* quirks of the whole device */
Alan Sternb5e795f2007-02-20 15:00:53 -0500396
Alan Stern645daaa2006-08-30 15:47:02 -0400397#ifdef CONFIG_PM
David Howellsc4028952006-11-22 14:57:56 +0000398 struct delayed_work autosuspend; /* for delayed autosuspends */
Alan Stern645daaa2006-08-30 15:47:02 -0400399 struct mutex pm_mutex; /* protects PM operations */
Alan Stern645daaa2006-08-30 15:47:02 -0400400
Alan Stern19410442007-03-27 13:33:59 -0400401 unsigned long last_busy; /* time of last use */
Alan Sterneaafbc32007-03-13 16:39:15 -0400402 int autosuspend_delay; /* in jiffies */
Alan Sternb5e795f2007-02-20 15:00:53 -0500403
Alan Stern645daaa2006-08-30 15:47:02 -0400404 unsigned auto_pm:1; /* autosuspend/resume in progress */
405 unsigned do_remote_wakeup:1; /* remote wakeup should be enabled */
Alan Stern0458d5b2007-05-04 11:52:20 -0400406 unsigned reset_resume:1; /* needs reset instead of resume */
Alan Sternb41a60e2007-05-30 15:39:33 -0400407 unsigned persist_enabled:1; /* USB_PERSIST enabled for this dev */
Alan Stern2add5222007-03-20 14:59:39 -0400408 unsigned autosuspend_disabled:1; /* autosuspend and autoresume */
409 unsigned autoresume_disabled:1; /* disabled by the user */
Alan Stern645daaa2006-08-30 15:47:02 -0400410#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411};
412#define to_usb_device(d) container_of(d, struct usb_device, dev)
413
414extern struct usb_device *usb_get_dev(struct usb_device *dev);
415extern void usb_put_dev(struct usb_device *dev);
416
Alan Stern9ad3d6c2005-11-17 17:10:32 -0500417/* USB device locking */
418#define usb_lock_device(udev) down(&(udev)->dev.sem)
419#define usb_unlock_device(udev) up(&(udev)->dev.sem)
420#define usb_trylock_device(udev) down_trylock(&(udev)->dev.sem)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421extern int usb_lock_device_for_reset(struct usb_device *udev,
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300422 const struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
424/* USB port reset for device reinitialization */
425extern int usb_reset_device(struct usb_device *dev);
Alan Stern79efa092006-06-01 13:33:42 -0400426extern int usb_reset_composite_device(struct usb_device *dev,
427 struct usb_interface *iface);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428
429extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
430
Alan Stern645daaa2006-08-30 15:47:02 -0400431/* USB autosuspend and autoresume */
432#ifdef CONFIG_USB_SUSPEND
Alan Stern692a1862006-10-30 17:07:51 -0500433extern int usb_autopm_set_interface(struct usb_interface *intf);
Alan Stern645daaa2006-08-30 15:47:02 -0400434extern int usb_autopm_get_interface(struct usb_interface *intf);
435extern void usb_autopm_put_interface(struct usb_interface *intf);
436
Alan Stern692a1862006-10-30 17:07:51 -0500437static inline void usb_autopm_enable(struct usb_interface *intf)
438{
439 intf->pm_usage_cnt = 0;
440 usb_autopm_set_interface(intf);
441}
Alan Stern645daaa2006-08-30 15:47:02 -0400442
Alan Stern692a1862006-10-30 17:07:51 -0500443static inline void usb_autopm_disable(struct usb_interface *intf)
444{
445 intf->pm_usage_cnt = 1;
446 usb_autopm_set_interface(intf);
447}
448
Alan Stern19410442007-03-27 13:33:59 -0400449static inline void usb_mark_last_busy(struct usb_device *udev)
450{
451 udev->last_busy = jiffies;
452}
453
Alan Stern692a1862006-10-30 17:07:51 -0500454#else
455
456static inline int usb_autopm_set_interface(struct usb_interface *intf)
457{ return 0; }
458
459static inline int usb_autopm_get_interface(struct usb_interface *intf)
460{ return 0; }
461
462static inline void usb_autopm_put_interface(struct usb_interface *intf)
463{ }
464static inline void usb_autopm_enable(struct usb_interface *intf)
465{ }
466static inline void usb_autopm_disable(struct usb_interface *intf)
467{ }
Alan Stern19410442007-03-27 13:33:59 -0400468static inline void usb_mark_last_busy(struct usb_device *udev)
469{ }
Alan Stern692a1862006-10-30 17:07:51 -0500470#endif
Alan Stern645daaa2006-08-30 15:47:02 -0400471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472/*-------------------------------------------------------------------------*/
473
474/* for drivers using iso endpoints */
475extern int usb_get_current_frame_number (struct usb_device *usb_dev);
476
477/* used these for multi-interface device registration */
478extern int usb_driver_claim_interface(struct usb_driver *driver,
479 struct usb_interface *iface, void* priv);
480
481/**
482 * usb_interface_claimed - returns true iff an interface is claimed
483 * @iface: the interface being checked
484 *
485 * Returns true (nonzero) iff the interface is claimed, else false (zero).
486 * Callers must own the driver model's usb bus readlock. So driver
487 * probe() entries don't need extra locking, but other call contexts
488 * may need to explicitly claim that lock.
489 *
490 */
491static inline int usb_interface_claimed(struct usb_interface *iface) {
492 return (iface->dev.driver != NULL);
493}
494
495extern void usb_driver_release_interface(struct usb_driver *driver,
496 struct usb_interface *iface);
497const struct usb_device_id *usb_match_id(struct usb_interface *interface,
498 const struct usb_device_id *id);
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100499extern int usb_match_one_id(struct usb_interface *interface,
500 const struct usb_device_id *id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
502extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
503 int minor);
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300504extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 unsigned ifnum);
506extern struct usb_host_interface *usb_altnum_to_altsetting(
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -0300507 const struct usb_interface *intf, unsigned int altnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509
510/**
511 * usb_make_path - returns stable device path in the usb tree
512 * @dev: the device whose path is being constructed
513 * @buf: where to put the string
514 * @size: how big is "buf"?
515 *
516 * Returns length of the string (> 0) or negative if size was too small.
517 *
518 * This identifier is intended to be "stable", reflecting physical paths in
519 * hardware such as physical bus addresses for host controllers or ports on
520 * USB hubs. That makes it stay the same until systems are physically
521 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
522 * controllers. Adding and removing devices, including virtual root hubs
523 * in host controller driver modules, does not change these path identifers;
524 * neither does rebooting or re-enumerating. These are more useful identifiers
525 * than changeable ("unstable") ones like bus numbers or device addresses.
526 *
527 * With a partial exception for devices connected to USB 2.0 root hubs, these
528 * identifiers are also predictable. So long as the device tree isn't changed,
529 * plugging any USB device into a given hub port always gives it the same path.
530 * Because of the use of "companion" controllers, devices connected to ports on
531 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
532 * high speed, and a different one if they are full or low speed.
533 */
Alan Sternb724ae72005-10-24 15:36:00 -0400534static inline int usb_make_path (struct usb_device *dev, char *buf,
535 size_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536{
537 int actual;
Alan Sternb724ae72005-10-24 15:36:00 -0400538 actual = snprintf (buf, size, "usb-%s-%s", dev->bus->bus_name,
539 dev->devpath);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 return (actual >= (int)size) ? -1 : actual;
541}
542
543/*-------------------------------------------------------------------------*/
544
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300545/**
546 * usb_endpoint_dir_in - check if the endpoint has IN direction
547 * @epd: endpoint to be checked
548 *
549 * Returns true if the endpoint is of type IN, otherwise it returns false.
550 */
551static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
552{
553 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
554}
555
556/**
557 * usb_endpoint_dir_out - check if the endpoint has OUT direction
558 * @epd: endpoint to be checked
559 *
560 * Returns true if the endpoint is of type OUT, otherwise it returns false.
561 */
562static inline int usb_endpoint_dir_out(const struct usb_endpoint_descriptor *epd)
563{
564 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
565}
566
567/**
568 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
569 * @epd: endpoint to be checked
570 *
571 * Returns true if the endpoint is of type bulk, otherwise it returns false.
572 */
573static inline int usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor *epd)
574{
575 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
576 USB_ENDPOINT_XFER_BULK);
577}
578
579/**
Sarah Baileya8ef36b2006-12-23 23:14:58 -0800580 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
581 * @epd: endpoint to be checked
582 *
583 * Returns true if the endpoint is of type control, otherwise it returns false.
584 */
585static inline int usb_endpoint_xfer_control(const struct usb_endpoint_descriptor *epd)
586{
587 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
588 USB_ENDPOINT_XFER_CONTROL);
589}
590
591/**
Luiz Fernando N. Capitulino0c1ac4f2006-10-30 14:53:03 -0300592 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
593 * @epd: endpoint to be checked
594 *
595 * Returns true if the endpoint is of type interrupt, otherwise it returns
596 * false.
597 */
598static inline int usb_endpoint_xfer_int(const struct usb_endpoint_descriptor *epd)
599{
600 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
601 USB_ENDPOINT_XFER_INT);
602}
603
604/**
605 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
606 * @epd: endpoint to be checked
607 *
608 * Returns true if the endpoint is of type isochronous, otherwise it returns
609 * false.
610 */
611static inline int usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor *epd)
612{
613 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
614 USB_ENDPOINT_XFER_ISOC);
615}
616
617/**
618 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
619 * @epd: endpoint to be checked
620 *
621 * Returns true if the endpoint has bulk transfer type and IN direction,
622 * otherwise it returns false.
623 */
624static inline int usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor *epd)
625{
626 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
627}
628
629/**
630 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
631 * @epd: endpoint to be checked
632 *
633 * Returns true if the endpoint has bulk transfer type and OUT direction,
634 * otherwise it returns false.
635 */
636static inline int usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor *epd)
637{
638 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
639}
640
641/**
642 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
643 * @epd: endpoint to be checked
644 *
645 * Returns true if the endpoint has interrupt transfer type and IN direction,
646 * otherwise it returns false.
647 */
648static inline int usb_endpoint_is_int_in(const struct usb_endpoint_descriptor *epd)
649{
650 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
651}
652
653/**
654 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
655 * @epd: endpoint to be checked
656 *
657 * Returns true if the endpoint has interrupt transfer type and OUT direction,
658 * otherwise it returns false.
659 */
660static inline int usb_endpoint_is_int_out(const struct usb_endpoint_descriptor *epd)
661{
662 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
663}
664
665/**
666 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
667 * @epd: endpoint to be checked
668 *
669 * Returns true if the endpoint has isochronous transfer type and IN direction,
670 * otherwise it returns false.
671 */
672static inline int usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor *epd)
673{
674 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
675}
676
677/**
678 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
679 * @epd: endpoint to be checked
680 *
681 * Returns true if the endpoint has isochronous transfer type and OUT direction,
682 * otherwise it returns false.
683 */
684static inline int usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor *epd)
685{
686 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
687}
Luiz Fernando N. Capitulinob7cfaaa2006-09-27 11:58:53 -0700688
689/*-------------------------------------------------------------------------*/
690
Alan Sternb724ae72005-10-24 15:36:00 -0400691#define USB_DEVICE_ID_MATCH_DEVICE \
692 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
693#define USB_DEVICE_ID_MATCH_DEV_RANGE \
694 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
695#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
696 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697#define USB_DEVICE_ID_MATCH_DEV_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400698 (USB_DEVICE_ID_MATCH_DEV_CLASS | \
699 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
700 USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701#define USB_DEVICE_ID_MATCH_INT_INFO \
Alan Sternb724ae72005-10-24 15:36:00 -0400702 (USB_DEVICE_ID_MATCH_INT_CLASS | \
703 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
704 USB_DEVICE_ID_MATCH_INT_PROTOCOL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
706/**
707 * USB_DEVICE - macro used to describe a specific usb device
708 * @vend: the 16 bit USB Vendor ID
709 * @prod: the 16 bit USB Product ID
710 *
711 * This macro is used to create a struct usb_device_id that matches a
712 * specific device.
713 */
714#define USB_DEVICE(vend,prod) \
Alan Sternb724ae72005-10-24 15:36:00 -0400715 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \
716 .idProduct = (prod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717/**
Alan Sternb724ae72005-10-24 15:36:00 -0400718 * USB_DEVICE_VER - macro used to describe a specific usb device with a
719 * version range
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 * @vend: the 16 bit USB Vendor ID
721 * @prod: the 16 bit USB Product ID
722 * @lo: the bcdDevice_lo value
723 * @hi: the bcdDevice_hi value
724 *
725 * This macro is used to create a struct usb_device_id that matches a
726 * specific device, with a version range.
727 */
728#define USB_DEVICE_VER(vend,prod,lo,hi) \
Alan Sternb724ae72005-10-24 15:36:00 -0400729 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
730 .idVendor = (vend), .idProduct = (prod), \
731 .bcdDevice_lo = (lo), .bcdDevice_hi = (hi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
733/**
Jan Kratochvilf836ac82007-05-09 00:26:15 -0400734 * USB_DEVICE_INTERFACE_PROTOCOL - macro used to describe a usb
735 * device with a specific interface protocol
736 * @vend: the 16 bit USB Vendor ID
737 * @prod: the 16 bit USB Product ID
738 * @pr: bInterfaceProtocol value
739 *
740 * This macro is used to create a struct usb_device_id that matches a
741 * specific interface protocol of devices.
742 */
743#define USB_DEVICE_INTERFACE_PROTOCOL(vend,prod,pr) \
744 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
745 .idVendor = (vend), \
746 .idProduct = (prod), \
747 .bInterfaceProtocol = (pr)
748
749/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 * USB_DEVICE_INFO - macro used to describe a class of usb devices
751 * @cl: bDeviceClass value
752 * @sc: bDeviceSubClass value
753 * @pr: bDeviceProtocol value
754 *
755 * This macro is used to create a struct usb_device_id that matches a
756 * specific class of devices.
757 */
758#define USB_DEVICE_INFO(cl,sc,pr) \
Alan Sternb724ae72005-10-24 15:36:00 -0400759 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, .bDeviceClass = (cl), \
760 .bDeviceSubClass = (sc), .bDeviceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
762/**
763 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
764 * @cl: bInterfaceClass value
765 * @sc: bInterfaceSubClass value
766 * @pr: bInterfaceProtocol value
767 *
768 * This macro is used to create a struct usb_device_id that matches a
769 * specific class of interfaces.
770 */
771#define USB_INTERFACE_INFO(cl,sc,pr) \
Alan Sternb724ae72005-10-24 15:36:00 -0400772 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, .bInterfaceClass = (cl), \
773 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Daniel Drake8538f962007-05-10 00:32:24 +0100775/**
776 * USB_DEVICE_AND_INTERFACE_INFO - macro used to describe a specific usb device
777 * with a class of usb interfaces
778 * @vend: the 16 bit USB Vendor ID
779 * @prod: the 16 bit USB Product ID
780 * @cl: bInterfaceClass value
781 * @sc: bInterfaceSubClass value
782 * @pr: bInterfaceProtocol value
783 *
784 * This macro is used to create a struct usb_device_id that matches a
785 * specific device with a specific class of interfaces.
786 *
787 * This is especially useful when explicitly matching devices that have
788 * vendor specific bDeviceClass values, but standards-compliant interfaces.
789 */
790#define USB_DEVICE_AND_INTERFACE_INFO(vend,prod,cl,sc,pr) \
791 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
792 | USB_DEVICE_ID_MATCH_DEVICE, \
793 .idVendor = (vend), .idProduct = (prod), \
794 .bInterfaceClass = (cl), \
795 .bInterfaceSubClass = (sc), .bInterfaceProtocol = (pr)
796
Alan Sternb724ae72005-10-24 15:36:00 -0400797/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100799/* Stuff for dynamic usb ids */
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800800struct usb_dynids {
801 spinlock_t lock;
802 struct list_head list;
803};
804
Greg Kroah-Hartman93bacef2006-12-17 21:50:23 +0100805struct usb_dynid {
806 struct list_head node;
807 struct usb_device_id id;
808};
809
810extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
811 struct device_driver *driver,
812 const char *buf, size_t count);
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814/**
Alan Stern8bb54ab2006-07-01 22:08:49 -0400815 * struct usbdrv_wrap - wrapper for driver-model structure
816 * @driver: The driver-model core driver structure.
817 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
818 */
819struct usbdrv_wrap {
820 struct device_driver driver;
821 int for_devices;
822};
823
824/**
825 * struct usb_driver - identifies USB interface driver to usbcore
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 * @name: The driver name should be unique among USB drivers,
827 * and should normally be the same as the module name.
828 * @probe: Called to see if the driver is willing to manage a particular
829 * interface on a device. If it is, probe returns zero and uses
830 * dev_set_drvdata() to associate driver-specific data with the
831 * interface. It may also use usb_set_interface() to specify the
832 * appropriate altsetting. If unwilling to manage the interface,
833 * return a negative errno value.
834 * @disconnect: Called when the interface is no longer accessible, usually
835 * because its device has been (or is being) disconnected or the
836 * driver module is being unloaded.
837 * @ioctl: Used for drivers that want to talk to userspace through
838 * the "usbfs" filesystem. This lets devices provide ways to
839 * expose information to user space regardless of where they
840 * do (or don't) show up otherwise in the filesystem.
841 * @suspend: Called when the device is going to be suspended by the system.
842 * @resume: Called when the device is being resumed by the system.
Alan Sternf07600c2007-05-30 15:38:16 -0400843 * @reset_resume: Called when the suspended device has been reset instead
844 * of being resumed.
Alan Stern79efa092006-06-01 13:33:42 -0400845 * @pre_reset: Called by usb_reset_composite_device() when the device
846 * is about to be reset.
847 * @post_reset: Called by usb_reset_composite_device() after the device
Alan Stern0458d5b2007-05-04 11:52:20 -0400848 * has been reset, or in lieu of @resume following a reset-resume
849 * (i.e., the device is reset instead of being resumed, as might
850 * happen if power was lost). The second argument tells which is
851 * the reason.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 * @id_table: USB drivers use ID table to support hotplugging.
853 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set
854 * or your driver's probe function will never get called.
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800855 * @dynids: used internally to hold the list of dynamically added device
856 * ids for this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400857 * @drvwrap: Driver-model core structure wrapper.
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800858 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
859 * added to this driver by preventing the sysfs file from being created.
Alan Stern645daaa2006-08-30 15:47:02 -0400860 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
861 * for interfaces bound to this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 *
Alan Stern8bb54ab2006-07-01 22:08:49 -0400863 * USB interface drivers must provide a name, probe() and disconnect()
864 * methods, and an id_table. Other driver fields are optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 *
866 * The id_table is used in hotplugging. It holds a set of descriptors,
867 * and specialized data may be associated with each entry. That table
868 * is used by both user and kernel mode hotplugging support.
869 *
870 * The probe() and disconnect() methods are called in a context where
871 * they can sleep, but they should avoid abusing the privilege. Most
872 * work to connect to a device should be done when the device is opened,
873 * and undone at the last close. The disconnect code needs to address
874 * concurrency issues with respect to open() and close() methods, as
875 * well as forcing all pending I/O requests to complete (by unlinking
876 * them as necessary, and blocking until the unlinks complete).
877 */
878struct usb_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 const char *name;
880
881 int (*probe) (struct usb_interface *intf,
882 const struct usb_device_id *id);
883
884 void (*disconnect) (struct usb_interface *intf);
885
Alan Sternb724ae72005-10-24 15:36:00 -0400886 int (*ioctl) (struct usb_interface *intf, unsigned int code,
887 void *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
David Brownell27d72e82005-04-18 17:39:22 -0700889 int (*suspend) (struct usb_interface *intf, pm_message_t message);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 int (*resume) (struct usb_interface *intf);
Alan Sternf07600c2007-05-30 15:38:16 -0400891 int (*reset_resume)(struct usb_interface *intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
Alan Sternf07600c2007-05-30 15:38:16 -0400893 int (*pre_reset)(struct usb_interface *intf);
894 int (*post_reset)(struct usb_interface *intf);
Alan Stern79efa092006-06-01 13:33:42 -0400895
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 const struct usb_device_id *id_table;
897
Greg Kroah-Hartman733260f2005-11-16 13:41:28 -0800898 struct usb_dynids dynids;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400899 struct usbdrv_wrap drvwrap;
Greg Kroah-Hartmanba9dc652005-11-16 13:41:28 -0800900 unsigned int no_dynamic_id:1;
Alan Stern645daaa2006-08-30 15:47:02 -0400901 unsigned int supports_autosuspend:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902};
Alan Stern8bb54ab2006-07-01 22:08:49 -0400903#define to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)
904
905/**
906 * struct usb_device_driver - identifies USB device driver to usbcore
907 * @name: The driver name should be unique among USB drivers,
908 * and should normally be the same as the module name.
909 * @probe: Called to see if the driver is willing to manage a particular
910 * device. If it is, probe returns zero and uses dev_set_drvdata()
911 * to associate driver-specific data with the device. If unwilling
912 * to manage the device, return a negative errno value.
913 * @disconnect: Called when the device is no longer accessible, usually
914 * because it has been (or is being) disconnected or the driver's
915 * module is being unloaded.
916 * @suspend: Called when the device is going to be suspended by the system.
917 * @resume: Called when the device is being resumed by the system.
918 * @drvwrap: Driver-model core structure wrapper.
Alan Stern645daaa2006-08-30 15:47:02 -0400919 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
920 * for devices bound to this driver.
Alan Stern8bb54ab2006-07-01 22:08:49 -0400921 *
922 * USB drivers must provide all the fields listed above except drvwrap.
923 */
924struct usb_device_driver {
925 const char *name;
926
927 int (*probe) (struct usb_device *udev);
928 void (*disconnect) (struct usb_device *udev);
929
930 int (*suspend) (struct usb_device *udev, pm_message_t message);
931 int (*resume) (struct usb_device *udev);
932 struct usbdrv_wrap drvwrap;
Alan Stern645daaa2006-08-30 15:47:02 -0400933 unsigned int supports_autosuspend:1;
Alan Stern8bb54ab2006-07-01 22:08:49 -0400934};
935#define to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
936 drvwrap.driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
938extern struct bus_type usb_bus_type;
939
940/**
941 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700942 * @name: the usb class device name for this driver. Will show up in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 * @fops: pointer to the struct file_operations of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 * @minor_base: the start of the minor range for this driver.
945 *
946 * This structure is used for the usb_register_dev() and
947 * usb_unregister_dev() functions, to consolidate a number of the
948 * parameters used for them.
949 */
950struct usb_class_driver {
951 char *name;
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800952 const struct file_operations *fops;
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -0700953 int minor_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954};
955
956/*
957 * use these in module_init()/module_exit()
958 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
959 */
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800960extern int usb_register_driver(struct usb_driver *, struct module *,
961 const char *);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800962static inline int usb_register(struct usb_driver *driver)
963{
Greg Kroah-Hartman80f745f2007-01-15 11:50:02 -0800964 return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
Greg Kroah-Hartman2143acc2005-11-21 14:53:03 -0800965}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966extern void usb_deregister(struct usb_driver *);
967
Alan Stern8bb54ab2006-07-01 22:08:49 -0400968extern int usb_register_device_driver(struct usb_device_driver *,
969 struct module *);
970extern void usb_deregister_device_driver(struct usb_device_driver *);
971
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972extern int usb_register_dev(struct usb_interface *intf,
973 struct usb_class_driver *class_driver);
974extern void usb_deregister_dev(struct usb_interface *intf,
975 struct usb_class_driver *class_driver);
976
977extern int usb_disabled(void);
978
Alan Sternb724ae72005-10-24 15:36:00 -0400979/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
981/*
982 * URB support, for asynchronous request completions
983 */
984
985/*
986 * urb->transfer_flags:
987 */
988#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */
Alan Sternb724ae72005-10-24 15:36:00 -0400989#define URB_ISO_ASAP 0x0002 /* iso-only, urb->start_frame
990 * ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */
992#define URB_NO_SETUP_DMA_MAP 0x0008 /* urb->setup_dma valid on submit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993#define URB_NO_FSBR 0x0020 /* UHCI-specific */
Alan Sternb724ae72005-10-24 15:36:00 -0400994#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */
995#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt
996 * needed */
Marcel Holtmann8b3b01c2007-06-13 08:02:11 +0200997#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
999struct usb_iso_packet_descriptor {
1000 unsigned int offset;
1001 unsigned int length; /* expected length */
1002 unsigned int actual_length;
Pete Zaitcevd1bbb602007-02-11 13:56:13 -08001003 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004};
1005
1006struct urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007
Oliver Neukum51a2f072007-05-25 13:40:56 +02001008struct usb_anchor {
1009 struct list_head urb_list;
1010 wait_queue_head_t wait;
1011 spinlock_t lock;
1012};
1013
1014static inline void init_usb_anchor(struct usb_anchor *anchor)
1015{
1016 INIT_LIST_HEAD(&anchor->urb_list);
1017 init_waitqueue_head(&anchor->wait);
1018 spin_lock_init(&anchor->lock);
1019}
1020
David Howells7d12e782006-10-05 14:55:46 +01001021typedef void (*usb_complete_t)(struct urb *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
1023/**
1024 * struct urb - USB Request Block
1025 * @urb_list: For use by current owner of the URB.
Oliver Neukum51a2f072007-05-25 13:40:56 +02001026 * @anchor_list: membership in the list of an anchor
1027 * @anchor: to anchor URBs to a common mooring
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 * @pipe: Holds endpoint number, direction, type, and more.
1029 * Create these values with the eight macros available;
1030 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
1031 * (control), "bulk", "int" (interrupt), or "iso" (isochronous).
1032 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint
1033 * numbers range from zero to fifteen. Note that "in" endpoint two
1034 * is a different endpoint (and pipe) from "out" endpoint two.
1035 * The current configuration controls the existence, type, and
1036 * maximum packet size of any given endpoint.
1037 * @dev: Identifies the USB device to perform the request.
1038 * @status: This is read in non-iso completion functions to get the
1039 * status of the particular request. ISO requests only use it
1040 * to tell whether the URB was unlinked; detailed status for
1041 * each frame is in the fields of the iso_frame-desc.
1042 * @transfer_flags: A variety of flags may be used to affect how URB
1043 * submission, unlinking, or operation are handled. Different
1044 * kinds of URB can use different flags.
1045 * @transfer_buffer: This identifies the buffer to (or from) which
1046 * the I/O request will be performed (unless URB_NO_TRANSFER_DMA_MAP
1047 * is set). This buffer must be suitable for DMA; allocate it with
1048 * kmalloc() or equivalent. For transfers to "in" endpoints, contents
1049 * of this buffer will be modified. This buffer is used for the data
1050 * stage of control transfers.
1051 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
1052 * the device driver is saying that it provided this DMA address,
1053 * which the host controller driver should use in preference to the
1054 * transfer_buffer.
1055 * @transfer_buffer_length: How big is transfer_buffer. The transfer may
1056 * be broken up into chunks according to the current maximum packet
1057 * size for the endpoint, which is a function of the configuration
1058 * and is encoded in the pipe. When the length is zero, neither
1059 * transfer_buffer nor transfer_dma is used.
1060 * @actual_length: This is read in non-iso completion functions, and
1061 * it tells how many bytes (out of transfer_buffer_length) were
1062 * transferred. It will normally be the same as requested, unless
1063 * either an error was reported or a short read was performed.
1064 * The URB_SHORT_NOT_OK transfer flag may be used to make such
1065 * short reads be reported as errors.
1066 * @setup_packet: Only used for control transfers, this points to eight bytes
1067 * of setup data. Control transfers always start by sending this data
1068 * to the device. Then transfer_buffer is read or written, if needed.
1069 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
1070 * device driver has provided this DMA address for the setup packet.
1071 * The host controller driver should use this in preference to
1072 * setup_packet.
1073 * @start_frame: Returns the initial frame for isochronous transfers.
1074 * @number_of_packets: Lists the number of ISO transfer buffers.
1075 * @interval: Specifies the polling interval for interrupt or isochronous
1076 * transfers. The units are frames (milliseconds) for for full and low
1077 * speed devices, and microframes (1/8 millisecond) for highspeed ones.
1078 * @error_count: Returns the number of ISO transfers that reported errors.
1079 * @context: For use in completion functions. This normally points to
1080 * request-specific driver context.
1081 * @complete: Completion handler. This URB is passed as the parameter to the
1082 * completion function. The completion function may then do what
1083 * it likes with the URB, including resubmitting or freeing it.
1084 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
1085 * collect the transfer status for each buffer.
1086 *
1087 * This structure identifies USB transfer requests. URBs must be allocated by
1088 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
1089 * Initialization may be done using various usb_fill_*_urb() functions. URBs
1090 * are submitted using usb_submit_urb(), and pending requests may be canceled
1091 * using usb_unlink_urb() or usb_kill_urb().
1092 *
1093 * Data Transfer Buffers:
1094 *
1095 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
1096 * taken from the general page pool. That is provided by transfer_buffer
1097 * (control requests also use setup_packet), and host controller drivers
1098 * perform a dma mapping (and unmapping) for each buffer transferred. Those
1099 * mapping operations can be expensive on some platforms (perhaps using a dma
1100 * bounce buffer or talking to an IOMMU),
1101 * although they're cheap on commodity x86 and ppc hardware.
1102 *
1103 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
1104 * which tell the host controller driver that no such mapping is needed since
1105 * the device driver is DMA-aware. For example, a device driver might
1106 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
1107 * When these transfer flags are provided, host controller drivers will
1108 * attempt to use the dma addresses found in the transfer_dma and/or
1109 * setup_dma fields rather than determining a dma address themselves. (Note
1110 * that transfer_buffer and setup_packet must still be set because not all
1111 * host controllers use DMA, nor do virtual root hubs).
1112 *
1113 * Initialization:
1114 *
1115 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
Alan Sternb375a042005-07-29 16:11:07 -04001116 * zero), and complete fields. All URBs must also initialize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 * transfer_buffer and transfer_buffer_length. They may provide the
1118 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
1119 * to be treated as errors; that flag is invalid for write requests.
1120 *
1121 * Bulk URBs may
1122 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
1123 * should always terminate with a short packet, even if it means adding an
1124 * extra zero length packet.
1125 *
1126 * Control URBs must provide a setup_packet. The setup_packet and
1127 * transfer_buffer may each be mapped for DMA or not, independently of
1128 * the other. The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
1129 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
1130 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
1131 *
1132 * Interrupt URBs must provide an interval, saying how often (in milliseconds
1133 * or, for highspeed devices, 125 microsecond units)
1134 * to poll for transfers. After the URB has been submitted, the interval
1135 * field reflects how the transfer was actually scheduled.
1136 * The polling interval may be more frequent than requested.
1137 * For example, some controllers have a maximum interval of 32 milliseconds,
1138 * while others support intervals of up to 1024 milliseconds.
1139 * Isochronous URBs also have transfer intervals. (Note that for isochronous
1140 * endpoints, as well as high speed interrupt endpoints, the encoding of
1141 * the transfer interval in the endpoint descriptor is logarithmic.
1142 * Device drivers must convert that value to linear units themselves.)
1143 *
1144 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
1145 * the host controller to schedule the transfer as soon as bandwidth
1146 * utilization allows, and then set start_frame to reflect the actual frame
1147 * selected during submission. Otherwise drivers must specify the start_frame
1148 * and handle the case where the transfer can't begin then. However, drivers
1149 * won't know how bandwidth is currently allocated, and while they can
1150 * find the current frame using usb_get_current_frame_number () they can't
1151 * know the range for that frame number. (Ranges for frame counter values
1152 * are HC-specific, and can go from 256 to 65536 frames from "now".)
1153 *
1154 * Isochronous URBs have a different data transfer model, in part because
1155 * the quality of service is only "best effort". Callers provide specially
1156 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
1157 * at the end. Each such packet is an individual ISO transfer. Isochronous
1158 * URBs are normally queued, submitted by drivers to arrange that
1159 * transfers are at least double buffered, and then explicitly resubmitted
1160 * in completion handlers, so
1161 * that data (such as audio or video) streams at as constant a rate as the
1162 * host controller scheduler can support.
1163 *
1164 * Completion Callbacks:
1165 *
1166 * The completion callback is made in_interrupt(), and one of the first
1167 * things that a completion handler should do is check the status field.
1168 * The status field is provided for all URBs. It is used to report
1169 * unlinked URBs, and status for all non-ISO transfers. It should not
1170 * be examined before the URB is returned to the completion handler.
1171 *
1172 * The context field is normally used to link URBs back to the relevant
1173 * driver or request state.
1174 *
1175 * When the completion callback is invoked for non-isochronous URBs, the
1176 * actual_length field tells how many bytes were transferred. This field
1177 * is updated even when the URB terminated with an error or was unlinked.
1178 *
1179 * ISO transfer status is reported in the status and actual_length fields
1180 * of the iso_frame_desc array, and the number of errors is reported in
1181 * error_count. Completion callbacks for ISO transfers will normally
1182 * (re)submit URBs to ensure a constant transfer rate.
Roman Kagan719df462005-05-06 00:55:56 +04001183 *
1184 * Note that even fields marked "public" should not be touched by the driver
1185 * when the urb is owned by the hcd, that is, since the call to
1186 * usb_submit_urb() till the entry into the completion routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 */
1188struct urb
1189{
Martin Waitzaeec46b2005-11-13 16:08:13 -08001190 /* private: usb core and host controller only fields in the urb */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 struct kref kref; /* reference count of the URB */
1192 spinlock_t lock; /* lock for the URB */
1193 void *hcpriv; /* private data for host controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 atomic_t use_count; /* concurrent submissions counter */
1195 u8 reject; /* submissions will fail */
1196
Martin Waitzaeec46b2005-11-13 16:08:13 -08001197 /* public: documented fields in the urb that can be used by drivers */
Alan Sternb724ae72005-10-24 15:36:00 -04001198 struct list_head urb_list; /* list head for use by the urb's
1199 * current owner */
Oliver Neukum51a2f072007-05-25 13:40:56 +02001200 struct list_head anchor_list; /* the URB may be anchored by the driver */
1201 struct usb_anchor *anchor;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 struct usb_device *dev; /* (in) pointer to associated device */
1203 unsigned int pipe; /* (in) pipe information */
1204 int status; /* (return) non-ISO status */
1205 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/
1206 void *transfer_buffer; /* (in) associated data buffer */
1207 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */
1208 int transfer_buffer_length; /* (in) data buffer length */
1209 int actual_length; /* (return) actual transfer length */
1210 unsigned char *setup_packet; /* (in) setup packet (control only) */
1211 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */
1212 int start_frame; /* (modify) start frame (ISO) */
1213 int number_of_packets; /* (in) number of ISO packets */
Alan Sternb724ae72005-10-24 15:36:00 -04001214 int interval; /* (modify) transfer interval
1215 * (INT/ISO) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 int error_count; /* (return) number of ISO errors */
1217 void *context; /* (in) context for completion */
1218 usb_complete_t complete; /* (in) completion routine */
Alan Sternb724ae72005-10-24 15:36:00 -04001219 struct usb_iso_packet_descriptor iso_frame_desc[0];
1220 /* (in) ISO ONLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221};
1222
Alan Sternb724ae72005-10-24 15:36:00 -04001223/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
1225/**
1226 * usb_fill_control_urb - initializes a control urb
1227 * @urb: pointer to the urb to initialize.
1228 * @dev: pointer to the struct usb_device for this urb.
1229 * @pipe: the endpoint pipe
1230 * @setup_packet: pointer to the setup_packet buffer
1231 * @transfer_buffer: pointer to the transfer buffer
1232 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001233 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 * @context: what to set the urb context to.
1235 *
1236 * Initializes a control urb with the proper information needed to submit
1237 * it to a device.
1238 */
1239static inline void usb_fill_control_urb (struct urb *urb,
1240 struct usb_device *dev,
1241 unsigned int pipe,
1242 unsigned char *setup_packet,
1243 void *transfer_buffer,
1244 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001245 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 void *context)
1247{
1248 spin_lock_init(&urb->lock);
1249 urb->dev = dev;
1250 urb->pipe = pipe;
1251 urb->setup_packet = setup_packet;
1252 urb->transfer_buffer = transfer_buffer;
1253 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001254 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 urb->context = context;
1256}
1257
1258/**
1259 * usb_fill_bulk_urb - macro to help initialize a bulk urb
1260 * @urb: pointer to the urb to initialize.
1261 * @dev: pointer to the struct usb_device for this urb.
1262 * @pipe: the endpoint pipe
1263 * @transfer_buffer: pointer to the transfer buffer
1264 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001265 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 * @context: what to set the urb context to.
1267 *
1268 * Initializes a bulk urb with the proper information needed to submit it
1269 * to a device.
1270 */
1271static inline void usb_fill_bulk_urb (struct urb *urb,
1272 struct usb_device *dev,
1273 unsigned int pipe,
1274 void *transfer_buffer,
1275 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001276 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 void *context)
1278{
1279 spin_lock_init(&urb->lock);
1280 urb->dev = dev;
1281 urb->pipe = pipe;
1282 urb->transfer_buffer = transfer_buffer;
1283 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001284 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 urb->context = context;
1286}
1287
1288/**
1289 * usb_fill_int_urb - macro to help initialize a interrupt urb
1290 * @urb: pointer to the urb to initialize.
1291 * @dev: pointer to the struct usb_device for this urb.
1292 * @pipe: the endpoint pipe
1293 * @transfer_buffer: pointer to the transfer buffer
1294 * @buffer_length: length of the transfer buffer
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001295 * @complete_fn: pointer to the usb_complete_t function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 * @context: what to set the urb context to.
1297 * @interval: what to set the urb interval to, encoded like
1298 * the endpoint descriptor's bInterval value.
1299 *
1300 * Initializes a interrupt urb with the proper information needed to submit
1301 * it to a device.
1302 * Note that high speed interrupt endpoints use a logarithmic encoding of
1303 * the endpoint interval, and express polling intervals in microframes
1304 * (eight per millisecond) rather than in frames (one per millisecond).
1305 */
1306static inline void usb_fill_int_urb (struct urb *urb,
1307 struct usb_device *dev,
1308 unsigned int pipe,
1309 void *transfer_buffer,
1310 int buffer_length,
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001311 usb_complete_t complete_fn,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 void *context,
1313 int interval)
1314{
1315 spin_lock_init(&urb->lock);
1316 urb->dev = dev;
1317 urb->pipe = pipe;
1318 urb->transfer_buffer = transfer_buffer;
1319 urb->transfer_buffer_length = buffer_length;
Jesper Juhl3d5b2512006-07-30 18:43:43 +02001320 urb->complete = complete_fn;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 urb->context = context;
1322 if (dev->speed == USB_SPEED_HIGH)
1323 urb->interval = 1 << (interval - 1);
1324 else
1325 urb->interval = interval;
1326 urb->start_frame = -1;
1327}
1328
1329extern void usb_init_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001330extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331extern void usb_free_urb(struct urb *urb);
1332#define usb_put_urb usb_free_urb
1333extern struct urb *usb_get_urb(struct urb *urb);
Al Viro55016f12005-10-21 03:21:58 -04001334extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335extern int usb_unlink_urb(struct urb *urb);
1336extern void usb_kill_urb(struct urb *urb);
Oliver Neukum51a2f072007-05-25 13:40:56 +02001337extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
1338extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
1339extern void usb_unanchor_urb(struct urb *urb);
1340extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
1341 unsigned int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343void *usb_buffer_alloc (struct usb_device *dev, size_t size,
Al Viro55016f12005-10-21 03:21:58 -04001344 gfp_t mem_flags, dma_addr_t *dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345void usb_buffer_free (struct usb_device *dev, size_t size,
1346 void *addr, dma_addr_t dma);
1347
1348#if 0
1349struct urb *usb_buffer_map (struct urb *urb);
1350void usb_buffer_dmasync (struct urb *urb);
1351void usb_buffer_unmap (struct urb *urb);
1352#endif
1353
1354struct scatterlist;
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001355int usb_buffer_map_sg(const struct usb_device *dev, unsigned pipe,
1356 struct scatterlist *sg, int nents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357#if 0
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001358void usb_buffer_dmasync_sg(const struct usb_device *dev, unsigned pipe,
1359 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360#endif
Luiz Fernando N. Capitulino095bc332006-08-26 23:48:11 -03001361void usb_buffer_unmap_sg(const struct usb_device *dev, unsigned pipe,
1362 struct scatterlist *sg, int n_hw_ents);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
1364/*-------------------------------------------------------------------*
1365 * SYNCHRONOUS CALL SUPPORT *
1366 *-------------------------------------------------------------------*/
1367
1368extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
1369 __u8 request, __u8 requesttype, __u16 value, __u16 index,
1370 void *data, __u16 size, int timeout);
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -07001371extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
1372 void *data, int len, int *actual_length, int timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
1374 void *data, int len, int *actual_length,
1375 int timeout);
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377/* wrappers around usb_control_msg() for the most common standard requests */
1378extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
1379 unsigned char descindex, void *buf, int size);
1380extern int usb_get_status(struct usb_device *dev,
1381 int type, int target, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382extern int usb_string(struct usb_device *dev, int index,
1383 char *buf, size_t size);
1384
1385/* wrappers that also update important state inside usbcore */
1386extern int usb_clear_halt(struct usb_device *dev, int pipe);
1387extern int usb_reset_configuration(struct usb_device *dev);
1388extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1389
Alan Stern088dc272006-08-21 12:08:19 -04001390/* this request isn't really synchronous, but it belongs with the others */
1391extern int usb_driver_set_configuration(struct usb_device *udev, int config);
1392
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393/*
1394 * timeouts, in milliseconds, used for sending/receiving control messages
1395 * they typically complete within a few frames (msec) after they're issued
1396 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
1397 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
1398 */
1399#define USB_CTRL_GET_TIMEOUT 5000
1400#define USB_CTRL_SET_TIMEOUT 5000
1401
1402
1403/**
1404 * struct usb_sg_request - support for scatter/gather I/O
1405 * @status: zero indicates success, else negative errno
1406 * @bytes: counts bytes transferred.
1407 *
1408 * These requests are initialized using usb_sg_init(), and then are used
1409 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most
1410 * members of the request object aren't for driver access.
1411 *
1412 * The status and bytecount values are valid only after usb_sg_wait()
1413 * returns. If the status is zero, then the bytecount matches the total
1414 * from the request.
1415 *
1416 * After an error completion, drivers may need to clear a halt condition
1417 * on the endpoint.
1418 */
1419struct usb_sg_request {
1420 int status;
1421 size_t bytes;
1422
1423 /*
Martin Waitzaeec46b2005-11-13 16:08:13 -08001424 * members below are private: to usbcore,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 * and are not provided for driver access!
1426 */
1427 spinlock_t lock;
1428
1429 struct usb_device *dev;
1430 int pipe;
1431 struct scatterlist *sg;
1432 int nents;
1433
1434 int entries;
1435 struct urb **urbs;
1436
1437 int count;
1438 struct completion complete;
1439};
1440
1441int usb_sg_init (
1442 struct usb_sg_request *io,
1443 struct usb_device *dev,
1444 unsigned pipe,
1445 unsigned period,
1446 struct scatterlist *sg,
1447 int nents,
1448 size_t length,
Al Viro55016f12005-10-21 03:21:58 -04001449 gfp_t mem_flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450);
1451void usb_sg_cancel (struct usb_sg_request *io);
1452void usb_sg_wait (struct usb_sg_request *io);
1453
1454
Alan Sternb724ae72005-10-24 15:36:00 -04001455/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
1457/*
1458 * For various legacy reasons, Linux has a small cookie that's paired with
1459 * a struct usb_device to identify an endpoint queue. Queue characteristics
1460 * are defined by the endpoint's descriptor. This cookie is called a "pipe",
1461 * an unsigned int encoded as:
1462 *
1463 * - direction: bit 7 (0 = Host-to-Device [Out],
1464 * 1 = Device-to-Host [In] ...
1465 * like endpoint bEndpointAddress)
1466 * - device address: bits 8-14 ... bit positions known to uhci-hcd
1467 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd
1468 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
1469 * 10 = control, 11 = bulk)
1470 *
1471 * Given the device address and endpoint descriptor, pipes are redundant.
1472 */
1473
1474/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */
1475/* (yet ... they're the values used by usbfs) */
1476#define PIPE_ISOCHRONOUS 0
1477#define PIPE_INTERRUPT 1
1478#define PIPE_CONTROL 2
1479#define PIPE_BULK 3
1480
1481#define usb_pipein(pipe) ((pipe) & USB_DIR_IN)
1482#define usb_pipeout(pipe) (!usb_pipein(pipe))
1483
1484#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
1485#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
1486
1487#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
1488#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
1489#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
1490#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
1491#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
1492
1493/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
1494#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
1495#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
Alan Sternb724ae72005-10-24 15:36:00 -04001496#define usb_settoggle(dev, ep, out, bit) \
1497 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
1498 ((bit) << (ep)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
1500
Alan Sternb724ae72005-10-24 15:36:00 -04001501static inline unsigned int __create_pipe(struct usb_device *dev,
1502 unsigned int endpoint)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503{
1504 return (dev->devnum << 8) | (endpoint << 15);
1505}
1506
1507/* Create various pipes... */
Alan Sternb724ae72005-10-24 15:36:00 -04001508#define usb_sndctrlpipe(dev,endpoint) \
1509 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint))
1510#define usb_rcvctrlpipe(dev,endpoint) \
1511 ((PIPE_CONTROL << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1512#define usb_sndisocpipe(dev,endpoint) \
1513 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint))
1514#define usb_rcvisocpipe(dev,endpoint) \
1515 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1516#define usb_sndbulkpipe(dev,endpoint) \
1517 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint))
1518#define usb_rcvbulkpipe(dev,endpoint) \
1519 ((PIPE_BULK << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
1520#define usb_sndintpipe(dev,endpoint) \
1521 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint))
1522#define usb_rcvintpipe(dev,endpoint) \
1523 ((PIPE_INTERRUPT << 30) | __create_pipe(dev,endpoint) | USB_DIR_IN)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
1525/*-------------------------------------------------------------------------*/
1526
1527static inline __u16
1528usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
1529{
1530 struct usb_host_endpoint *ep;
1531 unsigned epnum = usb_pipeendpoint(pipe);
1532
1533 if (is_out) {
1534 WARN_ON(usb_pipein(pipe));
1535 ep = udev->ep_out[epnum];
1536 } else {
1537 WARN_ON(usb_pipeout(pipe));
1538 ep = udev->ep_in[epnum];
1539 }
1540 if (!ep)
1541 return 0;
1542
1543 /* NOTE: only 0x07ff bits are for packet size... */
1544 return le16_to_cpu(ep->desc.wMaxPacketSize);
1545}
1546
Alan Sternb724ae72005-10-24 15:36:00 -04001547/* ----------------------------------------------------------------------- */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07001549/* Events from the usb core */
1550#define USB_DEVICE_ADD 0x0001
1551#define USB_DEVICE_REMOVE 0x0002
1552#define USB_BUS_ADD 0x0003
1553#define USB_BUS_REMOVE 0x0004
1554extern void usb_register_notify(struct notifier_block *nb);
1555extern void usb_unregister_notify(struct notifier_block *nb);
1556
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557#ifdef DEBUG
Alan Sternb724ae72005-10-24 15:36:00 -04001558#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
1559 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560#else
1561#define dbg(format, arg...) do {} while (0)
1562#endif
1563
Alan Sternb724ae72005-10-24 15:36:00 -04001564#define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
1565 __FILE__ , ## arg)
1566#define info(format, arg...) printk(KERN_INFO "%s: " format "\n" , \
1567 __FILE__ , ## arg)
1568#define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n" , \
1569 __FILE__ , ## arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
1571
1572#endif /* __KERNEL__ */
1573
1574#endif