3 * - By John Hodge (thePowersGang)
5 * Universal Host Controller Interface
8 #define VERSION VER2(0,5)
17 #define MAX_CONTROLLERS 4
21 int UHCI_Initialise(char **Arguments);
23 tUHCI_TD *UHCI_int_AllocateTD(tUHCI_Controller *Cont);
24 void UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD);
25 void *UHCI_int_SendTransaction(tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
26 void *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
27 void *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
28 void *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
29 int UHCI_IsTransferComplete(void *Ptr, void *Handle);
30 int UHCI_Int_InitHost(tUHCI_Controller *Host);
31 void UHCI_CheckPortUpdate(void *Ptr);
32 void UHCI_InterruptHandler(int IRQ, void *Ptr);
35 MODULE_DEFINE(0, VERSION, USB_UHCI, UHCI_Initialise, NULL, "USB_Core", NULL);
36 tUHCI_TD gaUHCI_TDPool[NUM_TDs];
37 tUHCI_Controller gUHCI_Controllers[MAX_CONTROLLERS];
38 tUSBHostDef gUHCI_HostDef = {
39 .SendIN = UHCI_DataIN,
40 .SendOUT = UHCI_DataOUT,
41 .SendSETUP = UHCI_SendSetup,
42 .CheckPorts = UHCI_CheckPortUpdate,
43 .IsOpComplete = UHCI_IsTransferComplete
48 * \fn int UHCI_Initialise()
49 * \brief Called to initialise the UHCI Driver
51 int UHCI_Initialise(char **Arguments)
58 // Enumerate PCI Bus, getting a maximum of `MAX_CONTROLLERS` devices
59 while( (id = PCI_GetDeviceByClass(0x0C03, 0xFFFF, id)) >= 0 && i < MAX_CONTROLLERS )
61 tUHCI_Controller *cinfo = &gUHCI_Controllers[i];
62 // NOTE: Check "protocol" from PCI?
65 cinfo->IOBase = PCI_GetBAR(id, 4);
66 if( !(cinfo->IOBase & 1) ) {
67 Log_Warning("UHCI", "MMIO is not supported");
71 cinfo->IRQNum = PCI_GetIRQ(id);
73 Log_Debug("UHCI", "Controller PCI #%i: IO Base = 0x%x, IRQ %i",
74 id, cinfo->IOBase, cinfo->IRQNum);
76 IRQ_AddHandler(cinfo->IRQNum, UHCI_InterruptHandler, cinfo);
79 ret = UHCI_Int_InitHost(&gUHCI_Controllers[i]);
86 cinfo->RootHub = USB_RegisterHost(&gUHCI_HostDef, cinfo, 2);
87 LOG("cinfo->RootHub = %p", cinfo->RootHub);
89 UHCI_CheckPortUpdate(cinfo);
93 if(i == MAX_CONTROLLERS) {
94 Log_Warning("UHCI", "Over "EXPAND_STR(MAX_CONTROLLERS)" UHCI controllers detected, ignoring rest");
96 LEAVE('i', MODULE_ERR_OK);
101 * \fn void UHCI_Cleanup()
102 * \brief Called just before module is unloaded
108 tUHCI_TD *UHCI_int_AllocateTD(tUHCI_Controller *Cont)
111 for(i = 0; i < NUM_TDs; i ++)
113 if(gaUHCI_TDPool[i].Link == 0) {
114 gaUHCI_TDPool[i].Link = 1;
115 gaUHCI_TDPool[i].Control = 1 << 23;
116 return &gaUHCI_TDPool[i];
118 // Still in use? Skip
119 if( gaUHCI_TDPool[i].Control & (1 << 23) )
121 // Is there a callback on it? Skip
122 if( gaUHCI_TDPool[i]._info.Callback )
124 // TODO: Garbage collect, but that means removing from the list too
126 // Ok, this is actually unused
127 gaUHCI_TDPool[i].Link = 1;
128 gaUHCI_TDPool[i].Control = 1 << 23;
129 return &gaUHCI_TDPool[i];
135 tUHCI_TD *UHCI_int_GetTDFromPhys(tPAddr PAddr)
137 // TODO: Fix this to work with a non-contiguous pool
138 static tPAddr td_pool_base;
139 if(!td_pool_base) td_pool_base = MM_GetPhysAddr( (tVAddr)gaUHCI_TDPool );
140 return gaUHCI_TDPool + (PAddr - td_pool_base) / sizeof(gaUHCI_TDPool[0]);
143 void UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD)
145 int next_frame = (inw(Cont->IOBase + FRNUM) + 2) & (1024-1);
149 // TODO: How to handle FRNUM incrementing while we are in this function?
152 if( Cont->FrameList[next_frame] & 1 )
154 // TODO: Ensure 32-bit paddr
155 Cont->FrameList[next_frame] = MM_GetPhysAddr( (tVAddr)TD );
156 TD->Control |= (1 << 24); // Ensure that there is an interrupt for each used frame
157 LOG("next_frame = %i", next_frame);
161 // Find the end of the list
162 link = Cont->FrameList[next_frame];
164 prev_td = UHCI_int_GetTDFromPhys(link);
165 link = prev_td->Link;
166 } while( !(link & 1) );
169 prev_td->Link = MM_GetPhysAddr( (tVAddr)TD );
171 LOG("next_frame = %i, prev_td = %p", next_frame, prev_td);
175 * \brief Send a transaction to the USB bus
176 * \param Cont Controller pointer
177 * \param Addr Function Address * 16 + Endpoint
178 * \param bTgl Data toggle value
180 void *UHCI_int_SendTransaction(
181 tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl,
182 tUSBHostCb Cb, void *CbData, void *Data, size_t Length)
186 if( Length > 0x400 ) return NULL; // Controller allows up to 0x500, but USB doesn't
188 td = UHCI_int_AllocateTD(Cont);
191 // TODO: Wait for one to free?
192 Log_Error("UHCI", "No avaliable TDs, transaction dropped");
197 td->Control = (Length - 1) & 0x7FF;
198 td->Control |= (1 << 23);
199 td->Token = ((Length - 1) & 0x7FF) << 21;
200 td->Token |= (bTgl & 1) << 19;
201 td->Token |= (Addr & 0xF) << 15;
202 td->Token |= ((Addr/16) & 0xFF) << 8;
205 // TODO: Ensure 32-bit paddr
206 if( ((tVAddr)Data & (PAGE_SIZE-1)) + Length > PAGE_SIZE ) {
207 Log_Warning("UHCI", "TODO: Support non single page transfers (%x + %x > %x)",
208 (tVAddr)Data & (PAGE_SIZE-1), Length, PAGE_SIZE
210 // TODO: Need to enable IOC to copy the data back
211 // td->BufferPointer =
212 td->_info.bCopyData = 1;
216 td->BufferPointer = MM_GetPhysAddr( (tVAddr)Data );
217 td->_info.bCopyData = 0;
220 // Interrupt on completion
222 td->Control |= (1 << 24);
223 LOG("IOC Cb=%p CbData=%p", Cb, CbData);
224 td->_info.Callback = Cb; // NOTE: if ERRPTR then the TD is kept allocated until checked
225 td->_info.CallbackPtr = CbData;
228 td->_info.DataPtr = Data;
230 UHCI_int_AppendTD(Cont, td);
235 void *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
237 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x69, DataTgl, Cb, CbData, Buf, Length);
240 void *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
242 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0xE1, DataTgl, Cb, CbData, Buf, Length);
245 void *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
247 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x2D, DataTgl, Cb, CbData, Buf, Length);
250 int UHCI_IsTransferComplete(void *Ptr, void *Handle)
252 tUHCI_TD *td = Handle;
254 ret = !(td->Control & (1 << 23));
256 td->_info.Callback = NULL;
262 // === INTERNAL FUNCTIONS ===
264 * \fn int UHCI_Int_InitHost(tUCHI_Controller *Host)
265 * \brief Initialises a UHCI host controller
266 * \param Host Pointer - Host to initialise
268 int UHCI_Int_InitHost(tUHCI_Controller *Host)
270 ENTER("pHost", Host);
272 outw( Host->IOBase + USBCMD, 4 ); // GRESET
274 // TODO: Wait for at least 10ms
275 outw( Host->IOBase + USBCMD, 0 ); // GRESET
277 // Allocate Frame List
278 // - 1 Page, 32-bit address
279 // - 1 page = 1024 4 byte entries
280 Host->FrameList = (void *) MM_AllocDMA(1, 32, &Host->PhysFrameList);
281 if( !Host->FrameList ) {
282 Log_Warning("UHCI", "Unable to allocate frame list, aborting");
286 LOG("Allocated frame list 0x%x (0x%x)", Host->FrameList, Host->PhysFrameList);
287 memsetd( Host->FrameList, 1, 1024 ); // Clear List (Disabling all entries)
289 //! \todo Properly fill frame list
291 // Set frame length to 1 ms
292 outb( Host->IOBase + SOFMOD, 64 );
295 outd( Host->IOBase + FLBASEADD, Host->PhysFrameList );
296 outw( Host->IOBase + FRNUM, 0 );
299 outw( Host->IOBase + USBINTR, 0x000F );
300 PCI_ConfigWrite( Host->PciId, 0xC0, 2, 0x2000 );
303 outw( Host->IOBase + USBCMD, 0x0001 );
309 void UHCI_CheckPortUpdate(void *Ptr)
311 tUHCI_Controller *Host = Ptr;
313 for( int i = 0; i < 2; i ++ )
315 int port = Host->IOBase + PORTSC1 + i*2;
316 // Check for port change
317 if( !(inw(port) & 0x0002) ) continue;
320 // Check if the port is connected
321 if( !(inw(port) & 1) )
323 // Tell the USB code it's gone.
324 USB_DeviceDisconnected(Host->RootHub, i);
329 LOG("Port %i has something", i);
330 // Reset port (set bit 9)
332 outw( port, 0x0200 );
333 Time_Delay(50); // 50ms delay
334 outw( port, inw(port) & ~0x0200 );
337 Time_Delay(50); // 50ms delay
338 outw( port, inw(port) | 0x0004 );
339 // Tell USB there's a new device
340 USB_DeviceConnected(Host->RootHub, i);
345 void UHCI_InterruptHandler(int IRQ, void *Ptr)
347 tUHCI_Controller *Host = Ptr;
348 int frame = ((int)inw(Host->IOBase + FRNUM) - 1) & 0x3FF;
349 Uint16 status = inw(Host->IOBase + USBSTS);
350 // Log_Debug("UHCI", "UHIC Interrupt, status = 0x%x, frame = %i", status, frame);
352 // Interrupt-on-completion
357 for( int i = 0; i < 10; i ++ )
359 link = Host->FrameList[frame];
360 Host->FrameList[frame] = 1;
363 tUHCI_TD *td = UHCI_int_GetTDFromPhys(link);
364 int byte_count = (td->Control&0x7FF)+1;
365 LOG("link = 0x%x, td = %p, byte_count = %i", link, td, byte_count);
366 // Handle non-page aligned destination
367 // TODO: This will break if the destination is not in global memory
368 if(td->_info.bCopyData)
370 void *ptr = (void*)MM_MapTemp(td->BufferPointer);
371 memcpy(td->_info.DataPtr, ptr, byte_count);
372 MM_FreeTemp((tVAddr)ptr);
375 if(td->_info.Callback && td->_info.Callback != INVLPTR)
377 LOG("Calling cb %p", td->_info.Callback);
378 td->_info.Callback(td->_info.CallbackPtr, td->_info.DataPtr, byte_count);
379 td->_info.Callback = NULL;
382 if( td->_info.Callback != INVLPTR )
392 // Host->LastCleanedFrame = frame;
395 LOG("status = 0x%02x", status);
396 outw(Host->IOBase + USBSTS, status);