usb.h 70.5 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 */
23
#include <linux/pm_runtime.h>	/* for runtime PM */
L
Linus Torvalds 已提交
24 25 26

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

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

/*
 * 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.
40
 *  - a SuperSpeed endpoint has a companion descriptor
L
Linus Torvalds 已提交
41 42 43 44 45 46
 *
 * And there might be other descriptors mixed in with those.
 *
 * Devices may also have class-specific or vendor-specific descriptors.
 */

47 48
struct ep_device;

L
Linus Torvalds 已提交
49 50 51
/**
 * struct usb_host_endpoint - host-side endpoint descriptor and queue
 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder
52
 * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint
L
Linus Torvalds 已提交
53 54 55
 * @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 已提交
56
 * @ep_dev: ep_device for sysfs info
L
Linus Torvalds 已提交
57 58
 * @extra: descriptors following this endpoint in the configuration
 * @extralen: how many bytes of "extra" are valid
A
Alan Stern 已提交
59
 * @enabled: URBs may be submitted to this endpoint
L
Linus Torvalds 已提交
60 61 62 63 64
 *
 * 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 {
65 66
	struct usb_endpoint_descriptor		desc;
	struct usb_ss_ep_comp_descriptor	ss_ep_comp;
L
Linus Torvalds 已提交
67 68
	struct list_head		urb_list;
	void				*hcpriv;
69
	struct ep_device		*ep_dev;	/* For sysfs info */
L
Linus Torvalds 已提交
70 71 72

	unsigned char *extra;   /* Extra descriptors */
	int extralen;
A
Alan Stern 已提交
73
	int enabled;
L
Linus Torvalds 已提交
74 75 76 77 78 79
};

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

80 81 82
	int extralen;
	unsigned char *extra;   /* Extra descriptors */

L
Linus Torvalds 已提交
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
	/* 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 */
};

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
101 102
 *	setting that may be selected.  Each one includes a set of
 *	endpoint configurations.  They will be in no particular order.
L
Linus Torvalds 已提交
103
 * @cur_altsetting: the current altsetting.
104
 * @num_altsetting: number of altsettings defined.
R
Randy Dunlap 已提交
105
 * @intf_assoc: interface association descriptor
L
Linus Torvalds 已提交
106 107 108 109 110 111 112 113
 * @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())
R
Randy Dunlap 已提交
114
 * @sysfs_files_created: sysfs attributes exist
A
Alan Stern 已提交
115
 * @ep_devs_created: endpoint child pseudo-devices exist
116
 * @unregistering: flag set when the interface is being unregistered
117 118
 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup
 *	capability during autosuspend.
119 120
 * @needs_altsetting0: flag set when a set-interface request for altsetting 0
 *	has been deferred.
121 122
 * @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 已提交
123
 * @dev: driver model's view of this device
124 125
 * @usb_dev: if an interface is bound to the USB major, this will point
 *	to the sysfs representation for that device.
126
 * @pm_usage_cnt: PM usage counter for this interface
127 128 129 130 131
 * @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().
132 133
 * @resetting_device: USB core reset the device, so use alt setting 0 as
 *	current; needs bandwidth alloc after reset.
L
Linus Torvalds 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
 *
 * 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
149
 * used to control the use of periodic endpoints, such as by having
L
Linus Torvalds 已提交
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
 * 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 */

169 170 171 172
	/* If there is an interface association descriptor then it will list
	 * the associated interfaces */
	struct usb_interface_assoc_descriptor *intf_assoc;

173 174
	int minor;			/* minor number this interface is
					 * bound to */
L
Linus Torvalds 已提交
175
	enum usb_interface_condition condition;		/* state of binding */
176
	unsigned sysfs_files_created:1;	/* the sysfs attributes exist */
A
Alan Stern 已提交
177
	unsigned ep_devs_created:1;	/* endpoint "devices" exist */
178
	unsigned unregistering:1;	/* unregistration is in progress */
179
	unsigned needs_remote_wakeup:1;	/* driver requires remote wakeup */
180
	unsigned needs_altsetting0:1;	/* switch to altsetting 0 is pending */
181
	unsigned needs_binding:1;	/* needs delayed unbind/rebind */
182
	unsigned reset_running:1;
183
	unsigned resetting_device:1;	/* true: bandwidth alloc after reset */
184

L
Linus Torvalds 已提交
185
	struct device dev;		/* interface specific device info */
186
	struct device *usb_dev;
A
Alan Stern 已提交
187
	atomic_t pm_usage_cnt;		/* usage counter for autosuspend */
188
	struct work_struct reset_ws;	/* for resets in atomic context */
L
Linus Torvalds 已提交
189 190 191
};
#define	to_usb_interface(d) container_of(d, struct usb_interface, dev)

192
static inline void *usb_get_intfdata(struct usb_interface *intf)
L
Linus Torvalds 已提交
193
{
194
	return dev_get_drvdata(&intf->dev);
L
Linus Torvalds 已提交
195 196
}

