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