b348a45f64cf6f8ff4c138bec74f52ae15aea918
[tpg/acess2.git] / KernelLand / Modules / USB / UHCI / uhci.c
1 /*
2  * Acess 2 USB Stack
3  * - By John Hodge (thePowersGang)
4  *
5  * Universal Host Controller Interface
6  */
7 #define DEBUG   0
8 #define VERSION VER2(0,5)
9 #include <acess.h>
10 #include <vfs.h>
11 #include <drv_pci.h>
12 #include <modules.h>
13 #include <usb_host.h>
14 #include "uhci.h"
15 #include <timers.h>
16
17 // === CONSTANTS ===
18 #define MAX_CONTROLLERS 4
19 #define NUM_TDs 1024
20
21 // === PROTOTYPES ===
22  int    UHCI_Initialise(char **Arguments);
23 void    UHCI_Cleanup();
24 tUHCI_TD        *UHCI_int_AllocateTD(tUHCI_Controller *Cont);
25 tUHCI_TD        *UHCI_int_GetTDFromPhys(tPAddr PAddr);
26 void    UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD);
27 void    *UHCI_int_SendTransaction(tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
28 void    *UHCI_DataIN(void *Ptr, int Dest, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
29 void    *UHCI_DataOUT(void *Ptr, int Dest, int DataTgl, tUSBHostCb Cb, void *CbData,  void *Buf, size_t Length);
30 void    *UHCI_SendSetup(void *Ptr, int Dest, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length);
31  int    UHCI_IsTransferComplete(void *Ptr, void *Handle);
32  int    UHCI_Int_InitHost(tUHCI_Controller *Host);
33 void    UHCI_CheckPortUpdate(void *Ptr);
34 void    UHCI_InterruptHandler(int IRQ, void *Ptr);
35 // 
36 static void     _OutByte(tUHCI_Controller *Host, int Reg, Uint8 Value);
37 static void     _OutWord(tUHCI_Controller *Host, int Reg, Uint16 Value);
38 static void     _OutDWord(tUHCI_Controller *Host, int Reg, Uint32 Value);
39 static Uint16   _InWord(tUHCI_Controller *Host, int Reg);
40
41 // === GLOBALS ===
42 MODULE_DEFINE(0, VERSION, USB_UHCI, UHCI_Initialise, NULL, "USB_Core", NULL);
43 tUHCI_TD        gaUHCI_TDPool[NUM_TDs];
44 tUHCI_Controller        gUHCI_Controllers[MAX_CONTROLLERS];
45 tUSBHostDef     gUHCI_HostDef = {
46         .SendIN = UHCI_DataIN,
47         .SendOUT = UHCI_DataOUT,
48         .SendSETUP = UHCI_SendSetup,
49         .IsOpComplete = UHCI_IsTransferComplete,
50         .CheckPorts = UHCI_CheckPortUpdate
51         };
52
53 // === CODE ===
54 /**
55  * \fn int UHCI_Initialise()
56  * \brief Called to initialise the UHCI Driver
57  */
58 int UHCI_Initialise(char **Arguments)
59 {
60          int    i=0, id=-1;
61          int    ret;
62         
63         ENTER("");
64         
65         // Enumerate PCI Bus, getting a maximum of `MAX_CONTROLLERS` devices
66         while( (id = PCI_GetDeviceByClass(0x0C0300, 0xFFFFFF, id)) >= 0 && i < MAX_CONTROLLERS )
67         {
68                 tUHCI_Controller        *cinfo = &gUHCI_Controllers[i];
69                 Uint32  base_addr;
70                 // NOTE: Check "protocol" from PCI?
71                 
72                 cinfo->PciId = id;
73                 base_addr = PCI_GetBAR(id, 4);
74                 
75                 if( base_addr & 1 )
76                 {
77                         cinfo->IOBase = base_addr & ~1;
78                         cinfo->MemIOMap = NULL;
79                 }
80                 else
81                 {
82                         cinfo->MemIOMap = (void*)MM_MapHWPages(base_addr, 1);
83                 }
84                 cinfo->IRQNum = PCI_GetIRQ(id);
85                 
86                 Log_Debug("UHCI", "Controller PCI #%i: IO Base = 0x%x, IRQ %i",
87                         id, base_addr, cinfo->IRQNum);
88                 
89                 IRQ_AddHandler(cinfo->IRQNum, UHCI_InterruptHandler, cinfo);
90         
91                 // Initialise Host
92                 ret = UHCI_Int_InitHost(&gUHCI_Controllers[i]);
93                 // Detect an error
94                 if(ret != 0) {
95                         LEAVE('i', ret);
96                         return ret;
97                 }
98                 
99                 cinfo->RootHub = USB_RegisterHost(&gUHCI_HostDef, cinfo, 2);
100                 LOG("cinfo->RootHub = %p", cinfo->RootHub);
101
102                 i ++;
103         }
104
105         if(i == 0) {
106                 LEAVE('i', MODULE_ERR_NOTNEEDED);
107                 return MODULE_ERR_NOTNEEDED;
108         }
109
110         if(i == MAX_CONTROLLERS) {
111                 Log_Warning("UHCI", "Over "EXPAND_STR(MAX_CONTROLLERS)" UHCI controllers detected, ignoring rest");
112         }
113         LEAVE('i', MODULE_ERR_OK);
114         return MODULE_ERR_OK;
115 }
116
117 /**
118  * \fn void UHCI_Cleanup()
119  * \brief Called just before module is unloaded
120  */
121 void UHCI_Cleanup()
122 {
123 }
124
125 tUHCI_TD *UHCI_int_AllocateTD(tUHCI_Controller *Cont)
126 {
127          int    i;
128         for(i = 0; i < NUM_TDs; i ++)
129         {
130                 if(gaUHCI_TDPool[i].Link == 0) {
131                         gaUHCI_TDPool[i].Link = 1;
132                         gaUHCI_TDPool[i].Control = 1 << 23;
133                         return &gaUHCI_TDPool[i];
134                 }
135                 // Still in use? Skip
136                 if( gaUHCI_TDPool[i].Control & (1 << 23) )
137                         continue ;
138                 // Is there a callback on it? Skip
139                 if( gaUHCI_TDPool[i]._info.Callback )
140                         continue ;
141                 // TODO: Garbage collect, but that means removing from the list too
142                 #if 0
143                 // Ok, this is actually unused
144                 gaUHCI_TDPool[i].Link = 1;
145                 gaUHCI_TDPool[i].Control = 1 << 23;
146                 return &gaUHCI_TDPool[i];
147                 #endif
148         }
149         return NULL;
150 }
151
152 tUHCI_TD *UHCI_int_GetTDFromPhys(tPAddr PAddr)
153 {
154         // TODO: Fix this to work with a non-contiguous pool
155         static tPAddr   td_pool_base;
156         const int pool_size = NUM_TDs;
157          int    offset;
158         if(!td_pool_base)       td_pool_base = MM_GetPhysAddr( (tVAddr)gaUHCI_TDPool );
159         offset = (PAddr - td_pool_base) / sizeof(gaUHCI_TDPool[0]);
160         if( offset < 0 || offset >= pool_size )
161         {
162                 Log_Error("UHCI", "TD PAddr %P not from pool", PAddr);
163                 return NULL;
164         }
165         return gaUHCI_TDPool + offset;
166 }
167
168 void UHCI_int_AppendTD(tUHCI_Controller *Cont, tUHCI_TD *TD)
169 {
170          int    next_frame;
171         tUHCI_TD        *prev_td;
172         Uint32  link;
173
174         ENTER("pCont pTD", Cont, TD);
175
176         // TODO: How to handle FRNUM incrementing while we are in this function?
177         next_frame = (_InWord(Cont, FRNUM) + 2) & (1024-1);
178         
179         // Empty list
180         if( Cont->FrameList[next_frame] & 1 )
181         {
182                 // TODO: Ensure 32-bit paddr
183                 Cont->FrameList[next_frame] = MM_GetPhysAddr( (tVAddr)TD );
184                 TD->Control |= (1 << 24);       // Ensure that there is an interrupt for each used frame
185                 LOG("next_frame = %i", next_frame);
186                 LEAVE('-');
187                 return;
188         }
189
190         // Find the end of the list
191         link = Cont->FrameList[next_frame];
192         do {
193                 prev_td = UHCI_int_GetTDFromPhys(link);
194                 if(!prev_td) {
195                         Log_Error("UHCI", "ERROR: TD list is bad");
196                         TD->Link = 1;
197                         LEAVE('-');
198                         return ;
199                 }
200                 link = prev_td->Link;
201         } while( !(link & 1) );
202         
203         // Append
204         prev_td->Link = MM_GetPhysAddr( (tVAddr)TD );
205
206         LOG("next_frame = %i, prev_td = %p", next_frame, prev_td);
207         LEAVE('-');
208 }
209
210 /**
211  * \brief Send a transaction to the USB bus
212  * \param Cont  Controller pointer
213  * \param Addr  Function Address * 16 + Endpoint
214  * \param bTgl  Data toggle value
215  */
216 void *UHCI_int_SendTransaction(
217         tUHCI_Controller *Cont, int Addr, Uint8 Type, int bTgl,
218         tUSBHostCb Cb, void *CbData, void *Data, size_t Length)
219 {
220         tUHCI_TD        *td;
221
222         if( Length > 0x400 )    return NULL;    // Controller allows up to 0x500, but USB doesn't
223
224         td = UHCI_int_AllocateTD(Cont);
225
226         if( !td ) {
227                 // TODO: Wait for one to free?
228                 Log_Error("UHCI", "No avaliable TDs, transaction dropped");
229                 return NULL;
230         }
231
232         td->Link = 1;
233         td->Control = (Length - 1) & 0x7FF;
234         td->Control |= (1 << 23);
235         td->Token  = ((Length - 1) & 0x7FF) << 21;
236         td->Token |= (bTgl & 1) << 19;
237         td->Token |= (Addr & 0xF) << 15;
238         td->Token |= ((Addr/16) & 0xFF) << 8;
239         td->Token |= Type;
240
241         // TODO: Ensure 32-bit paddr
242         if( ((tVAddr)Data & (PAGE_SIZE-1)) + Length > PAGE_SIZE ) {
243                 Log_Warning("UHCI", "TODO: Support non single page transfers (%x + %x > %x)",
244                         (tVAddr)Data & (PAGE_SIZE-1), Length, PAGE_SIZE
245                         );
246                 // TODO: Need to enable IOC to copy the data back
247 //              td->BufferPointer = 
248                 td->_info.bCopyData = 1;
249                 return NULL;
250         }
251         else {
252                 td->BufferPointer = MM_GetPhysAddr( (tVAddr)Data );
253                 td->_info.bCopyData = 0;
254         }
255
256         // Interrupt on completion
257         if( Cb ) {
258                 td->Control |= (1 << 24);
259                 LOG("IOC Cb=%p CbData=%p", Cb, CbData);
260                 td->_info.Callback = Cb;        // NOTE: if ERRPTR then the TD is kept allocated until checked
261                 td->_info.CallbackPtr = CbData;
262         }
263         
264         td->_info.DataPtr = Data;
265
266         UHCI_int_AppendTD(Cont, td);
267
268         return td;
269 }
270
271 void *UHCI_DataIN(void *Ptr, int Dest, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
272 {
273         return UHCI_int_SendTransaction(Ptr, Dest, 0x69, DataTgl, Cb, CbData, Buf, Length);
274 }
275
276 void *UHCI_DataOUT(void *Ptr, int Dest, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
277 {
278         return UHCI_int_SendTransaction(Ptr, Dest, 0xE1, DataTgl, Cb, CbData, Buf, Length);
279 }
280
281 void *UHCI_SendSetup(void *Ptr, int Dest, int DataTgl, tUSBHostCb Cb, void *CbData, void *Buf, size_t Length)
282 {
283         return UHCI_int_SendTransaction(Ptr, Dest, 0x2D, DataTgl, Cb, CbData, Buf, Length);
284 }
285
286 int UHCI_IsTransferComplete(void *Ptr, void *Handle)
287 {
288         tUHCI_TD        *td = Handle;
289          int    ret;
290         ret = !(td->Control & (1 << 23));
291         if(ret) {
292                 td->_info.Callback = NULL;
293                 td->Link = 0;
294         }
295         return ret;
296 }
297
298 // === INTERNAL FUNCTIONS ===
299 /**
300  * \fn int UHCI_Int_InitHost(tUCHI_Controller *Host)
301  * \brief Initialises a UHCI host controller
302  * \param Host  Pointer - Host to initialise
303  */
304 int UHCI_Int_InitHost(tUHCI_Controller *Host)
305 {
306         ENTER("pHost", Host);
307
308         _OutWord( Host, USBCMD, 4 );    // GRESET
309         // TODO: Wait for at least 10ms
310         _OutWord( Host, USBCMD, 0 );    // GRESET
311         
312         // Allocate Frame List
313         // - 1 Page, 32-bit address
314         // - 1 page = 1024  4 byte entries
315         Host->FrameList = (void *) MM_AllocDMA(1, 32, &Host->PhysFrameList);
316         if( !Host->FrameList ) {
317                 Log_Warning("UHCI", "Unable to allocate frame list, aborting");
318                 LEAVE('i', -1);
319                 return -1;
320         }
321         LOG("Allocated frame list 0x%x (0x%x)", Host->FrameList, Host->PhysFrameList);
322         for( int i = 0; i < 1024; i ++ )
323                 Host->FrameList[i] = 1; // Clear List (Disabling all entries)
324         
325         //! \todo Properly fill frame list
326         
327         // Set frame length to 1 ms
328         _OutByte( Host, SOFMOD, 64 );
329         
330         // Set Frame List
331         _OutDWord( Host, FLBASEADD, Host->PhysFrameList );
332         _OutWord( Host, FRNUM, 0 );
333         
334         // Enable Interrupts
335         _OutWord( Host, USBINTR, 0x000F );
336         PCI_ConfigWrite( Host->PciId, 0xC0, 2, 0x2000 );
337
338         // Enable processing
339         _OutWord( Host, USBCMD, 0x0001 );
340
341         LEAVE('i', 0);
342         return 0;
343 }
344
345 void UHCI_CheckPortUpdate(void *Ptr)
346 {
347         tUHCI_Controller        *Host = Ptr;
348         // Enable ports
349         for( int i = 0; i < 2; i ++ )
350         {
351                  int    port = PORTSC1 + i*2;
352                 Uint16  status;
353         
354                 status = _InWord(Host, port);
355                 // Check for port change
356                 if( !(status & 0x0002) )        continue;
357                 _OutWord(Host, port, 0x0002);
358                 
359                 // Check if the port is connected
360                 if( !(status & 1) )
361                 {
362                         // Tell the USB code it's gone.
363                         USB_DeviceDisconnected(Host->RootHub, i);
364                         continue;
365                 }
366                 else
367                 {
368                         LOG("Port %i has something", i);
369                         // Reset port (set bit 9)
370                         LOG("Reset");
371                         _OutWord(Host, port, 0x0200);
372                         Time_Delay(50); // 50ms delay
373                         _OutWord(Host, port, _InWord(Host, port) & ~0x0200);
374                         // Enable port
375                         LOG("Enable");
376                         Time_Delay(50); // 50ms delay
377                         _OutWord(Host, port, _InWord(Host, port) | 0x0004);
378                         // Tell USB there's a new device
379                         USB_DeviceConnected(Host->RootHub, i);
380                 }
381         }
382 }
383
384 void UHCI_InterruptHandler(int IRQ, void *Ptr)
385 {
386         tUHCI_Controller *Host = Ptr;
387          int    frame = (_InWord(Host, FRNUM) - 1) & 0x3FF;
388         Uint16  status = _InWord(Host, USBSTS);
389 //      Log_Debug("UHCI", "UHIC Interrupt, status = 0x%x, frame = %i", status, frame);
390         
391         // Interrupt-on-completion
392         if( status & 1 )
393         {
394                 tPAddr  link;
395                 
396                 for( int i = 0; i < 10; i ++ )
397                 {
398                         link = Host->FrameList[frame];
399                         Host->FrameList[frame] = 1;
400                         while( link && !(link & 1) )
401                         {
402                                 tUHCI_TD *td = UHCI_int_GetTDFromPhys(link);
403                                  int    byte_count = (td->Control&0x7FF)+1;
404                                 LOG("link = 0x%x, td = %p, byte_count = %i", link, td, byte_count);
405                                 // Handle non-page aligned destination
406                                 // TODO: This will break if the destination is not in global memory
407                                 if(td->_info.bCopyData)
408                                 {
409                                         void *ptr = (void*)MM_MapTemp(td->BufferPointer);
410                                         Log_Debug("UHCI", "td->_info.DataPtr = %p", td->_info.DataPtr);
411                                         memcpy(td->_info.DataPtr, ptr, byte_count);
412                                         MM_FreeTemp((tVAddr)ptr);
413                                 }
414                                 // Callback
415                                 if(td->_info.Callback && td->_info.Callback != INVLPTR)
416                                 {
417                                         LOG("Calling cb %p", td->_info.Callback);
418                                         td->_info.Callback(td->_info.CallbackPtr, td->_info.DataPtr, byte_count);
419                                         td->_info.Callback = NULL;
420                                 }
421                                 link = td->Link;
422                                 if( td->_info.Callback != INVLPTR )
423                                         td->Link = 0;
424                         }
425                         
426                         if(frame == 0)
427                                 frame = 0x3ff;
428                         else
429                                 frame --;
430                 }
431                 
432 //              Host->LastCleanedFrame = frame;
433         }
434
435         LOG("status = 0x%02x", status);
436         _OutWord(Host, USBSTS, status);
437 }
438
439 void _OutByte(tUHCI_Controller *Host, int Reg, Uint8 Value)
440 {
441         if( Host->MemIOMap )
442                 ((Uint8*)Host->MemIOMap)[Reg] = Value;
443         else
444                 outb(Host->IOBase + Reg, Value);
445 }
446
447 void _OutWord(tUHCI_Controller *Host, int Reg, Uint16 Value)
448 {
449         if( Host->MemIOMap )
450                 Host->MemIOMap[Reg/2] = Value;
451         else
452                 outw(Host->IOBase + Reg, Value);
453 }
454
455 void _OutDWord(tUHCI_Controller *Host, int Reg, Uint32 Value)
456 {
457         if( Host->MemIOMap )
458                 ((Uint32*)Host->MemIOMap)[Reg/4] = Value;
459         else
460                 outd(Host->IOBase + Reg, Value);
461 }
462
463 Uint16 _InWord(tUHCI_Controller *Host, int Reg)
464 {
465         if( Host->MemIOMap )
466                 return Host->MemIOMap[Reg/2];
467         else
468                 return inw(Host->IOBase + Reg);
469 }
470

UCC git Repository :: git.ucc.asn.au