197
static inline void usb_set_intfdata(struct usb_interface *intf, void *data)
L
Linus Torvalds 已提交
198 199 200 201 202 203 204 205 206
{
	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
207
#define USB_MAXIADS		(USB_MAXINTERFACES/2)
L
Linus Torvalds 已提交
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

/**
 * 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 已提交
241
 * @intf_assoc: list of any interface association descriptors in this config
L
Linus Torvalds 已提交
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
 * @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
271
 * desires (expressed through userspace tools).  However, drivers can call
L
Linus Torvalds 已提交
272 273 274 275 276 277
 * usb_reset_configuration() to reinitialize the current configuration and
 * all its interfaces.
 */
struct usb_host_config {
	struct usb_config_descriptor	desc;

278
	char *string;		/* iConfiguration string, if present */
279 280 281 282 283

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

L
Linus Torvalds 已提交
284 285 286 287 288 289 290 291 292 293 294 295
	/* 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;
};

A
Andiry Xu 已提交
296 297 298 299 300 301 302 303 304 305
/* USB2.0 and USB3.0 device BOS descriptor set */
struct usb_host_bos {
	struct usb_bos_descriptor	*desc;

	/* wireless cap descriptor is handled by wusb */
	struct usb_ext_cap_descriptor	*ext_cap;
	struct usb_ss_cap_descriptor	*ss_cap;
	struct usb_ss_container_id_descriptor	*ss_id;
};

L
Linus Torvalds 已提交
306 307
int __usb_get_extra_descriptor(char *buffer, unsigned size,
	unsigned char type, void **ptr);
308 309 310 311
#define usb_get_extra_descriptor(ifpoint, type, ptr) \
				__usb_get_extra_descriptor((ifpoint)->extra, \
				(ifpoint)->extralen, \
				type, (void **)ptr)
L
Linus Torvalds 已提交
312

313
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
314 315 316 317 318 319 320 321 322 323 324 325

/* 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) */
326
	const char *bus_name;		/* stable id (PCI slot_name etc) */
327
	u8 uses_dma;			/* Does the host controller use DMA? */
328 329 330 331
	u8 uses_pio_for_control;	/*
					 * Does the host controller use PIO
					 * for control transfers?
					 */
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 336 337 338 339
	unsigned no_stop_on_short:1;    /*
					 * Quirk: some controllers don't stop
					 * the ep queue on a short transfer
					 * with the URB_SHORT_NOT_OK flag set.
					 */
340
	unsigned no_sg_constraint:1;	/* no sg constraint */
341
	unsigned sg_tablesize;		/* 0 or largest number of sg list entries */
L
Linus Torvalds 已提交
342

343 344
	int devnum_next;		/* Next open device number in
					 * round-robin allocation */
L
Linus Torvalds 已提交
345 346 347

	struct usb_devmap devmap;	/* device address allocation map */
	struct usb_device *root_hub;	/* Root hub */
348
	struct usb_bus *hs_companion;	/* Companion EHCI bus, if any */
L
Linus Torvalds 已提交
349 350 351 352 353 354 355 356 357 358 359 360
	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 */

361 362
	unsigned resuming_ports;	/* bit array: resuming root-hub ports */

363
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
L
Linus Torvalds 已提交
364 365 366 367 368
	struct mon_bus *mon_bus;	/* non-null when associated */
	int monitored;			/* non-zero when monitored */
#endif
};

369
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
370 371 372

struct usb_tt;

373 374 375 376 377 378
enum usb_device_removable {
	USB_DEVICE_REMOVABLE_UNKNOWN = 0,
	USB_DEVICE_REMOVABLE,
	USB_DEVICE_FIXED,
};

379 380 381 382 383 384 385
enum usb_port_connect_type {
	USB_PORT_CONNECT_TYPE_UNKNOWN = 0,
	USB_PORT_CONNECT_TYPE_HOT_PLUG,
	USB_PORT_CONNECT_TYPE_HARD_WIRED,
	USB_PORT_NOT_USED,
};

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
/*
 * USB 2.0 Link Power Management (LPM) parameters.
 */
struct usb2_lpm_parameters {
	/* Best effort service latency indicate how long the host will drive
	 * resume on an exit from L1.
	 */
	unsigned int besl;

	/* Timeout value in microseconds for the L1 inactivity (LPM) timer.
	 * When the timer counts to zero, the parent hub will initiate a LPM
	 * transition to L1.
	 */
	int timeout;
};

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
/*
 * USB 3.0 Link Power Management (LPM) parameters.
 *
 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit.
 * All three are stored in nanoseconds.
 */
struct usb3_lpm_parameters {
	/*
	 * Maximum exit latency (MEL) for the host to send a packet to the
	 * device (either a Ping for isoc endpoints, or a data packet for
	 * interrupt endpoints), the hubs to decode the packet, and for all hubs
	 * in the path to transition the links to U0.
	 */
	unsigned int mel;
	/*
	 * Maximum exit latency for a device-initiated LPM transition to bring
	 * all links into U0.  Abbreviated as "PEL" in section 9.4.12 of the USB
	 * 3.0 spec, with no explanation of what "P" stands for.  "Path"?
	 */
	unsigned int pel;

	/*
	 * The System Exit Latency (SEL) includes PEL, and three other
	 * latencies.  After a device initiates a U0 transition, it will take
	 * some time from when the device sends the ERDY to when it will finally
	 * receive the data packet.  Basically, SEL should be the worse-case
	 * latency from when a device starts initiating a U0 transition to when
	 * it will get data.
	 */
	unsigned int sel;
433 434 435 436 437 438
	/*
	 * The idle timeout value that is currently programmed into the parent
	 * hub for this device.  When the timer counts to zero, the parent hub
	 * will initiate an LPM transition to either U1 or U2.
	 */
	int timeout;
439 440
};

441
/**
L
Linus Torvalds 已提交
442
 * struct usb_device - kernel's representation of a USB device
443 444
 * @devnum: device number; address on a USB bus
 * @devpath: device ID string for use in messages (e.g., /port/...)
445
 * @route: tree topology hex string for use with xHCI
446 447 448 449 450 451 452 453 454 455
 * @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
A
Andiry Xu 已提交
456
 * @bos: USB device BOS descriptor set
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
 * @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
 * @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
473
 * @authenticated: Crypto authentication passed
474
 * @wusb: device is Wireless USB
475
 * @lpm_capable: device supports LPM
A
Andiry Xu 已提交
476
 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM
477
 * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM
478 479
 * @usb2_hw_lpm_enabled: USB2 hardware LPM is enabled
 * @usb2_hw_lpm_allowed: Userspace allows USB 2.0 LPM to be enabled
480
 * @usb3_lpm_enabled: USB3 hardware LPM enabled
481 482 483 484 485 486 487 488 489 490 491 492
 * @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
 * @maxchild: number of ports if hub
 * @quirks: quirks of the whole device
 * @urbnum: number of URBs submitted for the whole device
 * @active_duration: total time device is not suspended
 * @connect_time: time device was first connected
 * @do_remote_wakeup:  remote wakeup should be enabled
 * @reset_resume: needs reset instead of resume
A
Alan Stern 已提交
493
 * @port_is_suspended: the upstream port is suspended (L2 or U3)
494 495
 * @wusb_dev: if this is a Wireless USB device, link to the WUSB
 *	specific data for the device.
496
 * @slot_id: Slot ID assigned by xHCI
497
 * @removable: Device can be physically removed from this port
498
 * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout.
499 500 501 502 503 504
 * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout.
 * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout.
 * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
 *	to keep track of the number of functions that require USB 3.0 Link Power
 *	Management to be disabled for this usb_device.  This count should only
 *	be manipulated by those functions, with the bandwidth_mutex is held.
L
Linus Torvalds 已提交
505
 *
506
 * Notes:
L
Linus Torvalds 已提交
507 508 509 510
 * Usbcore drivers should not set usbdev->state directly.  Instead use
 * usb_set_device_state().
 */
struct usb_device {
511
	int		devnum;
512
	char		devpath[16];
513
	u32		route;
514 515
	enum usb_device_state	state;
	enum usb_device_speed	speed;
L
Linus Torvalds 已提交
516

517 518
	struct usb_tt	*tt;
	int		ttport;
L
Linus Torvalds 已提交
519

520
	unsigned int toggle[2];
L
Linus Torvalds 已提交
521

522 523
	struct usb_device *parent;
	struct usb_bus *bus;
L
Linus Torvalds 已提交
524 525
	struct usb_host_endpoint ep0;

526
	struct device dev;
L
Linus Torvalds 已提交
527

528
	struct usb_device_descriptor descriptor;
A
Andiry Xu 已提交
529
	struct usb_host_bos *bos;
530
	struct usb_host_config *config;
L
Linus Torvalds 已提交
531

532
	struct usb_host_config *actconfig;
L
Linus Torvalds 已提交
533 534 535
	struct usb_host_endpoint *ep_in[16];
	struct usb_host_endpoint *ep_out[16];

536
	char **rawdescriptors;
L
Linus Torvalds 已提交
537

538 539 540
	unsigned short bus_mA;
	u8 portnum;
	u8 level;
541

542 543 544 545
	unsigned can_submit:1;
	unsigned persist_enabled:1;
	unsigned have_langid:1;
	unsigned authorized:1;
546
	unsigned authenticated:1;
547
	unsigned wusb:1;
548
	unsigned lpm_capable:1;
A
Andiry Xu 已提交
549
	unsigned usb2_hw_lpm_capable:1;
550
	unsigned usb2_hw_lpm_besl_capable:1;
A
Andiry Xu 已提交
551
	unsigned usb2_hw_lpm_enabled:1;
552
	unsigned usb2_hw_lpm_allowed:1;
553
	unsigned usb3_lpm_enabled:1;
554
	int string_langid;
L
Linus Torvalds 已提交
555

556
	/* static strings from the device */
557 558 559
	char *product;
	char *manufacturer;
	char *serial;
560

L
Linus Torvalds 已提交
561 562
	struct list_head filelist;

563
	int maxchild;
564

565 566
	u32 quirks;
	atomic_t urbnum;
567

568
	unsigned long active_duration;
S
Sarah Sharp 已提交
569

570
#ifdef CONFIG_PM
571 572 573 574
	unsigned long connect_time;

	unsigned do_remote_wakeup:1;
	unsigned reset_resume:1;
A
Alan Stern 已提交
575
	unsigned port_is_suspended:1;
576
#endif
577
	struct wusb_dev *wusb_dev;
578
	int slot_id;
579
	enum usb_device_removable removable;
580
	struct usb2_lpm_parameters l1_params;
581 582
	struct usb3_lpm_parameters u1_params;
	struct usb3_lpm_parameters u2_params;
583
	unsigned lpm_disable_count;
L
Linus Torvalds 已提交
584 585 586
};
#define	to_usb_device(d) container_of(d, struct usb_device, dev)

587 588 589 590 591
static inline struct usb_device *interface_to_usbdev(struct usb_interface *intf)
{
	return to_usb_device(intf->dev.parent);
}

L
Linus Torvalds 已提交
592 593
extern struct usb_device *usb_get_dev(struct usb_device *dev);
extern void usb_put_dev(struct usb_device *dev);
594 595 596 597 598 599 600 601 602 603 604
extern struct usb_device *usb_hub_find_child(struct usb_device *hdev,
	int port1);

/**
 * usb_hub_for_each_child - iterate over all child devices on the hub
 * @hdev:  USB device belonging to the usb hub
 * @port1: portnum associated with child device
 * @child: child device pointer
 */
#define usb_hub_for_each_child(hdev, port1, child) \
	for (port1 = 1,	child =	usb_hub_find_child(hdev, port1); \
605 606 607
			port1 <= hdev->maxchild; \
			child = usb_hub_find_child(hdev, ++port1)) \
		if (!child) continue; else
L
Linus Torvalds 已提交
608

609
/* USB device locking */
610 611 612
#define usb_lock_device(udev)		device_lock(&(udev)->dev)
#define usb_unlock_device(udev)		device_unlock(&(udev)->dev)
#define usb_trylock_device(udev)	device_trylock(&(udev)->dev)
L
Linus Torvalds 已提交
613
extern int usb_lock_device_for_reset(struct usb_device *udev,
614
				     const struct usb_interface *iface);
L
Linus Torvalds 已提交
615 616 617

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

620 621 622 623 624 625 626 627 628 629
#ifdef CONFIG_ACPI
extern int usb_acpi_set_power_state(struct usb_device *hdev, int index,
	bool enable);
extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index);
#else
static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index,
	bool enable) { return 0; }
