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