Modules/USB/UHCI/uhci.c

   1 /*
   2  * Acess 2 USB Stack
   3  * Universal Host Controller Interface
   4  */
   5 #define DEBUG   1
   6 #define VERSION VER2(0,5)
   7 #include <acess.h>
   8 #include <vfs.h>
   9 #include <drv_pci.h>
  10 #include <modules.h>
  11 #include <usb_host.h>
  12 #include "uhci.h"
  13
  14 // === CONSTANTS ===
  15 #define MAX_CONTROLLERS 4
  16 #define NUM_TDs 1024
  17
  18 // === PROTOTYPES ===
  19  int    UHCI_Initialise();
  20 void    UHCI_Cleanup();
  21 tUHCI_TD        *UHCI_int_AllocateTD(tUHCI_Controller *Cont);
  22 void    UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD);
  23 void    *UHCI_int_SendTransaction(tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl, tUSBHostCb Cb, void *Data, size_t Length);
  24 void    *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length);
  25 void    *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length);
  26 void    *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length);
  27 void    UHCI_Hub_Poll(tUSBHub *Hub, tUSBDevice *Dev);
  28  int    UHCI_Int_InitHost(tUHCI_Controller *Host);
  29 void    UHCI_CheckPortUpdate(tUHCI_Controller *Host);
  30 void    UHCI_InterruptHandler(int IRQ, void *Ptr);
  31
  32 // === GLOBALS ===
  33 MODULE_DEFINE(0, VERSION, USB_UHCI, UHCI_Initialise, NULL, "USB_Core", NULL);
  34 tUHCI_TD        gaUHCI_TDPool[NUM_TDs];
  35 tUHCI_Controller        gUHCI_Controllers[MAX_CONTROLLERS];
  36 tUSBHostDef     gUHCI_HostDef = {
  37         .SendIN = UHCI_DataIN,
  38         .SendOUT = UHCI_DataOUT,
  39         .SendSETUP = UHCI_SendSetup,
  40         .CheckPorts = (void*)UHCI_CheckPortUpdate
  41         };
  42
  43 // === CODE ===
  44 /**
  45  * \fn int UHCI_Initialise()
  46  * \brief Called to initialise the UHCI Driver
  47  */
  48 int UHCI_Initialise(const char **Arguments)
  49 {
  50          int    i=0, id=-1;
  51          int    ret;
  52
  53         ENTER("");
  54
  55         // Enumerate PCI Bus, getting a maximum of `MAX_CONTROLLERS` devices
  56         while( (id = PCI_GetDeviceByClass(0x0C03, 0xFFFF, id)) >= 0 && i < MAX_CONTROLLERS )
  57         {
  58                 tUHCI_Controller        *cinfo = &gUHCI_Controllers[i];
  59                 // NOTE: Check "protocol" from PCI?
  60
  61                 cinfo->PciId = id;
  62                 cinfo->IOBase = PCI_GetBAR(id, 4);
  63                 if( !(cinfo->IOBase & 1) ) {
  64                         Log_Warning("UHCI", "MMIO is not supported");
  65                         continue ;
  66                 }
  67                 cinfo->IRQNum = PCI_GetIRQ(id);
  68
  69                 Log_Debug("UHCI", "Controller PCI #%i: IO Base = 0x%x, IRQ %i",
  70                         id, cinfo->IOBase, cinfo->IRQNum);
  71
  72                 IRQ_AddHandler(cinfo->IRQNum, UHCI_InterruptHandler, cinfo);
  73
  74                 // Initialise Host
  75                 ret = UHCI_Int_InitHost(&gUHCI_Controllers[i]);
  76                 // Detect an error
  77                 if(ret != 0) {
  78                         LEAVE('i', ret);
  79                         return ret;
  80                 }
  81
  82                 cinfo->RootHub = USB_RegisterHost(&gUHCI_HostDef, cinfo, 2);
  83                 LOG("cinfo->RootHub = %p", cinfo->RootHub);
  84
  85                 i ++;
  86         }
  87         if(i == MAX_CONTROLLERS) {
  88                 Log_Warning("UHCI", "Over "EXPAND_STR(MAX_CONTROLLERS)" UHCI controllers detected, ignoring rest");
  89         }
  90         LEAVE('i', MODULE_ERR_OK);
  91         return MODULE_ERR_OK;
  92 }
  93
  94 /**
  95  * \fn void UHCI_Cleanup()
  96  * \brief Called just before module is unloaded
  97  */
  98 void UHCI_Cleanup()
  99 {
 100 }
 101
 102 tUHCI_TD *UHCI_int_AllocateTD(tUHCI_Controller *Cont)
 103 {
 104          int    i;
 105         for(i = 0; i < NUM_TDs; i ++)
 106         {
 107                 if(gaUHCI_TDPool[i].Link == 0) {
 108                         gaUHCI_TDPool[i].Link = 1;
 109                         return &gaUHCI_TDPool[i];
 110                 }
 111         }
 112         return NULL;
 113 }
 114
 115 void UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD)
 116 {
 117         Log_Warning("UHCI", "TODO: Implement AppendTD");
 118 }
 119
 120 /**
 121  * \brief Send a transaction to the USB bus
 122  * \param Cont  Controller pointer
 123  * \param Addr  Function Address * 16 + Endpoint
 124  * \param bTgl  Data toggle value
 125  */
 126 void *UHCI_int_SendTransaction(tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl, tUSBHostCb Cb, void *Data, size_t Length)
 127 {
 128         tUHCI_TD        *td;
 129
 130         if( Length > 0x400 )    return NULL;    // Controller allows up to 0x500, but USB doesn't
 131
 132         td = UHCI_int_AllocateTD(Cont);
 133
 134         td->Link = 1;
 135         td->Control = (Length - 1) & 0x7FF;
 136         td->Token  = ((Length - 1) & 0x7FF) << 21;
 137         td->Token |= (bTgl & 1) << 19;
 138         td->Token |= (Addr & 0xF) << 15;
 139         td->Token |= ((Addr/16) & 0xFF) << 8;
 140         td->Token |= Type;
 141
 142         // TODO: Ensure 32-bit paddr
 143         if( ((tVAddr)Data & PAGE_SIZE) + Length > PAGE_SIZE ) {
 144                 Log_Warning("UHCI", "TODO: Support non single page transfers");
 145                 // TODO: Need to enable IOC to copy the data back
 146 //              td->BufferPointer =
 147                 return NULL;
 148         }
 149         else {
 150                 td->BufferPointer = MM_GetPhysAddr( (tVAddr)Data );
 151         }
 152
 153         // Interrupt on completion
 154         if( Cb ) {
 155                 td->Control |= (1 << 24);
 156                 td->Avaliable[0] = (tVAddr)Cb;  // NOTE: if ERRPTR then the TD is kept allocated until checked
 157                 #if BITS > 32
 158                 td->Avaliable[1] = (tVAddr)Cb >> 32;
 159                 #endif
 160                 Log_Warning("UHCI", "TODO: Support IOC... somehow");
 161         }
 162
 163         UHCI_int_AppendTD(Cont, td);
 164
 165         return td;
 166 }
 167
 168 void *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
 169 {
 170         return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x69, DataTgl, Cb, Data, Length);
 171 }
 172
 173 void *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
 174 {
 175         return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0xE1, DataTgl, Cb, Data, Length);
 176 }
 177
 178 void *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
 179 {
 180         return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x2D, DataTgl, Cb, Data, Length);
 181 }
 182
 183 void UHCI_Hub_Poll(tUSBHub *Hub, tUSBDevice *Dev)
 184 {
 185         tUHCI_Controller *cont = USB_GetDeviceDataPtr(Dev);
 186
 187         UHCI_CheckPortUpdate(cont);
 188 }
 189
 190 // === INTERNAL FUNCTIONS ===
 191 /**
 192  * \fn int UHCI_Int_InitHost(tUCHI_Controller *Host)
 193  * \brief Initialises a UHCI host controller
 194  * \param Host  Pointer - Host to initialise
 195  */
 196 int UHCI_Int_InitHost(tUHCI_Controller *Host)
 197 {
 198         ENTER("pHost", Host);
 199
 200         outw( Host->IOBase + USBCMD, 4 );       // GRESET
 201         Time_Delay(10);
 202         // TODO: Wait for at least 10ms
 203         outw( Host->IOBase + USBCMD, 0 );       // GRESET
 204
 205         // Allocate Frame List
 206         // - 1 Page, 32-bit address
 207         // - 1 page = 1024  4 byte entries
 208         Host->FrameList = (void *) MM_AllocDMA(1, 32, &Host->PhysFrameList);
 209         if( !Host->FrameList ) {
 210                 Log_Warning("UHCI", "Unable to allocate frame list, aborting");
 211                 LEAVE('i', -1);
 212                 return -1;
 213         }
 214         LOG("Allocated frame list 0x%x (0x%x)", Host->FrameList, Host->PhysFrameList);
 215         memsetd( Host->FrameList, 1, 1024 );    // Clear List (Disabling all entries)
 216
 217         //! \todo Properly fill frame list
 218
 219         // Set frame length to 1 ms
 220         outb( Host->IOBase + SOFMOD, 64 );
 221
 222         // Set Frame List
 223         outd( Host->IOBase + FLBASEADD, Host->PhysFrameList );
 224         outw( Host->IOBase + FRNUM, 0 );
 225
 226         // Enable Interrupts
 227         outw( Host->IOBase + USBINTR, 0x000F );
 228         PCI_ConfigWrite( Host->PciId, 0xC0, 2, 0x2000 );
 229
 230         outw( Host->IOBase + USBCMD, 0x0001 );
 231
 232         LEAVE('i', 0);
 233         return 0;
 234 }
 235
 236 void UHCI_CheckPortUpdate(tUHCI_Controller *Host)
 237 {
 238         // Enable ports
 239         for( int i = 0; i < 2; i ++ )
 240         {
 241                  int    port = Host->IOBase + PORTSC1 + i*2;
 242                 // Check for port change
 243                 if( !(inw(port) & 0x0002) )     continue;
 244                 outw(port, 0x0002);
 245
 246                 // Check if the port is connected
 247                 if( !(inw(port) & 1) )
 248                 {
 249                         // Tell the USB code it's gone.
 250                         USB_DeviceDisconnected(Host->RootHub, i);
 251                         continue;
 252                 }
 253                 else
 254                 {
 255                         LOG("Port %i has something", i);
 256                         // Reset port (set bit 9)
 257                         LOG("Reset");
 258                         outw( port, 0x0100 );
 259                         Time_Delay(50); // 50ms delay
 260                         outw( port, inw(port) & ~0x0100 );
 261                         // Enable port
 262                         LOG("Enable");
 263                         Time_Delay(50); // 50ms delay
 264                         outw( port, inw(port) & 0x0004 );
 265                         // Tell USB there's a new device
 266                         USB_DeviceConnected(Host->RootHub, i);
 267                 }
 268         }
 269 }
 270
 271 void UHCI_InterruptHandler(int IRQ, void *Ptr)
 272 {
 273         Log_Debug("UHCI", "UHIC Interrupt");
 274 }