usb.h 61.2 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
#ifndef __LINUX_USB_H
#define __LINUX_USB_H

#include <linux/mod_devicetable.h>
5
#include <linux/usb/ch9.h>
L
Linus Torvalds 已提交
6 7

#define USB_MAJOR			180
8
#define USB_DEVICE_MAJOR		189
L
Linus Torvalds 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21


#ifdef __KERNEL__

#include <linux/errno.h>        /* for -ENODEV */
#include <linux/delay.h>	/* for mdelay() */
#include <linux/interrupt.h>	/* for in_interrupt() */
#include <linux/list.h>		/* for struct list_head */
#include <linux/kref.h>		/* for struct kref */
#include <linux/device.h>	/* for struct device */
#include <linux/fs.h>		/* for struct file_operations */
#include <linux/completion.h>	/* for struct completion */
#include <linux/sched.h>	/* for current && schedule_timeout */
22
#include <linux/mutex.h>	/* for struct mutex */
L
Linus Torvalds 已提交
23 24 25

struct usb_device;
struct usb_driver;
26
struct wusb_dev;
L
Linus Torvalds 已提交
27 28 29 30 31 32 33 34 35 36 37 38

/*-------------------------------------------------------------------------*/

/*
 * Host-side wrappers for standard USB descriptors ... these are parsed
 * from the data provided by devices.  Parsing turns them from a flat
 * sequence of descriptors into a hierarchy:
 *
 *  - devices have one (usually) or more configs;
 *  - configs have one (often) or more interfaces;
 *  - interfaces have one (usually) or more settings;
 *  - each interface setting has zero or (usually) more endpoints.
39
 *  - a SuperSpeed endpoint has a companion descriptor
L
Linus Torvalds 已提交
40 41 42 43 44 45
 *
 * And there might be other descriptors mixed in with those.
 *
 * Devices may also have class-specific or vendor-specific descriptors.
 */

46 47
struct ep_device;

48 49
/* For SS devices */
/**
50
 * struct usb_host_ss_ep_comp - Valid for SuperSpeed devices only
51 52 53 54
 * @desc: endpoint companion descriptor, wMaxPacketSize in native byteorder
 * @extra: descriptors following this endpoint companion descriptor
 * @extralen: how many bytes of "extra" are valid
 */
55 56 57 58
struct usb_host_ss_ep_comp {
	struct usb_ss_ep_comp_descriptor	desc;
	unsigned char				*extra;   /* Extra descriptors */
	int					extralen;
59 60
};

L
Linus Torvalds 已提交
61 62 63 64 65 66
/**
 * struct usb_host_endpoint - host-side endpoint descriptor and queue
 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
 * @urb_list: urbs queued to this endpoint; maintained by usbcore
 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH)
 *	with one or more transfer descriptors (TDs) per urb
R
Randy Dunlap 已提交
67
 * @ep_dev: ep_device for sysfs info
68
 * @ss_ep_comp: companion descriptor information for this endpoint
L
Linus Torvalds 已提交
69 70
 * @extra: descriptors following this endpoint in the configuration
 * @extralen: how many bytes of "extra" are valid
A
Alan Stern 已提交
71
 * @enabled: URBs may be submitted to this endpoint
L
Linus Torvalds 已提交
72 73 74 75 76 77 78 79
 *
 * USB requests are always queued to a given endpoint, identified by a
 * descriptor within an active interface in a given USB configuration.
 */
struct usb_host_endpoint {
	struct usb_endpoint_descriptor	desc;
	struct list_head		urb_list;
	void				*hcpriv;
80
	struct ep_device 		*ep_dev;	/* For sysfs info */
81
	struct usb_host_ss_ep_comp	*ss_ep_comp;	/* For SS devices */
L
Linus Torvalds 已提交
82 83 84

	unsigned char *extra;   /* Extra descriptors */
	int extralen;
A
Alan Stern 已提交
85
	int enabled;
L
Linus Torvalds 已提交
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
};

/* host-side wrapper for one interface setting's parsed descriptors */
struct usb_host_interface {
	struct usb_interface_descriptor	desc;

	/* array of desc.bNumEndpoint endpoints associated with this
	 * interface setting.  these will be in no particular order.
	 */
	struct usb_host_endpoint *endpoint;

	char *string;		/* iInterface string, if present */
	unsigned char *extra;   /* Extra descriptors */
	int extralen;
};

enum usb_interface_condition {
	USB_INTERFACE_UNBOUND = 0,
	USB_INTERFACE_BINDING,
	USB_INTERFACE_BOUND,
	USB_INTERFACE_UNBINDING,
};

/**
 * struct usb_interface - what usb device drivers talk to
 * @altsetting: array of interface structures, one for each alternate
 * 	setting that may be selected.  Each one includes a set of
 * 	endpoint configurations.  They will be in no particular order.
 * @cur_altsetting: the current altsetting.
115
 * @num_altsetting: number of altsettings defined.
R
Randy Dunlap 已提交
116
 * @intf_assoc: interface association descriptor
L
Linus Torvalds 已提交
117 118 119 120 121 122 123 124
 * @minor: the minor number assigned to this interface, if this
 *	interface is bound to a driver that uses the USB major number.
 *	If this interface does not use the USB major, this field should
 *	be unused.  The driver should set this value in the probe()
 *	function of the driver, after it has been assigned a minor
 *	number from the USB core by calling usb_register_dev().
 * @condition: binding state of the interface: not bound, binding
 *	(in probe()), bound to a driver, or unbinding (in disconnect())
125
 * @is_active: flag set when the interface is bound and not suspended.
R
Randy Dunlap 已提交
126
 * @sysfs_files_created: sysfs attributes exist
A
Alan Stern 已提交
127
 * @ep_devs_created: endpoint child pseudo-devices exist
128
 * @unregistering: flag set when the interface is being unregistered
129 130
 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
 *	capability during autosuspend.
131 132
 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
 *	has been deferred.
133 134
 * @needs_binding: flag set when the driver should be re-probed or unbound
 *	following a reset or suspend operation it doesn't support.
L
Linus Torvalds 已提交
135
 * @dev: driver model's view of this device
136 137
 * @usb_dev: if an interface is bound to the USB major, this will point
 *	to the sysfs representation for that device.
138 139
 * @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
 *	allowed unless the counter is 0.
140 141 142 143 144
 * @reset_ws: Used for scheduling resets from atomic context.
 * @reset_running: set to 1 if the interface is currently running a
 *      queued reset so that usb_cancel_queued_reset() doesn't try to
 *      remove from the workqueue when running inside the worker
 *      thread. See __usb_queue_reset_device().
L
Linus Torvalds 已提交
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
 *
 * USB device drivers attach to interfaces on a physical device.  Each
 * interface encapsulates a single high level function, such as feeding
 * an audio stream to a speaker or reporting a change in a volume control.
 * Many USB devices only have one interface.  The protocol used to talk to
 * an interface's endpoints can be defined in a usb "class" specification,
 * or by a product's vendor.  The (default) control endpoint is part of
 * every interface, but is never listed among the interface's descriptors.
 *
 * The driver that is bound to the interface can use standard driver model
 * calls such as dev_get_drvdata() on the dev member of this structure.
 *
 * Each interface may have alternate settings.  The initial configuration
 * of a device sets altsetting 0, but the device driver can change
 * that setting using usb_set_interface().  Alternate settings are often
160
 * used to control the use of periodic endpoints, such as by having
L
Linus Torvalds 已提交
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
 * different endpoints use different amounts of reserved USB bandwidth.
 * All standards-conformant USB devices that use isochronous endpoints
 * will use them in non-default settings.
 *
 * The USB specification says that alternate setting numbers must run from
 * 0 to one less than the total number of alternate settings.  But some
 * devices manage to mess this up, and the structures aren't necessarily
 * stored in numerical order anyhow.  Use usb_altnum_to_altsetting() to
 * look up an alternate setting in the altsetting array based on its number.
 */
struct usb_interface {
	/* array of alternate settings for this interface,
	 * stored in no particular order */
	struct usb_host_interface *altsetting;

	struct usb_host_interface *cur_altsetting;	/* the currently
					 * active alternate setting */
	unsigned num_altsetting;	/* number of alternate settings */

180 181 182 183
	/* If there is an interface association descriptor then it will list
	 * the associated interfaces */
	struct usb_interface_assoc_descriptor *intf_assoc;

184 185
	int minor;			/* minor number this interface is
					 * bound to */
L
Linus Torvalds 已提交
186
	enum usb_interface_condition condition;		/* state of binding */
187
	unsigned is_active:1;		/* the interface is not suspended */
188
	unsigned sysfs_files_created:1;	/* the sysfs attributes exist */
A
Alan Stern 已提交
189
	unsigned ep_devs_created:1;	/* endpoint "devices" exist */
190
	unsigned unregistering:1;	/* unregistration is in progress */
191
	unsigned needs_remote_wakeup:1;	/* driver requires remote wakeup */
192
	unsigned needs_altsetting0:1;	/* switch to altsetting 0 is pending */
193
	unsigned needs_binding:1;	/* needs delayed unbind/rebind */
194
	unsigned reset_running:1;
195
	unsigned resetting_device:1;	/* true: bandwidth alloc after reset */
196

L
Linus Torvalds 已提交
197
	struct device dev;		/* interface specific device info */
198
	struct device *usb_dev;
A
Alan Stern 已提交
199
	atomic_t pm_usage_cnt;		/* usage counter for autosuspend */
200
	struct work_struct reset_ws;	/* for resets in atomic context */
L
Linus Torvalds 已提交
201 202 203 204 205
};
#define	to_usb_interface(d) container_of(d, struct usb_interface, dev)
#define	interface_to_usbdev(intf) \
	container_of(intf->dev.parent, struct usb_device, dev)

