More documentation, mostly to the PCI

[tpg/acess2.git] / Kernel / include / drv_pci.h

diff --git a/Kernel/include/drv_pci.h b/Kernel/include/drv_pci.h
index b539430..d3eb8a2 100644 (file)
--- a/Kernel/include/drv_pci.h
+++ b/Kernel/include/drv_pci.h
@@ -1,12 +1,16 @@
-/*\r
- * Acess 2\r
- * PCI Bus Driver\r
- * drv_pci.h\r
+/**\r
+ * \file drv_pci.h\r
+ * \brief PCI Bus Driver\r
+ * \author John Hodge (thePowersGang)\r
  */\r
 #ifndef _DRV_PCI_H\r
 #define _DRV_PCI_H\r
 \r
-enum e_PciClasses {\r
+/**\r
+ * \brief PCI Class Codes\r
+ */\r
+enum ePCIClasses\r
+{\r
        PCI_CLASS_PRE20 = 0x00,\r
        PCI_CLASS_STORAGE,\r
        PCI_CLASS_NETWORK,\r
@@ -22,13 +26,20 @@ enum e_PciClasses {
        PCI_CLASS_SERIALBUS,\r
        PCI_CLASS_MISC = 0xFF\r
 };\r
-enum e_PciOverClasses {\r
+\r
+enum ePCIOverClasses\r
+{\r
        PCI_OC_PCIBRIDGE = 0x0604,\r
        PCI_OC_SCSI = 0x0100\r
 };\r
 \r
-\r
+/**\r
+ * \brief Count PCI Devices\r
+ * \r
+ * Counts the number of devices with specified Vendor and Device IDs\r
+ */\r
 extern int     PCI_CountDevices(Uint16 vendor, Uint16 device, Uint16 fcn);\r
+\r
 extern int     PCI_GetDevice(Uint16 vendor, Uint16 device, Uint16 fcn, int idx);\r
 extern int     PCI_GetDeviceByClass(Uint16 class, Uint16 mask, int prev);\r
 extern Uint8   PCI_GetIRQ(int id);\r