]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/usb/hcd.h
git://bbs.cooldavid.org / net-next-2.6.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
USB: EHCI: EHCI 1.1 addendum: Basic LPM feature support
[net-next-2.6.git] / include / linux / usb / hcd.h
CommitLineData
1da177e4
LT		 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
aa459e6a
AV		 19#ifndef __USB_CORE_HCD_H
20#define __USB_CORE_HCD_H
1da177e4
LT		 21
22#ifdef __KERNEL__
23
32fe0198
AS		 24#include <linux/rwsem.h>
25
38f3ad5e
FB		 26#define MAX_TOPO_LEVEL 6
27
1da177e4
LT		 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 */
dbe0dbb7 35#define USB_PID_EXT 0xf0 /* USB 2.0 LPM ECN */
1da177e4
LT		 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.
5234ce1b
IPG		 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.
1da177e4
LT		 66 */
67
68/*-------------------------------------------------------------------------*/
69
17200583 70struct usb_hcd {
1da177e4
LT		 71
72 /*
73 * housekeeping
74 */
75 struct usb_bus self; /* hcd is-a bus */
17200583 76 struct kref kref; /* reference counter */
1da177e4
LT		 77
78 const char *product_desc; /* product/vendor string */
79 char irq_descr[24]; /* driver + bus # */
80
d5926ae7
AS		 81 struct timer_list rh_timer; /* drives root-hub polling */
82 struct urb *status_urb; /* the current status urb */
9bbdf1e0 83#ifdef CONFIG_USB_SUSPEND
6b157c9b
AS		 84 struct work_struct wakeup_work; /* for remote wakeup */
85#endif
1da177e4
LT		 86
87 /*
88 * hardware info/state
89 */
90 const struct hc_driver *driver; /* hw-specific hooks */
8de98402
BH		 91
92 /* Flags that need to be manipulated atomically */
93 unsigned long flags;
94#define HCD_FLAG_HW_ACCESSIBLE 0x00000001
95#define HCD_FLAG_SAW_IRQ 0x00000002
96
1da177e4 97 unsigned rh_registered:1;/* is root hub registered? */
6d88e679 98 unsigned rh_pollable:1; /* may we poll the root hub? */
1da177e4 99
d5926ae7
AS		 100 /* The next flag is a stopgap, to be removed when all the HCDs
101 * support the new root-hub polling mechanism. */
102 unsigned uses_new_polling:1;
103 unsigned poll_rh:1; /* poll for rh status? */
104 unsigned poll_pending:1; /* status has changed? */
0165de09 105 unsigned wireless:1; /* Wireless USB HCD */
5234ce1b 106 unsigned authorized_default:1;
7329e211 107 unsigned has_tt:1; /* Integrated TT in root hub */
d5926ae7 108
1da177e4
LT		 109 int irq; /* irq allocated */
110 void __iomem *regs; /* device memory/io */
111 u64 rsrc_start; /* memory/io resource start */
112 u64 rsrc_len; /* memory/io resource length */
7d35b929 113 unsigned power_budget; /* in mA, 0 = no limit */
1da177e4 114
3f0479e0
SS		 115 /* bandwidth_mutex should be taken before adding or removing
116 * any new bus bandwidth constraints:
117 * 1. Before adding a configuration for a new device.
118 * 2. Before removing the configuration to put the device into
119 * the addressed state.
120 * 3. Before selecting a different configuration.
121 * 4. Before selecting an alternate interface setting.
122 *
123 * bandwidth_mutex should be dropped after a successful control message
124 * to the device, or resetting the bandwidth after a failed attempt.
125 */
126 struct mutex bandwidth_mutex;
127
128
1da177e4 129#define HCD_BUFFER_POOLS 4
0858a3a5 130 struct dma_pool *pool[HCD_BUFFER_POOLS];
1da177e4
LT		 131
132 int state;
133# define __ACTIVE 0x01
134# define __SUSPEND 0x04
135# define __TRANSIENT 0x80
136
137# define HC_STATE_HALT 0
138# define HC_STATE_RUNNING (__ACTIVE)
139# define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
140# define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
141# define HC_STATE_SUSPENDED (__SUSPEND)
142
143#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
144#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
145
146 /* more shared queuing code would be good; it should support
147 * smarter scheduling, handle transaction translators, etc;
84cca820 148 * input size of periodic table to an interrupt scheduler.
1da177e4
LT		 149 * (ohci 32, uhci 1024, ehci 256/512/1024).
150 */
151
152 /* The HC driver's private data is stored at the end of
153 * this structure.
154 */
155 unsigned long hcd_priv[0]
84cca820 156 __attribute__ ((aligned(sizeof(unsigned long))));
1da177e4
LT		 157};
158
159/* 2.4 does this a bit differently ... */
84cca820 160static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
1da177e4
LT		 161{
162 return &hcd->self;
163}
164
84cca820 165static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
17200583
AS		 166{
167 return container_of(bus, struct usb_hcd, self);
168}
1da177e4
LT		 169
170struct hcd_timeout { /* timeouts we allocate */
171 struct list_head timeout_list;
172 struct timer_list timer;
173};
174
175/*-------------------------------------------------------------------------*/
176
1da177e4 177
1da177e4
LT		 178struct hc_driver {
179 const char *description; /* "ehci-hcd" etc */
180 const char *product_desc; /* product/vendor string */
181 size_t hcd_priv_size; /* size of private data */
182
183 /* irq handler */
7d12e780 184 irqreturn_t (*irq) (struct usb_hcd *hcd);
1da177e4
LT		 185
186 int flags;
187#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
b3476675 188#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
1da177e4
LT		 189#define HCD_USB11 0x0010 /* USB 1.1 */
190#define HCD_USB2 0x0020 /* USB 2.0 */
66d4eadd 191#define HCD_USB3 0x0040 /* USB 3.0 */
6b403b02 192#define HCD_MASK 0x0070
1da177e4
LT		 193
194 /* called to init HCD and root hub */
195 int (*reset) (struct usb_hcd *hcd);
196 int (*start) (struct usb_hcd *hcd);
197
198 /* NOTE: these suspend/resume calls relate to the HC as
5f827ea3 199 * a whole, not just the root hub; they're for PCI bus glue.
1da177e4 200 */
5f827ea3 201 /* called after suspending the hub, before entering D3 etc */
6ec4beb5 202 int (*pci_suspend)(struct usb_hcd *hcd);
1da177e4 203
5f827ea3 204 /* called after entering D0 (etc), before resuming the hub */
6ec4beb5 205 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
1da177e4
LT		 206
207 /* cleanly make HCD stop writing memory and doing I/O */
208 void (*stop) (struct usb_hcd *hcd);
209
64a21d02
AG		 210 /* shutdown HCD */
211 void (*shutdown) (struct usb_hcd *hcd);
212
1da177e4
LT		 213 /* return current frame number */
214 int (*get_frame_number) (struct usb_hcd *hcd);
215
216 /* manage i/o requests, device state */
e9df41c5
AS		 217 int (*urb_enqueue)(struct usb_hcd *hcd,
218 struct urb *urb, gfp_t mem_flags);
219 int (*urb_dequeue)(struct usb_hcd *hcd,
220 struct urb *urb, int status);
1da177e4
LT		 221
222 /* hw synch, freeing endpoint resources that urb_dequeue can't */
0858a3a5 223 void (*endpoint_disable)(struct usb_hcd *hcd,
1da177e4
LT		 224 struct usb_host_endpoint *ep);
225
3444b26a
DV		 226 /* (optional) reset any endpoint state such as sequence number
227 and current window */
0858a3a5 228 void (*endpoint_reset)(struct usb_hcd *hcd,
3444b26a
DV		 229 struct usb_host_endpoint *ep);
230
1da177e4 231 /* root hub support */
84cca820
GKH		 232 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
233 int (*hub_control) (struct usb_hcd *hcd,
1da177e4
LT		 234 u16 typeReq, u16 wValue, u16 wIndex,
235 char *buf, u16 wLength);
84cca820
GKH		 236 int (*bus_suspend)(struct usb_hcd *);
237 int (*bus_resume)(struct usb_hcd *);
238 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
90da096e
BR		 239
240 /* force handover of high-speed port to full-speed companion */
84cca820 241 void (*relinquish_port)(struct usb_hcd *, int);
3a31155c
AS		 242 /* has a port been handed over to a companion? */
243 int (*port_handed_over)(struct usb_hcd *, int);
c6515272 244
cb88a1b8
AS		 245 /* CLEAR_TT_BUFFER completion callback */
246 void (*clear_tt_buffer_complete)(struct usb_hcd *,
247 struct usb_host_endpoint *);
248
c6515272
SS		 249 /* xHCI specific functions */
250 /* Called by usb_alloc_dev to alloc HC device structures */
251 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
f7410ced 252 /* Called by usb_disconnect to free HC device structures */
c6515272 253 void (*free_dev)(struct usb_hcd *, struct usb_device *);
eab1cafc
SS		 254 /* Change a group of bulk endpoints to support multiple stream IDs */
255 int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
256 struct usb_host_endpoint **eps, unsigned int num_eps,
257 unsigned int num_streams, gfp_t mem_flags);
258 /* Reverts a group of bulk endpoints back to not using stream IDs.
259 * Can fail if we run out of memory.
260 */
261 int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
262 struct usb_host_endpoint **eps, unsigned int num_eps,
263 gfp_t mem_flags);
79abb1ab
SS		 264
265 /* Bandwidth computation functions */
266 /* Note that add_endpoint() can only be called once per endpoint before
267 * check_bandwidth() or reset_bandwidth() must be called.
268 * drop_endpoint() can only be called once per endpoint also.
0858a3a5
GKH		 269 * A call to xhci_drop_endpoint() followed by a call to
270 * xhci_add_endpoint() will add the endpoint to the schedule with
271 * possibly new parameters denoted by a different endpoint descriptor
272 * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a
273 * call to xhci_drop_endpoint() is not allowed.
79abb1ab
SS		 274 */
275 /* Allocate endpoint resources and add them to a new schedule */
0858a3a5
GKH		 276 int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
277 struct usb_host_endpoint *);
79abb1ab 278 /* Drop an endpoint from a new schedule */
0858a3a5
GKH		 279 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
280 struct usb_host_endpoint *);
79abb1ab
SS		 281 /* Check that a new hardware configuration, set using
282 * endpoint_enable and endpoint_disable, does not exceed bus
283 * bandwidth. This must be called before any set configuration
284 * or set interface requests are sent to the device.
285 */
286 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
287 /* Reset the device schedule to the last known good schedule,
288 * which was set from a previous successful call to
289 * check_bandwidth(). This reverts any add_endpoint() and
290 * drop_endpoint() calls since that last successful call.
291 * Used for when a check_bandwidth() call fails due to resource
292 * or bandwidth constraints.
293 */
294 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
c6515272
SS		 295 /* Returns the hardware-chosen device address */
296 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
b356b7c7
SS		 297 /* Notifies the HCD after a hub descriptor is fetched.
298 * Will block.
299 */
300 int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
301 struct usb_tt *tt, gfp_t mem_flags);
a5f0efab 302 int (*reset_device)(struct usb_hcd *, struct usb_device *);
48f24970
AD		 303 /* Notifies the HCD after a device is connected and its
304 * address is set
305 */
306 int (*update_device)(struct usb_hcd *, struct usb_device *);
1da177e4
LT		 307};
308
e9df41c5
AS		 309extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
310extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
311 int status);
312extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
313
84cca820
GKH		 314extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
315extern int usb_hcd_unlink_urb(struct urb *urb, int status);
4a00027d
AS		 316extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
317 int status);
95cf82f9
AS		 318extern void usb_hcd_flush_endpoint(struct usb_device *udev,
319 struct usb_host_endpoint *ep);
320extern void usb_hcd_disable_endpoint(struct usb_device *udev,
a6d2bb9f 321 struct usb_host_endpoint *ep);
3444b26a
DV		 322extern void usb_hcd_reset_endpoint(struct usb_device *udev,
323 struct usb_host_endpoint *ep);
cde217a5 324extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
3f0479e0 325extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
79abb1ab 326 struct usb_host_config *new_config,
3f0479e0
SS		 327 struct usb_host_interface *old_alt,
328 struct usb_host_interface *new_alt);
84cca820 329extern int usb_hcd_get_frame_number(struct usb_device *udev);
1da177e4 330
84cca820 331extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
1b26da15 332 struct device *dev, const char *bus_name);
84cca820
GKH		 333extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
334extern void usb_put_hcd(struct usb_hcd *hcd);
1da177e4
LT		 335extern int usb_add_hcd(struct usb_hcd *hcd,
336 unsigned int irqnum, unsigned long irqflags);
337extern void usb_remove_hcd(struct usb_hcd *hcd);
338
64a21d02 339struct platform_device;
84cca820 340extern void usb_hcd_platform_shutdown(struct platform_device *dev);
64a21d02 341
1da177e4
LT		 342#ifdef CONFIG_PCI
343struct pci_dev;
344struct pci_device_id;
84cca820 345extern int usb_hcd_pci_probe(struct pci_dev *dev,
1da177e4 346 const struct pci_device_id *id);
84cca820 347extern void usb_hcd_pci_remove(struct pci_dev *dev);
84cca820 348extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
64a21d02 349
abb30641 350#ifdef CONFIG_PM_SLEEP
47145210 351extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
abb30641 352#endif
1da177e4
LT		 353#endif /* CONFIG_PCI */
354
355/* pci-ish (pdev null is ok) buffer alloc/mapping support */
84cca820
GKH		 356int hcd_buffer_create(struct usb_hcd *hcd);
357void hcd_buffer_destroy(struct usb_hcd *hcd);
1da177e4 358
84cca820 359void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
55016f10 360 gfp_t mem_flags, dma_addr_t *dma);
84cca820 361void hcd_buffer_free(struct usb_bus *bus, size_t size,
1da177e4
LT		 362 void *addr, dma_addr_t dma);
363
364/* generic bus glue, needed for host controllers that don't use PCI */
84cca820 365extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
d5926ae7 366
84cca820 367extern void usb_hc_died(struct usb_hcd *hcd);
d5926ae7 368extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
1da177e4 369
3444b26a
DV		 370/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
371#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
372#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
373#define usb_settoggle(dev, ep, out, bit) \
374 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
375 ((bit) << (ep)))
376
1da177e4
LT		 377/* -------------------------------------------------------------------------- */
378
379/* Enumeration is only for the hub driver, or HCD virtual root hubs */
380extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
381 struct usb_bus *, unsigned port);
382extern int usb_new_device(struct usb_device *dev);
383extern void usb_disconnect(struct usb_device **);
384
385extern int usb_get_configuration(struct usb_device *dev);
386extern void usb_destroy_configuration(struct usb_device *dev);
387
388/*-------------------------------------------------------------------------*/
389
390/*
391 * HCD Root Hub support
392 */
393
d20db4b4
EL		 394#include <linux/usb/ch11.h>
395
396/*
397 * As of USB 2.0, full/low speed devices are segregated into trees.
398 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
399 * The other type grows from high speed hubs when they connect to
400 * full/low speed devices using "Transaction Translators" (TTs).
401 *
402 * TTs should only be known to the hub driver, and high speed bus
403 * drivers (only EHCI for now). They affect periodic scheduling and
404 * sometimes control/bulk error recovery.
405 */
406
407struct usb_device;
408
409struct usb_tt {
410 struct usb_device *hub; /* upstream highspeed hub */
411 int multi; /* true means one TT per port */
412 unsigned think_time; /* think time in ns */
413
414 /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
415 spinlock_t lock;
416 struct list_head clear_list; /* of usb_tt_clear */
417 struct work_struct clear_work;
418};
419
420struct usb_tt_clear {
421 struct list_head clear_list;
422 unsigned tt;
423 u16 devinfo;
424 struct usb_hcd *hcd;
425 struct usb_host_endpoint *ep;
426};
427
428extern int usb_hub_clear_tt_buffer(struct urb *urb);
429extern void usb_ep0_reinit(struct usb_device *);
1da177e4
LT		 430
431/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
432#define DeviceRequest \
433 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
434#define DeviceOutRequest \
435 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
436
437#define InterfaceRequest \
438 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
439
440#define EndpointRequest \
441 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
442#define EndpointOutRequest \
443 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
444
445/* class requests from the USB 2.0 hub spec, table 11-15 */
446/* GetBusState and SetHubDescriptor are optional, omitted */
447#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
448#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
449#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
450#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
451#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
452#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
453#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
454
455
456/*-------------------------------------------------------------------------*/
457
458/*
459 * Generic bandwidth allocation constants/support
460 */
461#define FRAME_TIME_USECS 1000L
84cca820 462#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
1da177e4 463 /* Trying not to use worst-case bit-stuffing
84cca820 464 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
1da177e4
LT		 465 /* bytecount = data payload byte count */
466
467#define NS_TO_US(ns) ((ns + 500L) / 1000L)
468 /* convert & round nanoseconds to microseconds */
469
1da177e4
LT		 470
471/*
472 * Full/low speed bandwidth allocation constants/support.
473 */
474#define BW_HOST_DELAY 1000L /* nanoseconds */
475#define BW_HUB_LS_SETUP 333L /* nanoseconds */
84cca820 476 /* 4 full-speed bit times (est.) */
1da177e4 477
84cca820 478#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
1da177e4
LT		 479#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
480#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
481
1da177e4 482/*
498f78e6 483 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
1da177e4
LT		 484 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
485 * to preallocate bandwidth)
486 */
487#define USB2_HOST_DELAY 5 /* nsec, guess */
84cca820 488#define HS_NSECS(bytes) (((55 * 8 * 2083) \
f956e7cd 489 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 490 + USB2_HOST_DELAY)
84cca820 491#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
f956e7cd 492 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 493 + USB2_HOST_DELAY)
0858a3a5
GKH		 494#define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
495#define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
1da177e4 496
84cca820 497extern long usb_calc_bus_time(int speed, int is_input,
1da177e4
LT		 498 int isoc, int bytecount);
499
500/*-------------------------------------------------------------------------*/
501
1da177e4
LT		 502extern void usb_set_device_state(struct usb_device *udev,
503 enum usb_device_state new_state);
504
505/*-------------------------------------------------------------------------*/
506
507/* exported only within usbcore */
508
509extern struct list_head usb_bus_list;
4186ecf8 510extern struct mutex usb_bus_list_lock;
1da177e4
LT		 511extern wait_queue_head_t usb_kill_urb_queue;
512
84cca820 513extern int usb_find_interface_driver(struct usb_device *dev,
1da177e4
LT		 514 struct usb_interface *interface);
515
516#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
517
0c0382e3 518#ifdef CONFIG_PM
84cca820 519extern void usb_root_hub_lost_power(struct usb_device *rhdev);
65bfd296
AS		 520extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
521extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
9bbdf1e0
AS		 522#endif /* CONFIG_PM */
523
524#ifdef CONFIG_USB_SUSPEND
525extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
0c0382e3 526#else
db2d55b7
AM		 527static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
528{
529 return;
530}
9bbdf1e0
AS		 531#endif /* CONFIG_USB_SUSPEND */
532
0c0382e3 533
1da177e4
LT		 534/*
535 * USB device fs stuff
536 */
537
538#ifdef CONFIG_USB_DEVICEFS
539
540/*
541 * these are expected to be called from the USB core/hub thread
542 * with the kernel lock held
543 */
84cca820 544extern void usbfs_update_special(void);
1da177e4
LT		 545extern int usbfs_init(void);
546extern void usbfs_cleanup(void);
547
548#else /* CONFIG_USB_DEVICEFS */
549
84cca820 550static inline void usbfs_update_special(void) {}
1da177e4
LT		 551static inline int usbfs_init(void) { return 0; }
552static inline void usbfs_cleanup(void) { }
553
554#endif /* CONFIG_USB_DEVICEFS */
555
556/*-------------------------------------------------------------------------*/
557
f150fa1a 558#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
1da177e4
LT		 559
560struct usb_mon_operations {
561 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
562 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
9347d51c 563 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
1da177e4 564 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
1da177e4
LT		 565};
566
567extern struct usb_mon_operations *mon_ops;
568
569static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
570{
571 if (bus->monitored)
572 (*mon_ops->urb_submit)(bus, urb);
573}
574
575static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
576 int error)
577{
578 if (bus->monitored)
579 (*mon_ops->urb_submit_error)(bus, urb, error);
580}
581
9347d51c
AS		 582static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
583 int status)
1da177e4
LT		 584{
585 if (bus->monitored)
9347d51c 586 (*mon_ops->urb_complete)(bus, urb, status);
1da177e4 587}
1da177e4
LT		 588
589int usb_mon_register(struct usb_mon_operations *ops);
590void usb_mon_deregister(void);
591
592#else
593
594static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
595static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
596 int error) {}
9347d51c
AS		 597static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
598 int status) {}
1da177e4 599
f150fa1a 600#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
1da177e4
LT		 601
602/*-------------------------------------------------------------------------*/
603
604/* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
84cca820 605/* bleech -- resurfaced in 2.4.11 or 2.4.12 */
0858a3a5 606#define bitmap DeviceRemovable
1da177e4
LT		 607
608
609/*-------------------------------------------------------------------------*/
610
611/* random stuff */
612
84cca820
GKH		 613#define RUN_CONTEXT (in_irq() ? "in_irq" \
614 : (in_interrupt() ? "in_interrupt" : "can sleep"))
1da177e4
LT		 615
616
32fe0198
AS		 617/* This rwsem is for use only by the hub driver and ehci-hcd.
618 * Nobody else should touch it.
619 */
620extern struct rw_semaphore ehci_cf_port_reset_rwsem;
1da177e4 621
9beeee65
AS		 622/* Keep track of which host controller drivers are loaded */
623#define USB_UHCI_LOADED 0
624#define USB_OHCI_LOADED 1
625#define USB_EHCI_LOADED 2
626extern unsigned long usb_hcds_loaded;
627
32fe0198 628#endif /* __KERNEL__ */
aa459e6a
AV		 629
630#endif /* __USB_CORE_HCD_H */
Clone of davem's net-next-2.6 tree