206
static inline void *usb_get_intfdata(struct usb_interface *intf)
L
Linus Torvalds 已提交
207
{
208
	return dev_get_drvdata(&intf->dev);
L
Linus Torvalds 已提交
209 210
}

211
static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
L
Linus Torvalds 已提交
212 213 214 215 216 217 218 219 220
{
	dev_set_drvdata(&intf->dev, data);
}

struct usb_interface *usb_get_intf(struct usb_interface *intf);
void usb_put_intf(struct usb_interface *intf);

/* this maximum is arbitrary */
#define USB_MAXINTERFACES	32
221
#define USB_MAXIADS		USB_MAXINTERFACES/2
L
Linus Torvalds 已提交
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254

/**
 * struct usb_interface_cache - long-term representation of a device interface
 * @num_altsetting: number of altsettings defined.
 * @ref: reference counter.
 * @altsetting: variable-length array of interface structures, one for
 *	each alternate setting that may be selected.  Each one includes a
 *	set of endpoint configurations.  They will be in no particular order.
 *
 * These structures persist for the lifetime of a usb_device, unlike
 * struct usb_interface (which persists only as long as its configuration
 * is installed).  The altsetting arrays can be accessed through these
 * structures at any time, permitting comparison of configurations and
 * providing support for the /proc/bus/usb/devices pseudo-file.
 */
struct usb_interface_cache {
	unsigned num_altsetting;	/* number of alternate settings */
	struct kref ref;		/* reference counter */

	/* variable-length array of alternate settings for this interface,
	 * stored in no particular order */
	struct usb_host_interface altsetting[0];
};
#define	ref_to_usb_interface_cache(r) \
		container_of(r, struct usb_interface_cache, ref)
#define	altsetting_to_usb_interface_cache(a) \
		container_of(a, struct usb_interface_cache, altsetting[0])

/**
 * struct usb_host_config - representation of a device's configuration
 * @desc: the device's configuration descriptor.
 * @string: pointer to the cached version of the iConfiguration string, if
 *	present for this configuration.
R
Randy Dunlap 已提交
255
 * @intf_assoc: list of any interface association descriptors in this config
L
Linus Torvalds 已提交
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
 * @interface: array of pointers to usb_interface structures, one for each
 *	interface in the configuration.  The number of interfaces is stored
 *	in desc.bNumInterfaces.  These pointers are valid only while the
 *	the configuration is active.
 * @intf_cache: array of pointers to usb_interface_cache structures, one
 *	for each interface in the configuration.  These structures exist
 *	for the entire life of the device.
 * @extra: pointer to buffer containing all extra descriptors associated
 *	with this configuration (those preceding the first interface
 *	descriptor).
 * @extralen: length of the extra descriptors buffer.
 *
 * USB devices may have multiple configurations, but only one can be active
 * at any time.  Each encapsulates a different operational environment;
 * for example, a dual-speed device would have separate configurations for
 * full-speed and high-speed operation.  The number of configurations
 * available is stored in the device descriptor as bNumConfigurations.
 *
 * A configuration can contain multiple interfaces.  Each corresponds to
 * a different function of the USB device, and all are available whenever
 * the configuration is active.  The USB standard says that interfaces
 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot
 * of devices get this wrong.  In addition, the interface array is not
 * guaranteed to be sorted in numerical order.  Use usb_ifnum_to_if() to
 * look up an interface entry based on its number.
 *
 * Device drivers should not attempt to activate configurations.  The choice
 * of which configuration to install is a policy decision based on such
 * considerations as available power, functionality provided, and the user's
285
 * desires (expressed through userspace tools).  However, drivers can call
L
Linus Torvalds 已提交
286 287 288 289 290 291
 * usb_reset_configuration() to reinitialize the current configuration and
 * all its interfaces.
 */
struct usb_host_config {
	struct usb_config_descriptor	desc;

292
	char *string;		/* iConfiguration string, if present */
293 294 295 296 297

	/* List of any Interface Association Descriptors in this
	 * configuration. */
	struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS];

L
Linus Torvalds 已提交
298 299 300 301 302 303 304 305 306 307 308 309 310 311
	/* the interfaces associated with this configuration,
	 * stored in no particular order */
	struct usb_interface *interface[USB_MAXINTERFACES];

	/* Interface information available even when this is not the
	 * active configuration */
	struct usb_interface_cache *intf_cache[USB_MAXINTERFACES];

	unsigned char *extra;   /* Extra descriptors */
	int extralen;
};

int __usb_get_extra_descriptor(char *buffer, unsigned size,
	unsigned char type, void **ptr);
312 313 314 315
#define usb_get_extra_descriptor(ifpoint, type, ptr) \
				__usb_get_extra_descriptor((ifpoint)->extra, \
				(ifpoint)->extralen, \
				type, (void **)ptr)
L
Linus Torvalds 已提交
316

317
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
318 319 320 321 322 323 324 325 326 327 328 329

/* USB device number allocation bitmap */
struct usb_devmap {
	unsigned long devicemap[128 / (8*sizeof(unsigned long))];
};

/*
 * Allocated per bus (tree of devices) we have:
 */
struct usb_bus {
	struct device *controller;	/* host/master side hardware */
	int busnum;			/* Bus number (in order of reg) */
330
	const char *bus_name;		/* stable id (PCI slot_name etc) */
331
	u8 uses_dma;			/* Does the host controller use DMA? */
L
Linus Torvalds 已提交
332 333 334
	u8 otg_port;			/* 0, or number of OTG/HNP port */
	unsigned is_b_host:1;		/* true during some HNP roleswitches */
	unsigned b_hnp_enable:1;	/* OTG: did A-Host enable HNP? */
335
	unsigned sg_tablesize;		/* 0 or largest number of sg list entries */
L
Linus Torvalds 已提交
336

337 338
	int devnum_next;		/* Next open device number in
					 * round-robin allocation */
L
Linus Torvalds 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353

	struct usb_devmap devmap;	/* device address allocation map */
	struct usb_device *root_hub;	/* Root hub */
	struct list_head bus_list;	/* list of busses */

	int bandwidth_allocated;	/* on this bus: how much of the time
					 * reserved for periodic (intr/iso)
					 * requests is used, on average?
					 * Units: microseconds/frame.
					 * Limits: Full/low speed reserve 90%,
					 * while high speed reserves 80%.
					 */
	int bandwidth_int_reqs;		/* number of Interrupt requests */
	int bandwidth_isoc_reqs;	/* number of Isoc. requests */

354
#ifdef CONFIG_USB_DEVICEFS
L
Linus Torvalds 已提交
355
	struct dentry *usbfs_dentry;	/* usbfs dentry entry for the bus */
356
#endif
357

358
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
L
Linus Torvalds 已提交
359 360 361 362 363
	struct mon_bus *mon_bus;	/* non-null when associated */
	int monitored;			/* non-zero when monitored */
#endif
};

364
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
365 366 367 368

/* This is arbitrary.
 * From USB 2.0 spec Table 11-13, offset 7, a hub can
 * have up to 255 ports. The most yet reported is 10.
369 370 371 372 373
 *
 * Current Wireless USB host hardware (Intel i1480 for example) allows
 * up to 22 devices to connect. Upcoming hardware might raise that
 * limit. Because the arrays need to add a bit for hub status data, we
 * do 31, so plus one evens out to four bytes.
L
Linus Torvalds 已提交
374
 */
375
#define USB_MAXCHILDREN		(31)
L
Linus Torvalds 已提交
376 377 378

struct usb_tt;

