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