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