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