include/linux/usb/hcd.h

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