drivers/usb/core/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
  20 #ifdef __KERNEL__
  21
  22 #include <linux/rwsem.h>
  23
  24 /* This file contains declarations of usbcore internals that are mostly
  25  * used or exposed by Host Controller Drivers.
  26  */
  27
  28 /*
  29  * USB Packet IDs (PIDs)
  30  */
  31 #define USB_PID_EXT                     0xf0    /* USB 2.0 LPM ECN */
  32 #define USB_PID_OUT                     0xe1
  33 #define USB_PID_ACK                     0xd2
  34 #define USB_PID_DATA0                   0xc3
  35 #define USB_PID_PING                    0xb4    /* USB 2.0 */
  36 #define USB_PID_SOF                     0xa5
  37 #define USB_PID_NYET                    0x96    /* USB 2.0 */
  38 #define USB_PID_DATA2                   0x87    /* USB 2.0 */
  39 #define USB_PID_SPLIT                   0x78    /* USB 2.0 */
  40 #define USB_PID_IN                      0x69
  41 #define USB_PID_NAK                     0x5a
  42 #define USB_PID_DATA1                   0x4b
  43 #define USB_PID_PREAMBLE                0x3c    /* Token mode */
  44 #define USB_PID_ERR                     0x3c    /* USB 2.0: handshake mode */
  45 #define USB_PID_SETUP                   0x2d
  46 #define USB_PID_STALL                   0x1e
  47 #define USB_PID_MDATA                   0x0f    /* USB 2.0 */
  48
  49 /*-------------------------------------------------------------------------*/
  50
  51 /*
  52  * USB Host Controller Driver (usb_hcd) framework
  53  *
  54  * Since "struct usb_bus" is so thin, you can't share much code in it.
  55  * This framework is a layer over that, and should be more sharable.
  56  *
  57  * @authorized_default: Specifies if new devices are authorized to
  58  *                      connect by default or they require explicit
  59  *                      user space authorization; this bit is settable
  60  *                      through /sys/class/usb_host/X/authorized_default.
  61  *                      For the rest is RO, so we don't lock to r/w it.
  62  */
  63
  64 /*-------------------------------------------------------------------------*/
  65
  66 struct usb_hcd {
  67
  68         /*
  69          * housekeeping
  70          */
  71         struct usb_bus          self;           /* hcd is-a bus */
  72         struct kref             kref;           /* reference counter */
  73
  74         const char              *product_desc;  /* product/vendor string */
  75         char                    irq_descr[24];  /* driver + bus # */
  76
  77         struct timer_list       rh_timer;       /* drives root-hub polling */
  78         struct urb              *status_urb;    /* the current status urb */
  79 #ifdef CONFIG_PM
  80         struct work_struct      wakeup_work;    /* for remote wakeup */
  81 #endif
  82
  83         /*
  84          * hardware info/state
  85          */
  86         const struct hc_driver  *driver;        /* hw-specific hooks */
  87
  88         /* Flags that need to be manipulated atomically */
  89         unsigned long           flags;
  90 #define HCD_FLAG_HW_ACCESSIBLE  0x00000001
  91 #define HCD_FLAG_SAW_IRQ        0x00000002
  92
  93         unsigned                rh_registered:1;/* is root hub registered? */
  94
  95         /* The next flag is a stopgap, to be removed when all the HCDs
  96          * support the new root-hub polling mechanism. */
  97         unsigned                uses_new_polling:1;
  98         unsigned                poll_rh:1;      /* poll for rh status? */
  99         unsigned                poll_pending:1; /* status has changed? */
 100         unsigned                wireless:1;     /* Wireless USB HCD */
 101         unsigned                authorized_default:1;
 102         unsigned                has_tt:1;       /* Integrated TT in root hub */
 103
 104         int                     irq;            /* irq allocated */
 105         void __iomem            *regs;          /* device memory/io */
 106         u64                     rsrc_start;     /* memory/io resource start */
 107         u64                     rsrc_len;       /* memory/io resource length */
 108         unsigned                power_budget;   /* in mA, 0 = no limit */
 109
 110 #define HCD_BUFFER_POOLS        4
 111         struct dma_pool         *pool [HCD_BUFFER_POOLS];
 112
 113         int                     state;
 114 #       define  __ACTIVE                0x01
 115 #       define  __SUSPEND               0x04
 116 #       define  __TRANSIENT             0x80
 117
 118 #       define  HC_STATE_HALT           0
 119 #       define  HC_STATE_RUNNING        (__ACTIVE)
 120 #       define  HC_STATE_QUIESCING      (__SUSPEND|__TRANSIENT|__ACTIVE)
 121 #       define  HC_STATE_RESUMING       (__SUSPEND|__TRANSIENT)
 122 #       define  HC_STATE_SUSPENDED      (__SUSPEND)
 123
 124 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
 125 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
 126
 127         /* more shared queuing code would be good; it should support
 128          * smarter scheduling, handle transaction translators, etc;
 129          * input size of periodic table to an interrupt scheduler.
 130          * (ohci 32, uhci 1024, ehci 256/512/1024).
 131          */
 132
 133         /* The HC driver's private data is stored at the end of
 134          * this structure.
 135          */
 136         unsigned long hcd_priv[0]
 137                         __attribute__ ((aligned(sizeof(unsigned long))));
 138 };
 139
 140 /* 2.4 does this a bit differently ... */
 141 static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
 142 {
 143         return &hcd->self;
 144 }
 145
 146 static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
 147 {
 148         return container_of(bus, struct usb_hcd, self);
 149 }
 150
 151 struct hcd_timeout {    /* timeouts we allocate */
 152         struct list_head        timeout_list;
 153         struct timer_list       timer;
 154 };
 155
 156 /*-------------------------------------------------------------------------*/
 157
 158
 159 struct hc_driver {
 160         const char      *description;   /* "ehci-hcd" etc */
 161         const char      *product_desc;  /* product/vendor string */
 162         size_t          hcd_priv_size;  /* size of private data */
 163
 164         /* irq handler */
 165         irqreturn_t     (*irq) (struct usb_hcd *hcd);
 166
 167         int     flags;
 168 #define HCD_MEMORY      0x0001          /* HC regs use memory (else I/O) */
 169 #define HCD_LOCAL_MEM   0x0002          /* HC needs local memory */
 170 #define HCD_USB11       0x0010          /* USB 1.1 */
 171 #define HCD_USB2        0x0020          /* USB 2.0 */
 172
 173         /* called to init HCD and root hub */
 174         int     (*reset) (struct usb_hcd *hcd);
 175         int     (*start) (struct usb_hcd *hcd);
 176
 177         /* NOTE:  these suspend/resume calls relate to the HC as
 178          * a whole, not just the root hub; they're for PCI bus glue.
 179          */
 180         /* called after suspending the hub, before entering D3 etc */
 181         int     (*pci_suspend) (struct usb_hcd *hcd, pm_message_t message);
 182
 183         /* called after entering D0 (etc), before resuming the hub */
 184         int     (*pci_resume) (struct usb_hcd *hcd);
 185
 186         /* cleanly make HCD stop writing memory and doing I/O */
 187         void    (*stop) (struct usb_hcd *hcd);
 188
 189         /* shutdown HCD */
 190         void    (*shutdown) (struct usb_hcd *hcd);
 191
 192         /* return current frame number */
 193         int     (*get_frame_number) (struct usb_hcd *hcd);
 194
 195         /* manage i/o requests, device state */
 196         int     (*urb_enqueue)(struct usb_hcd *hcd,
 197                                 struct urb *urb, gfp_t mem_flags);
 198         int     (*urb_dequeue)(struct usb_hcd *hcd,
 199                                 struct urb *urb, int status);
 200
 201         /* hw synch, freeing endpoint resources that urb_dequeue can't */
 202         void    (*endpoint_disable)(struct usb_hcd *hcd,
 203                         struct usb_host_endpoint *ep);
 204
 205         /* root hub support */
 206         int     (*hub_status_data) (struct usb_hcd *hcd, char *buf);
 207         int     (*hub_control) (struct usb_hcd *hcd,
 208                                 u16 typeReq, u16 wValue, u16 wIndex,
 209                                 char *buf, u16 wLength);
 210         int     (*bus_suspend)(struct usb_hcd *);
 211         int     (*bus_resume)(struct usb_hcd *);
 212         int     (*start_port_reset)(struct usb_hcd *, unsigned port_num);
 213         void    (*hub_irq_enable)(struct usb_hcd *);
 214                 /* Needed only if port-change IRQs are level-triggered */
 215
 216                 /* force handover of high-speed port to full-speed companion */
 217         void    (*relinquish_port)(struct usb_hcd *, int);
 218                 /* has a port been handed over to a companion? */
 219         int     (*port_handed_over)(struct usb_hcd *, int);
 220 };
 221
 222 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
 223 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
 224                 int status);
 225 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
 226
 227 extern int usb_hcd_submit_urb(struct urb *urb, gfp_t mem_flags);
 228 extern int usb_hcd_unlink_urb(struct urb *urb, int status);
 229 extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
 230                 int status);
 231 extern void usb_hcd_flush_endpoint(struct usb_device *udev,
 232                 struct usb_host_endpoint *ep);
 233 extern void usb_hcd_disable_endpoint(struct usb_device *udev,
 234                 struct usb_host_endpoint *ep);
 235 extern int usb_hcd_get_frame_number(struct usb_device *udev);
 236
 237 extern struct usb_hcd *usb_create_hcd(const struct hc_driver *driver,
 238                 struct device *dev, char *bus_name);
 239 extern struct usb_hcd *usb_get_hcd(struct usb_hcd *hcd);
 240 extern void usb_put_hcd(struct usb_hcd *hcd);
 241 extern int usb_add_hcd(struct usb_hcd *hcd,
 242                 unsigned int irqnum, unsigned long irqflags);
 243 extern void usb_remove_hcd(struct usb_hcd *hcd);
 244
 245 struct platform_device;
 246 extern void usb_hcd_platform_shutdown(struct platform_device *dev);
 247
 248 #ifdef CONFIG_PCI
 249 struct pci_dev;
 250 struct pci_device_id;
 251 extern int usb_hcd_pci_probe(struct pci_dev *dev,
 252                                 const struct pci_device_id *id);
 253 extern void usb_hcd_pci_remove(struct pci_dev *dev);
 254
 255 #ifdef CONFIG_PM
 256 extern int usb_hcd_pci_suspend(struct pci_dev *dev, pm_message_t state);
 257 extern int usb_hcd_pci_resume(struct pci_dev *dev);
 258 #endif /* CONFIG_PM */
 259
 260 extern void usb_hcd_pci_shutdown(struct pci_dev *dev);
 261
 262 #endif /* CONFIG_PCI */
 263
 264 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
 265 int hcd_buffer_create(struct usb_hcd *hcd);
 266 void hcd_buffer_destroy(struct usb_hcd *hcd);
 267
 268 void *hcd_buffer_alloc(struct usb_bus *bus, size_t size,
 269         gfp_t mem_flags, dma_addr_t *dma);
 270 void hcd_buffer_free(struct usb_bus *bus, size_t size,
 271         void *addr, dma_addr_t dma);
 272
 273 /* generic bus glue, needed for host controllers that don't use PCI */
 274 extern irqreturn_t usb_hcd_irq(int irq, void *__hcd);
 275
 276 extern void usb_hc_died(struct usb_hcd *hcd);
 277 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
 278
 279 /* -------------------------------------------------------------------------- */
 280
 281 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
 282 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
 283                                         struct usb_bus *, unsigned port);
 284 extern int usb_new_device(struct usb_device *dev);
 285 extern void usb_disconnect(struct usb_device **);
 286
 287 extern int usb_get_configuration(struct usb_device *dev);
 288 extern void usb_destroy_configuration(struct usb_device *dev);
 289
 290 /*-------------------------------------------------------------------------*/
 291
 292 /*
 293  * HCD Root Hub support
 294  */
 295
 296 #include "hub.h"
 297
 298 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
 299 #define DeviceRequest \
 300         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 301 #define DeviceOutRequest \
 302         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 303
 304 #define InterfaceRequest \
 305         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 306
 307 #define EndpointRequest \
 308         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 309 #define EndpointOutRequest \
 310         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 311
 312 /* class requests from the USB 2.0 hub spec, table 11-15 */
 313 /* GetBusState and SetHubDescriptor are optional, omitted */
 314 #define ClearHubFeature         (0x2000 | USB_REQ_CLEAR_FEATURE)
 315 #define ClearPortFeature        (0x2300 | USB_REQ_CLEAR_FEATURE)
 316 #define GetHubDescriptor        (0xa000 | USB_REQ_GET_DESCRIPTOR)
 317 #define GetHubStatus            (0xa000 | USB_REQ_GET_STATUS)
 318 #define GetPortStatus           (0xa300 | USB_REQ_GET_STATUS)
 319 #define SetHubFeature           (0x2000 | USB_REQ_SET_FEATURE)
 320 #define SetPortFeature          (0x2300 | USB_REQ_SET_FEATURE)
 321
 322
 323 /*-------------------------------------------------------------------------*/
 324
 325 /*
 326  * Generic bandwidth allocation constants/support
 327  */
 328 #define FRAME_TIME_USECS        1000L
 329 #define BitTime(bytecount) (7 * 8 * bytecount / 6) /* with integer truncation */
 330                 /* Trying not to use worst-case bit-stuffing
 331                  * of (7/6 * 8 * bytecount) = 9.33 * bytecount */
 332                 /* bytecount = data payload byte count */
 333
 334 #define NS_TO_US(ns)    ((ns + 500L) / 1000L)
 335                         /* convert & round nanoseconds to microseconds */
 336
 337
 338 /*
 339  * Full/low speed bandwidth allocation constants/support.
 340  */
 341 #define BW_HOST_DELAY   1000L           /* nanoseconds */
 342 #define BW_HUB_LS_SETUP 333L            /* nanoseconds */
 343                         /* 4 full-speed bit times (est.) */
 344
 345 #define FRAME_TIME_BITS                 12000L  /* frame = 1 millisecond */
 346 #define FRAME_TIME_MAX_BITS_ALLOC       (90L * FRAME_TIME_BITS / 100L)
 347 #define FRAME_TIME_MAX_USECS_ALLOC      (90L * FRAME_TIME_USECS / 100L)
 348
 349 /*
 350  * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
 351  * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
 352  * to preallocate bandwidth)
 353  */
 354 #define USB2_HOST_DELAY 5       /* nsec, guess */
 355 #define HS_NSECS(bytes) (((55 * 8 * 2083) \
 356         + (2083UL * (3 + BitTime(bytes))))/1000 \
 357         + USB2_HOST_DELAY)
 358 #define HS_NSECS_ISO(bytes) (((38 * 8 * 2083) \
 359         + (2083UL * (3 + BitTime(bytes))))/1000 \
 360         + USB2_HOST_DELAY)
 361 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
 362 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
 363
 364 extern long usb_calc_bus_time(int speed, int is_input,
 365                         int isoc, int bytecount);
 366
 367 /*-------------------------------------------------------------------------*/
 368
 369 extern void usb_set_device_state(struct usb_device *udev,
 370                 enum usb_device_state new_state);
 371
 372 /*-------------------------------------------------------------------------*/
 373
 374 /* exported only within usbcore */
 375
 376 extern struct list_head usb_bus_list;
 377 extern struct mutex usb_bus_list_lock;
 378 extern wait_queue_head_t usb_kill_urb_queue;
 379
 380 extern void usb_enable_root_hub_irq(struct usb_bus *bus);
 381
 382 extern int usb_find_interface_driver(struct usb_device *dev,
 383         struct usb_interface *interface);
 384
 385 #define usb_endpoint_out(ep_dir)        (!((ep_dir) & USB_DIR_IN))
 386
 387 #ifdef CONFIG_PM
 388 extern void usb_hcd_resume_root_hub(struct usb_hcd *hcd);
 389 extern void usb_root_hub_lost_power(struct usb_device *rhdev);
 390 extern int hcd_bus_suspend(struct usb_device *rhdev);
 391 extern int hcd_bus_resume(struct usb_device *rhdev);
 392 #else
 393 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
 394 {
 395         return;
 396 }
 397 #endif /* CONFIG_PM */
 398
 399 /*
 400  * USB device fs stuff
 401  */
 402
 403 #ifdef CONFIG_USB_DEVICEFS
 404
 405 /*
 406  * these are expected to be called from the USB core/hub thread
 407  * with the kernel lock held
 408  */
 409 extern void usbfs_update_special(void);
 410 extern int usbfs_init(void);
 411 extern void usbfs_cleanup(void);
 412
 413 #else /* CONFIG_USB_DEVICEFS */
 414
 415 static inline void usbfs_update_special(void) {}
 416 static inline int usbfs_init(void) { return 0; }
 417 static inline void usbfs_cleanup(void) { }
 418
 419 #endif /* CONFIG_USB_DEVICEFS */
 420
 421 /*-------------------------------------------------------------------------*/
 422
 423 #if defined(CONFIG_USB_MON)
 424
 425 struct usb_mon_operations {
 426         void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
 427         void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
 428         void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
 429         /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
 430 };
 431
 432 extern struct usb_mon_operations *mon_ops;
 433
 434 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
 435 {
 436         if (bus->monitored)
 437                 (*mon_ops->urb_submit)(bus, urb);
 438 }
 439
 440 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
 441     int error)
 442 {
 443         if (bus->monitored)
 444                 (*mon_ops->urb_submit_error)(bus, urb, error);
 445 }
 446
 447 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
 448                 int status)
 449 {
 450         if (bus->monitored)
 451                 (*mon_ops->urb_complete)(bus, urb, status);
 452 }
 453
 454 int usb_mon_register(struct usb_mon_operations *ops);
 455 void usb_mon_deregister(void);
 456
 457 #else
 458
 459 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
 460 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
 461     int error) {}
 462 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
 463                 int status) {}
 464
 465 #endif /* CONFIG_USB_MON */
 466
 467 /*-------------------------------------------------------------------------*/
 468
 469 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
 470 /* bleech -- resurfaced in 2.4.11 or 2.4.12 */
 471 #define bitmap  DeviceRemovable
 472
 473
 474 /*-------------------------------------------------------------------------*/
 475
 476 /* random stuff */
 477
 478 #define RUN_CONTEXT (in_irq() ? "in_irq" \
 479                 : (in_interrupt() ? "in_interrupt" : "can sleep"))
 480
 481
 482 /* This rwsem is for use only by the hub driver and ehci-hcd.
 483  * Nobody else should touch it.
 484  */
 485 extern struct rw_semaphore ehci_cf_port_reset_rwsem;
 486
 487 #endif /* __KERNEL__ */