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();
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(const 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 LOG("next_frame = %i", next_frame);
160 // Find the end of the list
161 link = Cont->FrameList[next_frame];
163 prev_td = UHCI_int_GetTDFromPhys(link);
164 link = prev_td->Link;
165 } while( !(link & 1) );
168 prev_td->Link = MM_GetPhysAddr( (tVAddr)TD );
170 LOG("next_frame = %i, prev_td = %p", next_frame, prev_td);
174 * \brief Send a transaction to the USB bus
175 * \param Cont Controller pointer
176 * \param Addr Function Address * 16 + Endpoint
177 * \param bTgl Data toggle value
179 void *UHCI_int_SendTransaction(
180 tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl,
181 tUSBHostCb Cb, void *CbData, void *Data, size_t Length)
185 if( Length > 0x400 ) return NULL; // Controller allows up to 0x500, but USB doesn't
187 td = UHCI_int_AllocateTD(Cont);
190 // TODO: Wait for one to free?
191 Log_Error("UHCI", "No avaliable TDs, transaction dropped");
196 td->Control = (Length - 1) & 0x7FF;
197 td->Control |= (1 << 23);
198 td->Token = ((Length - 1) & 0x7FF) << 21;
199 td->Token |= (bTgl & 1) << 19;
200 td->Token |= (Addr & 0xF) << 15;
201 td->Token |= ((Addr/16) & 0xFF) << 8;
204 // TODO: Ensure 32-bit paddr
205 if( ((tVAddr)Data & (PAGE_SIZE-1)) + Length > PAGE_SIZE ) {
206 Log_Warning("UHCI", "TODO: Support non single page transfers (%x + %x > %x)",
207 (tVAddr)Data & (PAGE_SIZE-1), Length, PAGE_SIZE
209 // TODO: Need to enable IOC to copy the data back
210 // td->BufferPointer =
211 td->_info.bCopyData = 1;
215 td->BufferPointer = MM_GetPhysAddr( (tVAddr)Data );
216 td->_info.bCopyData = 0;
219 // Interrupt on completion
221 td->Control |= (1 << 24);
222 td->_info.Callback = Cb; // NOTE: if ERRPTR then the TD is kept allocated until checked
223 td->_info.CallbackPtr = CbData;
226 td->_info.DataPtr = Data;
228 UHCI_int_AppendTD(Cont, td);
233 void *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
235 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x69, DataTgl, Cb, CbData, Buf, Length);
238 void *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
240 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0xE1, DataTgl, Cb, CbData, Buf, Length);
243 void *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
245 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x2D, DataTgl, Cb, CbData, Buf, Length);
248 int UHCI_IsTransferComplete(void *Ptr, void *Handle)
250 tUHCI_TD *td = Handle;
252 ret = !(td->Control & (1 << 23));
254 td->_info.Callback = NULL;
260 // === INTERNAL FUNCTIONS ===
262 * \fn int UHCI_Int_InitHost(tUCHI_Controller *Host)
263 * \brief Initialises a UHCI host controller
264 * \param Host Pointer - Host to initialise
266 int UHCI_Int_InitHost(tUHCI_Controller *Host)
268 ENTER("pHost", Host);
270 outw( Host->IOBase + USBCMD, 4 ); // GRESET
272 // TODO: Wait for at least 10ms
273 outw( Host->IOBase + USBCMD, 0 ); // GRESET
275 // Allocate Frame List
276 // - 1 Page, 32-bit address
277 // - 1 page = 1024 4 byte entries
278 Host->FrameList = (void *) MM_AllocDMA(1, 32, &Host->PhysFrameList);
279 if( !Host->FrameList ) {
280 Log_Warning("UHCI", "Unable to allocate frame list, aborting");
284 LOG("Allocated frame list 0x%x (0x%x)", Host->FrameList, Host->PhysFrameList);
285 memsetd( Host->FrameList, 1, 1024 ); // Clear List (Disabling all entries)
287 //! \todo Properly fill frame list
289 // Set frame length to 1 ms
290 outb( Host->IOBase + SOFMOD, 64 );
293 outd( Host->IOBase + FLBASEADD, Host->PhysFrameList );
294 outw( Host->IOBase + FRNUM, 0 );
297 outw( Host->IOBase + USBINTR, 0x000F );
298 PCI_ConfigWrite( Host->PciId, 0xC0, 2, 0x2000 );
301 outw( Host->IOBase + USBCMD, 0x0001 );
307 void UHCI_CheckPortUpdate(void *Ptr)
309 tUHCI_Controller *Host = Ptr;
311 for( int i = 0; i < 2; i ++ )
313 int port = Host->IOBase + PORTSC1 + i*2;
314 // Check for port change
315 if( !(inw(port) & 0x0002) ) continue;
318 // Check if the port is connected
319 if( !(inw(port) & 1) )
321 // Tell the USB code it's gone.
322 USB_DeviceDisconnected(Host->RootHub, i);
327 LOG("Port %i has something", i);
328 // Reset port (set bit 9)
330 outw( port, 0x0200 );
331 Time_Delay(50); // 50ms delay
332 outw( port, inw(port) & ~0x0200 );
335 Time_Delay(50); // 50ms delay
336 outw( port, inw(port) | 0x0004 );
337 // Tell USB there's a new device
338 USB_DeviceConnected(Host->RootHub, i);
343 void UHCI_InterruptHandler(int IRQ, void *Ptr)
345 tUHCI_Controller *Host = Ptr;
346 Uint16 status = inw(Host->IOBase + USBSTS);
347 Log_Debug("UHCI", "UHIC Interrupt, status = 0x%x", status);
349 // Interrupt-on-completion
353 int frame = inw(Host->IOBase + FRNUM) - 1;
354 if(frame < 0) frame += 1024;
356 link = Host->FrameList[frame];
357 Host->FrameList[frame] = 1;
360 tUHCI_TD *td = UHCI_int_GetTDFromPhys(link);
361 int byte_count = (td->Control&0x7FF)+1;
362 // Handle non-page aligned destination
363 // TODO: This will break if the destination is not in global memory
364 if(td->_info.bCopyData)
366 void *ptr = (void*)MM_MapTemp(td->BufferPointer);
367 memcpy(td->_info.DataPtr, ptr, byte_count);
368 MM_FreeTemp((tVAddr)ptr);
371 if(td->_info.Callback && td->_info.Callback != INVLPTR)
373 td->_info.Callback(td->_info.CallbackPtr, td->_info.DataPtr, byte_count);
374 td->_info.Callback = NULL;
377 if( td->_info.Callback != INVLPTR )
381 // Host->LastCleanedFrame = frame;
384 outw(Host->IOBase + USBSTS, status);