379
/**
L
Linus Torvalds 已提交
380
 * struct usb_device - kernel's representation of a USB device
381 382
 * @devnum: device number; address on a USB bus
 * @devpath: device ID string for use in messages (e.g., /port/...)
383
 * @route: tree topology hex string for use with xHCI
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
 * @state: device state: configured, not attached, etc.
 * @speed: device speed: high/full/low (or error)
 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub
 * @ttport: device port on that tt hub
 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints
 * @parent: our hub, unless we're the root
 * @bus: bus we're part of
 * @ep0: endpoint 0 data (default control pipe)
 * @dev: generic device interface
 * @descriptor: USB device descriptor
 * @config: all of the device's configs
 * @actconfig: the active configuration
 * @ep_in: array of IN endpoints
 * @ep_out: array of OUT endpoints
 * @rawdescriptors: raw descriptors for each config
 * @bus_mA: Current available from the bus
 * @portnum: parent port number (origin 1)
 * @level: number of USB hub ancestors
 * @can_submit: URBs may be submitted
 * @discon_suspended: disconnected while suspended
 * @persist_enabled:  USB_PERSIST enabled for this device
 * @have_langid: whether string_langid is valid
 * @authorized: policy has said we can use it;
 *	(user space) policy determines if we authorize this device to be
 *	used or not. By default, wired USB devices are authorized.
 *	WUSB devices are not, until we authorize them from user space.
 *	FIXME -- complete doc
411
 * @authenticated: Crypto authentication passed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
 * @wusb: device is Wireless USB
 * @string_langid: language ID for strings
 * @product: iProduct string, if present (static)
 * @manufacturer: iManufacturer string, if present (static)
 * @serial: iSerialNumber string, if present (static)
 * @filelist: usbfs files that are open to this device
 * @usb_classdev: USB class device that was created for usbfs device
 *	access from userspace
 * @usbfs_dentry: usbfs dentry entry for the device
 * @maxchild: number of ports if hub
 * @children: child devices - USB devices that are attached to this hub
 * @pm_usage_cnt: usage counter for autosuspend
 * @quirks: quirks of the whole device
 * @urbnum: number of URBs submitted for the whole device
 * @active_duration: total time device is not suspended
 * @autosuspend: for delayed autosuspends
428
 * @autoresume: for autoresumes requested while in_interrupt
429 430 431 432 433 434 435 436
 * @pm_mutex: protects PM operations
 * @last_busy: time of last use
 * @autosuspend_delay: in jiffies
 * @connect_time: time device was first connected
 * @do_remote_wakeup:  remote wakeup should be enabled
 * @reset_resume: needs reset instead of resume
 * @autosuspend_disabled: autosuspend disabled by the user
 * @skip_sys_resume: skip the next system resume
437 438
 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
 *	specific data for the device.
439
 * @slot_id: Slot ID assigned by xHCI
L
Linus Torvalds 已提交
440
 *
441
 * Notes:
L
Linus Torvalds 已提交
442 443 444 445
 * Usbcore drivers should not set usbdev->state directly.  Instead use
 * usb_set_device_state().
 */
struct usb_device {
446 447
	int		devnum;
	char		devpath [16];
448
	u32		route;
449 450
	enum usb_device_state	state;
	enum usb_device_speed	speed;
L
Linus Torvalds 已提交
451

452 453
	struct usb_tt	*tt;
	int		ttport;
L
Linus Torvalds 已提交
454

455
	unsigned int toggle[2];
L
Linus Torvalds 已提交
456

457 458
	struct usb_device *parent;
	struct usb_bus *bus;
L
Linus Torvalds 已提交
459 460
	struct usb_host_endpoint ep0;

461
	struct device dev;
L
Linus Torvalds 已提交
462

463 464
	struct usb_device_descriptor descriptor;
	struct usb_host_config *config;
L
Linus Torvalds 已提交
465

466
	struct usb_host_config *actconfig;
L
Linus Torvalds 已提交
467 468 469
	struct usb_host_endpoint *ep_in[16];
	struct usb_host_endpoint *ep_out[16];

470
	char **rawdescriptors;
L
Linus Torvalds 已提交
471

472 473 474
	unsigned short bus_mA;
	u8 portnum;
	u8 level;
475

476 477 478 479 480
	unsigned can_submit:1;
	unsigned discon_suspended:1;
	unsigned persist_enabled:1;
	unsigned have_langid:1;
	unsigned authorized:1;
481
 	unsigned authenticated:1;
482 483
	unsigned wusb:1;
	int string_langid;
L
Linus Torvalds 已提交
484

485
	/* static strings from the device */
486 487 488
	char *product;
	char *manufacturer;
	char *serial;
489

L
Linus Torvalds 已提交
490
	struct list_head filelist;
491 492 493 494
#ifdef CONFIG_USB_DEVICE_CLASS
	struct device *usb_classdev;
#endif
#ifdef CONFIG_USB_DEVICEFS
495
	struct dentry *usbfs_dentry;
496
#endif
L
Linus Torvalds 已提交
497

498
	int maxchild;
L
Linus Torvalds 已提交
499
	struct usb_device *children[USB_MAXCHILDREN];
500

501 502 503
	int pm_usage_cnt;
	u32 quirks;
	atomic_t urbnum;
504

505
	unsigned long active_duration;
S
Sarah Sharp 已提交
506

507
#ifdef CONFIG_PM
508
	struct delayed_work autosuspend;
509
	struct work_struct autoresume;
510 511 512 513 514 515 516 517 518 519
	struct mutex pm_mutex;

	unsigned long last_busy;
	int autosuspend_delay;
	unsigned long connect_time;

	unsigned do_remote_wakeup:1;
	unsigned reset_resume:1;
	unsigned autosuspend_disabled:1;
	unsigned skip_sys_resume:1;
520
#endif
521
	struct wusb_dev *wusb_dev;
522
	int slot_id;
L
Linus Torvalds 已提交
523 524 525 526 527 528
};
#define	to_usb_device(d) container_of(d, struct usb_device, dev)

extern struct usb_device *usb_get_dev(struct usb_device *dev);
extern void usb_put_dev(struct usb_device *dev);

529 530 531 532
/* USB device locking */
#define usb_lock_device(udev)		down(&(udev)->dev.sem)
#define usb_unlock_device(udev)		up(&(udev)->dev.sem)
#define usb_trylock_device(udev)	down_trylock(&(udev)->dev.sem)
L
Linus Torvalds 已提交
533
extern int usb_lock_device_for_reset(struct usb_device *udev,
534
				     const struct usb_interface *iface);
L
Linus Torvalds 已提交
535 536 537

/* USB port reset for device reinitialization */
extern int usb_reset_device(struct usb_device *dev);
538
extern void usb_queue_reset_device(struct usb_interface *dev);
L
Linus Torvalds 已提交
539 540 541

extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);

542 543 544 545
/* USB autosuspend and autoresume */
#ifdef CONFIG_USB_SUSPEND
extern int usb_autopm_get_interface(struct usb_interface *intf);
extern void usb_autopm_put_interface(struct usb_interface *intf);
546 547
extern int usb_autopm_get_interface_async(struct usb_interface *intf);
extern void usb_autopm_put_interface_async(struct usb_interface *intf);
548

549 550
static inline void usb_autopm_get_interface_no_resume(
		struct usb_interface *intf)
551
{
552
	atomic_inc(&intf->pm_usage_cnt);
553
}
554 555
static inline void usb_autopm_put_interface_no_suspend(
		struct usb_interface *intf)
556
{
557
	atomic_dec(&intf->pm_usage_cnt);
558 559
}

560 561 562 563 564
static inline void usb_mark_last_busy(struct usb_device *udev)
{
	udev->last_busy = jiffies;
}

565 566
#else

567 568
static inline int usb_autopm_get_interface(struct usb_interface *intf)
{ return 0; }
569 570 571
static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
{ return 0; }

572 573
static inline void usb_autopm_put_interface(struct usb_interface *intf)
{ }
574 575
static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
{ }
576 577
static inline void usb_autopm_get_interface_no_resume(
		struct usb_interface *intf)
578
{ }
579 580
static inline void usb_autopm_put_interface_no_suspend(
		struct usb_interface *intf)
581
{ }
582 583
static inline void usb_mark_last_busy(struct usb_device *udev)
{ }
584
#endif
585

L
Linus Torvalds 已提交
586 587 588
/*-------------------------------------------------------------------------*/

/* for drivers using iso endpoints */
589
extern int usb_get_current_frame_number(struct usb_device *usb_dev);
L
Linus Torvalds 已提交
590 591 592

/* used these for multi-interface device registration */
extern int usb_driver_claim_interface(struct usb_driver *driver,
593
			struct usb_interface *iface, void *priv);
L
Linus Torvalds 已提交
594 595 596 597 598 599 600 601 602 603 604

/**
 * usb_interface_claimed - returns true iff an interface is claimed
 * @iface: the interface being checked
 *
 * Returns true (nonzero) iff the interface is claimed, else false (zero).
 * Callers must own the driver model's usb bus readlock.  So driver
 * probe() entries don't need extra locking, but other call contexts
 * may need to explicitly claim that lock.
 *
 */
605 606
static inline int usb_interface_claimed(struct usb_interface *iface)
{
L
Linus Torvalds 已提交
607 608 609 610 611 612 613
	return (iface->dev.driver != NULL);
}

extern void usb_driver_release_interface(struct usb_driver *driver,
			struct usb_interface *iface);
const struct usb_device_id *usb_match_id(struct usb_interface *interface,
					 const struct usb_device_id *id);
