SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 struct pt_regs;
 144
 145 struct hc_driver {
 146         const char      *description;   /* "ehci-hcd" etc */
 147         const char      *product_desc;  /* product/vendor string */
 148         size_t          hcd_priv_size;  /* size of private data */
 149
 150         /* irq handler */
 151         irqreturn_t     (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
 152
 153         int     flags;
 154 #define HCD_MEMORY      0x0001          /* HC regs use memory (else I/O) */
 155 #define HCD_USB11       0x0010          /* USB 1.1 */
 156 #define HCD_USB2        0x0020          /* USB 2.0 */
 157
 158         /* called to init HCD and root hub */
 159         int     (*reset) (struct usb_hcd *hcd);
 160         int     (*start) (struct usb_hcd *hcd);
 161
 162         /* NOTE:  these suspend/resume calls relate to the HC as
 163          * a whole, not just the root hub; they're for PCI bus glue.
 164          */
 165         /* called after suspending the hub, before entering D3 etc */
 166         int     (*suspend) (struct usb_hcd *hcd, pm_message_t message);
 167
 168         /* called after entering D0 (etc), before resuming the hub */
 169         int     (*resume) (struct usb_hcd *hcd);
 170
 171         /* cleanly make HCD stop writing memory and doing I/O */
 172         void    (*stop) (struct usb_hcd *hcd);
 173
 174         /* shutdown HCD */
 175         void    (*shutdown) (struct usb_hcd *hcd);
 176
 177         /* return current frame number */
 178         int     (*get_frame_number) (struct usb_hcd *hcd);
 179
 180         /* manage i/o requests, device state */
 181         int     (*urb_enqueue) (struct usb_hcd *hcd,
 182                                         struct usb_host_endpoint *ep,
 183                                         struct urb *urb,
 184                                         gfp_t mem_flags);
 185         int     (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
 186
 187         /* hw synch, freeing endpoint resources that urb_dequeue can't */
 188         void    (*endpoint_disable)(struct usb_hcd *hcd,
 189                         struct usb_host_endpoint *ep);
 190
 191         /* root hub support */
 192         int             (*hub_status_data) (struct usb_hcd *hcd, char *buf);
 193         int             (*hub_control) (struct usb_hcd *hcd,
 194                                 u16 typeReq, u16 wValue, u16 wIndex,
 195                                 char *buf, u16 wLength);
 196         int             (*bus_suspend)(struct usb_hcd *);
 197         int             (*bus_resume)(struct usb_hcd *);
 198         int             (*start_port_reset)(struct usb_hcd *, unsigned port_num);
 199         void            (*hub_irq_enable)(struct usb_hcd *);
 200                 /* Needed only if port-change IRQs are level-triggered */
 201 };
 202
 203 extern int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags);
 204 extern int usb_hcd_unlink_urb (struct urb *urb, int status);
 205 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb,
 206                 struct pt_regs *regs);
 207 extern void usb_hcd_endpoint_disable (struct usb_device *udev,
 208                 struct usb_host_endpoint *ep);
 209 extern int usb_hcd_get_frame_number (struct usb_device *udev);
 210
 211 extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
 212                 struct device *dev, char *bus_name);
 213 extern void usb_put_hcd (struct usb_hcd *hcd);
 214 extern int usb_add_hcd(struct usb_hcd *hcd,
 215                 unsigned int irqnum, unsigned long irqflags);
 216 extern void usb_remove_hcd(struct usb_hcd *hcd);
 217
 218 struct platform_device;
 219 extern void usb_hcd_platform_shutdown(struct platform_device* dev);
 220
 221 #ifdef CONFIG_PCI
 222 struct pci_dev;
 223 struct pci_device_id;
 224 extern int usb_hcd_pci_probe (struct pci_dev *dev,
 225                                 const struct pci_device_id *id);
 226 extern void usb_hcd_pci_remove (struct pci_dev *dev);
 227
 228 #ifdef CONFIG_PM
 229 extern int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t state);
 230 extern int usb_hcd_pci_resume (struct pci_dev *dev);
 231 #endif /* CONFIG_PM */
 232
 233 extern void usb_hcd_pci_shutdown (struct pci_dev *dev);
 234
 235 #endif /* CONFIG_PCI */
 236
 237 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
 238 int hcd_buffer_create (struct usb_hcd *hcd);
 239 void hcd_buffer_destroy (struct usb_hcd *hcd);
 240
 241 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
 242         gfp_t mem_flags, dma_addr_t *dma);
 243 void hcd_buffer_free (struct usb_bus *bus, size_t size,
 244         void *addr, dma_addr_t dma);
 245
 246 /* generic bus glue, needed for host controllers that don't use PCI */
 247 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
 248
 249 extern void usb_hc_died (struct usb_hcd *hcd);
 250 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
 251
 252 /* -------------------------------------------------------------------------- */
 253
 254 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
 255 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
 256                                         struct usb_bus *, unsigned port);
 257 extern int usb_new_device(struct usb_device *dev);
 258 extern void usb_disconnect(struct usb_device **);
 259
 260 extern int usb_get_configuration(struct usb_device *dev);
 261 extern void usb_destroy_configuration(struct usb_device *dev);
 262
 263 /*-------------------------------------------------------------------------*/
 264
 265 /*
 266  * HCD Root Hub support
 267  */
 268
 269 #include "hub.h"
 270
 271 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
 272 #define DeviceRequest \
 273         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 274 #define DeviceOutRequest \
 275         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 276
 277 #define InterfaceRequest \
 278         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 279
 280 #define EndpointRequest \
 281         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 282 #define EndpointOutRequest \
 283         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 284
 285 /* class requests from the USB 2.0 hub spec, table 11-15 */
 286 /* GetBusState and SetHubDescriptor are optional, omitted */
 287 #define ClearHubFeature         (0x2000 | USB_REQ_CLEAR_FEATURE)
 288 #define ClearPortFeature        (0x2300 | USB_REQ_CLEAR_FEATURE)
 289 #define GetHubDescriptor        (0xa000 | USB_REQ_GET_DESCRIPTOR)
 290 #define GetHubStatus            (0xa000 | USB_REQ_GET_STATUS)
 291 #define GetPortStatus           (0xa300 | USB_REQ_GET_STATUS)
 292 #define SetHubFeature           (0x2000 | USB_REQ_SET_FEATURE)
 293 #define SetPortFeature          (0x2300 | USB_REQ_SET_FEATURE)
 294
 295
 296 /*-------------------------------------------------------------------------*/
 297
 298 /*
 299  * Generic bandwidth allocation constants/support
 300  */
 301 #define FRAME_TIME_USECS        1000L
 302 #define BitTime(bytecount)  (7 * 8 * bytecount / 6)  /* with integer truncation */
 303                 /* Trying not to use worst-case bit-stuffing
 304                    of (7/6 * 8 * bytecount) = 9.33 * bytecount */
 305                 /* bytecount = data payload byte count */
 306
 307 #define NS_TO_US(ns)    ((ns + 500L) / 1000L)
 308                         /* convert & round nanoseconds to microseconds */
 309
 310 extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
 311                 int bustime, int isoc);
 312 extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
 313                 int isoc);
 314
 315 /*
 316  * Full/low speed bandwidth allocation constants/support.
 317  */
 318 #define BW_HOST_DELAY   1000L           /* nanoseconds */
 319 #define BW_HUB_LS_SETUP 333L            /* nanoseconds */
 320                         /* 4 full-speed bit times (est.) */
 321
 322 #define FRAME_TIME_BITS         12000L          /* frame = 1 millisecond */
 323 #define FRAME_TIME_MAX_BITS_ALLOC       (90L * FRAME_TIME_BITS / 100L)
 324 #define FRAME_TIME_MAX_USECS_ALLOC      (90L * FRAME_TIME_USECS / 100L)
 325
 326 extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
 327
 328 /*
 329  * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
 330  * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
 331  * to preallocate bandwidth)
 332  */
 333 #define USB2_HOST_DELAY 5       /* nsec, guess */
 334 #define HS_NSECS(bytes) ( ((55 * 8 * 2083) \
 335         + (2083UL * (3 + BitTime(bytes))))/1000 \
 336         + USB2_HOST_DELAY)
 337 #define HS_NSECS_ISO(bytes) ( ((38 * 8 * 2083) \
 338         + (2083UL * (3 + BitTime(bytes))))/1000 \
 339         + USB2_HOST_DELAY)
 340 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
 341 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
 342
 343 extern long usb_calc_bus_time (int speed, int is_input,
 344                         int isoc, int bytecount);
 345
 346 /*-------------------------------------------------------------------------*/
 347
 348 extern void usb_set_device_state(struct usb_device *udev,
 349                 enum usb_device_state new_state);
 350
 351 /*-------------------------------------------------------------------------*/
 352
 353 /* exported only within usbcore */
 354
 355 extern struct list_head usb_bus_list;
 356 extern struct mutex usb_bus_list_lock;
 357 extern wait_queue_head_t usb_kill_urb_queue;
 358
 359 extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
 360 extern void usb_bus_put (struct usb_bus *bus);
 361
 362 extern void usb_enable_root_hub_irq (struct usb_bus *bus);
 363
 364 extern int usb_find_interface_driver (struct usb_device *dev,
 365         struct usb_interface *interface);
 366
 367 #define usb_endpoint_out(ep_dir)        (!((ep_dir) & USB_DIR_IN))
 368
 369 #ifdef CONFIG_PM
 370 extern void usb_hcd_suspend_root_hub (struct usb_hcd *hcd);
 371 extern void usb_hcd_resume_root_hub (struct usb_hcd *hcd);
 372 extern void usb_root_hub_lost_power (struct usb_device *rhdev);
 373 extern int hcd_bus_suspend (struct usb_bus *bus);
 374 extern int hcd_bus_resume (struct usb_bus *bus);
 375 #else
 376 static inline void usb_hcd_suspend_root_hub(struct usb_hcd *hcd)
 377 {
 378         return;
 379 }
 380
 381 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
 382 {
 383         return;
 384 }
 385
 386 static inline int hcd_bus_suspend(struct usb_bus *bus)
 387 {
 388         return 0;
 389 }
 390
 391 static inline int hcd_bus_resume (struct usb_bus *bus)
 392 {
 393         return 0;
 394 }
 395 #endif /* CONFIG_PM */
 396
 397 /*
 398  * USB device fs stuff
 399  */
 400
 401 #ifdef CONFIG_USB_DEVICEFS
 402
 403 /*
 404  * these are expected to be called from the USB core/hub thread
 405  * with the kernel lock held
 406  */
 407 extern void usbfs_update_special (void);
 408 extern int usbfs_init(void);
 409 extern void usbfs_cleanup(void);
 410
 411 #else /* CONFIG_USB_DEVICEFS */
 412
 413 static inline void usbfs_update_special (void) {}
 414 static inline int usbfs_init(void) { return 0; }
 415 static inline void usbfs_cleanup(void) { }
 416
 417 #endif /* CONFIG_USB_DEVICEFS */
 418
 419 /*-------------------------------------------------------------------------*/
 420
 421 #if defined(CONFIG_USB_MON)
 422
 423 struct usb_mon_operations {
 424         void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
 425         void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
 426         void (*urb_complete)(struct usb_bus *bus, struct urb *urb);
 427         /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
 428 };
 429
 430 extern struct usb_mon_operations *mon_ops;
 431
 432 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
 433 {
 434         if (bus->monitored)
 435                 (*mon_ops->urb_submit)(bus, urb);
 436 }
 437
 438 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
 439     int error)
 440 {
 441         if (bus->monitored)
 442                 (*mon_ops->urb_submit_error)(bus, urb, error);
 443 }
 444
 445 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb)
 446 {
 447         if (bus->monitored)
 448                 (*mon_ops->urb_complete)(bus, urb);
 449 }
 450
 451 int usb_mon_register(struct usb_mon_operations *ops);
 452 void usb_mon_deregister(void);
 453
 454 #else
 455
 456 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
 457 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
 458     int error) {}
 459 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb) {}
 460
 461 #endif /* CONFIG_USB_MON */
 462
 463 /*-------------------------------------------------------------------------*/
 464
 465 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
 466 // bleech -- resurfaced in 2.4.11 or 2.4.12
 467 #define bitmap  DeviceRemovable
 468
 469
 470 /*-------------------------------------------------------------------------*/
 471
 472 /* random stuff */
 473
 474 #define RUN_CONTEXT (in_irq () ? "in_irq" \
 475                 : (in_interrupt () ? "in_interrupt" : "can sleep"))
 476
 477
 478 #endif /* __KERNEL__ */
 479