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
  87 /* When no queues need Full-Speed Bandwidth Reclamation,
  88  * delay this long before turning FSBR off */
  89 #define FSBR_OFF_DELAY          msecs_to_jiffies(400)
  90
  91 /* If a queue hasn't advanced after this much time, assume it is stuck */
  92 #define QH_WAIT_TIMEOUT         msecs_to_jiffies(200)
  93
  94
  95 /*
  96  *      Queue Headers
  97  */
  98
  99 /*
 100  * One role of a QH is to hold a queue of TDs for some endpoint.  One QH goes
 101  * with each endpoint, and qh->element (updated by the HC) is either:
 102  *   - the next unprocessed TD in the endpoint's queue, or
 103  *   - UHCI_PTR_TERM (when there's no more traffic for this endpoint).
 104  *
 105  * The other role of a QH is to serve as a "skeleton" framelist entry, so we
 106  * can easily splice a QH for some endpoint into the schedule at the right
 107  * place.  Then qh->element is UHCI_PTR_TERM.
 108  *
 109  * In the schedule, qh->link maintains a list of QHs seen by the HC:
 110  *     skel1 --> ep1-qh --> ep2-qh --> ... --> skel2 --> ...
 111  *
 112  * qh->node is the software equivalent of qh->link.  The differences
 113  * are that the software list is doubly-linked and QHs in the UNLINKING
 114  * state are on the software list but not the hardware schedule.
 115  *
 116  * For bookkeeping purposes we maintain QHs even for Isochronous endpoints,
 117  * but they never get added to the hardware schedule.
 118  */
 119 #define QH_STATE_IDLE           1       /* QH is not being used */
 120 #define QH_STATE_UNLINKING      2       /* QH has been removed from the
 121                                          * schedule but the hardware may
 122                                          * still be using it */
 123 #define QH_STATE_ACTIVE         3       /* QH is on the schedule */
 124
 125 struct uhci_qh {
 126         /* Hardware fields */
 127         __le32 link;                    /* Next QH in the schedule */
 128         __le32 element;                 /* Queue element (TD) pointer */
 129
 130         /* Software fields */
 131         dma_addr_t dma_handle;
 132
 133         struct list_head node;          /* Node in the list of QHs */
 134         struct usb_host_endpoint *hep;  /* Endpoint information */
 135         struct usb_device *udev;
 136         struct list_head queue;         /* Queue of urbps for this QH */
 137         struct uhci_qh *skel;           /* Skeleton 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         unsigned long advance_jiffies;  /* Time of last queue advance */
 142         unsigned int unlink_frame;      /* When the QH was unlinked */
 143         int state;                      /* QH_STATE_xxx; see above */
 144         int type;                       /* Queue type (control, bulk, etc) */
 145
 146         unsigned int initial_toggle:1;  /* Endpoint's current toggle value */
 147         unsigned int needs_fixup:1;     /* Must fix the TD toggle values */
 148         unsigned int is_stopped:1;      /* Queue was stopped by error/unlink */
 149         unsigned int wait_expired:1;    /* QH_WAIT_TIMEOUT has expired */
 150 } __attribute__((aligned(16)));
 151
 152 /*
 153  * We need a special accessor for the element pointer because it is
 154  * subject to asynchronous updates by the controller.
 155  */
 156 static inline __le32 qh_element(struct uhci_qh *qh) {
 157         __le32 element = qh->element;
 158
 159         barrier();
 160         return element;
 161 }
 162
 163
 164 /*
 165  *      Transfer Descriptors
 166  */
 167
 168 /*
 169  * for TD <status>:
 170  */
 171 #define TD_CTRL_SPD             (1 << 29)       /* Short Packet Detect */
 172 #define TD_CTRL_C_ERR_MASK      (3 << 27)       /* Error Counter bits */
 173 #define TD_CTRL_C_ERR_SHIFT     27
 174 #define TD_CTRL_LS              (1 << 26)       /* Low Speed Device */
 175 #define TD_CTRL_IOS             (1 << 25)       /* Isochronous Select */
 176 #define TD_CTRL_IOC             (1 << 24)       /* Interrupt on Complete */
 177 #define TD_CTRL_ACTIVE          (1 << 23)       /* TD Active */
 178 #define TD_CTRL_STALLED         (1 << 22)       /* TD Stalled */
 179 #define TD_CTRL_DBUFERR         (1 << 21)       /* Data Buffer Error */
 180 #define TD_CTRL_BABBLE          (1 << 20)       /* Babble Detected */
 181 #define TD_CTRL_NAK             (1 << 19)       /* NAK Received */
 182 #define TD_CTRL_CRCTIMEO        (1 << 18)       /* CRC/Time Out Error */
 183 #define TD_CTRL_BITSTUFF        (1 << 17)       /* Bit Stuff Error */
 184 #define TD_CTRL_ACTLEN_MASK     0x7FF   /* actual length, encoded as n - 1 */
 185
 186 #define TD_CTRL_ANY_ERROR       (TD_CTRL_STALLED | TD_CTRL_DBUFERR | \
 187                                  TD_CTRL_BABBLE | TD_CTRL_CRCTIME | \
 188                                  TD_CTRL_BITSTUFF)
 189
 190 #define uhci_maxerr(err)                ((err) << TD_CTRL_C_ERR_SHIFT)
 191 #define uhci_status_bits(ctrl_sts)      ((ctrl_sts) & 0xF60000)
 192 #define uhci_actual_length(ctrl_sts)    (((ctrl_sts) + 1) & \
 193                         TD_CTRL_ACTLEN_MASK)    /* 1-based */
 194
 195 /*
 196  * for TD <info>: (a.k.a. Token)
 197  */
 198 #define td_token(td)            le32_to_cpu((td)->token)
 199 #define TD_TOKEN_DEVADDR_SHIFT  8
 200 #define TD_TOKEN_TOGGLE_SHIFT   19
 201 #define TD_TOKEN_TOGGLE         (1 << 19)
 202 #define TD_TOKEN_EXPLEN_SHIFT   21
 203 #define TD_TOKEN_EXPLEN_MASK    0x7FF   /* expected length, encoded as n-1 */
 204 #define TD_TOKEN_PID_MASK       0xFF
 205
 206 #define uhci_explen(len)        ((((len) - 1) & TD_TOKEN_EXPLEN_MASK) << \
 207                                         TD_TOKEN_EXPLEN_SHIFT)
 208
 209 #define uhci_expected_length(token) ((((token) >> TD_TOKEN_EXPLEN_SHIFT) + \
 210                                         1) & TD_TOKEN_EXPLEN_MASK)
 211 #define uhci_toggle(token)      (((token) >> TD_TOKEN_TOGGLE_SHIFT) & 1)
 212 #define uhci_endpoint(token)    (((token) >> 15) & 0xf)
 213 #define uhci_devaddr(token)     (((token) >> TD_TOKEN_DEVADDR_SHIFT) & 0x7f)
 214 #define uhci_devep(token)       (((token) >> TD_TOKEN_DEVADDR_SHIFT) & 0x7ff)
 215 #define uhci_packetid(token)    ((token) & TD_TOKEN_PID_MASK)
 216 #define uhci_packetout(token)   (uhci_packetid(token) != USB_PID_IN)
 217 #define uhci_packetin(token)    (uhci_packetid(token) == USB_PID_IN)
 218
 219 /*
 220  * The documentation says "4 words for hardware, 4 words for software".
 221  *
 222  * That's silly, the hardware doesn't care. The hardware only cares that
 223  * the hardware words are 16-byte aligned, and we can have any amount of
 224  * sw space after the TD entry.
 225  *
 226  * td->link points to either another TD (not necessarily for the same urb or
 227  * even the same endpoint), or nothing (PTR_TERM), or a QH.
 228  */
 229 struct uhci_td {
 230         /* Hardware fields */
 231         __le32 link;
 232         __le32 status;
 233         __le32 token;
 234         __le32 buffer;
 235
 236         /* Software fields */
 237         dma_addr_t dma_handle;
 238
 239         struct list_head list;
 240
 241         int frame;                      /* for iso: what frame? */
 242         struct list_head fl_list;
 243 } __attribute__((aligned(16)));
 244
 245 /*
 246  * We need a special accessor for the control/status word because it is
 247  * subject to asynchronous updates by the controller.
 248  */
 249 static inline u32 td_status(struct uhci_td *td) {
 250         __le32 status = td->status;
 251
 252         barrier();
 253         return le32_to_cpu(status);
 254 }
 255
 256
 257 /*
 258  *      Skeleton Queue Headers
 259  */
 260
 261 /*
 262  * The UHCI driver uses QHs with Interrupt, Control and Bulk URBs for
 263  * automatic queuing. To make it easy to insert entries into the schedule,
 264  * we have a skeleton of QHs for each predefined Interrupt latency,
 265  * low-speed control, full-speed control, bulk, and terminating QH
 266  * (see explanation for the terminating QH below).
 267  *
 268  * When we want to add a new QH, we add it to the end of the list for the
 269  * skeleton QH.  For instance, the schedule list can look like this:
 270  *
 271  * skel int128 QH
 272  * dev 1 interrupt QH
 273  * dev 5 interrupt QH
 274  * skel int64 QH
 275  * skel int32 QH
 276  * ...
 277  * skel int1 QH
 278  * skel low-speed control QH
 279  * dev 5 control QH
 280  * skel full-speed control QH
 281  * skel bulk QH
 282  * dev 1 bulk QH
 283  * dev 2 bulk QH
 284  * skel terminating QH
 285  *
 286  * The terminating QH is used for 2 reasons:
 287  * - To place a terminating TD which is used to workaround a PIIX bug
 288  *   (see Intel errata for explanation), and
 289  * - To loop back to the full-speed control queue for full-speed bandwidth
 290  *   reclamation.
 291  *
 292  * There's a special skeleton QH for Isochronous QHs.  It never appears
 293  * on the schedule, and Isochronous TDs go on the schedule before the
 294  * the skeleton QHs.  The hardware accesses them directly rather than
 295  * through their QH, which is used only for bookkeeping purposes.
 296  * While the UHCI spec doesn't forbid the use of QHs for Isochronous,
 297  * it doesn't use them either.  And the spec says that queues never
 298  * advance on an error completion status, which makes them totally
 299  * unsuitable for Isochronous transfers.
 300  */
 301
 302 #define UHCI_NUM_SKELQH         14
 303 #define skel_unlink_qh          skelqh[0]
 304 #define skel_iso_qh             skelqh[1]
 305 #define skel_int128_qh          skelqh[2]
 306 #define skel_int64_qh           skelqh[3]
 307 #define skel_int32_qh           skelqh[4]
 308 #define skel_int16_qh           skelqh[5]
 309 #define skel_int8_qh            skelqh[6]
 310 #define skel_int4_qh            skelqh[7]
 311 #define skel_int2_qh            skelqh[8]
 312 #define skel_int1_qh            skelqh[9]
 313 #define skel_ls_control_qh      skelqh[10]
 314 #define skel_fs_control_qh      skelqh[11]
 315 #define skel_bulk_qh            skelqh[12]
 316 #define skel_term_qh            skelqh[13]
 317
 318 /*
 319  * Search tree for determining where <interval> fits in the skelqh[]
 320  * skeleton.
 321  *
 322  * An interrupt request should be placed into the slowest skelqh[]
 323  * which meets the interval/period/frequency requirement.
 324  * An interrupt request is allowed to be faster than <interval> but not slower.
 325  *
 326  * For a given <interval>, this function returns the appropriate/matching
 327  * skelqh[] index value.
 328  */
 329 static inline int __interval_to_skel(int interval)
 330 {
 331         if (interval < 16) {
 332                 if (interval < 4) {
 333                         if (interval < 2)
 334                                 return 9;       /* int1 for 0-1 ms */
 335                         return 8;               /* int2 for 2-3 ms */
 336                 }
 337                 if (interval < 8)
 338                         return 7;               /* int4 for 4-7 ms */
 339                 return 6;                       /* int8 for 8-15 ms */
 340         }
 341         if (interval < 64) {
 342                 if (interval < 32)
 343                         return 5;               /* int16 for 16-31 ms */
 344                 return 4;                       /* int32 for 32-63 ms */
 345         }
 346         if (interval < 128)
 347                 return 3;                       /* int64 for 64-127 ms */
 348         return 2;                               /* int128 for 128-255 ms (Max.) */
 349 }
 350
 351
 352 /*
 353  *      The UHCI controller and root hub
 354  */
 355
 356 /*
 357  * States for the root hub:
 358  *
 359  * To prevent "bouncing" in the presence of electrical noise,
 360  * when there are no devices attached we delay for 1 second in the
 361  * RUNNING_NODEVS state before switching to the AUTO_STOPPED state.
 362  *
 363  * (Note that the AUTO_STOPPED state won't be necessary once the hub
 364  * driver learns to autosuspend.)
 365  */
 366 enum uhci_rh_state {
 367         /* In the following states the HC must be halted.
 368          * These two must come first. */
 369         UHCI_RH_RESET,
 370         UHCI_RH_SUSPENDED,
 371
 372         UHCI_RH_AUTO_STOPPED,
 373         UHCI_RH_RESUMING,
 374
 375         /* In this state the HC changes from running to halted,
 376          * so it can legally appear either way. */
 377         UHCI_RH_SUSPENDING,
 378
 379         /* In the following states it's an error if the HC is halted.
 380          * These two must come last. */
 381         UHCI_RH_RUNNING,                /* The normal state */
 382         UHCI_RH_RUNNING_NODEVS,         /* Running with no devices attached */
 383 };
 384
 385 /*
 386  * The full UHCI controller information:
 387  */
 388 struct uhci_hcd {
 389
 390         /* debugfs */
 391         struct dentry *dentry;
 392
 393         /* Grabbed from PCI */
 394         unsigned long io_addr;
 395
 396         struct dma_pool *qh_pool;
 397         struct dma_pool *td_pool;
 398
 399         struct uhci_td *term_td;        /* Terminating TD, see UHCI bug */
 400         struct uhci_qh *skelqh[UHCI_NUM_SKELQH];        /* Skeleton QHs */
 401         struct uhci_qh *next_qh;        /* Next QH to scan */
 402
 403         spinlock_t lock;
 404
 405         dma_addr_t frame_dma_handle;    /* Hardware frame list */
 406         __le32 *frame;
 407         void **frame_cpu;               /* CPU's frame list */
 408
 409         unsigned long fsbr_jiffies;     /* Time when FSBR was last wanted */
 410
 411         enum uhci_rh_state rh_state;
 412         unsigned long auto_stop_time;           /* When to AUTO_STOP */
 413
 414         unsigned int frame_number;              /* As of last check */
 415         unsigned int is_stopped;
 416 #define UHCI_IS_STOPPED         9999            /* Larger than a frame # */
 417
 418         unsigned int scan_in_progress:1;        /* Schedule scan is running */
 419         unsigned int need_rescan:1;             /* Redo the schedule scan */
 420         unsigned int hc_inaccessible:1;         /* HC is suspended or dead */
 421         unsigned int working_RD:1;              /* Suspended root hub doesn't
 422                                                    need to be polled */
 423         unsigned int is_initialized:1;          /* Data structure is usable */
 424         unsigned int fsbr_is_on:1;              /* FSBR is turned on */
 425
 426         /* Support for port suspend/resume/reset */
 427         unsigned long port_c_suspend;           /* Bit-arrays of ports */
 428         unsigned long resuming_ports;
 429         unsigned long ports_timeout;            /* Time to stop signalling */
 430
 431         struct list_head idle_qh_list;          /* Where the idle QHs live */
 432
 433         int rh_numports;                        /* Number of root-hub ports */
 434
 435         wait_queue_head_t waitqh;               /* endpoint_disable waiters */
 436         int num_waiting;                        /* Number of waiters */
 437 };
 438
 439 /* Convert between a usb_hcd pointer and the corresponding uhci_hcd */
 440 static inline struct uhci_hcd *hcd_to_uhci(struct usb_hcd *hcd)
 441 {
 442         return (struct uhci_hcd *) (hcd->hcd_priv);
 443 }
 444 static inline struct usb_hcd *uhci_to_hcd(struct uhci_hcd *uhci)
 445 {
 446         return container_of((void *) uhci, struct usb_hcd, hcd_priv);
 447 }
 448
 449 #define uhci_dev(u)     (uhci_to_hcd(u)->self.controller)
 450
 451 /* Utility macro for comparing frame numbers */
 452 #define uhci_frame_before_eq(f1, f2)    (0 <= (int) ((f2) - (f1)))
 453
 454
 455 /*
 456  *      Private per-URB data
 457  */
 458 struct urb_priv {
 459         struct list_head node;          /* Node in the QH's urbp list */
 460
 461         struct urb *urb;
 462
 463         struct uhci_qh *qh;             /* QH for this URB */
 464         struct list_head td_list;
 465
 466         unsigned fsbr:1;                /* URB wants FSBR */
 467 };
 468
 469
 470 /*
 471  * Locking in uhci.c
 472  *
 473  * Almost everything relating to the hardware schedule and processing
 474  * of URBs is protected by uhci->lock.  urb->status is protected by
 475  * urb->lock; that's the one exception.
 476  *
 477  * To prevent deadlocks, never lock uhci->lock while holding urb->lock.
 478  * The safe order of locking is:
 479  *
 480  * #1 uhci->lock
 481  * #2 urb->lock
 482  */
 483
 484
 485 /* Some special IDs */
 486
 487 #define PCI_VENDOR_ID_GENESYS           0x17a0
 488 #define PCI_DEVICE_ID_GL880S_UHCI       0x8083
 489
 490 #endif