Modules/USB/UHCI/uhci.c

   1 /*
   2  * Acess 2 USB Stack
   3  * - By John Hodge (thePowersGang)
   4  *
   5  * Universal Host Controller Interface
   6  */
   7 #define DEBUG   0
   8 #define VERSION VER2(0,5)
   9 #include <acess.h>
  10 #include <vfs.h>
  11 #include <drv_pci.h>
  12 #include <modules.h>
  13 #include <usb_host.h>
  14 #include "uhci.h"
  15
  16 // === CONSTANTS ===
  17 #define MAX_CONTROLLERS 4
  18 #define NUM_TDs 1024
  19
  20 // === PROTOTYPES ===
  21  int    UHCI_Initialise();
  22 void    UHCI_Cleanup();
  23 tUHCI_TD        *UHCI_int_AllocateTD(tUHCI_Controller *Cont);
  24 void    UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD);
  25 void    *UHCI_int_SendTransaction(tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
  26 void    *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
  27 void    *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData,  void *Buf, size_t Length);
  28 void    *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
  29  int    UHCI_IsTransferComplete(void *Ptr, void *Handle);
  30  int    UHCI_Int_InitHost(tUHCI_Controller *Host);
  31 void    UHCI_CheckPortUpdate(void *Ptr);
  32 void    UHCI_InterruptHandler(int IRQ, void *Ptr);
  33
  34 // === GLOBALS ===
  35 MODULE_DEFINE(0, VERSION, USB_UHCI, UHCI_Initialise, NULL, "USB_Core", NULL);
  36 tUHCI_TD        gaUHCI_TDPool[NUM_TDs];
  37 tUHCI_Controller        gUHCI_Controllers[MAX_CONTROLLERS];
  38 tUSBHostDef     gUHCI_HostDef = {
  39         .SendIN = UHCI_DataIN,
  40         .SendOUT = UHCI_DataOUT,
  41         .SendSETUP = UHCI_SendSetup,
  42         .CheckPorts = UHCI_CheckPortUpdate,
  43         .IsOpComplete = UHCI_IsTransferComplete
  44         };
  45
  46 // === CODE ===
  47 /**
  48  * \fn int UHCI_Initialise()
  49  * \brief Called to initialise the UHCI Driver
  50  */
  51 int UHCI_Initialise(const char **Arguments)
  52 {
  53          int    i=0, id=-1;
  54          int    ret;
  55
  56         ENTER("");
  57
  58         // Enumerate PCI Bus, getting a maximum of `MAX_CONTROLLERS` devices
  59         while( (id = PCI_GetDeviceByClass(0x0C03, 0xFFFF, id)) >= 0 && i < MAX_CONTROLLERS )
  60         {
  61                 tUHCI_Controller        *cinfo = &gUHCI_Controllers[i];
  62                 // NOTE: Check "protocol" from PCI?
  63
  64                 cinfo->PciId = id;
  65                 cinfo->IOBase = PCI_GetBAR(id, 4);
  66                 if( !(cinfo->IOBase & 1) ) {
  67                         Log_Warning("UHCI", "MMIO is not supported");
  68                         continue ;
  69                 }
  70                 cinfo->IOBase &= ~1;
  71                 cinfo->IRQNum = PCI_GetIRQ(id);
  72
  73                 Log_Debug("UHCI", "Controller PCI #%i: IO Base = 0x%x, IRQ %i",
  74                         id, cinfo->IOBase, cinfo->IRQNum);
  75
  76                 IRQ_AddHandler(cinfo->IRQNum, UHCI_InterruptHandler, cinfo);
  77
  78                 // Initialise Host
  79                 ret = UHCI_Int_InitHost(&gUHCI_Controllers[i]);
  80                 // Detect an error
  81                 if(ret != 0) {
  82                         LEAVE('i', ret);
  83                         return ret;
  84                 }
  85
  86                 cinfo->RootHub = USB_RegisterHost(&gUHCI_HostDef, cinfo, 2);
  87                 LOG("cinfo->RootHub = %p", cinfo->RootHub);
  88
  89                 UHCI_CheckPortUpdate(cinfo);
  90
  91                 i ++;
  92         }
  93         if(i == MAX_CONTROLLERS) {
  94                 Log_Warning("UHCI", "Over "EXPAND_STR(MAX_CONTROLLERS)" UHCI controllers detected, ignoring rest");
  95         }
  96         LEAVE('i', MODULE_ERR_OK);
  97         return MODULE_ERR_OK;
  98 }
  99
 100 /**
 101  * \fn void UHCI_Cleanup()
 102  * \brief Called just before module is unloaded
 103  */
 104 void UHCI_Cleanup()
 105 {
 106 }
 107
 108 tUHCI_TD *UHCI_int_AllocateTD(tUHCI_Controller *Cont)
 109 {
 110          int    i;
 111         for(i = 0; i < NUM_TDs; i ++)
 112         {
 113                 if(gaUHCI_TDPool[i].Link == 0) {
 114                         gaUHCI_TDPool[i].Link = 1;
 115                         gaUHCI_TDPool[i].Control = 1 << 23;
 116                         return &gaUHCI_TDPool[i];
 117                 }
 118                 // Still in use? Skip
 119                 if( gaUHCI_TDPool[i].Control & (1 << 23) )
 120                         continue ;
 121                 // Is there a callback on it? Skip
 122                 if( gaUHCI_TDPool[i]._info.Callback )
 123                         continue ;
 124                 // TODO: Garbage collect, but that means removing from the list too
 125                 #if 0
 126                 // Ok, this is actually unused
 127                 gaUHCI_TDPool[i].Link = 1;
 128                 gaUHCI_TDPool[i].Control = 1 << 23;
 129                 return &gaUHCI_TDPool[i];
 130                 #endif
 131         }
 132         return NULL;
 133 }
 134
 135 tUHCI_TD *UHCI_int_GetTDFromPhys(tPAddr PAddr)
 136 {
 137         // TODO: Fix this to work with a non-contiguous pool
 138         static tPAddr   td_pool_base;
 139         if(!td_pool_base)       td_pool_base = MM_GetPhysAddr( (tVAddr)gaUHCI_TDPool );
 140         return gaUHCI_TDPool + (PAddr - td_pool_base) / sizeof(gaUHCI_TDPool[0]);
 141 }
 142
 143 void UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD)
 144 {
 145          int    next_frame = (inw(Cont->IOBase + FRNUM) + 2) & (1024-1);
 146         tUHCI_TD        *prev_td;
 147         Uint32  link;
 148
 149         // TODO: How to handle FRNUM incrementing while we are in this function?
 150
 151         // Empty list
 152         if( Cont->FrameList[next_frame] & 1 )
 153         {
 154                 // TODO: Ensure 32-bit paddr
 155                 Cont->FrameList[next_frame] = MM_GetPhysAddr( (tVAddr)TD );
 156                 TD->Control |= (1 << 24);       // Ensure that there is an interrupt for each used frame
 157                 LOG("next_frame = %i", next_frame);
 158                 return;
 159         }
 160
 161         // Find the end of the list
 162         link = Cont->FrameList[next_frame];
 163         do {
 164                 prev_td = UHCI_int_GetTDFromPhys(link);
 165                 link = prev_td->Link;
 166         } while( !(link & 1) );
 167
 168         // Append
 169         prev_td->Link = MM_GetPhysAddr( (tVAddr)TD );
 170
 171         LOG("next_frame = %i, prev_td = %p", next_frame, prev_td);
 172 }
 173
 174 /**
 175  * \brief Send a transaction to the USB bus
 176  * \param Cont  Controller pointer
 177  * \param Addr  Function Address * 16 + Endpoint
 178  * \param bTgl  Data toggle value
 179  */
 180 void *UHCI_int_SendTransaction(
 181         tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl,
 182         tUSBHostCb Cb, void *CbData, void *Data, size_t Length)
 183 {
 184         tUHCI_TD        *td;
 185
 186         if( Length > 0x400 )    return NULL;    // Controller allows up to 0x500, but USB doesn't
 187
 188         td = UHCI_int_AllocateTD(Cont);
 189
 190         if( !td ) {
 191                 // TODO: Wait for one to free?
 192                 Log_Error("UHCI", "No avaliable TDs, transaction dropped");
 193                 return NULL;
 194         }
 195
 196         td->Link = 1;
 197         td->Control = (Length - 1) & 0x7FF;
 198         td->Control |= (1 << 23);
 199         td->Token  = ((Length - 1) & 0x7FF) << 21;
 200         td->Token |= (bTgl & 1) << 19;
 201         td->Token |= (Addr & 0xF) << 15;
 202         td->Token |= ((Addr/16) & 0xFF) << 8;
 203         td->Token |= Type;
 204
 205         // TODO: Ensure 32-bit paddr
 206         if( ((tVAddr)Data & (PAGE_SIZE-1)) + Length > PAGE_SIZE ) {
 207                 Log_Warning("UHCI", "TODO: Support non single page transfers (%x + %x > %x)",
 208                         (tVAddr)Data & (PAGE_SIZE-1), Length, PAGE_SIZE
 209                         );
 210                 // TODO: Need to enable IOC to copy the data back
 211 //              td->BufferPointer =
 212                 td->_info.bCopyData = 1;
 213                 return NULL;
 214         }
 215         else {
 216                 td->BufferPointer = MM_GetPhysAddr( (tVAddr)Data );
 217                 td->_info.bCopyData = 0;
 218         }
 219
 220         // Interrupt on completion
 221         if( Cb ) {
 222                 td->Control |= (1 << 24);
 223                 LOG("IOC Cb=%p CbData=%p", Cb, CbData);
 224                 td->_info.Callback = Cb;        // NOTE: if ERRPTR then the TD is kept allocated until checked
 225                 td->_info.CallbackPtr = CbData;
 226         }
 227
 228         td->_info.DataPtr = Data;
 229
 230         UHCI_int_AppendTD(Cont, td);
 231
 232         return td;
 233 }
 234
 235 void *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
 236 {
 237         return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x69, DataTgl, Cb, CbData, Buf, Length);
 238 }
 239
 240 void *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
 241 {
 242         return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0xE1, DataTgl, Cb, CbData, Buf, Length);
 243 }
 244
 245 void *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
 246 {
 247         return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x2D, DataTgl, Cb, CbData, Buf, Length);
 248 }
 249
 250 int UHCI_IsTransferComplete(void *Ptr, void *Handle)
 251 {
 252         tUHCI_TD        *td = Handle;
 253          int    ret;
 254         ret = !(td->Control & (1 << 23));
 255         if(ret) {
 256                 td->_info.Callback = NULL;
 257                 td->Link = 1;
 258         }
 259         return ret;
 260 }
 261
 262 // === INTERNAL FUNCTIONS ===
 263 /**
 264  * \fn int UHCI_Int_InitHost(tUCHI_Controller *Host)
 265  * \brief Initialises a UHCI host controller
 266  * \param Host  Pointer - Host to initialise
 267  */
 268 int UHCI_Int_InitHost(tUHCI_Controller *Host)
 269 {
 270         ENTER("pHost", Host);
 271
 272         outw( Host->IOBase + USBCMD, 4 );       // GRESET
 273         Time_Delay(10);
 274         // TODO: Wait for at least 10ms
 275         outw( Host->IOBase + USBCMD, 0 );       // GRESET
 276
 277         // Allocate Frame List
 278         // - 1 Page, 32-bit address
 279         // - 1 page = 1024  4 byte entries
 280         Host->FrameList = (void *) MM_AllocDMA(1, 32, &Host->PhysFrameList);
 281         if( !Host->FrameList ) {
 282                 Log_Warning("UHCI", "Unable to allocate frame list, aborting");
 283                 LEAVE('i', -1);
 284                 return -1;
 285         }
 286         LOG("Allocated frame list 0x%x (0x%x)", Host->FrameList, Host->PhysFrameList);
 287         memsetd( Host->FrameList, 1, 1024 );    // Clear List (Disabling all entries)
 288
 289         //! \todo Properly fill frame list
 290
 291         // Set frame length to 1 ms
 292         outb( Host->IOBase + SOFMOD, 64 );
 293
 294         // Set Frame List
 295         outd( Host->IOBase + FLBASEADD, Host->PhysFrameList );
 296         outw( Host->IOBase + FRNUM, 0 );
 297
 298         // Enable Interrupts
 299         outw( Host->IOBase + USBINTR, 0x000F );
 300         PCI_ConfigWrite( Host->PciId, 0xC0, 2, 0x2000 );
 301
 302         // Enable processing
 303         outw( Host->IOBase + USBCMD, 0x0001 );
 304
 305         LEAVE('i', 0);
 306         return 0;
 307 }
 308
 309 void UHCI_CheckPortUpdate(void *Ptr)
 310 {
 311         tUHCI_Controller        *Host = Ptr;
 312         // Enable ports
 313         for( int i = 0; i < 2; i ++ )
 314         {
 315                  int    port = Host->IOBase + PORTSC1 + i*2;
 316                 // Check for port change
 317                 if( !(inw(port) & 0x0002) )     continue;
 318                 outw(port, 0x0002);
 319
 320                 // Check if the port is connected
 321                 if( !(inw(port) & 1) )
 322                 {
 323                         // Tell the USB code it's gone.
 324                         USB_DeviceDisconnected(Host->RootHub, i);
 325                         continue;
 326                 }
 327                 else
 328                 {
 329                         LOG("Port %i has something", i);
 330                         // Reset port (set bit 9)
 331                         LOG("Reset");
 332                         outw( port, 0x0200 );
 333                         Time_Delay(50); // 50ms delay
 334                         outw( port, inw(port) & ~0x0200 );
 335                         // Enable port
 336                         LOG("Enable");
 337                         Time_Delay(50); // 50ms delay
 338                         outw( port, inw(port) | 0x0004 );
 339                         // Tell USB there's a new device
 340                         USB_DeviceConnected(Host->RootHub, i);
 341                 }
 342         }
 343 }
 344
 345 void UHCI_InterruptHandler(int IRQ, void *Ptr)
 346 {
 347         tUHCI_Controller *Host = Ptr;
 348          int    frame = ((int)inw(Host->IOBase + FRNUM) - 1) & 0x3FF;
 349         Uint16  status = inw(Host->IOBase + USBSTS);
 350 //      Log_Debug("UHCI", "UHIC Interrupt, status = 0x%x, frame = %i", status, frame);
 351
 352         // Interrupt-on-completion
 353         if( status & 1 )
 354         {
 355                 tPAddr  link;
 356
 357                 for( int i = 0; i < 10; i ++ )
 358                 {
 359                         link = Host->FrameList[frame];
 360                         Host->FrameList[frame] = 1;
 361                         while( !(link & 1) )
 362                         {
 363                                 tUHCI_TD *td = UHCI_int_GetTDFromPhys(link);
 364                                  int    byte_count = (td->Control&0x7FF)+1;
 365                                 LOG("link = 0x%x, td = %p, byte_count = %i", link, td, byte_count);
 366                                 // Handle non-page aligned destination
 367                                 // TODO: This will break if the destination is not in global memory
 368                                 if(td->_info.bCopyData)
 369                                 {
 370                                         void *ptr = (void*)MM_MapTemp(td->BufferPointer);
 371                                         memcpy(td->_info.DataPtr, ptr, byte_count);
 372                                         MM_FreeTemp((tVAddr)ptr);
 373                                 }
 374                                 // Callback
 375                                 if(td->_info.Callback && td->_info.Callback != INVLPTR)
 376                                 {
 377                                         LOG("Calling cb %p", td->_info.Callback);
 378                                         td->_info.Callback(td->_info.CallbackPtr, td->_info.DataPtr, byte_count);
 379                                         td->_info.Callback = NULL;
 380                                 }
 381                                 link = td->Link;
 382                                 if( td->_info.Callback != INVLPTR )
 383                                         td->Link = 1;
 384                         }
 385
 386                         if(frame == 0)
 387                                 frame = 0x3ff;
 388                         else
 389                                 frame --;
 390                 }
 391
 392 //              Host->LastCleanedFrame = frame;
 393         }
 394
 395         LOG("status = 0x%02x", status);
 396         outw(Host->IOBase + USBSTS, status);
 397 }