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