614 615
extern int usb_match_one_id(struct usb_interface *interface,
			    const struct usb_device_id *id);
L
Linus Torvalds 已提交
616 617 618

extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
		int minor);
619
extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
L
Linus Torvalds 已提交
620 621
		unsigned ifnum);
extern struct usb_host_interface *usb_altnum_to_altsetting(
622
		const struct usb_interface *intf, unsigned int altnum);
623 624 625 626
extern struct usb_host_interface *usb_find_alt_setting(
		struct usb_host_config *config,
		unsigned int iface_num,
		unsigned int alt_num);
L
Linus Torvalds 已提交
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652


/**
 * usb_make_path - returns stable device path in the usb tree
 * @dev: the device whose path is being constructed
 * @buf: where to put the string
 * @size: how big is "buf"?
 *
 * Returns length of the string (> 0) or negative if size was too small.
 *
 * This identifier is intended to be "stable", reflecting physical paths in
 * hardware such as physical bus addresses for host controllers or ports on
 * USB hubs.  That makes it stay the same until systems are physically
 * reconfigured, by re-cabling a tree of USB devices or by moving USB host
 * controllers.  Adding and removing devices, including virtual root hubs
 * in host controller driver modules, does not change these path identifers;
 * neither does rebooting or re-enumerating.  These are more useful identifiers
 * than changeable ("unstable") ones like bus numbers or device addresses.
 *
 * With a partial exception for devices connected to USB 2.0 root hubs, these
 * identifiers are also predictable.  So long as the device tree isn't changed,
 * plugging any USB device into a given hub port always gives it the same path.
 * Because of the use of "companion" controllers, devices connected to ports on
 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are
 * high speed, and a different one if they are full or low speed.
 */
653
static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
L
Linus Torvalds 已提交
654 655
{
	int actual;
656 657
	actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
			  dev->devpath);
L
Linus Torvalds 已提交
658 659 660 661 662
	return (actual >= (int)size) ? -1 : actual;
}

/*-------------------------------------------------------------------------*/

663 664 665 666 667 668
#define USB_DEVICE_ID_MATCH_DEVICE \
		(USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
#define USB_DEVICE_ID_MATCH_DEV_RANGE \
		(USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI)
#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \
		(USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE)
L
Linus Torvalds 已提交
669
#define USB_DEVICE_ID_MATCH_DEV_INFO \
670 671 672
		(USB_DEVICE_ID_MATCH_DEV_CLASS | \
		USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
		USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
L
Linus Torvalds 已提交
673
#define USB_DEVICE_ID_MATCH_INT_INFO \
674 675 676
		(USB_DEVICE_ID_MATCH_INT_CLASS | \
		USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
		USB_DEVICE_ID_MATCH_INT_PROTOCOL)
L
Linus Torvalds 已提交
677 678 679 680 681 682 683 684 685 686

/**
 * USB_DEVICE - macro used to describe a specific usb device
 * @vend: the 16 bit USB Vendor ID
 * @prod: the 16 bit USB Product ID
 *
 * This macro is used to create a struct usb_device_id that matches a
 * specific device.
 */
#define USB_DEVICE(vend,prod) \
687 688 689
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
	.idVendor = (vend), \
	.idProduct = (prod)
L
Linus Torvalds 已提交
690
/**
R
Randy Dunlap 已提交
691
 * USB_DEVICE_VER - describe a specific usb device with a version range
L
Linus Torvalds 已提交
692 693 694 695 696 697 698 699
 * @vend: the 16 bit USB Vendor ID
 * @prod: the 16 bit USB Product ID
 * @lo: the bcdDevice_lo value
 * @hi: the bcdDevice_hi value
 *
 * This macro is used to create a struct usb_device_id that matches a
 * specific device, with a version range.
 */
700
#define USB_DEVICE_VER(vend, prod, lo, hi) \
701
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
702 703 704 705
	.idVendor = (vend), \
	.idProduct = (prod), \
	.bcdDevice_lo = (lo), \
	.bcdDevice_hi = (hi)
L
Linus Torvalds 已提交
706

707
/**
R
Randy Dunlap 已提交
708
 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
709 710 711 712 713 714 715
 * @vend: the 16 bit USB Vendor ID
 * @prod: the 16 bit USB Product ID
 * @pr: bInterfaceProtocol value
 *
 * This macro is used to create a struct usb_device_id that matches a
 * specific interface protocol of devices.
 */
716 717 718
#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
		       USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
719 720 721 722
	.idVendor = (vend), \
	.idProduct = (prod), \
	.bInterfaceProtocol = (pr)

L
Linus Torvalds 已提交
723 724 725 726 727 728 729 730 731
/**
 * USB_DEVICE_INFO - macro used to describe a class of usb devices
 * @cl: bDeviceClass value
 * @sc: bDeviceSubClass value
 * @pr: bDeviceProtocol value
 *
 * This macro is used to create a struct usb_device_id that matches a
 * specific class of devices.
 */
732 733 734 735 736
#define USB_DEVICE_INFO(cl, sc, pr) \
	.match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
	.bDeviceClass = (cl), \
	.bDeviceSubClass = (sc), \
	.bDeviceProtocol = (pr)
L
Linus Torvalds 已提交
737 738

/**
739
 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
L
Linus Torvalds 已提交
740 741 742 743 744 745 746
 * @cl: bInterfaceClass value
 * @sc: bInterfaceSubClass value
 * @pr: bInterfaceProtocol value
 *
 * This macro is used to create a struct usb_device_id that matches a
 * specific class of interfaces.
 */
747 748 749 750 751
#define USB_INTERFACE_INFO(cl, sc, pr) \
	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
	.bInterfaceClass = (cl), \
	.bInterfaceSubClass = (sc), \
	.bInterfaceProtocol = (pr)
752 753

/**
R
Randy Dunlap 已提交
754
 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
755 756 757 758 759 760 761 762 763 764 765 766
 * @vend: the 16 bit USB Vendor ID
 * @prod: the 16 bit USB Product ID
 * @cl: bInterfaceClass value
 * @sc: bInterfaceSubClass value
 * @pr: bInterfaceProtocol value
 *
 * This macro is used to create a struct usb_device_id that matches a
 * specific device with a specific class of interfaces.
 *
 * This is especially useful when explicitly matching devices that have
 * vendor specific bDeviceClass values, but standards-compliant interfaces.
 */
767
#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
768 769
	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
		| USB_DEVICE_ID_MATCH_DEVICE, \
770 771
	.idVendor = (vend), \
	.idProduct = (prod), \
772
	.bInterfaceClass = (cl), \
773 774
	.bInterfaceSubClass = (sc), \
	.bInterfaceProtocol = (pr)
L
Linus Torvalds 已提交
775

776
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
777

778
/* Stuff for dynamic usb ids */
779 780 781 782 783
struct usb_dynids {
	spinlock_t lock;
	struct list_head list;
};

784 785 786 787 788 789 790 791 792
struct usb_dynid {
	struct list_head node;
	struct usb_device_id id;
};

extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
				struct device_driver *driver,
				const char *buf, size_t count);

L
Linus Torvalds 已提交
793
/**
794 795 796 797 798 799 800 801 802 803 804
 * struct usbdrv_wrap - wrapper for driver-model structure
 * @driver: The driver-model core driver structure.
 * @for_devices: Non-zero for device drivers, 0 for interface drivers.
 */
struct usbdrv_wrap {
	struct device_driver driver;
	int for_devices;
};

/**
 * struct usb_driver - identifies USB interface driver to usbcore
L
Linus Torvalds 已提交
805 806 807 808
 * @name: The driver name should be unique among USB drivers,
 *	and should normally be the same as the module name.
 * @probe: Called to see if the driver is willing to manage a particular
 *	interface on a device.  If it is, probe returns zero and uses
809
 *	usb_set_intfdata() to associate driver-specific data with the
L
Linus Torvalds 已提交
810 811
 *	interface.  It may also use usb_set_interface() to specify the
 *	appropriate altsetting.  If unwilling to manage the interface,
812 813
 *	return -ENODEV, if genuine IO errors occured, an appropriate
 *	negative errno value.
L
Linus Torvalds 已提交
814 815 816 817 818 819 820 821 822
 * @disconnect: Called when the interface is no longer accessible, usually
 *	because its device has been (or is being) disconnected or the
 *	driver module is being unloaded.
 * @ioctl: Used for drivers that want to talk to userspace through
 *	the "usbfs" filesystem.  This lets devices provide ways to
 *	expose information to user space regardless of where they
 *	do (or don't) show up otherwise in the filesystem.
 * @suspend: Called when the device is going to be suspended by the system.
 * @resume: Called when the device is being resumed by the system.
A
Alan Stern 已提交
823 824
 * @reset_resume: Called when the suspended device has been reset instead
 *	of being resumed.
825
 * @pre_reset: Called by usb_reset_device() when the device
826
 *	is about to be reset.
827
 * @post_reset: Called by usb_reset_device() after the device
828
 *	has been reset
L
Linus Torvalds 已提交
829 830 831
 * @id_table: USB drivers use ID table to support hotplugging.
 *	Export this with MODULE_DEVICE_TABLE(usb,...).  This must be set
 *	or your driver's probe function will never get called.
832 833
 * @dynids: used internally to hold the list of dynamically added device
 *	ids for this driver.
834
 * @drvwrap: Driver-model core structure wrapper.
835 836
 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be
 *	added to this driver by preventing the sysfs file from being created.
837 838
 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
 *	for interfaces bound to this driver.
A
Alan Stern 已提交
839 840
 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
 *	endpoints before calling the driver's disconnect method.
L
Linus Torvalds 已提交
841
 *
842 843
 * USB interface drivers must provide a name, probe() and disconnect()
 * methods, and an id_table.  Other driver fields are optional.
L
Linus Torvalds 已提交
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
 *
 * The id_table is used in hotplugging.  It holds a set of descriptors,
 * and specialized data may be associated with each entry.  That table
 * is used by both user and kernel mode hotplugging support.
 *
 * The probe() and disconnect() methods are called in a context where
 * they can sleep, but they should avoid abusing the privilege.  Most
 * work to connect to a device should be done when the device is opened,
 * and undone at the last close.  The disconnect code needs to address
 * concurrency issues with respect to open() and close() methods, as
 * well as forcing all pending I/O requests to complete (by unlinking
 * them as necessary, and blocking until the unlinks complete).
 */
struct usb_driver {
	const char *name;

	int (*probe) (struct usb_interface *intf,
		      const struct usb_device_id *id);

	void (*disconnect) (struct usb_interface *intf);

865 866
	int (*ioctl) (struct usb_interface *intf, unsigned int code,
			void *buf);
L
Linus Torvalds 已提交
867

868
	int (*suspend) (struct usb_interface *intf, pm_message_t message);
L
Linus Torvalds 已提交
869
	int (*resume) (struct usb_interface *intf);
A
Alan Stern 已提交
870
	int (*reset_resume)(struct usb_interface *intf);
L
Linus Torvalds 已提交
871

A
Alan Stern 已提交
872 873
	int (*pre_reset)(struct usb_interface *intf);
	int (*post_reset)(struct usb_interface *intf);
874

L
Linus Torvalds 已提交
875 876
	const struct usb_device_id *id_table;

877
	struct usb_dynids dynids;
878
	struct usbdrv_wrap drvwrap;
879
	unsigned int no_dynamic_id:1;
880
	unsigned int supports_autosuspend:1;
A
Alan Stern 已提交
881
	unsigned int soft_unbind:1;
L
Linus Torvalds 已提交
882
};
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
#define	to_usb_driver(d) container_of(d, struct usb_driver, drvwrap.driver)

/**
 * struct usb_device_driver - identifies USB device driver to usbcore
 * @name: The driver name should be unique among USB drivers,
 *	and should normally be the same as the module name.
 * @probe: Called to see if the driver is willing to manage a particular
 *	device.  If it is, probe returns zero and uses dev_set_drvdata()
 *	to associate driver-specific data with the device.  If unwilling
 *	to manage the device, return a negative errno value.
 * @disconnect: Called when the device is no longer accessible, usually
 *	because it has been (or is being) disconnected or the driver's
 *	module is being unloaded.
 * @suspend: Called when the device is going to be suspended by the system.
 * @resume: Called when the device is being resumed by the system.
 * @drvwrap: Driver-model core structure wrapper.
899 900
 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
 *	for devices bound to this driver.
901 902 903 904 905 906 907 908 909 910
 *
 * USB drivers must provide all the fields listed above except drvwrap.
 */
struct usb_device_driver {
	const char *name;

	int (*probe) (struct usb_device *udev);
	void (*disconnect) (struct usb_device *udev);

	int (*suspend) (struct usb_device *udev, pm_message_t message);
A
Alan Stern 已提交
911
	int (*resume) (struct usb_device *udev, pm_message_t message);
912
	struct usbdrv_wrap drvwrap;
913
	unsigned int supports_autosuspend:1;
914 915 916
};
#define	to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
		drvwrap.driver)
