TODO
[tpg/acess2.git] / KernelLand / Kernel / drv / pci.c
1 /*\r
2  * AcessOS/AcessBasic v0.1\r
3  * PCI Bus Driver\r
4  */\r
5 #define DEBUG   0\r
6 #include <acess.h>\r
7 #include <modules.h>\r
8 #include <vfs.h>\r
9 #include <fs_devfs.h>\r
10 #include <drv_pci.h>\r
11 #include <drv_pci_int.h>\r
12 \r
13 #define USE_PORT_BITMAP 0\r
14 #define LIST_DEVICES    1\r
15 \r
16 // === STRUCTURES ===\r
17 typedef struct sPCIDevice\r
18 {\r
19         Uint16  bus, slot, fcn;\r
20         Uint16  vendor, device;\r
21         Uint32  class;  // Class:Subclass:ProgIf\r
22         Uint8   revision;\r
23         Uint32  ConfigCache[256/4];\r
24         char    Name[8];\r
25         tVFS_Node       Node;\r
26 } tPCIDevice;\r
27 \r
28 // === CONSTANTS ===\r
29 #define SPACE_STEP      5\r
30 #define MAX_RESERVED_PORT       0xD00\r
31 \r
32 // === PROTOTYPES ===\r
33  int    PCI_Install(char **Arguments);\r
34  int    PCI_ScanBus(int ID, int bFill);\r
35  \r
36 char    *PCI_int_ReadDirRoot(tVFS_Node *node, int pos);\r
37 tVFS_Node       *PCI_int_FindDirRoot(tVFS_Node *node, const char *filename);\r
38 Uint32  PCI_int_GetBusAddr(Uint16 Bus, Uint16 Slot, Uint16 Fcn, Uint8 Offset);\r
39 size_t  PCI_int_ReadDevice(tVFS_Node *node, off_t Offset, size_t Length, void *buffer);\r
40  int    PCI_int_EnumDevice(Uint16 bus, Uint16 dev, Uint16 fcn, tPCIDevice *info);\r
41 \r
42 // === GLOBALS ===\r
43 MODULE_DEFINE(0, 0x0100, PCI, PCI_Install, NULL, NULL);\r
44  int    giPCI_BusCount = 1;\r
45  int    giPCI_InodeHandle = -1;\r
46  int    giPCI_DeviceCount = 0;\r
47 tPCIDevice      *gPCI_Devices = NULL;\r
48 tVFS_NodeType   gPCI_RootNodeType = {\r
49         .TypeName = "PCI Root Node",\r
50         .ReadDir = PCI_int_ReadDirRoot,\r
51         .FindDir = PCI_int_FindDirRoot\r
52 };\r
53 tVFS_NodeType   gPCI_DevNodeType = {\r
54         .TypeName = "PCI Dev Node",\r
55         .Read = PCI_int_ReadDevice\r
56 };\r
57 tDevFS_Driver   gPCI_DriverStruct = {\r
58         NULL, "pci",\r
59         {\r
60         .Flags = VFS_FFLAG_DIRECTORY,\r
61         .Size = -1,\r
62         .NumACLs = 1,\r
63         .ACLs = &gVFS_ACL_EveryoneRX,\r
64         .Type = &gPCI_RootNodeType\r
65         }\r
66 };\r
67 #if USE_PORT_BITMAP\r
68 Uint32  *gaPCI_PortBitmap = NULL;\r
69 #endif\r
70 Uint32  gaPCI_BusBitmap[256/32];\r
71  \r
72 // === CODE ===\r
73 /**\r
74  * \brief Scan the PCI Bus for devices\r
75  * \param Arguments     Boot-time parameters\r
76  */\r
77 int PCI_Install(char **Arguments)\r
78 {\r
79          int    ret, bus;\r
80         void    *tmpPtr;\r
81         \r
82         #if USE_PORT_BITMAP\r
83         // Build Portmap\r
84         gaPCI_PortBitmap = malloc( 1 << 13 );\r
85         if( !gaPCI_PortBitmap ) {\r
86                 Log_Error("PCI", "Unable to allocate %i bytes for bitmap", 1 << 13);\r
87                 return MODULE_ERR_MALLOC;\r
88         }\r
89         memset( gaPCI_PortBitmap, 0, 1 << 13 );\r
90          int    i;\r
91         for( i = 0; i < MAX_RESERVED_PORT / 32; i ++ )\r
92                 gaPCI_PortBitmap[i] = -1;\r
93         for( i = 0; i < MAX_RESERVED_PORT % 32; i ++ )\r
94                 gaPCI_PortBitmap[MAX_RESERVED_PORT / 32] = 1 << i;\r
95         #endif  \r
96 \r
97         // Scan Bus (Bus 0, Don't fill gPCI_Devices)\r
98         for( bus = 0; bus < giPCI_BusCount; bus ++ )\r
99         {\r
100                 ret = PCI_ScanBus(bus, 0);\r
101                 if(ret != MODULE_ERR_OK)        return ret;\r
102         }\r
103                 \r
104         if(giPCI_DeviceCount == 0) {\r
105                 Log_Notice("PCI", "No devices were found");\r
106                 return MODULE_ERR_NOTNEEDED;\r
107         }\r
108         \r
109         // Allocate device buffer\r
110         tmpPtr = malloc(giPCI_DeviceCount * sizeof(tPCIDevice));\r
111         if(tmpPtr == NULL) {\r
112                 Log_Warning("PCI", "Malloc ERROR");\r
113                 return MODULE_ERR_MALLOC;\r
114         }\r
115         gPCI_Devices = tmpPtr;\r
116         \r
117         Log_Log("PCI", "%i devices, filling structure", giPCI_DeviceCount);\r
118         \r
119         // Reset counts\r
120         giPCI_DeviceCount = 0;\r
121         giPCI_BusCount = 1;\r
122         memset(gaPCI_BusBitmap, 0, sizeof(gaPCI_BusBitmap));\r
123         // Rescan, filling the PCI device array\r
124         for( bus = 0; bus < giPCI_BusCount; bus ++ )\r
125         {\r
126                 PCI_ScanBus(bus, 1);\r
127         }\r
128         \r
129         // Complete Driver Structure\r
130         gPCI_DriverStruct.RootNode.Size = giPCI_DeviceCount;\r
131         \r
132         // And add to DevFS\r
133         DevFS_AddDevice(&gPCI_DriverStruct);\r
134         \r
135         return MODULE_ERR_OK;\r
136 }\r
137 \r
138 /**\r
139  * \brief Scans a specific PCI Bus\r
140  * \param BusID PCI Bus ID to scan\r
141  * \param bFill Fill the \a gPCI_Devices array?\r
142  */\r
143 int PCI_ScanBus(int BusID, int bFill)\r
144 {\r
145          int    dev, fcn;\r
146         tPCIDevice      devInfo;\r
147         \r
148         if( gaPCI_BusBitmap[BusID/32] & (1 << (BusID%32)) )\r
149                 return MODULE_ERR_OK;\r
150         \r
151         gaPCI_BusBitmap[BusID/32] |= (1 << (BusID%32));\r
152         \r
153         for( dev = 0; dev < 32; dev++ ) // 32 Devices per bus\r
154         {\r
155                 for( fcn = 0; fcn < 8; fcn++ )  // Max 8 functions per device\r
156                 {\r
157                         // Check if the device/function exists\r
158                         if(!PCI_int_EnumDevice(BusID, dev, fcn, &devInfo))\r
159                                 continue;\r
160                         \r
161                         if(devInfo.class == PCI_OC_PCIBRIDGE)\r
162                         {\r
163                                 #if LIST_DEVICES\r
164                                 if( !bFill )\r
165                                         Log_Log("PCI", "Bridge @ %i,%i:%i (0x%x:0x%x)",\r
166                                                 BusID, dev, fcn, devInfo.vendor, devInfo.device);\r
167                                 #endif\r
168                                 //TODO: Handle PCI-PCI Bridges\r
169                                 //PCI_ScanBus(devInfo.???, bFill);\r
170                                 giPCI_BusCount ++;\r
171                         }\r
172                         else\r
173                         {\r
174                                 #if LIST_DEVICES\r
175                                 if( !bFill )\r
176                                         Log_Log("PCI", "Device %i,%i:%i %06x => 0x%04x:0x%04x",\r
177                                                 BusID, dev, fcn, devInfo.class, devInfo.vendor, devInfo.device);\r
178                                 #endif\r
179                         }\r
180                         \r
181                         if( bFill ) {\r
182                                 devInfo.Node.Inode = giPCI_DeviceCount;\r
183                                 memcpy(&gPCI_Devices[giPCI_DeviceCount], &devInfo, sizeof(tPCIDevice));\r
184                         }\r
185                         giPCI_DeviceCount ++;\r
186                         \r
187                         // If bit 23 of (soemthing) is set, there are sub-functions\r
188                         if(fcn == 0 && !(devInfo.ConfigCache[3] & 0x00800000) )\r
189                                 break;\r
190                 }\r
191         }\r
192         \r
193         return MODULE_ERR_OK;\r
194 }\r
195 \r
196 /**\r
197  * \brief Read from Root of PCI Driver\r
198 */\r
199 char *PCI_int_ReadDirRoot(tVFS_Node *Node, int Pos)\r
200 {\r
201         ENTER("pNode iPos", Node, Pos);\r
202         if(Pos < 0 || Pos >= giPCI_DeviceCount) {\r
203                 LEAVE('n');\r
204                 return NULL;\r
205         }\r
206         \r
207         LEAVE('s', gPCI_Devices[Pos].Name);\r
208         return strdup( gPCI_Devices[Pos].Name );\r
209 }\r
210 /**\r
211  */\r
212 tVFS_Node *PCI_int_FindDirRoot(tVFS_Node *node, const char *filename)\r
213 {\r
214          int    bus,slot,fcn;\r
215          int    i;\r
216         // Validate Filename (Pointer and length)\r
217         if(!filename || strlen(filename) != 7)\r
218                 return NULL;\r
219         // Check for spacers\r
220         if(filename[2] != '.' || filename[5] != ':')\r
221                 return NULL;\r
222         \r
223         // Get Information\r
224         if(filename[0] < '0' || filename[0] > '9')      return NULL;\r
225         bus = (filename[0] - '0')*10;\r
226         if(filename[1] < '0' || filename[1] > '9')      return NULL;\r
227         bus += filename[1] - '0';\r
228         if(filename[3] < '0' || filename[3] > '9')      return NULL;\r
229         slot = (filename[3] - '0')*10;\r
230         if(filename[4] < '0' || filename[4] > '9')      return NULL;\r
231         slot += filename[4] - '0';\r
232         if(filename[6] < '0' || filename[6] > '9')      return NULL;\r
233         fcn = filename[6] - '0';\r
234         \r
235         // Find Match\r
236         for(i=0;i<giPCI_DeviceCount;i++)\r
237         {\r
238                 if(gPCI_Devices[i].bus != bus)          continue;\r
239                 if(gPCI_Devices[i].slot != slot)        continue;\r
240                 if(gPCI_Devices[i].fcn != fcn)  continue;\r
241                 \r
242                 return &gPCI_Devices[i].Node;\r
243         }\r
244         \r
245         // Error Return\r
246         return NULL;\r
247 }\r
248 \r
249 /**\r
250  * \brief Read the PCI configuration space of a device\r
251  */\r
252 size_t PCI_int_ReadDevice(tVFS_Node *node, off_t pos, size_t length, void *buffer)\r
253 {       \r
254         if( pos + length > 256 )        return 0;\r
255         \r
256         memcpy(\r
257                 buffer,\r
258                 (char*)gPCI_Devices[node->Inode].ConfigCache + pos,\r
259                 length);\r
260         \r
261         return length;\r
262 }\r
263 \r
264 // --- Kernel Code Interface ---\r
265 /**\r
266  * \brief Counts the devices with the specified codes\r
267  * \param vendor        Vendor ID\r
268  * \param device        Device ID\r
269  */\r
270 int PCI_CountDevices(Uint16 vendor, Uint16 device)\r
271 {\r
272         int i, ret=0;\r
273         for(i=0;i<giPCI_DeviceCount;i++)\r
274         {\r
275                 if(gPCI_Devices[i].vendor != vendor)    continue;\r
276                 if(gPCI_Devices[i].device != device)    continue;\r
277                 ret ++;\r
278         }\r
279         return ret;\r
280 }\r
281 \r
282 /**\r
283  * \brief Gets the ID of the specified PCI device\r
284  * \param vendor        Vendor ID\r
285  * \param device        Device ID\r
286  * \param idx   Number of matching entry wanted\r
287  */\r
288 tPCIDev PCI_GetDevice(Uint16 vendor, Uint16 device, int idx)\r
289 {\r
290          int    i, j=0;\r
291         for( i = 0; i < giPCI_DeviceCount; i ++ )\r
292         {\r
293                 if(gPCI_Devices[i].vendor != vendor)    continue;\r
294                 if(gPCI_Devices[i].device != device)    continue;\r
295                 if(j == idx)    return i;\r
296                 j ++;\r
297         }\r
298         return -1;\r
299 }\r
300 \r
301 /**\r
302  * \brief Gets the ID of a device by it's class code\r
303  * \param class Class Code\r
304  * \param mask  Mask for class comparison\r
305  * \param prev  ID of previous device (-1 for no previous)\r
306  */\r
307 tPCIDev PCI_GetDeviceByClass(Uint32 class, Uint32 mask, tPCIDev prev)\r
308 {\r
309          int    i;\r
310         // Check if prev is negative (meaning get first)\r
311         if(prev < 0)    i = 0;\r
312         else    i = prev+1;\r
313         \r
314         for( ; i < giPCI_DeviceCount; i++ )\r
315         {\r
316                 if((gPCI_Devices[i].class & mask) == class)\r
317                         return i;\r
318         }\r
319         return -1;\r
320 }\r
321 \r
322 int PCI_GetDeviceInfo(tPCIDev ID, Uint16 *Vendor, Uint16 *Device, Uint32 *Class)\r
323 {\r
324         tPCIDevice      *dev = &gPCI_Devices[ID];\r
325         if(ID < 0 || ID >= giPCI_DeviceCount)   return 1;\r
326         \r
327         if(Vendor)      *Vendor = dev->vendor;\r
328         if(Device)      *Device = dev->device;\r
329         if(Class)       *Class = dev->class;\r
330         return 0;\r
331 }\r
332 \r
333 int PCI_GetDeviceVersion(tPCIDev ID, Uint8 *Revision)\r
334 {\r
335         tPCIDevice      *dev = &gPCI_Devices[ID];\r
336         if(ID < 0 || ID >= giPCI_DeviceCount)   return 1;\r
337         \r
338         if(Revision)    *Revision = dev->revision;\r
339         return 0;\r
340 }\r
341 \r
342 int PCI_GetDeviceSubsys(tPCIDev ID, Uint16 *SubsystemVendor, Uint16 *SubsystemID)\r
343 {\r
344         tPCIDevice      *dev = &gPCI_Devices[ID];\r
345         if(ID < 0 || ID >= giPCI_DeviceCount)   return 1;\r
346         \r
347         if(SubsystemVendor)     *SubsystemVendor = dev->ConfigCache[0x2c/4] & 0xFFFF;\r
348         if(SubsystemID) *SubsystemID = dev->ConfigCache[0x2c/4] >> 16;\r
349 \r
350         return 0;\r
351 }\r
352 \r
353 Uint32 PCI_int_GetBusAddr(Uint16 Bus, Uint16 Slot, Uint16 Fcn, Uint8 Offset)\r
354 {\r
355         Bus &= 0xFF;\r
356         Slot &= 0x1F;\r
357         Fcn &= 7;\r
358         Offset &= 0xFC;\r
359         return ((Uint32)Bus << 16) | (Slot << 11) | (Fcn << 8) | (Offset & 0xFC);\r
360 }\r
361 \r
362 Uint32 PCI_ConfigRead(tPCIDev ID, int Offset, int Size)\r
363 {\r
364         tPCIDevice      *dev;\r
365         Uint32  dword, addr;\r
366         \r
367         if( ID < 0 || ID >= giPCI_DeviceCount ) return 0;\r
368         if( Offset < 0 || Offset > 256 )        return 0;\r
369 \r
370         // TODO: Should I support non-aligned reads?\r
371         if( Offset & (Size - 1) )       return 0;\r
372 \r
373         dev = &gPCI_Devices[ID];\r
374         addr = PCI_int_GetBusAddr(dev->bus, dev->slot, dev->fcn, Offset);\r
375 \r
376         dword = PCI_CfgReadDWord(addr);\r
377         gPCI_Devices[ID].ConfigCache[Offset/4] = dword;\r
378         switch( Size )\r
379         {\r
380         case 1: return (dword >> (8 * (Offset&3))) & 0xFF;\r
381         case 2: return (dword >> (8 * (Offset&2))) & 0xFFFF;\r
382         case 4: return dword;\r
383         default:\r
384                 return 0;\r
385         }\r
386 }\r
387 \r
388 void PCI_ConfigWrite(tPCIDev ID, int Offset, int Size, Uint32 Value)\r
389 {\r
390         tPCIDevice      *dev;\r
391         Uint32  dword, addr;\r
392          int    shift;\r
393         if( ID < 0 || ID >= giPCI_DeviceCount ) return ;\r
394         if( Offset < 0 || Offset > 256 )        return ;\r
395         \r
396         dev = &gPCI_Devices[ID];\r
397         addr = PCI_int_GetBusAddr(dev->bus, dev->slot, dev->fcn, Offset);\r
398 \r
399         if(Size != 4)\r
400                 dword = PCI_CfgReadDWord(addr);\r
401         switch(Size)\r
402         {\r
403         case 1:\r
404                 shift = (Offset&3)*8;\r
405                 dword &= ~(0xFF << shift);\r
406                 dword |= Value << shift;\r
407                 break;\r
408         case 2:\r
409                 shift = (Offset&2)*8;\r
410                 dword &= ~(0xFFFF << shift);\r
411                 dword |= Value << shift;\r
412                 break;\r
413         case 4:\r
414                 dword = Value;\r
415                 break;\r
416         default:\r
417                 return;\r
418         }\r
419         PCI_CfgWriteDWord(addr, dword);\r
420 }\r
421 \r
422 /**\r
423  * \brief Get the IRQ assigned to a device\r
424  */\r
425 Uint8 PCI_GetIRQ(tPCIDev id)\r
426 {\r
427         if(id < 0 || id >= giPCI_DeviceCount)\r
428                 return 0;\r
429         return gPCI_Devices[id].ConfigCache[15] & 0xFF;\r
430         //return PCI_CfgReadByte( gPCI_Devices[id].bus, gPCI_Devices[id].slot, gPCI_Devices[id].fcn, 0x3C);\r
431 }\r
432 \r
433 /**\r
434  * \brief Read the a BAR (base address register) from the PCI config space\r
435  */\r
436 Uint32 PCI_GetBAR(tPCIDev id, int BARNum)\r
437 {\r
438         if(id < 0 || id >= giPCI_DeviceCount)\r
439                 return 0;\r
440         if(BARNum < 0 || BARNum >= 6)\r
441                 return 0;\r
442         return gPCI_Devices[id].ConfigCache[4+BARNum];\r
443 }\r
444 \r
445 /**\r
446  * \brief Get device information for a slot/function\r
447  */\r
448 int PCI_int_EnumDevice(Uint16 bus, Uint16 slot, Uint16 fcn, tPCIDevice *info)\r
449 {\r
450         Uint32  vendor_dev, tmp;\r
451          int    i;\r
452         Uint32  addr;\r
453         addr = PCI_int_GetBusAddr(bus, slot, fcn, 0);   \r
454 \r
455         vendor_dev = PCI_CfgReadDWord( addr );\r
456         if((vendor_dev & 0xFFFF) == 0xFFFF)     // Invalid Device\r
457                 return 0;\r
458 \r
459         info->ConfigCache[0] = vendor_dev;\r
460         for( i = 1, addr += 4; i < 256/4; i ++, addr += 4 )\r
461         {\r
462                 info->ConfigCache[i] = PCI_CfgReadDWord(addr);\r
463         }       \r
464 \r
465         info->bus = bus;\r
466         info->slot = slot;\r
467         info->fcn = fcn;\r
468         info->vendor = vendor_dev & 0xFFFF;\r
469         info->device = vendor_dev >> 16;\r
470         tmp = info->ConfigCache[2];\r
471         info->revision = tmp & 0xFF;\r
472         info->class = tmp >> 8;\r
473         \r
474 //      #if LIST_DEVICES\r
475 //      Log("BAR0 0x%08x BAR1 0x%08x BAR2 0x%08x", info->ConfigCache[4], info->ConfigCache[5], info->ConfigCache[6]);\r
476 //      Log("BAR3 0x%08x BAR4 0x%08x BAR5 0x%08x", info->ConfigCache[7], info->ConfigCache[8], info->ConfigCache[9]);\r
477 //      Log("Class: 0x%06x", info->class);\r
478 //      #endif\r
479         \r
480         // Make node name\r
481         info->Name[0] = '0' + bus/10;\r
482         info->Name[1] = '0' + bus%10;\r
483         info->Name[2] = '.';\r
484         info->Name[3] = '0' + slot/10;\r
485         info->Name[4] = '0' + slot%10;\r
486         info->Name[5] = ':';\r
487         info->Name[6] = '0' + fcn;\r
488         info->Name[7] = '\0';\r
489         \r
490         // Create VFS Node\r
491         memset( &info->Node, 0, sizeof(tVFS_Node) );\r
492         info->Node.Size = 256;\r
493         \r
494         info->Node.NumACLs = 1;\r
495         info->Node.ACLs = &gVFS_ACL_EveryoneRO;\r
496         \r
497         info->Node.Type = &gPCI_RootNodeType;\r
498         \r
499         return 1;\r
500 }\r
501 \r
502 // === EXPORTS ===\r
503 //*\r
504 EXPORT(PCI_CountDevices);\r
505 EXPORT(PCI_GetDevice);\r
506 EXPORT(PCI_GetDeviceByClass);\r
507 EXPORT(PCI_GetDeviceInfo);\r
508 EXPORT(PCI_GetDeviceVersion);\r
509 EXPORT(PCI_GetDeviceSubsys);\r
510 //EXPORT(PCI_AssignPort);\r
511 EXPORT(PCI_GetBAR);\r
512 EXPORT(PCI_GetIRQ);\r
513 //*/\r

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