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 bool high_prio; 56 spinlock_t lock; 57 struct list_head head; 58 struct tasklet_struct bh; 59 struct usb_host_endpoint *completing_ep; 60 }; 61 62 enum usb_dev_authorize_policy { 63 USB_DEVICE_AUTHORIZE_NONE = 0, 64 USB_DEVICE_AUTHORIZE_ALL = 1, 65 USB_DEVICE_AUTHORIZE_INTERNAL = 2, 66 }; 67 68 struct usb_hcd { 69 70 /* 71 * housekeeping 72 */ 73 struct usb_bus self; /* hcd is-a bus */ 74 struct kref kref; /* reference counter */ 75 76 const char *product_desc; /* product/vendor string */ 77 int speed; /* Speed for this roothub. 78 * May be different from 79 * hcd->driver->flags & HCD_MASK 80 */ 81 char irq_descr[24]; /* driver + bus # */ 82 83 struct timer_list rh_timer; /* drives root-hub polling */ 84 struct urb *status_urb; /* the current status urb */ 85 #ifdef CONFIG_PM 86 struct work_struct wakeup_work; /* for remote wakeup */ 87 #endif 88 struct work_struct died_work; /* for when the device dies */ 89 90 /* 91 * hardware info/state 92 */ 93 const struct hc_driver *driver; /* hw-specific hooks */ 94 95 /* 96 * OTG and some Host controllers need software interaction with phys; 97 * other external phys should be software-transparent 98 */ 99 struct usb_phy *usb_phy; 100 struct usb_phy_roothub *phy_roothub; 101 102 /* Flags that need to be manipulated atomically because they can 103 * change while the host controller is running. Always use 104 * set_bit() or clear_bit() to change their values. 105 */ 106 unsigned long flags; 107 #define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */ 108 #define HCD_FLAG_POLL_RH 2 /* poll for rh status? */ 109 #define HCD_FLAG_POLL_PENDING 3 /* status has changed? */ 110 #define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */ 111 #define HCD_FLAG_RH_RUNNING 5 /* root hub is running? */ 112 #define HCD_FLAG_DEAD 6 /* controller has died? */ 113 #define HCD_FLAG_INTF_AUTHORIZED 7 /* authorize interfaces? */ 114 #define HCD_FLAG_DEFER_RH_REGISTER 8 /* Defer roothub registration */ 115 116 /* The flags can be tested using these macros; they are likely to 117 * be slightly faster than test_bit(). 118 */ 119 #define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE)) 120 #define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH)) 121 #define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING)) 122 #define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING)) 123 #define HCD_RH_RUNNING(hcd) ((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING)) 124 #define HCD_DEAD(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEAD)) 125 #define HCD_DEFER_RH_REGISTER(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEFER_RH_REGISTER)) 126 127 /* 128 * Specifies if interfaces are authorized by default 129 * or they require explicit user space authorization; this bit is 130 * settable through /sys/class/usb_host/X/interface_authorized_default 131 */ 132 #define HCD_INTF_AUTHORIZED(hcd) \ 133 ((hcd)->flags & (1U << HCD_FLAG_INTF_AUTHORIZED)) 134 135 /* 136 * Specifies if devices are authorized by default 137 * or they require explicit user space authorization; this bit is 138 * settable through /sys/class/usb_host/X/authorized_default 139 */ 140 enum usb_dev_authorize_policy dev_policy; 141 142 /* Flags that get set only during HCD registration or removal. */ 143 unsigned rh_registered:1;/* is root hub registered? */ 144 unsigned rh_pollable:1; /* may we poll the root hub? */ 145 unsigned msix_enabled:1; /* driver has MSI-X enabled? */ 146 unsigned msi_enabled:1; /* driver has MSI enabled? */ 147 /* 148 * do not manage the PHY state in the HCD core, instead let the driver 149 * handle this (for example if the PHY can only be turned on after a 150 * specific event) 151 */ 152 unsigned skip_phy_initialization:1; 153 154 /* The next flag is a stopgap, to be removed when all the HCDs 155 * support the new root-hub polling mechanism. */ 156 unsigned uses_new_polling:1; 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_USB3 0x0040 /* USB 3.0 */ 252 #define HCD_USB31 0x0050 /* USB 3.1 */ 253 #define HCD_USB32 0x0060 /* USB 3.2 */ 254 #define HCD_MASK 0x0070 255 #define HCD_BH 0x0100 /* URB complete in BH context */ 256 257 /* called to init HCD and root hub */ 258 int (*reset) (struct usb_hcd *hcd); 259 int (*start) (struct usb_hcd *hcd); 260 261 /* NOTE: these suspend/resume calls relate to the HC as 262 * a whole, not just the root hub; they're for PCI bus glue. 263 */ 264 /* called after suspending the hub, before entering D3 etc */ 265 int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup); 266 267 /* called after entering D0 (etc), before resuming the hub */ 268 int (*pci_resume)(struct usb_hcd *hcd, pm_message_t state); 269 270 /* called just before hibernate final D3 state, allows host to poweroff parts */ 271 int (*pci_poweroff_late)(struct usb_hcd *hcd, bool do_wakeup); 272 273 /* cleanly make HCD stop writing memory and doing I/O */ 274 void (*stop) (struct usb_hcd *hcd); 275 276 /* shutdown HCD */ 277 void (*shutdown) (struct usb_hcd *hcd); 278 279 /* return current frame number */ 280 int (*get_frame_number) (struct usb_hcd *hcd); 281 282 /* manage i/o requests, device state */ 283 int (*urb_enqueue)(struct usb_hcd *hcd, 284 struct urb *urb, gfp_t mem_flags); 285 int (*urb_dequeue)(struct usb_hcd *hcd, 286 struct urb *urb, int status); 287 288 /* 289 * (optional) these hooks allow an HCD to override the default DMA 290 * mapping and unmapping routines. In general, they shouldn't be 291 * necessary unless the host controller has special DMA requirements, 292 * such as alignment constraints. If these are not specified, the 293 * general usb_hcd_(un)?map_urb_for_dma functions will be used instead 294 * (and it may be a good idea to call these functions in your HCD 295 * implementation) 296 */ 297 int (*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb, 298 gfp_t mem_flags); 299 void (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb); 300 301 /* hw synch, freeing endpoint resources that urb_dequeue can't */ 302 void (*endpoint_disable)(struct usb_hcd *hcd, 303 struct usb_host_endpoint *ep); 304 305 /* (optional) reset any endpoint state such as sequence number 306 and current window */ 307 void (*endpoint_reset)(struct usb_hcd *hcd, 308 struct usb_host_endpoint *ep); 309 310 /* root hub support */ 311 int (*hub_status_data) (struct usb_hcd *hcd, char *buf); 312 int (*hub_control) (struct usb_hcd *hcd, 313 u16 typeReq, u16 wValue, u16 wIndex, 314 char *buf, u16 wLength); 315 int (*bus_suspend)(struct usb_hcd *); 316 int (*bus_resume)(struct usb_hcd *); 317 int (*start_port_reset)(struct usb_hcd *, unsigned port_num); 318 unsigned long (*get_resuming_ports)(struct usb_hcd *); 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 /* Call for SINGLE_STEP_SET_FEATURE Test for USB2 EH certification */ 403 #define EHSET_TEST_SINGLE_STEP_SET_FEATURE 0x06 404 int (*submit_single_step_set_feature)(struct usb_hcd *, 405 struct urb *, int); 406 }; 407 408 static inline int hcd_giveback_urb_in_bh(struct usb_hcd *hcd) 409 { 410 return hcd->driver->flags & HCD_BH; 411 } 412 413 static inline bool hcd_periodic_completion_in_progress(struct usb_hcd *hcd, 414 struct usb_host_endpoint *ep) 415 { 416 return hcd->high_prio_bh.completing_ep == ep; 417 } 418 419 static inline bool hcd_uses_dma(struct usb_hcd *hcd) 420 { 421 return IS_ENABLED(CONFIG_HAS_DMA) && (hcd->driver->flags & HCD_DMA); 422 } 423 424 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb); 425 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb, 426 int status); 427 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb); 428 429 extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags); 430 extern int usb_hcd_unlink_urb(struct urb *urb, int status); 431 extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, 432 int status); 433 extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb, 434 gfp_t mem_flags); 435 extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *); 436 extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *); 437 extern void usb_hcd_flush_endpoint(struct usb_device *udev, 438 struct usb_host_endpoint *ep); 439 extern void usb_hcd_disable_endpoint(struct usb_device *udev, 440 struct usb_host_endpoint *ep); 441 extern void usb_hcd_reset_endpoint(struct usb_device *udev, 442 struct usb_host_endpoint *ep); 443 extern void usb_hcd_synchronize_unlinks(struct usb_device *udev); 444 extern int usb_hcd_alloc_bandwidth(struct usb_device *udev, 445 struct usb_host_config *new_config, 446 struct usb_host_interface *old_alt, 447 struct usb_host_interface *new_alt); 448 extern int usb_hcd_get_frame_number(struct usb_device *udev); 449 450 struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver, 451 struct device *sysdev, struct device *dev, const char *bus_name, 452 struct usb_hcd *primary_hcd); 453 extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver, 454 struct device *dev, const char *bus_name); 455 extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver, 456 struct device *dev, const char *bus_name, 457 struct usb_hcd *shared_hcd); 458 extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd); 459 extern void usb_put_hcd(struct usb_hcd *hcd); 460 extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd); 461 extern int usb_add_hcd(struct usb_hcd *hcd, 462 unsigned int irqnum, unsigned long irqflags); 463 extern void usb_remove_hcd(struct usb_hcd *hcd); 464 extern int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1); 465 int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr, 466 dma_addr_t dma, size_t size); 467 468 struct platform_device; 469 extern void usb_hcd_platform_shutdown(struct platform_device *dev); 470 #ifdef CONFIG_USB_HCD_TEST_MODE 471 extern int ehset_single_step_set_feature(struct usb_hcd *hcd, int port); 472 #else 473 static inline int ehset_single_step_set_feature(struct usb_hcd *hcd, int port) 474 { 475 return 0; 476 } 477 #endif /* CONFIG_USB_HCD_TEST_MODE */ 478 479 #ifdef CONFIG_USB_PCI 480 struct pci_dev; 481 struct pci_device_id; 482 extern int usb_hcd_pci_probe(struct pci_dev *dev, 483 const struct hc_driver *driver); 484 extern void usb_hcd_pci_remove(struct pci_dev *dev); 485 extern void usb_hcd_pci_shutdown(struct pci_dev *dev); 486 487 extern int usb_hcd_amd_remote_wakeup_quirk(struct pci_dev *dev); 488 489 extern const struct dev_pm_ops usb_hcd_pci_pm_ops; 490 #endif /* CONFIG_USB_PCI */ 491 492 /* pci-ish (pdev null is ok) buffer alloc/mapping support */ 493 void usb_init_pool_max(void); 494 int hcd_buffer_create(struct usb_hcd *hcd); 495 void hcd_buffer_destroy(struct usb_hcd *hcd); 496 497 void *hcd_buffer_alloc(struct usb_bus *bus, size_t size, 498 gfp_t mem_flags, dma_addr_t *dma); 499 void hcd_buffer_free(struct usb_bus *bus, size_t size, 500 void *addr, dma_addr_t dma); 501 502 void *hcd_buffer_alloc_pages(struct usb_hcd *hcd, 503 size_t size, gfp_t mem_flags, dma_addr_t *dma); 504 void hcd_buffer_free_pages(struct usb_hcd *hcd, 505 size_t size, void *addr, dma_addr_t dma); 506 507 /* generic bus glue, needed for host controllers that don't use PCI */ 508 extern irqreturn_t usb_hcd_irq(int irq, void *__hcd); 509 510 extern void usb_hc_died(struct usb_hcd *hcd); 511 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd); 512 extern void usb_wakeup_notification(struct usb_device *hdev, 513 unsigned int portnum); 514 515 extern void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum); 516 extern void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum); 517 518 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */ 519 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1) 520 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep))) 521 #define usb_settoggle(dev, ep, out, bit) \ 522 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \ 523 ((bit) << (ep))) 524 525 /* -------------------------------------------------------------------------- */ 526 527 /* Enumeration is only for the hub driver, or HCD virtual root hubs */ 528 extern struct usb_device *usb_alloc_dev(struct usb_device *parent, 529 struct usb_bus *, unsigned port); 530 extern int usb_new_device(struct usb_device *dev); 531 extern void usb_disconnect(struct usb_device **); 532 533 extern int usb_get_configuration(struct usb_device *dev); 534 extern void usb_destroy_configuration(struct usb_device *dev); 535 536 /*-------------------------------------------------------------------------*/ 537 538 /* 539 * HCD Root Hub support 540 */ 541 542 #include <linux/usb/ch11.h> 543 544 /* 545 * As of USB 2.0, full/low speed devices are segregated into trees. 546 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc). 547 * The other type grows from high speed hubs when they connect to 548 * full/low speed devices using "Transaction Translators" (TTs). 549 * 550 * TTs should only be known to the hub driver, and high speed bus 551 * drivers (only EHCI for now). They affect periodic scheduling and 552 * sometimes control/bulk error recovery. 553 */ 554 555 struct usb_device; 556 557 struct usb_tt { 558 struct usb_device *hub; /* upstream highspeed hub */ 559 int multi; /* true means one TT per port */ 560 unsigned think_time; /* think time in ns */ 561 void *hcpriv; /* HCD private data */ 562 563 /* for control/bulk error recovery (CLEAR_TT_BUFFER) */ 564 spinlock_t lock; 565 struct list_head clear_list; /* of usb_tt_clear */ 566 struct work_struct clear_work; 567 }; 568 569 struct usb_tt_clear { 570 struct list_head clear_list; 571 unsigned tt; 572 u16 devinfo; 573 struct usb_hcd *hcd; 574 struct usb_host_endpoint *ep; 575 }; 576 577 extern int usb_hub_clear_tt_buffer(struct urb *urb); 578 extern void usb_ep0_reinit(struct usb_device *); 579 580 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */ 581 #define DeviceRequest \ 582 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) 583 #define DeviceOutRequest \ 584 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) 585 586 #define InterfaceRequest \ 587 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) 588 589 #define EndpointRequest \ 590 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) 591 #define EndpointOutRequest \ 592 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) 593 594 /* class requests from the USB 2.0 hub spec, table 11-15 */ 595 #define HUB_CLASS_REQ(dir, type, request) ((((dir) | (type)) << 8) | (request)) 596 /* GetBusState and SetHubDescriptor are optional, omitted */ 597 #define ClearHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_CLEAR_FEATURE) 598 #define ClearPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_CLEAR_FEATURE) 599 #define GetHubDescriptor HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_DESCRIPTOR) 600 #define GetHubStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_STATUS) 601 #define GetPortStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, USB_REQ_GET_STATUS) 602 #define SetHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_SET_FEATURE) 603 #define SetPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_SET_FEATURE) 604 #define ClearTTBuffer HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_CLEAR_TT_BUFFER) 605 #define ResetTT HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_RESET_TT) 606 #define GetTTState HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, HUB_GET_TT_STATE) 607 #define StopTT HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_STOP_TT) 608 609 610 /*-------------------------------------------------------------------------*/ 611 612 /* class requests from USB 3.1 hub spec, table 10-7 */ 613 #define SetHubDepth HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, HUB_SET_DEPTH) 614 #define GetPortErrorCount HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, HUB_GET_PORT_ERR_COUNT) 615 616 /* 617 * Generic bandwidth allocation constants/support 618 */ 619 #define FRAME_TIME_USECS 1000L 620 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */ 621 /* Trying not to use worst-case bit-stuffing 622 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */ 623 /* bytecount = data payload byte count */ 624 625 #define NS_TO_US(ns) DIV_ROUND_UP(ns, 1000L) 626 /* convert nanoseconds to microseconds, rounding up */ 627 628 /* 629 * Full/low speed bandwidth allocation constants/support. 630 */ 631 #define BW_HOST_DELAY 1000L /* nanoseconds */ 632 #define BW_HUB_LS_SETUP 333L /* nanoseconds */ 633 /* 4 full-speed bit times (est.) */ 634 635 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */ 636 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L) 637 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L) 638 639 /* 640 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed 641 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed 642 * to preallocate bandwidth) 643 */ 644 #define USB2_HOST_DELAY 5 /* nsec, guess */ 645 #define HS_NSECS(bytes) (((55 * 8 * 2083) \ 646 + (2083UL * (3 + BitTime(bytes))))/1000 \ 647 + USB2_HOST_DELAY) 648 #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \ 649 + (2083UL * (3 + BitTime(bytes))))/1000 \ 650 + USB2_HOST_DELAY) 651 #define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes)) 652 #define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes)) 653 654 extern long usb_calc_bus_time(int speed, int is_input, 655 int isoc, int bytecount); 656 657 /*-------------------------------------------------------------------------*/ 658 659 extern void usb_set_device_state(struct usb_device *udev, 660 enum usb_device_state new_state); 661 662 /*-------------------------------------------------------------------------*/ 663 664 /* exported only within usbcore */ 665 666 extern struct idr usb_bus_idr; 667 extern struct mutex usb_bus_idr_lock; 668 extern wait_queue_head_t usb_kill_urb_queue; 669 670 671 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN)) 672 673 #ifdef CONFIG_PM 674 extern unsigned usb_wakeup_enabled_descendants(struct usb_device *udev); 675 extern void usb_root_hub_lost_power(struct usb_device *rhdev); 676 extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg); 677 extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg); 678 extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd); 679 #else 680 static inline unsigned usb_wakeup_enabled_descendants(struct usb_device *udev) 681 { 682 return 0; 683 } 684 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd) 685 { 686 return; 687 } 688 #endif /* CONFIG_PM */ 689 690 /*-------------------------------------------------------------------------*/ 691 692 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE) 693 694 struct usb_mon_operations { 695 void (*urb_submit)(struct usb_bus *bus, struct urb *urb); 696 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err); 697 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status); 698 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */ 699 }; 700 701 extern const struct usb_mon_operations *mon_ops; 702 703 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) 704 { 705 if (bus->monitored) 706 (*mon_ops->urb_submit)(bus, urb); 707 } 708 709 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, 710 int error) 711 { 712 if (bus->monitored) 713 (*mon_ops->urb_submit_error)(bus, urb, error); 714 } 715 716 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb, 717 int status) 718 { 719 if (bus->monitored) 720 (*mon_ops->urb_complete)(bus, urb, status); 721 } 722 723 int usb_mon_register(const struct usb_mon_operations *ops); 724 void usb_mon_deregister(void); 725 726 #else 727 728 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {} 729 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb, 730 int error) {} 731 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb, 732 int status) {} 733 734 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */ 735 736 /*-------------------------------------------------------------------------*/ 737 738 /* random stuff */ 739 740 /* This rwsem is for use only by the hub driver and ehci-hcd. 741 * Nobody else should touch it. 742 */ 743 extern struct rw_semaphore ehci_cf_port_reset_rwsem; 744 745 /* Keep track of which host controller drivers are loaded */ 746 #define USB_UHCI_LOADED 0 747 #define USB_OHCI_LOADED 1 748 #define USB_EHCI_LOADED 2 749 extern unsigned long usb_hcds_loaded; 750 751 #endif /* __KERNEL__ */ 752 753 #endif /* __USB_CORE_HCD_H */ 754