static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
	{ return true; }
#endif
L
Linus Torvalds 已提交
630

631
/* USB autosuspend and autoresume */
632
#ifdef CONFIG_PM_RUNTIME
633 634
extern void usb_enable_autosuspend(struct usb_device *udev);
extern void usb_disable_autosuspend(struct usb_device *udev);
635

636 637
extern int usb_autopm_get_interface(struct usb_interface *intf);
extern void usb_autopm_put_interface(struct usb_interface *intf);
638 639
extern int usb_autopm_get_interface_async(struct usb_interface *intf);
extern void usb_autopm_put_interface_async(struct usb_interface *intf);
640 641
extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
642

643 644
static inline void usb_mark_last_busy(struct usb_device *udev)
{
645
	pm_runtime_mark_last_busy(&udev->dev);
646 647
}

648 649
#else

650 651 652 653 654
static inline int usb_enable_autosuspend(struct usb_device *udev)
{ return 0; }
static inline int usb_disable_autosuspend(struct usb_device *udev)
{ return 0; }

655 656
static inline int usb_autopm_get_interface(struct usb_interface *intf)
{ return 0; }
657 658 659
static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
{ return 0; }

660 661
static inline void usb_autopm_put_interface(struct usb_interface *intf)
{ }
662 663
static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
{ }
664 665
static inline void usb_autopm_get_interface_no_resume(
		struct usb_interface *intf)
666
{ }
667 668
static inline void usb_autopm_put_interface_no_suspend(
		struct usb_interface *intf)
669
{ }
670 671
static inline void usb_mark_last_busy(struct usb_device *udev)
{ }
672
#endif
673

674 675 676 677 678 679
extern int usb_disable_lpm(struct usb_device *udev);
extern void usb_enable_lpm(struct usb_device *udev);
/* Same as above, but these functions lock/unlock the bandwidth_mutex. */
extern int usb_unlocked_disable_lpm(struct usb_device *udev);
extern void usb_unlocked_enable_lpm(struct usb_device *udev);

680 681 682
extern int usb_disable_ltm(struct usb_device *udev);
extern void usb_enable_ltm(struct usb_device *udev);

