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