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"
98 // TODO: Register with the USB stack
103 int EHCI_Cleanup(void)
108 // --- Driver Init ---
109 int EHCI_InitController(tPAddr BaseAddress, Uint8 InterruptNum)
111 tEHCI_Controller *cont = NULL;
113 for( int i = 0; i < EHCI_MAX_CONTROLLERS; i ++ )
115 if( gaEHCI_Controllers[i].PhysBase == 0 ) {
116 cont = &gaEHCI_Controllers[i];
117 cont->PhysBase = BaseAddress;
122 Log_Notice("EHCI", "Too many controllers (EHCI_MAX_CONTROLLERS=%i)",
123 EHCI_MAX_CONTROLLERS);
127 // - Nuke a couple of fields so error handling code doesn't derp
128 cont->CapRegs = NULL;
129 cont->PeriodicQueue = NULL;
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);
139 if( (cont->CapRegs->CapLength & 3) ) {
140 Log_Warning("EHCI", "Controller at %P non-aligned op regs", BaseAddress);
143 cont->OpRegs = (void*)( (Uint32*)cont->CapRegs + cont->CapRegs->CapLength / 4 );
144 // - Allocate periodic queue
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");
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");
160 for( int i = 0; i < TD_POOL_SIZE; i ++ ) {
161 cont->TDPool[i].Token = 3 << 8;
165 cont->nPorts = cont->CapRegs->HCSParams & 0xF;
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");
174 LOG("cont->InterruptThread = %p", cont->InterruptThread);
176 // -- Initialisation procedure (from ehci-r10) --
177 // - Reset controller
178 cont->OpRegs->USBCmd = USBCMD_HCReset;
179 // - Set CTRLDSSEGMENT (TODO: 64-bit support)
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;
187 cont->OpRegs->ConfigFlag = 1;
189 // -- Register with USB Core --
190 cont->RootHub = USB_RegisterHost(&gEHCI_HostDef, cont, cont->nPorts);
196 MM_Deallocate( (tVAddr)cont->CapRegs );
197 if( cont->PeriodicQueue )
198 MM_Deallocate( (tVAddr)cont->PeriodicQueue );
200 MM_Deallocate( (tVAddr)cont->TDPool );
204 void EHCI_InterruptHandler(int IRQ, void *Ptr)
206 tEHCI_Controller *Cont = Ptr;
207 Uint32 sts = Cont->OpRegs->USBSts;
210 Cont->OpRegs->USBSts = sts;
212 if( sts & 0xFFFF0FC0 ) {
213 LOG("Oops, reserved bits set (%08x), funny hardware?", sts);
217 // Unmask read-only bits
220 if( sts & USBINTR_IOC ) {
222 Threads_PostEvent(Cont->InterruptThread, EHCI_THREADEVENT_IOC);
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;
233 if( sts & USBINTR_FrameRollover ) {
234 // Frame rollover, used to aid timing (trigger per-second operations)
235 LOG("Frame rollover");
236 sts &= ~USBINTR_FrameRollover;
240 // Unhandled interupt bits
242 LOG("WARN - Bitmask %x unhandled", sts);
248 // --------------------------------------------------------------------
250 // --------------------------------------------------------------------
251 void *EHCI_InitInterrupt(void *Ptr, int Endpoint, int bOutbound, int Period,
252 tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
254 tEHCI_Controller *Cont = Ptr;
255 int pow2period, period_pow;
257 if( Endpoint >= 256*16 )
264 // Round the period to the closest power of two
267 // - Find the first power above the period
268 while( pow2period < Period )
273 // - Check which is closest
274 if( Period - pow2period / 2 > pow2period - Period )
277 Period = pow2period/2;
282 tEHCI_QH *qh = EHCI_int_AllocateQH(Cont, Endpoint, Length);
283 qh->Impl.IntPeriodPow = period_pow;
285 Mutex_Acquire(&Cont->PeriodicListLock);
287 // Choose an interrupt slot to use
288 int minslot = 0, minslot_load = INT_MAX;
289 for( int slot = 0; slot < Period; slot ++ )
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 ) {
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;
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);
309 // Insert into the periodic list
310 for( int i = 0; i < PERIODIC_SIZE; i += Period )
313 // - the end is reached
314 // - this QH is found
315 // - A QH with a lower period is encountered
316 tEHCI_QH *pqh = NULL;
318 for( nqh = Cont->PeriodicQueueV[i]; nqh; pqh = nqh, nqh = nqh->Impl.Next )
322 if( nqh->Impl.IntPeriodPow < period_pow )
326 // Somehow, we've already been added to this queue.
327 if( nqh && nqh == qh )
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);
338 qh->HLink = MM_GetPhysAddr(nqh) | 2;
341 qh->Impl.Next = NULL;
342 qh->HLink = 2|1; // QH, Terminate
347 pqh->HLink = MM_GetPhysAddr(qh) | 2;
350 Cont->PeriodicQueueV[i] = qh;
351 Cont->PeriodicQueue[i] = MM_GetPhysAddr(qh) | 2;
354 Mutex_Release(&Cont->PeriodicListLock);
359 void *EHCI_InitIsoch(void *Ptr, int Endpoint, size_t MaxPacketSize)
361 return (void*)(tVAddr)(Endpoint + 1);
363 void *EHCI_InitControl(void *Ptr, int Endpoint, size_t MaxPacketSize)
365 tEHCI_Controller *Cont = Ptr;
368 tEHCI_QH *qh = EHCI_int_AllocateQH(Cont, Endpoint, MaxPacketSize);
370 // Append to async list
371 if( Cont->LastAsyncHead ) {
372 Cont->LastAsyncHead->HLink = MM_GetPhysAddr(qh)|2;
373 Cont->LastAsyncHead->Impl.Next = qh;
376 Cont->OpRegs->AsyncListAddr = MM_GetPhysAddr(qh)|2;
377 Cont->LastAsyncHead = qh;
379 LOG("Created %p for %p Ep 0x%x - %i bytes MPS", qh, Ptr, Endpoint, MaxPacketSize);
383 void *EHCI_InitBulk(void *Ptr, int Endpoint, size_t MaxPacketSize)
385 return EHCI_InitControl(Ptr, Endpoint, MaxPacketSize);
387 void EHCI_RemEndpoint(void *Ptr, void *Handle)
391 else if( (tVAddr)Handle <= 256*16 )
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) {
406 EHCI_int_DeallocateQH(Ptr, Handle);
410 void *EHCI_SendControl(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData,
412 const void *SetupData, size_t SetupLength,
413 const void *OutData, size_t OutLength,
414 void *InData, size_t InLength
417 tEHCI_Controller *Cont = Ptr;
418 tEHCI_qTD *td_setup, *td_data, *td_status;
421 if( (tVAddr)Dest <= 256*16 )
424 // Check size of SETUP and status
427 td_setup = EHCI_int_AllocateTD(Cont, PID_SETUP, (void*)SetupData, SetupLength, NULL, NULL);
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);
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);
442 td_setup->Link = MM_GetPhysAddr(td_data);
443 td_data->Link = MM_GetPhysAddr(td_status) | 1;
446 td_setup->Link = MM_GetPhysAddr(td_status) | 1;
448 EHCI_int_AppendTD(Cont, Dest, td_setup);
453 void *EHCI_SendBulk(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData, int Dir, void *Data, size_t Length)
455 tEHCI_Controller *Cont = Ptr;
457 // Sanity check the pointer
458 // - Can't be NULL or an isoch
459 if( (tVAddr)Dest <= 256*16 )
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);
469 void EHCI_FreeOp(void *Ptr, void *Handle)
471 tEHCI_Controller *Cont = Ptr;
473 EHCI_int_DeallocateTD(Cont, Handle);
476 Uint32 EHCI_int_RootHub_FeatToMask(int Feat)
480 case PORT_RESET: return PORTSC_PortReset;
481 case PORT_ENABLE: return PORTSC_PortEnabled;
483 Log_Warning("EHCI", "Unknown root hub port feature %i", Feat);
488 void EHCI_RootHub_SetPortFeature(void *Ptr, int Port, int Feat)
490 tEHCI_Controller *Cont = Ptr;
491 if(Port >= Cont->nPorts) return;
493 Cont->OpRegs->PortSC[Port] |= EHCI_int_RootHub_FeatToMask(Feat);
496 void EHCI_RootHub_ClearPortFeature(void *Ptr, int Port, int Feat)
498 tEHCI_Controller *Cont = Ptr;
499 if(Port >= Cont->nPorts) return;
501 Cont->OpRegs->PortSC[Port] &= ~EHCI_int_RootHub_FeatToMask(Feat);
504 int EHCI_RootHub_GetPortStatus(void *Ptr, int Port, int Flag)
506 tEHCI_Controller *Cont = Ptr;
507 if(Port >= Cont->nPorts) return 0;
509 return !!(Cont->OpRegs->PortSC[Port] & EHCI_int_RootHub_FeatToMask(Flag));
512 // --------------------------------------------------------------------
514 // --------------------------------------------------------------------
515 tEHCI_qTD *EHCI_int_GetTDFromPhys(tEHCI_Controller *Cont, Uint32 Addr)
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);
522 tEHCI_qTD *EHCI_int_AllocateTD(tEHCI_Controller *Cont, int PID, void *Data, size_t Length, tUSBHostCb Cb, void *CbData)
524 // Semaphore_Wait(&Cont->TDSemaphore, 1);
525 Mutex_Acquire(&Cont->TDPoolMutex);
526 for( int i = 0; i < TD_POOL_SIZE; i ++ )
528 if( ((Cont->TDPool[i].Token >> 8) & 3) != 3 )
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];
540 Mutex_Release(&Cont->TDPoolMutex);
544 void EHCI_int_DeallocateTD(tEHCI_Controller *Cont, tEHCI_qTD *TD)
549 void EHCI_int_AppendTD(tEHCI_Controller *Cont, tEHCI_QH *QH, tEHCI_qTD *TD)
551 tEHCI_qTD *ptd = NULL;
552 Uint32 link = QH->CurrentTD;
554 // TODO: Need locking and validation here
555 while( link && !(link & 1) )
557 ptd = EHCI_int_GetTDFromPhys(Cont, link);
560 // TODO: Figure out how to follow this properly
562 QH->CurrentTD = MM_GetPhysAddr(TD);
565 ptd->Link = MM_GetPhysAddr(TD);
568 tEHCI_QH *EHCI_int_AllocateQH(tEHCI_Controller *Cont, int Endpoint, size_t MaxPacketSize)
571 Mutex_Acquire(&Cont->QHPoolMutex);
572 for( int i = 0; i < QH_POOL_SIZE; i ++ )
574 if( !MM_GetPhysAddr( Cont->QHPools[i/QH_POOL_NPERPAGE] ) ) {
576 Cont->QHPools[i/QH_POOL_NPERPAGE] = (void*)MM_AllocDMA(1, 32, &tmp);
577 memset(Cont->QHPools[i/QH_POOL_NPERPAGE], 0, PAGE_SIZE);
580 ret = &Cont->QHPools[i/QH_POOL_NPERPAGE][i%QH_POOL_NPERPAGE];
581 if( ret->HLink == 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);
593 Mutex_Release(&Cont->QHPoolMutex);
597 void EHCI_int_DeallocateQH(tEHCI_Controller *Cont, tEHCI_QH *QH)
599 // TODO: Ensure it's unused (somehow)
603 void EHCI_int_HandlePortConnectChange(tEHCI_Controller *Cont, int Port)
606 if( Cont->OpRegs->PortSC[Port] & PORTSC_CurrentConnectStatus )
608 // Is the device low-speed?
609 if( (Cont->OpRegs->PortSC[Port] & PORTSC_LineStatus_MASK) == PORTSC_LineStatus_Kstate )
611 LOG("Low speed device on %p Port %i, giving to companion", Cont, Port);
612 Cont->OpRegs->PortSC[Port] |= PORTSC_PortOwner;
614 // not a low-speed device, EHCI reset
617 LOG("Device connected on %p #%i", Cont, Port);
619 USB_PortCtl_BeginReset(Cont->RootHub, Port);
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;
630 LOG("Port %i disconnected", Port);
631 USB_DeviceDisconnected(Cont->RootHub, Port);
636 void EHCI_int_InterruptThread(void *ControllerPtr)
638 tEHCI_Controller *Cont = ControllerPtr;
643 LOG("sleeping for events");
644 events = Threads_WaitEvents(EHCI_THREADEVENT_IOC|EHCI_THREADEVENT_PORTSC);
646 // TODO: Should this cause a termination?
648 LOG("events = 0x%x", events);
650 if( events & EHCI_THREADEVENT_IOC )
652 // IOC, Do whatever it is you do
655 // Port status change interrupt
656 if( events & EHCI_THREADEVENT_PORTSC )
658 // Check for port status changes
659 for(int i = 0; i < Cont->nPorts; i ++ )
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);
667 if( sts & PORTSC_PortEnableChange )
669 // Handle enable/disable
672 if( sts & PORTSC_OvercurrentChange )
674 // Handle over-current change
679 LOG("Going back to sleep");