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