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