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         const char              *description;   /* "ehci-hcd" etc */
  67
  68         struct timer_list       rh_timer;       /* drives root hub */
  69         struct list_head        dev_list;       /* devices on this bus */
  70
  71         /*
  72          * hardware info/state
  73          */
  74         struct hc_driver        *driver;        /* hw-specific hooks */
  75         unsigned                saw_irq : 1;
  76         unsigned                can_wakeup:1;   /* hw supports wakeup? */
  77         unsigned                remote_wakeup:1;/* sw should use wakeup? */
  78         int                     irq;            /* irq allocated */
  79         void __iomem            *regs;          /* device memory/io */
  80
  81 #ifdef  CONFIG_PCI
  82         int                     region;         /* pci region for regs */
  83 #endif
  84
  85 #define HCD_BUFFER_POOLS        4
  86         struct dma_pool         *pool [HCD_BUFFER_POOLS];
  87
  88         int                     state;
  89 #       define  __ACTIVE                0x01
  90 #       define  __SUSPEND               0x04
  91 #       define  __TRANSIENT             0x80
  92
  93 #       define  USB_STATE_HALT          0
  94 #       define  USB_STATE_RUNNING       (__ACTIVE)
  95 #       define  USB_STATE_QUIESCING     (__SUSPEND|__TRANSIENT|__ACTIVE)
  96 #       define  USB_STATE_RESUMING      (__SUSPEND|__TRANSIENT)
  97 #       define  HCD_STATE_SUSPENDED     (__SUSPEND)
  98
  99 #define HCD_IS_RUNNING(state) ((state) & __ACTIVE)
 100 #define HCD_IS_SUSPENDED(state) ((state) & __SUSPEND)
 101
 102         /* more shared queuing code would be good; it should support
 103          * smarter scheduling, handle transaction translators, etc;
 104          * input size of periodic table to an interrupt scheduler.
 105          * (ohci 32, uhci 1024, ehci 256/512/1024).
 106          */
 107 };
 108
 109 /* 2.4 does this a bit differently ... */
 110 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
 111 {
 112         return &hcd->self;
 113 }
 114
 115
 116 struct hcd_dev {        /* usb_device.hcpriv points to this */
 117         struct list_head        dev_list;       /* on this hcd */
 118         struct list_head        urb_list;       /* pending on this dev */
 119
 120         /* per-configuration HC/HCD state, such as QH or ED */
 121         void                    *ep[32];
 122 };
 123
 124 // urb.hcpriv is really hardware-specific
 125
 126 struct hcd_timeout {    /* timeouts we allocate */
 127         struct list_head        timeout_list;
 128         struct timer_list       timer;
 129 };
 130
 131 /*-------------------------------------------------------------------------*/
 132
 133 /*
 134  * FIXME usb_operations should vanish or become hc_driver,
 135  * when usb_bus and usb_hcd become the same thing.
 136  */
 137
 138 struct usb_operations {
 139         int (*allocate)(struct usb_device *);
 140         int (*deallocate)(struct usb_device *);
 141         int (*get_frame_number) (struct usb_device *usb_dev);
 142         int (*submit_urb) (struct urb *urb, int mem_flags);
 143         int (*unlink_urb) (struct urb *urb, int status);
 144
 145         /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
 146         void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
 147                         int mem_flags,
 148                         dma_addr_t *dma);
 149         void (*buffer_free)(struct usb_bus *bus, size_t size,
 150                         void *addr, dma_addr_t dma);
 151
 152         void (*disable)(struct usb_device *udev, int bEndpointAddress);
 153
 154         /* global suspend/resume of bus */
 155         int (*hub_suspend)(struct usb_bus *);
 156         int (*hub_resume)(struct usb_bus *);
 157 };
 158
 159 /* each driver provides one of these, and hardware init support */
 160
 161 struct pt_regs;
 162
 163 struct hc_driver {
 164         const char      *description;   /* "ehci-hcd" etc */
 165
 166         /* irq handler */
 167         irqreturn_t     (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
 168
 169         int     flags;
 170 #define HCD_MEMORY      0x0001          /* HC regs use memory (else I/O) */
 171 #define HCD_USB11       0x0010          /* USB 1.1 */
 172 #define HCD_USB2        0x0020          /* USB 2.0 */
 173
 174         /* called to init HCD and root hub */
 175         int     (*reset) (struct usb_hcd *hcd);
 176         int     (*start) (struct usb_hcd *hcd);
 177
 178         /* NOTE:  these suspend/resume calls relate to the HC as
 179          * a whole, not just the root hub; they're for bus glue.
 180          */
 181         /* called after all devices were suspended */
 182         int     (*suspend) (struct usb_hcd *hcd, u32 state);
 183
 184         /* called before any devices get resumed */
 185         int     (*resume) (struct usb_hcd *hcd);
 186
 187         /* cleanly make HCD stop writing memory and doing I/O */
 188         void    (*stop) (struct usb_hcd *hcd);
 189
 190         /* return current frame number */
 191         int     (*get_frame_number) (struct usb_hcd *hcd);
 192
 193         /* memory lifecycle */
 194         /* Note: The absence of hcd_free reflects a temporary situation;
 195          * in the near future hcd_alloc will disappear as well and all
 196          * allocations/deallocations will be handled by usbcore.  For the
 197          * moment, drivers are required to return a pointer that the core
 198          * can pass to kfree, i.e., the struct usb_hcd must be the _first_
 199          * member of a larger driver-specific structure. */
 200         struct usb_hcd  *(*hcd_alloc) (void);
 201
 202         /* manage i/o requests, device state */
 203         int     (*urb_enqueue) (struct usb_hcd *hcd, struct urb *urb,
 204                                         int mem_flags);
 205         int     (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
 206
 207         /* hw synch, freeing endpoint resources that urb_dequeue can't */
 208         void    (*endpoint_disable)(struct usb_hcd *hcd,
 209                         struct hcd_dev *dev, int bEndpointAddress);
 210
 211         /* root hub support */
 212         int             (*hub_status_data) (struct usb_hcd *hcd, char *buf);
 213         int             (*hub_control) (struct usb_hcd *hcd,
 214                                 u16 typeReq, u16 wValue, u16 wIndex,
 215                                 char *buf, u16 wLength);
 216         int             (*hub_suspend)(struct usb_hcd *);
 217         int             (*hub_resume)(struct usb_hcd *);
 218         int             (*start_port_reset)(struct usb_hcd *, unsigned port_num);
 219 };
 220
 221 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
 222 extern void usb_bus_init (struct usb_bus *bus);
 223
 224 #ifdef CONFIG_PCI
 225 struct pci_dev;
 226 struct pci_device_id;
 227 extern int usb_hcd_pci_probe (struct pci_dev *dev,
 228                                 const struct pci_device_id *id);
 229 extern void usb_hcd_pci_remove (struct pci_dev *dev);
 230
 231 #ifdef CONFIG_PM
 232 extern int usb_hcd_pci_suspend (struct pci_dev *dev, u32 state);
 233 extern int usb_hcd_pci_resume (struct pci_dev *dev);
 234 #endif /* CONFIG_PM */
 235
 236 #endif /* CONFIG_PCI */
 237
 238 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
 239 int hcd_buffer_create (struct usb_hcd *hcd);
 240 void hcd_buffer_destroy (struct usb_hcd *hcd);
 241
 242 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
 243         int mem_flags, dma_addr_t *dma);
 244 void hcd_buffer_free (struct usb_bus *bus, size_t size,
 245         void *addr, dma_addr_t dma);
 246
 247 /* generic bus glue, needed for host controllers that don't use PCI */
 248 extern struct usb_operations usb_hcd_operations;
 249 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
 250 extern void usb_hc_died (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 microseconds (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_USECS(bytes) NS_TO_US ( ((55 * 8 * 2083)/1000) \
 335         + ((2083UL * (3167 + BitTime (bytes)))/1000) \
 336         + USB2_HOST_DELAY)
 337 #define HS_USECS_ISO(bytes) NS_TO_US ( ((38 * 8 * 2083)/1000) \
 338         + ((2083UL * (3167 + BitTime (bytes)))/1000) \
 339         + USB2_HOST_DELAY)
 340
 341 extern long usb_calc_bus_time (int speed, int is_input,
 342                         int isoc, int bytecount);
 343
 344 /*-------------------------------------------------------------------------*/
 345
 346 extern struct usb_bus *usb_alloc_bus (struct usb_operations *);
 347
 348 extern int usb_register_bus (struct usb_bus *);
 349 extern void usb_deregister_bus (struct usb_bus *);
 350
 351 extern int usb_register_root_hub (struct usb_device *usb_dev,
 352                 struct device *parent_dev);
 353
 354 static inline int hcd_register_root (struct usb_device *usb_dev,
 355                 struct usb_hcd *hcd)
 356 {
 357         /* hcd->driver->start() reported can_wakeup, probably with
 358          * assistance from board's boot firmware.
 359          * NOTE:  normal devices won't enable wakeup by default.
 360          */
 361         if (hcd->can_wakeup)
 362                 dev_dbg (hcd->self.controller, "supports USB remote wakeup\n");
 363         hcd->remote_wakeup = hcd->can_wakeup;
 364
 365         return usb_register_root_hub (usb_dev, hcd->self.controller);
 366 }
 367
 368 extern void usb_hcd_release (struct usb_bus *);
 369
 370 extern void usb_set_device_state(struct usb_device *udev,
 371                 enum usb_device_state new_state);
 372
 373 /*-------------------------------------------------------------------------*/
 374
 375 /* exported only within usbcore */
 376
 377 extern struct list_head usb_bus_list;
 378 extern struct semaphore usb_bus_list_lock;
 379 extern wait_queue_head_t usb_kill_urb_queue;
 380
 381 extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
 382 extern void usb_bus_put (struct usb_bus *bus);
 383
 384 extern int usb_find_interface_driver (struct usb_device *dev,
 385         struct usb_interface *interface);
 386
 387 #define usb_endpoint_out(ep_dir)        (!((ep_dir) & USB_DIR_IN))
 388
 389 /*
 390  * USB device fs stuff
 391  */
 392
 393 #ifdef CONFIG_USB_DEVICEFS
 394
 395 /*
 396  * these are expected to be called from the USB core/hub thread
 397  * with the kernel lock held
 398  */
 399 extern void usbfs_add_bus(struct usb_bus *bus);
 400 extern void usbfs_remove_bus(struct usb_bus *bus);
 401 extern void usbfs_add_device(struct usb_device *dev);
 402 extern void usbfs_remove_device(struct usb_device *dev);
 403 extern void usbfs_update_special (void);
 404
 405 extern int usbfs_init(void);
 406 extern void usbfs_cleanup(void);
 407
 408 #else /* CONFIG_USB_DEVICEFS */
 409
 410 static inline void usbfs_add_bus(struct usb_bus *bus) {}
 411 static inline void usbfs_remove_bus(struct usb_bus *bus) {}
 412 static inline void usbfs_add_device(struct usb_device *dev) {}
 413 static inline void usbfs_remove_device(struct usb_device *dev) {}
 414 static inline void usbfs_update_special (void) {}
 415
 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 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
 424 // bleech -- resurfaced in 2.4.11 or 2.4.12
 425 #define bitmap  DeviceRemovable
 426
 427
 428 /*-------------------------------------------------------------------------*/
 429
 430 /* random stuff */
 431
 432 #define RUN_CONTEXT (in_irq () ? "in_irq" \
 433                 : (in_interrupt () ? "in_interrupt" : "can sleep"))
 434
 435
 436 #endif /* __KERNEL__ */
 437