683 684 685 686 687 688 689
static inline bool usb_device_supports_ltm(struct usb_device *udev)
{
	if (udev->speed != USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap)
		return false;
	return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT;
}

690 691 692 693 694
static inline bool usb_device_no_sg_constraint(struct usb_device *udev)
{
	return udev && udev->bus && udev->bus->no_sg_constraint;
}

695

L
Linus Torvalds 已提交
696 697 698
/*-------------------------------------------------------------------------*/

/* for drivers using iso endpoints */
699
extern int usb_get_current_frame_number(struct usb_device *usb_dev);
L
Linus Torvalds 已提交
700

701 702 703 704 705 706
/* Sets up a group of bulk endpoints to support multiple stream IDs. */
extern int usb_alloc_streams(struct usb_interface *interface,
		struct usb_host_endpoint **eps, unsigned int num_eps,
		unsigned int num_streams, gfp_t mem_flags);

/* Reverts a group of bulk endpoints back to not using stream IDs. */
707
extern int usb_free_streams(struct usb_interface *interface,
708 709 710
		struct usb_host_endpoint **eps, unsigned int num_eps,
		gfp_t mem_flags);

L
Linus Torvalds 已提交
711 712
/* used these for multi-interface device registration */
extern int usb_driver_claim_interface(struct usb_driver *driver,
713
			struct usb_interface *iface, void *priv);
L
Linus Torvalds 已提交
714 715 716 717 718

/**
 * usb_interface_claimed - returns true iff an interface is claimed
 * @iface: the interface being checked
 *
719 720 721 722
 * Return: %true (nonzero) iff the interface is claimed, else %false
 * (zero).
 *
 * Note:
L
Linus Torvalds 已提交
723 724 725 726 727
 * 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.
 *
 */
728 729
static inline int usb_interface_claimed(struct usb_interface *iface)
{
L
Linus Torvalds 已提交
730 731 732 733 734 735 736
	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);
737 738
extern int usb_match_one_id(struct usb_interface *interface,
			    const struct usb_device_id *id);
L
Linus Torvalds 已提交
739

740
extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *));
L
Linus Torvalds 已提交
741 742
extern struct usb_interface *usb_find_interface(struct usb_driver *drv,
		int minor);
743
extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev,
L
Linus Torvalds 已提交
744 745
		unsigned ifnum);
extern struct usb_host_interface *usb_altnum_to_altsetting(
746
		const struct usb_interface *intf, unsigned int altnum);
747 748 749 750
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 已提交
751 752 753 754 755 756 757 758


/**
 * 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"?
 *
759
 * Return: Length of the string (> 0) or negative if size was too small.
L
Linus Torvalds 已提交
760
 *
761
 * Note:
L
Linus Torvalds 已提交
762 763 764 765 766
 * 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
L
Lucas De Marchi 已提交
767
 * in host controller driver modules, does not change these path identifiers;
L
Linus Torvalds 已提交
768 769 770 771 772 773 774 775 776 777
 * 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.
 */
778
static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size)
L
Linus Torvalds 已提交
779 780
{
	int actual;
781 782
	actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name,
			  dev->devpath);
L
Linus Torvalds 已提交
783 784 785 786 787
	return (actual >= (int)size) ? -1 : actual;
}

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

788 789 790 791 792 793
#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 已提交
794
#define USB_DEVICE_ID_MATCH_DEV_INFO \
795 796 797
		(USB_DEVICE_ID_MATCH_DEV_CLASS | \
		USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \
		USB_DEVICE_ID_MATCH_DEV_PROTOCOL)
L
Linus Torvalds 已提交
798
#define USB_DEVICE_ID_MATCH_INT_INFO \
799 800 801
		(USB_DEVICE_ID_MATCH_INT_CLASS | \
		USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
		USB_DEVICE_ID_MATCH_INT_PROTOCOL)
L
Linus Torvalds 已提交
802 803 804 805 806 807 808 809 810

/**
 * 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.
 */
811
#define USB_DEVICE(vend, prod) \
812 813 814
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
	.idVendor = (vend), \
	.idProduct = (prod)
L
Linus Torvalds 已提交
815
/**
R
Randy Dunlap 已提交
816
 * USB_DEVICE_VER - describe a specific usb device with a version range
L
Linus Torvalds 已提交
817 818 819 820 821 822 823 824
 * @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.
 */
825
#define USB_DEVICE_VER(vend, prod, lo, hi) \
826
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \
827 828 829 830
	.idVendor = (vend), \
	.idProduct = (prod), \
	.bcdDevice_lo = (lo), \
	.bcdDevice_hi = (hi)
L
Linus Torvalds 已提交
831

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
/**
 * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class
 * @vend: the 16 bit USB Vendor ID
 * @prod: the 16 bit USB Product ID
 * @cl: bInterfaceClass value
 *
 * This macro is used to create a struct usb_device_id that matches a
 * specific interface class of devices.
 */
#define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
		       USB_DEVICE_ID_MATCH_INT_CLASS, \
	.idVendor = (vend), \
	.idProduct = (prod), \
	.bInterfaceClass = (cl)

848
/**
R
Randy Dunlap 已提交
849
 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol
850 851 852 853 854 855 856
 * @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.
 */
857 858 859
#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
		       USB_DEVICE_ID_MATCH_INT_PROTOCOL, \
860 861 862 863
	.idVendor = (vend), \
	.idProduct = (prod), \
	.bInterfaceProtocol = (pr)

864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
/**
 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number
 * @vend: the 16 bit USB Vendor ID
 * @prod: the 16 bit USB Product ID
 * @num: bInterfaceNumber value
 *
 * This macro is used to create a struct usb_device_id that matches a
 * specific interface number of devices.
 */
#define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
		       USB_DEVICE_ID_MATCH_INT_NUMBER, \
	.idVendor = (vend), \
	.idProduct = (prod), \
	.bInterfaceNumber = (num)

L
Linus Torvalds 已提交
880 881 882 883 884 885 886 887 888
/**
 * 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.
 */
889 890 891 892 893
#define USB_DEVICE_INFO(cl, sc, pr) \
	.match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \
	.bDeviceClass = (cl), \
	.bDeviceSubClass = (sc), \
	.bDeviceProtocol = (pr)
L
Linus Torvalds 已提交
894 895

/**
896
 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
L
Linus Torvalds 已提交
897 898 899 900 901 902 903
 * @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.
 */
