3 * - By John Hodge (thePowersGang)
9 #define VERSION VER2(0,1)
20 #define EHCI_MAX_CONTROLLERS 4
21 #define EHCI_THREADEVENT_IOC THREAD_EVENT_USER1
22 #define EHCI_THREADEVENT_PORTSC THREAD_EVENT_USER2
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);
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,
37 const void *SetupData, size_t SetupLength,
38 const void *OutData, size_t OutLength,
39 void *InData, size_t InLength
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);
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);
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,
65 .SendControl = EHCI_SendControl,
66 .SendBulk = EHCI_SendBulk,
67 .FreeOp = EHCI_FreeOp,
69 .CheckPorts = NULL, // No need
70 .SetPortFeature = EHCI_RootHub_SetPortFeature,
71 .ClearPortFeature = EHCI_RootHub_ClearPortFeature,
72 .GetPortStatus = EHCI_RootHub_GetPortStatus,
76 int EHCI_Initialise(char **Arguments)
78 for( int id = -1; (id = PCI_GetDeviceByClass(0x0C0320, 0xFFFFFF, id)) >= 0; )
80 Uint32 addr = PCI_GetBAR(id, 0);
82 // Oops, PCI BIOS emulation time
84 Uint8 irq = PCI_GetIRQ(id);
89 Log_Log("ECHI", "Controller at PCI %i 0x%x IRQ 0x%x",
92 if( EHCI_InitController(addr, irq) )
94 // TODO: Detect other forms of failure than "out of slots"
99 for( int i = 0; Arguments[i]; i ++ )
101 char *pos = Arguments[i], *next;
102 LOG("pos = '%s'", pos);
103 tPAddr base = strtoull(pos, &next, 16);
107 LOG("pos = '%s'", pos);
110 LOG("pos = '%s'", pos);
111 int irq = strtol(pos, &next, 16);
116 LOG("base=%x, irq=%i", base, irq);
117 if( EHCI_InitController(base, irq) )
126 int EHCI_Cleanup(void)
131 // --- Driver Init ---
132 int EHCI_InitController(tPAddr BaseAddress, Uint8 InterruptNum)
134 tEHCI_Controller *cont = NULL;
136 for( int i = 0; i < EHCI_MAX_CONTROLLERS; i ++ )
138 if( gaEHCI_Controllers[i].PhysBase == 0 ) {
139 cont = &gaEHCI_Controllers[i];
140 cont->PhysBase = BaseAddress;
145 Log_Notice("EHCI", "Too many controllers (EHCI_MAX_CONTROLLERS=%i)",
146 EHCI_MAX_CONTROLLERS);
150 // - Nuke a couple of fields so error handling code doesn't derp
151 cont->CapRegs = NULL;
152 cont->PeriodicQueue = NULL;
155 // -- Build up structure --
156 cont->CapRegs = (void*)MM_MapHWPages(BaseAddress, 1);
157 if( !cont->CapRegs ) {
158 Log_Warning("EHCI", "Can't map 1 page at %P into kernel space", BaseAddress);
162 if( (cont->CapRegs->CapLength & 3) ) {
163 Log_Warning("EHCI", "Controller at %P non-aligned op regs (%x)",
164 BaseAddress, cont->CapRegs->CapLength);
167 cont->OpRegs = (void*)( (Uint32*)cont->CapRegs + cont->CapRegs->CapLength / 4 );
168 // - Allocate periodic queue
170 cont->PeriodicQueue = (void*)MM_AllocDMA(1, 32, &unused);
171 if( !cont->PeriodicQueue ) {
172 Log_Warning("ECHI", "Can't allocate 1 32-bit page for periodic queue");
175 for( int i = 0; i < 1024; i ++ )
176 cont->PeriodicQueue[i] = 1;
180 // - Allocate TD pool
181 cont->TDPool = (void*)MM_AllocDMA(1, 32, &unused);
182 if( !cont->TDPool ) {
183 Log_Warning("ECHI", "Can't allocate 1 32-bit page for qTD pool");
186 for( int i = 0; i < TD_POOL_SIZE; i ++ ) {
187 cont->TDPool[i].Token = 3 << 8;
191 cont->nPorts = cont->CapRegs->HCSParams & 0xF;
194 IRQ_AddHandler(InterruptNum, EHCI_InterruptHandler, cont);
195 cont->InterruptThread = Proc_SpawnWorker(EHCI_int_InterruptThread, cont);
196 if( !cont->InterruptThread ) {
197 Log_Warning("EHCI", "Can't spawn interrupt worker thread");
200 LOG("cont->InterruptThread = %p", cont->InterruptThread);
202 // -- Initialisation procedure (from ehci-r10) --
203 // - Reset controller
204 cont->OpRegs->USBCmd = USBCMD_HCReset;
205 // - Set CTRLDSSEGMENT (TODO: 64-bit support)
207 cont->OpRegs->USBIntr = USBINTR_IOC|USBINTR_PortChange|USBINTR_FrameRollover;
208 // - Set PERIODICLIST BASE
209 cont->OpRegs->PeridocListBase = MM_GetPhysAddr( cont->PeriodicQueue );
210 // - Enable controller
211 cont->OpRegs->USBCmd = (0x40 << 16) | USBCMD_PeriodicEnable | USBCMD_Run;
213 cont->OpRegs->ConfigFlag = 1;
215 cont->DeadTD = EHCI_int_AllocateTD(cont, 0, NULL, 0, NULL, NULL);
216 cont->DeadTD->Link = 1;
217 cont->DeadTD->Link2 = 1;
218 cont->DeadTD->Token = 0;
220 // -- Register with USB Core --
221 cont->RootHub = USB_RegisterHost(&gEHCI_HostDef, cont, cont->nPorts);
227 MM_Deallocate( (tVAddr)cont->CapRegs );
228 if( cont->PeriodicQueue )
229 MM_Deallocate( (tVAddr)cont->PeriodicQueue );
231 MM_Deallocate( (tVAddr)cont->TDPool );
235 void EHCI_InterruptHandler(int IRQ, void *Ptr)
237 tEHCI_Controller *Cont = Ptr;
238 Uint32 sts = Cont->OpRegs->USBSts;
241 Cont->OpRegs->USBSts = sts;
243 if( sts & 0xFFFF0FC0 ) {
244 LOG("Oops, reserved bits set (%08x), funny hardware?", sts);
248 // Unmask read-only bits
251 if( sts & USBINTR_IOC ) {
253 Threads_PostEvent(Cont->InterruptThread, EHCI_THREADEVENT_IOC);
257 if( sts & USBINTR_PortChange ) {
258 // Port change, determine what port and poke helper thread
259 LOG("Port status change");
260 Threads_PostEvent(Cont->InterruptThread, EHCI_THREADEVENT_PORTSC);
261 sts &= ~USBINTR_PortChange;
264 if( sts & USBINTR_FrameRollover ) {
265 // Frame rollover, used to aid timing (trigger per-second operations)
266 LOG("Frame rollover");
267 sts &= ~USBINTR_FrameRollover;
271 // Unhandled interupt bits
273 LOG("WARN - Bitmask %x unhandled", sts);
279 // --------------------------------------------------------------------
281 // --------------------------------------------------------------------
282 void *EHCI_InitInterrupt(void *Ptr, int Endpoint, int bOutbound, int Period,
283 tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
285 tEHCI_Controller *Cont = Ptr;
286 int pow2period, period_pow;
288 if( Endpoint >= 256*16 )
295 LOG("Endpoint=%x, bOutbound=%i, Period=%i, Length=%i", Endpoint, bOutbound, Period, Length);
297 // Round the period to the closest power of two
300 // - Find the first power above the period
301 while( pow2period < Period )
306 // - Check which is closest
307 if( Period - pow2period / 2 > pow2period - Period )
310 Period = pow2period/2;
315 tEHCI_QH *qh = EHCI_int_AllocateQH(Cont, Endpoint, Length);
316 qh->Impl.IntPeriodPow = period_pow;
318 Mutex_Acquire(&Cont->PeriodicListLock);
320 // Choose an interrupt slot to use
321 int minslot = 0, minslot_load = INT_MAX;
322 for( int slot = 0; slot < Period; slot ++ )
325 for( int i = 0; i < PERIODIC_SIZE; i += Period )
326 load += Cont->InterruptLoad[i+slot];
327 if( load == 0 ) break;
328 if( load < minslot_load ) {
333 // Increase loading on the selected slot
334 for( int i = minslot; i < PERIODIC_SIZE; i += Period )
335 Cont->InterruptLoad[i] += Length;
336 qh->Impl.IntOfs = minslot;
338 // Allocate TD for the data
339 tEHCI_qTD *td = EHCI_int_AllocateTD(Cont, (bOutbound ? PID_OUT : PID_IN), Buf, Length, Cb, CbData);
340 EHCI_int_AppendTD(Cont, qh, td);
342 // Insert into the periodic list
343 for( int i = 0; i < PERIODIC_SIZE; i += Period )
346 // - the end is reached
347 // - this QH is found
348 // - A QH with a lower period is encountered
349 tEHCI_QH *pqh = NULL;
351 for( nqh = Cont->PeriodicQueueV[i]; nqh; pqh = nqh, nqh = nqh->Impl.Next )
355 if( nqh->Impl.IntPeriodPow < period_pow )
359 // Somehow, we've already been added to this queue.
360 if( nqh && nqh == qh )
363 if( qh->Impl.Next && qh->Impl.Next != nqh ) {
364 Log_Warning("EHCI", "Suspected bookkeeping error on %p - int list %i+%i overlap",
365 Cont, period_pow, minslot);
371 qh->HLink = MM_GetPhysAddr(nqh) | 2;
374 qh->Impl.Next = NULL;
375 qh->HLink = 2|1; // QH, Terminate
380 pqh->HLink = MM_GetPhysAddr(qh) | 2;
383 Cont->PeriodicQueueV[i] = qh;
384 Cont->PeriodicQueue[i] = MM_GetPhysAddr(qh) | 2;
387 Mutex_Release(&Cont->PeriodicListLock);
392 void *EHCI_InitIsoch(void *Ptr, int Endpoint, size_t MaxPacketSize)
394 return (void*)(tVAddr)(Endpoint + 1);
396 void *EHCI_InitControl(void *Ptr, int Endpoint, size_t MaxPacketSize)
398 tEHCI_Controller *Cont = Ptr;
401 tEHCI_QH *qh = EHCI_int_AllocateQH(Cont, Endpoint, MaxPacketSize);
402 qh->CurrentTD = MM_GetPhysAddr(Cont->DeadTD);
404 // Append to async list
405 if( Cont->LastAsyncHead ) {
406 Cont->LastAsyncHead->HLink = MM_GetPhysAddr(qh)|2;
407 Cont->LastAsyncHead->Impl.Next = qh;
408 LOG("- Placed after %p", Cont->LastAsyncHead);
411 Cont->OpRegs->AsyncListAddr = MM_GetPhysAddr(qh)|2;
413 qh->HLink = Cont->OpRegs->AsyncListAddr;
414 Cont->OpRegs->USBCmd |= USBCMD_AsyncEnable;
415 Cont->LastAsyncHead = qh;
417 LOG("Created %p for %p Ep 0x%x - %i bytes MPS", qh, Ptr, Endpoint, MaxPacketSize);
421 void *EHCI_InitBulk(void *Ptr, int Endpoint, size_t MaxPacketSize)
423 return EHCI_InitControl(Ptr, Endpoint, MaxPacketSize);
425 void EHCI_RemEndpoint(void *Ptr, void *Handle)
429 else if( (tVAddr)Handle <= 256*16 )
434 // Remove QH from list
435 // - If it's a polling endpoint, need to remove from all periodic lists
436 if( qh->Impl.IntPeriodPow != 0xFF) {
444 EHCI_int_DeallocateQH(Ptr, Handle);
448 void *EHCI_SendControl(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData,
450 const void *SetupData, size_t SetupLength,
451 const void *OutData, size_t OutLength,
452 void *InData, size_t InLength
455 tEHCI_Controller *Cont = Ptr;
456 tEHCI_qTD *td_setup, *td_data, *td_status;
459 if( (tVAddr)Dest <= 256*16 )
462 LOG("Dest=%p, isOutbound=%i, Lengths(Setup:%i,Out:%i,In:%i)", Dest, isOutbound, SetupLength, OutLength, InLength);
464 // Check size of SETUP and status
467 td_setup = EHCI_int_AllocateTD(Cont, PID_SETUP, (void*)SetupData, SetupLength, NULL, NULL);
470 td_data = OutData ? EHCI_int_AllocateTD(Cont, PID_OUT, (void*)OutData, OutLength, NULL, NULL) : NULL;
471 td_status = EHCI_int_AllocateTD(Cont, PID_IN, InData, InLength, Cb, CbData);
475 td_data = InData ? EHCI_int_AllocateTD(Cont, PID_IN, InData, InLength, NULL, NULL) : NULL;
476 td_status = EHCI_int_AllocateTD(Cont, PID_OUT, (void*)OutData, OutLength, Cb, CbData);
477 td_status->Token |= (1 << 15); // IOC
482 td_setup->Link = MM_GetPhysAddr(td_data);
483 td_data->Link = MM_GetPhysAddr(td_status) | 1;
484 td_data->Token |= (1 << 8); // Active
487 td_setup->Link = MM_GetPhysAddr(td_status) | 1;
489 td_setup->Token |= (1 << 8); // Active
490 td_status->Token |= (1 << 8);
491 EHCI_int_AppendTD(Cont, Dest, td_setup);
496 void *EHCI_SendBulk(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData, int Dir, void *Data, size_t Length)
498 tEHCI_Controller *Cont = Ptr;
500 // Sanity check the pointer
501 // - Can't be NULL or an isoch
502 if( (tVAddr)Dest <= 256*16 )
505 // Allocate single TD
506 tEHCI_qTD *td = EHCI_int_AllocateTD(Cont, (Dir ? PID_OUT : PID_IN), Data, Length, Cb, CbData);
507 EHCI_int_AppendTD(Cont, Dest, td);
512 void EHCI_FreeOp(void *Ptr, void *Handle)
514 tEHCI_Controller *Cont = Ptr;
516 EHCI_int_DeallocateTD(Cont, Handle);
519 Uint32 EHCI_int_RootHub_FeatToMask(int Feat)
523 case PORT_RESET: return PORTSC_PortReset;
524 case PORT_ENABLE: return PORTSC_PortEnabled;
526 Log_Warning("EHCI", "Unknown root hub port feature %i", Feat);
531 void EHCI_RootHub_SetPortFeature(void *Ptr, int Port, int Feat)
533 tEHCI_Controller *Cont = Ptr;
534 if(Port >= Cont->nPorts) return;
536 Cont->OpRegs->PortSC[Port] |= EHCI_int_RootHub_FeatToMask(Feat);
539 void EHCI_RootHub_ClearPortFeature(void *Ptr, int Port, int Feat)
541 tEHCI_Controller *Cont = Ptr;
542 if(Port >= Cont->nPorts) return;
544 Cont->OpRegs->PortSC[Port] &= ~EHCI_int_RootHub_FeatToMask(Feat);
547 int EHCI_RootHub_GetPortStatus(void *Ptr, int Port, int Flag)
549 tEHCI_Controller *Cont = Ptr;
550 if(Port >= Cont->nPorts) return 0;
552 return !!(Cont->OpRegs->PortSC[Port] & EHCI_int_RootHub_FeatToMask(Flag));
555 // --------------------------------------------------------------------
557 // --------------------------------------------------------------------
558 tEHCI_qTD *EHCI_int_GetTDFromPhys(tEHCI_Controller *Cont, Uint32 Addr)
560 if( Addr == 0 ) return NULL;
561 LOG("%p + (%x - %x)", Cont->TDPool, Addr, MM_GetPhysAddr(Cont->TDPool));
562 return Cont->TDPool + (Addr - MM_GetPhysAddr(Cont->TDPool))/sizeof(tEHCI_qTD);
565 tEHCI_qTD *EHCI_int_AllocateTD(tEHCI_Controller *Cont, int PID, void *Data, size_t Length, tUSBHostCb Cb, void *CbData)
567 // Semaphore_Wait(&Cont->TDSemaphore, 1);
568 Mutex_Acquire(&Cont->TDPoolMutex);
569 for( int i = 0; i < TD_POOL_SIZE; i ++ )
571 if( ((Cont->TDPool[i].Token >> 8) & 3) != 3 )
573 Cont->TDPool[i].Token = (PID << 8) | (Length << 16);
574 // NOTE: Assumes that `Length` is <= PAGE_SIZE
575 Cont->TDPool[i].Pages[0] = MM_GetPhysAddr(Data);
576 if( (Cont->TDPool[i].Pages[0] & (PAGE_SIZE-1)) + Length - 1 > PAGE_SIZE )
577 Cont->TDPool[i].Pages[1] = MM_GetPhysAddr((char*)Data + Length - 1) & ~(PAGE_SIZE-1);
578 Mutex_Release(&Cont->TDPoolMutex);
579 LOG("Allocated %p for PID %i on %p", &Cont->TDPool[i], PID, Cont);
580 return &Cont->TDPool[i];
583 Mutex_Release(&Cont->TDPoolMutex);
587 void EHCI_int_DeallocateTD(tEHCI_Controller *Cont, tEHCI_qTD *TD)
592 void EHCI_int_AppendTD(tEHCI_Controller *Cont, tEHCI_QH *QH, tEHCI_qTD *TD)
594 tEHCI_qTD *ptd = NULL;
595 Uint32 link = QH->CurrentTD;
597 // TODO: Need locking and validation here
598 while( link && !(link & 1) )
600 ptd = EHCI_int_GetTDFromPhys(Cont, link);
603 // TODO: Figure out how to follow this properly
605 QH->CurrentTD = MM_GetPhysAddr(TD);
606 LOG("Appended %p to beginning of %p", TD, QH);
609 ptd->Link = MM_GetPhysAddr(TD);
610 LOG("Appended %p to end of %p", TD, QH);
614 tEHCI_QH *EHCI_int_AllocateQH(tEHCI_Controller *Cont, int Endpoint, size_t MaxPacketSize)
617 Mutex_Acquire(&Cont->QHPoolMutex);
618 for( int i = 0; i < QH_POOL_SIZE; i ++ )
620 if( !MM_GetPhysAddr( Cont->QHPools[i/QH_POOL_NPERPAGE] ) ) {
622 Cont->QHPools[i/QH_POOL_NPERPAGE] = (void*)MM_AllocDMA(1, 32, &tmp);
623 memset(Cont->QHPools[i/QH_POOL_NPERPAGE], 0, PAGE_SIZE);
626 ret = &Cont->QHPools[i/QH_POOL_NPERPAGE][i%QH_POOL_NPERPAGE];
627 if( ret->HLink == 0 ) {
629 ret->Overlay.Link = 1;
630 ret->Endpoint = (Endpoint >> 4) | 0x80 | ((Endpoint & 0xF) << 8)
631 | (MaxPacketSize << 16);
632 // TODO: Endpoint speed (13:12) 0:Full, 1:Low, 2:High
633 // TODO: Control Endpoint Flag (27) 0:*, 1:Full/Low Control
634 Mutex_Release(&Cont->QHPoolMutex);
638 Mutex_Release(&Cont->QHPoolMutex);
642 void EHCI_int_DeallocateQH(tEHCI_Controller *Cont, tEHCI_QH *QH)
644 // TODO: Ensure it's unused (somehow)
648 void EHCI_int_HandlePortConnectChange(tEHCI_Controller *Cont, int Port)
651 if( Cont->OpRegs->PortSC[Port] & PORTSC_CurrentConnectStatus )
653 // Is the device low-speed?
654 if( (Cont->OpRegs->PortSC[Port] & PORTSC_LineStatus_MASK) == PORTSC_LineStatus_Kstate )
656 LOG("Low speed device on %p Port %i, giving to companion", Cont, Port);
657 Cont->OpRegs->PortSC[Port] |= PORTSC_PortOwner;
659 // not a low-speed device, EHCI reset
662 LOG("Device connected on %p #%i", Cont, Port);
664 USB_PortCtl_BeginReset(Cont->RootHub, Port);
670 if( Cont->OpRegs->PortSC[Port] & PORTSC_PortOwner ) {
671 LOG("Companion port %i disconnected, taking it back", Port);
672 Cont->OpRegs->PortSC[Port] &= ~PORTSC_PortOwner;
675 LOG("Port %i disconnected", Port);
676 USB_DeviceDisconnected(Cont->RootHub, Port);
681 void EHCI_int_InterruptThread(void *ControllerPtr)
683 tEHCI_Controller *Cont = ControllerPtr;
688 LOG("sleeping for events");
689 events = Threads_WaitEvents(EHCI_THREADEVENT_IOC|EHCI_THREADEVENT_PORTSC);
691 // TODO: Should this cause a termination?
693 LOG("events = 0x%x", events);
695 if( events & EHCI_THREADEVENT_IOC )
697 // IOC, Do whatever it is you do
700 // Port status change interrupt
701 if( events & EHCI_THREADEVENT_PORTSC )
703 // Check for port status changes
704 for(int i = 0; i < Cont->nPorts; i ++ )
706 Uint32 sts = Cont->OpRegs->PortSC[i];
707 LOG("Port %i: sts = %x", i, sts);
708 Cont->OpRegs->PortSC[i] = sts;
709 if( sts & PORTSC_ConnectStatusChange )
710 EHCI_int_HandlePortConnectChange(Cont, i);
712 if( sts & PORTSC_PortEnableChange )
714 // Handle enable/disable
717 if( sts & PORTSC_OvercurrentChange )
719 // Handle over-current change
724 LOG("Going back to sleep");