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         struct work_struct      work;
  71
  72         /*
  73          * hardware info/state
  74          */
  75         struct hc_driver        *driver;        /* hw-specific hooks */
  76         unsigned                saw_irq : 1;
  77         unsigned                can_wakeup:1;   /* hw supports wakeup? */
  78         unsigned                remote_wakeup:1;/* sw should use wakeup? */
  79         int                     irq;            /* irq allocated */
  80         void                    *regs;          /* device memory/io */
  81
  82 #ifdef  CONFIG_PCI
  83         int                     region;         /* pci region for regs */
  84         u32                     pci_state [16]; /* for PM state save */
  85 #endif
  86
  87 #define HCD_BUFFER_POOLS        4
  88         struct dma_pool         *pool [HCD_BUFFER_POOLS];
  89
  90         int                     state;
  91 #       define  __ACTIVE                0x01
  92 #       define  __SUSPEND               0x04
  93 #       define  __TRANSIENT             0x80
  94
  95 #       define  USB_STATE_HALT          0
  96 #       define  USB_STATE_RUNNING       (__ACTIVE)
  97 #       define  USB_STATE_QUIESCING     (__SUSPEND|__TRANSIENT|__ACTIVE)
  98 #       define  USB_STATE_RESUMING      (__SUSPEND|__TRANSIENT)
  99 #       define  HCD_STATE_SUSPENDED     (__SUSPEND)
 100
 101 #define HCD_IS_RUNNING(state) ((state) & __ACTIVE)
 102 #define HCD_IS_SUSPENDED(state) ((state) & __SUSPEND)
 103
 104         /* more shared queuing code would be good; it should support
 105          * smarter scheduling, handle transaction translators, etc;
 106          * input size of periodic table to an interrupt scheduler.
 107          * (ohci 32, uhci 1024, ehci 256/512/1024).
 108          */
 109 };
 110
 111 /* 2.4 does this a bit differently ... */
 112 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
 113 {
 114         return &hcd->self;
 115 }
 116
 117
 118 struct hcd_dev {        /* usb_device.hcpriv points to this */
 119         struct list_head        dev_list;       /* on this hcd */
 120         struct list_head        urb_list;       /* pending on this dev */
 121
 122         /* per-configuration HC/HCD state, such as QH or ED */
 123         void                    *ep[32];
 124 };
 125
 126 // urb.hcpriv is really hardware-specific
 127
 128 struct hcd_timeout {    /* timeouts we allocate */
 129         struct list_head        timeout_list;
 130         struct timer_list       timer;
 131 };
 132
 133 /*-------------------------------------------------------------------------*/
 134
 135 /*
 136  * FIXME usb_operations should vanish or become hc_driver,
 137  * when usb_bus and usb_hcd become the same thing.
 138  */
 139
 140 struct usb_operations {
 141         int (*allocate)(struct usb_device *);
 142         int (*deallocate)(struct usb_device *);
 143         int (*get_frame_number) (struct usb_device *usb_dev);
 144         int (*submit_urb) (struct urb *urb, int mem_flags);
 145         int (*unlink_urb) (struct urb *urb);
 146
 147         /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
 148         void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
 149                         int mem_flags,
 150                         dma_addr_t *dma);
 151         void (*buffer_free)(struct usb_bus *bus, size_t size,
 152                         void *addr, dma_addr_t dma);
 153
 154         void (*disable)(struct usb_device *udev, int bEndpointAddress);
 155 };
 156
 157 /* each driver provides one of these, and hardware init support */
 158
 159 struct pt_regs;
 160
 161 struct hc_driver {
 162         const char      *description;   /* "ehci-hcd" etc */
 163
 164         /* irq handler */
 165         irqreturn_t     (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
 166
 167         int     flags;
 168 #define HCD_MEMORY      0x0001          /* HC regs use memory (else I/O) */
 169 #define HCD_USB11       0x0010          /* USB 1.1 */
 170 #define HCD_USB2        0x0020          /* USB 2.0 */
 171
 172         /* called to init HCD and root hub */
 173         int     (*reset) (struct usb_hcd *hcd);
 174         int     (*start) (struct usb_hcd *hcd);
 175
 176         /* called after all devices were suspended */
 177         int     (*suspend) (struct usb_hcd *hcd, u32 state);
 178
 179         /* called before any devices get resumed */
 180         int     (*resume) (struct usb_hcd *hcd);
 181
 182         /* cleanly make HCD stop writing memory and doing I/O */
 183         void    (*stop) (struct usb_hcd *hcd);
 184
 185         /* return current frame number */
 186         int     (*get_frame_number) (struct usb_hcd *hcd);
 187
 188         /* memory lifecycle */
 189         struct usb_hcd  *(*hcd_alloc) (void);
 190         void            (*hcd_free) (struct usb_hcd *hcd);
 191
 192         /* manage i/o requests, device state */
 193         int     (*urb_enqueue) (struct usb_hcd *hcd, 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 hcd_dev *dev, int bEndpointAddress);
 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 };
 207
 208 extern void usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
 209 extern void usb_bus_init (struct usb_bus *bus);
 210 extern void usb_rh_status_dequeue (struct usb_hcd *hcd, struct urb *urb);
 211
 212 #ifdef CONFIG_PCI
 213 struct pci_dev;
 214 struct pci_device_id;
 215 extern int usb_hcd_pci_probe (struct pci_dev *dev,
 216                                 const struct pci_device_id *id);
 217 extern void usb_hcd_pci_remove (struct pci_dev *dev);
 218
 219 #ifdef CONFIG_PM
 220 extern int usb_hcd_pci_suspend (struct pci_dev *dev, u32 state);
 221 extern int usb_hcd_pci_resume (struct pci_dev *dev);
 222 #endif /* CONFIG_PM */
 223
 224 #endif /* CONFIG_PCI */
 225
 226 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
 227 int hcd_buffer_create (struct usb_hcd *hcd);
 228 void hcd_buffer_destroy (struct usb_hcd *hcd);
 229
 230 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
 231         int mem_flags, dma_addr_t *dma);
 232 void hcd_buffer_free (struct usb_bus *bus, size_t size,
 233         void *addr, dma_addr_t dma);
 234
 235 /* generic bus glue, needed for host controllers that don't use PCI */
 236 extern struct usb_operations usb_hcd_operations;
 237 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
 238 extern void usb_hc_died (struct usb_hcd *hcd);
 239
 240 /* -------------------------------------------------------------------------- */
 241
 242 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
 243 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
 244                                         struct usb_bus *, unsigned port);
 245 extern int usb_new_device(struct usb_device *dev);
 246 extern void usb_disconnect(struct usb_device **);
 247 extern void usb_choose_address(struct usb_device *dev);
 248 extern void usb_release_address(struct usb_device *dev);
 249
 250 /* exported to hub driver ONLY to support usb_reset_device () */
 251 extern int usb_get_configuration(struct usb_device *dev);
 252 extern void usb_destroy_configuration(struct usb_device *dev);
 253
 254 /* use these only before the device's address has been set */
 255 #define usb_snddefctrl(dev)             ((PIPE_CONTROL << 30))
 256 #define usb_rcvdefctrl(dev)             ((PIPE_CONTROL << 30) | USB_DIR_IN)
 257
 258 /*-------------------------------------------------------------------------*/
 259
 260 /*
 261  * HCD Root Hub support
 262  */
 263
 264 #include "hub.h"
 265
 266 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
 267 #define DeviceRequest \
 268         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 269 #define DeviceOutRequest \
 270         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 271
 272 #define InterfaceRequest \
 273         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 274
 275 #define EndpointRequest \
 276         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 277 #define EndpointOutRequest \
 278         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 279
 280 /* class requests from the USB 2.0 hub spec, table 11-15 */
 281 /* GetBusState and SetHubDescriptor are optional, omitted */
 282 #define ClearHubFeature         (0x2000 | USB_REQ_CLEAR_FEATURE)
 283 #define ClearPortFeature        (0x2300 | USB_REQ_CLEAR_FEATURE)
 284 #define GetHubDescriptor        (0xa000 | USB_REQ_GET_DESCRIPTOR)
 285 #define GetHubStatus            (0xa000 | USB_REQ_GET_STATUS)
 286 #define GetPortStatus           (0xa300 | USB_REQ_GET_STATUS)
 287 #define SetHubFeature           (0x2000 | USB_REQ_SET_FEATURE)
 288 #define SetPortFeature          (0x2300 | USB_REQ_SET_FEATURE)
 289
 290
 291 /*-------------------------------------------------------------------------*/
 292
 293 /*
 294  * Generic bandwidth allocation constants/support
 295  */
 296 #define FRAME_TIME_USECS        1000L
 297 #define BitTime(bytecount)  (7 * 8 * bytecount / 6)  /* with integer truncation */
 298                 /* Trying not to use worst-case bit-stuffing
 299                    of (7/6 * 8 * bytecount) = 9.33 * bytecount */
 300                 /* bytecount = data payload byte count */
 301
 302 #define NS_TO_US(ns)    ((ns + 500L) / 1000L)
 303                         /* convert & round nanoseconds to microseconds */
 304
 305 extern void usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
 306                 int bustime, int isoc);
 307 extern void usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
 308                 int isoc);
 309
 310 /*
 311  * Full/low speed bandwidth allocation constants/support.
 312  */
 313 #define BW_HOST_DELAY   1000L           /* nanoseconds */
 314 #define BW_HUB_LS_SETUP 333L            /* nanoseconds */
 315                         /* 4 full-speed bit times (est.) */
 316
 317 #define FRAME_TIME_BITS         12000L          /* frame = 1 millisecond */
 318 #define FRAME_TIME_MAX_BITS_ALLOC       (90L * FRAME_TIME_BITS / 100L)
 319 #define FRAME_TIME_MAX_USECS_ALLOC      (90L * FRAME_TIME_USECS / 100L)
 320
 321 extern int usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
 322
 323 /*
 324  * Ceiling microseconds (typical) for that many bytes at high speed
 325  * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
 326  * to preallocate bandwidth)
 327  */
 328 #define USB2_HOST_DELAY 5       /* nsec, guess */
 329 #define HS_USECS(bytes) NS_TO_US ( ((55 * 8 * 2083)/1000) \
 330         + ((2083UL * (3167 + BitTime (bytes)))/1000) \
 331         + USB2_HOST_DELAY)
 332 #define HS_USECS_ISO(bytes) NS_TO_US ( ((38 * 8 * 2083)/1000) \
 333         + ((2083UL * (3167 + BitTime (bytes)))/1000) \
 334         + USB2_HOST_DELAY)
 335
 336 extern long usb_calc_bus_time (int speed, int is_input,
 337                         int isoc, int bytecount);
 338
 339 /*-------------------------------------------------------------------------*/
 340
 341 extern struct usb_bus *usb_alloc_bus (struct usb_operations *);
 342
 343 extern int usb_register_bus (struct usb_bus *);
 344 extern void usb_deregister_bus (struct usb_bus *);
 345
 346 extern int usb_register_root_hub (struct usb_device *usb_dev,
 347                 struct device *parent_dev);
 348
 349 static inline int hcd_register_root (struct usb_hcd *hcd)
 350 {
 351         /* hcd->driver->start() reported can_wakeup, probably with
 352          * assistance from board's boot firmware.
 353          * NOTE:  normal devices won't enable wakeup by default.
 354          */
 355         if (hcd->can_wakeup)
 356                 dev_dbg (hcd->self.controller, "supports USB remote wakeup\n");
 357         hcd->remote_wakeup = hcd->can_wakeup;
 358
 359         return usb_register_root_hub (
 360                 hcd_to_bus (hcd)->root_hub, hcd->self.controller);
 361 }
 362
 363 /*-------------------------------------------------------------------------*/
 364
 365 /* exported only within usbcore */
 366
 367 extern struct list_head usb_bus_list;
 368 extern struct semaphore usb_bus_list_lock;
 369
 370 extern struct usb_bus *usb_bus_get (struct usb_bus *bus);
 371 extern void usb_bus_put (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_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
 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