projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
xHCI: set USB2 hardware LPM
[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 */
83de4b2b
SS		 79 int speed; /* Speed for this roothub.
80 * May be different from
81 * hcd->driver->flags & HCD_MASK
82 */
1da177e4
LT		 83 char irq_descr[24]; /* driver + bus # */
84
d5926ae7
AS		 85 struct timer_list rh_timer; /* drives root-hub polling */
86 struct urb *status_urb; /* the current status urb */
9bbdf1e0 87#ifdef CONFIG_USB_SUSPEND
6b157c9b
AS		 88 struct work_struct wakeup_work; /* for remote wakeup */
89#endif
1da177e4
LT		 90
91 /*
92 * hardware info/state
93 */
94 const struct hc_driver *driver; /* hw-specific hooks */
8de98402 95
541c7d43
AS		 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 */
8de98402 100 unsigned long flags;
541c7d43
AS		 101#define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */
102#define HCD_FLAG_SAW_IRQ 1
103#define HCD_FLAG_POLL_RH 2 /* poll for rh status? */
104#define HCD_FLAG_POLL_PENDING 3 /* status has changed? */
ff2f0787 105#define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */
9b37596a
AS		 106#define HCD_FLAG_RH_RUNNING 5 /* root hub is running? */
107#define HCD_FLAG_DEAD 6 /* controller has died? */
541c7d43
AS		 108
109 /* The flags can be tested using these macros; they are likely to
110 * be slightly faster than test_bit().
111 */
112#define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE))
113#define HCD_SAW_IRQ(hcd) ((hcd)->flags & (1U << HCD_FLAG_SAW_IRQ))
114#define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH))
115#define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING))
ff2f0787 116#define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING))
9b37596a
AS		 117#define HCD_RH_RUNNING(hcd) ((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING))
118#define HCD_DEAD(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEAD))
8de98402 119
541c7d43 120 /* Flags that get set only during HCD registration or removal. */
1da177e4 121 unsigned rh_registered:1;/* is root hub registered? */
6d88e679 122 unsigned rh_pollable:1; /* may we poll the root hub? */
0029227f 123 unsigned msix_enabled:1; /* driver has MSI-X enabled? */
1da177e4 124
d5926ae7
AS		 125 /* The next flag is a stopgap, to be removed when all the HCDs
126 * support the new root-hub polling mechanism. */
127 unsigned uses_new_polling:1;
0165de09 128 unsigned wireless:1; /* Wireless USB HCD */
5234ce1b 129 unsigned authorized_default:1;
7329e211 130 unsigned has_tt:1; /* Integrated TT in root hub */
d5926ae7 131
1da177e4
LT		 132 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 */
7d35b929 136 unsigned power_budget; /* in mA, 0 = no limit */
1da177e4 137
3f0479e0
SS		 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 */
d673bfcb 149 struct mutex *bandwidth_mutex;
c5635437
SS		 150 struct usb_hcd *shared_hcd;
151 struct usb_hcd *primary_hcd;
3f0479e0
SS		 152
153
1da177e4 154#define HCD_BUFFER_POOLS 4
0858a3a5 155 struct dma_pool *pool[HCD_BUFFER_POOLS];
1da177e4
LT		 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;
84cca820 173 * input size of periodic table to an interrupt scheduler.
1da177e4
LT		 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]
84cca820 181 __attribute__ ((aligned(sizeof(unsigned long))));
1da177e4
LT		 182};
183
184/* 2.4 does this a bit differently ... */
84cca820 185static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
1da177e4
LT		 186{
187 return &hcd->self;
188}
189
84cca820 190static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
17200583
AS		 191{
192 return container_of(bus, struct usb_hcd, self);
193}
1da177e4
LT		 194
195struct hcd_timeout { /* timeouts we allocate */
196 struct list_head timeout_list;
197 struct timer_list timer;
198};
199
200/*-------------------------------------------------------------------------*/
201
1da177e4 202
1da177e4
LT		 203struct 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 */
7d12e780 209 irqreturn_t (*irq) (struct usb_hcd *hcd);
1da177e4
LT		 210
211 int flags;
212#define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
b3476675 213#define HCD_LOCAL_MEM 0x0002 /* HC needs local memory */
c5635437 214#define HCD_SHARED 0x0004 /* Two (or more) usb_hcds share HW */
1da177e4
LT		 215#define HCD_USB11 0x0010 /* USB 1.1 */
216#define HCD_USB2 0x0020 /* USB 2.0 */
66d4eadd 217#define HCD_USB3 0x0040 /* USB 3.0 */
6b403b02 218#define HCD_MASK 0x0070
1da177e4
LT		 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
5f827ea3 225 * a whole, not just the root hub; they're for PCI bus glue.
1da177e4 226 */
5f827ea3 227 /* called after suspending the hub, before entering D3 etc */
4147200d 228 int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
1da177e4 229
5f827ea3 230 /* called after entering D0 (etc), before resuming the hub */
6ec4beb5 231 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
1da177e4
LT		 232
233 /* cleanly make HCD stop writing memory and doing I/O */
234 void (*stop) (struct usb_hcd *hcd);
235
64a21d02
AG		 236 /* shutdown HCD */
237 void (*shutdown) (struct usb_hcd *hcd);
238
1da177e4
LT		 239 /* return current frame number */
240 int (*get_frame_number) (struct usb_hcd *hcd);
241
242 /* manage i/o requests, device state */
e9df41c5
AS		 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);
1da177e4 247
2694a48d
RM		 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
1da177e4 261 /* hw synch, freeing endpoint resources that urb_dequeue can't */
0858a3a5 262 void (*endpoint_disable)(struct usb_hcd *hcd,
1da177e4
LT		 263 struct usb_host_endpoint *ep);
264
3444b26a
DV		 265 /* (optional) reset any endpoint state such as sequence number
266 and current window */
0858a3a5 267 void (*endpoint_reset)(struct usb_hcd *hcd,
3444b26a
DV		 268 struct usb_host_endpoint *ep);
269
1da177e4 270 /* root hub support */
84cca820
GKH		 271 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
272 int (*hub_control) (struct usb_hcd *hcd,
1da177e4
LT		 273 u16 typeReq, u16 wValue, u16 wIndex,
274 char *buf, u16 wLength);
84cca820
GKH		 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);
90da096e
BR		 278
279 /* force handover of high-speed port to full-speed companion */
84cca820 280 void (*relinquish_port)(struct usb_hcd *, int);
3a31155c
AS		 281 /* has a port been handed over to a companion? */
282 int (*port_handed_over)(struct usb_hcd *, int);
c6515272 283
cb88a1b8
AS		 284 /* CLEAR_TT_BUFFER completion callback */
285 void (*clear_tt_buffer_complete)(struct usb_hcd *,
286 struct usb_host_endpoint *);
287
c6515272
SS		 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 *);
f7410ced 291 /* Called by usb_disconnect to free HC device structures */
c6515272 292 void (*free_dev)(struct usb_hcd *, struct usb_device *);
eab1cafc
SS		 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);
79abb1ab
SS		 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.
0858a3a5
GKH		 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.
79abb1ab
SS		 313 */
314 /* Allocate endpoint resources and add them to a new schedule */
0858a3a5
GKH		 315 int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
316 struct usb_host_endpoint *);
79abb1ab 317 /* Drop an endpoint from a new schedule */
0858a3a5
GKH		 318 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
319 struct usb_host_endpoint *);
79abb1ab
SS		 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 *);
c6515272
SS		 334 /* Returns the hardware-chosen device address */
335 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
b356b7c7
SS		 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);
a5f0efab 341 int (*reset_device)(struct usb_hcd *, struct usb_device *);
48f24970
AD		 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 *);
65580b43 346 int (*set_usb2_hw_lpm)(struct usb_hcd *, struct usb_device *, int);
1da177e4
LT		 347};
348
e9df41c5
AS		 349extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
350extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
351 int status);
352extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
353
84cca820
GKH		 354extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
355extern int usb_hcd_unlink_urb(struct urb *urb, int status);
4a00027d
AS		 356extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
357 int status);
2694a48d
RM		 358extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
359 gfp_t mem_flags);
c8cf203a
RM		 360extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
361extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *);
95cf82f9
AS		 362extern void usb_hcd_flush_endpoint(struct usb_device *udev,
363 struct usb_host_endpoint *ep);
364extern void usb_hcd_disable_endpoint(struct usb_device *udev,
a6d2bb9f 365 struct usb_host_endpoint *ep);
3444b26a
DV		 366extern void usb_hcd_reset_endpoint(struct usb_device *udev,
367 struct usb_host_endpoint *ep);
cde217a5 368extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
3f0479e0 369extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
79abb1ab 370 struct usb_host_config *new_config,
3f0479e0
SS		 371 struct usb_host_interface *old_alt,
372 struct usb_host_interface *new_alt);
84cca820 373extern int usb_hcd_get_frame_number(struct usb_device *udev);
1da177e4 374
84cca820 375extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
1b26da15 376 struct device *dev, const char *bus_name);
c5635437
SS		 377extern 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);
84cca820
GKH		 380extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
381extern void usb_put_hcd(struct usb_hcd *hcd);
c5635437 382extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd);
1da177e4
LT		 383extern int usb_add_hcd(struct usb_hcd *hcd,
384 unsigned int irqnum, unsigned long irqflags);
385extern void usb_remove_hcd(struct usb_hcd *hcd);
386
64a21d02 387struct platform_device;
84cca820 388extern void usb_hcd_platform_shutdown(struct platform_device *dev);
64a21d02 389
1da177e4
LT		 390#ifdef CONFIG_PCI
391struct pci_dev;
392struct pci_device_id;
84cca820 393extern int usb_hcd_pci_probe(struct pci_dev *dev,
1da177e4 394 const struct pci_device_id *id);
84cca820 395extern void usb_hcd_pci_remove(struct pci_dev *dev);
84cca820 396extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
64a21d02 397
abb30641 398#ifdef CONFIG_PM_SLEEP
47145210 399extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
abb30641 400#endif
1da177e4
LT		 401#endif /* CONFIG_PCI */
402
403/* pci-ish (pdev null is ok) buffer alloc/mapping support */
84cca820
GKH		 404int hcd_buffer_create(struct usb_hcd *hcd);
405void hcd_buffer_destroy(struct usb_hcd *hcd);
1da177e4 406
84cca820 407void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
55016f10 408 gfp_t mem_flags, dma_addr_t *dma);
84cca820 409void hcd_buffer_free(struct usb_bus *bus, size_t size,
1da177e4
LT		 410 void *addr, dma_addr_t dma);
411
412/* generic bus glue, needed for host controllers that don't use PCI */
84cca820 413extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
d5926ae7 414
84cca820 415extern void usb_hc_died(struct usb_hcd *hcd);
d5926ae7 416extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
1da177e4 417
3444b26a
DV		 418/* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
419#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
420#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
421#define usb_settoggle(dev, ep, out, bit) \
422 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
423 ((bit) << (ep)))
424
1da177e4
LT		 425/* -------------------------------------------------------------------------- */
426
427/* Enumeration is only for the hub driver, or HCD virtual root hubs */
428extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
429 struct usb_bus *, unsigned port);
430extern int usb_new_device(struct usb_device *dev);
431extern void usb_disconnect(struct usb_device **);
432
433extern int usb_get_configuration(struct usb_device *dev);
434extern void usb_destroy_configuration(struct usb_device *dev);
435
436/*-------------------------------------------------------------------------*/
437
438/*
439 * HCD Root Hub support
440 */
441
d20db4b4
EL		 442#include <linux/usb/ch11.h>
443
444/*
445 * As of USB 2.0, full/low speed devices are segregated into trees.
446 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
447 * The other type grows from high speed hubs when they connect to
448 * full/low speed devices using "Transaction Translators" (TTs).
449 *
450 * TTs should only be known to the hub driver, and high speed bus
451 * drivers (only EHCI for now). They affect periodic scheduling and
452 * sometimes control/bulk error recovery.
453 */
454
455struct usb_device;
456
457struct usb_tt {
458 struct usb_device *hub; /* upstream highspeed hub */
459 int multi; /* true means one TT per port */
460 unsigned think_time; /* think time in ns */
461
462 /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
463 spinlock_t lock;
464 struct list_head clear_list; /* of usb_tt_clear */
465 struct work_struct clear_work;
466};
467
468struct usb_tt_clear {
469 struct list_head clear_list;
470 unsigned tt;
471 u16 devinfo;
472 struct usb_hcd *hcd;
473 struct usb_host_endpoint *ep;
474};
475
476extern int usb_hub_clear_tt_buffer(struct urb *urb);
477extern void usb_ep0_reinit(struct usb_device *);
1da177e4
LT		 478
479/* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
480#define DeviceRequest \
481 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
482#define DeviceOutRequest \
483 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
484
485#define InterfaceRequest \
486 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
487
488#define EndpointRequest \
489 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
490#define EndpointOutRequest \
491 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
492
493/* class requests from the USB 2.0 hub spec, table 11-15 */
494/* GetBusState and SetHubDescriptor are optional, omitted */
495#define ClearHubFeature (0x2000 | USB_REQ_CLEAR_FEATURE)
496#define ClearPortFeature (0x2300 | USB_REQ_CLEAR_FEATURE)
497#define GetHubDescriptor (0xa000 | USB_REQ_GET_DESCRIPTOR)
498#define GetHubStatus (0xa000 | USB_REQ_GET_STATUS)
499#define GetPortStatus (0xa300 | USB_REQ_GET_STATUS)
500#define SetHubFeature (0x2000 | USB_REQ_SET_FEATURE)
501#define SetPortFeature (0x2300 | USB_REQ_SET_FEATURE)
502
503
504/*-------------------------------------------------------------------------*/
0eadcc09
TB		 505
506/* class requests from USB 3.0 hub spec, table 10-5 */
507#define SetHubDepth (0x3000 | HUB_SET_DEPTH)
508#define GetPortErrorCount (0x8000 | HUB_GET_PORT_ERR_COUNT)
1da177e4
LT		 509
510/*
511 * Generic bandwidth allocation constants/support
512 */
513#define FRAME_TIME_USECS 1000L
84cca820 514#define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
1da177e4 515 /* Trying not to use worst-case bit-stuffing
84cca820 516 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
1da177e4
LT		 517 /* bytecount = data payload byte count */
518
519#define NS_TO_US(ns) ((ns + 500L) / 1000L)
520 /* convert & round nanoseconds to microseconds */
521
1da177e4
LT		 522
523/*
524 * Full/low speed bandwidth allocation constants/support.
525 */
526#define BW_HOST_DELAY 1000L /* nanoseconds */
527#define BW_HUB_LS_SETUP 333L /* nanoseconds */
84cca820 528 /* 4 full-speed bit times (est.) */
1da177e4 529
84cca820 530#define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
1da177e4
LT		 531#define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
532#define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
533
1da177e4 534/*
498f78e6 535 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
1da177e4
LT		 536 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
537 * to preallocate bandwidth)
538 */
539#define USB2_HOST_DELAY 5 /* nsec, guess */
84cca820 540#define HS_NSECS(bytes) (((55 * 8 * 2083) \
f956e7cd 541 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 542 + USB2_HOST_DELAY)
84cca820 543#define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
f956e7cd 544 + (2083UL * (3 + BitTime(bytes))))/1000 \
1da177e4 545 + USB2_HOST_DELAY)
0858a3a5
GKH		 546#define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
547#define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
1da177e4 548
84cca820 549extern long usb_calc_bus_time(int speed, int is_input,
1da177e4
LT		 550 int isoc, int bytecount);
551
552/*-------------------------------------------------------------------------*/
553
1da177e4
LT		 554extern void usb_set_device_state(struct usb_device *udev,
555 enum usb_device_state new_state);
556
557/*-------------------------------------------------------------------------*/
558
559/* exported only within usbcore */
560
561extern struct list_head usb_bus_list;
4186ecf8 562extern struct mutex usb_bus_list_lock;
1da177e4
LT		 563extern wait_queue_head_t usb_kill_urb_queue;
564
84cca820 565extern int usb_find_interface_driver(struct usb_device *dev,
1da177e4
LT		 566 struct usb_interface *interface);
567
568#define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
569
0c0382e3 570#ifdef CONFIG_PM
84cca820 571extern void usb_root_hub_lost_power(struct usb_device *rhdev);
65bfd296
AS		 572extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
573extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
9bbdf1e0
AS		 574#endif /* CONFIG_PM */
575
576#ifdef CONFIG_USB_SUSPEND
577extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
0c0382e3 578#else
db2d55b7
AM		 579static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
580{
581 return;
582}
9bbdf1e0
AS		 583#endif /* CONFIG_USB_SUSPEND */
584
0c0382e3 585
1da177e4
LT		 586/*
587 * USB device fs stuff
588 */
589
590#ifdef CONFIG_USB_DEVICEFS
591
592/*
593 * these are expected to be called from the USB core/hub thread
594 * with the kernel lock held
595 */
84cca820 596extern void usbfs_update_special(void);
1da177e4
LT		 597extern int usbfs_init(void);
598extern void usbfs_cleanup(void);
599
600#else /* CONFIG_USB_DEVICEFS */
601
84cca820 602static inline void usbfs_update_special(void) {}
1da177e4
LT		 603static inline int usbfs_init(void) { return 0; }
604static inline void usbfs_cleanup(void) { }
605
606#endif /* CONFIG_USB_DEVICEFS */
607
608/*-------------------------------------------------------------------------*/
609
f150fa1a 610#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
1da177e4
LT		 611
612struct usb_mon_operations {
613 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
614 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
9347d51c 615 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
1da177e4 616 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
1da177e4
LT		 617};
618
619extern struct usb_mon_operations *mon_ops;
620
621static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
622{
623 if (bus->monitored)
624 (*mon_ops->urb_submit)(bus, urb);
625}
626
627static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
628 int error)
629{
630 if (bus->monitored)
631 (*mon_ops->urb_submit_error)(bus, urb, error);
632}
633
9347d51c
AS		 634static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
635 int status)
1da177e4
LT		 636{
637 if (bus->monitored)
9347d51c 638 (*mon_ops->urb_complete)(bus, urb, status);
1da177e4 639}
1da177e4
LT		 640
641int usb_mon_register(struct usb_mon_operations *ops);
642void usb_mon_deregister(void);
643
644#else
645
646static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
647static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
648 int error) {}
9347d51c
AS		 649static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
650 int status) {}
1da177e4 651
f150fa1a 652#endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
1da177e4 653
1da177e4
LT		 654/*-------------------------------------------------------------------------*/
655
656/* random stuff */
657
84cca820
GKH		 658#define RUN_CONTEXT (in_irq() ? "in_irq" \
659 : (in_interrupt() ? "in_interrupt" : "can sleep"))
1da177e4
LT		 660
661
32fe0198
AS		 662/* This rwsem is for use only by the hub driver and ehci-hcd.
663 * Nobody else should touch it.
664 */
665extern struct rw_semaphore ehci_cf_port_reset_rwsem;
1da177e4 666
9beeee65
AS		 667/* Keep track of which host controller drivers are loaded */
668#define USB_UHCI_LOADED 0
669#define USB_OHCI_LOADED 1
670#define USB_EHCI_LOADED 2
671extern unsigned long usb_hcds_loaded;
672
32fe0198 673#endif /* __KERNEL__ */
aa459e6a
AV		 674
675#endif /* __USB_CORE_HCD_H */
Linux kernel - Deliverables
This page took 0.797853 seconds and 5 git commands to generate.