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