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 void UHCI_Hub_Poll(tUSBHub *Hub, tUSBDevice *Dev);
28 int UHCI_Int_InitHost(tUHCI_Controller *Host);
29 void UHCI_CheckPortUpdate(tUHCI_Controller *Host);
30 void UHCI_InterruptHandler(int IRQ, void *Ptr);
33 MODULE_DEFINE(0, VERSION, USB_UHCI, UHCI_Initialise, NULL, "USB_Core", NULL);
34 tUHCI_TD gaUHCI_TDPool[NUM_TDs];
35 tUHCI_Controller gUHCI_Controllers[MAX_CONTROLLERS];
36 tUSBHostDef gUHCI_HostDef = {
37 .SendIN = UHCI_DataIN,
38 .SendOUT = UHCI_DataOUT,
39 .SendSETUP = UHCI_SendSetup,
40 .CheckPorts = (void*)UHCI_CheckPortUpdate
45 * \fn int UHCI_Initialise()
46 * \brief Called to initialise the UHCI Driver
48 int UHCI_Initialise(const char **Arguments)
55 // Enumerate PCI Bus, getting a maximum of `MAX_CONTROLLERS` devices
56 while( (id = PCI_GetDeviceByClass(0x0C03, 0xFFFF, id)) >= 0 && i < MAX_CONTROLLERS )
58 tUHCI_Controller *cinfo = &gUHCI_Controllers[i];
59 // NOTE: Check "protocol" from PCI?
62 cinfo->IOBase = PCI_GetBAR(id, 4);
63 if( !(cinfo->IOBase & 1) ) {
64 Log_Warning("UHCI", "MMIO is not supported");
67 cinfo->IRQNum = PCI_GetIRQ(id);
69 Log_Debug("UHCI", "Controller PCI #%i: IO Base = 0x%x, IRQ %i",
70 id, cinfo->IOBase, cinfo->IRQNum);
72 IRQ_AddHandler(cinfo->IRQNum, UHCI_InterruptHandler, cinfo);
75 ret = UHCI_Int_InitHost(&gUHCI_Controllers[i]);
82 cinfo->RootHub = USB_RegisterHost(&gUHCI_HostDef, cinfo, 2);
86 if(i == MAX_CONTROLLERS) {
87 Log_Warning("UHCI", "Over "EXPAND_STR(MAX_CONTROLLERS)" UHCI controllers detected, ignoring rest");
89 LEAVE('i', MODULE_ERR_OK);
94 * \fn void UHCI_Cleanup()
95 * \brief Called just before module is unloaded
101 tUHCI_TD *UHCI_int_AllocateTD(tUHCI_Controller *Cont)
104 for(i = 0; i < NUM_TDs; i ++)
106 if(gaUHCI_TDPool[i].Link == 0) {
107 gaUHCI_TDPool[i].Link = 1;
108 return &gaUHCI_TDPool[i];
114 void UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD)
116 Log_Warning("UHCI", "TODO: Implement AppendTD");
120 * \brief Send a transaction to the USB bus
121 * \param Cont Controller pointer
122 * \param Addr Function Address * 16 + Endpoint
123 * \param bTgl Data toggle value
125 void *UHCI_int_SendTransaction(tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl, tUSBHostCb Cb, void *Data, size_t Length)
129 if( Length > 0x400 ) return NULL; // Controller allows up to 0x500, but USB doesn't
131 td = UHCI_int_AllocateTD(Cont);
134 td->Control = (Length - 1) & 0x7FF;
135 td->Token = ((Length - 1) & 0x7FF) << 21;
136 td->Token |= (bTgl & 1) << 19;
137 td->Token |= (Addr & 0xF) << 15;
138 td->Token |= ((Addr/16) & 0xFF) << 8;
141 // TODO: Ensure 32-bit paddr
142 if( ((tVAddr)Data & PAGE_SIZE) + Length > PAGE_SIZE ) {
143 Log_Warning("UHCI", "TODO: Support non single page transfers");
144 // TODO: Need to enable IOC to copy the data back
145 // td->BufferPointer =
149 td->BufferPointer = MM_GetPhysAddr( (tVAddr)Data );
152 // Interrupt on completion
154 td->Control |= (1 << 24);
155 td->Avaliable[0] = (tVAddr)Cb; // NOTE: if ERRPTR then the TD is kept allocated until checked
157 td->Avaliable[1] = (tVAddr)Cb >> 32;
159 Log_Warning("UHCI", "TODO: Support IOC... somehow");
162 UHCI_int_AppendTD(Cont, td);
167 void *UHCI_DataIN(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
169 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x69, DataTgl, Cb, Data, Length);
172 void *UHCI_DataOUT(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
174 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0xE1, DataTgl, Cb, Data, Length);
177 void *UHCI_SendSetup(void *Ptr, int Fcn, int Endpt, int DataTgl, tUSBHostCb Cb, void *Data, size_t Length)
179 return UHCI_int_SendTransaction(Ptr, Fcn*16+Endpt, 0x2D, DataTgl, Cb, Data, Length);
182 void UHCI_Hub_Poll(tUSBHub *Hub, tUSBDevice *Dev)
184 tUHCI_Controller *cont = USB_GetDeviceDataPtr(Dev);
186 UHCI_CheckPortUpdate(cont);
189 // === INTERNAL FUNCTIONS ===
191 * \fn int UHCI_Int_InitHost(tUCHI_Controller *Host)
192 * \brief Initialises a UHCI host controller
193 * \param Host Pointer - Host to initialise
195 int UHCI_Int_InitHost(tUHCI_Controller *Host)
197 ENTER("pHost", Host);
199 outw( Host->IOBase + USBCMD, 4 ); // GRESET
201 // TODO: Wait for at least 10ms
202 outw( Host->IOBase + USBCMD, 0 ); // GRESET
204 // Allocate Frame List
205 // - 1 Page, 32-bit address
206 // - 1 page = 1024 4 byte entries
207 Host->FrameList = (void *) MM_AllocDMA(1, 32, &Host->PhysFrameList);
208 if( !Host->FrameList ) {
209 Log_Warning("UHCI", "Unable to allocate frame list, aborting");
213 LOG("Allocated frame list 0x%x (0x%x)", Host->FrameList, Host->PhysFrameList);
214 memsetd( Host->FrameList, 1, 1024 ); // Clear List (Disabling all entries)
216 //! \todo Properly fill frame list
218 // Set frame length to 1 ms
219 outb( Host->IOBase + SOFMOD, 64 );
222 outd( Host->IOBase + FLBASEADD, Host->PhysFrameList );
223 outw( Host->IOBase + FRNUM, 0 );
226 outw( Host->IOBase + USBINTR, 0x000F );
227 PCI_ConfigWrite( Host->PciId, 0xC0, 2, 0x2000 );
229 outw( Host->IOBase + USBCMD, 0x0001 );
235 void UHCI_CheckPortUpdate(tUHCI_Controller *Host)
238 for( int i = 0; i < 2; i ++ )
240 int port = Host->IOBase + PORTSC1 + i*2;
241 // Check for port change
242 if( !(inw(port) & 0x0002) ) continue;
245 // Check if the port is connected
246 if( !(inw(port) & 1) )
248 // Tell the USB code it's gone.
249 USB_DeviceDisconnected(Host->RootHub, i);
254 LOG("Port %i has something", i);
255 // Reset port (set bit 9)
257 outw( port, 0x0100 );
258 Time_Delay(50); // 50ms delay
259 outw( port, inw(port) & ~0x0100 );
262 Time_Delay(50); // 50ms delay
263 outw( port, inw(port) & 0x0004 );
264 // Tell USB there's a new device
265 USB_DeviceConnected(Host->RootHub, i);
270 void UHCI_InterruptHandler(int IRQ, void *Ptr)
272 Log_Debug("UHCI", "UHIC Interrupt");