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