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