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
  67         struct timer_list       rh_timer;       /* drives root hub */
  68
  69         /*
  70          * hardware info/state
  71          */
  72         const struct hc_driver  *driver;        /* hw-specific hooks */
  73         unsigned                saw_irq : 1;
  74         unsigned                can_wakeup:1;   /* hw supports wakeup? */
  75         unsigned                remote_wakeup:1;/* sw should use wakeup? */
  76         int                     irq;            /* irq allocated */
  77         void __iomem            *regs;          /* device memory/io */
  78
  79 #ifdef  CONFIG_PCI
  80         int                     region;         /* pci region for regs */
  81 #endif
  82
  83 #define HCD_BUFFER_POOLS        4
  84         struct dma_pool         *pool [HCD_BUFFER_POOLS];
  85
  86         int                     state;
  87 #       define  __ACTIVE                0x01
  88 #       define  __SUSPEND               0x04
  89 #       define  __TRANSIENT             0x80
  90
  91 #       define  USB_STATE_HALT          0
  92 #       define  USB_STATE_RUNNING       (__ACTIVE)
  93 #       define  USB_STATE_QUIESCING     (__SUSPEND|__TRANSIENT|__ACTIVE)
  94 #       define  USB_STATE_RESUMING      (__SUSPEND|__TRANSIENT)
  95 #       define  HCD_STATE_SUSPENDED     (__SUSPEND)
  96
  97 #define HCD_IS_RUNNING(state) ((state) & __ACTIVE)
  98 #define HCD_IS_SUSPENDED(state) ((state) & __SUSPEND)
  99
 100         /* more shared queuing code would be good; it should support
 101          * smarter scheduling, handle transaction translators, etc;
 102          * input size of periodic table to an interrupt scheduler.
 103          * (ohci 32, uhci 1024, ehci 256/512/1024).
 104          */
 105
 106         /* The HC driver's private data is stored at the end of
 107          * this structure.
 108          */
 109         unsigned long hcd_priv[0]
 110                         __attribute__ ((aligned (sizeof(unsigned long))));
 111 };
 112
 113 /* 2.4 does this a bit differently ... */
 114 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
 115 {
 116         return &hcd->self;
 117 }
 118
 119
 120 // urb.hcpriv is really hardware-specific
 121
 122 struct hcd_timeout {    /* timeouts we allocate */
 123         struct list_head        timeout_list;
 124         struct timer_list       timer;
 125 };
 126
 127 /*-------------------------------------------------------------------------*/
 128
 129 /*
 130  * FIXME usb_operations should vanish or become hc_driver,
 131  * when usb_bus and usb_hcd become the same thing.
 132  */
 133
 134 struct usb_operations {
 135         int (*get_frame_number) (struct usb_device *usb_dev);
 136         int (*submit_urb) (struct urb *urb, int mem_flags);
 137         int (*unlink_urb) (struct urb *urb, int status);
 138
 139         /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
 140         void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
 141                         int mem_flags,
 142                         dma_addr_t *dma);
 143         void (*buffer_free)(struct usb_bus *bus, size_t size,
 144                         void *addr, dma_addr_t dma);
 145
 146         void (*disable)(struct usb_device *udev,
 147                         struct usb_host_endpoint *ep);
 148
 149         /* global suspend/resume of bus */
 150         int (*hub_suspend)(struct usb_bus *);
 151         int (*hub_resume)(struct usb_bus *);
 152 };
 153
 154 /* each driver provides one of these, and hardware init support */
 155
 156 struct pt_regs;
 157
 158 struct hc_driver {
 159         const char      *description;   /* "ehci-hcd" etc */
 160         const char      *product_desc;  /* product/vendor string */
 161         size_t          hcd_priv_size;  /* size of private data */
 162
 163         /* irq handler */
 164         irqreturn_t     (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
 165
 166         int     flags;
 167 #define HCD_MEMORY      0x0001          /* HC regs use memory (else I/O) */
 168 #define HCD_USB11       0x0010          /* USB 1.1 */
 169 #define HCD_USB2        0x0020          /* USB 2.0 */
 170
 171         /* called to init HCD and root hub */
 172         int     (*reset) (struct usb_hcd *hcd);
 173         int     (*start) (struct usb_hcd *hcd);
 174
 175         /* NOTE:  these suspend/resume calls relate to the HC as
 176          * a whole, not just the root hub; they're for bus glue.
 177          */
 178         /* called after all devices were suspended */
 179         int     (*suspend) (struct usb_hcd *hcd, u32 state);
 180
 181         /* called before any devices get resumed */
 182         int     (*resume) (struct usb_hcd *hcd);
 183
 184         /* cleanly make HCD stop writing memory and doing I/O */
 185         void    (*stop) (struct usb_hcd *hcd);
 186
 187         /* return current frame number */
 188         int     (*get_frame_number) (struct usb_hcd *hcd);
 189
 190         /* manage i/o requests, device state */
 191         int     (*urb_enqueue) (struct usb_hcd *hcd,
 192                                         struct usb_host_endpoint *ep,
 193                                         struct urb *urb,
 194                                         int mem_flags);
 195         int     (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
 196
 197         /* hw synch, freeing endpoint resources that urb_dequeue can't */
 198         void    (*endpoint_disable)(struct usb_hcd *hcd,
 199                         struct usb_host_endpoint *ep);
 200
 201         /* root hub support */
 202         int             (*hub_status_data) (struct usb_hcd *hcd, char *buf);
 203         int             (*hub_control) (struct usb_hcd *hcd,
 204                                 u16 typeReq, u16 wValue, u16 wIndex,
 205                                 char *buf, u16 wLength);
 206         int             (*hub_suspend)(struct usb_hcd *);
 207         int             (*hub_resume)(struct usb_hcd *);
 208         int             (*start_port_reset)(struct usb_hcd *, unsigned port_num);
 209 };
 210
 211 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
 212 extern void usb_bus_init (struct usb_bus *bus);
 213
 214 extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver);
 215 extern void usb_put_hcd (struct usb_hcd *hcd);
 216
 217
 218 #ifdef CONFIG_PCI
 219 struct pci_dev;
 220 struct pci_device_id;
 221 extern int usb_hcd_pci_probe (struct pci_dev *dev,
 222                                 const struct pci_device_id *id);
 223 extern void usb_hcd_pci_remove (struct pci_dev *dev);
 224
 225 #ifdef CONFIG_PM
 226 extern int usb_hcd_pci_suspend (struct pci_dev *dev, u32 state);
 227 extern int usb_hcd_pci_resume (struct pci_dev *dev);
 228 #endif /* CONFIG_PM */
 229
 230 #endif /* CONFIG_PCI */
 231
 232 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
 233 int hcd_buffer_create (struct usb_hcd *hcd);
 234 void hcd_buffer_destroy (struct usb_hcd *hcd);
 235
 236 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
 237         int mem_flags, dma_addr_t *dma);
 238 void hcd_buffer_free (struct usb_bus *bus, size_t size,
 239         void *addr, dma_addr_t dma);
 240
 241 /* generic bus glue, needed for host controllers that don't use PCI */
 242 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
 243 extern void usb_hc_died (struct usb_hcd *hcd);
 244
 245 /* -------------------------------------------------------------------------- */
 246
 247 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
 248 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
 249                                         struct usb_bus *, unsigned port);
 250 extern int usb_new_device(struct usb_device *dev);
 251 extern void usb_disconnect(struct usb_device **);
 252
 253 extern int usb_get_configuration(struct usb_device *dev);
 254 extern void usb_destroy_configuration(struct usb_device *dev);
 255
 256 /*-------------------------------------------------------------------------*/
 257
 258 /*
 259  * HCD Root Hub support
 260  */
 261
 262 #include "hub.h"
 263
 264 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
 265 #define DeviceRequest \
 266         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 267 #define DeviceOutRequest \
 268         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 269
 270 #define InterfaceRequest \
 271         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 272
 273 #define EndpointRequest \
 274         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 275 #define EndpointOutRequest \
 276         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 277
 278 /* class requests from the USB 2.0 hub spec, table 11-15 */
 279 /* GetBusState and SetHubDescriptor are optional, omitted */
 280 #define ClearHubFeature         (0x2000 | USB_REQ_CLEAR_FEATURE)
 281 #define ClearPortFeature        (0x2300 | USB_REQ_CLEAR_FEATURE)
 282 #define GetHubDescriptor        (0xa000 | USB_REQ_GET_DESCRIPTOR)
 283 #define GetHubStatus            (0xa000 | USB_REQ_GET_STATUS)
 284 #define GetPortStatus           (0xa300 | USB_REQ_GET_STATUS)
 285 #define SetHubFeature           (0x2000 | USB_REQ_SET_FEATURE)
 286 #define SetPortFeature          (0x2300 | USB_REQ_SET_FEATURE)
 287
 288
 289 /*-------------------------------------------------------------------------*/
 290
 291 /*
 292  * Generic bandwidth allocation constants/support
 293  */
 294 #define FRAME_TIME_USECS        1000L
 295 #define BitTime(bytecount)  (7 * 8 * bytecount / 6)  /* with integer truncation */
 296                 /* Trying not to use worst-case bit-stuffing
 297                    of (7/6 * 8 * bytecount) = 9.33 * bytecount */
 298                 /* bytecount = data payload byte count */
 299
 300 #define NS_TO_US(ns)    ((ns + 500L) / 1000L)
 301                         /* convert & round nanoseconds to microseconds */
 302
 303 extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
 304                 int bustime, int isoc);
 305 extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
 306                 int isoc);
 307
 308 /*
 309  * Full/low speed bandwidth allocation constants/support.
 310  */
 311 #define BW_HOST_DELAY   1000L           /* nanoseconds */
 312 #define BW_HUB_LS_SETUP 333L            /* nanoseconds */
 313                         /* 4 full-speed bit times (est.) */
 314
 315 #define FRAME_TIME_BITS         12000L          /* frame = 1 millisecond */
 316 #define FRAME_TIME_MAX_BITS_ALLOC       (90L * FRAME_TIME_BITS / 100L)
 317 #define FRAME_TIME_MAX_USECS_ALLOC      (90L * FRAME_TIME_USECS / 100L)
 318
 319 extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
 320
 321 /*
 322  * Ceiling microseconds (typical) for that many bytes at high speed
 323  * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
 324  * to preallocate bandwidth)
 325  */
 326 #define USB2_HOST_DELAY 5       /* nsec, guess */
 327 #define HS_USECS(bytes) NS_TO_US ( ((55 * 8 * 2083)/1000) \
 328         + ((2083UL * (3167 + BitTime (bytes)))/1000) \
 329         + USB2_HOST_DELAY)
 330 #define HS_USECS_ISO(bytes) NS_TO_US ( ((38 * 8 * 2083)/1000) \
 331         + ((2083UL * (3167 + BitTime (bytes)))/1000) \
 332         + USB2_HOST_DELAY)
 333
 334 extern long usb_calc_bus_time (int speed, int is_input,
 335                         int isoc, int bytecount);
 336
 337 /*-------------------------------------------------------------------------*/
 338
 339 extern struct usb_bus *usb_alloc_bus (struct usb_operations *);
 340
 341 extern int usb_register_bus (struct usb_bus *);
 342 extern void usb_deregister_bus (struct usb_bus *);
 343
 344 extern int usb_register_root_hub (struct usb_device *usb_dev,
 345                 struct device *parent_dev);
 346
 347 static inline int hcd_register_root (struct usb_device *usb_dev,
 348                 struct usb_hcd *hcd)
 349 {
 350         /* hcd->driver->start() reported can_wakeup, probably with
 351          * assistance from board's boot firmware.
 352          * NOTE:  normal devices won't enable wakeup by default.
 353          */
 354         if (hcd->can_wakeup)
 355                 dev_dbg (hcd->self.controller, "supports USB remote wakeup\n");
 356         hcd->remote_wakeup = hcd->can_wakeup;
 357
 358         return usb_register_root_hub (usb_dev, hcd->self.controller);
 359 }
 360
 361 extern void usb_set_device_state(struct usb_device *udev,
 362                 enum usb_device_state new_state);
 363
 364 /*-------------------------------------------------------------------------*/
 365
 366 /* exported only within usbcore */
 367
 368 extern struct list_head usb_bus_list;
 369 extern struct semaphore usb_bus_list_lock;
 370 extern wait_queue_head_t usb_kill_urb_queue;
 371
 372 extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
 373 extern void usb_bus_put (struct usb_bus *bus);
 374
 375 extern int usb_find_interface_driver (struct usb_device *dev,
 376         struct usb_interface *interface);
 377
 378 #define usb_endpoint_out(ep_dir)        (!((ep_dir) & USB_DIR_IN))
 379
 380 /*
 381  * USB device fs stuff
 382  */
 383
 384 #ifdef CONFIG_USB_DEVICEFS
 385
 386 /*
 387  * these are expected to be called from the USB core/hub thread
 388  * with the kernel lock held
 389  */
 390 extern void usbfs_add_bus(struct usb_bus *bus);
 391 extern void usbfs_remove_bus(struct usb_bus *bus);
 392 extern void usbfs_add_device(struct usb_device *dev);
 393 extern void usbfs_remove_device(struct usb_device *dev);
 394 extern void usbfs_update_special (void);
 395
 396 extern int usbfs_init(void);
 397 extern void usbfs_cleanup(void);
 398
 399 #else /* CONFIG_USB_DEVICEFS */
 400
 401 static inline void usbfs_add_bus(struct usb_bus *bus) {}
 402 static inline void usbfs_remove_bus(struct usb_bus *bus) {}
 403 static inline void usbfs_add_device(struct usb_device *dev) {}
 404 static inline void usbfs_remove_device(struct usb_device *dev) {}
 405 static inline void usbfs_update_special (void) {}
 406
 407 static inline int usbfs_init(void) { return 0; }
 408 static inline void usbfs_cleanup(void) { }
 409
 410 #endif /* CONFIG_USB_DEVICEFS */
 411
 412 /*-------------------------------------------------------------------------*/
 413
 414 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
 415 // bleech -- resurfaced in 2.4.11 or 2.4.12
 416 #define bitmap  DeviceRemovable
 417
 418
 419 /*-------------------------------------------------------------------------*/
 420
 421 /* random stuff */
 422
 423 #define RUN_CONTEXT (in_irq () ? "in_irq" \
 424                 : (in_interrupt () ? "in_interrupt" : "can sleep"))
 425
 426
 427 #endif /* __KERNEL__ */
 428