src/usb-uhci.h

   1 #ifndef __USB_UHCI_H
   2 #define __USB_UHCI_H
   3
   4 // usb-uhci.c
   5 struct usb_s;
   6 int uhci_init(struct usb_s *cntl);
   7 int uhci_control(u32 endp, int dir, const void *cmd, int cmdsize
   8                  , void *data, int datasize);
   9 void *uhci_alloc_intr_pipe(u32 endp, int period);
  10 int uhci_poll_intr(void *pipe, void *data);
  11
  12
  13 /****************************************************************
  14  * uhci structs and flags
  15  ****************************************************************/
  16
  17 /* USB port status and control registers */
  18 #define USBPORTSC1      16
  19 #define USBPORTSC2      18
  20 #define   USBPORTSC_CCS         0x0001  /* Current Connect Status
  21                                          * ("device present") */
  22 #define   USBPORTSC_CSC         0x0002  /* Connect Status Change */
  23 #define   USBPORTSC_PE          0x0004  /* Port Enable */
  24 #define   USBPORTSC_PEC         0x0008  /* Port Enable Change */
  25 #define   USBPORTSC_DPLUS       0x0010  /* D+ high (line status) */
  26 #define   USBPORTSC_DMINUS      0x0020  /* D- high (line status) */
  27 #define   USBPORTSC_RD          0x0040  /* Resume Detect */
  28 #define   USBPORTSC_RES1        0x0080  /* reserved, always 1 */
  29 #define   USBPORTSC_LSDA        0x0100  /* Low Speed Device Attached */
  30 #define   USBPORTSC_PR          0x0200  /* Port Reset */
  31
  32 /* Legacy support register */
  33 #define USBLEGSUP               0xc0
  34 #define   USBLEGSUP_RWC         0x8f00  /* the R/WC bits */
  35
  36 /* Command register */
  37 #define USBCMD          0
  38 #define   USBCMD_RS             0x0001  /* Run/Stop */
  39 #define   USBCMD_HCRESET        0x0002  /* Host reset */
  40 #define   USBCMD_GRESET         0x0004  /* Global reset */
  41 #define   USBCMD_EGSM           0x0008  /* Global Suspend Mode */
  42 #define   USBCMD_FGR            0x0010  /* Force Global Resume */
  43 #define   USBCMD_SWDBG          0x0020  /* SW Debug mode */
  44 #define   USBCMD_CF             0x0040  /* Config Flag (sw only) */
  45 #define   USBCMD_MAXP           0x0080  /* Max Packet (0 = 32, 1 = 64) */
  46
  47 /* Status register */
  48 #define USBSTS          2
  49 #define   USBSTS_USBINT         0x0001  /* Interrupt due to IOC */
  50 #define   USBSTS_ERROR          0x0002  /* Interrupt due to error */
  51 #define   USBSTS_RD             0x0004  /* Resume Detect */
  52 #define   USBSTS_HSE            0x0008  /* Host System Error: PCI problems */
  53 #define   USBSTS_HCPE           0x0010  /* Host Controller Process Error:
  54                                          * the schedule is buggy */
  55 #define   USBSTS_HCH            0x0020  /* HC Halted */
  56
  57 /* Interrupt enable register */
  58 #define USBINTR         4
  59 #define   USBINTR_TIMEOUT       0x0001  /* Timeout/CRC error enable */
  60 #define   USBINTR_RESUME        0x0002  /* Resume interrupt enable */
  61 #define   USBINTR_IOC           0x0004  /* Interrupt On Complete enable */
  62 #define   USBINTR_SP            0x0008  /* Short packet interrupt enable */
  63
  64 #define USBFRNUM        6
  65 #define USBFLBASEADD    8
  66 #define USBSOF          12
  67 #define   USBSOF_DEFAULT        64      /* Frame length is exactly 1 ms */
  68
  69 struct uhci_framelist {
  70     u32 links[1024];
  71 } PACKED;
  72
  73 #define TD_CTRL_SPD             (1 << 29)       /* Short Packet Detect */
  74 #define TD_CTRL_C_ERR_MASK      (3 << 27)       /* Error Counter bits */
  75 #define TD_CTRL_C_ERR_SHIFT     27
  76 #define TD_CTRL_LS              (1 << 26)       /* Low Speed Device */
  77 #define TD_CTRL_IOS             (1 << 25)       /* Isochronous Select */
  78 #define TD_CTRL_IOC             (1 << 24)       /* Interrupt on Complete */
  79 #define TD_CTRL_ACTIVE          (1 << 23)       /* TD Active */
  80 #define TD_CTRL_STALLED         (1 << 22)       /* TD Stalled */
  81 #define TD_CTRL_DBUFERR         (1 << 21)       /* Data Buffer Error */
  82 #define TD_CTRL_BABBLE          (1 << 20)       /* Babble Detected */
  83 #define TD_CTRL_NAK             (1 << 19)       /* NAK Received */
  84 #define TD_CTRL_CRCTIMEO        (1 << 18)       /* CRC/Time Out Error */
  85 #define TD_CTRL_BITSTUFF        (1 << 17)       /* Bit Stuff Error */
  86 #define TD_CTRL_ACTLEN_MASK     0x7FF   /* actual length, encoded as n - 1 */
  87
  88 #define TD_CTRL_ANY_ERROR       (TD_CTRL_STALLED | TD_CTRL_DBUFERR | \
  89                                  TD_CTRL_BABBLE | TD_CTRL_CRCTIME | \
  90                                  TD_CTRL_BITSTUFF)
  91 #define uhci_maxerr(err)                ((err) << TD_CTRL_C_ERR_SHIFT)
  92
  93 #define TD_TOKEN_DEVADDR_SHIFT  8
  94 #define TD_TOKEN_TOGGLE_SHIFT   19
  95 #define TD_TOKEN_TOGGLE         (1 << 19)
  96 #define TD_TOKEN_EXPLEN_SHIFT   21
  97 #define TD_TOKEN_EXPLEN_MASK    0x7FF   /* expected length, encoded as n-1 */
  98 #define TD_TOKEN_PID_MASK       0xFF
  99
 100 #define uhci_explen(len)        ((((len) - 1) & TD_TOKEN_EXPLEN_MASK) << \
 101                                         TD_TOKEN_EXPLEN_SHIFT)
 102
 103 #define uhci_expected_length(token) ((((token) >> TD_TOKEN_EXPLEN_SHIFT) + \
 104                                         1) & TD_TOKEN_EXPLEN_MASK)
 105
 106 struct uhci_td {
 107     u32 link;
 108     u32 status;
 109     u32 token;
 110     void *buffer;
 111
 112     // Software fields
 113     u32 data[4];
 114 } PACKED;
 115
 116 struct uhci_qh {
 117     u32 link;
 118     u32 element;
 119
 120     // Software fields
 121     struct uhci_td *next_td;
 122     u32 reserved;
 123 } PACKED;
 124
 125 #define UHCI_PTR_BITS           0x000F
 126 #define UHCI_PTR_TERM           0x0001
 127 #define UHCI_PTR_QH             0x0002
 128 #define UHCI_PTR_DEPTH          0x0004
 129 #define UHCI_PTR_BREADTH        0x0000
 130
 131 #endif // usb-uhci.h