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