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