FILE
usb.h
File preview with syntax highlighting.
linux-6.19.14/include/linux/usb.h
1/* SPDX-License-Identifier: GPL-2.0 */ 2#ifndef __LINUX_USB_H 3#define __LINUX_USB_H 4 5#include <linux/mod_devicetable.h> 6#include <linux/usb/ch9.h> 7 8#define USB_MAJOR 180 9#define USB_DEVICE_MAJOR 189 10 11 12#ifdef __KERNEL__ 13 14#include <linux/errno.h> /* for -ENODEV */ 15#include <linux/delay.h> /* for mdelay() */ 16#include <linux/interrupt.h> /* for in_interrupt() */ 17#include <linux/list.h> /* for struct list_head */ 18#include <linux/kref.h> /* for struct kref */ 19#include <linux/device.h> /* for struct device */ 20#include <linux/fs.h> /* for struct file_operations */ 21#include <linux/completion.h> /* for struct completion */ 22#include <linux/sched.h> /* for current && schedule_timeout */ 23#include <linux/mutex.h> /* for struct mutex */ 24#include <linux/spinlock.h> /* for spinlock_t */ 25#include <linux/pm_runtime.h> /* for runtime PM */ 26 27struct usb_device; 28struct usb_driver; 29 30/*-------------------------------------------------------------------------*/ 31 32/* 33 * Host-side wrappers for standard USB descriptors ... these are parsed 34 * from the data provided by devices. Parsing turns them from a flat 35 * sequence of descriptors into a hierarchy: 36 * 37 * - devices have one (usually) or more configs; 38 * - configs have one (often) or more interfaces; 39 * - interfaces have one (usually) or more settings; 40 * - each interface setting has zero or (usually) more endpoints. 41 * - a SuperSpeed endpoint has a companion descriptor 42 * 43 * And there might be other descriptors mixed in with those. 44 * 45 * Devices may also have class-specific or vendor-specific descriptors. 46 */ 47 48struct ep_device; 49 50/** 51 * struct usb_host_endpoint - host-side endpoint descriptor and queue 52 * @desc: descriptor for this endpoint, wMaxPacketSize in native byteorder 53 * @ss_ep_comp: SuperSpeed companion descriptor for this endpoint 54 * @ssp_isoc_ep_comp: SuperSpeedPlus isoc companion descriptor for this endpoint 55 * @eusb2_isoc_ep_comp: eUSB2 isoc companion descriptor for this endpoint 56 * @urb_list: urbs queued to this endpoint; maintained by usbcore 57 * @hcpriv: for use by HCD; typically holds hardware dma queue head (QH) 58 * with one or more transfer descriptors (TDs) per urb 59 * @ep_dev: ep_device for sysfs info 60 * @extra: descriptors following this endpoint in the configuration 61 * @extralen: how many bytes of "extra" are valid 62 * @enabled: URBs may be submitted to this endpoint 63 * @streams: number of USB-3 streams allocated on the endpoint 64 * 65 * USB requests are always queued to a given endpoint, identified by a 66 * descriptor within an active interface in a given USB configuration. 67 */ 68struct usb_host_endpoint { 69 struct usb_endpoint_descriptor desc; 70 struct usb_ss_ep_comp_descriptor ss_ep_comp; 71 struct usb_ssp_isoc_ep_comp_descriptor ssp_isoc_ep_comp; 72 struct usb_eusb2_isoc_ep_comp_descriptor eusb2_isoc_ep_comp; 73 struct list_head urb_list; 74 void *hcpriv; 75 struct ep_device *ep_dev; /* For sysfs info */ 76 77 unsigned char *extra; /* Extra descriptors */ 78 int extralen; 79 int enabled; 80 int streams; 81}; 82 83/* host-side wrapper for one interface setting's parsed descriptors */ 84struct usb_host_interface { 85 struct usb_interface_descriptor desc; 86 87 int extralen; 88 unsigned char *extra; /* Extra descriptors */ 89 90 /* array of desc.bNumEndpoints endpoints associated with this 91 * interface setting. these will be in no particular order. 92 */ 93 struct usb_host_endpoint *endpoint; 94 95 char *string; /* iInterface string, if present */ 96}; 97 98enum usb_interface_condition { 99 USB_INTERFACE_UNBOUND = 0, 100 USB_INTERFACE_BINDING, 101 USB_INTERFACE_BOUND, 102 USB_INTERFACE_UNBINDING, 103}; 104 105int __must_check 106usb_find_common_endpoints(struct usb_host_interface *alt, 107 struct usb_endpoint_descriptor **bulk_in, 108 struct usb_endpoint_descriptor **bulk_out, 109 struct usb_endpoint_descriptor **int_in, 110 struct usb_endpoint_descriptor **int_out); 111 112int __must_check 113usb_find_common_endpoints_reverse(struct usb_host_interface *alt, 114 struct usb_endpoint_descriptor **bulk_in, 115 struct usb_endpoint_descriptor **bulk_out, 116 struct usb_endpoint_descriptor **int_in, 117 struct usb_endpoint_descriptor **int_out); 118 119static inline int __must_check 120usb_find_bulk_in_endpoint(struct usb_host_interface *alt, 121 struct usb_endpoint_descriptor **bulk_in) 122{ 123 return usb_find_common_endpoints(alt, bulk_in, NULL, NULL, NULL); 124} 125 126static inline int __must_check 127usb_find_bulk_out_endpoint(struct usb_host_interface *alt, 128 struct usb_endpoint_descriptor **bulk_out) 129{ 130 return usb_find_common_endpoints(alt, NULL, bulk_out, NULL, NULL); 131} 132 133static inline int __must_check 134usb_find_int_in_endpoint(struct usb_host_interface *alt, 135 struct usb_endpoint_descriptor **int_in) 136{ 137 return usb_find_common_endpoints(alt, NULL, NULL, int_in, NULL); 138} 139 140static inline int __must_check 141usb_find_int_out_endpoint(struct usb_host_interface *alt, 142 struct usb_endpoint_descriptor **int_out) 143{ 144 return usb_find_common_endpoints(alt, NULL, NULL, NULL, int_out); 145} 146 147static inline int __must_check 148usb_find_last_bulk_in_endpoint(struct usb_host_interface *alt, 149 struct usb_endpoint_descriptor **bulk_in) 150{ 151 return usb_find_common_endpoints_reverse(alt, bulk_in, NULL, NULL, NULL); 152} 153 154static inline int __must_check 155usb_find_last_bulk_out_endpoint(struct usb_host_interface *alt, 156 struct usb_endpoint_descriptor **bulk_out) 157{ 158 return usb_find_common_endpoints_reverse(alt, NULL, bulk_out, NULL, NULL); 159} 160 161static inline int __must_check 162usb_find_last_int_in_endpoint(struct usb_host_interface *alt, 163 struct usb_endpoint_descriptor **int_in) 164{ 165 return usb_find_common_endpoints_reverse(alt, NULL, NULL, int_in, NULL); 166} 167 168static inline int __must_check 169usb_find_last_int_out_endpoint(struct usb_host_interface *alt, 170 struct usb_endpoint_descriptor **int_out) 171{ 172 return usb_find_common_endpoints_reverse(alt, NULL, NULL, NULL, int_out); 173} 174 175enum usb_wireless_status { 176 USB_WIRELESS_STATUS_NA = 0, 177 USB_WIRELESS_STATUS_DISCONNECTED, 178 USB_WIRELESS_STATUS_CONNECTED, 179}; 180 181/** 182 * struct usb_interface - what usb device drivers talk to 183 * @altsetting: array of interface structures, one for each alternate 184 * setting that may be selected. Each one includes a set of 185 * endpoint configurations. They will be in no particular order. 186 * @cur_altsetting: the current altsetting. 187 * @num_altsetting: number of altsettings defined. 188 * @intf_assoc: interface association descriptor 189 * @minor: the minor number assigned to this interface, if this 190 * interface is bound to a driver that uses the USB major number. 191 * If this interface does not use the USB major, this field should 192 * be unused. The driver should set this value in the probe() 193 * function of the driver, after it has been assigned a minor 194 * number from the USB core by calling usb_register_dev(). 195 * @condition: binding state of the interface: not bound, binding 196 * (in probe()), bound to a driver, or unbinding (in disconnect()) 197 * @sysfs_files_created: sysfs attributes exist 198 * @ep_devs_created: endpoint child pseudo-devices exist 199 * @unregistering: flag set when the interface is being unregistered 200 * @needs_remote_wakeup: flag set when the driver requires remote-wakeup 201 * capability during autosuspend. 202 * @needs_altsetting0: flag set when a set-interface request for altsetting 0 203 * has been deferred. 204 * @needs_binding: flag set when the driver should be re-probed or unbound 205 * following a reset or suspend operation it doesn't support. 206 * @authorized: This allows to (de)authorize individual interfaces instead 207 * a whole device in contrast to the device authorization. 208 * @wireless_status: if the USB device uses a receiver/emitter combo, whether 209 * the emitter is connected. 210 * @wireless_status_work: Used for scheduling wireless status changes 211 * from atomic context. 212 * @dev: driver model's view of this device 213 * @usb_dev: if an interface is bound to the USB major, this will point 214 * to the sysfs representation for that device. 215 * @reset_ws: Used for scheduling resets from atomic context. 216 * @resetting_device: USB core reset the device, so use alt setting 0 as 217 * current; needs bandwidth alloc after reset. 218 * 219 * USB device drivers attach to interfaces on a physical device. Each 220 * interface encapsulates a single high level function, such as feeding 221 * an audio stream to a speaker or reporting a change in a volume control. 222 * Many USB devices only have one interface. The protocol used to talk to 223 * an interface's endpoints can be defined in a usb "class" specification, 224 * or by a product's vendor. The (default) control endpoint is part of 225 * every interface, but is never listed among the interface's descriptors. 226 * 227 * The driver that is bound to the interface can use standard driver model 228 * calls such as dev_get_drvdata() on the dev member of this structure. 229 * 230 * Each interface may have alternate settings. The initial configuration 231 * of a device sets altsetting 0, but the device driver can change 232 * that setting using usb_set_interface(). Alternate settings are often 233 * used to control the use of periodic endpoints, such as by having 234 * different endpoints use different amounts of reserved USB bandwidth. 235 * All standards-conformant USB devices that use isochronous endpoints 236 * will use them in non-default settings. 237 * 238 * The USB specification says that alternate setting numbers must run from 239 * 0 to one less than the total number of alternate settings. But some 240 * devices manage to mess this up, and the structures aren't necessarily 241 * stored in numerical order anyhow. Use usb_altnum_to_altsetting() to 242 * look up an alternate setting in the altsetting array based on its number. 243 */ 244struct usb_interface { 245 /* array of alternate settings for this interface, 246 * stored in no particular order */ 247 struct usb_host_interface *altsetting; 248 249 struct usb_host_interface *cur_altsetting; /* the currently 250 * active alternate setting */ 251 unsigned num_altsetting; /* number of alternate settings */ 252 253 /* If there is an interface association descriptor then it will list 254 * the associated interfaces */ 255 struct usb_interface_assoc_descriptor *intf_assoc; 256 257 int minor; /* minor number this interface is 258 * bound to */ 259 enum usb_interface_condition condition; /* state of binding */ 260 unsigned sysfs_files_created:1; /* the sysfs attributes exist */ 261 unsigned ep_devs_created:1; /* endpoint "devices" exist */ 262 unsigned unregistering:1; /* unregistration is in progress */ 263 unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */ 264 unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */ 265 unsigned needs_binding:1; /* needs delayed unbind/rebind */ 266 unsigned resetting_device:1; /* true: bandwidth alloc after reset */ 267 unsigned authorized:1; /* used for interface authorization */ 268 enum usb_wireless_status wireless_status; 269 struct work_struct wireless_status_work; 270 271 struct device dev; /* interface specific device info */ 272 struct device *usb_dev; 273 struct work_struct reset_ws; /* for resets in atomic context */ 274}; 275 276#define to_usb_interface(__dev) container_of_const(__dev, struct usb_interface, dev) 277 278static inline void *usb_get_intfdata(struct usb_interface *intf) 279{ 280 return dev_get_drvdata(&intf->dev); 281} 282 283/** 284 * usb_set_intfdata() - associate driver-specific data with an interface 285 * @intf: USB interface 286 * @data: driver data 287 * 288 * Drivers can use this function in their probe() callbacks to associate 289 * driver-specific data with an interface. 290 * 291 * Note that there is generally no need to clear the driver-data pointer even 292 * if some drivers do so for historical or implementation-specific reasons. 293 */ 294static inline void usb_set_intfdata(struct usb_interface *intf, void *data) 295{ 296 dev_set_drvdata(&intf->dev, data); 297} 298 299struct usb_interface *usb_get_intf(struct usb_interface *intf); 300void usb_put_intf(struct usb_interface *intf); 301 302/* Hard limit */ 303#define USB_MAXENDPOINTS 30 304/* this maximum is arbitrary */ 305#define USB_MAXINTERFACES 32 306#define USB_MAXIADS (USB_MAXINTERFACES/2) 307 308bool usb_check_bulk_endpoints( 309 const struct usb_interface *intf, const u8 *ep_addrs); 310bool usb_check_int_endpoints( 311 const struct usb_interface *intf, const u8 *ep_addrs); 312 313/* 314 * USB Resume Timer: Every Host controller driver should drive the resume 315 * signalling on the bus for the amount of time defined by this macro. 316 * 317 * That way we will have a 'stable' behavior among all HCDs supported by Linux. 318 * 319 * Note that the USB Specification states we should drive resume for *at least* 320 * 20 ms, but it doesn't give an upper bound. This creates two possible 321 * situations which we want to avoid: 322 * 323 * (a) sometimes an msleep(20) might expire slightly before 20 ms, which causes 324 * us to fail USB Electrical Tests, thus failing Certification 325 * 326 * (b) Some (many) devices actually need more than 20 ms of resume signalling, 327 * and while we can argue that's against the USB Specification, we don't have 328 * control over which devices a certification laboratory will be using for 329 * certification. If CertLab uses a device which was tested against Windows and 330 * that happens to have relaxed resume signalling rules, we might fall into 331 * situations where we fail interoperability and electrical tests. 332 * 333 * In order to avoid both conditions, we're using a 40 ms resume timeout, which 334 * should cope with both LPJ calibration errors and devices not following every 335 * detail of the USB Specification. 336 */ 337#define USB_RESUME_TIMEOUT 40 /* ms */ 338 339/** 340 * struct usb_interface_cache - long-term representation of a device interface 341 * @num_altsetting: number of altsettings defined. 342 * @ref: reference counter. 343 * @altsetting: variable-length array of interface structures, one for 344 * each alternate setting that may be selected. Each one includes a 345 * set of endpoint configurations. They will be in no particular order. 346 * 347 * These structures persist for the lifetime of a usb_device, unlike 348 * struct usb_interface (which persists only as long as its configuration 349 * is installed). The altsetting arrays can be accessed through these 350 * structures at any time, permitting comparison of configurations and 351 * providing support for the /sys/kernel/debug/usb/devices pseudo-file. 352 */ 353struct usb_interface_cache { 354 unsigned num_altsetting; /* number of alternate settings */ 355 struct kref ref; /* reference counter */ 356 357 /* variable-length array of alternate settings for this interface, 358 * stored in no particular order */ 359 struct usb_host_interface altsetting[]; 360}; 361#define ref_to_usb_interface_cache(r) \ 362 container_of(r, struct usb_interface_cache, ref) 363#define altsetting_to_usb_interface_cache(a) \ 364 container_of(a, struct usb_interface_cache, altsetting[0]) 365 366/** 367 * struct usb_host_config - representation of a device's configuration 368 * @desc: the device's configuration descriptor. 369 * @string: pointer to the cached version of the iConfiguration string, if 370 * present for this configuration. 371 * @intf_assoc: list of any interface association descriptors in this config 372 * @interface: array of pointers to usb_interface structures, one for each 373 * interface in the configuration. The number of interfaces is stored 374 * in desc.bNumInterfaces. These pointers are valid only while the 375 * configuration is active. 376 * @intf_cache: array of pointers to usb_interface_cache structures, one 377 * for each interface in the configuration. These structures exist 378 * for the entire life of the device. 379 * @extra: pointer to buffer containing all extra descriptors associated 380 * with this configuration (those preceding the first interface 381 * descriptor). 382 * @extralen: length of the extra descriptors buffer. 383 * 384 * USB devices may have multiple configurations, but only one can be active 385 * at any time. Each encapsulates a different operational environment; 386 * for example, a dual-speed device would have separate configurations for 387 * full-speed and high-speed operation. The number of configurations 388 * available is stored in the device descriptor as bNumConfigurations. 389 * 390 * A configuration can contain multiple interfaces. Each corresponds to 391 * a different function of the USB device, and all are available whenever 392 * the configuration is active. The USB standard says that interfaces 393 * are supposed to be numbered from 0 to desc.bNumInterfaces-1, but a lot 394 * of devices get this wrong. In addition, the interface array is not 395 * guaranteed to be sorted in numerical order. Use usb_ifnum_to_if() to 396 * look up an interface entry based on its number. 397 * 398 * Device drivers should not attempt to activate configurations. The choice 399 * of which configuration to install is a policy decision based on such 400 * considerations as available power, functionality provided, and the user's 401 * desires (expressed through userspace tools). However, drivers can call 402 * usb_reset_configuration() to reinitialize the current configuration and 403 * all its interfaces. 404 */ 405struct usb_host_config { 406 struct usb_config_descriptor desc; 407 408 char *string; /* iConfiguration string, if present */ 409 410 /* List of any Interface Association Descriptors in this 411 * configuration. */ 412 struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS]; 413 414 /* the interfaces associated with this configuration, 415 * stored in no particular order */ 416 struct usb_interface *interface[USB_MAXINTERFACES]; 417 418 /* Interface information available even when this is not the 419 * active configuration */ 420 struct usb_interface_cache *intf_cache[USB_MAXINTERFACES]; 421 422 unsigned char *extra; /* Extra descriptors */ 423 int extralen; 424}; 425 426/* USB2.0 and USB3.0 device BOS descriptor set */ 427struct usb_host_bos { 428 struct usb_bos_descriptor *desc; 429 430 struct usb_ext_cap_descriptor *ext_cap; 431 struct usb_ss_cap_descriptor *ss_cap; 432 struct usb_ssp_cap_descriptor *ssp_cap; 433 struct usb_ss_container_id_descriptor *ss_id; 434 struct usb_ptm_cap_descriptor *ptm_cap; 435}; 436 437int __usb_get_extra_descriptor(char *buffer, unsigned size, 438 unsigned char type, void **ptr, size_t min); 439#define usb_get_extra_descriptor(ifpoint, type, ptr) \ 440 __usb_get_extra_descriptor((ifpoint)->extra, \ 441 (ifpoint)->extralen, \ 442 type, (void **)ptr, sizeof(**(ptr))) 443 444/* ----------------------------------------------------------------------- */ 445 446/* 447 * Allocated per bus (tree of devices) we have: 448 */ 449struct usb_bus { 450 struct device *controller; /* host side hardware */ 451 struct device *sysdev; /* as seen from firmware or bus */ 452 int busnum; /* Bus number (in order of reg) */ 453 const char *bus_name; /* stable id (PCI slot_name etc) */ 454 u8 uses_pio_for_control; /* 455 * Does the host controller use PIO 456 * for control transfers? 457 */ 458 u8 otg_port; /* 0, or number of OTG/HNP port */ 459 unsigned is_b_host:1; /* true during some HNP roleswitches */ 460 unsigned b_hnp_enable:1; /* OTG: did A-Host enable HNP? */ 461 unsigned no_stop_on_short:1; /* 462 * Quirk: some controllers don't stop 463 * the ep queue on a short transfer 464 * with the URB_SHORT_NOT_OK flag set. 465 */ 466 unsigned no_sg_constraint:1; /* no sg constraint */ 467 unsigned sg_tablesize; /* 0 or largest number of sg list entries */ 468 469 int devnum_next; /* Next open device number in 470 * round-robin allocation */ 471 struct mutex devnum_next_mutex; /* devnum_next mutex */ 472 473 DECLARE_BITMAP(devmap, 128); /* USB device number allocation bitmap */ 474 struct usb_device *root_hub; /* Root hub */ 475 struct usb_bus *hs_companion; /* Companion EHCI bus, if any */ 476 477 int bandwidth_allocated; /* on this bus: how much of the time 478 * reserved for periodic (intr/iso) 479 * requests is used, on average? 480 * Units: microseconds/frame. 481 * Limits: Full/low speed reserve 90%, 482 * while high speed reserves 80%. 483 */ 484 int bandwidth_int_reqs; /* number of Interrupt requests */ 485 int bandwidth_isoc_reqs; /* number of Isoc. requests */ 486 487 unsigned resuming_ports; /* bit array: resuming root-hub ports */ 488 489#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE) 490 struct mon_bus *mon_bus; /* non-null when associated */ 491 int monitored; /* non-zero when monitored */ 492#endif 493}; 494 495struct usb_dev_state; 496 497/* ----------------------------------------------------------------------- */ 498 499struct usb_tt; 500 501enum usb_link_tunnel_mode { 502 USB_LINK_UNKNOWN = 0, 503 USB_LINK_NATIVE, 504 USB_LINK_TUNNELED, 505}; 506 507enum usb_port_connect_type { 508 USB_PORT_CONNECT_TYPE_UNKNOWN = 0, 509 USB_PORT_CONNECT_TYPE_HOT_PLUG, 510 USB_PORT_CONNECT_TYPE_HARD_WIRED, 511 USB_PORT_NOT_USED, 512}; 513 514/* 515 * USB port quirks. 516 */ 517 518/* For the given port, prefer the old (faster) enumeration scheme. */ 519#define USB_PORT_QUIRK_OLD_SCHEME BIT(0) 520 521/* Decrease TRSTRCY to 10ms during device enumeration. */ 522#define USB_PORT_QUIRK_FAST_ENUM BIT(1) 523 524/* 525 * USB 2.0 Link Power Management (LPM) parameters. 526 */ 527struct usb2_lpm_parameters { 528 /* Best effort service latency indicate how long the host will drive 529 * resume on an exit from L1. 530 */ 531 unsigned int besl; 532 533 /* Timeout value in microseconds for the L1 inactivity (LPM) timer. 534 * When the timer counts to zero, the parent hub will initiate a LPM 535 * transition to L1. 536 */ 537 int timeout; 538}; 539 540/* 541 * USB 3.0 Link Power Management (LPM) parameters. 542 * 543 * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit. 544 * MEL is the USB 3.0 Link PM latency for host-initiated LPM exit. 545 * All three are stored in nanoseconds. 546 */ 547struct usb3_lpm_parameters { 548 /* 549 * Maximum exit latency (MEL) for the host to send a packet to the 550 * device (either a Ping for isoc endpoints, or a data packet for 551 * interrupt endpoints), the hubs to decode the packet, and for all hubs 552 * in the path to transition the links to U0. 553 */ 554 unsigned int mel; 555 /* 556 * Maximum exit latency for a device-initiated LPM transition to bring 557 * all links into U0. Abbreviated as "PEL" in section 9.4.12 of the USB 558 * 3.0 spec, with no explanation of what "P" stands for. "Path"? 559 */ 560 unsigned int pel; 561 562 /* 563 * The System Exit Latency (SEL) includes PEL, and three other 564 * latencies. After a device initiates a U0 transition, it will take 565 * some time from when the device sends the ERDY to when it will finally 566 * receive the data packet. Basically, SEL should be the worse-case 567 * latency from when a device starts initiating a U0 transition to when 568 * it will get data. 569 */ 570 unsigned int sel; 571 /* 572 * The idle timeout value that is currently programmed into the parent 573 * hub for this device. When the timer counts to zero, the parent hub 574 * will initiate an LPM transition to either U1 or U2. 575 */ 576 int timeout; 577}; 578 579/** 580 * struct usb_device - kernel's representation of a USB device 581 * @devnum: device number; address on a USB bus 582 * @devpath: device ID string for use in messages (e.g., /port/...) 583 * @route: tree topology hex string for use with xHCI 584 * @state: device state: configured, not attached, etc. 585 * @speed: device speed: high/full/low (or error) 586 * @rx_lanes: number of rx lanes in use, USB 3.2 adds dual-lane support 587 * @tx_lanes: number of tx lanes in use, USB 3.2 adds dual-lane support 588 * @ssp_rate: SuperSpeed Plus phy signaling rate and lane count 589 * @tt: Transaction Translator info; used with low/full speed dev, highspeed hub 590 * @ttport: device port on that tt hub 591 * @toggle: one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints 592 * @parent: our hub, unless we're the root 593 * @bus: bus we're part of 594 * @ep0: endpoint 0 data (default control pipe) 595 * @dev: generic device interface 596 * @descriptor: USB device descriptor 597 * @bos: USB device BOS descriptor set 598 * @config: all of the device's configs 599 * @actconfig: the active configuration 600 * @ep_in: array of IN endpoints 601 * @ep_out: array of OUT endpoints 602 * @rawdescriptors: raw descriptors for each config 603 * @bus_mA: Current available from the bus 604 * @portnum: parent port number (origin 1) 605 * @level: number of USB hub ancestors 606 * @devaddr: device address, XHCI: assigned by HW, others: same as devnum 607 * @can_submit: URBs may be submitted 608 * @persist_enabled: USB_PERSIST enabled for this device 609 * @reset_in_progress: the device is being reset 610 * @have_langid: whether string_langid is valid 611 * @authorized: policy has said we can use it; 612 * (user space) policy determines if we authorize this device to be 613 * used or not. By default, wired USB devices are authorized. 614 * WUSB devices are not, until we authorize them from user space. 615 * FIXME -- complete doc 616 * @authenticated: Crypto authentication passed 617 * @tunnel_mode: Connection native or tunneled over USB4 618 * @usb4_link: device link to the USB4 host interface 619 * @lpm_capable: device supports LPM 620 * @lpm_devinit_allow: Allow USB3 device initiated LPM, exit latency is in range 621 * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM 622 * @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM 623 * @usb2_hw_lpm_enabled: USB2 hardware LPM is enabled 624 * @usb2_hw_lpm_allowed: Userspace allows USB 2.0 LPM to be enabled 625 * @usb3_lpm_u1_enabled: USB3 hardware U1 LPM enabled 626 * @usb3_lpm_u2_enabled: USB3 hardware U2 LPM enabled 627 * @string_langid: language ID for strings 628 * @product: iProduct string, if present (static) 629 * @manufacturer: iManufacturer string, if present (static) 630 * @serial: iSerialNumber string, if present (static) 631 * @filelist: usbfs files that are open to this device 632 * @maxchild: number of ports if hub 633 * @quirks: quirks of the whole device 634 * @urbnum: number of URBs submitted for the whole device 635 * @active_duration: total time device is not suspended 636 * @connect_time: time device was first connected 637 * @do_remote_wakeup: remote wakeup should be enabled 638 * @reset_resume: needs reset instead of resume 639 * @port_is_suspended: the upstream port is suspended (L2 or U3) 640 * @offload_pm_locked: prevents offload_usage changes during PM transitions. 641 * @offload_usage: number of offload activities happening on this usb device. 642 * @offload_lock: protects offload_usage and offload_pm_locked 643 * @slot_id: Slot ID assigned by xHCI 644 * @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout. 645 * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout. 646 * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout. 647 * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm() 648 * to keep track of the number of functions that require USB 3.0 Link Power 649 * Management to be disabled for this usb_device. This count should only 650 * be manipulated by those functions, with the bandwidth_mutex is held. 651 * @hub_delay: cached value consisting of: 652 * parent->hub_delay + wHubDelay + tTPTransmissionDelay (40ns) 653 * Will be used as wValue for SetIsochDelay requests. 654 * @use_generic_driver: ask driver core to reprobe using the generic driver. 655 * 656 * Notes: 657 * Usbcore drivers should not set usbdev->state directly. Instead use 658 * usb_set_device_state(). 659 */ 660struct usb_device { 661 int devnum; 662 char devpath[16]; 663 u32 route; 664 enum usb_device_state state; 665 enum usb_device_speed speed; 666 unsigned int rx_lanes; 667 unsigned int tx_lanes; 668 enum usb_ssp_rate ssp_rate; 669 670 struct usb_tt *tt; 671 int ttport; 672 673 unsigned int toggle[2]; 674 675 struct usb_device *parent; 676 struct usb_bus *bus; 677 struct usb_host_endpoint ep0; 678 679 struct device dev; 680 681 struct usb_device_descriptor descriptor; 682 struct usb_host_bos *bos; 683 struct usb_host_config *config; 684 685 struct usb_host_config *actconfig; 686 struct usb_host_endpoint *ep_in[16]; 687 struct usb_host_endpoint *ep_out[16]; 688 689 char **rawdescriptors; 690 691 unsigned short bus_mA; 692 u8 portnum; 693 u8 level; 694 u8 devaddr; 695 696 unsigned can_submit:1; 697 unsigned persist_enabled:1; 698 unsigned reset_in_progress:1; 699 unsigned have_langid:1; 700 unsigned authorized:1; 701 unsigned authenticated:1; 702 unsigned lpm_capable:1; 703 unsigned lpm_devinit_allow:1; 704 unsigned usb2_hw_lpm_capable:1; 705 unsigned usb2_hw_lpm_besl_capable:1; 706 unsigned usb2_hw_lpm_enabled:1; 707 unsigned usb2_hw_lpm_allowed:1; 708 unsigned usb3_lpm_u1_enabled:1; 709 unsigned usb3_lpm_u2_enabled:1; 710 int string_langid; 711 712 /* static strings from the device */ 713 char *product; 714 char *manufacturer; 715 char *serial; 716 717 struct list_head filelist; 718 719 int maxchild; 720 721 u32 quirks; 722 atomic_t urbnum; 723 724 unsigned long active_duration; 725 726 unsigned long connect_time; 727 728 unsigned do_remote_wakeup:1; 729 unsigned reset_resume:1; 730 unsigned port_is_suspended:1; 731 unsigned offload_pm_locked:1; 732 int offload_usage; 733 spinlock_t offload_lock; 734 enum usb_link_tunnel_mode tunnel_mode; 735 struct device_link *usb4_link; 736 737 int slot_id; 738 struct usb2_lpm_parameters l1_params; 739 struct usb3_lpm_parameters u1_params; 740 struct usb3_lpm_parameters u2_params; 741 unsigned lpm_disable_count; 742 743 u16 hub_delay; 744 unsigned use_generic_driver:1; 745}; 746 747#define to_usb_device(__dev) container_of_const(__dev, struct usb_device, dev) 748 749static inline struct usb_device *__intf_to_usbdev(struct usb_interface *intf) 750{ 751 return to_usb_device(intf->dev.parent); 752} 753static inline const struct usb_device *__intf_to_usbdev_const(const struct usb_interface *intf) 754{ 755 return to_usb_device((const struct device *)intf->dev.parent); 756} 757 758#define interface_to_usbdev(intf) \ 759 _Generic((intf), \ 760 const struct usb_interface *: __intf_to_usbdev_const, \ 761 struct usb_interface *: __intf_to_usbdev)(intf) 762 763extern struct usb_device *usb_get_dev(struct usb_device *dev); 764extern void usb_put_dev(struct usb_device *dev); 765extern struct usb_device *usb_hub_find_child(struct usb_device *hdev, 766 int port1); 767 768/** 769 * usb_hub_for_each_child - iterate over all child devices on the hub 770 * @hdev: USB device belonging to the usb hub 771 * @port1: portnum associated with child device 772 * @child: child device pointer 773 */ 774#define usb_hub_for_each_child(hdev, port1, child) \ 775 for (port1 = 1, child = usb_hub_find_child(hdev, port1); \ 776 port1 <= hdev->maxchild; \ 777 child = usb_hub_find_child(hdev, ++port1)) \ 778 if (!child) continue; else 779 780/* USB device locking */ 781#define usb_lock_device(udev) device_lock(&(udev)->dev) 782#define usb_unlock_device(udev) device_unlock(&(udev)->dev) 783#define usb_lock_device_interruptible(udev) device_lock_interruptible(&(udev)->dev) 784#define usb_trylock_device(udev) device_trylock(&(udev)->dev) 785extern int usb_lock_device_for_reset(struct usb_device *udev, 786 const struct usb_interface *iface); 787 788/* USB port reset for device reinitialization */ 789extern int usb_reset_device(struct usb_device *dev); 790extern void usb_queue_reset_device(struct usb_interface *dev); 791 792extern struct device *usb_intf_get_dma_device(struct usb_interface *intf); 793 794#ifdef CONFIG_ACPI 795extern int usb_acpi_set_power_state(struct usb_device *hdev, int index, 796 bool enable); 797extern bool usb_acpi_power_manageable(struct usb_device *hdev, int index); 798extern int usb_acpi_port_lpm_incapable(struct usb_device *hdev, int index); 799#else 800static inline int usb_acpi_set_power_state(struct usb_device *hdev, int index, 801 bool enable) { return 0; } 802static inline bool usb_acpi_power_manageable(struct usb_device *hdev, int index) 803 { return true; } 804static inline int usb_acpi_port_lpm_incapable(struct usb_device *hdev, int index) 805 { return 0; } 806#endif 807 808/* USB autosuspend and autoresume */ 809#ifdef CONFIG_PM 810extern void usb_enable_autosuspend(struct usb_device *udev); 811extern void usb_disable_autosuspend(struct usb_device *udev); 812 813extern int usb_autopm_get_interface(struct usb_interface *intf); 814extern void usb_autopm_put_interface(struct usb_interface *intf); 815extern int usb_autopm_get_interface_async(struct usb_interface *intf); 816extern void usb_autopm_put_interface_async(struct usb_interface *intf); 817extern void usb_autopm_get_interface_no_resume(struct usb_interface *intf); 818extern void usb_autopm_put_interface_no_suspend(struct usb_interface *intf); 819 820static inline void usb_mark_last_busy(struct usb_device *udev) 821{ 822 pm_runtime_mark_last_busy(&udev->dev); 823} 824 825#else 826 827static inline void usb_enable_autosuspend(struct usb_device *udev) 828{ } 829static inline void usb_disable_autosuspend(struct usb_device *udev) 830{ } 831 832static inline int usb_autopm_get_interface(struct usb_interface *intf) 833{ return 0; } 834static inline int usb_autopm_get_interface_async(struct usb_interface *intf) 835{ return 0; } 836 837static inline void usb_autopm_put_interface(struct usb_interface *intf) 838{ } 839static inline void usb_autopm_put_interface_async(struct usb_interface *intf) 840{ } 841static inline void usb_autopm_get_interface_no_resume( 842 struct usb_interface *intf) 843{ } 844static inline void usb_autopm_put_interface_no_suspend( 845 struct usb_interface *intf) 846{ } 847static inline void usb_mark_last_busy(struct usb_device *udev) 848{ } 849#endif 850 851#if IS_ENABLED(CONFIG_USB_XHCI_SIDEBAND) 852int usb_offload_get(struct usb_device *udev); 853int usb_offload_put(struct usb_device *udev); 854bool usb_offload_check(struct usb_device *udev); 855void usb_offload_set_pm_locked(struct usb_device *udev, bool locked); 856#else 857 858static inline int usb_offload_get(struct usb_device *udev) 859{ return 0; } 860static inline int usb_offload_put(struct usb_device *udev) 861{ return 0; } 862static inline bool usb_offload_check(struct usb_device *udev) 863{ return false; } 864static inline void usb_offload_set_pm_locked(struct usb_device *udev, bool locked) 865{ } 866#endif 867 868extern int usb_disable_lpm(struct usb_device *udev); 869extern void usb_enable_lpm(struct usb_device *udev); 870/* Same as above, but these functions lock/unlock the bandwidth_mutex. */ 871extern int usb_unlocked_disable_lpm(struct usb_device *udev); 872extern void usb_unlocked_enable_lpm(struct usb_device *udev); 873 874extern int usb_disable_ltm(struct usb_device *udev); 875extern void usb_enable_ltm(struct usb_device *udev); 876 877static inline bool usb_device_supports_ltm(struct usb_device *udev) 878{ 879 if (udev->speed < USB_SPEED_SUPER || !udev->bos || !udev->bos->ss_cap) 880 return false; 881 return udev->bos->ss_cap->bmAttributes & USB_LTM_SUPPORT; 882} 883 884static inline bool usb_device_no_sg_constraint(struct usb_device *udev) 885{ 886 return udev && udev->bus && udev->bus->no_sg_constraint; 887} 888 889 890/*-------------------------------------------------------------------------*/ 891 892/* for drivers using iso endpoints */ 893extern int usb_get_current_frame_number(struct usb_device *usb_dev); 894 895/* Sets up a group of bulk endpoints to support multiple stream IDs. */ 896extern int usb_alloc_streams(struct usb_interface *interface, 897 struct usb_host_endpoint **eps, unsigned int num_eps, 898 unsigned int num_streams, gfp_t mem_flags); 899 900/* Reverts a group of bulk endpoints back to not using stream IDs. */ 901extern int usb_free_streams(struct usb_interface *interface, 902 struct usb_host_endpoint **eps, unsigned int num_eps, 903 gfp_t mem_flags); 904 905/* used these for multi-interface device registration */ 906extern int usb_driver_claim_interface(struct usb_driver *driver, 907 struct usb_interface *iface, void *data); 908 909/** 910 * usb_interface_claimed - returns true iff an interface is claimed 911 * @iface: the interface being checked 912 * 913 * Return: %true (nonzero) iff the interface is claimed, else %false 914 * (zero). 915 * 916 * Note: 917 * Callers must own the driver model's usb bus readlock. So driver 918 * probe() entries don't need extra locking, but other call contexts 919 * may need to explicitly claim that lock. 920 * 921 */ 922static inline int usb_interface_claimed(struct usb_interface *iface) 923{ 924 return (iface->dev.driver != NULL); 925} 926 927extern void usb_driver_release_interface(struct usb_driver *driver, 928 struct usb_interface *iface); 929 930int usb_set_wireless_status(struct usb_interface *iface, 931 enum usb_wireless_status status); 932 933const struct usb_device_id *usb_match_id(struct usb_interface *interface, 934 const struct usb_device_id *id); 935extern int usb_match_one_id(struct usb_interface *interface, 936 const struct usb_device_id *id); 937 938extern int usb_for_each_dev(void *data, int (*fn)(struct usb_device *, void *)); 939extern struct usb_interface *usb_find_interface(struct usb_driver *drv, 940 int minor); 941extern struct usb_interface *usb_ifnum_to_if(const struct usb_device *dev, 942 unsigned ifnum); 943extern struct usb_host_interface *usb_altnum_to_altsetting( 944 const struct usb_interface *intf, unsigned int altnum); 945extern struct usb_host_interface *usb_find_alt_setting( 946 struct usb_host_config *config, 947 unsigned int iface_num, 948 unsigned int alt_num); 949 950/* port claiming functions */ 951int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, 952 struct usb_dev_state *owner); 953int usb_hub_release_port(struct usb_device *hdev, unsigned port1, 954 struct usb_dev_state *owner); 955 956/** 957 * usb_make_path - returns stable device path in the usb tree 958 * @dev: the device whose path is being constructed 959 * @buf: where to put the string 960 * @size: how big is "buf"? 961 * 962 * Return: Length of the string (> 0) or negative if size was too small. 963 * 964 * Note: 965 * This identifier is intended to be "stable", reflecting physical paths in 966 * hardware such as physical bus addresses for host controllers or ports on 967 * USB hubs. That makes it stay the same until systems are physically 968 * reconfigured, by re-cabling a tree of USB devices or by moving USB host 969 * controllers. Adding and removing devices, including virtual root hubs 970 * in host controller driver modules, does not change these path identifiers; 971 * neither does rebooting or re-enumerating. These are more useful identifiers 972 * than changeable ("unstable") ones like bus numbers or device addresses. 973 * 974 * With a partial exception for devices connected to USB 2.0 root hubs, these 975 * identifiers are also predictable. So long as the device tree isn't changed, 976 * plugging any USB device into a given hub port always gives it the same path. 977 * Because of the use of "companion" controllers, devices connected to ports on 978 * USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are 979 * high speed, and a different one if they are full or low speed. 980 */ 981static inline int usb_make_path(struct usb_device *dev, char *buf, size_t size) 982{ 983 int actual; 984 actual = snprintf(buf, size, "usb-%s-%s", dev->bus->bus_name, 985 dev->devpath); 986 return (actual >= (int)size) ? -1 : actual; 987} 988 989/*-------------------------------------------------------------------------*/ 990 991#define USB_DEVICE_ID_MATCH_DEVICE \ 992 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT) 993#define USB_DEVICE_ID_MATCH_DEV_RANGE \ 994 (USB_DEVICE_ID_MATCH_DEV_LO | USB_DEVICE_ID_MATCH_DEV_HI) 995#define USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION \ 996 (USB_DEVICE_ID_MATCH_DEVICE | USB_DEVICE_ID_MATCH_DEV_RANGE) 997#define USB_DEVICE_ID_MATCH_DEV_INFO \ 998 (USB_DEVICE_ID_MATCH_DEV_CLASS | \ 999 USB_DEVICE_ID_MATCH_DEV_SUBCLASS | \ 1000 USB_DEVICE_ID_MATCH_DEV_PROTOCOL) 1001#define USB_DEVICE_ID_MATCH_INT_INFO \ 1002 (USB_DEVICE_ID_MATCH_INT_CLASS | \ 1003 USB_DEVICE_ID_MATCH_INT_SUBCLASS | \ 1004 USB_DEVICE_ID_MATCH_INT_PROTOCOL) 1005 1006/** 1007 * USB_DEVICE - macro used to describe a specific usb device 1008 * @vend: the 16 bit USB Vendor ID 1009 * @prod: the 16 bit USB Product ID 1010 * 1011 * This macro is used to create a struct usb_device_id that matches a 1012 * specific device. 1013 */ 1014#define USB_DEVICE(vend, prod) \ 1015 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \ 1016 .idVendor = (vend), \ 1017 .idProduct = (prod) 1018/** 1019 * USB_DEVICE_VER - describe a specific usb device with a version range 1020 * @vend: the 16 bit USB Vendor ID 1021 * @prod: the 16 bit USB Product ID 1022 * @lo: the bcdDevice_lo value 1023 * @hi: the bcdDevice_hi value 1024 * 1025 * This macro is used to create a struct usb_device_id that matches a 1026 * specific device, with a version range. 1027 */ 1028#define USB_DEVICE_VER(vend, prod, lo, hi) \ 1029 .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION, \ 1030 .idVendor = (vend), \ 1031 .idProduct = (prod), \ 1032 .bcdDevice_lo = (lo), \ 1033 .bcdDevice_hi = (hi) 1034 1035/** 1036 * USB_DEVICE_INTERFACE_CLASS - describe a usb device with a specific interface class 1037 * @vend: the 16 bit USB Vendor ID 1038 * @prod: the 16 bit USB Product ID 1039 * @cl: bInterfaceClass value 1040 * 1041 * This macro is used to create a struct usb_device_id that matches a 1042 * specific interface class of devices. 1043 */ 1044#define USB_DEVICE_INTERFACE_CLASS(vend, prod, cl) \ 1045 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \ 1046 USB_DEVICE_ID_MATCH_INT_CLASS, \ 1047 .idVendor = (vend), \ 1048 .idProduct = (prod), \ 1049 .bInterfaceClass = (cl) 1050 1051/** 1052 * USB_DEVICE_INTERFACE_PROTOCOL - describe a usb device with a specific interface protocol 1053 * @vend: the 16 bit USB Vendor ID 1054 * @prod: the 16 bit USB Product ID 1055 * @pr: bInterfaceProtocol value 1056 * 1057 * This macro is used to create a struct usb_device_id that matches a 1058 * specific interface protocol of devices. 1059 */ 1060#define USB_DEVICE_INTERFACE_PROTOCOL(vend, prod, pr) \ 1061 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \ 1062 USB_DEVICE_ID_MATCH_INT_PROTOCOL, \ 1063 .idVendor = (vend), \ 1064 .idProduct = (prod), \ 1065 .bInterfaceProtocol = (pr) 1066 1067/** 1068 * USB_DEVICE_INTERFACE_NUMBER - describe a usb device with a specific interface number 1069 * @vend: the 16 bit USB Vendor ID 1070 * @prod: the 16 bit USB Product ID 1071 * @num: bInterfaceNumber value 1072 * 1073 * This macro is used to create a struct usb_device_id that matches a 1074 * specific interface number of devices. 1075 */ 1076#define USB_DEVICE_INTERFACE_NUMBER(vend, prod, num) \ 1077 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \ 1078 USB_DEVICE_ID_MATCH_INT_NUMBER, \ 1079 .idVendor = (vend), \ 1080 .idProduct = (prod), \ 1081 .bInterfaceNumber = (num) 1082 1083/** 1084 * USB_DEVICE_INFO - macro used to describe a class of usb devices 1085 * @cl: bDeviceClass value 1086 * @sc: bDeviceSubClass value 1087 * @pr: bDeviceProtocol value 1088 * 1089 * This macro is used to create a struct usb_device_id that matches a 1090 * specific class of devices. 1091 */ 1092#define USB_DEVICE_INFO(cl, sc, pr) \ 1093 .match_flags = USB_DEVICE_ID_MATCH_DEV_INFO, \ 1094 .bDeviceClass = (cl), \ 1095 .bDeviceSubClass = (sc), \ 1096 .bDeviceProtocol = (pr) 1097 1098/** 1099 * USB_INTERFACE_INFO - macro used to describe a class of usb interfaces 1100 * @cl: bInterfaceClass value 1101 * @sc: bInterfaceSubClass value 1102 * @pr: bInterfaceProtocol value 1103 * 1104 * This macro is used to create a struct usb_device_id that matches a 1105 * specific class of interfaces. 1106 */ 1107#define USB_INTERFACE_INFO(cl, sc, pr) \ 1108 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \ 1109 .bInterfaceClass = (cl), \ 1110 .bInterfaceSubClass = (sc), \ 1111 .bInterfaceProtocol = (pr) 1112 1113/** 1114 * USB_DEVICE_AND_INTERFACE_INFO - describe a specific usb device with a class of usb interfaces 1115 * @vend: the 16 bit USB Vendor ID 1116 * @prod: the 16 bit USB Product ID 1117 * @cl: bInterfaceClass value 1118 * @sc: bInterfaceSubClass value 1119 * @pr: bInterfaceProtocol value 1120 * 1121 * This macro is used to create a struct usb_device_id that matches a 1122 * specific device with a specific class of interfaces. 1123 * 1124 * This is especially useful when explicitly matching devices that have 1125 * vendor specific bDeviceClass values, but standards-compliant interfaces. 1126 */ 1127#define USB_DEVICE_AND_INTERFACE_INFO(vend, prod, cl, sc, pr) \ 1128 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \ 1129 | USB_DEVICE_ID_MATCH_DEVICE, \ 1130 .idVendor = (vend), \ 1131 .idProduct = (prod), \ 1132 .bInterfaceClass = (cl), \ 1133 .bInterfaceSubClass = (sc), \ 1134 .bInterfaceProtocol = (pr) 1135 1136/** 1137 * USB_VENDOR_AND_INTERFACE_INFO - describe a specific usb vendor with a class of usb interfaces 1138 * @vend: the 16 bit USB Vendor ID 1139 * @cl: bInterfaceClass value 1140 * @sc: bInterfaceSubClass value 1141 * @pr: bInterfaceProtocol value 1142 * 1143 * This macro is used to create a struct usb_device_id that matches a 1144 * specific vendor with a specific class of interfaces. 1145 * 1146 * This is especially useful when explicitly matching devices that have 1147 * vendor specific bDeviceClass values, but standards-compliant interfaces. 1148 */ 1149#define USB_VENDOR_AND_INTERFACE_INFO(vend, cl, sc, pr) \ 1150 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO \ 1151 | USB_DEVICE_ID_MATCH_VENDOR, \ 1152 .idVendor = (vend), \ 1153 .bInterfaceClass = (cl), \ 1154 .bInterfaceSubClass = (sc), \ 1155 .bInterfaceProtocol = (pr) 1156 1157/* ----------------------------------------------------------------------- */ 1158 1159/* Stuff for dynamic usb ids */ 1160extern struct mutex usb_dynids_lock; 1161struct usb_dynids { 1162 struct list_head list; 1163}; 1164 1165struct usb_dynid { 1166 struct list_head node; 1167 struct usb_device_id id; 1168}; 1169 1170extern ssize_t usb_store_new_id(struct usb_dynids *dynids, 1171 const struct usb_device_id *id_table, 1172 struct device_driver *driver, 1173 const char *buf, size_t count); 1174 1175extern ssize_t usb_show_dynids(struct usb_dynids *dynids, char *buf); 1176 1177/** 1178 * struct usb_driver - identifies USB interface driver to usbcore 1179 * @name: The driver name should be unique among USB drivers, 1180 * and should normally be the same as the module name. 1181 * @probe: Called to see if the driver is willing to manage a particular 1182 * interface on a device. If it is, probe returns zero and uses 1183 * usb_set_intfdata() to associate driver-specific data with the 1184 * interface. It may also use usb_set_interface() to specify the 1185 * appropriate altsetting. If unwilling to manage the interface, 1186 * return -ENODEV, if genuine IO errors occurred, an appropriate 1187 * negative errno value. 1188 * @disconnect: Called when the interface is no longer accessible, usually 1189 * because its device has been (or is being) disconnected or the 1190 * driver module is being unloaded. 1191 * @unlocked_ioctl: Used for drivers that want to talk to userspace through 1192 * the "usbfs" filesystem. This lets devices provide ways to 1193 * expose information to user space regardless of where they 1194 * do (or don't) show up otherwise in the filesystem. 1195 * @suspend: Called when the device is going to be suspended by the 1196 * system either from system sleep or runtime suspend context. The 1197 * return value will be ignored in system sleep context, so do NOT 1198 * try to continue using the device if suspend fails in this case. 1199 * Instead, let the resume or reset-resume routine recover from 1200 * the failure. 1201 * @resume: Called when the device is being resumed by the system. 1202 * @reset_resume: Called when the suspended device has been reset instead 1203 * of being resumed. 1204 * @pre_reset: Called by usb_reset_device() when the device is about to be 1205 * reset. This routine must not return until the driver has no active 1206 * URBs for the device, and no more URBs may be submitted until the 1207 * post_reset method is called. 1208 * @post_reset: Called by usb_reset_device() after the device 1209 * has been reset 1210 * @shutdown: Called at shut-down time to quiesce the device. 1211 * @id_table: USB drivers use ID table to support hotplugging. 1212 * Export this with MODULE_DEVICE_TABLE(usb,...). This must be set 1213 * or your driver's probe function will never get called. 1214 * @dev_groups: Attributes attached to the device that will be created once it 1215 * is bound to the driver. 1216 * @dynids: used internally to hold the list of dynamically added device 1217 * ids for this driver. 1218 * @driver: The driver-model core driver structure. 1219 * @no_dynamic_id: if set to 1, the USB core will not allow dynamic ids to be 1220 * added to this driver by preventing the sysfs file from being created. 1221 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend 1222 * for interfaces bound to this driver. 1223 * @soft_unbind: if set to 1, the USB core will not kill URBs and disable 1224 * endpoints before calling the driver's disconnect method. 1225 * @disable_hub_initiated_lpm: if set to 1, the USB core will not allow hubs 1226 * to initiate lower power link state transitions when an idle timeout 1227 * occurs. Device-initiated USB 3.0 link PM will still be allowed. 1228 * 1229 * USB interface drivers must provide a name, probe() and disconnect() 1230 * methods, and an id_table. Other driver fields are optional. 1231 * 1232 * The id_table is used in hotplugging. It holds a set of descriptors, 1233 * and specialized data may be associated with each entry. That table 1234 * is used by both user and kernel mode hotplugging support. 1235 * 1236 * The probe() and disconnect() methods are called in a context where 1237 * they can sleep, but they should avoid abusing the privilege. Most 1238 * work to connect to a device should be done when the device is opened, 1239 * and undone at the last close. The disconnect code needs to address 1240 * concurrency issues with respect to open() and close() methods, as 1241 * well as forcing all pending I/O requests to complete (by unlinking 1242 * them as necessary, and blocking until the unlinks complete). 1243 */ 1244struct usb_driver { 1245 const char *name; 1246 1247 int (*probe) (struct usb_interface *intf, 1248 const struct usb_device_id *id); 1249 1250 void (*disconnect) (struct usb_interface *intf); 1251 1252 int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code, 1253 void *buf); 1254 1255 int (*suspend) (struct usb_interface *intf, pm_message_t message); 1256 int (*resume) (struct usb_interface *intf); 1257 int (*reset_resume)(struct usb_interface *intf); 1258 1259 int (*pre_reset)(struct usb_interface *intf); 1260 int (*post_reset)(struct usb_interface *intf); 1261 1262 void (*shutdown)(struct usb_interface *intf); 1263 1264 const struct usb_device_id *id_table; 1265 const struct attribute_group **dev_groups; 1266 1267 struct usb_dynids dynids; 1268 struct device_driver driver; 1269 unsigned int no_dynamic_id:1; 1270 unsigned int supports_autosuspend:1; 1271 unsigned int disable_hub_initiated_lpm:1; 1272 unsigned int soft_unbind:1; 1273}; 1274#define to_usb_driver(d) container_of_const(d, struct usb_driver, driver) 1275 1276/** 1277 * struct usb_device_driver - identifies USB device driver to usbcore 1278 * @name: The driver name should be unique among USB drivers, 1279 * and should normally be the same as the module name. 1280 * @match: If set, used for better device/driver matching. 1281 * @probe: Called to see if the driver is willing to manage a particular 1282 * device. If it is, probe returns zero and uses dev_set_drvdata() 1283 * to associate driver-specific data with the device. If unwilling 1284 * to manage the device, return a negative errno value. 1285 * @disconnect: Called when the device is no longer accessible, usually 1286 * because it has been (or is being) disconnected or the driver's 1287 * module is being unloaded. 1288 * @suspend: Called when the device is going to be suspended by the system. 1289 * @resume: Called when the device is being resumed by the system. 1290 * @choose_configuration: If non-NULL, called instead of the default 1291 * usb_choose_configuration(). If this returns an error then we'll go 1292 * on to call the normal usb_choose_configuration(). 1293 * @dev_groups: Attributes attached to the device that will be created once it 1294 * is bound to the driver. 1295 * @driver: The driver-model core driver structure. 1296 * @id_table: used with @match() to select better matching driver at 1297 * probe() time. 1298 * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend 1299 * for devices bound to this driver. 1300 * @generic_subclass: if set to 1, the generic USB driver's probe, disconnect, 1301 * resume and suspend functions will be called in addition to the driver's 1302 * own, so this part of the setup does not need to be replicated. 1303 * 1304 * USB drivers must provide all the fields listed above except driver, 1305 * match, and id_table. 1306 */ 1307struct usb_device_driver { 1308 const char *name; 1309 1310 bool (*match) (struct usb_device *udev); 1311 int (*probe) (struct usb_device *udev); 1312 void (*disconnect) (struct usb_device *udev); 1313 1314 int (*suspend) (struct usb_device *udev, pm_message_t message); 1315 int (*resume) (struct usb_device *udev, pm_message_t message); 1316 1317 int (*choose_configuration) (struct usb_device *udev); 1318 1319 const struct attribute_group **dev_groups; 1320 struct device_driver driver; 1321 const struct usb_device_id *id_table; 1322 unsigned int supports_autosuspend:1; 1323 unsigned int generic_subclass:1; 1324}; 1325#define to_usb_device_driver(d) container_of_const(d, struct usb_device_driver, driver) 1326 1327/** 1328 * struct usb_class_driver - identifies a USB driver that wants to use the USB major number 1329 * @name: the usb class device name for this driver. Will show up in sysfs. 1330 * @devnode: Callback to provide a naming hint for a possible 1331 * device node to create. 1332 * @fops: pointer to the struct file_operations of this driver. 1333 * @minor_base: the start of the minor range for this driver. 1334 * 1335 * This structure is used for the usb_register_dev() and 1336 * usb_deregister_dev() functions, to consolidate a number of the 1337 * parameters used for them. 1338 */ 1339struct usb_class_driver { 1340 char *name; 1341 char *(*devnode)(const struct device *dev, umode_t *mode); 1342 const struct file_operations *fops; 1343 int minor_base; 1344}; 1345 1346/* 1347 * use these in module_init()/module_exit() 1348 * and don't forget MODULE_DEVICE_TABLE(usb, ...) 1349 */ 1350extern int usb_register_driver(struct usb_driver *, struct module *, 1351 const char *); 1352 1353/* use a define to avoid include chaining to get THIS_MODULE & friends */ 1354#define usb_register(driver) \ 1355 usb_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) 1356 1357extern void usb_deregister(struct usb_driver *); 1358 1359/** 1360 * module_usb_driver() - Helper macro for registering a USB driver 1361 * @__usb_driver: usb_driver struct 1362 * 1363 * Helper macro for USB drivers which do not do anything special in module 1364 * init/exit. This eliminates a lot of boilerplate. Each module may only 1365 * use this macro once, and calling it replaces module_init() and module_exit() 1366 */ 1367#define module_usb_driver(__usb_driver) \ 1368 module_driver(__usb_driver, usb_register, \ 1369 usb_deregister) 1370 1371extern int usb_register_device_driver(struct usb_device_driver *, 1372 struct module *); 1373extern void usb_deregister_device_driver(struct usb_device_driver *); 1374 1375extern int usb_register_dev(struct usb_interface *intf, 1376 struct usb_class_driver *class_driver); 1377extern void usb_deregister_dev(struct usb_interface *intf, 1378 struct usb_class_driver *class_driver); 1379 1380extern int usb_disabled(void); 1381 1382/* ----------------------------------------------------------------------- */ 1383 1384/* 1385 * URB support, for asynchronous request completions 1386 */ 1387 1388/* 1389 * urb->transfer_flags: 1390 * 1391 * Note: URB_DIR_IN/OUT is automatically set in usb_submit_urb(). 1392 */ 1393#define URB_SHORT_NOT_OK 0x0001 /* report short reads as errors */ 1394#define URB_ISO_ASAP 0x0002 /* iso-only; use the first unexpired 1395 * slot in the schedule */ 1396#define URB_NO_TRANSFER_DMA_MAP 0x0004 /* urb->transfer_dma valid on submit */ 1397#define URB_ZERO_PACKET 0x0040 /* Finish bulk OUT with short packet */ 1398#define URB_NO_INTERRUPT 0x0080 /* HINT: no non-error interrupt 1399 * needed */ 1400#define URB_FREE_BUFFER 0x0100 /* Free transfer buffer with the URB */ 1401 1402/* The following flags are used internally by usbcore and HCDs */ 1403#define URB_DIR_IN 0x0200 /* Transfer from device to host */ 1404#define URB_DIR_OUT 0 1405#define URB_DIR_MASK URB_DIR_IN 1406 1407#define URB_DMA_MAP_SINGLE 0x00010000 /* Non-scatter-gather mapping */ 1408#define URB_DMA_MAP_PAGE 0x00020000 /* HCD-unsupported S-G */ 1409#define URB_DMA_MAP_SG 0x00040000 /* HCD-supported S-G */ 1410#define URB_MAP_LOCAL 0x00080000 /* HCD-local-memory mapping */ 1411#define URB_SETUP_MAP_SINGLE 0x00100000 /* Setup packet DMA mapped */ 1412#define URB_SETUP_MAP_LOCAL 0x00200000 /* HCD-local setup packet */ 1413#define URB_DMA_SG_COMBINED 0x00400000 /* S-G entries were combined */ 1414#define URB_ALIGNED_TEMP_BUFFER 0x00800000 /* Temp buffer was alloc'd */ 1415 1416struct usb_iso_packet_descriptor { 1417 unsigned int offset; 1418 unsigned int length; /* expected length */ 1419 unsigned int actual_length; 1420 int status; 1421}; 1422 1423struct urb; 1424 1425struct usb_anchor { 1426 struct list_head urb_list; 1427 wait_queue_head_t wait; 1428 spinlock_t lock; 1429 atomic_t suspend_wakeups; 1430 unsigned int poisoned:1; 1431}; 1432 1433static inline void init_usb_anchor(struct usb_anchor *anchor) 1434{ 1435 memset(anchor, 0, sizeof(*anchor)); 1436 INIT_LIST_HEAD(&anchor->urb_list); 1437 init_waitqueue_head(&anchor->wait); 1438 spin_lock_init(&anchor->lock); 1439} 1440 1441typedef void (*usb_complete_t)(struct urb *); 1442 1443/** 1444 * struct urb - USB Request Block 1445 * @urb_list: For use by current owner of the URB. 1446 * @anchor_list: membership in the list of an anchor 1447 * @anchor: to anchor URBs to a common mooring 1448 * @ep: Points to the endpoint's data structure. Will eventually 1449 * replace @pipe. 1450 * @pipe: Holds endpoint number, direction, type, and more. 1451 * Create these values with the eight macros available; 1452 * usb_{snd,rcv}TYPEpipe(dev,endpoint), where the TYPE is "ctrl" 1453 * (control), "bulk", "int" (interrupt), or "iso" (isochronous). 1454 * For example usb_sndbulkpipe() or usb_rcvintpipe(). Endpoint 1455 * numbers range from zero to fifteen. Note that "in" endpoint two 1456 * is a different endpoint (and pipe) from "out" endpoint two. 1457 * The current configuration controls the existence, type, and 1458 * maximum packet size of any given endpoint. 1459 * @stream_id: the endpoint's stream ID for bulk streams 1460 * @dev: Identifies the USB device to perform the request. 1461 * @status: This is read in non-iso completion functions to get the 1462 * status of the particular request. ISO requests only use it 1463 * to tell whether the URB was unlinked; detailed status for 1464 * each frame is in the fields of the iso_frame-desc. 1465 * @transfer_flags: A variety of flags may be used to affect how URB 1466 * submission, unlinking, or operation are handled. Different 1467 * kinds of URB can use different flags. 1468 * @transfer_buffer: This identifies the buffer to (or from) which the I/O 1469 * request will be performed unless URB_NO_TRANSFER_DMA_MAP is set 1470 * (however, do not leave garbage in transfer_buffer even then). 1471 * This buffer must be suitable for DMA; allocate it with 1472 * kmalloc() or equivalent. For transfers to "in" endpoints, contents 1473 * of this buffer will be modified. This buffer is used for the data 1474 * stage of control transfers. 1475 * @transfer_dma: When transfer_flags includes URB_NO_TRANSFER_DMA_MAP, 1476 * the device driver is saying that it provided this DMA address, 1477 * which the host controller driver should use in preference to the 1478 * transfer_buffer. 1479 * @sg: scatter gather buffer list, the buffer size of each element in 1480 * the list (except the last) must be divisible by the endpoint's 1481 * max packet size if no_sg_constraint isn't set in 'struct usb_bus' 1482 * @sgt: used to hold a scatter gather table returned by usb_alloc_noncoherent(), 1483 * which describes the allocated non-coherent and possibly non-contiguous 1484 * memory and is guaranteed to have 1 single DMA mapped segment. The 1485 * allocated memory needs to be freed by usb_free_noncoherent(). 1486 * @num_mapped_sgs: (internal) number of mapped sg entries 1487 * @num_sgs: number of entries in the sg list 1488 * @transfer_buffer_length: How big is transfer_buffer. The transfer may 1489 * be broken up into chunks according to the current maximum packet 1490 * size for the endpoint, which is a function of the configuration 1491 * and is encoded in the pipe. When the length is zero, neither 1492 * transfer_buffer nor transfer_dma is used. 1493 * @actual_length: This is read in non-iso completion functions, and 1494 * it tells how many bytes (out of transfer_buffer_length) were 1495 * transferred. It will normally be the same as requested, unless 1496 * either an error was reported or a short read was performed. 1497 * The URB_SHORT_NOT_OK transfer flag may be used to make such 1498 * short reads be reported as errors. 1499 * @setup_packet: Only used for control transfers, this points to eight bytes 1500 * of setup data. Control transfers always start by sending this data 1501 * to the device. Then transfer_buffer is read or written, if needed. 1502 * @setup_dma: DMA pointer for the setup packet. The caller must not use 1503 * this field; setup_packet must point to a valid buffer. 1504 * @start_frame: Returns the initial frame for isochronous transfers. 1505 * @number_of_packets: Lists the number of ISO transfer buffers. 1506 * @interval: Specifies the polling interval for interrupt or isochronous 1507 * transfers. The units are frames (milliseconds) for full and low 1508 * speed devices, and microframes (1/8 millisecond) for highspeed 1509 * and SuperSpeed devices. 1510 * @error_count: Returns the number of ISO transfers that reported errors. 1511 * @context: For use in completion functions. This normally points to 1512 * request-specific driver context. 1513 * @complete: Completion handler. This URB is passed as the parameter to the 1514 * completion function. The completion function may then do what 1515 * it likes with the URB, including resubmitting or freeing it. 1516 * @iso_frame_desc: Used to provide arrays of ISO transfer buffers and to 1517 * collect the transfer status for each buffer. 1518 * 1519 * This structure identifies USB transfer requests. URBs must be allocated by 1520 * calling usb_alloc_urb() and freed with a call to usb_free_urb(). 1521 * Initialization may be done using various usb_fill_*_urb() functions. URBs 1522 * are submitted using usb_submit_urb(), and pending requests may be canceled 1523 * using usb_unlink_urb() or usb_kill_urb(). 1524 * 1525 * Data Transfer Buffers: 1526 * 1527 * Normally drivers provide I/O buffers allocated with kmalloc() or otherwise 1528 * taken from the general page pool. That is provided by transfer_buffer 1529 * (control requests also use setup_packet), and host controller drivers 1530 * perform a dma mapping (and unmapping) for each buffer transferred. Those 1531 * mapping operations can be expensive on some platforms (perhaps using a dma 1532 * bounce buffer or talking to an IOMMU), 1533 * although they're cheap on commodity x86 and ppc hardware. 1534 * 1535 * Alternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag, 1536 * which tells the host controller driver that no such mapping is needed for 1537 * the transfer_buffer since 1538 * the device driver is DMA-aware. For example, a device driver might 1539 * allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map(). 1540 * When this transfer flag is provided, host controller drivers will 1541 * attempt to use the dma address found in the transfer_dma 1542 * field rather than determining a dma address themselves. 1543 * 1544 * Note that transfer_buffer must still be set if the controller 1545 * does not support DMA (as indicated by hcd_uses_dma()) and when talking 1546 * to root hub. If you have to transfer between highmem zone and the device 1547 * on such controller, create a bounce buffer or bail out with an error. 1548 * If transfer_buffer cannot be set (is in highmem) and the controller is DMA 1549 * capable, assign NULL to it, so that usbmon knows not to use the value. 1550 * The setup_packet must always be set, so it cannot be located in highmem. 1551 * 1552 * Initialization: 1553 * 1554 * All URBs submitted must initialize the dev, pipe, transfer_flags (may be 1555 * zero), and complete fields. All URBs must also initialize 1556 * transfer_buffer and transfer_buffer_length. They may provide the 1557 * URB_SHORT_NOT_OK transfer flag, indicating that short reads are 1558 * to be treated as errors; that flag is invalid for write requests. 1559 * 1560 * Bulk URBs may 1561 * use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers 1562 * should always terminate with a short packet, even if it means adding an 1563 * extra zero length packet. 1564 * 1565 * Control URBs must provide a valid pointer in the setup_packet field. 1566 * Unlike the transfer_buffer, the setup_packet may not be mapped for DMA 1567 * beforehand. 1568 * 1569 * Interrupt URBs must provide an interval, saying how often (in milliseconds 1570 * or, for highspeed devices, 125 microsecond units) 1571 * to poll for transfers. After the URB has been submitted, the interval 1572 * field reflects how the transfer was actually scheduled. 1573 * The polling interval may be more frequent than requested. 1574 * For example, some controllers have a maximum interval of 32 milliseconds, 1575 * while others support intervals of up to 1024 milliseconds. 1576 * Isochronous URBs also have transfer intervals. (Note that for isochronous 1577 * endpoints, as well as high speed interrupt endpoints, the encoding of 1578 * the transfer interval in the endpoint descriptor is logarithmic. 1579 * Device drivers must convert that value to linear units themselves.) 1580 * 1581 * If an isochronous endpoint queue isn't already running, the host 1582 * controller will schedule a new URB to start as soon as bandwidth 1583 * utilization allows. If the queue is running then a new URB will be 1584 * scheduled to start in the first transfer slot following the end of the 1585 * preceding URB, if that slot has not already expired. If the slot has 1586 * expired (which can happen when IRQ delivery is delayed for a long time), 1587 * the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag 1588 * is clear then the URB will be scheduled to start in the expired slot, 1589 * implying that some of its packets will not be transferred; if the flag 1590 * is set then the URB will be scheduled in the first unexpired slot, 1591 * breaking the queue's synchronization. Upon URB completion, the 1592 * start_frame field will be set to the (micro)frame number in which the 1593 * transfer was scheduled. Ranges for frame counter values are HC-specific 1594 * and can go from as low as 256 to as high as 65536 frames. 1595 * 1596 * Isochronous URBs have a different data transfer model, in part because 1597 * the quality of service is only "best effort". Callers provide specially 1598 * allocated URBs, with number_of_packets worth of iso_frame_desc structures 1599 * at the end. Each such packet is an individual ISO transfer. Isochronous 1600 * URBs are normally queued, submitted by drivers to arrange that 1601 * transfers are at least double buffered, and then explicitly resubmitted 1602 * in completion handlers, so 1603 * that data (such as audio or video) streams at as constant a rate as the 1604 * host controller scheduler can support. 1605 * 1606 * Completion Callbacks: 1607 * 1608 * The completion callback is made in_interrupt(), and one of the first 1609 * things that a completion handler should do is check the status field. 1610 * The status field is provided for all URBs. It is used to report 1611 * unlinked URBs, and status for all non-ISO transfers. It should not 1612 * be examined before the URB is returned to the completion handler. 1613 * 1614 * The context field is normally used to link URBs back to the relevant 1615 * driver or request state. 1616 * 1617 * When the completion callback is invoked for non-isochronous URBs, the 1618 * actual_length field tells how many bytes were transferred. This field 1619 * is updated even when the URB terminated with an error or was unlinked. 1620 * 1621 * ISO transfer status is reported in the status and actual_length fields 1622 * of the iso_frame_desc array, and the number of errors is reported in 1623 * error_count. Completion callbacks for ISO transfers will normally 1624 * (re)submit URBs to ensure a constant transfer rate. 1625 * 1626 * Note that even fields marked "public" should not be touched by the driver 1627 * when the urb is owned by the hcd, that is, since the call to 1628 * usb_submit_urb() till the entry into the completion routine. 1629 */ 1630struct urb { 1631 /* private: usb core and host controller only fields in the urb */ 1632 struct kref kref; /* reference count of the URB */ 1633 int unlinked; /* unlink error code */ 1634 void *hcpriv; /* private data for host controller */ 1635 atomic_t use_count; /* concurrent submissions counter */ 1636 atomic_t reject; /* submissions will fail */ 1637 1638 /* public: documented fields in the urb that can be used by drivers */ 1639 struct list_head urb_list; /* list head for use by the urb's 1640 * current owner */ 1641 struct list_head anchor_list; /* the URB may be anchored */ 1642 struct usb_anchor *anchor; 1643 struct usb_device *dev; /* (in) pointer to associated device */ 1644 struct usb_host_endpoint *ep; /* (internal) pointer to endpoint */ 1645 unsigned int pipe; /* (in) pipe information */ 1646 unsigned int stream_id; /* (in) stream ID */ 1647 int status; /* (return) non-ISO status */ 1648 unsigned int transfer_flags; /* (in) URB_SHORT_NOT_OK | ...*/ 1649 void *transfer_buffer; /* (in) associated data buffer */ 1650 dma_addr_t transfer_dma; /* (in) dma addr for transfer_buffer */ 1651 struct scatterlist *sg; /* (in) scatter gather buffer list */ 1652 struct sg_table *sgt; /* (in) scatter gather table for noncoherent buffer */ 1653 int num_mapped_sgs; /* (internal) mapped sg entries */ 1654 int num_sgs; /* (in) number of entries in the sg list */ 1655 u32 transfer_buffer_length; /* (in) data buffer length */ 1656 u32 actual_length; /* (return) actual transfer length */ 1657 unsigned char *setup_packet; /* (in) setup packet (control only) */ 1658 dma_addr_t setup_dma; /* (in) dma addr for setup_packet */ 1659 int start_frame; /* (modify) start frame (ISO) */ 1660 int number_of_packets; /* (in) number of ISO packets */ 1661 int interval; /* (modify) transfer interval 1662 * (INT/ISO) */ 1663 int error_count; /* (return) number of ISO errors */ 1664 void *context; /* (in) context for completion */ 1665 usb_complete_t complete; /* (in) completion routine */ 1666 struct usb_iso_packet_descriptor iso_frame_desc[]; 1667 /* (in) ISO ONLY */ 1668}; 1669 1670/* ----------------------------------------------------------------------- */ 1671 1672/** 1673 * usb_fill_control_urb - initializes a control urb 1674 * @urb: pointer to the urb to initialize. 1675 * @dev: pointer to the struct usb_device for this urb. 1676 * @pipe: the endpoint pipe 1677 * @setup_packet: pointer to the setup_packet buffer. The buffer must be 1678 * suitable for DMA. 1679 * @transfer_buffer: pointer to the transfer buffer. The buffer must be 1680 * suitable for DMA. 1681 * @buffer_length: length of the transfer buffer 1682 * @complete_fn: pointer to the usb_complete_t function 1683 * @context: what to set the urb context to. 1684 * 1685 * Initializes a control urb with the proper information needed to submit 1686 * it to a device. 1687 * 1688 * The transfer buffer and the setup_packet buffer will most likely be filled 1689 * or read via DMA. The simplest way to get a buffer that can be DMAed to is 1690 * allocating it via kmalloc() or equivalent, even for very small buffers. 1691 * If the buffers are embedded in a bigger structure, there is a risk that 1692 * the buffer itself, the previous fields and/or the next fields are corrupted 1693 * due to cache incoherencies; or slowed down if they are evicted from the 1694 * cache. For more information, check &struct urb. 1695 * 1696 */ 1697static inline void usb_fill_control_urb(struct urb *urb, 1698 struct usb_device *dev, 1699 unsigned int pipe, 1700 unsigned char *setup_packet, 1701 void *transfer_buffer, 1702 int buffer_length, 1703 usb_complete_t complete_fn, 1704 void *context) 1705{ 1706 urb->dev = dev; 1707 urb->pipe = pipe; 1708 urb->setup_packet = setup_packet; 1709 urb->transfer_buffer = transfer_buffer; 1710 urb->transfer_buffer_length = buffer_length; 1711 urb->complete = complete_fn; 1712 urb->context = context; 1713} 1714 1715/** 1716 * usb_fill_bulk_urb - macro to help initialize a bulk urb 1717 * @urb: pointer to the urb to initialize. 1718 * @dev: pointer to the struct usb_device for this urb. 1719 * @pipe: the endpoint pipe 1720 * @transfer_buffer: pointer to the transfer buffer. The buffer must be 1721 * suitable for DMA. 1722 * @buffer_length: length of the transfer buffer 1723 * @complete_fn: pointer to the usb_complete_t function 1724 * @context: what to set the urb context to. 1725 * 1726 * Initializes a bulk urb with the proper information needed to submit it 1727 * to a device. 1728 * 1729 * Refer to usb_fill_control_urb() for a description of the requirements for 1730 * transfer_buffer. 1731 */ 1732static inline void usb_fill_bulk_urb(struct urb *urb, 1733 struct usb_device *dev, 1734 unsigned int pipe, 1735 void *transfer_buffer, 1736 int buffer_length, 1737 usb_complete_t complete_fn, 1738 void *context) 1739{ 1740 urb->dev = dev; 1741 urb->pipe = pipe; 1742 urb->transfer_buffer = transfer_buffer; 1743 urb->transfer_buffer_length = buffer_length; 1744 urb->complete = complete_fn; 1745 urb->context = context; 1746} 1747 1748/** 1749 * usb_fill_int_urb - macro to help initialize a interrupt urb 1750 * @urb: pointer to the urb to initialize. 1751 * @dev: pointer to the struct usb_device for this urb. 1752 * @pipe: the endpoint pipe 1753 * @transfer_buffer: pointer to the transfer buffer. The buffer must be 1754 * suitable for DMA. 1755 * @buffer_length: length of the transfer buffer 1756 * @complete_fn: pointer to the usb_complete_t function 1757 * @context: what to set the urb context to. 1758 * @interval: what to set the urb interval to, encoded like 1759 * the endpoint descriptor's bInterval value. 1760 * 1761 * Initializes a interrupt urb with the proper information needed to submit 1762 * it to a device. 1763 * 1764 * Refer to usb_fill_control_urb() for a description of the requirements for 1765 * transfer_buffer. 1766 * 1767 * Note that High Speed and SuperSpeed(+) interrupt endpoints use a logarithmic 1768 * encoding of the endpoint interval, and express polling intervals in 1769 * microframes (eight per millisecond) rather than in frames (one per 1770 * millisecond). 1771 */ 1772static inline void usb_fill_int_urb(struct urb *urb, 1773 struct usb_device *dev, 1774 unsigned int pipe, 1775 void *transfer_buffer, 1776 int buffer_length, 1777 usb_complete_t complete_fn, 1778 void *context, 1779 int interval) 1780{ 1781 urb->dev = dev; 1782 urb->pipe = pipe; 1783 urb->transfer_buffer = transfer_buffer; 1784 urb->transfer_buffer_length = buffer_length; 1785 urb->complete = complete_fn; 1786 urb->context = context; 1787 1788 if (dev->speed == USB_SPEED_HIGH || dev->speed >= USB_SPEED_SUPER) { 1789 /* make sure interval is within allowed range */ 1790 interval = clamp(interval, 1, 16); 1791 1792 urb->interval = 1 << (interval - 1); 1793 } else { 1794 urb->interval = interval; 1795 } 1796 1797 urb->start_frame = -1; 1798} 1799 1800extern void usb_init_urb(struct urb *urb); 1801extern struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags); 1802extern void usb_free_urb(struct urb *urb); 1803#define usb_put_urb usb_free_urb 1804extern struct urb *usb_get_urb(struct urb *urb); 1805extern int usb_submit_urb(struct urb *urb, gfp_t mem_flags); 1806extern int usb_unlink_urb(struct urb *urb); 1807extern void usb_kill_urb(struct urb *urb); 1808extern void usb_poison_urb(struct urb *urb); 1809extern void usb_unpoison_urb(struct urb *urb); 1810extern void usb_block_urb(struct urb *urb); 1811extern void usb_kill_anchored_urbs(struct usb_anchor *anchor); 1812extern void usb_poison_anchored_urbs(struct usb_anchor *anchor); 1813extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor); 1814extern void usb_anchor_suspend_wakeups(struct usb_anchor *anchor); 1815extern void usb_anchor_resume_wakeups(struct usb_anchor *anchor); 1816extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor); 1817extern void usb_unanchor_urb(struct urb *urb); 1818extern int usb_wait_anchor_empty_timeout(struct usb_anchor *anchor, 1819 unsigned int timeout); 1820extern struct urb *usb_get_from_anchor(struct usb_anchor *anchor); 1821extern void usb_scuttle_anchored_urbs(struct usb_anchor *anchor); 1822extern int usb_anchor_empty(struct usb_anchor *anchor); 1823 1824#define usb_unblock_urb usb_unpoison_urb 1825 1826/** 1827 * usb_urb_dir_in - check if an URB describes an IN transfer 1828 * @urb: URB to be checked 1829 * 1830 * Return: 1 if @urb describes an IN transfer (device-to-host), 1831 * otherwise 0. 1832 */ 1833static inline int usb_urb_dir_in(struct urb *urb) 1834{ 1835 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_IN; 1836} 1837 1838/** 1839 * usb_urb_dir_out - check if an URB describes an OUT transfer 1840 * @urb: URB to be checked 1841 * 1842 * Return: 1 if @urb describes an OUT transfer (host-to-device), 1843 * otherwise 0. 1844 */ 1845static inline int usb_urb_dir_out(struct urb *urb) 1846{ 1847 return (urb->transfer_flags & URB_DIR_MASK) == URB_DIR_OUT; 1848} 1849 1850int usb_pipe_type_check(struct usb_device *dev, unsigned int pipe); 1851int usb_urb_ep_type_check(const struct urb *urb); 1852 1853void *usb_alloc_coherent(struct usb_device *dev, size_t size, 1854 gfp_t mem_flags, dma_addr_t *dma); 1855void usb_free_coherent(struct usb_device *dev, size_t size, 1856 void *addr, dma_addr_t dma); 1857 1858enum dma_data_direction; 1859 1860void *usb_alloc_noncoherent(struct usb_device *dev, size_t size, 1861 gfp_t mem_flags, dma_addr_t *dma, 1862 enum dma_data_direction dir, 1863 struct sg_table **table); 1864void usb_free_noncoherent(struct usb_device *dev, size_t size, 1865 void *addr, enum dma_data_direction dir, 1866 struct sg_table *table); 1867 1868/*-------------------------------------------------------------------* 1869 * SYNCHRONOUS CALL SUPPORT * 1870 *-------------------------------------------------------------------*/ 1871 1872/* Maximum value allowed for timeout in synchronous routines below */ 1873#define USB_MAX_SYNCHRONOUS_TIMEOUT 60000 /* ms */ 1874 1875extern int usb_control_msg(struct usb_device *dev, unsigned int pipe, 1876 __u8 request, __u8 requesttype, __u16 value, __u16 index, 1877 void *data, __u16 size, int timeout); 1878extern int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe, 1879 void *data, int len, int *actual_length, int timeout); 1880extern int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, 1881 void *data, int len, int *actual_length, int timeout); 1882extern int usb_bulk_msg_killable(struct usb_device *usb_dev, unsigned int pipe, 1883 void *data, int len, int *actual_length, int timeout); 1884 1885/* wrappers around usb_control_msg() for the most common standard requests */ 1886int usb_control_msg_send(struct usb_device *dev, __u8 endpoint, __u8 request, 1887 __u8 requesttype, __u16 value, __u16 index, 1888 const void *data, __u16 size, int timeout, 1889 gfp_t memflags); 1890int usb_control_msg_recv(struct usb_device *dev, __u8 endpoint, __u8 request, 1891 __u8 requesttype, __u16 value, __u16 index, 1892 void *data, __u16 size, int timeout, 1893 gfp_t memflags); 1894extern int usb_get_descriptor(struct usb_device *dev, unsigned char desctype, 1895 unsigned char descindex, void *buf, int size); 1896extern int usb_get_status(struct usb_device *dev, 1897 int recip, int type, int target, void *data); 1898 1899static inline int usb_get_std_status(struct usb_device *dev, 1900 int recip, int target, void *data) 1901{ 1902 return usb_get_status(dev, recip, USB_STATUS_TYPE_STANDARD, target, 1903 data); 1904} 1905 1906static inline int usb_get_ptm_status(struct usb_device *dev, void *data) 1907{ 1908 return usb_get_status(dev, USB_RECIP_DEVICE, USB_STATUS_TYPE_PTM, 1909 0, data); 1910} 1911 1912extern int usb_string(struct usb_device *dev, int index, 1913 char *buf, size_t size); 1914extern char *usb_cache_string(struct usb_device *udev, int index); 1915 1916/* wrappers that also update important state inside usbcore */ 1917extern int usb_clear_halt(struct usb_device *dev, int pipe); 1918extern int usb_reset_configuration(struct usb_device *dev); 1919extern int usb_set_interface(struct usb_device *dev, int ifnum, int alternate); 1920extern void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr); 1921 1922/* this request isn't really synchronous, but it belongs with the others */ 1923extern int usb_driver_set_configuration(struct usb_device *udev, int config); 1924 1925/* choose and set configuration for device */ 1926extern int usb_choose_configuration(struct usb_device *udev); 1927extern int usb_set_configuration(struct usb_device *dev, int configuration); 1928 1929/* 1930 * timeouts, in milliseconds, used for sending/receiving control messages 1931 * they typically complete within a few frames (msec) after they're issued 1932 * USB identifies 5 second timeouts, maybe more in a few cases, and a few 1933 * slow devices (like some MGE Ellipse UPSes) actually push that limit. 1934 */ 1935#define USB_CTRL_GET_TIMEOUT 5000 1936#define USB_CTRL_SET_TIMEOUT 5000 1937 1938 1939/** 1940 * struct usb_sg_request - support for scatter/gather I/O 1941 * @status: zero indicates success, else negative errno 1942 * @bytes: counts bytes transferred. 1943 * 1944 * These requests are initialized using usb_sg_init(), and then are used 1945 * as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most 1946 * members of the request object aren't for driver access. 1947 * 1948 * The status and bytecount values are valid only after usb_sg_wait() 1949 * returns. If the status is zero, then the bytecount matches the total 1950 * from the request. 1951 * 1952 * After an error completion, drivers may need to clear a halt condition 1953 * on the endpoint. 1954 */ 1955struct usb_sg_request { 1956 int status; 1957 size_t bytes; 1958 1959 /* private: 1960 * members below are private to usbcore, 1961 * and are not provided for driver access! 1962 */ 1963 spinlock_t lock; 1964 1965 struct usb_device *dev; 1966 int pipe; 1967 1968 int entries; 1969 struct urb **urbs; 1970 1971 int count; 1972 struct completion complete; 1973}; 1974 1975int usb_sg_init( 1976 struct usb_sg_request *io, 1977 struct usb_device *dev, 1978 unsigned pipe, 1979 unsigned period, 1980 struct scatterlist *sg, 1981 int nents, 1982 size_t length, 1983 gfp_t mem_flags 1984); 1985void usb_sg_cancel(struct usb_sg_request *io); 1986void usb_sg_wait(struct usb_sg_request *io); 1987 1988 1989/* ----------------------------------------------------------------------- */ 1990 1991/* 1992 * For various legacy reasons, Linux has a small cookie that's paired with 1993 * a struct usb_device to identify an endpoint queue. Queue characteristics 1994 * are defined by the endpoint's descriptor. This cookie is called a "pipe", 1995 * an unsigned int encoded as: 1996 * 1997 * - direction: bit 7 (0 = Host-to-Device [Out], 1998 * 1 = Device-to-Host [In] ... 1999 * like endpoint bEndpointAddress) 2000 * - device address: bits 8-14 ... bit positions known to uhci-hcd 2001 * - endpoint: bits 15-18 ... bit positions known to uhci-hcd 2002 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 2003 * 10 = control, 11 = bulk) 2004 * 2005 * Given the device address and endpoint descriptor, pipes are redundant. 2006 */ 2007 2008/* NOTE: these are not the standard USB_ENDPOINT_XFER_* values!! */ 2009/* (yet ... they're the values used by usbfs) */ 2010#define PIPE_ISOCHRONOUS 0 2011#define PIPE_INTERRUPT 1 2012#define PIPE_CONTROL 2 2013#define PIPE_BULK 3 2014 2015#define usb_pipein(pipe) ((pipe) & USB_DIR_IN) 2016#define usb_pipeout(pipe) (!usb_pipein(pipe)) 2017 2018#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) 2019#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) 2020 2021#define usb_pipetype(pipe) (((pipe) >> 30) & 3) 2022#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) 2023#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) 2024#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) 2025#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) 2026 2027static inline unsigned int __create_pipe(struct usb_device *dev, 2028 unsigned int endpoint) 2029{ 2030 return (dev->devnum << 8) | (endpoint << 15); 2031} 2032 2033/* Create various pipes... */ 2034#define usb_sndctrlpipe(dev, endpoint) \ 2035 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint)) 2036#define usb_rcvctrlpipe(dev, endpoint) \ 2037 ((PIPE_CONTROL << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN) 2038#define usb_sndisocpipe(dev, endpoint) \ 2039 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint)) 2040#define usb_rcvisocpipe(dev, endpoint) \ 2041 ((PIPE_ISOCHRONOUS << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN) 2042#define usb_sndbulkpipe(dev, endpoint) \ 2043 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint)) 2044#define usb_rcvbulkpipe(dev, endpoint) \ 2045 ((PIPE_BULK << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN) 2046#define usb_sndintpipe(dev, endpoint) \ 2047 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint)) 2048#define usb_rcvintpipe(dev, endpoint) \ 2049 ((PIPE_INTERRUPT << 30) | __create_pipe(dev, endpoint) | USB_DIR_IN) 2050 2051static inline struct usb_host_endpoint * 2052usb_pipe_endpoint(struct usb_device *dev, unsigned int pipe) 2053{ 2054 struct usb_host_endpoint **eps; 2055 eps = usb_pipein(pipe) ? dev->ep_in : dev->ep_out; 2056 return eps[usb_pipeendpoint(pipe)]; 2057} 2058 2059static inline u16 usb_maxpacket(struct usb_device *udev, int pipe) 2060{ 2061 struct usb_host_endpoint *ep = usb_pipe_endpoint(udev, pipe); 2062 2063 if (!ep) 2064 return 0; 2065 2066 /* NOTE: only 0x07ff bits are for packet size... */ 2067 return usb_endpoint_maxp(&ep->desc); 2068} 2069 2070u32 usb_endpoint_max_periodic_payload(struct usb_device *udev, 2071 const struct usb_host_endpoint *ep); 2072 2073bool usb_endpoint_is_hs_isoc_double(struct usb_device *udev, 2074 const struct usb_host_endpoint *ep); 2075 2076/* translate USB error codes to codes user space understands */ 2077static inline int usb_translate_errors(int error_code) 2078{ 2079 switch (error_code) { 2080 case 0: 2081 case -ENOMEM: 2082 case -ENODEV: 2083 case -EOPNOTSUPP: 2084 return error_code; 2085 default: 2086 return -EIO; 2087 } 2088} 2089 2090/* Events from the usb core */ 2091#define USB_DEVICE_ADD 0x0001 2092#define USB_DEVICE_REMOVE 0x0002 2093#define USB_BUS_ADD 0x0003 2094#define USB_BUS_REMOVE 0x0004 2095extern void usb_register_notify(struct notifier_block *nb); 2096extern void usb_unregister_notify(struct notifier_block *nb); 2097 2098/* debugfs stuff */ 2099extern struct dentry *usb_debug_root; 2100 2101/* LED triggers */ 2102enum usb_led_event { 2103 USB_LED_EVENT_HOST = 0, 2104 USB_LED_EVENT_GADGET = 1, 2105}; 2106 2107#ifdef CONFIG_USB_LED_TRIG 2108extern void usb_led_activity(enum usb_led_event ev); 2109#else 2110static inline void usb_led_activity(enum usb_led_event ev) {} 2111#endif 2112 2113#endif /* __KERNEL__ */ 2114 2115#endif
~/
Read-only file preview.