L
Linus Torvalds 已提交
917 918 919 920 921

extern struct bus_type usb_bus_type;

/**
 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
922
 * @name: the usb class device name for this driver.  Will show up in sysfs.
923
 * @devnode: Callback to provide a naming hint for a possible
924
 *	device node to create.
L
Linus Torvalds 已提交
925 926 927 928 929 930 931 932 933
 * @fops: pointer to the struct file_operations of this driver.
 * @minor_base: the start of the minor range for this driver.
 *
 * This structure is used for the usb_register_dev() and
 * usb_unregister_dev() functions, to consolidate a number of the
 * parameters used for them.
 */
struct usb_class_driver {
	char *name;
934
	char *(*devnode)(struct device *dev, mode_t *mode);
935
	const struct file_operations *fops;
936
	int minor_base;
L
Linus Torvalds 已提交
937 938 939 940 941 942
};

/*
 * use these in module_init()/module_exit()
 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
 */
943 944
extern int usb_register_driver(struct usb_driver *, struct module *,
			       const char *);
945 946
static inline int usb_register(struct usb_driver *driver)
{
947
	return usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
948
}
L
Linus Torvalds 已提交
949 950
extern void usb_deregister(struct usb_driver *);

951 952 953 954
extern int usb_register_device_driver(struct usb_device_driver *,
			struct module *);
extern void usb_deregister_device_driver(struct usb_device_driver *);

L
Linus Torvalds 已提交
955 956 957 958 959 960 961
extern int usb_register_dev(struct usb_interface *intf,
			    struct usb_class_driver *class_driver);
extern void usb_deregister_dev(struct usb_interface *intf,
			       struct usb_class_driver *class_driver);

extern int usb_disabled(void);

962
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
963 964 965 966 967 968 969

/*
 * URB support, for asynchronous request completions
 */

/*
 * urb->transfer_flags:
970 971
 *
 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
L
Linus Torvalds 已提交
972 973
 */
#define URB_SHORT_NOT_OK	0x0001	/* report short reads as errors */
974 975
#define URB_ISO_ASAP		0x0002	/* iso-only, urb->start_frame
					 * ignored */
L
Linus Torvalds 已提交
976 977 978
#define URB_NO_TRANSFER_DMA_MAP	0x0004	/* urb->transfer_dma valid on submit */
#define URB_NO_SETUP_DMA_MAP	0x0008	/* urb->setup_dma valid on submit */
#define URB_NO_FSBR		0x0020	/* UHCI-specific */
979 980 981
#define URB_ZERO_PACKET		0x0040	/* Finish bulk OUT with short packet */
#define URB_NO_INTERRUPT	0x0080	/* HINT: no non-error interrupt
					 * needed */
982
#define URB_FREE_BUFFER		0x0100	/* Free transfer buffer with the URB */
L
Linus Torvalds 已提交
983

984 985 986 987
#define URB_DIR_IN		0x0200	/* Transfer from device to host */
#define URB_DIR_OUT		0
#define URB_DIR_MASK		URB_DIR_IN

L
Linus Torvalds 已提交
988 989 990 991
struct usb_iso_packet_descriptor {
	unsigned int offset;
	unsigned int length;		/* expected length */
	unsigned int actual_length;
992
	int status;
L
Linus Torvalds 已提交
993 994 995 996
};

struct urb;

O
Oliver Neukum 已提交
997 998 999 1000
struct usb_anchor {
	struct list_head urb_list;
	wait_queue_head_t wait;
	spinlock_t lock;
O
Oliver Neukum 已提交
1001
	unsigned int poisoned:1;
O
Oliver Neukum 已提交
1002 1003 1004 1005 1006 1007 1008 1009 1010
};

static inline void init_usb_anchor(struct usb_anchor *anchor)
{
	INIT_LIST_HEAD(&anchor->urb_list);
	init_waitqueue_head(&anchor->wait);
	spin_lock_init(&anchor->lock);
}

1011
typedef void (*usb_complete_t)(struct urb *);
L
Linus Torvalds 已提交
1012 1013 1014 1015