904 905 906 907 908
#define USB_INTERFACE_INFO(cl, sc, pr) \
	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
	.bInterfaceClass = (cl), \
	.bInterfaceSubClass = (sc), \
	.bInterfaceProtocol = (pr)
909 910

/**
R
Randy Dunlap 已提交
911
 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces
912 913 914 915 916 917 918 919 920 921 922 923
 * @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.
 */
924
#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \
925 926
	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
		| USB_DEVICE_ID_MATCH_DEVICE, \
927 928
	.idVendor = (vend), \
	.idProduct = (prod), \
929
	.bInterfaceClass = (cl), \
930 931
	.bInterfaceSubClass = (sc), \
	.bInterfaceProtocol = (pr)
L
Linus Torvalds 已提交
932

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
/**
 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces
 * @vend: the 16 bit USB Vendor 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 vendor with a specific class of interfaces.
 *
 * This is especially useful when explicitly matching devices that have
 * vendor specific bDeviceClass values, but standards-compliant interfaces.
 */
#define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \
	.match_flags = USB_DEVICE_ID_MATCH_INT_INFO \
		| USB_DEVICE_ID_MATCH_VENDOR, \
	.idVendor = (vend), \
	.bInterfaceClass = (cl), \
	.bInterfaceSubClass = (sc), \
	.bInterfaceProtocol = (pr)

954
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
955

956
/* Stuff for dynamic usb ids */
957 958 959 960 961
struct usb_dynids {
	spinlock_t lock;
	struct list_head list;
};

962 963 964 965 966 967
struct usb_dynid {
	struct list_head node;
	struct usb_device_id id;
};

extern ssize_t usb_store_new_id(struct usb_dynids *dynids,
968
				const struct usb_device_id *id_table,
969 970 971
				struct device_driver *driver,
				const char *buf, size_t count);

972 973
extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf);

L
Linus Torvalds 已提交
974
/**
975 976 977 978 979 980 981 982 983 984 985
 * 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 已提交
986 987 988 989
 * @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
990
 *	usb_set_intfdata() to associate driver-specific data with the
L
Linus Torvalds 已提交
991 992
 *	interface.  It may also use usb_set_interface() to specify the
 *	appropriate altsetting.  If unwilling to manage the interface,
L
Lucas De Marchi 已提交
993
 *	return -ENODEV, if genuine IO errors occurred, an appropriate
994
 *	negative errno value.
L
Linus Torvalds 已提交
995 996 997
 * @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.
R
Randy Dunlap 已提交
998
 * @unlocked_ioctl: Used for drivers that want to talk to userspace through
L
Linus Torvalds 已提交
999 1000 1001
 *	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.
M
Ming Lei 已提交
1002 1003 1004 1005 1006 1007
 * @suspend: Called when the device is going to be suspended by the
 *	system either from system sleep or runtime suspend context. The
 *	return value will be ignored in system sleep context, so do NOT
 *	try to continue using the device if suspend fails in this case.
 *	Instead, let the resume or reset-resume routine recover from
 *	the failure.
L
Linus Torvalds 已提交
1008
 * @resume: Called when the device is being resumed by the system.
A
Alan Stern 已提交
1009 1010
 * @reset_resume: Called when the suspended device has been reset instead
 *	of being resumed.
1011 1012 1013 1014
 * @pre_reset: Called by usb_reset_device() when the device is about to be
 *	reset.  This routine must not return until the driver has no active
 *	URBs for the device, and no more URBs may be submitted until the
 *	post_reset method is called.
1015
 * @post_reset: Called by usb_reset_device() after the device
1016
 *	has been reset
L
Linus Torvalds 已提交
1017 1018 1019
 * @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.
1020 1021
 * @dynids: used internally to hold the list of dynamically added device
 *	ids for this driver.
1022
 * @drvwrap: Driver-model core structure wrapper.
1023 1024
 * @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.
1025 1026
 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
 *	for interfaces bound to this driver.
A
Alan Stern 已提交
1027 1028
 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable
 *	endpoints before calling the driver's disconnect method.
1029 1030 1031
 * @disable_hub_initiated_lpm: if set to 0, the USB core will not allow hubs
 *	to initiate lower power link state transitions when an idle timeout
 *	occurs.  Device-initiated USB 3.0 link PM will still be allowed.
L
Linus Torvalds 已提交
1032
 *
1033 1034
 * USB interface drivers must provide a name, probe() and disconnect()
 * methods, and an id_table.  Other driver fields are optional.
L
Linus Torvalds 已提交
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
 *
 * 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);

1056
	int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code,
1057
			void *buf);
L
Linus Torvalds 已提交
1058

1059
	int (*suspend) (struct usb_interface *intf, pm_message_t message);
L
Linus Torvalds 已提交
1060
	int (*resume) (struct usb_interface *intf);
A
Alan Stern 已提交
1061
	int (*reset_resume)(struct usb_interface *intf);
L
Linus Torvalds 已提交
1062

A
Alan Stern 已提交
1063 1064
	int (*pre_reset)(struct usb_interface *intf);
	int (*post_reset)(struct usb_interface *intf);
1065

L
Linus Torvalds 已提交
1066 1067
	const struct usb_device_id *id_table;

1068
	struct usb_dynids dynids;
1069
	struct usbdrv_wrap drvwrap;
1070
	unsigned int no_dynamic_id:1;
1071
	unsigned int supports_autosuspend:1;
1072
	unsigned int disable_hub_initiated_lpm:1;
A
Alan Stern 已提交
1073
	unsigned int soft_unbind:1;
L
Linus Torvalds 已提交
1074
};
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
#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.
1091 1092
 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
 *	for devices bound to this driver.
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
 *
 * 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 已提交
1103
	int (*resume) (struct usb_device *udev, pm_message_t message);
1104
	struct usbdrv_wrap drvwrap;
1105
	unsigned int supports_autosuspend:1;
1106 1107 1108
};
#define	to_usb_device_driver(d) container_of(d, struct usb_device_driver, \
		drvwrap.driver)
L
Linus Torvalds 已提交
1109 1110 1111 1112 1113

extern struct bus_type usb_bus_type;

/**
 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number
1114
 * @name: the usb class device name for this driver.  Will show up in sysfs.
1115
 * @devnode: Callback to provide a naming hint for a possible
1116
 *	device node to create.
L
Linus Torvalds 已提交
1117 1118 1119 1120 1121 1122 1123 1124 1125
 * @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;
1126
	char *(*devnode)(struct device *dev, umode_t *mode);
1127
	const struct file_operations *fops;
1128
	int minor_base;
L
Linus Torvalds 已提交
1129 1130 1131 1132 1133 1134
};

/*
 * use these in module_init()/module_exit()
 * and don't forget MODULE_DEVICE_TABLE(usb, ...)
 */
