1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2001-2002 by David Brownell
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.
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
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.
20 #ifndef __USB_CORE_HCD_H
21 #define __USB_CORE_HCD_H
25 #include <linux/rwsem.h>
26 #include <linux/interrupt.h>
27 #include <linux/idr.h>
29 #define MAX_TOPO_LEVEL 6
31 /* This file contains declarations of usbcore internals that are mostly
32 * used or exposed by Host Controller Drivers.
36 * USB Packet IDs (PIDs)
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 */
56 /*-------------------------------------------------------------------------*/
59 * USB Host Controller Driver (usb_hcd) framework
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 shareable.
65 /*-------------------------------------------------------------------------*/
67 struct giveback_urb_bh {
70 struct list_head head;
71 struct tasklet_struct bh;
72 struct usb_host_endpoint *completing_ep;
75 enum usb_dev_authorize_policy {
76 USB_DEVICE_AUTHORIZE_NONE = 0,
77 USB_DEVICE_AUTHORIZE_ALL = 1,
78 USB_DEVICE_AUTHORIZE_INTERNAL = 2,
86 struct usb_bus self; /* hcd is-a bus */
87 struct kref kref; /* reference counter */
89 const char *product_desc; /* product/vendor string */
90 int speed; /* Speed for this roothub.
91 * May be different from
92 * hcd->driver->flags & HCD_MASK
94 char irq_descr[24]; /* driver + bus # */
96 struct timer_list rh_timer; /* drives root-hub polling */
97 struct urb *status_urb; /* the current status urb */
99 struct work_struct wakeup_work; /* for remote wakeup */
101 struct work_struct died_work; /* for when the device dies */
104 * hardware info/state
106 const struct hc_driver *driver; /* hw-specific hooks */
109 * OTG and some Host controllers need software interaction with phys;
110 * other external phys should be software-transparent
112 struct usb_phy *usb_phy;
113 struct usb_phy_roothub *phy_roothub;
115 /* Flags that need to be manipulated atomically because they can
116 * change while the host controller is running. Always use
117 * set_bit() or clear_bit() to change their values.
120 #define HCD_FLAG_HW_ACCESSIBLE 0 /* at full power */
121 #define HCD_FLAG_POLL_RH 2 /* poll for rh status? */
122 #define HCD_FLAG_POLL_PENDING 3 /* status has changed? */
123 #define HCD_FLAG_WAKEUP_PENDING 4 /* root hub is resuming? */
124 #define HCD_FLAG_RH_RUNNING 5 /* root hub is running? */
125 #define HCD_FLAG_DEAD 6 /* controller has died? */
126 #define HCD_FLAG_INTF_AUTHORIZED 7 /* authorize interfaces? */
127 #define HCD_FLAG_DEFER_RH_REGISTER 8 /* Defer roothub registration */
129 /* The flags can be tested using these macros; they are likely to
130 * be slightly faster than test_bit().
132 #define HCD_HW_ACCESSIBLE(hcd) ((hcd)->flags & (1U << HCD_FLAG_HW_ACCESSIBLE))
133 #define HCD_POLL_RH(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_RH))
134 #define HCD_POLL_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_POLL_PENDING))
135 #define HCD_WAKEUP_PENDING(hcd) ((hcd)->flags & (1U << HCD_FLAG_WAKEUP_PENDING))
136 #define HCD_RH_RUNNING(hcd) ((hcd)->flags & (1U << HCD_FLAG_RH_RUNNING))
137 #define HCD_DEAD(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEAD))
138 #define HCD_DEFER_RH_REGISTER(hcd) ((hcd)->flags & (1U << HCD_FLAG_DEFER_RH_REGISTER))
141 * Specifies if interfaces are authorized by default
142 * or they require explicit user space authorization; this bit is
143 * settable through /sys/class/usb_host/X/interface_authorized_default
145 #define HCD_INTF_AUTHORIZED(hcd) \
146 ((hcd)->flags & (1U << HCD_FLAG_INTF_AUTHORIZED))
149 * Specifies if devices are authorized by default
150 * or they require explicit user space authorization; this bit is
151 * settable through /sys/class/usb_host/X/authorized_default
153 enum usb_dev_authorize_policy dev_policy;
155 /* Flags that get set only during HCD registration or removal. */
156 unsigned rh_registered:1;/* is root hub registered? */
157 unsigned rh_pollable:1; /* may we poll the root hub? */
158 unsigned msix_enabled:1; /* driver has MSI-X enabled? */
159 unsigned msi_enabled:1; /* driver has MSI enabled? */
161 * do not manage the PHY state in the HCD core, instead let the driver
162 * handle this (for example if the PHY can only be turned on after a
165 unsigned skip_phy_initialization:1;
167 /* The next flag is a stopgap, to be removed when all the HCDs
168 * support the new root-hub polling mechanism. */
169 unsigned uses_new_polling:1;
170 unsigned wireless:1; /* Wireless USB HCD */
171 unsigned has_tt:1; /* Integrated TT in root hub */
172 unsigned amd_resume_bug:1; /* AMD remote wakeup quirk */
173 unsigned can_do_streams:1; /* HC supports streams */
174 unsigned tpl_support:1; /* OTG & EH TPL support */
175 unsigned cant_recv_wakeups:1;
176 /* wakeup requests from downstream aren't received */
178 unsigned int irq; /* irq allocated */
179 void __iomem *regs; /* device memory/io */
180 resource_size_t rsrc_start; /* memory/io resource start */
181 resource_size_t rsrc_len; /* memory/io resource length */
182 unsigned power_budget; /* in mA, 0 = no limit */
184 struct giveback_urb_bh high_prio_bh;
185 struct giveback_urb_bh low_prio_bh;
187 /* bandwidth_mutex should be taken before adding or removing
188 * any new bus bandwidth constraints:
189 * 1. Before adding a configuration for a new device.
190 * 2. Before removing the configuration to put the device into
191 * the addressed state.
192 * 3. Before selecting a different configuration.
193 * 4. Before selecting an alternate interface setting.
195 * bandwidth_mutex should be dropped after a successful control message
196 * to the device, or resetting the bandwidth after a failed attempt.
198 struct mutex *address0_mutex;
199 struct mutex *bandwidth_mutex;
200 struct usb_hcd *shared_hcd;
201 struct usb_hcd *primary_hcd;
204 #define HCD_BUFFER_POOLS 4
205 struct dma_pool *pool[HCD_BUFFER_POOLS];
208 # define __ACTIVE 0x01
209 # define __SUSPEND 0x04
210 # define __TRANSIENT 0x80
212 # define HC_STATE_HALT 0
213 # define HC_STATE_RUNNING (__ACTIVE)
214 # define HC_STATE_QUIESCING (__SUSPEND|__TRANSIENT|__ACTIVE)
215 # define HC_STATE_RESUMING (__SUSPEND|__TRANSIENT)
216 # define HC_STATE_SUSPENDED (__SUSPEND)
218 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
219 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
221 /* memory pool for HCs having local memory, or %NULL */
222 struct gen_pool *localmem_pool;
224 /* more shared queuing code would be good; it should support
225 * smarter scheduling, handle transaction translators, etc;
226 * input size of periodic table to an interrupt scheduler.
227 * (ohci 32, uhci 1024, ehci 256/512/1024).
230 /* The HC driver's private data is stored at the end of
233 unsigned long hcd_priv[]
234 __attribute__ ((aligned(sizeof(s64))));
237 /* 2.4 does this a bit differently ... */
238 static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
243 static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
245 return container_of(bus, struct usb_hcd, self);
248 /*-------------------------------------------------------------------------*/
252 const char *description; /* "ehci-hcd" etc */
253 const char *product_desc; /* product/vendor string */
254 size_t hcd_priv_size; /* size of private data */
257 irqreturn_t (*irq) (struct usb_hcd *hcd);
260 #define HCD_MEMORY 0x0001 /* HC regs use memory (else I/O) */
261 #define HCD_DMA 0x0002 /* HC uses DMA */
262 #define HCD_SHARED 0x0004 /* Two (or more) usb_hcds share HW */
263 #define HCD_USB11 0x0010 /* USB 1.1 */
264 #define HCD_USB2 0x0020 /* USB 2.0 */
265 #define HCD_USB25 0x0030 /* Wireless USB 1.0 (USB 2.5)*/
266 #define HCD_USB3 0x0040 /* USB 3.0 */
267 #define HCD_USB31 0x0050 /* USB 3.1 */
268 #define HCD_USB32 0x0060 /* USB 3.2 */
269 #define HCD_MASK 0x0070
270 #define HCD_BH 0x0100 /* URB complete in BH context */
272 /* called to init HCD and root hub */
273 int (*reset) (struct usb_hcd *hcd);
274 int (*start) (struct usb_hcd *hcd);
276 /* NOTE: these suspend/resume calls relate to the HC as
277 * a whole, not just the root hub; they're for PCI bus glue.
279 /* called after suspending the hub, before entering D3 etc */
280 int (*pci_suspend)(struct usb_hcd *hcd, bool do_wakeup);
282 /* called after entering D0 (etc), before resuming the hub */
283 int (*pci_resume)(struct usb_hcd *hcd, bool hibernated);
285 /* cleanly make HCD stop writing memory and doing I/O */
286 void (*stop) (struct usb_hcd *hcd);
289 void (*shutdown) (struct usb_hcd *hcd);
291 /* return current frame number */
292 int (*get_frame_number) (struct usb_hcd *hcd);
294 /* manage i/o requests, device state */
295 int (*urb_enqueue)(struct usb_hcd *hcd,
296 struct urb *urb, gfp_t mem_flags);
297 int (*urb_dequeue)(struct usb_hcd *hcd,
298 struct urb *urb, int status);
301 * (optional) these hooks allow an HCD to override the default DMA
302 * mapping and unmapping routines. In general, they shouldn't be
303 * necessary unless the host controller has special DMA requirements,
304 * such as alignment constraints. If these are not specified, the
305 * general usb_hcd_(un)?map_urb_for_dma functions will be used instead
306 * (and it may be a good idea to call these functions in your HCD
309 int (*map_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb,
311 void (*unmap_urb_for_dma)(struct usb_hcd *hcd, struct urb *urb);
313 /* hw synch, freeing endpoint resources that urb_dequeue can't */
314 void (*endpoint_disable)(struct usb_hcd *hcd,
315 struct usb_host_endpoint *ep);
317 /* (optional) reset any endpoint state such as sequence number
318 and current window */
319 void (*endpoint_reset)(struct usb_hcd *hcd,
320 struct usb_host_endpoint *ep);
322 /* root hub support */
323 int (*hub_status_data) (struct usb_hcd *hcd, char *buf);
324 int (*hub_control) (struct usb_hcd *hcd,
325 u16 typeReq, u16 wValue, u16 wIndex,
326 char *buf, u16 wLength);
327 int (*bus_suspend)(struct usb_hcd *);
328 int (*bus_resume)(struct usb_hcd *);
329 int (*start_port_reset)(struct usb_hcd *, unsigned port_num);
330 unsigned long (*get_resuming_ports)(struct usb_hcd *);
332 /* force handover of high-speed port to full-speed companion */
333 void (*relinquish_port)(struct usb_hcd *, int);
334 /* has a port been handed over to a companion? */
335 int (*port_handed_over)(struct usb_hcd *, int);
337 /* CLEAR_TT_BUFFER completion callback */
338 void (*clear_tt_buffer_complete)(struct usb_hcd *,
339 struct usb_host_endpoint *);
341 /* xHCI specific functions */
342 /* Called by usb_alloc_dev to alloc HC device structures */
343 int (*alloc_dev)(struct usb_hcd *, struct usb_device *);
344 /* Called by usb_disconnect to free HC device structures */
345 void (*free_dev)(struct usb_hcd *, struct usb_device *);
346 /* Change a group of bulk endpoints to support multiple stream IDs */
347 int (*alloc_streams)(struct usb_hcd *hcd, struct usb_device *udev,
348 struct usb_host_endpoint **eps, unsigned int num_eps,
349 unsigned int num_streams, gfp_t mem_flags);
350 /* Reverts a group of bulk endpoints back to not using stream IDs.
351 * Can fail if we run out of memory.
353 int (*free_streams)(struct usb_hcd *hcd, struct usb_device *udev,
354 struct usb_host_endpoint **eps, unsigned int num_eps,
357 /* Bandwidth computation functions */
358 /* Note that add_endpoint() can only be called once per endpoint before
359 * check_bandwidth() or reset_bandwidth() must be called.
360 * drop_endpoint() can only be called once per endpoint also.
361 * A call to xhci_drop_endpoint() followed by a call to
362 * xhci_add_endpoint() will add the endpoint to the schedule with
363 * possibly new parameters denoted by a different endpoint descriptor
364 * in usb_host_endpoint. A call to xhci_add_endpoint() followed by a
365 * call to xhci_drop_endpoint() is not allowed.
367 /* Allocate endpoint resources and add them to a new schedule */
368 int (*add_endpoint)(struct usb_hcd *, struct usb_device *,
369 struct usb_host_endpoint *);
370 /* Drop an endpoint from a new schedule */
371 int (*drop_endpoint)(struct usb_hcd *, struct usb_device *,
372 struct usb_host_endpoint *);
373 /* Check that a new hardware configuration, set using
374 * endpoint_enable and endpoint_disable, does not exceed bus
375 * bandwidth. This must be called before any set configuration
376 * or set interface requests are sent to the device.
378 int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
379 /* Reset the device schedule to the last known good schedule,
380 * which was set from a previous successful call to
381 * check_bandwidth(). This reverts any add_endpoint() and
382 * drop_endpoint() calls since that last successful call.
383 * Used for when a check_bandwidth() call fails due to resource
384 * or bandwidth constraints.
386 void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
387 /* Override the endpoint-derived interval
388 * (if there is any cached hardware state).
390 void (*fixup_endpoint)(struct usb_hcd *hcd, struct usb_device *udev,
391 struct usb_host_endpoint *ep, int interval);
392 /* Returns the hardware-chosen device address */
393 int (*address_device)(struct usb_hcd *, struct usb_device *udev);
394 /* prepares the hardware to send commands to the device */
395 int (*enable_device)(struct usb_hcd *, struct usb_device *udev);
396 /* Notifies the HCD after a hub descriptor is fetched.
399 int (*update_hub_device)(struct usb_hcd *, struct usb_device *hdev,
400 struct usb_tt *tt, gfp_t mem_flags);
401 int (*reset_device)(struct usb_hcd *, struct usb_device *);
402 /* Notifies the HCD after a device is connected and its
405 int (*update_device)(struct usb_hcd *, struct usb_device *);
406 int (*set_usb2_hw_lpm)(struct usb_hcd *, struct usb_device *, int);
407 /* USB 3.0 Link Power Management */
408 /* Returns the USB3 hub-encoded value for the U1/U2 timeout. */
409 int (*enable_usb3_lpm_timeout)(struct usb_hcd *,
410 struct usb_device *, enum usb3_link_state state);
411 /* The xHCI host controller can still fail the command to
412 * disable the LPM timeouts, so this can return an error code.
414 int (*disable_usb3_lpm_timeout)(struct usb_hcd *,
415 struct usb_device *, enum usb3_link_state state);
416 int (*find_raw_port_number)(struct usb_hcd *, int);
417 /* Call for power on/off the port if necessary */
418 int (*port_power)(struct usb_hcd *hcd, int portnum, bool enable);
419 /* Call for SINGLE_STEP_SET_FEATURE Test for USB2 EH certification */
420 #define EHSET_TEST_SINGLE_STEP_SET_FEATURE 0x06
421 int (*submit_single_step_set_feature)(struct usb_hcd *,
425 static inline int hcd_giveback_urb_in_bh(struct usb_hcd *hcd)
427 return hcd->driver->flags & HCD_BH;
430 static inline bool hcd_periodic_completion_in_progress(struct usb_hcd *hcd,
431 struct usb_host_endpoint *ep)
433 return hcd->high_prio_bh.completing_ep == ep;
436 static inline bool hcd_uses_dma(struct usb_hcd *hcd)
438 return IS_ENABLED(CONFIG_HAS_DMA) && (hcd->driver->flags & HCD_DMA);
441 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
442 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
444 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
446 extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
447 extern int usb_hcd_unlink_urb(struct urb *urb, int status);
448 extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
450 extern int usb_hcd_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
452 extern void usb_hcd_unmap_urb_setup_for_dma(struct usb_hcd *, struct urb *);
453 extern void usb_hcd_unmap_urb_for_dma(struct usb_hcd *, struct urb *);
454 extern void usb_hcd_flush_endpoint(struct usb_device *udev,
455 struct usb_host_endpoint *ep);
456 extern void usb_hcd_fixup_endpoint(struct usb_device *udev,
457 struct usb_host_endpoint *ep, int interval);
458 extern void usb_hcd_disable_endpoint(struct usb_device *udev,
459 struct usb_host_endpoint *ep);
460 extern void usb_hcd_reset_endpoint(struct usb_device *udev,
461 struct usb_host_endpoint *ep);
462 extern void usb_hcd_synchronize_unlinks(struct usb_device *udev);
463 extern int usb_hcd_alloc_bandwidth(struct usb_device *udev,
464 struct usb_host_config *new_config,
465 struct usb_host_interface *old_alt,
466 struct usb_host_interface *new_alt);
467 extern int usb_hcd_get_frame_number(struct usb_device *udev);
469 struct usb_hcd *__usb_create_hcd(const struct hc_driver *driver,
470 struct device *sysdev, struct device *dev, const char *bus_name,
471 struct usb_hcd *primary_hcd);
472 extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
473 struct device *dev, const char *bus_name);
474 extern struct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver,
475 struct device *dev, const char *bus_name,
476 struct usb_hcd *shared_hcd);
477 extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
478 extern void usb_put_hcd(struct usb_hcd *hcd);
479 extern int usb_hcd_is_primary_hcd(struct usb_hcd *hcd);
480 extern int usb_add_hcd(struct usb_hcd *hcd,
481 unsigned int irqnum, unsigned long irqflags);
482 extern void usb_remove_hcd(struct usb_hcd *hcd);
483 extern int usb_hcd_find_raw_port_number(struct usb_hcd *hcd, int port1);
484 int usb_hcd_setup_local_mem(struct usb_hcd *hcd, phys_addr_t phys_addr,
485 dma_addr_t dma, size_t size);
487 struct platform_device;
488 extern void usb_hcd_platform_shutdown(struct platform_device *dev);
489 #ifdef CONFIG_USB_HCD_TEST_MODE
490 extern int ehset_single_step_set_feature(struct usb_hcd *hcd, int port);
492 static inline int ehset_single_step_set_feature(struct usb_hcd *hcd, int port)
496 #endif /* CONFIG_USB_HCD_TEST_MODE */
498 #ifdef CONFIG_USB_PCI
500 struct pci_device_id;
501 extern int usb_hcd_pci_probe(struct pci_dev *dev,
502 const struct pci_device_id *id,
503 const struct hc_driver *driver);
504 extern void usb_hcd_pci_remove(struct pci_dev *dev);
505 extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
507 extern int usb_hcd_amd_remote_wakeup_quirk(struct pci_dev *dev);
510 extern const struct dev_pm_ops usb_hcd_pci_pm_ops;
512 #endif /* CONFIG_USB_PCI */
514 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
515 void usb_init_pool_max(void);
516 int hcd_buffer_create(struct usb_hcd *hcd);
517 void hcd_buffer_destroy(struct usb_hcd *hcd);
519 void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
520 gfp_t mem_flags, dma_addr_t *dma);
521 void hcd_buffer_free(struct usb_bus *bus, size_t size,
522 void *addr, dma_addr_t dma);
524 /* generic bus glue, needed for host controllers that don't use PCI */
525 extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
527 extern void usb_hc_died(struct usb_hcd *hcd);
528 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
529 extern void usb_wakeup_notification(struct usb_device *hdev,
530 unsigned int portnum);
532 extern void usb_hcd_start_port_resume(struct usb_bus *bus, int portnum);
533 extern void usb_hcd_end_port_resume(struct usb_bus *bus, int portnum);
535 /* The D0/D1 toggle bits ... USE WITH CAUTION (they're almost hcd-internal) */
536 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> (ep)) & 1)
537 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << (ep)))
538 #define usb_settoggle(dev, ep, out, bit) \
539 ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << (ep))) | \
542 /* -------------------------------------------------------------------------- */
544 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
545 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
546 struct usb_bus *, unsigned port);
547 extern int usb_new_device(struct usb_device *dev);
548 extern void usb_disconnect(struct usb_device **);
550 extern int usb_get_configuration(struct usb_device *dev);
551 extern void usb_destroy_configuration(struct usb_device *dev);
553 /*-------------------------------------------------------------------------*/
556 * HCD Root Hub support
559 #include <linux/usb/ch11.h>
562 * As of USB 2.0, full/low speed devices are segregated into trees.
563 * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
564 * The other type grows from high speed hubs when they connect to
565 * full/low speed devices using "Transaction Translators" (TTs).
567 * TTs should only be known to the hub driver, and high speed bus
568 * drivers (only EHCI for now). They affect periodic scheduling and
569 * sometimes control/bulk error recovery.
575 struct usb_device *hub; /* upstream highspeed hub */
576 int multi; /* true means one TT per port */
577 unsigned think_time; /* think time in ns */
578 void *hcpriv; /* HCD private data */
580 /* for control/bulk error recovery (CLEAR_TT_BUFFER) */
582 struct list_head clear_list; /* of usb_tt_clear */
583 struct work_struct clear_work;
586 struct usb_tt_clear {
587 struct list_head clear_list;
591 struct usb_host_endpoint *ep;
594 extern int usb_hub_clear_tt_buffer(struct urb *urb);
595 extern void usb_ep0_reinit(struct usb_device *);
597 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
598 #define DeviceRequest \
599 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
600 #define DeviceOutRequest \
601 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
603 #define InterfaceRequest \
604 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
606 #define EndpointRequest \
607 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
608 #define EndpointOutRequest \
609 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
611 /* class requests from the USB 2.0 hub spec, table 11-15 */
612 #define HUB_CLASS_REQ(dir, type, request) ((((dir) | (type)) << 8) | (request))
613 /* GetBusState and SetHubDescriptor are optional, omitted */
614 #define ClearHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_CLEAR_FEATURE)
615 #define ClearPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_CLEAR_FEATURE)
616 #define GetHubDescriptor HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_DESCRIPTOR)
617 #define GetHubStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, USB_REQ_GET_STATUS)
618 #define GetPortStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, USB_REQ_GET_STATUS)
619 #define SetHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, USB_REQ_SET_FEATURE)
620 #define SetPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, USB_REQ_SET_FEATURE)
621 #define ClearTTBuffer HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_CLEAR_TT_BUFFER)
622 #define ResetTT HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_RESET_TT)
623 #define GetTTState HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, HUB_GET_TT_STATE)
624 #define StopTT HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, HUB_STOP_TT)
627 /*-------------------------------------------------------------------------*/
629 /* class requests from USB 3.1 hub spec, table 10-7 */
630 #define SetHubDepth HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, HUB_SET_DEPTH)
631 #define GetPortErrorCount HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, HUB_GET_PORT_ERR_COUNT)
634 * Generic bandwidth allocation constants/support
636 #define FRAME_TIME_USECS 1000L
637 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
638 /* Trying not to use worst-case bit-stuffing
639 * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
640 /* bytecount = data payload byte count */
642 #define NS_TO_US(ns) DIV_ROUND_UP(ns, 1000L)
643 /* convert nanoseconds to microseconds, rounding up */
646 * Full/low speed bandwidth allocation constants/support.
648 #define BW_HOST_DELAY 1000L /* nanoseconds */
649 #define BW_HUB_LS_SETUP 333L /* nanoseconds */
650 /* 4 full-speed bit times (est.) */
652 #define FRAME_TIME_BITS 12000L /* frame = 1 millisecond */
653 #define FRAME_TIME_MAX_BITS_ALLOC (90L * FRAME_TIME_BITS / 100L)
654 #define FRAME_TIME_MAX_USECS_ALLOC (90L * FRAME_TIME_USECS / 100L)
657 * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
658 * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
659 * to preallocate bandwidth)
661 #define USB2_HOST_DELAY 5 /* nsec, guess */
662 #define HS_NSECS(bytes) (((55 * 8 * 2083) \
663 + (2083UL * (3 + BitTime(bytes))))/1000 \
665 #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
666 + (2083UL * (3 + BitTime(bytes))))/1000 \
668 #define HS_USECS(bytes) NS_TO_US(HS_NSECS(bytes))
669 #define HS_USECS_ISO(bytes) NS_TO_US(HS_NSECS_ISO(bytes))
671 extern long usb_calc_bus_time(int speed, int is_input,
672 int isoc, int bytecount);
674 /*-------------------------------------------------------------------------*/
676 extern void usb_set_device_state(struct usb_device *udev,
677 enum usb_device_state new_state);
679 /*-------------------------------------------------------------------------*/
681 /* exported only within usbcore */
683 extern struct idr usb_bus_idr;
684 extern struct mutex usb_bus_idr_lock;
685 extern wait_queue_head_t usb_kill_urb_queue;
688 #define usb_endpoint_out(ep_dir) (!((ep_dir) & USB_DIR_IN))
691 extern unsigned usb_wakeup_enabled_descendants(struct usb_device *udev);
692 extern void usb_root_hub_lost_power(struct usb_device *rhdev);
693 extern int hcd_bus_suspend(struct usb_device *rhdev, pm_message_t msg);
694 extern int hcd_bus_resume(struct usb_device *rhdev, pm_message_t msg);
695 extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
697 static inline unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
701 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
705 #endif /* CONFIG_PM */
707 /*-------------------------------------------------------------------------*/
709 #if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
711 struct usb_mon_operations {
712 void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
713 void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
714 void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
715 /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
718 extern const struct usb_mon_operations *mon_ops;
720 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
723 (*mon_ops->urb_submit)(bus, urb);
726 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
730 (*mon_ops->urb_submit_error)(bus, urb, error);
733 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
737 (*mon_ops->urb_complete)(bus, urb, status);
740 int usb_mon_register(const struct usb_mon_operations *ops);
741 void usb_mon_deregister(void);
745 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
746 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
748 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
751 #endif /* CONFIG_USB_MON || CONFIG_USB_MON_MODULE */
753 /*-------------------------------------------------------------------------*/
757 /* This rwsem is for use only by the hub driver and ehci-hcd.
758 * Nobody else should touch it.
760 extern struct rw_semaphore ehci_cf_port_reset_rwsem;
762 /* Keep track of which host controller drivers are loaded */
763 #define USB_UHCI_LOADED 0
764 #define USB_OHCI_LOADED 1
765 #define USB_EHCI_LOADED 2
766 extern unsigned long usb_hcds_loaded;
768 #endif /* __KERNEL__ */
770 #endif /* __USB_CORE_HCD_H */