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