/**
 * struct urb - USB Request Block
 * @urb_list: For use by current owner of the URB.
O
Oliver Neukum 已提交
1016 1017
 * @anchor_list: membership in the list of an anchor
 * @anchor: to anchor URBs to a common mooring
A
Alan Stern 已提交
1018 1019
 * @ep: Points to the endpoint's data structure.  Will eventually
 *	replace @pipe.
L
Linus Torvalds 已提交
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
 * @pipe: Holds endpoint number, direction, type, and more.
 *	Create these values with the eight macros available;
 *	usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl"
 *	(control), "bulk", "int" (interrupt), or "iso" (isochronous).
 *	For example usb_sndbulkpipe() or usb_rcvintpipe().  Endpoint
 *	numbers range from zero to fifteen.  Note that "in" endpoint two
 *	is a different endpoint (and pipe) from "out" endpoint two.
 *	The current configuration controls the existence, type, and
 *	maximum packet size of any given endpoint.
 * @dev: Identifies the USB device to perform the request.
 * @status: This is read in non-iso completion functions to get the
 *	status of the particular request.  ISO requests only use it
 *	to tell whether the URB was unlinked; detailed status for
 *	each frame is in the fields of the iso_frame-desc.
 * @transfer_flags: A variety of flags may be used to affect how URB
 *	submission, unlinking, or operation are handled.  Different
 *	kinds of URB can use different flags.
1037 1038 1039 1040
 * @transfer_buffer:  This identifies the buffer to (or from) which the I/O
 *	request will be performed unless URB_NO_TRANSFER_DMA_MAP is set
 *	(however, do not leave garbage in transfer_buffer even then).
 *	This buffer must be suitable for DMA; allocate it with
L
Linus Torvalds 已提交
1041 1042 1043 1044 1045 1046 1047
 *	kmalloc() or equivalent.  For transfers to "in" endpoints, contents
 *	of this buffer will be modified.  This buffer is used for the data
 *	stage of control transfers.
 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP,
 *	the device driver is saying that it provided this DMA address,
 *	which the host controller driver should use in preference to the
 *	transfer_buffer.
1048 1049
 * @sg: scatter gather buffer list
 * @num_sgs: number of entries in the sg list
L
Linus Torvalds 已提交
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
 * @transfer_buffer_length: How big is transfer_buffer.  The transfer may
 *	be broken up into chunks according to the current maximum packet
 *	size for the endpoint, which is a function of the configuration
 *	and is encoded in the pipe.  When the length is zero, neither
 *	transfer_buffer nor transfer_dma is used.
 * @actual_length: This is read in non-iso completion functions, and
 *	it tells how many bytes (out of transfer_buffer_length) were
 *	transferred.  It will normally be the same as requested, unless
 *	either an error was reported or a short read was performed.
 *	The URB_SHORT_NOT_OK transfer flag may be used to make such
1060
 *	short reads be reported as errors.
L
Linus Torvalds 已提交
1061 1062 1063 1064 1065 1066
 * @setup_packet: Only used for control transfers, this points to eight bytes
 *	of setup data.  Control transfers always start by sending this data
 *	to the device.  Then transfer_buffer is read or written, if needed.
 * @setup_dma: For control transfers with URB_NO_SETUP_DMA_MAP set, the
 *	device driver has provided this DMA address for the setup packet.
 *	The host controller driver should use this in preference to
1067 1068 1069
 *	setup_packet, but the HCD may chose to ignore the address if it must
 *	copy the setup packet into internal structures.  Therefore, setup_packet
 *	must always point to a valid buffer.
L
Linus Torvalds 已提交
1070 1071 1072
 * @start_frame: Returns the initial frame for isochronous transfers.
 * @number_of_packets: Lists the number of ISO transfer buffers.
 * @interval: Specifies the polling interval for interrupt or isochronous
1073
 *	transfers.  The units are frames (milliseconds) for full and low
L
Linus Torvalds 已提交
1074 1075 1076 1077 1078 1079 1080
 *	speed devices, and microframes (1/8 millisecond) for highspeed ones.
 * @error_count: Returns the number of ISO transfers that reported errors.
 * @context: For use in completion functions.  This normally points to
 *	request-specific driver context.
 * @complete: Completion handler. This URB is passed as the parameter to the
 *	completion function.  The completion function may then do what
 *	it likes with the URB, including resubmitting or freeing it.
1081
 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
L
Linus Torvalds 已提交
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
 *	collect the transfer status for each buffer.
 *
 * This structure identifies USB transfer requests.  URBs must be allocated by
 * calling usb_alloc_urb() and freed with a call to usb_free_urb().
 * Initialization may be done using various usb_fill_*_urb() functions.  URBs
 * are submitted using usb_submit_urb(), and pending requests may be canceled
 * using usb_unlink_urb() or usb_kill_urb().
 *
 * Data Transfer Buffers:
 *
 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise
 * taken from the general page pool.  That is provided by transfer_buffer
 * (control requests also use setup_packet), and host controller drivers
 * perform a dma mapping (and unmapping) for each buffer transferred.  Those
 * mapping operations can be expensive on some platforms (perhaps using a dma
 * bounce buffer or talking to an IOMMU),
 * although they're cheap on commodity x86 and ppc hardware.
 *
 * Alternatively, drivers may pass the URB_NO_xxx_DMA_MAP transfer flags,
 * which tell the host controller driver that no such mapping is needed since
 * the device driver is DMA-aware.  For example, a device driver might
 * allocate a DMA buffer with usb_buffer_alloc() or call usb_buffer_map().
 * When these transfer flags are provided, host controller drivers will
 * attempt to use the dma addresses found in the transfer_dma and/or
1106 1107 1108 1109 1110 1111 1112 1113 1114
 * setup_dma fields rather than determining a dma address themselves.
 *
 * Note that transfer_buffer must still be set if the controller
 * does not support DMA (as indicated by bus.uses_dma) and when talking
 * to root hub. If you have to trasfer between highmem zone and the device
 * on such controller, create a bounce buffer or bail out with an error.
 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA
 * capable, assign NULL to it, so that usbmon knows not to use the value.
 * The setup_packet must always be set, so it cannot be located in highmem.
L
Linus Torvalds 已提交
1115 1116 1117 1118
 *
 * Initialization:
 *
 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1119
 * zero), and complete fields.  All URBs must also initialize
L
Linus Torvalds 已提交
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
 * transfer_buffer and transfer_buffer_length.  They may provide the
 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are
 * to be treated as errors; that flag is invalid for write requests.
 *
 * Bulk URBs may
 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers
 * should always terminate with a short packet, even if it means adding an
 * extra zero length packet.
 *
 * Control URBs must provide a setup_packet.  The setup_packet and
 * transfer_buffer may each be mapped for DMA or not, independently of
 * the other.  The transfer_flags bits URB_NO_TRANSFER_DMA_MAP and
 * URB_NO_SETUP_DMA_MAP indicate which buffers have already been mapped.
 * URB_NO_SETUP_DMA_MAP is ignored for non-control URBs.
 *
 * Interrupt URBs must provide an interval, saying how often (in milliseconds
 * or, for highspeed devices, 125 microsecond units)
 * to poll for transfers.  After the URB has been submitted, the interval
 * field reflects how the transfer was actually scheduled.
 * The polling interval may be more frequent than requested.
 * For example, some controllers have a maximum interval of 32 milliseconds,
 * while others support intervals of up to 1024 milliseconds.
 * Isochronous URBs also have transfer intervals.  (Note that for isochronous
 * endpoints, as well as high speed interrupt endpoints, the encoding of
 * the transfer interval in the endpoint descriptor is logarithmic.
 * Device drivers must convert that value to linear units themselves.)
 *
 * Isochronous URBs normally use the URB_ISO_ASAP transfer flag, telling
 * the host controller to schedule the transfer as soon as bandwidth
 * utilization allows, and then set start_frame to reflect the actual frame
 * selected during submission.  Otherwise drivers must specify the start_frame
 * and handle the case where the transfer can't begin then.  However, drivers
 * won't know how bandwidth is currently allocated, and while they can
 * find the current frame using usb_get_current_frame_number () they can't
 * know the range for that frame number.  (Ranges for frame counter values
 * are HC-specific, and can go from 256 to 65536 frames from "now".)
 *
 * Isochronous URBs have a different data transfer model, in part because
 * the quality of service is only "best effort".  Callers provide specially
 * allocated URBs, with number_of_packets worth of iso_frame_desc structures
 * at the end.  Each such packet is an individual ISO transfer.  Isochronous
 * URBs are normally queued, submitted by drivers to arrange that
 * transfers are at least double buffered, and then explicitly resubmitted
 * in completion handlers, so
 * that data (such as audio or video) streams at as constant a rate as the
 * host controller scheduler can support.
 *
 * Completion Callbacks:
 *
 * The completion callback is made in_interrupt(), and one of the first
 * things that a completion handler should do is check the status field.
 * The status field is provided for all URBs.  It is used to report
 * unlinked URBs, and status for all non-ISO transfers.  It should not
 * be examined before the URB is returned to the completion handler.
 *
 * The context field is normally used to link URBs back to the relevant
 * driver or request state.
 *
 * When the completion callback is invoked for non-isochronous URBs, the
 * actual_length field tells how many bytes were transferred.  This field
 * is updated even when the URB terminated with an error or was unlinked.
 *
 * ISO transfer status is reported in the status and actual_length fields
 * of the iso_frame_desc array, and the number of errors is reported in
 * error_count.  Completion callbacks for ISO transfers will normally
 * (re)submit URBs to ensure a constant transfer rate.
1186 1187 1188 1189
 *
 * Note that even fields marked "public" should not be touched by the driver
 * when the urb is owned by the hcd, that is, since the call to
 * usb_submit_urb() till the entry into the completion routine.
L
Linus Torvalds 已提交
1190
 */
