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