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