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