KernelLand/Modules/USB/EHCI/ehci.c

   1 /*
   2  * Acess2 EHCI Driver
   3  * - By John Hodge (thePowersGang)
   4  *
   5  * ehci.c
   6  * - Driver Core
   7  */
   8 #define DEBUG   1
   9 #define VERSION VER2(0,1)
  10 #include <acess.h>
  11 #include <modules.h>
  12 #include <usb_host.h>
  13 #include "ehci.h"
  14 #include <drv_pci.h>
  15 #include <limits.h>
  16 #include <events.h>
  17 #include <timers.h>
  18
  19 // === CONSTANTS ===
  20 #define EHCI_MAX_CONTROLLERS    4
  21 #define EHCI_THREADEVENT_IOC    THREAD_EVENT_USER1
  22 #define EHCI_THREADEVENT_PORTSC THREAD_EVENT_USER2
  23
  24 // === PROTOTYPES ===
  25  int    EHCI_Initialise(char **Arguments);
  26  int    EHCI_Cleanup(void);
  27  int    EHCI_InitController(tPAddr BaseAddress, Uint8 InterruptNum);
  28 void    EHCI_InterruptHandler(int IRQ, void *Ptr);
  29 // -- API ---
  30 void    *EHCI_InitInterrupt(void *Ptr, int Endpoint, int bInput, int Period, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
  31 void    *EHCI_InitIsoch  (void *Ptr, int Endpoint, size_t MaxPacketSize);
  32 void    *EHCI_InitControl(void *Ptr, int Endpoint, size_t MaxPacketSize);
  33 void    *EHCI_InitBulk   (void *Ptr, int Endpoint, size_t MaxPacketSize);
  34 void    EHCI_RemEndpoint(void *Ptr, void *Handle);
  35 void    *EHCI_SendControl(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData,
  36         int isOutbound,
  37         const void *SetupData, size_t SetupLength,
  38         const void *OutData, size_t OutLength,
  39         void *InData, size_t InLength
  40         );
  41 void    *EHCI_SendBulk(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData, int Dir, void *Data, size_t Length);
  42 void    EHCI_FreeOp(void *Ptr, void *Handle);
  43 Uint32  EHCI_int_RootHub_FeatToMask(int Feat);
  44 void    EHCI_RootHub_SetPortFeature(void *Ptr, int Port, int Feat);
  45 void    EHCI_RootHub_ClearPortFeature(void *Ptr, int Port, int Feat);
  46  int    EHCI_RootHub_GetPortStatus(void *Ptr, int Port, int Flag);
  47 // --- Internals ---
  48 tEHCI_qTD       *EHCI_int_AllocateTD(tEHCI_Controller *Cont, int PID, void *Data, size_t Length, tUSBHostCb Cb, void *CbData);
  49 void    EHCI_int_DeallocateTD(tEHCI_Controller *Cont, tEHCI_qTD *TD);
  50 void    EHCI_int_AppendTD(tEHCI_Controller *Cont, tEHCI_QH *QH, tEHCI_qTD *TD);
  51 tEHCI_QH        *EHCI_int_AllocateQH(tEHCI_Controller *Cont, int Endpoint, size_t MaxPacketSize);
  52 void    EHCI_int_DeallocateQH(tEHCI_Controller *Cont, tEHCI_QH *QH);
  53 void    EHCI_int_InterruptThread(void *ControllerPtr);
  54
  55 // === GLOBALS ===
  56 MODULE_DEFINE(0, VERSION, USB_EHCI, EHCI_Initialise, NULL, "USB_Core", NULL);
  57 tEHCI_Controller        gaEHCI_Controllers[EHCI_MAX_CONTROLLERS];
  58 tUSBHostDef     gEHCI_HostDef = {
  59         .InitInterrupt = EHCI_InitInterrupt,
  60         .InitIsoch     = EHCI_InitIsoch,
  61         .InitControl   = EHCI_InitControl,
  62         .InitBulk      = EHCI_InitBulk,
  63         .RemEndpoint   = EHCI_RemEndpoint,
  64         .SendIsoch   = NULL,
  65         .SendControl = EHCI_SendControl,
  66         .SendBulk    = EHCI_SendBulk,
  67         .FreeOp      = EHCI_FreeOp,
  68
  69         .CheckPorts = NULL,     // No need
  70         .SetPortFeature   = EHCI_RootHub_SetPortFeature,
  71         .ClearPortFeature = EHCI_RootHub_ClearPortFeature,
  72         .GetPortStatus    = EHCI_RootHub_GetPortStatus,
  73         };
  74
  75 // === CODE ===
  76 int EHCI_Initialise(char **Arguments)
  77 {
  78         for( int id = -1; (id = PCI_GetDeviceByClass(0x0C0320, 0xFFFFFF, id)) >= 0;  )
  79         {
  80                 Uint32  addr = PCI_GetBAR(id, 0);
  81                 if( addr == 0 ) {
  82                         // Oops, PCI BIOS emulation time
  83                 }
  84                 Uint8   irq = PCI_GetIRQ(id);
  85                 if( irq == 0 ) {
  86                         // TODO: The same
  87                 }
  88
  89                 Log_Log("ECHI", "Controller at PCI %i 0x%x IRQ 0x%x",
  90                         id, addr, irq);
  91
  92                 if( EHCI_InitController(addr, irq) )
  93                 {
  94                         // TODO: Detect other forms of failure than "out of slots"
  95                         break ;
  96                 }
  97
  98                 // TODO: Register with the USB stack
  99         }
 100         return 0;
 101 }
 102
 103 int EHCI_Cleanup(void)
 104 {
 105         return 0;
 106 }
 107
 108 // --- Driver Init ---
 109 int EHCI_InitController(tPAddr BaseAddress, Uint8 InterruptNum)
 110 {
 111         tEHCI_Controller        *cont = NULL;
 112
 113         for( int i = 0; i < EHCI_MAX_CONTROLLERS; i ++ )
 114         {
 115                 if( gaEHCI_Controllers[i].PhysBase == 0 ) {
 116                         cont = &gaEHCI_Controllers[i];
 117                         cont->PhysBase = BaseAddress;
 118                         break;
 119                 }
 120         }
 121         if(!cont) {
 122                 Log_Notice("EHCI", "Too many controllers (EHCI_MAX_CONTROLLERS=%i)",
 123                         EHCI_MAX_CONTROLLERS);
 124                 return 1;
 125         }
 126
 127         // - Nuke a couple of fields so error handling code doesn't derp
 128         cont->CapRegs = NULL;
 129         cont->PeriodicQueue = NULL;
 130         cont->TDPool = NULL;
 131
 132         // -- Build up structure --
 133         cont->CapRegs = (void*)MM_MapHWPages(BaseAddress, 1);
 134         if( !cont->CapRegs ) {
 135                 Log_Warning("EHCI", "Can't map 1 page at %P into kernel space", BaseAddress);
 136                 goto _error;
 137         }
 138         // TODO: Error check
 139         if( (cont->CapRegs->CapLength & 3) ) {
 140                 Log_Warning("EHCI", "Controller at %P non-aligned op regs", BaseAddress);
 141                 goto _error;
 142         }
 143         cont->OpRegs = (void*)( (Uint32*)cont->CapRegs + cont->CapRegs->CapLength / 4 );
 144         // - Allocate periodic queue
 145         tPAddr  unused;
 146         cont->PeriodicQueue = (void*)MM_AllocDMA(1, 32, &unused);
 147         if( !cont->PeriodicQueue ) {
 148                 Log_Warning("ECHI", "Can't allocate 1 32-bit page for periodic queue");
 149                 goto _error;
 150         }
 151         // TODO: Error check
 152         //  > Populate queue
 153
 154         // - Allocate TD pool
 155         cont->TDPool = (void*)MM_AllocDMA(1, 32, &unused);
 156         if( !cont->TDPool ) {
 157                 Log_Warning("ECHI", "Can't allocate 1 32-bit page for qTD pool");
 158                 goto _error;
 159         }
 160         for( int i = 0; i < TD_POOL_SIZE; i ++ ) {
 161                 cont->TDPool[i].Token = 3 << 8;
 162         }
 163
 164         // Get port count
 165         cont->nPorts = cont->CapRegs->HCSParams & 0xF;
 166
 167         // -- Bind IRQ --
 168         IRQ_AddHandler(InterruptNum, EHCI_InterruptHandler, cont);
 169         cont->InterruptThread = Proc_SpawnWorker(EHCI_int_InterruptThread, cont);
 170         if( !cont->InterruptThread ) {
 171                 Log_Warning("EHCI", "Can't spawn interrupt worker thread");
 172                 goto _error;
 173         }
 174         LOG("cont->InterruptThread = %p", cont->InterruptThread);
 175
 176         // -- Initialisation procedure (from ehci-r10) --
 177         // - Reset controller
 178         cont->OpRegs->USBCmd = USBCMD_HCReset;
 179         // - Set CTRLDSSEGMENT (TODO: 64-bit support)
 180         // - Set USBINTR
 181         cont->OpRegs->USBIntr = USBINTR_IOC|USBINTR_PortChange|USBINTR_FrameRollover;
 182         // - Set PERIODICLIST BASE
 183         cont->OpRegs->PeridocListBase = MM_GetPhysAddr( cont->PeriodicQueue );
 184         // - Enable controller
 185         cont->OpRegs->USBCmd = (0x40 << 16) | USBCMD_PeriodicEnable | USBCMD_Run;
 186         // - Route all ports
 187         cont->OpRegs->ConfigFlag = 1;
 188
 189         // -- Register with USB Core --
 190         cont->RootHub = USB_RegisterHost(&gEHCI_HostDef, cont, cont->nPorts);
 191
 192         return 0;
 193 _error:
 194         cont->PhysBase = 0;
 195         if( cont->CapRegs )
 196                 MM_Deallocate( (tVAddr)cont->CapRegs );
 197         if( cont->PeriodicQueue )
 198                 MM_Deallocate( (tVAddr)cont->PeriodicQueue );
 199         if( cont->TDPool )
 200                 MM_Deallocate( (tVAddr)cont->TDPool );
 201         return 2;
 202 }
 203
 204 void EHCI_InterruptHandler(int IRQ, void *Ptr)
 205 {
 206         tEHCI_Controller *Cont = Ptr;
 207         Uint32  sts = Cont->OpRegs->USBSts;
 208
 209         // Clear interrupts
 210         Cont->OpRegs->USBSts = sts;
 211
 212         if( sts & 0xFFFF0FC0 ) {
 213                 LOG("Oops, reserved bits set (%08x), funny hardware?", sts);
 214                 sts &= ~0xFFFF0FFC0;
 215         }
 216
 217         // Unmask read-only bits
 218         sts &= ~(0xF000);
 219
 220         if( sts & USBINTR_IOC ) {
 221                 // IOC
 222                 Threads_PostEvent(Cont->InterruptThread, EHCI_THREADEVENT_IOC);
 223                 sts &= ~USBINTR_IOC;
 224         }
 225
 226         if( sts & USBINTR_PortChange ) {
 227                 // Port change, determine what port and poke helper thread
 228                 LOG("Port status change");
 229                 Threads_PostEvent(Cont->InterruptThread, EHCI_THREADEVENT_PORTSC);
 230                 sts &= ~USBINTR_PortChange;
 231         }
 232
 233         if( sts & USBINTR_FrameRollover ) {
 234                 // Frame rollover, used to aid timing (trigger per-second operations)
 235                 LOG("Frame rollover");
 236                 sts &= ~USBINTR_FrameRollover;
 237         }
 238
 239         if( sts ) {
 240                 // Unhandled interupt bits
 241                 // TODO: Warn
 242                 LOG("WARN - Bitmask %x unhandled", sts);
 243         }
 244
 245
 246 }
 247
 248 // --------------------------------------------------------------------
 249 // USB API
 250 // --------------------------------------------------------------------
 251 void *EHCI_InitInterrupt(void *Ptr, int Endpoint, int bOutbound, int Period,
 252         tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
 253 {
 254         tEHCI_Controller        *Cont = Ptr;
 255          int    pow2period, period_pow;
 256
 257         if( Endpoint >= 256*16 )
 258                 return NULL;
 259         if( Period <= 0 )
 260                 return NULL;
 261         if( Period > 256 )
 262                 Period = 256;
 263
 264         // Round the period to the closest power of two
 265         pow2period = 1;
 266         period_pow = 0;
 267         // - Find the first power above the period
 268         while( pow2period < Period )
 269         {
 270                 pow2period *= 2;
 271                 period_pow ++;
 272         }
 273         // - Check which is closest
 274         if( Period - pow2period / 2 > pow2period - Period )
 275                 Period = pow2period;
 276         else {
 277                 Period = pow2period/2;
 278                 period_pow --;
 279         }
 280
 281         // Allocate a QH
 282         tEHCI_QH *qh = EHCI_int_AllocateQH(Cont, Endpoint, Length);
 283         qh->Impl.IntPeriodPow = period_pow;
 284
 285         Mutex_Acquire(&Cont->PeriodicListLock);
 286
 287         // Choose an interrupt slot to use
 288         int minslot = 0, minslot_load = INT_MAX;
 289         for( int slot = 0; slot < Period; slot ++ )
 290         {
 291                  int    load = 0;
 292                 for( int i = 0; i < PERIODIC_SIZE; i += Period )
 293                         load += Cont->InterruptLoad[i+slot];
 294                 if( load == 0 ) break;
 295                 if( load < minslot_load ) {
 296                         minslot = slot;
 297                         minslot_load = load;
 298                 }
 299         }
 300         // Increase loading on the selected slot
 301         for( int i = minslot; i < PERIODIC_SIZE; i += Period )
 302                 Cont->InterruptLoad[i] += Length;
 303         qh->Impl.IntOfs = minslot;
 304
 305         // Allocate TD for the data
 306         tEHCI_qTD *td = EHCI_int_AllocateTD(Cont, (bOutbound ? PID_OUT : PID_IN), Buf, Length, Cb, CbData);
 307         EHCI_int_AppendTD(Cont, qh, td);
 308
 309         // Insert into the periodic list
 310         for( int i = 0; i < PERIODIC_SIZE; i += Period )
 311         {
 312                 // Walk list until
 313                 // - the end is reached
 314                 // - this QH is found
 315                 // - A QH with a lower period is encountered
 316                 tEHCI_QH        *pqh = NULL;
 317                 tEHCI_QH        *nqh;
 318                 for( nqh = Cont->PeriodicQueueV[i]; nqh; pqh = nqh, nqh = nqh->Impl.Next )
 319                 {
 320                         if( nqh == qh )
 321                                 break;
 322                         if( nqh->Impl.IntPeriodPow < period_pow )
 323                                 break;
 324                 }
 325
 326                 // Somehow, we've already been added to this queue.
 327                 if( nqh && nqh == qh )
 328                         continue ;
 329
 330                 if( qh->Impl.Next && qh->Impl.Next != nqh ) {
 331                         Log_Warning("EHCI", "Suspected bookkeeping error on %p - int list %i+%i overlap",
 332                                 Cont, period_pow, minslot);
 333                         break;
 334                 }
 335
 336                 if( nqh ) {
 337                         qh->Impl.Next = nqh;
 338                         qh->HLink = MM_GetPhysAddr(nqh) | 2;
 339                 }
 340                 else {
 341                         qh->Impl.Next = NULL;
 342                         qh->HLink = 2|1;        // QH, Terminate
 343                 }
 344
 345                 if( pqh ) {
 346                         pqh->Impl.Next = qh;
 347                         pqh->HLink = MM_GetPhysAddr(qh) | 2;
 348                 }
 349                 else {
 350                         Cont->PeriodicQueueV[i] = qh;
 351                         Cont->PeriodicQueue[i] = MM_GetPhysAddr(qh) | 2;
 352                 }
 353         }
 354         Mutex_Release(&Cont->PeriodicListLock);
 355
 356         return qh;
 357 }
 358
 359 void *EHCI_InitIsoch(void *Ptr, int Endpoint, size_t MaxPacketSize)
 360 {
 361         return (void*)(tVAddr)(Endpoint + 1);
 362 }
 363 void *EHCI_InitControl(void *Ptr, int Endpoint, size_t MaxPacketSize)
 364 {
 365         tEHCI_Controller *Cont = Ptr;
 366
 367         // Allocate a QH
 368         tEHCI_QH *qh = EHCI_int_AllocateQH(Cont, Endpoint, MaxPacketSize);
 369
 370         // Append to async list
 371         if( Cont->LastAsyncHead ) {
 372                 Cont->LastAsyncHead->HLink = MM_GetPhysAddr(qh)|2;
 373                 Cont->LastAsyncHead->Impl.Next = qh;
 374         }
 375         else
 376                 Cont->OpRegs->AsyncListAddr = MM_GetPhysAddr(qh)|2;
 377         Cont->LastAsyncHead = qh;
 378
 379         LOG("Created %p for %p Ep 0x%x - %i bytes MPS", qh, Ptr, Endpoint, MaxPacketSize);
 380
 381         return qh;
 382 }
 383 void *EHCI_InitBulk(void *Ptr, int Endpoint, size_t MaxPacketSize)
 384 {
 385         return EHCI_InitControl(Ptr, Endpoint, MaxPacketSize);
 386 }
 387 void EHCI_RemEndpoint(void *Ptr, void *Handle)
 388 {
 389         if( Handle == NULL )
 390                 return ;
 391         else if( (tVAddr)Handle <= 256*16 )
 392                 return ;        // Isoch
 393         else {
 394                 tEHCI_QH        *qh = Ptr;
 395
 396                 // Remove QH from list
 397                 // - If it's a polling endpoint, need to remove from all periodic lists
 398                 if( qh->Impl.IntPeriodPow != 0xFF) {
 399                         // Poll
 400                 }
 401                 else {
 402                         // GP
 403                 }
 404
 405                 // Deallocate QH
 406                 EHCI_int_DeallocateQH(Ptr, Handle);
 407         }
 408 }
 409
 410 void *EHCI_SendControl(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData,
 411         int isOutbound,
 412         const void *SetupData, size_t SetupLength,
 413         const void *OutData, size_t OutLength,
 414         void *InData, size_t InLength
 415         )
 416 {
 417         tEHCI_Controller *Cont = Ptr;
 418         tEHCI_qTD       *td_setup, *td_data, *td_status;
 419
 420         // Sanity checks
 421         if( (tVAddr)Dest <= 256*16 )
 422                 return NULL;
 423
 424         // Check size of SETUP and status
 425
 426         // Allocate TDs
 427         td_setup = EHCI_int_AllocateTD(Cont, PID_SETUP, (void*)SetupData, SetupLength, NULL, NULL);
 428         if( isOutbound )
 429         {
 430                 td_data = OutData ? EHCI_int_AllocateTD(Cont, PID_OUT, (void*)OutData, OutLength, NULL, NULL) : NULL;
 431                 td_status = EHCI_int_AllocateTD(Cont, PID_IN, InData, InLength, Cb, CbData);
 432         }
 433         else
 434         {
 435                 td_data = InData ? EHCI_int_AllocateTD(Cont, PID_IN, InData, InLength, NULL, NULL) : NULL;
 436                 td_status = EHCI_int_AllocateTD(Cont, PID_OUT, (void*)OutData, OutLength, Cb, CbData);
 437                 td_status->Token |= (1 << 15);
 438         }
 439
 440         // Append TDs
 441         if( td_data ) {
 442                 td_setup->Link = MM_GetPhysAddr(td_data);
 443                 td_data->Link = MM_GetPhysAddr(td_status) | 1;
 444         }
 445         else {
 446                 td_setup->Link = MM_GetPhysAddr(td_status) | 1;
 447         }
 448         EHCI_int_AppendTD(Cont, Dest, td_setup);
 449
 450         return td_status;
 451 }
 452
 453 void *EHCI_SendBulk(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData, int Dir, void *Data, size_t Length)
 454 {
 455         tEHCI_Controller        *Cont = Ptr;
 456
 457         // Sanity check the pointer
 458         // - Can't be NULL or an isoch
 459         if( (tVAddr)Dest <= 256*16 )
 460                 return NULL;
 461
 462         // Allocate single TD
 463         tEHCI_qTD       *td = EHCI_int_AllocateTD(Cont, (Dir ? PID_OUT : PID_IN), Data, Length, Cb, CbData);
 464         EHCI_int_AppendTD(Cont, Dest, td);
 465
 466         return td;
 467 }
 468
 469 void EHCI_FreeOp(void *Ptr, void *Handle)
 470 {
 471         tEHCI_Controller        *Cont = Ptr;
 472
 473         EHCI_int_DeallocateTD(Cont, Handle);
 474 }
 475
 476 Uint32 EHCI_int_RootHub_FeatToMask(int Feat)
 477 {
 478         switch(Feat)
 479         {
 480         case PORT_RESET:        return PORTSC_PortReset;
 481         case PORT_ENABLE:       return PORTSC_PortEnabled;
 482         default:
 483                 Log_Warning("EHCI", "Unknown root hub port feature %i", Feat);
 484                 return 0;
 485         }
 486 }
 487
 488 void EHCI_RootHub_SetPortFeature(void *Ptr, int Port, int Feat)
 489 {
 490         tEHCI_Controller        *Cont = Ptr;
 491         if(Port >= Cont->nPorts)        return;
 492
 493         Cont->OpRegs->PortSC[Port] |= EHCI_int_RootHub_FeatToMask(Feat);
 494 }
 495
 496 void EHCI_RootHub_ClearPortFeature(void *Ptr, int Port, int Feat)
 497 {
 498         tEHCI_Controller        *Cont = Ptr;
 499         if(Port >= Cont->nPorts)        return;
 500
 501         Cont->OpRegs->PortSC[Port] &= ~EHCI_int_RootHub_FeatToMask(Feat);
 502 }
 503
 504 int EHCI_RootHub_GetPortStatus(void *Ptr, int Port, int Flag)
 505 {
 506         tEHCI_Controller        *Cont = Ptr;
 507         if(Port >= Cont->nPorts)        return 0;
 508
 509         return !!(Cont->OpRegs->PortSC[Port] & EHCI_int_RootHub_FeatToMask(Flag));
 510 }
 511
 512 // --------------------------------------------------------------------
 513 // Internals
 514 // --------------------------------------------------------------------
 515 tEHCI_qTD *EHCI_int_GetTDFromPhys(tEHCI_Controller *Cont, Uint32 Addr)
 516 {
 517         if( Addr == 0 ) return NULL;
 518         LOG("%p + (%x - %x)", Cont->TDPool, Addr, MM_GetPhysAddr(Cont->TDPool));
 519         return Cont->TDPool + (Addr - MM_GetPhysAddr(Cont->TDPool))/sizeof(tEHCI_qTD);
 520 }
 521
 522 tEHCI_qTD *EHCI_int_AllocateTD(tEHCI_Controller *Cont, int PID, void *Data, size_t Length, tUSBHostCb Cb, void *CbData)
 523 {
 524 //      Semaphore_Wait(&Cont->TDSemaphore, 1);
 525         Mutex_Acquire(&Cont->TDPoolMutex);
 526         for( int i = 0; i < TD_POOL_SIZE; i ++ )
 527         {
 528                 if( ((Cont->TDPool[i].Token >> 8) & 3) != 3 )
 529                         continue ;
 530                 Cont->TDPool[i].Token = (PID << 8) | (Length << 16);
 531                 // NOTE: Assumes that `Length` is <= PAGE_SIZE
 532                 Cont->TDPool[i].Pages[0] = MM_GetPhysAddr(Data);
 533                 if( (Cont->TDPool[i].Pages[0] & (PAGE_SIZE-1)) + Length - 1 > PAGE_SIZE )
 534                         Cont->TDPool[i].Pages[1] = MM_GetPhysAddr((char*)Data + Length - 1) & ~(PAGE_SIZE-1);
 535                 Mutex_Release(&Cont->TDPoolMutex);
 536                 LOG("Allocated %p for PID %i on %p", &Cont->TDPool[i], PID, Cont);
 537                 return &Cont->TDPool[i];
 538         }
 539
 540         Mutex_Release(&Cont->TDPoolMutex);
 541         return NULL;
 542 }
 543
 544 void EHCI_int_DeallocateTD(tEHCI_Controller *Cont, tEHCI_qTD *TD)
 545 {
 546         UNIMPLEMENTED();
 547 }
 548
 549 void EHCI_int_AppendTD(tEHCI_Controller *Cont, tEHCI_QH *QH, tEHCI_qTD *TD)
 550 {
 551         tEHCI_qTD       *ptd = NULL;
 552         Uint32  link = QH->CurrentTD;
 553
 554         // TODO: Need locking and validation here
 555         while( link && !(link & 1) )
 556         {
 557                 ptd = EHCI_int_GetTDFromPhys(Cont, link);
 558                 link = ptd->Link;
 559         }
 560         // TODO: Figure out how to follow this properly
 561         if( !ptd ) {
 562                 QH->CurrentTD = MM_GetPhysAddr(TD);
 563         }
 564         else
 565                 ptd->Link = MM_GetPhysAddr(TD);
 566 }
 567
 568 tEHCI_QH *EHCI_int_AllocateQH(tEHCI_Controller *Cont, int Endpoint, size_t MaxPacketSize)
 569 {
 570         tEHCI_QH        *ret;
 571         Mutex_Acquire(&Cont->QHPoolMutex);
 572         for( int i = 0; i < QH_POOL_SIZE; i ++ )
 573         {
 574                 if( !MM_GetPhysAddr( Cont->QHPools[i/QH_POOL_NPERPAGE] ) ) {
 575                         tPAddr  tmp;
 576                         Cont->QHPools[i/QH_POOL_NPERPAGE] = (void*)MM_AllocDMA(1, 32, &tmp);
 577                         memset(Cont->QHPools[i/QH_POOL_NPERPAGE], 0, PAGE_SIZE);
 578                 }
 579
 580                 ret = &Cont->QHPools[i/QH_POOL_NPERPAGE][i%QH_POOL_NPERPAGE];
 581                 if( ret->HLink == 0 ) {
 582                         ret->HLink = 1;
 583                         ret->CurrentTD = 0;
 584                         ret->Overlay.Link = 1;
 585                         ret->Endpoint = (Endpoint >> 4) | ((Endpoint & 0xF) << 8)
 586                                 | (MaxPacketSize << 16);
 587                         // TODO: Endpoint speed (13:12) 0:Full, 1:Low, 2:High
 588                         // TODO: Control Endpoint Flag (27) 0:*, 1:Full/Low Control
 589                         Mutex_Release(&Cont->QHPoolMutex);
 590                         return ret;
 591                 }
 592         }
 593         Mutex_Release(&Cont->QHPoolMutex);
 594         return NULL;
 595 }
 596
 597 void EHCI_int_DeallocateQH(tEHCI_Controller *Cont, tEHCI_QH *QH)
 598 {
 599         // TODO: Ensure it's unused (somehow)
 600         QH->HLink = 0;
 601 }
 602
 603 void EHCI_int_HandlePortConnectChange(tEHCI_Controller *Cont, int Port)
 604 {
 605         // Connect Event
 606         if( Cont->OpRegs->PortSC[Port] & PORTSC_CurrentConnectStatus )
 607         {
 608                 // Is the device low-speed?
 609                 if( (Cont->OpRegs->PortSC[Port] & PORTSC_LineStatus_MASK) == PORTSC_LineStatus_Kstate )
 610                 {
 611                         LOG("Low speed device on %p Port %i, giving to companion", Cont, Port);
 612                         Cont->OpRegs->PortSC[Port] |= PORTSC_PortOwner;
 613                 }
 614                 // not a low-speed device, EHCI reset
 615                 else
 616                 {
 617                         LOG("Device connected on %p #%i", Cont, Port);
 618                         // Reset procedure.
 619                         USB_PortCtl_BeginReset(Cont->RootHub, Port);
 620                 }
 621         }
 622         // Disconnect Event
 623         else
 624         {
 625                 if( Cont->OpRegs->PortSC[Port] & PORTSC_PortOwner ) {
 626                         LOG("Companion port %i disconnected, taking it back", Port);
 627                         Cont->OpRegs->PortSC[Port] &= ~PORTSC_PortOwner;
 628                 }
 629                 else {
 630                         LOG("Port %i disconnected", Port);
 631                         USB_DeviceDisconnected(Cont->RootHub, Port);
 632                 }
 633         }
 634 }
 635
 636 void EHCI_int_InterruptThread(void *ControllerPtr)
 637 {
 638         tEHCI_Controller        *Cont = ControllerPtr;
 639         while(Cont->OpRegs)
 640         {
 641                 Uint32  events;
 642
 643                 LOG("sleeping for events");
 644                 events = Threads_WaitEvents(EHCI_THREADEVENT_IOC|EHCI_THREADEVENT_PORTSC);
 645                 if( !events ) {
 646                         // TODO: Should this cause a termination?
 647                 }
 648                 LOG("events = 0x%x", events);
 649
 650                 if( events & EHCI_THREADEVENT_IOC )
 651                 {
 652                         // IOC, Do whatever it is you do
 653                 }
 654
 655                 // Port status change interrupt
 656                 if( events & EHCI_THREADEVENT_PORTSC )
 657                 {
 658                         // Check for port status changes
 659                         for(int i = 0; i < Cont->nPorts; i ++ )
 660                         {
 661                                 Uint32  sts = Cont->OpRegs->PortSC[i];
 662                                 LOG("Port %i: sts = %x", i, sts);
 663                                 Cont->OpRegs->PortSC[i] = sts;
 664                                 if( sts & PORTSC_ConnectStatusChange )
 665                                         EHCI_int_HandlePortConnectChange(Cont, i);
 666
 667                                 if( sts & PORTSC_PortEnableChange )
 668                                 {
 669                                         // Handle enable/disable
 670                                 }
 671
 672                                 if( sts & PORTSC_OvercurrentChange )
 673                                 {
 674                                         // Handle over-current change
 675                                 }
 676                         }
 677                 }
 678
 679                 LOG("Going back to sleep");
 680         }
 681 }