include/linux/usb/hcd.h

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