2 * Copyright (c) 2001-2002 by David Brownell
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.
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
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.
19 #ifndef __USB_CORE_HCD_H
20 #define __USB_CORE_HCD_H
24 #include <linux/rwsem.h>
25 #include <linux/interrupt.h>
27 #define MAX_TOPO_LEVEL 6
29 /* This file contains declarations of usbcore internals that are mostly
30 * used or exposed by Host Controller Drivers.
34 * USB Packet IDs (PIDs)
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 */
54 /*-------------------------------------------------------------------------*/
57 * USB Host Controller Driver (usb_hcd) framework
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.
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.
69 /*-------------------------------------------------------------------------*/
71 struct giveback_urb_bh {
74 struct list_head head;
75 struct tasklet_struct bh;
76 struct usb_host_endpoint *completing_ep;
84 struct usb_bus self; /* hcd is-a bus */
85 struct kref kref; /* reference counter */
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
92 char irq_descr[24]; /* driver + bus # */
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 */
101 * hardware info/state
103 const struct hc_driver *driver; /* hw-specific hooks */
106 * OTG and some Host controllers need software interaction with phys;
107 * other external phys should be software-transparent
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.
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? */
123 /* The flags can be tested using these macros; they are likely to
124 * be slightly faster than test_bit().
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))
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? */
138 /* The next flag is a stopgap, to be removed when all the HCDs
139 * support the new root-hub polling mechanism. */
140 unsigned uses_new_polling:1;
141 unsigned wireless:1; /* Wireless USB HCD */
142 unsigned authorized_default:1;
143 unsigned has_tt:1; /* Integrated TT in root hub */
145 unsigned int irq; /* irq allocated */
146 void __iomem *regs; /* device memory/io */
147 resource_size_t rsrc_start; /* memory/io resource start */
148 resource_size_t rsrc_len; /* memory/io resource length */
149 unsigned power_budget; /* in mA, 0 = no limit */
151 struct giveback_urb_bh high_prio_bh;
152 struct giveback_urb_bh low_prio_bh;
154 /* bandwidth_mutex should be taken before adding or removing
155 * any new bus bandwidth constraints:
156 * 1. Before adding a configuration for a new device.
157 * 2. Before removing the configuration to put the device into
158 * the addressed state.
159 * 3. Before selecting a different configuration.
160 * 4. Before selecting an alternate interface setting.
162 * bandwidth_mutex should be dropped after a successful control message
163 * to the device, or resetting the bandwidth after a failed attempt.
165 struct mutex *bandwidth_mutex;
166 struct usb_hcd *shared_hcd;
167 struct usb_hcd *primary_hcd;
170 #define HCD_BUFFER_POOLS 4
171 struct dma_pool *pool[HCD_BUFFER_POOLS];
174 # define __ACTIVE 0x01
175 # define __SUSPEND 0x04
176 # define __TRANSIENT 0x80
178 # define HC_STATE_HALT 0
179 # define HC_STATE_RUNNING (__ACTIVE)
180 # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
181 # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
182 # define HC_STATE_SUSPENDED (__SUSPEND)
184 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
185 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
187 /* more shared queuing code would be good; it should support
188 * smarter scheduling, handle transaction translators, etc;
189 * input size of periodic table to an interrupt scheduler.
190 * (ohci 32, uhci 1024, ehci 256/512/1024).
193 /* The HC driver's private data is stored at the end of
196 unsigned long hcd_priv[0]
197 __attribute__ ((aligned(sizeof(s64))));
200 /* 2.4 does this a bit differently ... */
201 static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
206 static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
208 return container_of(bus, struct usb_hcd, self);
211 struct hcd_timeout { /* timeouts we allocate */
212 struct list_head timeout_list;
213 struct timer_list timer;
216 /*-------------------------------------------------------------------------*/
220 const char *description; /* "ehci-hcd" etc */
221 const char *product_desc; /* product/vendor string */
222 size_t hcd_priv_size; /* size of private data */
225 irqreturn_t (*irq) (struct usb_hcd *hcd);
228 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
229 #define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
230 #define HCD_SHARED 0x0004 /* Two (or more) usb_hcds share HW */
231 #define HCD_USB11 0x0010 /* USB 1.1 */
232 #define HCD_USB2 0x0020 /* USB 2.0 */
233 #define HCD_USB25 0x0030 /* Wireless USB 1.0 (USB 2.5)*/
234 #define HCD_USB3 0x0040 /* USB 3.0 */
235 #define HCD_MASK 0x0070
236 #define HCD_BH 0x0100 /* URB complete in BH context */
238 /* called to init HCD and root hub */
239 int (*reset) (struct usb_hcd *hcd);
240 int (*start) (struct usb_hcd *hcd);
242 /* NOTE: these suspend/resume calls relate to the HC as
243 * a whole, not just the root hub; they're for PCI bus glue.
245 /* called after suspending the hub, before entering D3 etc */
246 int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
248 /* called after entering D0 (etc), before resuming the hub */
249 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
251 /* cleanly make HCD stop writing memory and doing I/O */
252 void (*stop) (struct usb_hcd *hcd);
255 void (*shutdown) (struct usb_hcd *hcd);
257 /* return current frame number */
258 int (*get_frame_number) (struct usb_hcd *hcd);
260 /* manage i/o requests, device state */
261 int (*urb_enqueue)(struct usb_hcd *hcd,
262 struct urb *urb, gfp_t mem_flags);
263 int (*urb_dequeue)(struct usb_hcd *hcd,
264 struct urb *urb, int status);
267 * (optional) these hooks allow an HCD to override the default DMA
268 * mapping and unmapping routines. In general, they shouldn't be
269 * necessary unless the host controller has special DMA requirements,
270 * such as alignment contraints. If these are not specified, the
271 * general usb_hcd_(un)?map_urb_for_dma functions will be used instead
272 * (and it may be a good idea to call these functions in your HCD
275 int (*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb,
277 void (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb);
279 /* hw synch, freeing endpoint resources that urb_dequeue can't */
280 void (*endpoint_disable)(struct usb_hcd *hcd,
281 struct usb_host_endpoint *ep);
283 /* (optional) reset any endpoint state such as sequence number
284 and current window */
285 void (*endpoint_reset)(struct usb_hcd *hcd,
286 struct usb_host_endpoint *ep);
288 /* root hub support */
289 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
290 int (*hub_control) (struct usb_hcd *hcd,
291 u16 typeReq, u16 wValue, u16 wIndex,
292 char *buf, u16 wLength);
293 int (*bus_suspend)(struct usb_hcd *);
294 int (*bus_resume)(struct usb_hcd *);
295 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
297 /* force handover of high-speed port to full-speed companion */
298 void (*relinquish_port)(struct usb_hcd *, int);
299 /* has a port been handed over to a companion? */
300 int (*port_handed_over)(struct usb_hcd *, int);
302 /* CLEAR_TT_BUFFER completion callback */
303 void (*clear_tt_buffer_complete)(struct usb_hcd *,
304 struct usb_host_endpoint *);
306 /* xHCI specific functions */
307 /* Called by usb_alloc_dev to alloc HC device structures */
308 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
309 /* Called by usb_disconnect to free HC device structures */
310 void (*free_dev)(struct usb_hcd *, struct usb_device *);
311 /* Change a group of bulk endpoints to support multiple stream IDs */
312 int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
313 struct usb_host_endpoint **eps, unsigned int num_eps,
314 unsigned int num_streams, gfp_t mem_flags);
315 /* Reverts a group of bulk endpoints back to not using stream IDs.
316 * Can fail if we run out of memory.
318 int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
319 struct usb_host_endpoint **eps, unsigned int num_eps,
322 /* Bandwidth computation functions */
323 /* Note that add_endpoint() can only be called once per endpoint before
324 * check_bandwidth() or reset_bandwidth() must be called.
325 * drop_endpoint() can only be called once per endpoint also.
326 * A call to xhci_drop_endpoint() followed by a call to
327 * xhci_add_endpoint() will add the endpoint to the schedule with
328 * possibly new parameters denoted by a different endpoint descriptor
329 * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a
330 * call to xhci_drop_endpoint() is not allowed.
332 /* Allocate endpoint resources and add them to a new schedule */
333 int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
334 struct usb_host_endpoint *);
335 /* Drop an endpoint from a new schedule */
336 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
337 struct usb_host_endpoint *);
338 /* Check that a new hardware configuration, set using
339 * endpoint_enable and endpoint_disable, does not exceed bus
340 * bandwidth. This must be called before any set configuration
341 * or set interface requests are sent to the device.
343 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
344 /* Reset the device schedule to the last known good schedule,
345 * which was set from a previous successful call to
346 * check_bandwidth(). This reverts any add_endpoint() and
347 * drop_endpoint() calls since that last successful call.
348 * Used for when a check_bandwidth() call fails due to resource
349 * or bandwidth constraints.
351 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
352 /* Returns the hardware-chosen device address */
353 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
354 /* Notifies the HCD after a hub descriptor is fetched.
357 int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
358 struct usb_tt *tt, gfp_t mem_flags);
359 int (*reset_device)(struct usb_hcd *, struct usb_device *);
360 /* Notifies the HCD after a device is connected and its
363 int (*update_device)(struct usb_hcd *, struct usb_device *);
364 int (*set_usb2_hw_lpm)(struct usb_hcd *, struct usb_device *, int);
365 /* USB 3.0 Link Power Management */
366 /* Returns the USB3 hub-encoded value for the U1/U2 timeout. */
367 int (*enable_usb3_lpm_timeout)(struct usb_hcd *,
368 struct usb_device *, enum usb3_link_state state);
369 /* The xHCI host controller can still fail the command to
370 * disable the LPM timeouts, so this can return an error code.
372 int (*disable_usb3_lpm_timeout)(struct usb_hcd *,
373 struct usb_device *, enum usb3_link_state state);
374 int (*find_raw_port_number)(struct usb_hcd *, int);
377 static inline int hcd_giveback_urb_in_bh(struct usb_hcd *hcd)
379 return hcd->driver->flags & HCD_BH;
382 static inline bool hcd_periodic_completion_in_progress(struct usb_hcd *hcd,
383 struct usb_host_endpoint *ep)
385 return hcd->high_prio_bh.completing_ep == ep;
388 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
389 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
391 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
393 extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
394 extern int usb_hcd_unlink_urb(struct urb *urb, int status);
395 extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
397 extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
399 extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
400 extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *);
401 extern void usb_hcd_flush_endpoint(struct usb_device *udev,
402 struct usb_host_endpoint *ep);
403 extern void usb_hcd_disable_endpoint(struct usb_device *udev,
404 struct usb_host_endpoint *ep);
405 extern void usb_hcd_reset_endpoint(struct usb_device *udev,
406 struct usb_host_endpoint *ep);
407 extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
408 extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
409 struct usb_host_config *new_config,
410 struct usb_host_interface *old_alt,
411 struct usb_host_interface *new_alt);
412 extern int usb_hcd_get_frame_number(struct usb_device *udev);
414 extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
415 struct device *dev, const char *bus_name);
416 extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
417 struct device *dev, const char *bus_name,
418 struct usb_hcd *shared_hcd);
419 extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
420 extern void usb_put_hcd(struct usb_hcd *hcd);
421 extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd);
422 extern int usb_add_hcd(struct usb_hcd *hcd,
423 unsigned int irqnum, unsigned long irqflags);
424 extern void usb_remove_hcd(struct usb_hcd *hcd);
425 extern int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1);
427 struct platform_device;
428 extern void usb_hcd_platform_shutdown(struct platform_device *dev);
432 struct pci_device_id;
433 extern int usb_hcd_pci_probe(struct pci_dev *dev,
434 const struct pci_device_id *id);
435 extern void usb_hcd_pci_remove(struct pci_dev *dev);
436 extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
439 extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
441 #endif /* CONFIG_PCI */
443 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
444 int hcd_buffer_create(struct usb_hcd *hcd);
445 void hcd_buffer_destroy(struct usb_hcd *hcd);
447 void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
448 gfp_t mem_flags, dma_addr_t *dma);
449 void hcd_buffer_free(struct usb_bus *bus, size_t size,
450 void *addr, dma_addr_t dma);
452 /* generic bus glue, needed for host controllers that don't use PCI */
453 extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
455 extern void usb_hc_died(struct usb_hcd *hcd);
456 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
457 extern void usb_wakeup_notification(struct usb_device *hdev,
458 unsigned int portnum);
460 extern void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum);
461 extern void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum);
463 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
464 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
465 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
466 #define usb_settoggle(dev, ep, out, bit) \
467 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
470 /* -------------------------------------------------------------------------- */
472 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
473 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
474 struct usb_bus *, unsigned port);
475 extern int usb_new_device(struct usb_device *dev);
476 extern void usb_disconnect(struct usb_device **);
478 extern int usb_get_configuration(struct usb_device *dev);
479 extern void usb_destroy_configuration(struct usb_device *dev);
481 /*-------------------------------------------------------------------------*/
484 * HCD Root Hub support
487 #include <linux/usb/ch11.h>
490 * As of USB 2.0, full/low speed devices are segregated into trees.
491 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
492 * The other type grows from high speed hubs when they connect to
493 * full/low speed devices using "Transaction Translators" (TTs).
495 * TTs should only be known to the hub driver, and high speed bus
496 * drivers (only EHCI for now). They affect periodic scheduling and
497 * sometimes control/bulk error recovery.
503 struct usb_device *hub; /* upstream highspeed hub */
504 int multi; /* true means one TT per port */
505 unsigned think_time; /* think time in ns */
507 /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
509 struct list_head clear_list; /* of usb_tt_clear */
510 struct work_struct clear_work;
513 struct usb_tt_clear {
514 struct list_head clear_list;
518 struct usb_host_endpoint *ep;
521 extern int usb_hub_clear_tt_buffer(struct urb *urb);
522 extern void usb_ep0_reinit(struct usb_device *);
524 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
525 #define DeviceRequest \
526 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
527 #define DeviceOutRequest \
528 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
530 #define InterfaceRequest \
531 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
533 #define EndpointRequest \
534 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
535 #define EndpointOutRequest \
536 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
538 /* class requests from the USB 2.0 hub spec, table 11-15 */
539 /* GetBusState and SetHubDescriptor are optional, omitted */
540 #define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
541 #define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
542 #define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
543 #define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
544 #define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
545 #define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
546 #define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
549 /*-------------------------------------------------------------------------*/
551 /* class requests from USB 3.0 hub spec, table 10-5 */
552 #define SetHubDepth (0x3000 | HUB_SET_DEPTH)
553 #define GetPortErrorCount (0x8000 | HUB_GET_PORT_ERR_COUNT)
556 * Generic bandwidth allocation constants/support
558 #define FRAME_TIME_USECS 1000L
559 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
560 /* Trying not to use worst-case bit-stuffing
561 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
562 /* bytecount = data payload byte count */
564 #define NS_TO_US(ns) ((ns + 500L) / 1000L)
565 /* convert & round nanoseconds to microseconds */
569 * Full/low speed bandwidth allocation constants/support.
571 #define BW_HOST_DELAY 1000L /* nanoseconds */
572 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
573 /* 4 full-speed bit times (est.) */
575 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
576 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
577 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
580 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
581 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
582 * to preallocate bandwidth)
584 #define USB2_HOST_DELAY 5 /* nsec, guess */
585 #define HS_NSECS(bytes) (((55 * 8 * 2083) \
586 + (2083UL * (3 + BitTime(bytes))))/1000 \
588 #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
589 + (2083UL * (3 + BitTime(bytes))))/1000 \
591 #define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
592 #define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
594 extern long usb_calc_bus_time(int speed, int is_input,
595 int isoc, int bytecount);
597 /*-------------------------------------------------------------------------*/
599 extern void usb_set_device_state(struct usb_device *udev,
600 enum usb_device_state new_state);
602 /*-------------------------------------------------------------------------*/
604 /* exported only within usbcore */
606 extern struct list_head usb_bus_list;
607 extern struct mutex usb_bus_list_lock;
608 extern wait_queue_head_t usb_kill_urb_queue;
610 extern int usb_find_interface_driver(struct usb_device *dev,
611 struct usb_interface *interface);
613 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
616 extern void usb_root_hub_lost_power(struct usb_device *rhdev);
617 extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
618 extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
619 #endif /* CONFIG_PM */
621 #ifdef CONFIG_PM_RUNTIME
622 extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
624 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
628 #endif /* CONFIG_PM_RUNTIME */
630 /*-------------------------------------------------------------------------*/
632 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
634 struct usb_mon_operations {
635 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
636 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
637 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
638 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
641 extern struct usb_mon_operations *mon_ops;
643 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
646 (*mon_ops->urb_submit)(bus, urb);
649 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
653 (*mon_ops->urb_submit_error)(bus, urb, error);
656 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
660 (*mon_ops->urb_complete)(bus, urb, status);
663 int usb_mon_register(struct usb_mon_operations *ops);
664 void usb_mon_deregister(void);
668 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
669 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
671 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
674 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
676 /*-------------------------------------------------------------------------*/
680 #define RUN_CONTEXT (in_irq() ? "in_irq" \
681 : (in_interrupt() ? "in_interrupt" : "can sleep"))
684 /* This rwsem is for use only by the hub driver and ehci-hcd.
685 * Nobody else should touch it.
687 extern struct rw_semaphore ehci_cf_port_reset_rwsem;
689 /* Keep track of which host controller drivers are loaded */
690 #define USB_UHCI_LOADED 0
691 #define USB_OHCI_LOADED 1
692 #define USB_EHCI_LOADED 2
693 extern unsigned long usb_hcds_loaded;
695 #endif /* __KERNEL__ */
697 #endif /* __USB_CORE_HCD_H */