1135 1136
extern int usb_register_driver(struct usb_driver *, struct module *,
			       const char *);
1137 1138 1139 1140 1141

/* use a define to avoid include chaining to get THIS_MODULE & friends */
#define usb_register(driver) \
	usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)

L
Linus Torvalds 已提交
1142 1143
extern void usb_deregister(struct usb_driver *);

1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
/**
 * module_usb_driver() - Helper macro for registering a USB driver
 * @__usb_driver: usb_driver struct
 *
 * Helper macro for USB drivers which do not do anything special in module
 * init/exit. This eliminates a lot of boilerplate. Each module may only
 * use this macro once, and calling it replaces module_init() and module_exit()
 */
#define module_usb_driver(__usb_driver) \
	module_driver(__usb_driver, usb_register, \
		       usb_deregister)

1156 1157 1158 1159
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 已提交
1160 1161 1162 1163 1164 1165 1166
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);

1167
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
1168 1169 1170 1171 1172 1173 1174

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

/*
 * urb->transfer_flags:
1175 1176
 *
 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb().
L
Linus Torvalds 已提交
1177 1178
 */
#define URB_SHORT_NOT_OK	0x0001	/* report short reads as errors */
1179 1180
#define URB_ISO_ASAP		0x0002	/* iso-only; use the first unexpired
					 * slot in the schedule */
L
Linus Torvalds 已提交
1181 1182
#define URB_NO_TRANSFER_DMA_MAP	0x0004	/* urb->transfer_dma valid on submit */
#define URB_NO_FSBR		0x0020	/* UHCI-specific */
1183 1184 1185
#define URB_ZERO_PACKET		0x0040	/* Finish bulk OUT with short packet */
#define URB_NO_INTERRUPT	0x0080	/* HINT: no non-error interrupt
					 * needed */
1186
#define URB_FREE_BUFFER		0x0100	/* Free transfer buffer with the URB */
L
Linus Torvalds 已提交
1187

1188
/* The following flags are used internally by usbcore and HCDs */
1189 1190 1191 1192
#define URB_DIR_IN		0x0200	/* Transfer from device to host */
#define URB_DIR_OUT		0
#define URB_DIR_MASK		URB_DIR_IN

1193 1194 1195 1196 1197 1198 1199
#define URB_DMA_MAP_SINGLE	0x00010000	/* Non-scatter-gather mapping */
#define URB_DMA_MAP_PAGE	0x00020000	/* HCD-unsupported S-G */
#define URB_DMA_MAP_SG		0x00040000	/* HCD-supported S-G */
#define URB_MAP_LOCAL		0x00080000	/* HCD-local-memory mapping */
#define URB_SETUP_MAP_SINGLE	0x00100000	/* Setup packet DMA mapped */
#define URB_SETUP_MAP_LOCAL	0x00200000	/* HCD-local setup packet */
#define URB_DMA_SG_COMBINED	0x00400000	/* S-G entries were combined */
1200
#define URB_ALIGNED_TEMP_BUFFER	0x00800000	/* Temp buffer was alloc'd */
1201

L
Linus Torvalds 已提交
1202 1203 1204 1205
struct usb_iso_packet_descriptor {
	unsigned int offset;
	unsigned int length;		/* expected length */
	unsigned int actual_length;
1206
	int status;
L
Linus Torvalds 已提交
1207 1208 1209 1210
};

struct urb;

O
Oliver Neukum 已提交
1211 1212 1213 1214
struct usb_anchor {
	struct list_head urb_list;
	wait_queue_head_t wait;
	spinlock_t lock;
1215
	atomic_t suspend_wakeups;
O
Oliver Neukum 已提交
1216
	unsigned int poisoned:1;
O
Oliver Neukum 已提交
1217 1218 1219 1220
};

static inline void init_usb_anchor(struct usb_anchor *anchor)
{
1221
	memset(anchor, 0, sizeof(*anchor));
O
Oliver Neukum 已提交
1222 1223 1224 1225 1226
	INIT_LIST_HEAD(&anchor->urb_list);
	init_waitqueue_head(&anchor->wait);
	spin_lock_init(&anchor->lock);
}

1227
typedef void (*usb_complete_t)(struct urb *);
L
Linus Torvalds 已提交
1228 1229 1230 1231

/**
 * struct urb - USB Request Block
 * @urb_list: For use by current owner of the URB.
O
Oliver Neukum 已提交
1232 1233
 * @anchor_list: membership in the list of an anchor
 * @anchor: to anchor URBs to a common mooring
A
Alan Stern 已提交
1234 1235
 * @ep: Points to the endpoint's data structure.  Will eventually
 *	replace @pipe.
L
Linus Torvalds 已提交
1236 1237 1238 1239 1240 1241 1242 1243 1244
 * @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.
1245
 * @stream_id: the endpoint's stream ID for bulk streams
L
Linus Torvalds 已提交
1246 1247 1248 1249 1250 1251 1252 1253
 * @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.
1254 1255 1256 1257
 * @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 已提交
1258 1259 1260 1261 1262 1263 1264
 *	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.
1265 1266
 * @sg: scatter gather buffer list, the buffer size of each element in
 * 	the list (except the last) must be divisible by the endpoint's
1267
 * 	max packet size if no_sg_constraint isn't set in 'struct usb_bus'
1268
 * @num_mapped_sgs: (internal) number of mapped sg entries
1269
 * @num_sgs: number of entries in the sg list
L
Linus Torvalds 已提交
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
 * @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
1280
 *	short reads be reported as errors.
L
Linus Torvalds 已提交
1281 1282 1283
 * @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.
A
Alan Stern 已提交
1284 1285
 * @setup_dma: DMA pointer for the setup packet.  The caller must not use
 *	this field; setup_packet must point to a valid buffer.
L
Linus Torvalds 已提交
1286 1287 1288
 * @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
1289
 *	transfers.  The units are frames (milliseconds) for full and low
1290 1291
 *	speed devices, and microframes (1/8 millisecond) for highspeed
 *	and SuperSpeed devices.
L
Linus Torvalds 已提交
1292 1293 1294 1295 1296 1297
 * @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.
1298
 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to
L
Linus Torvalds 已提交
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
 *	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.
 *
A
Alan Stern 已提交
1317 1318 1319
 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag,
 * which tells the host controller driver that no such mapping is needed for
 * the transfer_buffer since
L
Linus Torvalds 已提交
1320
 * the device driver is DMA-aware.  For example, a device driver might
1321
 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map().
A
Alan Stern 已提交
1322 1323 1324
 * When this transfer flag is provided, host controller drivers will
 * attempt to use the dma address found in the transfer_dma
 * field rather than determining a dma address themselves.
1325 1326 1327 1328 1329 1330 1331 1332
 *
 * 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 已提交
1333 1334 1335 1336
 *
 * Initialization:
 *
 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be
1337
 * zero), and complete fields.  All URBs must also initialize
L
Linus Torvalds 已提交
1338 1339 1340 1341 1342 1343 1344 1345 1346
 * 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.
 *
A
Alan Stern 已提交
1347 1348 1349
 * Control URBs must provide a valid pointer in the setup_packet field.
 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA
 * beforehand.
L
Linus Torvalds 已提交
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
 *
 * 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.)
 *
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
 * If an isochronous endpoint queue isn't already running, the host
 * controller will schedule a new URB to start as soon as bandwidth
 * utilization allows.  If the queue is running then a new URB will be
 * scheduled to start in the first transfer slot following the end of the
 * preceding URB, if that slot has not already expired.  If the slot has
 * expired (which can happen when IRQ delivery is delayed for a long time),
 * the scheduling behavior depends on the URB_ISO_ASAP flag.  If the flag
 * is clear then the URB will be scheduled to start in the expired slot,
 * implying that some of its packets will not be transferred; if the flag
 * is set then the URB will be scheduled in the first unexpired slot,
 * breaking the queue's synchronization.  Upon URB completion, the
 * start_frame field will be set to the (micro)frame number in which the
 * transfer was scheduled.  Ranges for frame counter values are HC-specific
 * and can go from as low as 256 to as high as 65536 frames.
L
Linus Torvalds 已提交
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406
 *
 * 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.
1407 1408 1409 1410
 *
 * 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 已提交
1411
 */
