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