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