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