add pci-pcie slides and resources

[lunaix-os.git] / lunaix-os / includes / hal / pci.h

diff --git a/lunaix-os/includes/hal/pci.h b/lunaix-os/includes/hal/pci.h
index bd203590100e8c48e8b473fbb47d7ecc295efc31..639a12c4de271febd0897b3aa3c7b18896268f58 100644 (file)
--- a/lunaix-os/includes/hal/pci.h
+++ b/lunaix-os/includes/hal/pci.h
@@ -15,7 +15,7 @@
 
 #define PCI_REG_VENDOR_DEV 0
 #define PCI_REG_STATUS_CMD 0x4
 
 #define PCI_REG_VENDOR_DEV 0
 #define PCI_REG_STATUS_CMD 0x4

-#define PCI_REG_BAR(offset) (0x10 + (offset)*4)
+#define PCI_REG_BAR(num) (0x10 + (num - 1) * 4)

 
 #define PCI_DEV_VENDOR(x) ((x)&0xffff)
 #define PCI_DEV_DEVID(x) ((x) >> 16)
 
 #define PCI_DEV_VENDOR(x) ((x)&0xffff)
 #define PCI_DEV_DEVID(x) ((x) >> 16)


@@ -23,9 +23,18 @@
 #define PCI_INTR_PIN(x) (((x)&0xff00) >> 8)
 #define PCI_DEV_CLASS(x) ((x) >> 8)
 #define PCI_DEV_REV(x) (((x)&0xff))
 #define PCI_INTR_PIN(x) (((x)&0xff00) >> 8)
 #define PCI_DEV_CLASS(x) ((x) >> 8)
 #define PCI_DEV_REV(x) (((x)&0xff))

-#define PCI_BUS_NUM(x) ((x >> 16) & 0xff)
-#define PCI_SLOT_NUM(x) ((x >> 11) & 0x1f)
-#define PCI_FUNCT_NUM(x) ((x >> 8) & 0x7)
+#define PCI_BUS_NUM(x) (((x) >> 16) & 0xff)
+#define PCI_SLOT_NUM(x) (((x) >> 11) & 0x1f)
+#define PCI_FUNCT_NUM(x) (((x) >> 8) & 0x7)
+
+#define PCI_BAR_MMIO(x) (!((x)&0x1))
+#define PCI_BAR_CACHEABLE(x) ((x)&0x8)
+#define PCI_BAR_TYPE(x) ((x)&0x6)
+#define PCI_BAR_ADDR_MM(x) ((x) & ~0xf)
+#define PCI_BAR_ADDR_IO(x) ((x) & ~0x3)
+
+#define PCI_MSI_ADDR(msi_base) ((msi_base) + 4)
+#define PCI_MSI_DATA(msi_base) ((msi_base) + 8)

 
 #define PCI_ADDRESS(bus, dev, funct)                                           \
     (((bus)&0xff) << 16) | (((dev)&0xff) << 11) | (((funct)&0xff) << 8) |      \
 
 #define PCI_ADDRESS(bus, dev, funct)                                           \
     (((bus)&0xff) << 16) | (((dev)&0xff) << 11) | (((funct)&0xff) << 8) |      \


@@ -63,18 +72,57 @@ pci_write_cspace(uint32_t base, int offset, pci_reg_t data)
     io_outl(PCI_CONFIG_DATA, data);
 }
 
     io_outl(PCI_CONFIG_DATA, data);
 }
 

-void
-pci_probe();
-
+/**
+ * @brief 初始化PCI。这主要是通过扫描PCI总线进行拓扑重建。注意，该
+ * 初始化不包括针对每个设备的初始化，因为那是设备驱动的事情。
+ *
+ */

 void
 pci_init();
 
 void
 pci_print_device();
 
 void
 pci_init();
 
 void
 pci_print_device();
 

+/**
+ * @brief 根据类型代码（Class Code）去在拓扑中寻找一个设备
+ * 类型代码请参阅： PCI LB Spec. Appendix D.
+ *
+ * @return struct pci_device*
+ */

 struct pci_device* pci_get_device_by_class(uint32_t class);
 
 struct pci_device* pci_get_device_by_class(uint32_t class);
 

+/**
+ * @brief 根据设备商ID和设备ID，在拓扑中寻找一个设备
+ *
+ * @param vendorId
+ * @param deviceId
+ * @return struct pci_device*
+ */

 struct pci_device*
 pci_get_device_by_id(uint16_t vendorId, uint16_t deviceId);
 
 struct pci_device*
 pci_get_device_by_id(uint16_t vendorId, uint16_t deviceId);
 

+/**
+ * @brief 初始化PCI设备的基地址寄存器。返回由该基地址代表的，
+ * 设备所使用的MMIO或I/O地址空间的，大小。
+ * 参阅：PCI LB Spec. (Rev 3) Section 6.2.5.1, Implementation Note.
+ *
+ * @param dev The PCI device
+ * @param bar_out Value in BAR
+ * @param bar_num The index of BAR (starting from 1)
+ * @return size_t
+ */
+size_t
+pci_bar_sizing(struct pci_device* dev, uint32_t* bar_out, uint32_t bar_num);
+
+/**
+ * @brief 配置并启用设备MSI支持。
+ * 参阅：PCI LB Spec. (Rev 3) Section 6.8 & 6.8.1
+ * 以及：Intel Manual, Vol 3, Section 10.11
+ *
+ * @param device PCI device
+ * @param vector interrupt vector.
+ */
+void
+pci_setup_msi(struct pci_device* device, int vector);
+

 #endif /* __LUNAIX_PCI_H */
 #endif /* __LUNAIX_PCI_H */