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