3 * Universal Host Controller Interface
6 #define VERSION VER2(0,5)
15 #define MAX_CONTROLLERS 4
19 int UHCI_Initialise();
21 tUHCI_TD *UHCI_int_AllocateTD(tUHCI_Controller *Cont);
22 void UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD);
23 void *UHCI_int_SendTransaction(tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl, tUSBHostCb Cb, void *Data, size_t Length);
24 void *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length);
25 void *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length);
26 void *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length);
27 int UHCI_IsTransferComplete(void *Ptr, void *Handle);
28 void UHCI_Hub_Poll(tUSBHub *Hub, tUSBDevice *Dev);
29 int UHCI_Int_InitHost(tUHCI_Controller *Host);
30 void UHCI_CheckPortUpdate(tUHCI_Controller *Host);
31 void UHCI_InterruptHandler(int IRQ, void *Ptr);
34 MODULE_DEFINE(0, VERSION, USB_UHCI, UHCI_Initialise, NULL, "USB_Core", NULL);
35 tUHCI_TD gaUHCI_TDPool[NUM_TDs];
36 tUHCI_Controller gUHCI_Controllers[MAX_CONTROLLERS];
37 tUSBHostDef gUHCI_HostDef = {
38 .SendIN = UHCI_DataIN,
39 .SendOUT = UHCI_DataOUT,
40 .SendSETUP = UHCI_SendSetup,
41 .CheckPorts = (void*)UHCI_CheckPortUpdate,
42 .IsOpComplete = UHCI_IsTransferComplete
47 * \fn int UHCI_Initialise()
48 * \brief Called to initialise the UHCI Driver
50 int UHCI_Initialise(const char **Arguments)
57 // Enumerate PCI Bus, getting a maximum of `MAX_CONTROLLERS` devices
58 while( (id = PCI_GetDeviceByClass(0x0C03, 0xFFFF, id)) >= 0 && i < MAX_CONTROLLERS )
60 tUHCI_Controller *cinfo = &gUHCI_Controllers[i];
61 // NOTE: Check "protocol" from PCI?
64 cinfo->IOBase = PCI_GetBAR(id, 4);
65 if( !(cinfo->IOBase & 1) ) {
66 Log_Warning("UHCI", "MMIO is not supported");
70 cinfo->IRQNum = PCI_GetIRQ(id);
72 Log_Debug("UHCI", "Controller PCI #%i: IO Base = 0x%x, IRQ %i",
73 id, cinfo->IOBase, cinfo->IRQNum);
75 IRQ_AddHandler(cinfo->IRQNum, UHCI_InterruptHandler, cinfo);
78 ret = UHCI_Int_InitHost(&gUHCI_Controllers[i]);
85 cinfo->RootHub = USB_RegisterHost(&gUHCI_HostDef, cinfo, 2);
86 LOG("cinfo->RootHub = %p", cinfo->RootHub);
88 UHCI_CheckPortUpdate(cinfo);
92 if(i == MAX_CONTROLLERS) {
93 Log_Warning("UHCI", "Over "EXPAND_STR(MAX_CONTROLLERS)" UHCI controllers detected, ignoring rest");
95 LEAVE('i', MODULE_ERR_OK);
100 * \fn void UHCI_Cleanup()
101 * \brief Called just before module is unloaded
107 tUHCI_TD *UHCI_int_AllocateTD(tUHCI_Controller *Cont)
110 for(i = 0; i < NUM_TDs; i ++)
112 if(gaUHCI_TDPool[i].Link == 0) {
113 gaUHCI_TDPool[i].Link = 1;
114 gaUHCI_TDPool[i].Control = 1 << 23;
115 return &gaUHCI_TDPool[i];
117 // Still in use? Skip
118 if( gaUHCI_TDPool[i].Control & (1 << 23) )
120 // Is there a callback on it? Skip
121 if( gaUHCI_TDPool[i]._info.Callback )
123 // TODO: Garbage collect, but that means removing from the list too
125 // Ok, this is actually unused
126 gaUHCI_TDPool[i].Link = 1;
127 gaUHCI_TDPool[i].Control = 1 << 23;
128 return &gaUHCI_TDPool[i];
134 void UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD)
136 int next_frame = (inw(Cont->IOBase + FRNUM) + 2) & (1024-1);
137 tPAddr td_pool_base = MM_GetPhysAddr( (tVAddr)gaUHCI_TDPool );
141 // TODO: How to handle FRNUM incrementing while we are in this function?
144 if( Cont->FrameList[next_frame] & 1 )
146 // TODO: Ensure 32-bit paddr
147 Cont->FrameList[next_frame] = MM_GetPhysAddr( (tVAddr)TD );
148 LOG("next_frame = %i", next_frame);
152 // Find the end of the list
153 link = Cont->FrameList[next_frame];
155 // TODO: Fix this to work with a non-contiguous pool
156 prev_td = gaUHCI_TDPool + (link - td_pool_base) / sizeof(gaUHCI_TDPool[0]);
157 link = prev_td->Link;
158 } while( !(link & 1) );
161 prev_td->Link = MM_GetPhysAddr( (tVAddr)TD );
163 LOG("next_frame = %i, prev_td = %p", next_frame, prev_td);
167 * \brief Send a transaction to the USB bus
168 * \param Cont Controller pointer
169 * \param Addr Function Address * 16 + Endpoint
170 * \param bTgl Data toggle value
172 void *UHCI_int_SendTransaction(tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl, tUSBHostCb Cb, void *Data, size_t Length)
176 if( Length > 0x400 ) return NULL; // Controller allows up to 0x500, but USB doesn't
178 td = UHCI_int_AllocateTD(Cont);
182 Log_Error("UHCI", "No avaliable TDs, transaction dropped");
187 td->Control = (Length - 1) & 0x7FF;
188 td->Control |= (1 << 23);
189 td->Token = ((Length - 1) & 0x7FF) << 21;
190 td->Token |= (bTgl & 1) << 19;
191 td->Token |= (Addr & 0xF) << 15;
192 td->Token |= ((Addr/16) & 0xFF) << 8;
195 // TODO: Ensure 32-bit paddr
196 if( ((tVAddr)Data & (PAGE_SIZE-1)) + Length > PAGE_SIZE ) {
197 Log_Warning("UHCI", "TODO: Support non single page transfers (%x + %x > %x)",
198 (tVAddr)Data & (PAGE_SIZE-1), Length, PAGE_SIZE
200 // TODO: Need to enable IOC to copy the data back
201 // td->BufferPointer =
205 td->BufferPointer = MM_GetPhysAddr( (tVAddr)Data );
208 // Interrupt on completion
210 td->Control |= (1 << 24);
211 td->_info.Callback = Cb; // NOTE: if ERRPTR then the TD is kept allocated until checked
214 Log_Warning("UHCI", "TODO: Support IOC... somehow");
218 td->_info.DestPtr = Data;
220 UHCI_int_AppendTD(Cont, td);
225 void *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
227 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x69, DataTgl, Cb, Data, Length);
230 void *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
232 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0xE1, DataTgl, Cb, Data, Length);
235 void *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
237 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x2D, DataTgl, Cb, Data, Length);
240 int UHCI_IsTransferComplete(void *Ptr, void *Handle)
242 tUHCI_TD *td = Handle;
243 return !(td->Control & (1 << 23));
246 void UHCI_Hub_Poll(tUSBHub *Hub, tUSBDevice *Dev)
248 tUHCI_Controller *cont = USB_GetDeviceDataPtr(Dev);
250 UHCI_CheckPortUpdate(cont);
253 // === INTERNAL FUNCTIONS ===
255 * \fn int UHCI_Int_InitHost(tUCHI_Controller *Host)
256 * \brief Initialises a UHCI host controller
257 * \param Host Pointer - Host to initialise
259 int UHCI_Int_InitHost(tUHCI_Controller *Host)
261 ENTER("pHost", Host);
263 outw( Host->IOBase + USBCMD, 4 ); // GRESET
265 // TODO: Wait for at least 10ms
266 outw( Host->IOBase + USBCMD, 0 ); // GRESET
268 // Allocate Frame List
269 // - 1 Page, 32-bit address
270 // - 1 page = 1024 4 byte entries
271 Host->FrameList = (void *) MM_AllocDMA(1, 32, &Host->PhysFrameList);
272 if( !Host->FrameList ) {
273 Log_Warning("UHCI", "Unable to allocate frame list, aborting");
277 LOG("Allocated frame list 0x%x (0x%x)", Host->FrameList, Host->PhysFrameList);
278 memsetd( Host->FrameList, 1, 1024 ); // Clear List (Disabling all entries)
280 //! \todo Properly fill frame list
282 // Set frame length to 1 ms
283 outb( Host->IOBase + SOFMOD, 64 );
286 outd( Host->IOBase + FLBASEADD, Host->PhysFrameList );
287 outw( Host->IOBase + FRNUM, 0 );
290 outw( Host->IOBase + USBINTR, 0x000F );
291 PCI_ConfigWrite( Host->PciId, 0xC0, 2, 0x2000 );
294 outw( Host->IOBase + USBCMD, 0x0001 );
300 void UHCI_CheckPortUpdate(tUHCI_Controller *Host)
303 for( int i = 0; i < 2; i ++ )
305 int port = Host->IOBase + PORTSC1 + i*2;
306 // Check for port change
307 if( !(inw(port) & 0x0002) ) continue;
310 // Check if the port is connected
311 if( !(inw(port) & 1) )
313 // Tell the USB code it's gone.
314 USB_DeviceDisconnected(Host->RootHub, i);
319 LOG("Port %i has something", i);
320 // Reset port (set bit 9)
322 outw( port, 0x0200 );
323 Time_Delay(50); // 50ms delay
324 outw( port, inw(port) & ~0x0200 );
327 Time_Delay(50); // 50ms delay
328 outw( port, inw(port) | 0x0004 );
329 // Tell USB there's a new device
330 USB_DeviceConnected(Host->RootHub, i);
335 void UHCI_InterruptHandler(int IRQ, void *Ptr)
337 tUHCI_Controller *Host = Ptr;
338 Uint16 status = inw(Host->IOBase + USBSTS);
339 Log_Debug("UHCI", "UHIC Interrupt, status = 0x%x", status);
343 // Interrupt-on-completion
346 outw(Host->IOBase + USBSTS, status);