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