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