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