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