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