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 #include <linux/rwsem.h>
  23
  24 /* This file contains declarations of usbcore internals that are mostly
  25  * used or exposed by Host Controller Drivers.
  26  */
  27
  28 /*
  29  * USB Packet IDs (PIDs)
  30  */
  31 #define USB_PID_UNDEF_0                 0xf0
  32 #define USB_PID_OUT                     0xe1
  33 #define USB_PID_ACK                     0xd2
  34 #define USB_PID_DATA0                   0xc3
  35 #define USB_PID_PING                    0xb4    /* USB 2.0 */
  36 #define USB_PID_SOF                     0xa5
  37 #define USB_PID_NYET                    0x96    /* USB 2.0 */
  38 #define USB_PID_DATA2                   0x87    /* USB 2.0 */
  39 #define USB_PID_SPLIT                   0x78    /* USB 2.0 */
  40 #define USB_PID_IN                      0x69
  41 #define USB_PID_NAK                     0x5a
  42 #define USB_PID_DATA1                   0x4b
  43 #define USB_PID_PREAMBLE                0x3c    /* Token mode */
  44 #define USB_PID_ERR                     0x3c    /* USB 2.0: handshake mode */
  45 #define USB_PID_SETUP                   0x2d
  46 #define USB_PID_STALL                   0x1e
  47 #define USB_PID_MDATA                   0x0f    /* USB 2.0 */
  48
  49 /*-------------------------------------------------------------------------*/
  50
  51 /*
  52  * USB Host Controller Driver (usb_hcd) framework
  53  *
  54  * Since "struct usb_bus" is so thin, you can't share much code in it.
  55  * This framework is a layer over that, and should be more sharable.
  56  *
  57  * @authorized_default: Specifies if new devices are authorized to
  58  *                      connect by default or they require explicit
  59  *                      user space authorization; this bit is settable
  60  *                      through /sys/class/usb_host/X/authorized_default.
  61  *                      For the rest is RO, so we don't lock to r/w it.
  62  */
  63
  64 /*-------------------------------------------------------------------------*/
  65
  66 struct usb_hcd {
  67
  68         /*
  69          * housekeeping
  70          */
  71         struct usb_bus          self;           /* hcd is-a bus */
  72         struct kref             kref;           /* reference counter */
  73
  74         const char              *product_desc;  /* product/vendor string */
  75         char                    irq_descr[24];  /* driver + bus # */
  76
  77         struct timer_list       rh_timer;       /* drives root-hub polling */
  78         struct urb              *status_urb;    /* the current status urb */
  79 #ifdef CONFIG_PM
  80         struct work_struct      wakeup_work;    /* for remote wakeup */
  81 #endif
  82
  83         /*
  84          * hardware info/state
  85          */
  86         const struct hc_driver  *driver;        /* hw-specific hooks */
  87
  88         /* Flags that need to be manipulated atomically */
  89         unsigned long           flags;
  90 #define HCD_FLAG_HW_ACCESSIBLE  0x00000001
  91 #define HCD_FLAG_SAW_IRQ        0x00000002
  92
  93         unsigned                rh_registered:1;/* is root hub registered? */
  94
  95         /* The next flag is a stopgap, to be removed when all the HCDs
  96          * support the new root-hub polling mechanism. */
  97         unsigned                uses_new_polling:1;
  98         unsigned                poll_rh:1;      /* poll for rh status? */
  99         unsigned                poll_pending:1; /* status has changed? */
 100         unsigned                wireless:1;     /* Wireless USB HCD */
 101         unsigned                authorized_default:1;
 102
 103         int                     irq;            /* irq allocated */
 104         void __iomem            *regs;          /* device memory/io */
 105         u64                     rsrc_start;     /* memory/io resource start */
 106         u64                     rsrc_len;       /* memory/io resource length */
 107         unsigned                power_budget;   /* in mA, 0 = no limit */
 108
 109 #define HCD_BUFFER_POOLS        4
 110         struct dma_pool         *pool [HCD_BUFFER_POOLS];
 111
 112         int                     state;
 113 #       define  __ACTIVE                0x01
 114 #       define  __SUSPEND               0x04
 115 #       define  __TRANSIENT             0x80
 116
 117 #       define  HC_STATE_HALT           0
 118 #       define  HC_STATE_RUNNING        (__ACTIVE)
 119 #       define  HC_STATE_QUIESCING      (__SUSPEND|__TRANSIENT|__ACTIVE)
 120 #       define  HC_STATE_RESUMING       (__SUSPEND|__TRANSIENT)
 121 #       define  HC_STATE_SUSPENDED      (__SUSPEND)
 122
 123 #define HC_IS_RUNNING(state) ((state) & __ACTIVE)
 124 #define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
 125
 126         /* more shared queuing code would be good; it should support
 127          * smarter scheduling, handle transaction translators, etc;
 128          * input size of periodic table to an interrupt scheduler.
 129          * (ohci 32, uhci 1024, ehci 256/512/1024).
 130          */
 131
 132         /* The HC driver's private data is stored at the end of
 133          * this structure.
 134          */
 135         unsigned long hcd_priv[0]
 136                         __attribute__ ((aligned (sizeof(unsigned long))));
 137 };
 138
 139 /* 2.4 does this a bit differently ... */
 140 static inline struct usb_bus *hcd_to_bus (struct usb_hcd *hcd)
 141 {
 142         return &hcd->self;
 143 }
 144
 145 static inline struct usb_hcd *bus_to_hcd (struct usb_bus *bus)
 146 {
 147         return container_of(bus, struct usb_hcd, self);
 148 }
 149
 150 struct hcd_timeout {    /* timeouts we allocate */
 151         struct list_head        timeout_list;
 152         struct timer_list       timer;
 153 };
 154
 155 /*-------------------------------------------------------------------------*/
 156
 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);
 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 PCI bus glue.
 177          */
 178         /* called after suspending the hub, before entering D3 etc */
 179         int     (*suspend) (struct usb_hcd *hcd, pm_message_t message);
 180
 181         /* called after entering D0 (etc), before resuming the hub */
 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         /* shutdown HCD */
 188         void    (*shutdown) (struct usb_hcd *hcd);
 189
 190         /* return current frame number */
 191         int     (*get_frame_number) (struct usb_hcd *hcd);
 192
 193         /* manage i/o requests, device state */
 194         int     (*urb_enqueue)(struct usb_hcd *hcd,
 195                                 struct urb *urb, gfp_t mem_flags);
 196         int     (*urb_dequeue)(struct usb_hcd *hcd,
 197                                 struct urb *urb, int status);
 198
 199         /* hw synch, freeing endpoint resources that urb_dequeue can't */
 200         void    (*endpoint_disable)(struct usb_hcd *hcd,
 201                         struct usb_host_endpoint *ep);
 202
 203         /* root hub support */
 204         int             (*hub_status_data) (struct usb_hcd *hcd, char *buf);
 205         int             (*hub_control) (struct usb_hcd *hcd,
 206                                 u16 typeReq, u16 wValue, u16 wIndex,
 207                                 char *buf, u16 wLength);
 208         int             (*bus_suspend)(struct usb_hcd *);
 209         int             (*bus_resume)(struct usb_hcd *);
 210         int             (*start_port_reset)(struct usb_hcd *, unsigned port_num);
 211         void            (*hub_irq_enable)(struct usb_hcd *);
 212                 /* Needed only if port-change IRQs are level-triggered */
 213
 214                 /* force handover of high-speed port to full-speed companion */
 215         void            (*relinquish_port)(struct usb_hcd *, int);
 216 };
 217
 218 extern int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb);
 219 extern int usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb,
 220                 int status);
 221 extern void usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb);
 222
 223 extern int usb_hcd_submit_urb (struct urb *urb, gfp_t mem_flags);
 224 extern int usb_hcd_unlink_urb (struct urb *urb, int status);
 225 extern void usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb,
 226                 int status);
 227 extern void usb_hcd_flush_endpoint(struct usb_device *udev,
 228                 struct usb_host_endpoint *ep);
 229 extern void usb_hcd_disable_endpoint(struct usb_device *udev,
 230                 struct usb_host_endpoint *ep);
 231 extern int usb_hcd_get_frame_number (struct usb_device *udev);
 232
 233 extern struct usb_hcd *usb_create_hcd (const struct hc_driver *driver,
 234                 struct device *dev, char *bus_name);
 235 extern struct usb_hcd *usb_get_hcd (struct usb_hcd *hcd);
 236 extern void usb_put_hcd (struct usb_hcd *hcd);
 237 extern int usb_add_hcd(struct usb_hcd *hcd,
 238                 unsigned int irqnum, unsigned long irqflags);
 239 extern void usb_remove_hcd(struct usb_hcd *hcd);
 240
 241 struct platform_device;
 242 extern void usb_hcd_platform_shutdown(struct platform_device* dev);
 243
 244 #ifdef CONFIG_PCI
 245 struct pci_dev;
 246 struct pci_device_id;
 247 extern int usb_hcd_pci_probe (struct pci_dev *dev,
 248                                 const struct pci_device_id *id);
 249 extern void usb_hcd_pci_remove (struct pci_dev *dev);
 250
 251 #ifdef CONFIG_PM
 252 extern int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t state);
 253 extern int usb_hcd_pci_resume (struct pci_dev *dev);
 254 #endif /* CONFIG_PM */
 255
 256 extern void usb_hcd_pci_shutdown (struct pci_dev *dev);
 257
 258 #endif /* CONFIG_PCI */
 259
 260 /* pci-ish (pdev null is ok) buffer alloc/mapping support */
 261 int hcd_buffer_create (struct usb_hcd *hcd);
 262 void hcd_buffer_destroy (struct usb_hcd *hcd);
 263
 264 void *hcd_buffer_alloc (struct usb_bus *bus, size_t size,
 265         gfp_t mem_flags, dma_addr_t *dma);
 266 void hcd_buffer_free (struct usb_bus *bus, size_t size,
 267         void *addr, dma_addr_t dma);
 268
 269 /* generic bus glue, needed for host controllers that don't use PCI */
 270 extern irqreturn_t usb_hcd_irq (int irq, void *__hcd);
 271
 272 extern void usb_hc_died (struct usb_hcd *hcd);
 273 extern void usb_hcd_poll_rh_status(struct usb_hcd *hcd);
 274
 275 /* -------------------------------------------------------------------------- */
 276
 277 /* Enumeration is only for the hub driver, or HCD virtual root hubs */
 278 extern struct usb_device *usb_alloc_dev(struct usb_device *parent,
 279                                         struct usb_bus *, unsigned port);
 280 extern int usb_new_device(struct usb_device *dev);
 281 extern void usb_disconnect(struct usb_device **);
 282
 283 extern int usb_get_configuration(struct usb_device *dev);
 284 extern void usb_destroy_configuration(struct usb_device *dev);
 285
 286 /*-------------------------------------------------------------------------*/
 287
 288 /*
 289  * HCD Root Hub support
 290  */
 291
 292 #include "hub.h"
 293
 294 /* (shifted) direction/type/recipient from the USB 2.0 spec, table 9.2 */
 295 #define DeviceRequest \
 296         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 297 #define DeviceOutRequest \
 298         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
 299
 300 #define InterfaceRequest \
 301         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 302
 303 #define EndpointRequest \
 304         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 305 #define EndpointOutRequest \
 306         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 307
 308 /* class requests from the USB 2.0 hub spec, table 11-15 */
 309 /* GetBusState and SetHubDescriptor are optional, omitted */
 310 #define ClearHubFeature         (0x2000 | USB_REQ_CLEAR_FEATURE)
 311 #define ClearPortFeature        (0x2300 | USB_REQ_CLEAR_FEATURE)
 312 #define GetHubDescriptor        (0xa000 | USB_REQ_GET_DESCRIPTOR)
 313 #define GetHubStatus            (0xa000 | USB_REQ_GET_STATUS)
 314 #define GetPortStatus           (0xa300 | USB_REQ_GET_STATUS)
 315 #define SetHubFeature           (0x2000 | USB_REQ_SET_FEATURE)
 316 #define SetPortFeature          (0x2300 | USB_REQ_SET_FEATURE)
 317
 318
 319 /*-------------------------------------------------------------------------*/
 320
 321 /*
 322  * Generic bandwidth allocation constants/support
 323  */
 324 #define FRAME_TIME_USECS        1000L
 325 #define BitTime(bytecount)  (7 * 8 * bytecount / 6)  /* with integer truncation */
 326                 /* Trying not to use worst-case bit-stuffing
 327                    of (7/6 * 8 * bytecount) = 9.33 * bytecount */
 328                 /* bytecount = data payload byte count */
 329
 330 #define NS_TO_US(ns)    ((ns + 500L) / 1000L)
 331                         /* convert & round nanoseconds to microseconds */
 332
 333
 334 /*
 335  * Full/low speed bandwidth allocation constants/support.
 336  */
 337 #define BW_HOST_DELAY   1000L           /* nanoseconds */
 338 #define BW_HUB_LS_SETUP 333L            /* nanoseconds */
 339                         /* 4 full-speed bit times (est.) */
 340
 341 #define FRAME_TIME_BITS         12000L          /* frame = 1 millisecond */
 342 #define FRAME_TIME_MAX_BITS_ALLOC       (90L * FRAME_TIME_BITS / 100L)
 343 #define FRAME_TIME_MAX_USECS_ALLOC      (90L * FRAME_TIME_USECS / 100L)
 344
 345 /*
 346  * Ceiling [nano/micro]seconds (typical) for that many bytes at high speed
 347  * ISO is a bit less, no ACK ... from USB 2.0 spec, 5.11.3 (and needed
 348  * to preallocate bandwidth)
 349  */
 350 #define USB2_HOST_DELAY 5       /* nsec, guess */
 351 #define HS_NSECS(bytes) ( ((55 * 8 * 2083) \
 352         + (2083UL * (3 + BitTime(bytes))))/1000 \
 353         + USB2_HOST_DELAY)
 354 #define HS_NSECS_ISO(bytes) ( ((38 * 8 * 2083) \
 355         + (2083UL * (3 + BitTime(bytes))))/1000 \
 356         + USB2_HOST_DELAY)
 357 #define HS_USECS(bytes) NS_TO_US (HS_NSECS(bytes))
 358 #define HS_USECS_ISO(bytes) NS_TO_US (HS_NSECS_ISO(bytes))
 359
 360 extern long usb_calc_bus_time (int speed, int is_input,
 361                         int isoc, int bytecount);
 362
 363 /*-------------------------------------------------------------------------*/
 364
 365 extern void usb_set_device_state(struct usb_device *udev,
 366                 enum usb_device_state new_state);
 367
 368 /*-------------------------------------------------------------------------*/
 369
 370 /* exported only within usbcore */
 371
 372 extern struct list_head usb_bus_list;
 373 extern struct mutex usb_bus_list_lock;
 374 extern wait_queue_head_t usb_kill_urb_queue;
 375
 376 extern void usb_enable_root_hub_irq (struct usb_bus *bus);
 377
 378 extern int usb_find_interface_driver (struct usb_device *dev,
 379         struct usb_interface *interface);
 380
 381 #define usb_endpoint_out(ep_dir)        (!((ep_dir) & USB_DIR_IN))
 382
 383 #ifdef CONFIG_PM
 384 extern void usb_hcd_resume_root_hub (struct usb_hcd *hcd);
 385 extern void usb_root_hub_lost_power (struct usb_device *rhdev);
 386 extern int hcd_bus_suspend(struct usb_device *rhdev);
 387 extern int hcd_bus_resume(struct usb_device *rhdev);
 388 #else
 389 static inline void usb_hcd_resume_root_hub(struct usb_hcd *hcd)
 390 {
 391         return;
 392 }
 393 #endif /* CONFIG_PM */
 394
 395 /*
 396  * USB device fs stuff
 397  */
 398
 399 #ifdef CONFIG_USB_DEVICEFS
 400
 401 /*
 402  * these are expected to be called from the USB core/hub thread
 403  * with the kernel lock held
 404  */
 405 extern void usbfs_update_special (void);
 406 extern int usbfs_init(void);
 407 extern void usbfs_cleanup(void);
 408
 409 #else /* CONFIG_USB_DEVICEFS */
 410
 411 static inline void usbfs_update_special (void) {}
 412 static inline int usbfs_init(void) { return 0; }
 413 static inline void usbfs_cleanup(void) { }
 414
 415 #endif /* CONFIG_USB_DEVICEFS */
 416
 417 /*-------------------------------------------------------------------------*/
 418
 419 #if defined(CONFIG_USB_MON)
 420
 421 struct usb_mon_operations {
 422         void (*urb_submit)(struct usb_bus *bus, struct urb *urb);
 423         void (*urb_submit_error)(struct usb_bus *bus, struct urb *urb, int err);
 424         void (*urb_complete)(struct usb_bus *bus, struct urb *urb, int status);
 425         /* void (*urb_unlink)(struct usb_bus *bus, struct urb *urb); */
 426 };
 427
 428 extern struct usb_mon_operations *mon_ops;
 429
 430 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb)
 431 {
 432         if (bus->monitored)
 433                 (*mon_ops->urb_submit)(bus, urb);
 434 }
 435
 436 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
 437     int error)
 438 {
 439         if (bus->monitored)
 440                 (*mon_ops->urb_submit_error)(bus, urb, error);
 441 }
 442
 443 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
 444                 int status)
 445 {
 446         if (bus->monitored)
 447                 (*mon_ops->urb_complete)(bus, urb, status);
 448 }
 449
 450 int usb_mon_register(struct usb_mon_operations *ops);
 451 void usb_mon_deregister(void);
 452
 453 #else
 454
 455 static inline void usbmon_urb_submit(struct usb_bus *bus, struct urb *urb) {}
 456 static inline void usbmon_urb_submit_error(struct usb_bus *bus, struct urb *urb,
 457     int error) {}
 458 static inline void usbmon_urb_complete(struct usb_bus *bus, struct urb *urb,
 459                 int status) {}
 460
 461 #endif /* CONFIG_USB_MON */
 462
 463 /*-------------------------------------------------------------------------*/
 464
 465 /* hub.h ... DeviceRemovable in 2.4.2-ac11, gone in 2.4.10 */
 466 // bleech -- resurfaced in 2.4.11 or 2.4.12
 467 #define bitmap  DeviceRemovable
 468
 469
 470 /*-------------------------------------------------------------------------*/
 471
 472 /* random stuff */
 473
 474 #define RUN_CONTEXT (in_irq () ? "in_irq" \
 475                 : (in_interrupt () ? "in_interrupt" : "can sleep"))
 476
 477
 478 /* This rwsem is for use only by the hub driver and ehci-hcd.
 479  * Nobody else should touch it.
 480  */
 481 extern struct rw_semaphore ehci_cf_port_reset_rwsem;
 482
 483 #endif /* __KERNEL__ */