1191
struct urb {
1192
	/* private: usb core and host controller only fields in the urb */
L
Linus Torvalds 已提交
1193 1194 1195
	struct kref kref;		/* reference count of the URB */
	void *hcpriv;			/* private data for host controller */
	atomic_t use_count;		/* concurrent submissions counter */
1196
	atomic_t reject;		/* submissions will fail */
A
Alan Stern 已提交
1197
	int unlinked;			/* unlink error code */
L
Linus Torvalds 已提交
1198

1199
	/* public: documented fields in the urb that can be used by drivers */
1200 1201
	struct list_head urb_list;	/* list head for use by the urb's
					 * current owner */
1202
	struct list_head anchor_list;	/* the URB may be anchored */
O
Oliver Neukum 已提交
1203
	struct usb_anchor *anchor;
L
Linus Torvalds 已提交
1204
	struct usb_device *dev; 	/* (in) pointer to associated device */
1205
	struct usb_host_endpoint *ep;	/* (internal) pointer to endpoint */
L
Linus Torvalds 已提交
1206 1207 1208 1209 1210
	unsigned int pipe;		/* (in) pipe information */
	int status;			/* (return) non-ISO status */
	unsigned int transfer_flags;	/* (in) URB_SHORT_NOT_OK | ...*/
	void *transfer_buffer;		/* (in) associated data buffer */
	dma_addr_t transfer_dma;	/* (in) dma addr for transfer_buffer */
1211 1212
	struct usb_sg_request *sg;	/* (in) scatter gather buffer list */
	int num_sgs;			/* (in) number of entries in the sg list */
1213
	u32 transfer_buffer_length;	/* (in) data buffer length */
1214
	u32 actual_length;		/* (return) actual transfer length */
L
Linus Torvalds 已提交
1215 1216 1217 1218
	unsigned char *setup_packet;	/* (in) setup packet (control only) */
	dma_addr_t setup_dma;		/* (in) dma addr for setup_packet */
	int start_frame;		/* (modify) start frame (ISO) */
	int number_of_packets;		/* (in) number of ISO packets */
1219 1220
	int interval;			/* (modify) transfer interval
					 * (INT/ISO) */
L
Linus Torvalds 已提交
1221 1222 1223
	int error_count;		/* (return) number of ISO errors */
	void *context;			/* (in) context for completion */
	usb_complete_t complete;	/* (in) completion routine */
1224 1225
	struct usb_iso_packet_descriptor iso_frame_desc[0];
					/* (in) ISO ONLY */
L
Linus Torvalds 已提交
1226 1227
};

1228
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
1229 1230 1231 1232 1233 1234 1235 1236 1237

/**
 * usb_fill_control_urb - initializes a control urb
 * @urb: pointer to the urb to initialize.
 * @dev: pointer to the struct usb_device for this urb.
 * @pipe: the endpoint pipe
 * @setup_packet: pointer to the setup_packet buffer
 * @transfer_buffer: pointer to the transfer buffer
 * @buffer_length: length of the transfer buffer
1238
 * @complete_fn: pointer to the usb_complete_t function
L
Linus Torvalds 已提交
1239 1240 1241 1242 1243
 * @context: what to set the urb context to.
 *
 * Initializes a control urb with the proper information needed to submit
 * it to a device.
 */
1244 1245 1246 1247 1248 1249 1250 1251
static inline void usb_fill_control_urb(struct urb *urb,
					struct usb_device *dev,
					unsigned int pipe,
					unsigned char *setup_packet,
					void *transfer_buffer,
					int buffer_length,
					usb_complete_t complete_fn,
					void *context)
L
Linus Torvalds 已提交
1252 1253 1254 1255 1256 1257
{
	urb->dev = dev;
	urb->pipe = pipe;
	urb->setup_packet = setup_packet;
	urb->transfer_buffer = transfer_buffer;
	urb->transfer_buffer_length = buffer_length;
1258
	urb->complete = complete_fn;
L
Linus Torvalds 已提交
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
	urb->context = context;
}

/**
 * usb_fill_bulk_urb - macro to help initialize a bulk urb
 * @urb: pointer to the urb to initialize.
 * @dev: pointer to the struct usb_device for this urb.
 * @pipe: the endpoint pipe
 * @transfer_buffer: pointer to the transfer buffer
 * @buffer_length: length of the transfer buffer
1269
 * @complete_fn: pointer to the usb_complete_t function
L
Linus Torvalds 已提交
1270 1271 1272 1273 1274
 * @context: what to set the urb context to.
 *
 * Initializes a bulk urb with the proper information needed to submit it
 * to a device.
 */
1275 1276 1277 1278 1279 1280 1281
static inline void usb_fill_bulk_urb(struct urb *urb,
				     struct usb_device *dev,
				     unsigned int pipe,
				     void *transfer_buffer,
				     int buffer_length,
				     usb_complete_t complete_fn,
				     void *context)
L
Linus Torvalds 已提交
1282 1283 1284 1285 1286
{
	urb->dev = dev;
	urb->pipe = pipe;
	urb->transfer_buffer = transfer_buffer;
	urb->transfer_buffer_length = buffer_length;
1287
	urb->complete = complete_fn;
L
Linus Torvalds 已提交
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
	urb->context = context;
}

/**
 * usb_fill_int_urb - macro to help initialize a interrupt urb
 * @urb: pointer to the urb to initialize.
 * @dev: pointer to the struct usb_device for this urb.
 * @pipe: the endpoint pipe
 * @transfer_buffer: pointer to the transfer buffer
 * @buffer_length: length of the transfer buffer
1298
 * @complete_fn: pointer to the usb_complete_t function
L
Linus Torvalds 已提交
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
 * @context: what to set the urb context to.
 * @interval: what to set the urb interval to, encoded like
 *	the endpoint descriptor's bInterval value.
 *
 * Initializes a interrupt urb with the proper information needed to submit
 * it to a device.
 * Note that high speed interrupt endpoints use a logarithmic encoding of
 * the endpoint interval, and express polling intervals in microframes
 * (eight per millisecond) rather than in frames (one per millisecond).
 */
1309 1310 1311 1312 1313 1314 1315 1316
static inline void usb_fill_int_urb(struct urb *urb,
				    struct usb_device *dev,
				    unsigned int pipe,
				    void *transfer_buffer,
				    int buffer_length,
				    usb_complete_t complete_fn,
				    void *context,
				    int interval)
L
Linus Torvalds 已提交
1317 1318 1319 1320 1321
{
	urb->dev = dev;
	urb->pipe = pipe;
	urb->transfer_buffer = transfer_buffer;
	urb->transfer_buffer_length = buffer_length;
1322
	urb->complete = complete_fn;
L
Linus Torvalds 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331
	urb->context = context;
	if (dev->speed == USB_SPEED_HIGH)
		urb->interval = 1 << (interval - 1);
	else
		urb->interval = interval;
	urb->start_frame = -1;
}

extern void usb_init_urb(struct urb *urb);
A
Al Viro 已提交
1332
extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
L
Linus Torvalds 已提交
1333 1334 1335
extern void usb_free_urb(struct urb *urb);
#define usb_put_urb usb_free_urb
extern struct urb *usb_get_urb(struct urb *urb);
A
Al Viro 已提交
1336
extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
L
Linus Torvalds 已提交
1337 1338
extern int usb_unlink_urb(struct urb *urb);
extern void usb_kill_urb(struct urb *urb);
O
Oliver Neukum 已提交
1339 1340
extern void usb_poison_urb(struct urb *urb);
extern void usb_unpoison_urb(struct urb *urb);
O
Oliver Neukum 已提交
1341
extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
O
Oliver Neukum 已提交
1342
extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
1343
extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
1344
extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
O
Oliver Neukum 已提交
1345 1346 1347 1348
extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
extern void usb_unanchor_urb(struct urb *urb);
extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor,
					 unsigned int timeout);
1349 1350 1351
extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor);
extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor);
extern int usb_anchor_empty(struct usb_anchor *anchor);
L
Linus Torvalds 已提交
1352

1353 1354 1355 1356 1357 1358 1359 1360 1361
/**
 * usb_urb_dir_in - check if an URB describes an IN transfer
 * @urb: URB to be checked
 *
 * Returns 1 if @urb describes an IN transfer (device-to-host),
 * otherwise 0.
 */
static inline int usb_urb_dir_in(struct urb *urb)
{
A
Alan Stern 已提交
1362
	return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
}

/**
 * usb_urb_dir_out - check if an URB describes an OUT transfer
 * @urb: URB to be checked
 *
 * Returns 1 if @urb describes an OUT transfer (host-to-device),
 * otherwise 0.
 */
static inline int usb_urb_dir_out(struct urb *urb)
{
	return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT;
}

1377
void *usb_buffer_alloc(struct usb_device *dev, size_t size,
A
Al Viro 已提交
1378
	gfp_t mem_flags, dma_addr_t *dma);