1412
struct urb {
1413
	/* private: usb core and host controller only fields in the urb */
L
Linus Torvalds 已提交
1414 1415 1416
	struct kref kref;		/* reference count of the URB */
	void *hcpriv;			/* private data for host controller */
	atomic_t use_count;		/* concurrent submissions counter */
1417
	atomic_t reject;		/* submissions will fail */
A
Alan Stern 已提交
1418
	int unlinked;			/* unlink error code */
L
Linus Torvalds 已提交
1419

1420
	/* public: documented fields in the urb that can be used by drivers */
1421 1422
	struct list_head urb_list;	/* list head for use by the urb's
					 * current owner */
1423
	struct list_head anchor_list;	/* the URB may be anchored */
O
Oliver Neukum 已提交
1424
	struct usb_anchor *anchor;
1425
	struct usb_device *dev;		/* (in) pointer to associated device */
1426
	struct usb_host_endpoint *ep;	/* (internal) pointer to endpoint */
L
Linus Torvalds 已提交
1427
	unsigned int pipe;		/* (in) pipe information */
1428
	unsigned int stream_id;		/* (in) stream ID */
L
Linus Torvalds 已提交
1429 1430 1431 1432
	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 */
1433
	struct scatterlist *sg;		/* (in) scatter gather buffer list */
1434
	int num_mapped_sgs;		/* (internal) mapped sg entries */
1435
	int num_sgs;			/* (in) number of entries in the sg list */
1436
	u32 transfer_buffer_length;	/* (in) data buffer length */
1437
	u32 actual_length;		/* (return) actual transfer length */
L
Linus Torvalds 已提交
1438 1439 1440 1441
	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 */
1442 1443
	int interval;			/* (modify) transfer interval
					 * (INT/ISO) */
L
Linus Torvalds 已提交
1444 1445 1446
	int error_count;		/* (return) number of ISO errors */
	void *context;			/* (in) context for completion */
	usb_complete_t complete;	/* (in) completion routine */
1447 1448
	struct usb_iso_packet_descriptor iso_frame_desc[0];
					/* (in) ISO ONLY */
L
Linus Torvalds 已提交
1449 1450
};

1451
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
1452 1453 1454 1455 1456 1457 1458 1459 1460

/**
 * 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
1461
 * @complete_fn: pointer to the usb_complete_t function
L
Linus Torvalds 已提交
1462 1463 1464 1465 1466
 * @context: what to set the urb context to.
 *
 * Initializes a control urb with the proper information needed to submit
 * it to a device.
 */
1467 1468 1469 1470 1471 1472 1473 1474
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 已提交
1475 1476 1477 1478 1479 1480
{
	urb->dev = dev;
	urb->pipe = pipe;
	urb->setup_packet = setup_packet;
	urb->transfer_buffer = transfer_buffer;
	urb->transfer_buffer_length = buffer_length;
1481
	urb->complete = complete_fn;
L
Linus Torvalds 已提交
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
	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
1492
 * @complete_fn: pointer to the usb_complete_t function
L
Linus Torvalds 已提交
1493 1494 1495 1496 1497
 * @context: what to set the urb context to.
 *
 * Initializes a bulk urb with the proper information needed to submit it
 * to a device.
 */
1498 1499 1500 1501 1502 1503 1504
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 已提交
1505 1506 1507 1508 1509
{
	urb->dev = dev;
	urb->pipe = pipe;
	urb->transfer_buffer = transfer_buffer;
	urb->transfer_buffer_length = buffer_length;
1510
	urb->complete = complete_fn;
L
Linus Torvalds 已提交
1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
	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
1521
 * @complete_fn: pointer to the usb_complete_t function
L
Linus Torvalds 已提交
1522 1523 1524 1525 1526 1527
 * @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.
1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
 *
 * Note that High Speed and SuperSpeed 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).
 *
 * Wireless USB also uses the logarithmic encoding, but specifies it in units of
 * 128us instead of 125us.  For Wireless USB devices, the interval is passed
 * through to the host controller, rather than being translated into microframe
 * units.
L
Linus Torvalds 已提交
1538
 */
1539 1540 1541 1542 1543 1544 1545 1546
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 已提交
1547 1548 1549 1550 1551
{
	urb->dev = dev;
	urb->pipe = pipe;
	urb->transfer_buffer = transfer_buffer;
	urb->transfer_buffer_length = buffer_length;
1552
	urb->complete = complete_fn;
L
Linus Torvalds 已提交
1553
	urb->context = context;
1554 1555 1556 1557 1558

	if (dev->speed == USB_SPEED_HIGH || dev->speed == USB_SPEED_SUPER) {
		/* make sure interval is within allowed range */
		interval = clamp(interval, 1, 16);

L
Linus Torvalds 已提交
1559
		urb->interval = 1 << (interval - 1);
1560
	} else {
L
Linus Torvalds 已提交
1561
		urb->interval = interval;
1562 1563
	}

L
Linus Torvalds 已提交
1564 1565 1566 1567
	urb->start_frame = -1;
}

extern void usb_init_urb(struct urb *urb);
A
Al Viro 已提交
1568
extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags);
L
Linus Torvalds 已提交
1569 1570 1571
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 已提交
1572
extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags);
L
Linus Torvalds 已提交
1573 1574
extern int usb_unlink_urb(struct urb *urb);
extern void usb_kill_urb(struct urb *urb);
O
Oliver Neukum 已提交
1575 1576
extern void usb_poison_urb(struct urb *urb);
extern void usb_unpoison_urb(struct urb *urb);
1577
extern void usb_block_urb(struct urb *urb);
O
Oliver Neukum 已提交
1578
extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
O
Oliver Neukum 已提交
1579
extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
1580
extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
1581
extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
1582 1583
extern void usb_anchor_suspend_wakeups(struct usb_anchor *anchor);
extern void usb_anchor_resume_wakeups(struct usb_anchor *anchor);
O
Oliver Neukum 已提交
1584 1585 1586 1587
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);
1588 1589 1590
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 已提交
1591

