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