reactos/drivers/usb/usbport/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         int                     irq;            /* irq allocated */
  77         void                    *regs;          /* device memory/io */
  78         struct device           *controller;    /* handle to hardware */
  79
  80         /* a few non-PCI controllers exist, mostly for OHCI */
  81         struct pci_dev          *pdev;          /* pci is typical */
  82 #ifdef  CONFIG_PCI
  83         int                     region;         /* pci region for regs */
  84         u32                     pci_state [16]; /* for PM state save */
  85         atomic_t                resume_count;   /* multiple resumes issue */
  86 #endif
  87
  88 #define HCD_BUFFER_POOLS        4
  89         struct pci_pool         *pool [HCD_BUFFER_POOLS];
  90
  91         int                     state;
  92 #       define  __ACTIVE                0x01
  93 #       define  __SLEEPY                0x02
  94 #       define  __SUSPEND               0x04
  95 #       define  __TRANSIENT             0x80
  96
  97 #       define  USB_STATE_HALT          0
  98 #       define  USB_STATE_RUNNING       (__ACTIVE)
  99 #       define  USB_STATE_READY         (__ACTIVE|__SLEEPY)
 100 #       define  USB_STATE_QUIESCING     (__SUSPEND|__TRANSIENT|__ACTIVE)
 101 #       define  USB_STATE_RESUMING      (__SUSPEND|__TRANSIENT)
 102 #       define  USB_STATE_SUSPENDED     (__SUSPEND)
 103
 104 #define HCD_IS_RUNNING(state) ((state) & __ACTIVE)
 105 #define HCD_IS_SUSPENDED(state) ((state) & __SUSPEND)
 106
 107         /* more shared queuing code would be good; it should support
 108          * smarter scheduling, handle transaction translators, etc;
 109          * input size of periodic table to an interrupt scheduler.
 110          * (ohci 32, uhci 1024, ehci 256/512/1024).
 111          */
 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 struct hcd_dev {        /* usb_device.hcpriv points to this */
 122         struct list_head        dev_list;       /* on this hcd */
 123         struct list_head        urb_list;       /* pending on this dev */
 124
 125         /* per-configuration HC/HCD state, such as QH or ED */
 126         void                    *ep[32];
 127 };
 128
 129 // urb.hcpriv is really hardware-specific
 130
 131 struct hcd_timeout {    /* timeouts we allocate */
 132         struct list_head        timeout_list;
 133         struct timer_list       timer;
 134 };
 135
 136 /*-------------------------------------------------------------------------*/
 137
 138 /*
 139  * FIXME usb_operations should vanish or become hc_driver,
 140  * when usb_bus and usb_hcd become the same thing.
 141  */
 142
 143 struct usb_operations {
 144         int (*allocate)(struct usb_device *);
 145         int (*deallocate)(struct usb_device *);
 146         int (*get_frame_number) (struct usb_device *usb_dev);
 147         int (*submit_urb) (struct urb *urb, int mem_flags);
 148         int (*unlink_urb) (struct urb *urb);
 149
 150         /* allocate dma-consistent buffer for URB_DMA_NOMAPPING */
 151         void *(*buffer_alloc)(struct usb_bus *bus, size_t size,
 152                         int mem_flags,
 153                         dma_addr_t *dma);
 154         void (*buffer_free)(struct usb_bus *bus, size_t size,
 155                         void *addr, dma_addr_t dma);
 156
 157         void (*disable)(struct usb_device *udev, int bEndpointAddress);
 158 };
 159
 160 /* each driver provides one of these, and hardware init support */
 161
 162 struct pt_regs;
 163
 164 // new struct from 2.6
 165 struct hc_driver {
 166         const char      *description;   /* "ehci-hcd" etc */
 167
 168         /* irq handler */
 169         irqreturn_t     (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
 170
 171         int     flags;
 172 #define HCD_MEMORY      0x0001          /* HC regs use memory (else I/O) */
 173 #define HCD_USB11       0x0010          /* USB 1.1 */
 174 #define HCD_USB2        0x0020          /* USB 2.0 */
 175
 176         /* called to init HCD and root hub */
 177         int     (*reset) (struct usb_hcd *hcd);
 178         int     (*start) (struct usb_hcd *hcd);
 179
 180         /* called after all devices were suspended */
 181         int     (*suspend) (struct usb_hcd *hcd, u32 state);
 182
 183         /* called before any devices get resumed */
 184         int     (*resume) (struct usb_hcd *hcd);
 185
 186         /* cleanly make HCD stop writing memory and doing I/O */
 187         void    (*stop) (struct usb_hcd *hcd);
 188
 189         /* return current frame number */
 190         int     (*get_frame_number) (struct usb_hcd *hcd);
 191
 192         /* memory lifecycle */
 193         struct usb_hcd  *(*hcd_alloc) (void);
 194         void            (*hcd_free) (struct usb_hcd *hcd);
 195
 196         /* manage i/o requests, device state */
 197         int     (*urb_enqueue) (struct usb_hcd *hcd, struct urb *urb,
 198                                         int mem_flags);
 199         int     (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
 200
 201         /* hw synch, freeing endpoint resources that urb_dequeue can't */
 202         void    (*endpoint_disable)(struct usb_hcd *hcd,
 203                         struct hcd_dev *dev, int bEndpointAddress);
 204
 205         /* root hub support */
 206         int             (*hub_status_data) (struct usb_hcd *hcd, char *buf);
 207         int             (*hub_control) (struct usb_hcd *hcd,
 208                                 u16 typeReq, u16 wValue, u16 wIndex,
 209                                 char *buf, u16 wLength);
 210 };
 211
 212 // old version, "just in case"
 213 #if 0
 214 struct hc_driver {
 215         const char      *description;   /* "ehci-hcd" etc */
 216
 217         /* irq handler */
 218         int     (*irq) (struct usb_hcd *hcd, struct pt_regs *regs);
 219
 220         int     flags;
 221 #define HCD_MEMORY      0x0001          /* HC regs use memory (else I/O) */
 222 #define HCD_USB11       0x0010          /* USB 1.1 */
 223 #define HCD_USB2        0x0020          /* USB 2.0 */
 224
 225         /* called to init HCD and root hub */
 226         int     (*start) (struct usb_hcd *hcd);
 227
 228         /* called after all devices were suspended */
 229         int     (*suspend) (struct usb_hcd *hcd, u32 state);
 230
 231         /* called before any devices get resumed */
 232         int     (*resume) (struct usb_hcd *hcd);
 233
 234         /* cleanly make HCD stop writing memory and doing I/O */
 235         void    (*stop) (struct usb_hcd *hcd);
 236
 237         /* return current frame number */
 238         int     (*get_frame_number) (struct usb_hcd *hcd);
 239
 240         /* memory lifecycle */
 241         struct usb_hcd  *(*hcd_alloc) (void);
 242         void            (*hcd_free) (struct usb_hcd *hcd);
 243
 244         /* manage i/o requests, device state */
 245         int     (*urb_enqueue) (struct usb_hcd *hcd, struct urb *urb,
 246                                         int mem_flags);
 247         int     (*urb_dequeue) (struct usb_hcd *hcd, struct urb *urb);
 248
 249         /* hw synch, freeing endpoint resources that urb_dequeue can't */
 250         void    (*endpoint_disable)(struct usb_hcd *hcd,
 251                         struct hcd_dev *dev, int bEndpointAddress);
 252
 253         /* root hub support */
 254         int             (*hub_status_data) (struct usb_hcd *hcd, char *buf);
 255         int             (*hub_control) (struct usb_hcd *hcd,
 256                                 u16 typeReq, u16 wValue, u16 wIndex,
 257                                 char *buf, u16 wLength);
 258 };
 259 #endif
 260
 261 extern void STDCALL usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, struct pt_regs *regs);
 262 extern void STDCALL usb_bus_init (struct usb_bus *bus);
 263 extern void usb_rh_status_dequeue (struct usb_hcd *hcd, struct urb *urb);
 264
 265 #ifdef CONFIG_PCI
 266 struct pci_dev;
 267 struct pci_device_id;
 268 extern int STDCALL usb_hcd_pci_probe (struct pci_dev *dev,
 269                                 const struct pci_device_id *id);
 270 extern void STDCALL usb_hcd_pci_remove (struct pci_dev *dev);
 271
 272 #ifdef CONFIG_PM
 273 // FIXME:  see Documentation/power/pci.txt (2.4.6 and later?)
 274 // extern int usb_hcd_pci_save_state (struct pci_dev *dev, u32 state);
 275 extern int usb_hcd_pci_suspend (struct pci_dev *dev, u32 state);
 276 extern int usb_hcd_pci_resume (struct pci_dev *dev);
 277 // extern int usb_hcd_pci_enable_wake (struct pci_dev *dev, u32 state, int flg);
 278 #endif /* CONFIG_PM */
 279
 280 #endif /* CONFIG_PCI */
 281
 282 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
 283 int hcd_buffer_create (struct usb_hcd *hcd);
 284 void hcd_buffer_destroy (struct usb_hcd *hcd);
 285
 286 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
 287         int mem_flags, dma_addr_t *dma);
 288 void hcd_buffer_free (struct usb_bus *bus, size_t size,
 289         void *addr, dma_addr_t dma);
 290
 291 /* generic bus glue, needed for host controllers that don't use PCI */
 292 extern struct usb_operations usb_hcd_operations;
 293 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd, struct pt_regs *r);
 294 extern void STDCALL usb_hc_died (struct usb_hcd *hcd);
 295
 296 /* -------------------------------------------------------------------------- */
 297
 298 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
 299 extern int usb_new_device(struct usb_device *dev, struct device *parent);
 300 extern void STDCALL usb_connect(struct usb_device *dev);
 301 extern void usb_disconnect(struct usb_device **);
 302
 303 /* exported to hub driver ONLY to support usb_reset_device () */
 304 extern int usb_get_configuration(struct usb_device *dev);
 305 extern void usb_set_maxpacket(struct usb_device *dev);
 306 extern void usb_destroy_configuration(struct usb_device *dev);
 307 extern int usb_set_address(struct usb_device *dev);
 308
 309 /* use these only before the device's address has been set */
 310 #define usb_snddefctrl(dev)             ((PIPE_CONTROL << 30))
 311 #define usb_rcvdefctrl(dev)             ((PIPE_CONTROL << 30) | USB_DIR_IN)
 312
 313 /*-------------------------------------------------------------------------*/
 314
 315 /*
 316  * HCD Root Hub support
 317  */
 318
 319 #include "hub.h"
 320
 321 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
 322 #define DeviceRequest \
 323         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 324 #define DeviceOutRequest \
 325         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 326
 327 #define InterfaceRequest \
 328         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 329
 330 #define EndpointRequest \
 331         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 332 #define EndpointOutRequest \
 333         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 334
 335 /* table 9.6 standard features */
 336 #define DEVICE_REMOTE_WAKEUP    1
 337 #define ENDPOINT_HALT           0
 338
 339 /* class requests from the USB 2.0 hub spec, table 11-15 */
 340 /* GetBusState and SetHubDescriptor are optional, omitted */
 341 #define ClearHubFeature         (0x2000 | USB_REQ_CLEAR_FEATURE)
 342 #define ClearPortFeature        (0x2300 | USB_REQ_CLEAR_FEATURE)
 343 #define GetHubDescriptor        (0xa000 | USB_REQ_GET_DESCRIPTOR)
 344 #define GetHubStatus            (0xa000 | USB_REQ_GET_STATUS)
 345 #define GetPortStatus           (0xa300 | USB_REQ_GET_STATUS)
 346 #define SetHubFeature           (0x2000 | USB_REQ_SET_FEATURE)
 347 #define SetPortFeature          (0x2300 | USB_REQ_SET_FEATURE)
 348
 349
 350 /*-------------------------------------------------------------------------*/
 351
 352 /*
 353  * Generic bandwidth allocation constants/support
 354  */
 355 #define FRAME_TIME_USECS        1000L
 356 #define BitTime(bytecount)  (7 * 8 * bytecount / 6)  /* with integer truncation */
 357                 /* Trying not to use worst-case bit-stuffing
 358                    of (7/6 * 8 * bytecount) = 9.33 * bytecount */
 359                 /* bytecount = data payload byte count */
 360
 361 #define NS_TO_US(ns)    ((ns + 500L) / 1000L)
 362                         /* convert & round nanoseconds to microseconds */
 363
 364 extern void STDCALL usb_claim_bandwidth (struct usb_device *dev, struct urb *urb,
 365                 int bustime, int isoc);
 366 extern void STDCALL usb_release_bandwidth (struct usb_device *dev, struct urb *urb,
 367                 int isoc);
 368
 369 /*
 370  * Full/low speed bandwidth allocation constants/support.
 371  */
 372 #define BW_HOST_DELAY   1000L           /* nanoseconds */
 373 #define BW_HUB_LS_SETUP 333L            /* nanoseconds */
 374                         /* 4 full-speed bit times (est.) */
 375
 376 #define FRAME_TIME_BITS         12000L          /* frame = 1 millisecond */
 377 #define FRAME_TIME_MAX_BITS_ALLOC       (90L * FRAME_TIME_BITS / 100L)
 378 #define FRAME_TIME_MAX_USECS_ALLOC      (90L * FRAME_TIME_USECS / 100L)
 379
 380 extern int STDCALL usb_check_bandwidth (struct usb_device *dev, struct urb *urb);
 381
 382 /*
 383  * Ceiling microseconds (typical) for that many bytes at high speed
 384  * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
 385  * to preallocate bandwidth)
 386  */
 387 #define USB2_HOST_DELAY 5       /* nsec, guess */
 388 #define HS_USECS(bytes) NS_TO_US ( ((55 * 8 * 2083)/1000) \
 389         + ((2083UL * (3167 + BitTime (bytes)))/1000) \
 390         + USB2_HOST_DELAY)
 391 #define HS_USECS_ISO(bytes) NS_TO_US ( ((long)(38 * 8 * 2.083)) \
 392         + ((2083UL * (3167 + BitTime (bytes)))/1000) \
 393         + USB2_HOST_DELAY)
 394
 395 extern long STDCALL usb_calc_bus_time (int speed, int is_input,
 396                         int isoc, int bytecount);
 397
 398 /*-------------------------------------------------------------------------*/
 399
 400 extern struct usb_bus STDCALL *usb_alloc_bus (struct usb_operations *);
 401 extern void STDCALL usb_free_bus (struct usb_bus *);
 402
 403 extern void STDCALL usb_register_bus (struct usb_bus *);
 404 extern void STDCALL usb_deregister_bus (struct usb_bus *);
 405
 406 extern int STDCALL usb_register_root_hub (struct usb_device *usb_dev,
 407                 struct device *parent_dev);
 408
 409 /* for portability to 2.4, hcds should call this */
 410 static inline int hcd_register_root (struct usb_hcd *hcd)
 411 {
 412         return usb_register_root_hub (
 413                 hcd_to_bus (hcd)->root_hub, hcd->controller);
 414 }
 415
 416 /*-------------------------------------------------------------------------*/
 417
 418 /* exported only within usbcore */
 419
 420 extern struct list_head usb_bus_list;
 421 extern struct semaphore usb_bus_list_lock;
 422
 423 extern void usb_bus_get (struct usb_bus *bus);
 424 extern void usb_bus_put (struct usb_bus *bus);
 425
 426 extern int usb_find_interface_driver (struct usb_device *dev,
 427         struct usb_interface *interface);
 428
 429 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
 430
 431 #define usb_endpoint_out(ep_dir)        (!((ep_dir) & USB_DIR_IN))
 432
 433 /*
 434  * USB device fs stuff
 435  */
 436
 437 #ifdef CONFIG_USB_DEVICEFS
 438
 439 /*
 440  * these are expected to be called from the USB core/hub thread
 441  * with the kernel lock held
 442  */
 443 extern void usbfs_add_bus(struct usb_bus *bus);
 444 extern void usbfs_remove_bus(struct usb_bus *bus);
 445 extern void usbfs_add_device(struct usb_device *dev);
 446 extern void usbfs_remove_device(struct usb_device *dev);
 447 extern void usbfs_update_special (void);
 448
 449 extern int usbfs_init(void);
 450 extern void usbfs_cleanup(void);
 451
 452 #else /* CONFIG_USB_DEVICEFS */
 453
 454 static inline void usbfs_add_bus(struct usb_bus *bus) {}
 455 static inline void usbfs_remove_bus(struct usb_bus *bus) {}
 456 static inline void usbfs_add_device(struct usb_device *dev)
 457 {
 458         if (dev->parent)
 459         {
 460                 PDEVICE_OBJECT Pdo = (PDEVICE_OBJECT)dev->parent->dev.dev_ext;
 461                 IoInvalidateDeviceRelations(Pdo, BusRelations);
 462         }
 463 }
 464 static inline void usbfs_remove_device(struct usb_device *dev) {}
 465 static inline void usbfs_update_special (void) {}
 466
 467 static inline int usbfs_init(void) { return 0; }
 468 static inline void usbfs_cleanup(void) { }
 469
 470 #endif /* CONFIG_USB_DEVICEFS */
 471
 472 /*-------------------------------------------------------------------------*/
 473
 474 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
 475 // bleech -- resurfaced in 2.4.11 or 2.4.12
 476 #define bitmap  DeviceRemovable
 477
 478
 479 /*-------------------------------------------------------------------------*/
 480
 481 /* random stuff */
 482
 483 #define RUN_CONTEXT (in_irq () ? "in_irq" \
 484                 : (in_interrupt () ? "in_interrupt" : "can sleep"))
 485
 486
 487 #endif /* __KERNEL__ */
 488