1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * Copyright (c) 2001-2002 by David Brownell 4 * 5 * This program is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License as published by the 7 * Free Software Foundation; either version 2 of the License, or (at your 8 * option) any later version. 9 * 10 * This program is distributed in the hope that it will be useful, but 11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 * for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software Foundation, 17 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 18 */ 19 20 #ifndef __USB_CORE_HCD_H 21 #define __USB_CORE_HCD_H 22 23 #ifdef __KERNEL__ 24 25 #include <linux/rwsem.h> 26 #include <linux/interrupt.h> 27 #include <linux/idr.h> 28 29 #define MAX_TOPO_LEVEL 6 30 31 /* This file contains declarations of usbcore internals that are mostly 32 * used or exposed by Host Controller Drivers. 33 */ 34 35 /* 36 * USB Packet IDs (PIDs) 37 */ 38 #define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */ 39 #define USB_PID_OUT 0xe1 40 #define USB_PID_ACK 0xd2 41 #define USB_PID_DATA0 0xc3 42 #define USB_PID_PING 0xb4 /* USB 2.0 */ 43 #define USB_PID_SOF 0xa5 44 #define USB_PID_NYET 0x96 /* USB 2.0 */ 45 #define USB_PID_DATA2 0x87 /* USB 2.0 */ 46 #define USB_PID_SPLIT 0x78 /* USB 2.0 */ 47 #define USB_PID_IN 0x69 48 #define USB_PID_NAK 0x5a 49 #define USB_PID_DATA1 0x4b 50 #define USB_PID_PREAMBLE 0x3c /* Token mode */ 51 #define USB_PID_ERR 0x3c /* USB 2.0: handshake mode */ 52 #define USB_PID_SETUP 0x2d 53 #define USB_PID_STALL 0x1e 54 #define USB_PID_MDATA 0x0f /* USB 2.0 */ 55 56 /*-------------------------------------------------------------------------*/ 57 58 /* 59 * USB Host Controller Driver (usb_hcd) framework 60 * 61 * Since "struct usb_bus" is so thin, you can't share much code in it. 62 * This framework is a layer over that, and should be more sharable. 63 */ 64 65 /*-------------------------------------------------------------------------*/ 66 67 struct giveback_urb_bh { 68 bool running; 69 spinlock_t lock; 70 struct list_head head; 71 struct tasklet_struct bh; 72 struct usb_host_endpoint *completing_ep; 73 }; 74 75 struct usb_hcd { 76 77 /* 78 * housekeeping 79 */ 80 struct usb_bus self; /* hcd is-a bus */ 81 struct kref kref; /* reference counter */ 82 83 const char *product_desc; /* product/vendor string */ 84 int speed; /* Speed for this roothub. 85 * May be different from 86 * hcd->driver->flags & HCD_MASK 87 */ 88 char irq_descr[24]; /* driver + bus # */ 89 90 struct timer_list rh_timer; /* drives root-hub polling */ 91 struct urb *status_urb; /* the current status urb */ 92 #ifdef CONFIG_PM 93 struct work_struct wakeup_work; /* for remote wakeup */ 94 #endif 95 96 /* 97 * hardware info/state 98 */ 99 const struct hc_driver *driver; /* hw-specific hooks */ 100 101 /* 102 * OTG and some Host controllers need software interaction with phys; 103 * other external phys should be software-transparent 104 */ 105 struct usb_phy *usb_phy; 106 struct phy *phy; 107 108 /* Flags that need to be manipulated atomically because they can 109 * change while the host controller is running. Always use 110 * set_bit() or clear_bit() to change their values. 111 */ 112 unsigned long flags; 113 #define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */ 114 #define HCD_FLAG_POLL_RH 2 /* poll for rh status? */ 115 #define HCD_FLAG_POLL_PENDING 3 /* status has changed? */ 116 #define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */ 117 #define HCD_FLAG_RH_RUNNING 5 /* root hub is running? */ 118 #define HCD_FLAG_DEAD 6 /* controller has died? */ 119 #define HCD_FLAG_INTF_AUTHORIZED 7 /* authorize interfaces? */ 120 #define HCD_FLAG_DEV_AUTHORIZED 8 /* authorize devices? */ 121 122 /* The flags can be tested using these macros; they are likely to 123 * be slightly faster than test_bit(). 124 */ 125 #define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE)) 126 #define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH)) 127 #define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING)) 128 #define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING)) 129 #define HCD_RH_RUNNING(hcd) ((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING)) 130 #define HCD_DEAD(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEAD)) 131 132 /* 133 * Specifies if interfaces are authorized by default 134 * or they require explicit user space authorization; this bit is 135 * settable through /sys/class/usb_host/X/interface_authorized_default 136 */ 137 #define HCD_INTF_AUTHORIZED(hcd) \ 138 ((hcd)->flags & (1U << HCD_FLAG_INTF_AUTHORIZED)) 139 140 /* 141 * Specifies if devices are authorized by default 142 * or they require explicit user space authorization; this bit is 143 * settable through /sys/class/usb_host/X/authorized_default 144 */ 145 #define HCD_DEV_AUTHORIZED(hcd) \ 146 ((hcd)->flags & (1U << HCD_FLAG_DEV_AUTHORIZED)) 147 148 /* Flags that get set only during HCD registration or removal. */ 149 unsigned rh_registered:1;/* is root hub registered? */ 150 unsigned rh_pollable:1; /* may we poll the root hub? */ 151 unsigned msix_enabled:1; /* driver has MSI-X enabled? */ 152 unsigned msi_enabled:1; /* driver has MSI enabled? */ 153 unsigned remove_phy:1; /* auto-remove USB phy */ 154 155 /* The next flag is a stopgap, to be removed when all the HCDs 156 * support the new root-hub polling mechanism. */ 157 unsigned uses_new_polling:1; 158 unsigned wireless:1; /* Wireless USB HCD */ 159 unsigned has_tt:1; /* Integrated TT in root hub */ 160 unsigned amd_resume_bug:1; /* AMD remote wakeup quirk */ 161 unsigned can_do_streams:1; /* HC supports streams */ 162 unsigned tpl_support:1; /* OTG & EH TPL support */ 163 unsigned cant_recv_wakeups:1; 164 /* wakeup requests from downstream aren't received */ 165 166 unsigned int irq; /* irq allocated */ 167 void __iomem *regs; /* device memory/io */ 168 resource_size_t rsrc_start; /* memory/io resource start */ 169 resource_size_t rsrc_len; /* memory/io resource length */ 170 unsigned power_budget; /* in mA, 0 = no limit */ 171 172 struct giveback_urb_bh high_prio_bh; 173 struct giveback_urb_bh low_prio_bh; 174 175 /* bandwidth_mutex should be taken before adding or removing 176 * any new bus bandwidth constraints: 177 * 1. Before adding a configuration for a new device. 178 * 2. Before removing the configuration to put the device into 179 * the addressed state. 180 * 3. Before selecting a different configuration. 181 * 4. Before selecting an alternate interface setting. 182 * 183 * bandwidth_mutex should be dropped after a successful control message 184 * to the device, or resetting the bandwidth after a failed attempt. 185 */ 186 struct mutex *address0_mutex; 187 struct mutex *bandwidth_mutex; 188 struct usb_hcd *shared_hcd; 189 struct usb_hcd *primary_hcd; 190 191 192 #define HCD_BUFFER_POOLS 4 193 struct dma_pool *pool[HCD_BUFFER_POOLS]; 194 195 int state; 196 # define __ACTIVE 0x01 197 # define __SUSPEND 0x04 198 # define __TRANSIENT 0x80 199 200 # define HC_STATE_HALT 0 201 # define HC_STATE_RUNNING (__ACTIVE) 202 # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE) 203 # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT) 204 # define HC_STATE_SUSPENDED (__SUSPEND) 205 206 #define HC_IS_RUNNING(state) ((state) & __ACTIVE) 207 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND) 208 209 /* more shared queuing code would be good; it should support 210 * smarter scheduling, handle transaction translators, etc; 211 * input size of periodic table to an interrupt scheduler. 212 * (ohci 32, uhci 1024, ehci 256/512/1024). 213 */ 214 215 /* The HC driver's private data is stored at the end of 216 * this structure. 217 */ 218 unsigned long hcd_priv[0] 219 __attribute__ ((aligned(sizeof(s64)))); 220 }; 221 222 /* 2.4 does this a bit differently ... */ 223 static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd) 224 { 225 return &hcd->self; 226 } 227 228 static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus) 229 { 230 return container_of(bus, struct usb_hcd, self); 231 } 232 233 struct hcd_timeout { /* timeouts we allocate */ 234 struct list_head timeout_list; 235 struct timer_list timer; 236 }; 237 238 /*-------------------------------------------------------------------------*/ 239 240 241 struct hc_driver { 242 const char *description; /* "ehci-hcd" etc */ 243 const char *product_desc; /* product/vendor string */ 244 size_t hcd_priv_size; /* size of private data */ 245 246 /* irq handler */ 247 irqreturn_t (*irq) (struct usb_hcd *hcd); 248 249 int flags; 250 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */ 251 #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */ 252 #define HCD_SHARED 0x0004 /* Two (or more) usb_hcds share HW */ 253 #define HCD_USB11 0x0010 /* USB 1.1 */ 254 #define HCD_USB2 0x0020 /* USB 2.0 */ 255 #define HCD_USB25 0x0030 /* Wireless USB 1.0 (USB 2.5)*/ 256 #define HCD_USB3 0x0040 /* USB 3.0 */ 257 #define HCD_USB31 0x0050 /* USB 3.1 */ 258 #define HCD_MASK 0x0070 259 #define HCD_BH 0x0100 /* URB complete in BH context */ 260 261 /* called to init HCD and root hub */ 262 int (*reset) (struct usb_hcd *hcd); 263 int (*start) (struct usb_hcd *hcd); 264 265 /* NOTE: these suspend/resume calls relate to the HC as 266 * a whole, not just the root hub; they're for PCI bus glue. 267 */ 268 /* called after suspending the hub, before entering D3 etc */ 269 int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup); 270 271 /* called after entering D0 (etc), before resuming the hub */ 272 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated); 273 274 /* cleanly make HCD stop writing memory and doing I/O */ 275 void (*stop) (struct usb_hcd *hcd); 276 277 /* shutdown HCD */ 278 void (*shutdown) (struct usb_hcd *hcd); 279 280 /* return current frame number */ 281 int (*get_frame_number) (struct usb_hcd *hcd); 282 283 /* manage i/o requests, device state */ 284 int (*urb_enqueue)(struct usb_hcd *hcd, 285 struct urb *urb, gfp_t mem_flags); 286 int (*urb_dequeue)(struct usb_hcd *hcd, 287 struct urb *urb, int status); 288 289 /* 290 * (optional) these hooks allow an HCD to override the default DMA 291 * mapping and unmapping routines. In general, they shouldn't be 292 * necessary unless the host controller has special DMA requirements, 293 * such as alignment contraints. If these are not specified, the 294 * general usb_hcd_(un)?map_urb_for_dma functions will be used instead 295 * (and it may be a good idea to call these functions in your HCD 296 * implementation) 297 */ 298 int (*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb, 299 gfp_t mem_flags); 300 void (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb); 301 302 /* hw synch, freeing endpoint resources that urb_dequeue can't */ 303 void (*endpoint_disable)(struct usb_hcd *hcd, 304 struct usb_host_endpoint *ep); 305 306 /* (optional) reset any endpoint state such as sequence number 307 and current window */ 308 void (*endpoint_reset)(struct usb_hcd *hcd, 309 struct usb_host_endpoint *ep); 310 311 /* root hub support */ 312 int (*hub_status_data) (struct usb_hcd *hcd, char *buf); 313 int (*hub_control) (struct usb_hcd *hcd, 314 u16 typeReq, u16 wValue, u16 wIndex, 315 char *buf, u16 wLength); 316 int (*bus_suspend)(struct usb_hcd *); 317 int (*bus_resume)(struct usb_hcd *); 318 int (*start_port_reset)(struct usb_hcd *, unsigned port_num); 319 320 /* force handover of high-speed port to full-speed companion */ 321 void (*relinquish_port)(struct usb_hcd *, int); 322 /* has a port been handed over to a companion? */ 323 int (*port_handed_over)(struct usb_hcd *, int); 324 325 /* CLEAR_TT_BUFFER completion callback */ 326 void (*clear_tt_buffer_complete)(struct usb_hcd *, 327 struct usb_host_endpoint *); 328 329 /* xHCI specific functions */ 330 /* Called by usb_alloc_dev to alloc HC device structures */ 331 int (*alloc_dev)(struct usb_hcd *, struct usb_device *); 332 /* Called by usb_disconnect to free HC device structures */ 333 void (*free_dev)(struct usb_hcd *, struct usb_device *); 334 /* Change a group of bulk endpoints to support multiple stream IDs */ 335 int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev, 336 struct usb_host_endpoint **eps, unsigned int num_eps, 337 unsigned int num_streams, gfp_t mem_flags); 338 /* Reverts a group of bulk endpoints back to not using stream IDs. 339 * Can fail if we run out of memory. 340 */ 341 int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev, 342 struct usb_host_endpoint **eps, unsigned int num_eps, 343 gfp_t mem_flags); 344 345 /* Bandwidth computation functions */ 346 /* Note that add_endpoint() can only be called once per endpoint before 347 * check_bandwidth() or reset_bandwidth() must be called. 348 * drop_endpoint() can only be called once per endpoint also. 349 * A call to xhci_drop_endpoint() followed by a call to 350 * xhci_add_endpoint() will add the endpoint to the schedule with 351 * possibly new parameters denoted by a different endpoint descriptor 352 * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a 353 * call to xhci_drop_endpoint() is not allowed. 354 */ 355 /* Allocate endpoint resources and add them to a new schedule */ 356 int (*add_endpoint)(struct usb_hcd *, struct usb_device *, 357 struct usb_host_endpoint *); 358 /* Drop an endpoint from a new schedule */ 359 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *, 360 struct usb_host_endpoint *); 361 /* Check that a new hardware configuration, set using 362 * endpoint_enable and endpoint_disable, does not exceed bus 363 * bandwidth. This must be called before any set configuration 364 * or set interface requests are sent to the device. 365 */ 366 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *); 367 /* Reset the device schedule to the last known good schedule, 368 * which was set from a previous successful call to 369 * check_bandwidth(). This reverts any add_endpoint() and 370 * drop_endpoint() calls since that last successful call. 371 * Used for when a check_bandwidth() call fails due to resource 372 * or bandwidth constraints. 373 */ 374 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *); 375 /* Returns the hardware-chosen device address */ 376 int (*address_device)(struct usb_hcd *, struct usb_device *udev); 377 /* prepares the hardware to send commands to the device */ 378 int (*enable_device)(struct usb_hcd *, struct usb_device *udev); 379 /* Notifies the HCD after a hub descriptor is fetched. 380 * Will block. 381 */ 382 int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev, 383 struct usb_tt *tt, gfp_t mem_flags); 384 int (*reset_device)(struct usb_hcd *, struct usb_device *); 385 /* Notifies the HCD after a device is connected and its 386 * address is set 387 */ 388 int (*update_device)(struct usb_hcd *, struct usb_device *); 389 int (*set_usb2_hw_lpm)(struct usb_hcd *, struct usb_device *, int); 390 /* USB 3.0 Link Power Management */ 391 /* Returns the USB3 hub-encoded value for the U1/U2 timeout. */ 392 int (*enable_usb3_lpm_timeout)(struct usb_hcd *, 393 struct usb_device *, enum usb3_link_state state); 394 /* The xHCI host controller can still fail the command to 395 * disable the LPM timeouts, so this can return an error code. 396 */ 397 int (*disable_usb3_lpm_timeout)(struct usb_hcd *, 398 struct usb_device *, enum usb3_link_state state); 399 int (*find_raw_port_number)(struct usb_hcd *, int); 400 /* Call for power on/off the port if necessary */ 401 int (*port_power)(struct usb_hcd *hcd, int portnum, bool enable); 402 403 }; 404 405 static inline int hcd_giveback_urb_in_bh(struct usb_hcd *hcd) 406 { 407 return hcd->driver->flags & HCD_BH; 408 } 409 410 static inline bool hcd_periodic_completion_in_progress(struct usb_hcd *hcd, 411 struct usb_host_endpoint *ep) 412 { 413 return hcd->high_prio_bh.completing_ep == ep; 414 } 415 416 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb); 417 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb, 418 int status); 419 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb); 420 421 extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags); 422 extern int usb_hcd_unlink_urb(struct urb *urb, int status); 423 extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, 424 int status); 425 extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb, 426 gfp_t mem_flags); 427 extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *); 428 extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *); 429 extern void usb_hcd_flush_endpoint(struct usb_device *udev, 430 struct usb_host_endpoint *ep); 431 extern void usb_hcd_disable_endpoint(struct usb_device *udev, 432 struct usb_host_endpoint *ep); 433 extern void usb_hcd_reset_endpoint(struct usb_device *udev, 434 struct usb_host_endpoint *ep); 435 extern void usb_hcd_synchronize_unlinks(struct usb_device *udev); 436 extern int usb_hcd_alloc_bandwidth(struct usb_device *udev, 437 struct usb_host_config *new_config, 438 struct usb_host_interface *old_alt, 439 struct usb_host_interface *new_alt); 440 extern int usb_hcd_get_frame_number(struct usb_device *udev); 441 442 struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver, 443 struct device *sysdev, struct device *dev, const char *bus_name, 444 struct usb_hcd *primary_hcd); 445 extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver, 446 struct device *dev, const char *bus_name); 447 extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver, 448 struct device *dev, const char *bus_name, 449 struct usb_hcd *shared_hcd); 450 extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd); 451 extern void usb_put_hcd(struct usb_hcd *hcd); 452 extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd); 453 extern int usb_add_hcd(struct usb_hcd *hcd, 454 unsigned int irqnum, unsigned long irqflags); 455 extern void usb_remove_hcd(struct usb_hcd *hcd); 456 extern int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1); 457 458 struct platform_device; 459 extern void usb_hcd_platform_shutdown(struct platform_device *dev); 460 461 #ifdef CONFIG_USB_PCI 462 struct pci_dev; 463 struct pci_device_id; 464 extern int usb_hcd_pci_probe(struct pci_dev *dev, 465 const struct pci_device_id *id); 466 extern void usb_hcd_pci_remove(struct pci_dev *dev); 467 extern void usb_hcd_pci_shutdown(struct pci_dev *dev); 468 469 extern int usb_hcd_amd_remote_wakeup_quirk(struct pci_dev *dev); 470 471 #ifdef CONFIG_PM 472 extern const struct dev_pm_ops usb_hcd_pci_pm_ops; 473 #endif 474 #endif /* CONFIG_USB_PCI */ 475 476 /* pci-ish (pdev null is ok) buffer alloc/mapping support */ 477 void usb_init_pool_max(void); 478 int hcd_buffer_create(struct usb_hcd *hcd); 479 void hcd_buffer_destroy(struct usb_hcd *hcd); 480 481 void *hcd_buffer_alloc(struct usb_bus *bus, size_t size, 482 gfp_t mem_flags, dma_addr_t *dma); 483 void hcd_buffer_free(struct usb_bus *bus, size_t size, 484 void *addr, dma_addr_t dma); 485 486 /* generic bus glue, needed for host controllers that don't use PCI */ 487 extern irqreturn_t usb_hcd_irq(int irq, void *__hcd); 488 489 extern void usb_hc_died(struct usb_hcd *hcd); 490 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd); 491 extern void usb_wakeup_notification(struct usb_device *hdev, 492 unsigned int portnum); 493 494 extern void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum); 495 extern void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum); 496 497 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */ 498 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1) 499 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep))) 500 #define usb_settoggle(dev, ep, out, bit) \ 501 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \ 502 ((bit) << (ep))) 503 504 /* -------------------------------------------------------------------------- */ 505 506 /* Enumeration is only for the hub driver, or HCD virtual root hubs */ 507 extern struct usb_device *usb_alloc_dev(struct usb_device *parent, 508 struct usb_bus *, unsigned port); 509 extern int usb_new_device(struct usb_device *dev); 510 extern void usb_disconnect(struct usb_device **); 511 512 extern int usb_get_configuration(struct usb_device *dev); 513 extern void usb_destroy_configuration(struct usb_device *dev); 514 515 /*-------------------------------------------------------------------------*/ 516 517 /* 518 * HCD Root Hub support 519 */ 520 521 #include <linux/usb/ch11.h> 522 523 /* 524 * As of USB 2.0, full/low speed devices are segregated into trees. 525 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc). 526 * The other type grows from high speed hubs when they connect to 527 * full/low speed devices using "Transaction Translators" (TTs). 528 * 529 * TTs should only be known to the hub driver, and high speed bus 530 * drivers (only EHCI for now). They affect periodic scheduling and 531 * sometimes control/bulk error recovery. 532 */ 533 534 struct usb_device; 535 536 struct usb_tt { 537 struct usb_device *hub; /* upstream highspeed hub */ 538 int multi; /* true means one TT per port */ 539 unsigned think_time; /* think time in ns */ 540 void *hcpriv; /* HCD private data */ 541 542 /* for control/bulk error recovery (CLEAR_TT_BUFFER) */ 543 spinlock_t lock; 544 struct list_head clear_list; /* of usb_tt_clear */ 545 struct work_struct clear_work; 546 }; 547 548 struct usb_tt_clear { 549 struct list_head clear_list; 550 unsigned tt; 551 u16 devinfo; 552 struct usb_hcd *hcd; 553 struct usb_host_endpoint *ep; 554 }; 555 556 extern int usb_hub_clear_tt_buffer(struct urb *urb); 557 extern void usb_ep0_reinit(struct usb_device *); 558 559 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */ 560 #define DeviceRequest \ 561 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) 562 #define DeviceOutRequest \ 563 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) 564 565 #define InterfaceRequest \ 566 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) 567 568 #define EndpointRequest \ 569 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) 570 #define EndpointOutRequest \ 571 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) 572 573 /* class requests from the USB 2.0 hub spec, table 11-15 */ 574 #define HUB_CLASS_REQ(dir, type, request) ((((dir) | (type)) << 8) | (request)) 575 /* GetBusState and SetHubDescriptor are optional, omitted */ 576 #define ClearHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_CLEAR_FEATURE) 577 #define ClearPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_CLEAR_FEATURE) 578 #define GetHubDescriptor HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_DESCRIPTOR) 579 #define GetHubStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_STATUS) 580 #define GetPortStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, USB_REQ_GET_STATUS) 581 #define SetHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_SET_FEATURE) 582 #define SetPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_SET_FEATURE) 583 584 585 /*-------------------------------------------------------------------------*/ 586 587 /* class requests from USB 3.1 hub spec, table 10-7 */ 588 #define SetHubDepth HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, HUB_SET_DEPTH) 589 #define GetPortErrorCount HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, HUB_GET_PORT_ERR_COUNT) 590 591 /* 592 * Generic bandwidth allocation constants/support 593 */ 594 #define FRAME_TIME_USECS 1000L 595 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */ 596 /* Trying not to use worst-case bit-stuffing 597 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */ 598 /* bytecount = data payload byte count */ 599 600 #define NS_TO_US(ns) DIV_ROUND_UP(ns, 1000L) 601 /* convert nanoseconds to microseconds, rounding up */ 602 603 /* 604 * Full/low speed bandwidth allocation constants/support. 605 */ 606 #define BW_HOST_DELAY 1000L /* nanoseconds */ 607 #define BW_HUB_LS_SETUP 333L /* nanoseconds */ 608 /* 4 full-speed bit times (est.) */ 609 610 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */ 611 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L) 612 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L) 613 614 /* 615 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed 616 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed 617 * to preallocate bandwidth) 618 */ 619 #define USB2_HOST_DELAY 5 /* nsec, guess */ 620 #define HS_NSECS(bytes) (((55 * 8 * 2083) \ 621 + (2083UL * (3 + BitTime(bytes))))/1000 \ 622 + USB2_HOST_DELAY) 623 #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \ 624 + (2083UL * (3 + BitTime(bytes))))/1000 \ 625 + USB2_HOST_DELAY) 626 #define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes)) 627 #define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes)) 628 629 extern long usb_calc_bus_time(int speed, int is_input, 630 int isoc, int bytecount); 631 632 /*-------------------------------------------------------------------------*/ 633 634 extern void usb_set_device_state(struct usb_device *udev, 635 enum usb_device_state new_state); 636 637 /*-------------------------------------------------------------------------*/ 638 639 /* exported only within usbcore */ 640 641 extern struct idr usb_bus_idr; 642 extern struct mutex usb_bus_idr_lock; 643 extern wait_queue_head_t usb_kill_urb_queue; 644 645 646 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN)) 647 648 #ifdef CONFIG_PM 649 extern void usb_root_hub_lost_power(struct usb_device *rhdev); 650 extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg); 651 extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg); 652 extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd); 653 #else 654 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd) 655 { 656 return; 657 } 658 #endif /* CONFIG_PM */ 659 660 /*-------------------------------------------------------------------------*/ 661 662 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE) 663 664 struct usb_mon_operations { 665 void (*urb_submit)(struct usb_bus *bus, struct urb *urb); 666 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err); 667 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status); 668 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */ 669 }; 670 671 extern const struct usb_mon_operations *mon_ops; 672 673 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) 674 { 675 if (bus->monitored) 676 (*mon_ops->urb_submit)(bus, urb); 677 } 678 679 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, 680 int error) 681 { 682 if (bus->monitored) 683 (*mon_ops->urb_submit_error)(bus, urb, error); 684 } 685 686 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb, 687 int status) 688 { 689 if (bus->monitored) 690 (*mon_ops->urb_complete)(bus, urb, status); 691 } 692 693 int usb_mon_register(const struct usb_mon_operations *ops); 694 void usb_mon_deregister(void); 695 696 #else 697 698 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {} 699 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, 700 int error) {} 701 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb, 702 int status) {} 703 704 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */ 705 706 /*-------------------------------------------------------------------------*/ 707 708 /* random stuff */ 709 710 #define RUN_CONTEXT (in_irq() ? "in_irq" \ 711 : (in_interrupt() ? "in_interrupt" : "can sleep")) 712 713 714 /* This rwsem is for use only by the hub driver and ehci-hcd. 715 * Nobody else should touch it. 716 */ 717 extern struct rw_semaphore ehci_cf_port_reset_rwsem; 718 719 /* Keep track of which host controller drivers are loaded */ 720 #define USB_UHCI_LOADED 0 721 #define USB_OHCI_LOADED 1 722 #define USB_EHCI_LOADED 2 723 extern unsigned long usb_hcds_loaded; 724 725 #endif /* __KERNEL__ */ 726 727 #endif /* __USB_CORE_HCD_H */ 728