1379
void usb_buffer_free(struct usb_device *dev, size_t size,
L
Linus Torvalds 已提交
1380 1381 1382
	void *addr, dma_addr_t dma);

#if 0
1383 1384 1385
struct urb *usb_buffer_map(struct urb *urb);
void usb_buffer_dmasync(struct urb *urb);
void usb_buffer_unmap(struct urb *urb);
L
Linus Torvalds 已提交
1386 1387 1388
#endif

struct scatterlist;
A
Alan Stern 已提交
1389
int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
1390
		      struct scatterlist *sg, int nents);
L
Linus Torvalds 已提交
1391
#if 0
A
Alan Stern 已提交
1392
void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
1393
			   struct scatterlist *sg, int n_hw_ents);
L
Linus Torvalds 已提交
1394
#endif
A
Alan Stern 已提交
1395
void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
1396
			 struct scatterlist *sg, int n_hw_ents);
L
Linus Torvalds 已提交
1397 1398 1399 1400 1401 1402 1403 1404

/*-------------------------------------------------------------------*
 *                         SYNCHRONOUS CALL SUPPORT                  *
 *-------------------------------------------------------------------*/

extern int usb_control_msg(struct usb_device *dev, unsigned int pipe,
	__u8 request, __u8 requesttype, __u16 value, __u16 index,
	void *data, __u16 size, int timeout);
1405 1406
extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
	void *data, int len, int *actual_length, int timeout);
L
Linus Torvalds 已提交
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
	void *data, int len, int *actual_length,
	int timeout);

/* wrappers around usb_control_msg() for the most common standard requests */
extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype,
	unsigned char descindex, void *buf, int size);
extern int usb_get_status(struct usb_device *dev,
	int type, int target, void *data);
extern int usb_string(struct usb_device *dev, int index,
	char *buf, size_t size);

/* wrappers that also update important state inside usbcore */
extern int usb_clear_halt(struct usb_device *dev, int pipe);
extern int usb_reset_configuration(struct usb_device *dev);
extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate);
1423
extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
L
Linus Torvalds 已提交
1424

1425 1426 1427
/* this request isn't really synchronous, but it belongs with the others */
extern int usb_driver_set_configuration(struct usb_device *udev, int config);

L
Linus Torvalds 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
/*
 * timeouts, in milliseconds, used for sending/receiving control messages
 * they typically complete within a few frames (msec) after they're issued
 * USB identifies 5 second timeouts, maybe more in a few cases, and a few
 * slow devices (like some MGE Ellipse UPSes) actually push that limit.
 */
#define USB_CTRL_GET_TIMEOUT	5000
#define USB_CTRL_SET_TIMEOUT	5000


/**
 * struct usb_sg_request - support for scatter/gather I/O
 * @status: zero indicates success, else negative errno
 * @bytes: counts bytes transferred.
 *
 * These requests are initialized using usb_sg_init(), and then are used
 * as request handles passed to usb_sg_wait() or usb_sg_cancel().  Most
 * members of the request object aren't for driver access.
 *
 * The status and bytecount values are valid only after usb_sg_wait()
 * returns.  If the status is zero, then the bytecount matches the total
 * from the request.
 *
 * After an error completion, drivers may need to clear a halt condition
 * on the endpoint.
 */
struct usb_sg_request {
	int			status;
	size_t			bytes;

1458 1459
	/* private:
	 * members below are private to usbcore,
L
Linus Torvalds 已提交
1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
	 * and are not provided for driver access!
	 */
	spinlock_t		lock;

	struct usb_device	*dev;
	int			pipe;
	struct scatterlist	*sg;
	int			nents;

	int			entries;
	struct urb		**urbs;

	int			count;
	struct completion	complete;
};

1476
int usb_sg_init(
L
Linus Torvalds 已提交
1477 1478
	struct usb_sg_request	*io,
	struct usb_device	*dev,
1479
	unsigned		pipe,
L
Linus Torvalds 已提交
1480 1481 1482 1483
	unsigned		period,
	struct scatterlist	*sg,
	int			nents,
	size_t			length,
A
Al Viro 已提交
1484
	gfp_t			mem_flags
L
Linus Torvalds 已提交
1485
);
1486 1487
void usb_sg_cancel(struct usb_sg_request *io);
void usb_sg_wait(struct usb_sg_request *io);
L
Linus Torvalds 已提交
1488 1489


1490
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527

/*
 * For various legacy reasons, Linux has a small cookie that's paired with
 * a struct usb_device to identify an endpoint queue.  Queue characteristics
 * are defined by the endpoint's descriptor.  This cookie is called a "pipe",
 * an unsigned int encoded as:
 *
 *  - direction:	bit 7		(0 = Host-to-Device [Out],
 *					 1 = Device-to-Host [In] ...
 *					like endpoint bEndpointAddress)
 *  - device address:	bits 8-14       ... bit positions known to uhci-hcd
 *  - endpoint:		bits 15-18      ... bit positions known to uhci-hcd
 *  - pipe type:	bits 30-31	(00 = isochronous, 01 = interrupt,
 *					 10 = control, 11 = bulk)
 *
 * Given the device address and endpoint descriptor, pipes are redundant.
 */

/* NOTE:  these are not the standard USB_ENDPOINT_XFER_* values!! */
/* (yet ... they're the values used by usbfs) */
#define PIPE_ISOCHRONOUS		0
#define PIPE_INTERRUPT			1
#define PIPE_CONTROL			2
#define PIPE_BULK			3

#define usb_pipein(pipe)	((pipe) & USB_DIR_IN)
#define usb_pipeout(pipe)	(!usb_pipein(pipe))

#define usb_pipedevice(pipe)	(((pipe) >> 8) & 0x7f)
#define usb_pipeendpoint(pipe)	(((pipe) >> 15) & 0xf)

#define usb_pipetype(pipe)	(((pipe) >> 30) & 3)
#define usb_pipeisoc(pipe)	(usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
#define usb_pipeint(pipe)	(usb_pipetype((pipe)) == PIPE_INTERRUPT)
#define usb_pipecontrol(pipe)	(usb_pipetype((pipe)) == PIPE_CONTROL)
#define usb_pipebulk(pipe)	(usb_pipetype((pipe)) == PIPE_BULK)

1528 1529
static inline unsigned int __create_pipe(struct usb_device *dev,
		unsigned int endpoint)
L
Linus Torvalds 已提交
1530 1531 1532 1533 1534
{
	return (dev->devnum << 8) | (endpoint << 15);
}

/* Create various pipes... */
1535
#define usb_sndctrlpipe(dev,endpoint)	\
1536
	((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
1537
#define usb_rcvctrlpipe(dev,endpoint)	\
1538
	((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1539
#define usb_sndisocpipe(dev,endpoint)	\
1540
	((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
1541
#define usb_rcvisocpipe(dev,endpoint)	\
1542
	((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1543
#define usb_sndbulkpipe(dev,endpoint)	\
1544
	((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
1545
#define usb_rcvbulkpipe(dev,endpoint)	\
1546
	((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1547
#define usb_sndintpipe(dev,endpoint)	\
1548
	((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
1549
#define usb_rcvintpipe(dev,endpoint)	\
1550
	((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
L
Linus Torvalds 已提交
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573

/*-------------------------------------------------------------------------*/

static inline __u16
usb_maxpacket(struct usb_device *udev, int pipe, int is_out)
{
	struct usb_host_endpoint	*ep;
	unsigned			epnum = usb_pipeendpoint(pipe);

	if (is_out) {
		WARN_ON(usb_pipein(pipe));
		ep = udev->ep_out[epnum];
	} else {
		WARN_ON(usb_pipeout(pipe));
		ep = udev->ep_in[epnum];
	}
	if (!ep)
		return 0;

	/* NOTE:  only 0x07ff bits are for packet size... */
	return le16_to_cpu(ep->desc.wMaxPacketSize);
}

1574
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
1575

1576 1577 1578 1579 1580 1581 1582 1583
/* Events from the usb core */
#define USB_DEVICE_ADD		0x0001
#define USB_DEVICE_REMOVE	0x0002
#define USB_BUS_ADD		0x0003
#define USB_BUS_REMOVE		0x0004
extern void usb_register_notify(struct notifier_block *nb);
extern void usb_unregister_notify(struct notifier_block *nb);

L
Linus Torvalds 已提交
1584
#ifdef DEBUG
1585 1586
#define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
	__FILE__ , ## arg)
L
Linus Torvalds 已提交
1587 1588 1589 1590
#else
#define dbg(format, arg...) do {} while (0)
#endif

1591 1592
#define err(format, arg...) printk(KERN_ERR KBUILD_MODNAME ": " \
	format "\n" , ## arg)
L
Linus Torvalds 已提交
1593

1594 1595 1596
/* debugfs stuff */
extern struct dentry *usb_debug_root;

L
Linus Torvalds 已提交
1597 1598 1599
#endif  /* __KERNEL__ */

#endif