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