1592 1593
#define usb_unblock_urb	usb_unpoison_urb

1594 1595 1596 1597
/**
 * usb_urb_dir_in - check if an URB describes an IN transfer
 * @urb: URB to be checked
 *
1598
 * Return: 1 if @urb describes an IN transfer (device-to-host),
1599 1600 1601 1602
 * otherwise 0.
 */
static inline int usb_urb_dir_in(struct urb *urb)
{
A
Alan Stern 已提交
1603
	return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN;
1604 1605 1606 1607 1608 1609
}

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

1618
void *usb_alloc_coherent(struct usb_device *dev, size_t size,
A
Al Viro 已提交
1619
	gfp_t mem_flags, dma_addr_t *dma);
1620
void usb_free_coherent(struct usb_device *dev, size_t size,
L
Linus Torvalds 已提交
1621 1622 1623
	void *addr, dma_addr_t dma);

#if 0
1624 1625 1626
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 已提交
1627 1628 1629
#endif

struct scatterlist;
A
Alan Stern 已提交
1630
int usb_buffer_map_sg(const struct usb_device *dev, int is_in,
1631
		      struct scatterlist *sg, int nents);
L
Linus Torvalds 已提交
1632
#if 0
A
Alan Stern 已提交
1633
void usb_buffer_dmasync_sg(const struct usb_device *dev, int is_in,
1634
			   struct scatterlist *sg, int n_hw_ents);
L
Linus Torvalds 已提交
1635
#endif
A
Alan Stern 已提交
1636
void usb_buffer_unmap_sg(const struct usb_device *dev, int is_in,
1637
			 struct scatterlist *sg, int n_hw_ents);
L
Linus Torvalds 已提交
1638 1639 1640 1641 1642 1643 1644 1645

/*-------------------------------------------------------------------*
 *                         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);
1646 1647
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 已提交
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
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);
1664
extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr);
L
Linus Torvalds 已提交
1665

1666 1667 1668
/* 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 已提交
1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
/*
 * 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;

1699 1700
	/* private:
	 * members below are private to usbcore,
L
Linus Torvalds 已提交
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
	 * and are not provided for driver access!
	 */
	spinlock_t		lock;

	struct usb_device	*dev;
	int			pipe;

	int			entries;
	struct urb		**urbs;

	int			count;
	struct completion	complete;
};

1715
int usb_sg_init(
L
Linus Torvalds 已提交
1716 1717
	struct usb_sg_request	*io,
	struct usb_device	*dev,
1718
	unsigned		pipe,
L
Linus Torvalds 已提交
1719 1720 1721 1722
	unsigned		period,
	struct scatterlist	*sg,
	int			nents,
	size_t			length,
A
Al Viro 已提交
1723
	gfp_t			mem_flags
L
Linus Torvalds 已提交
1724
);
1725 1726
void usb_sg_cancel(struct usb_sg_request *io);
void usb_sg_wait(struct usb_sg_request *io);
L
Linus Torvalds 已提交
1727 1728


1729
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766

/*
 * 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)

1767 1768
static inline unsigned int __create_pipe(struct usb_device *dev,
		unsigned int endpoint)
L
Linus Torvalds 已提交
1769 1770 1771 1772 1773
{
	return (dev->devnum << 8) | (endpoint << 15);
}

/* Create various pipes... */
1774
#define usb_sndctrlpipe(dev, endpoint)	\
1775
	((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint))
1776
#define usb_rcvctrlpipe(dev, endpoint)	\
1777
	((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1778
#define usb_sndisocpipe(dev, endpoint)	\
1779
	((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint))
1780
#define usb_rcvisocpipe(dev, endpoint)	\
1781
	((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1782
#define usb_sndbulkpipe(dev, endpoint)	\
1783
	((PIPE_BULK << 30) | __create_pipe(dev, endpoint))
1784
#define usb_rcvbulkpipe(dev, endpoint)	\
1785
	((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
1786
#define usb_sndintpipe(dev, endpoint)	\
1787
	((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint))
1788
#define usb_rcvintpipe(dev, endpoint)	\
1789
	((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN)
L
Linus Torvalds 已提交
1790

1791 1792 1793 1794 1795 1796 1797 1798
static inline struct usb_host_endpoint *
usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe)
{
	struct usb_host_endpoint **eps;
	eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out;
	return eps[usb_pipeendpoint(pipe)];
}

L
Linus Torvalds 已提交
1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817
/*-------------------------------------------------------------------------*/

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... */
1818
	return usb_endpoint_maxp(&ep->desc);
L
Linus Torvalds 已提交
1819 1820
}

1821
/* ----------------------------------------------------------------------- */
L
Linus Torvalds 已提交
1822

1823 1824 1825 1826 1827 1828 1829
/* translate USB error codes to codes user space understands */
static inline int usb_translate_errors(int error_code)
{
	switch (error_code) {
	case 0:
	case -ENOMEM:
	case -ENODEV:
1830
	case -EOPNOTSUPP:
1831 1832 1833 1834 1835 1836
		return error_code;
	default:
		return -EIO;
	}
}

1837 1838 1839 1840 1841 1842 1843 1844
/* 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);

1845 1846 1847
/* debugfs stuff */
extern struct dentry *usb_debug_root;

L
Linus Torvalds 已提交
1848 1849 1850
#endif  /* __KERNEL__ */

#endif