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