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