drivers/usb/host/uhci-hcd.h

   1 #ifndef __LINUX_UHCI_HCD_H
   2 #define __LINUX_UHCI_HCD_H
   3
   4 #include <linux/list.h>
   5 #include <linux/usb.h>
   6
   7 #define usb_packetid(pipe)      (usb_pipein(pipe) ? USB_PID_IN : USB_PID_OUT)
   8 #define PIPE_DEVEP_MASK         0x0007ff00
   9
  10
  11 /*
  12  * Universal Host Controller Interface data structures and defines
  13  */
  14
  15 /* Command register */
  16 #define USBCMD          0
  17 #define   USBCMD_RS             0x0001  /* Run/Stop */
  18 #define   USBCMD_HCRESET        0x0002  /* Host reset */
  19 #define   USBCMD_GRESET         0x0004  /* Global reset */
  20 #define   USBCMD_EGSM           0x0008  /* Global Suspend Mode */
  21 #define   USBCMD_FGR            0x0010  /* Force Global Resume */
  22 #define   USBCMD_SWDBG          0x0020  /* SW Debug mode */
  23 #define   USBCMD_CF             0x0040  /* Config Flag (sw only) */
  24 #define   USBCMD_MAXP           0x0080  /* Max Packet (0 = 32, 1 = 64) */
  25
  26 /* Status register */
  27 #define USBSTS          2
  28 #define   USBSTS_USBINT         0x0001  /* Interrupt due to IOC */
  29 #define   USBSTS_ERROR          0x0002  /* Interrupt due to error */
  30 #define   USBSTS_RD             0x0004  /* Resume Detect */
  31 #define   USBSTS_HSE            0x0008  /* Host System Error: PCI problems */
  32 #define   USBSTS_HCPE           0x0010  /* Host Controller Process Error:
  33                                          * the schedule is buggy */
  34 #define   USBSTS_HCH            0x0020  /* HC Halted */
  35
  36 /* Interrupt enable register */
  37 #define USBINTR         4
  38 #define   USBINTR_TIMEOUT       0x0001  /* Timeout/CRC error enable */
  39 #define   USBINTR_RESUME        0x0002  /* Resume interrupt enable */
  40 #define   USBINTR_IOC           0x0004  /* Interrupt On Complete enable */
  41 #define   USBINTR_SP            0x0008  /* Short packet interrupt enable */
  42
  43 #define USBFRNUM        6
  44 #define USBFLBASEADD    8
  45 #define USBSOF          12
  46 #define   USBSOF_DEFAULT        64      /* Frame length is exactly 1 ms */
  47
  48 /* USB port status and control registers */
  49 #define USBPORTSC1      16
  50 #define USBPORTSC2      18
  51 #define   USBPORTSC_CCS         0x0001  /* Current Connect Status
  52                                          * ("device present") */
  53 #define   USBPORTSC_CSC         0x0002  /* Connect Status Change */
  54 #define   USBPORTSC_PE          0x0004  /* Port Enable */
  55 #define   USBPORTSC_PEC         0x0008  /* Port Enable Change */
  56 #define   USBPORTSC_DPLUS       0x0010  /* D+ high (line status) */
  57 #define   USBPORTSC_DMINUS      0x0020  /* D- high (line status) */
  58 #define   USBPORTSC_RD          0x0040  /* Resume Detect */
  59 #define   USBPORTSC_RES1        0x0080  /* reserved, always 1 */
  60 #define   USBPORTSC_LSDA        0x0100  /* Low Speed Device Attached */
  61 #define   USBPORTSC_PR          0x0200  /* Port Reset */
  62 /* OC and OCC from Intel 430TX and later (not UHCI 1.1d spec) */
  63 #define   USBPORTSC_OC          0x0400  /* Over Current condition */
  64 #define   USBPORTSC_OCC         0x0800  /* Over Current Change R/WC */
  65 #define   USBPORTSC_SUSP        0x1000  /* Suspend */
  66 #define   USBPORTSC_RES2        0x2000  /* reserved, write zeroes */
  67 #define   USBPORTSC_RES3        0x4000  /* reserved, write zeroes */
  68 #define   USBPORTSC_RES4        0x8000  /* reserved, write zeroes */
  69
  70 /* Legacy support register */
  71 #define USBLEGSUP               0xc0
  72 #define   USBLEGSUP_DEFAULT     0x2000  /* only PIRQ enable set */
  73 #define   USBLEGSUP_RWC         0x8f00  /* the R/WC bits */
  74 #define   USBLEGSUP_RO          0x5040  /* R/O and reserved bits */
  75
  76 #define UHCI_PTR_BITS           __constant_cpu_to_le32(0x000F)
  77 #define UHCI_PTR_TERM           __constant_cpu_to_le32(0x0001)
  78 #define UHCI_PTR_QH             __constant_cpu_to_le32(0x0002)
  79 #define UHCI_PTR_DEPTH          __constant_cpu_to_le32(0x0004)
  80 #define UHCI_PTR_BREADTH        __constant_cpu_to_le32(0x0000)
  81
  82 #define UHCI_NUMFRAMES          1024    /* in the frame list [array] */
  83 #define UHCI_MAX_SOF_NUMBER     2047    /* in an SOF packet */
  84 #define CAN_SCHEDULE_FRAMES     1000    /* how far in the future frames
  85                                          * can be scheduled */
  86 #define MAX_PHASE               32      /* Periodic scheduling length */
  87
  88 /* When no queues need Full-Speed Bandwidth Reclamation,
  89  * delay this long before turning FSBR off */
  90 #define FSBR_OFF_DELAY          msecs_to_jiffies(10)
  91
  92 /* If a queue hasn't advanced after this much time, assume it is stuck */
  93 #define QH_WAIT_TIMEOUT         msecs_to_jiffies(200)
  94
  95
  96 /*
  97  *      Queue Headers
  98  */
  99
 100 /*
 101  * One role of a QH is to hold a queue of TDs for some endpoint.  One QH goes
 102  * with each endpoint, and qh->element (updated by the HC) is either:
 103  *   - the next unprocessed TD in the endpoint's queue, or
 104  *   - UHCI_PTR_TERM (when there's no more traffic for this endpoint).
 105  *
 106  * The other role of a QH is to serve as a "skeleton" framelist entry, so we
 107  * can easily splice a QH for some endpoint into the schedule at the right
 108  * place.  Then qh->element is UHCI_PTR_TERM.
 109  *
 110  * In the schedule, qh->link maintains a list of QHs seen by the HC:
 111  *     skel1 --> ep1-qh --> ep2-qh --> ... --> skel2 --> ...
 112  *
 113  * qh->node is the software equivalent of qh->link.  The differences
 114  * are that the software list is doubly-linked and QHs in the UNLINKING
 115  * state are on the software list but not the hardware schedule.
 116  *
 117  * For bookkeeping purposes we maintain QHs even for Isochronous endpoints,
 118  * but they never get added to the hardware schedule.
 119  */
 120 #define QH_STATE_IDLE           1       /* QH is not being used */
 121 #define QH_STATE_UNLINKING      2       /* QH has been removed from the
 122                                          * schedule but the hardware may
 123                                          * still be using it */
 124 #define QH_STATE_ACTIVE         3       /* QH is on the schedule */
 125
 126 struct uhci_qh {
 127         /* Hardware fields */
 128         __le32 link;                    /* Next QH in the schedule */
 129         __le32 element;                 /* Queue element (TD) pointer */
 130
 131         /* Software fields */
 132         dma_addr_t dma_handle;
 133
 134         struct list_head node;          /* Node in the list of QHs */
 135         struct usb_host_endpoint *hep;  /* Endpoint information */
 136         struct usb_device *udev;
 137         struct list_head queue;         /* Queue of urbps for this QH */
 138         struct uhci_td *dummy_td;       /* Dummy TD to end the queue */
 139         struct uhci_td *post_td;        /* Last TD completed */
 140
 141         struct usb_iso_packet_descriptor *iso_packet_desc;
 142                                         /* Next urb->iso_frame_desc entry */
 143         unsigned long advance_jiffies;  /* Time of last queue advance */
 144         unsigned int unlink_frame;      /* When the QH was unlinked */
 145         unsigned int period;            /* For Interrupt and Isochronous QHs */
 146         short phase;                    /* Between 0 and period-1 */
 147         short load;                     /* Periodic time requirement, in us */
 148         unsigned int iso_frame;         /* Frame # for iso_packet_desc */
 149         int iso_status;                 /* Status for Isochronous URBs */
 150
 151         int state;                      /* QH_STATE_xxx; see above */
 152         int type;                       /* Queue type (control, bulk, etc) */
 153         int skel;                       /* Skeleton queue number */
 154
 155         unsigned int initial_toggle:1;  /* Endpoint's current toggle value */
 156         unsigned int needs_fixup:1;     /* Must fix the TD toggle values */
 157         unsigned int is_stopped:1;      /* Queue was stopped by error/unlink */
 158         unsigned int wait_expired:1;    /* QH_WAIT_TIMEOUT has expired */
 159         unsigned int bandwidth_reserved:1;      /* Periodic bandwidth has
 160                                                  * been allocated */
 161 } __attribute__((aligned(16)));
 162
 163 /*
 164  * We need a special accessor for the element pointer because it is
 165  * subject to asynchronous updates by the controller.
 166  */
 167 static inline __le32 qh_element(struct uhci_qh *qh) {
 168         __le32 element = qh->element;
 169
 170         barrier();
 171         return element;
 172 }
 173
 174 #define LINK_TO_QH(qh)          (UHCI_PTR_QH | cpu_to_le32((qh)->dma_handle))
 175
 176
 177 /*
 178  *      Transfer Descriptors
 179  */
 180
 181 /*
 182  * for TD <status>:
 183  */
 184 #define TD_CTRL_SPD             (1 << 29)       /* Short Packet Detect */
 185 #define TD_CTRL_C_ERR_MASK      (3 << 27)       /* Error Counter bits */
 186 #define TD_CTRL_C_ERR_SHIFT     27
 187 #define TD_CTRL_LS              (1 << 26)       /* Low Speed Device */
 188 #define TD_CTRL_IOS             (1 << 25)       /* Isochronous Select */
 189 #define TD_CTRL_IOC             (1 << 24)       /* Interrupt on Complete */
 190 #define TD_CTRL_ACTIVE          (1 << 23)       /* TD Active */
 191 #define TD_CTRL_STALLED         (1 << 22)       /* TD Stalled */
 192 #define TD_CTRL_DBUFERR         (1 << 21)       /* Data Buffer Error */
 193 #define TD_CTRL_BABBLE          (1 << 20)       /* Babble Detected */
 194 #define TD_CTRL_NAK             (1 << 19)       /* NAK Received */
 195 #define TD_CTRL_CRCTIMEO        (1 << 18)       /* CRC/Time Out Error */
 196 #define TD_CTRL_BITSTUFF        (1 << 17)       /* Bit Stuff Error */
 197 #define TD_CTRL_ACTLEN_MASK     0x7FF   /* actual length, encoded as n - 1 */
 198
 199 #define TD_CTRL_ANY_ERROR       (TD_CTRL_STALLED | TD_CTRL_DBUFERR | \
 200                                  TD_CTRL_BABBLE | TD_CTRL_CRCTIME | \
 201                                  TD_CTRL_BITSTUFF)
 202
 203 #define uhci_maxerr(err)                ((err) << TD_CTRL_C_ERR_SHIFT)
 204 #define uhci_status_bits(ctrl_sts)      ((ctrl_sts) & 0xF60000)
 205 #define uhci_actual_length(ctrl_sts)    (((ctrl_sts) + 1) & \
 206                         TD_CTRL_ACTLEN_MASK)    /* 1-based */
 207
 208 /*
 209  * for TD <info>: (a.k.a. Token)
 210  */
 211 #define td_token(td)            le32_to_cpu((td)->token)
 212 #define TD_TOKEN_DEVADDR_SHIFT  8
 213 #define TD_TOKEN_TOGGLE_SHIFT   19
 214 #define TD_TOKEN_TOGGLE         (1 << 19)
 215 #define TD_TOKEN_EXPLEN_SHIFT   21
 216 #define TD_TOKEN_EXPLEN_MASK    0x7FF   /* expected length, encoded as n-1 */
 217 #define TD_TOKEN_PID_MASK       0xFF
 218
 219 #define uhci_explen(len)        ((((len) - 1) & TD_TOKEN_EXPLEN_MASK) << \
 220                                         TD_TOKEN_EXPLEN_SHIFT)
 221
 222 #define uhci_expected_length(token) ((((token) >> TD_TOKEN_EXPLEN_SHIFT) + \
 223                                         1) & TD_TOKEN_EXPLEN_MASK)
 224 #define uhci_toggle(token)      (((token) >> TD_TOKEN_TOGGLE_SHIFT) & 1)
 225 #define uhci_endpoint(token)    (((token) >> 15) & 0xf)
 226 #define uhci_devaddr(token)     (((token) >> TD_TOKEN_DEVADDR_SHIFT) & 0x7f)
 227 #define uhci_devep(token)       (((token) >> TD_TOKEN_DEVADDR_SHIFT) & 0x7ff)
 228 #define uhci_packetid(token)    ((token) & TD_TOKEN_PID_MASK)
 229 #define uhci_packetout(token)   (uhci_packetid(token) != USB_PID_IN)
 230 #define uhci_packetin(token)    (uhci_packetid(token) == USB_PID_IN)
 231
 232 /*
 233  * The documentation says "4 words for hardware, 4 words for software".
 234  *
 235  * That's silly, the hardware doesn't care. The hardware only cares that
 236  * the hardware words are 16-byte aligned, and we can have any amount of
 237  * sw space after the TD entry.
 238  *
 239  * td->link points to either another TD (not necessarily for the same urb or
 240  * even the same endpoint), or nothing (PTR_TERM), or a QH.
 241  */
 242 struct uhci_td {
 243         /* Hardware fields */
 244         __le32 link;
 245         __le32 status;
 246         __le32 token;
 247         __le32 buffer;
 248
 249         /* Software fields */
 250         dma_addr_t dma_handle;
 251
 252         struct list_head list;
 253
 254         int frame;                      /* for iso: what frame? */
 255         struct list_head fl_list;
 256 } __attribute__((aligned(16)));
 257
 258 /*
 259  * We need a special accessor for the control/status word because it is
 260  * subject to asynchronous updates by the controller.
 261  */
 262 static inline u32 td_status(struct uhci_td *td) {
 263         __le32 status = td->status;
 264
 265         barrier();
 266         return le32_to_cpu(status);
 267 }
 268
 269 #define LINK_TO_TD(td)          (cpu_to_le32((td)->dma_handle))
 270
 271
 272 /*
 273  *      Skeleton Queue Headers
 274  */
 275
 276 /*
 277  * The UHCI driver uses QHs with Interrupt, Control and Bulk URBs for
 278  * automatic queuing. To make it easy to insert entries into the schedule,
 279  * we have a skeleton of QHs for each predefined Interrupt latency.
 280  * Asynchronous QHs (low-speed control, full-speed control, and bulk)
 281  * go onto the period-1 interrupt list, since they all get accessed on
 282  * every frame.
 283  *
 284  * When we want to add a new QH, we add it to the list starting from the
 285  * appropriate skeleton QH.  For instance, the schedule can look like this:
 286  *
 287  * skel int128 QH
 288  * dev 1 interrupt QH
 289  * dev 5 interrupt QH
 290  * skel int64 QH
 291  * skel int32 QH
 292  * ...
 293  * skel int1 + async QH
 294  * dev 5 low-speed control QH
 295  * dev 1 bulk QH
 296  * dev 2 bulk QH
 297  *
 298  * There is a special terminating QH used to keep full-speed bandwidth
 299  * reclamation active when no full-speed control or bulk QHs are linked
 300  * into the schedule.  It has an inactive TD (to work around a PIIX bug,
 301  * see the Intel errata) and it points back to itself.
 302  *
 303  * There's a special skeleton QH for Isochronous QHs which never appears
 304  * on the schedule.  Isochronous TDs go on the schedule before the
 305  * the skeleton QHs.  The hardware accesses them directly rather than
 306  * through their QH, which is used only for bookkeeping purposes.
 307  * While the UHCI spec doesn't forbid the use of QHs for Isochronous,
 308  * it doesn't use them either.  And the spec says that queues never
 309  * advance on an error completion status, which makes them totally
 310  * unsuitable for Isochronous transfers.
 311  *
 312  * There's also a special skeleton QH used for QHs which are in the process
 313  * of unlinking and so may still be in use by the hardware.  It too never
 314  * appears on the schedule.
 315  */
 316
 317 #define UHCI_NUM_SKELQH         11
 318 #define SKEL_UNLINK             0
 319 #define skel_unlink_qh          skelqh[SKEL_UNLINK]
 320 #define SKEL_ISO                1
 321 #define skel_iso_qh             skelqh[SKEL_ISO]
 322         /* int128, int64, ..., int1 = 2, 3, ..., 9 */
 323 #define SKEL_INDEX(exponent)    (9 - exponent)
 324 #define SKEL_ASYNC              9
 325 #define skel_async_qh           skelqh[SKEL_ASYNC]
 326 #define SKEL_TERM               10
 327 #define skel_term_qh            skelqh[SKEL_TERM]
 328
 329 /* The following entries refer to sublists of skel_async_qh */
 330 #define SKEL_LS_CONTROL         20
 331 #define SKEL_FS_CONTROL         21
 332 #define SKEL_FSBR               SKEL_FS_CONTROL
 333 #define SKEL_BULK               22
 334
 335 /*
 336  *      The UHCI controller and root hub
 337  */
 338
 339 /*
 340  * States for the root hub:
 341  *
 342  * To prevent "bouncing" in the presence of electrical noise,
 343  * when there are no devices attached we delay for 1 second in the
 344  * RUNNING_NODEVS state before switching to the AUTO_STOPPED state.
 345  *
 346  * (Note that the AUTO_STOPPED state won't be necessary once the hub
 347  * driver learns to autosuspend.)
 348  */
 349 enum uhci_rh_state {
 350         /* In the following states the HC must be halted.
 351          * These two must come first. */
 352         UHCI_RH_RESET,
 353         UHCI_RH_SUSPENDED,
 354
 355         UHCI_RH_AUTO_STOPPED,
 356         UHCI_RH_RESUMING,
 357
 358         /* In this state the HC changes from running to halted,
 359          * so it can legally appear either way. */
 360         UHCI_RH_SUSPENDING,
 361
 362         /* In the following states it's an error if the HC is halted.
 363          * These two must come last. */
 364         UHCI_RH_RUNNING,                /* The normal state */
 365         UHCI_RH_RUNNING_NODEVS,         /* Running with no devices attached */
 366 };
 367
 368 /*
 369  * The full UHCI controller information:
 370  */
 371 struct uhci_hcd {
 372
 373         /* debugfs */
 374         struct dentry *dentry;
 375
 376         /* Grabbed from PCI */
 377         unsigned long io_addr;
 378
 379         struct dma_pool *qh_pool;
 380         struct dma_pool *td_pool;
 381
 382         struct uhci_td *term_td;        /* Terminating TD, see UHCI bug */
 383         struct uhci_qh *skelqh[UHCI_NUM_SKELQH];        /* Skeleton QHs */
 384         struct uhci_qh *next_qh;        /* Next QH to scan */
 385
 386         spinlock_t lock;
 387
 388         dma_addr_t frame_dma_handle;    /* Hardware frame list */
 389         __le32 *frame;
 390         void **frame_cpu;               /* CPU's frame list */
 391
 392         enum uhci_rh_state rh_state;
 393         unsigned long auto_stop_time;           /* When to AUTO_STOP */
 394
 395         unsigned int frame_number;              /* As of last check */
 396         unsigned int is_stopped;
 397 #define UHCI_IS_STOPPED         9999            /* Larger than a frame # */
 398         unsigned int last_iso_frame;            /* Frame of last scan */
 399         unsigned int cur_iso_frame;             /* Frame for current scan */
 400
 401         unsigned int scan_in_progress:1;        /* Schedule scan is running */
 402         unsigned int need_rescan:1;             /* Redo the schedule scan */
 403         unsigned int dead:1;                    /* Controller has died */
 404         unsigned int working_RD:1;              /* Suspended root hub doesn't
 405                                                    need to be polled */
 406         unsigned int is_initialized:1;          /* Data structure is usable */
 407         unsigned int fsbr_is_on:1;              /* FSBR is turned on */
 408         unsigned int fsbr_is_wanted:1;          /* Does any URB want FSBR? */
 409         unsigned int fsbr_expiring:1;           /* FSBR is timing out */
 410
 411         struct timer_list fsbr_timer;           /* For turning off FBSR */
 412
 413         /* Support for port suspend/resume/reset */
 414         unsigned long port_c_suspend;           /* Bit-arrays of ports */
 415         unsigned long resuming_ports;
 416         unsigned long ports_timeout;            /* Time to stop signalling */
 417
 418         struct list_head idle_qh_list;          /* Where the idle QHs live */
 419
 420         int rh_numports;                        /* Number of root-hub ports */
 421
 422         wait_queue_head_t waitqh;               /* endpoint_disable waiters */
 423         int num_waiting;                        /* Number of waiters */
 424
 425         int total_load;                         /* Sum of array values */
 426         short load[MAX_PHASE];                  /* Periodic allocations */
 427 };
 428
 429 /* Convert between a usb_hcd pointer and the corresponding uhci_hcd */
 430 static inline struct uhci_hcd *hcd_to_uhci(struct usb_hcd *hcd)
 431 {
 432         return (struct uhci_hcd *) (hcd->hcd_priv);
 433 }
 434 static inline struct usb_hcd *uhci_to_hcd(struct uhci_hcd *uhci)
 435 {
 436         return container_of((void *) uhci, struct usb_hcd, hcd_priv);
 437 }
 438
 439 #define uhci_dev(u)     (uhci_to_hcd(u)->self.controller)
 440
 441 /* Utility macro for comparing frame numbers */
 442 #define uhci_frame_before_eq(f1, f2)    (0 <= (int) ((f2) - (f1)))
 443
 444
 445 /*
 446  *      Private per-URB data
 447  */
 448 struct urb_priv {
 449         struct list_head node;          /* Node in the QH's urbp list */
 450
 451         struct urb *urb;
 452
 453         struct uhci_qh *qh;             /* QH for this URB */
 454         struct list_head td_list;
 455
 456         unsigned fsbr:1;                /* URB wants FSBR */
 457 };
 458
 459
 460 /*
 461  * Locking in uhci.c
 462  *
 463  * Almost everything relating to the hardware schedule and processing
 464  * of URBs is protected by uhci->lock.  urb->status is protected by
 465  * urb->lock; that's the one exception.
 466  *
 467  * To prevent deadlocks, never lock uhci->lock while holding urb->lock.
 468  * The safe order of locking is:
 469  *
 470  * #1 uhci->lock
 471  * #2 urb->lock
 472  */
 473
 474
 475 /* Some special IDs */
 476
 477 #define PCI_VENDOR_ID_GENESYS           0x17a0
 478 #define PCI_DEVICE_ID_GL880S_UHCI       0x8083
 479
 480 #endif