Modules/USB/UHCI/uhci.h

   1 /*
   2  * AcessOS Version 1
   3  * USB Stack
   4  * - Universal Host Controller Interface
   5  */
   6 #ifndef _UHCI_H_
   7 #define _UHCI_H_
   8
   9 // === TYPES ===
  10 typedef struct sUHCI_Controller tUHCI_Controller;
  11 typedef struct sUHCI_TD tUHCI_TD;
  12 typedef struct sUHCI_QH tUHCI_QH;
  13
  14 // === STRUCTURES ===
  15 struct sUHCI_Controller
  16 {
  17         /**
  18          * \brief PCI Device ID
  19          */
  20         Uint16  PciId;
  21
  22         /**
  23          * \brief IO Base Address
  24          */
  25         Uint16  IOBase;
  26
  27         /**
  28          * \brief IRQ Number assigned to the device
  29          */
  30          int    IRQNum;
  31
  32         /**
  33          * \brief Frame list
  34          *
  35          * 31:4 - Frame Pointer
  36          * 3:2 - Reserved
  37          * 1 - QH/TD Selector
  38          * 0 - Terminate (Empty Pointer)
  39          */
  40         Uint32  *FrameList;
  41
  42         /**
  43          * \brief Physical Address of the Frame List
  44          */
  45         tPAddr  PhysFrameList;
  46
  47         tUSBHub *RootHub;
  48 };
  49
  50 struct sUHCI_TD
  51 {
  52         /**
  53          * \brief Next Entry in list
  54          *
  55          * 31:4 - Address
  56          * 3 - Reserved
  57          * 2 - Depth/Breadth Select
  58          * 1 - QH/TD Select
  59          * 0 - Terminate (Last in List)
  60          */
  61         Uint32  Link;
  62
  63         /**
  64          * \brief Control and Status Field
  65          *
  66          * 31:30 - Reserved
  67          * 29 - Short Packet Detect (Input Only)
  68          * 28:27 - Number of Errors Allowed
  69          * 26 - Low Speed Device (Communicating with a low speed device)
  70          * 25 - Isynchonious Select
  71          * 24 - Interrupt on Completion (IOC)
  72          * 23:16 - Status
  73          *     23 - Active
  74          *     22 - Stalled
  75          *     21 - Data Buffer Error
  76          *     20 - Babble Detected
  77          *     19 - NAK Detected
  78          *     18 - CRC/Timout Error
  79          *     17 - Bitstuff Error
  80          *     16 - Reserved
  81          * 15:11 - Reserved
  82          * 10:0 - Actual Length (Number of bytes transfered)
  83          */
  84         Uint32  Control;
  85
  86         /**
  87          * \brief Packet Header
  88          *
  89          * 31:21 - Maximum Length (0=1, Max 0x4FF, 0x7FF=0)
  90          * 20 - Reserved
  91          * 19 - Data Toggle
  92          * 18:15 - Endpoint
  93          * 14:8 - Device Address
  94          * 7:0 - PID (Packet Identifcation) - Only 96, E1, 2D allowed
  95          *
  96          * 0x96 = Data IN
  97          * 0xE1 = Data Out
  98          * 0x2D = Setup
  99          */
 100         Uint32  Token;
 101
 102         /**
 103          * \brief Pointer to the data to send
 104          */
 105         Uint32  BufferPointer;
 106
 107         union
 108         {
 109                 /**
 110                  * \brief Avaliable for use by software
 111                  */
 112                 Uint32  Avaliable[4];
 113
 114                 struct
 115                 {
 116                         void    *Callback;
 117                         void    *DestPtr;
 118                 } _info;
 119         };
 120 };
 121
 122 struct sUHCI_QH
 123 {
 124         /**
 125          * \brief Next Entry in list
 126          *
 127          * 31:4 - Address
 128          * 3:2 - Reserved
 129          * 1 - QH/TD Select
 130          * 0 - Terminate (Last in List)
 131          */
 132         Uint32  Next;
 133
 134
 135         /**
 136          * \brief Next Entry in list
 137          *
 138          * 31:4 - Address
 139          * 3:2 - Reserved
 140          * 1 - QH/TD Select
 141          * 0 - Terminate (Last in List)
 142          */
 143         Uint32  Child;
 144 };
 145
 146 // === ENUMERATIONS ===
 147 enum eUHCI_IOPorts {
 148         /**
 149          * \brief USB Command Register
 150          *
 151          * 15:8 - Reserved
 152          * 7 - Maximum Packet Size selector (1: 64 bytes, 0: 32 bytes)
 153          * 6 - Configure Flag (No Hardware Effect)
 154          * 5 - Software Debug (Don't think it will be needed)
 155          * 4 - Force Global Resume
 156          * 3 - Enter Global Suspend Mode
 157          * 2 - Global Reset (Resets all devices on the bus)
 158          * 1 - Host Controller Reset (Reset just the controller)
 159          * 0 - Run/Stop
 160          */
 161         USBCMD  = 0x00,
 162         /**
 163          * \brief USB Status Register
 164          *
 165          * 15:6 - Reserved
 166          * 5 - HC Halted, set to 1 when USBCMD:RS is set to 0
 167          * 4 - Host Controller Process Error (Errors related to the bus)
 168          * 3 - Host System Error (Errors related to the OS/PCI Bus)
 169          * 2 - Resume Detect (Set if a RESUME command is sent to the Controller)
 170          * 1 - USB Error Interrupt
 171          * 0 - USB Interrupts (Set if a transaction with the IOC bit set is completed)
 172          */
 173         USBSTS  = 0x02,
 174         /**
 175          * \brief USB Interrupt Enable Register
 176          *
 177          * 15:4 - Reserved
 178          * 3 - Short Packet Interrupt Enable
 179          * 2 - Interrupt on Complete (IOC) Enable
 180          * 1 - Resume Interrupt Enable
 181          * 0 - Timout / CRC Error Interrupt Enable
 182          */
 183         USBINTR = 0x04,
 184         /**
 185          * \brief Frame Number (Index into the Frame List)
 186          *
 187          * 15:11 - Reserved
 188          * 10:0 - Index (Incremented each approx 1ms)
 189          */
 190         FRNUM   = 0x06,
 191         /**
 192          * \brief Frame List Base Address
 193          *
 194          * 31:12 - Pysical Address >> 12
 195          * 11:0 - Reserved (Set to Zero)
 196          */
 197         FLBASEADD = 0x08,       // 32-bit
 198         /**
 199          * \brief Start-of-frame Modify Register
 200          * \note 8-bits only
 201          *
 202          * Sets the size of a frame
 203          * Frequency = (11936+n)/12000 kHz
 204          *
 205          * 7 - Reserved
 206          * 6:0 -
 207          */
 208         SOFMOD = 0x0C,  // 8bit
 209         /**
 210          * \brief Port Status and Controll Register (Port 1)
 211          *
 212          * 15:13 - Reserved
 213          * 12 - Suspend
 214          * 11:10 - Reserved
 215          * 9 - Port Reset
 216          * 8 - Low Speed Device Attached
 217          * 5:4 - Line Status
 218          * 3 - Port Enable/Disable Change - Used for detecting device removal
 219          * 2 - Port Enable/Disable
 220          * 1 - Connect Status Change
 221          * 0 - Current Connect Status
 222          */
 223         PORTSC1 = 0x10,
 224         /**
 225          * \brief Port Status and Controll Register (Port 2)
 226          *
 227          * See ::PORTSC1
 228          */
 229         PORTSC2 = 0x12
 230 };
 231
 232 #endif