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_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;
131 // -- Build up structure --
132 cont->CapRegs = (void*)MM_MapHWPages(BaseAddress, 1);
133 if( !cont->CapRegs ) {
134 Log_Warning("EHCI", "Can't map 1 page at %P into kernel space", BaseAddress);
138 if( (cont->CapRegs->CapLength & 3) ) {
139 Log_Warning("EHCI", "Controller at %P non-aligned op regs", BaseAddress);
142 cont->OpRegs = (void*)( (Uint32*)cont->CapRegs + cont->CapRegs->CapLength / 4 );
143 // - Allocate periodic queue
145 cont->PeriodicQueue = (void*)MM_AllocDMA(1, 32, &unused);
146 if( !cont->PeriodicQueue ) {
147 Log_Warning("ECHI", "Can't allocate 1 32-bit page for periodic queue");
154 cont->nPorts = cont->CapRegs->HCSParams & 0xF;
158 IRQ_AddHandler(InterruptNum, EHCI_InterruptHandler, cont);
159 cont->InterruptThread = Proc_SpawnWorker(EHCI_int_InterruptThread, cont);
160 if( !cont->InterruptThread ) {
161 Log_Warning("EHCI", "Can't spawn interrupt worker thread");
164 LOG("cont->InterruptThread = %p", cont->InterruptThread);
166 // -- Initialisation procedure (from ehci-r10) --
167 // - Reset controller
168 cont->OpRegs->USBCmd = USBCMD_HCReset;
169 // - Set CTRLDSSEGMENT (TODO: 64-bit support)
171 cont->OpRegs->USBIntr = USBINTR_IOC|USBINTR_PortChange|USBINTR_FrameRollover;
172 // - Set PERIODICLIST BASE
173 cont->OpRegs->PeridocListBase = MM_GetPhysAddr( cont->PeriodicQueue );
174 // - Enable controller
175 cont->OpRegs->USBCmd = (0x40 << 16) | USBCMD_PeriodicEnable | USBCMD_Run;
177 cont->OpRegs->ConfigFlag = 1;
179 // -- Register with USB Core --
180 cont->RootHub = USB_RegisterHost(&gEHCI_HostDef, cont, cont->nPorts);
186 MM_Deallocate( (tVAddr)cont->CapRegs );
187 if( cont->PeriodicQueue )
188 MM_Deallocate( (tVAddr)cont->PeriodicQueue );
192 void EHCI_InterruptHandler(int IRQ, void *Ptr)
194 tEHCI_Controller *Cont = Ptr;
195 Uint32 sts = Cont->OpRegs->USBSts;
198 Cont->OpRegs->USBSts = sts;
200 if( sts & 0xFFFF0FC0 ) {
201 LOG("Oops, reserved bits set (%08x), funny hardware?", sts);
205 // Unmask read-only bits
208 if( sts & USBINTR_IOC ) {
210 Threads_PostEvent(Cont->InterruptThread, EHCI_THREADEVENT_IOC);
214 if( sts & USBINTR_PortChange ) {
215 // Port change, determine what port and poke helper thread
216 LOG("Port status change");
217 Threads_PostEvent(Cont->InterruptThread, EHCI_THREADEVENT_PORTSC);
218 sts &= ~USBINTR_PortChange;
221 if( sts & USBINTR_FrameRollover ) {
222 // Frame rollover, used to aid timing (trigger per-second operations)
223 LOG("Frame rollover");
224 sts &= ~USBINTR_FrameRollover;
228 // Unhandled interupt bits
230 LOG("WARN - Bitmask %x unhandled", sts);
236 // --------------------------------------------------------------------
238 // --------------------------------------------------------------------
239 void *EHCI_InitInterrupt(void *Ptr, int Endpoint, int bOutbound, int Period,
240 tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
242 tEHCI_Controller *Cont = Ptr;
243 int pow2period, period_pow;
245 if( Endpoint >= 256*16 )
252 // Round the period to the closest power of two
255 // - Find the first power above the period
256 while( pow2period < Period )
261 // - Check which is closest
262 if( Period - pow2period / 2 > pow2period - Period )
265 Period = pow2period/2;
270 tEHCI_QH *qh = EHCI_int_AllocateQH(Cont, Endpoint, Length);
271 qh->Impl.IntPeriodPow = period_pow;
273 Mutex_Acquire(&Cont->PeriodicListLock);
275 // Choose an interrupt slot to use
276 int minslot = 0, minslot_load = INT_MAX;
277 for( int slot = 0; slot < Period; slot ++ )
280 for( int i = 0; i < PERIODIC_SIZE; i += Period )
281 load += Cont->InterruptLoad[i+slot];
282 if( load == 0 ) break;
283 if( load < minslot_load ) {
288 // Increase loading on the selected slot
289 for( int i = minslot; i < PERIODIC_SIZE; i += Period )
290 Cont->InterruptLoad[i] += Length;
291 qh->Impl.IntOfs = minslot;
293 // Allocate TD for the data
294 tEHCI_qTD *td = EHCI_int_AllocateTD(Cont, (bOutbound ? PID_OUT : PID_IN), Buf, Length, Cb, CbData);
295 EHCI_int_AppendTD(qh, td);
297 // Insert into the periodic list
298 for( int i = 0; i < PERIODIC_SIZE; i += Period )
301 // - the end is reached
302 // - this QH is found
303 // - A QH with a lower period is encountered
304 tEHCI_QH *pqh = NULL;
306 for( nqh = Cont->PeriodicQueueV[i]; nqh; pqh = nqh, nqh = nqh->Impl.Next )
310 if( nqh->Impl.IntPeriodPow < period_pow )
314 // Somehow, we've already been added to this queue.
315 if( nqh && nqh == qh )
318 if( qh->Impl.Next && qh->Impl.Next != nqh ) {
319 Log_Warning("EHCI", "Suspected bookkeeping error on %p - int list %i+%i overlap",
320 Cont, period_pow, minslot);
326 qh->HLink = MM_GetPhysAddr(nqh) | 2;
329 qh->Impl.Next = NULL;
330 qh->HLink = 2|1; // QH, Terminate
335 pqh->HLink = MM_GetPhysAddr(qh) | 2;
338 Cont->PeriodicQueueV[i] = qh;
339 Cont->PeriodicQueue[i] = MM_GetPhysAddr(qh) | 2;
342 Mutex_Release(&Cont->PeriodicListLock);
347 void *EHCI_InitIsoch(void *Ptr, int Endpoint, size_t MaxPacketSize)
349 return (void*)(tVAddr)(Endpoint + 1);
351 void *EHCI_InitControl(void *Ptr, int Endpoint, size_t MaxPacketSize)
353 tEHCI_Controller *Cont = Ptr;
356 tEHCI_QH *qh = EHCI_int_AllocateQH(Cont, Endpoint, MaxPacketSize);
358 // Append to async list
359 if( Cont->LastAsyncHead ) {
360 Cont->LastAsyncHead->HLink = MM_GetPhysAddr(qh)|2;
361 Cont->LastAsyncHead->Impl.Next = qh;
364 Cont->OpRegs->AsyncListAddr = MM_GetPhysAddr(qh)|2;
365 Cont->LastAsyncHead = qh;
367 LOG("Created %p for %p Ep 0x%x - %i bytes MPS", qh, Ptr, Endpoint, MaxPacketSize);
371 void *EHCI_InitBulk(void *Ptr, int Endpoint, size_t MaxPacketSize)
373 return EHCI_InitControl(Ptr, Endpoint, MaxPacketSize);
375 void EHCI_RemEndpoint(void *Ptr, void *Handle)
379 else if( (tVAddr)Handle <= 256*16 )
384 // Remove QH from list
385 // - If it's a polling endpoint, need to remove from all periodic lists
386 if( qh->Impl.IntPeriodPow != 0xFF) {
394 EHCI_int_DeallocateQH(Ptr, Handle);
398 void *EHCI_SendControl(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData,
400 const void *SetupData, size_t SetupLength,
401 const void *OutData, size_t OutLength,
402 void *InData, size_t InLength
405 tEHCI_Controller *Cont = Ptr;
406 tEHCI_qTD *td_setup, *td_data, *td_status;
409 if( (tVAddr)Dest <= 256*16 )
412 // Check size of SETUP and status
415 td_setup = EHCI_int_AllocateTD(Cont, PID_SETUP, (void*)SetupData, SetupLength, NULL, NULL);
418 td_data = OutData ? EHCI_int_AllocateTD(Cont, PID_OUT, (void*)OutData, OutLength, NULL, NULL) : NULL;
419 td_status = EHCI_int_AllocateTD(Cont, PID_IN, InData, InLength, Cb, CbData);
423 td_data = InData ? EHCI_int_AllocateTD(Cont, PID_IN, InData, InLength, NULL, NULL) : NULL;
424 td_status = EHCI_int_AllocateTD(Cont, PID_OUT, (void*)OutData, OutLength, Cb, CbData);
428 EHCI_int_AppendTD(Dest, td_setup);
430 EHCI_int_AppendTD(Dest, td_data);
431 EHCI_int_AppendTD(Dest, td_status);
436 void *EHCI_SendBulk(void *Ptr, void *Dest, tUSBHostCb Cb, void *CbData, int Dir, void *Data, size_t Length)
438 tEHCI_Controller *Cont = Ptr;
440 // Sanity check the pointer
441 // - Can't be NULL or an isoch
442 if( (tVAddr)Dest <= 256*16 )
445 // Allocate single TD
446 tEHCI_qTD *td = EHCI_int_AllocateTD(Cont, (Dir ? PID_OUT : PID_IN), Data, Length, Cb, CbData);
447 EHCI_int_AppendTD(Dest, td);
452 void EHCI_FreeOp(void *Ptr, void *Handle)
454 tEHCI_Controller *Cont = Ptr;
456 EHCI_int_DeallocateTD(Cont, Handle);
459 Uint32 EHCI_int_RootHub_FeatToMask(int Feat)
463 case PORT_RESET: return PORTSC_PortReset;
464 case PORT_ENABLE: return PORTSC_PortEnabled;
466 Log_Warning("EHCI", "Unknown root hub port feature %i", Feat);
471 void EHCI_RootHub_SetPortFeature(void *Ptr, int Port, int Feat)
473 tEHCI_Controller *Cont = Ptr;
474 if(Port >= Cont->nPorts) return;
476 Cont->OpRegs->PortSC[Port] |= EHCI_int_RootHub_FeatToMask(Feat);
479 void EHCI_RootHub_ClearPortFeature(void *Ptr, int Port, int Feat)
481 tEHCI_Controller *Cont = Ptr;
482 if(Port >= Cont->nPorts) return;
484 Cont->OpRegs->PortSC[Port] &= ~EHCI_int_RootHub_FeatToMask(Feat);
487 int EHCI_RootHub_GetPortStatus(void *Ptr, int Port, int Flag)
489 tEHCI_Controller *Cont = Ptr;
490 if(Port >= Cont->nPorts) return 0;
492 return !!(Cont->OpRegs->PortSC[Port] & EHCI_int_RootHub_FeatToMask(Flag));
495 // --------------------------------------------------------------------
497 // --------------------------------------------------------------------
498 tEHCI_qTD *EHCI_int_AllocateTD(tEHCI_Controller *Cont, int PID, void *Data, size_t Length, tUSBHostCb Cb, void *CbData)
504 void EHCI_int_DeallocateTD(tEHCI_Controller *Cont, tEHCI_qTD *TD)
509 void EHCI_int_AppendTD(tEHCI_QH *QH, tEHCI_qTD *TD)
514 tEHCI_QH *EHCI_int_AllocateQH(tEHCI_Controller *Cont, int Endpoint, size_t MaxPacketSize)
520 void EHCI_int_DeallocateQH(tEHCI_Controller *Cont, tEHCI_QH *QH)
525 void EHCI_int_HandlePortConnectChange(tEHCI_Controller *Cont, int Port)
528 if( Cont->OpRegs->PortSC[Port] & PORTSC_CurrentConnectStatus )
530 // Is the device low-speed?
531 if( (Cont->OpRegs->PortSC[Port] & PORTSC_LineStatus_MASK) == PORTSC_LineStatus_Kstate )
533 LOG("Low speed device on %p Port %i, giving to companion", Cont, Port);
534 Cont->OpRegs->PortSC[Port] |= PORTSC_PortOwner;
536 // not a low-speed device, EHCI reset
539 LOG("Device connected on %p #%i", Cont, Port);
541 USB_PortCtl_BeginReset(Cont->RootHub, Port);
547 if( Cont->OpRegs->PortSC[Port] & PORTSC_PortOwner ) {
548 LOG("Companion port %i disconnected, taking it back", Port);
549 Cont->OpRegs->PortSC[Port] &= ~PORTSC_PortOwner;
552 LOG("Port %i disconnected", Port);
553 USB_DeviceDisconnected(Cont->RootHub, Port);
558 void EHCI_int_InterruptThread(void *ControllerPtr)
560 tEHCI_Controller *Cont = ControllerPtr;
565 LOG("sleeping for events");
566 events = Threads_WaitEvents(EHCI_THREADEVENT_IOC|EHCI_THREADEVENT_PORTSC);
568 // TODO: Should this cause a termination?
570 LOG("events = 0x%x", events);
572 if( events & EHCI_THREADEVENT_IOC )
574 // IOC, Do whatever it is you do
577 // Port status change interrupt
578 if( events & EHCI_THREADEVENT_PORTSC )
580 // Check for port status changes
581 for(int i = 0; i < Cont->nPorts; i ++ )
583 Uint32 sts = Cont->OpRegs->PortSC[i];
584 LOG("Port %i: sts = %x", i, sts);
585 Cont->OpRegs->PortSC[i] = sts;
586 if( sts & PORTSC_ConnectStatusChange )
587 EHCI_int_HandlePortConnectChange(Cont, i);
589 if( sts & PORTSC_PortEnableChange )
591 // Handle enable/disable
594 if( sts & PORTSC_OvercurrentChange )
596 // Handle over-current change
601 LOG("Going back to sleep");