lunaix-os/includes/hal/pci.h

   1 #ifndef __LUNAIX_PCI_H
   2 #define __LUNAIX_PCI_H
   3
   4 #include <hal/io.h>
   5 #include <lunaix/ds/llist.h>
   6
   7 #define PCI_CONFIG_ADDR 0xcf8
   8 #define PCI_CONFIG_DATA 0xcfc
   9
  10 #define PCI_TDEV 0x0
  11 #define PCI_TPCIBRIDGE 0x1
  12 #define PCI_TCARDBRIDGE 0x2
  13
  14 #define PCI_VENDOR_INVLD 0xffff
  15
  16 #define PCI_REG_VENDOR_DEV 0
  17 #define PCI_REG_STATUS_CMD 0x4
  18 #define PCI_REG_BAR(num) (0x10 + (num - 1) * 4)
  19
  20 #define PCI_DEV_VENDOR(x) ((x)&0xffff)
  21 #define PCI_DEV_DEVID(x) ((x) >> 16)
  22 #define PCI_INTR_IRQ(x) ((x)&0xff)
  23 #define PCI_INTR_PIN(x) (((x)&0xff00) >> 8)
  24 #define PCI_DEV_CLASS(x) ((x) >> 8)
  25 #define PCI_DEV_REV(x) (((x)&0xff))
  26 #define PCI_BUS_NUM(x) (((x) >> 16) & 0xff)
  27 #define PCI_SLOT_NUM(x) (((x) >> 11) & 0x1f)
  28 #define PCI_FUNCT_NUM(x) (((x) >> 8) & 0x7)
  29
  30 #define PCI_BAR_MMIO(x) (!((x)&0x1))
  31 #define PCI_BAR_CACHEABLE(x) ((x)&0x8)
  32 #define PCI_BAR_TYPE(x) ((x)&0x6)
  33 #define PCI_BAR_ADDR_MM(x) ((x) & ~0xf)
  34 #define PCI_BAR_ADDR_IO(x) ((x) & ~0x3)
  35
  36 #define PCI_MSI_ADDR(msi_base) ((msi_base) + 4)
  37 #define PCI_MSI_DATA(msi_base) ((msi_base) + 8)
  38
  39 #define PCI_ADDRESS(bus, dev, funct)                                           \
  40     (((bus)&0xff) << 16) | (((dev)&0xff) << 11) | (((funct)&0xff) << 8) |      \
  41       0x80000000
  42
  43 typedef unsigned int pci_reg_t;
  44
  45 // PCI device header format
  46 // Ref: "PCI Local Bus Specification, Rev.3, Section 6.1"
  47
  48 struct pci_device
  49 {
  50     struct llist_header dev_chain;
  51     uint32_t device_info;
  52     uint32_t class_info;
  53     uint32_t cspace_base;
  54     uint32_t msi_loc;
  55     uint16_t intr_info;
  56 };
  57
  58 // PCI Configuration Space (C-Space) r/w:
  59 //      Refer to "PCI Local Bus Specification, Rev.3, Section 3.2.2.3.2"
  60
  61 inline pci_reg_t
  62 pci_read_cspace(uint32_t base, int offset)
  63 {
  64     io_outl(PCI_CONFIG_ADDR, base | (offset & ~0x3));
  65     return io_inl(PCI_CONFIG_DATA);
  66 }
  67
  68 inline void
  69 pci_write_cspace(uint32_t base, int offset, pci_reg_t data)
  70 {
  71     io_outl(PCI_CONFIG_ADDR, base | (offset & ~0x3));
  72     io_outl(PCI_CONFIG_DATA, data);
  73 }
  74
  75 /**
  76  * @brief 初始化PCI。这主要是通过扫描PCI总线进行拓扑重建。注意，该
  77  * 初始化不包括针对每个设备的初始化，因为那是设备驱动的事情。
  78  *
  79  */
  80 void
  81 pci_init();
  82
  83 void
  84 pci_print_device();
  85
  86 /**
  87  * @brief 根据类型代码（Class Code）去在拓扑中寻找一个设备
  88  * 类型代码请参阅： PCI LB Spec. Appendix D.
  89  *
  90  * @return struct pci_device*
  91  */
  92 struct pci_device* pci_get_device_by_class(uint32_t class);
  93
  94 /**
  95  * @brief 根据设备商ID和设备ID，在拓扑中寻找一个设备
  96  *
  97  * @param vendorId
  98  * @param deviceId
  99  * @return struct pci_device*
 100  */
 101 struct pci_device*
 102 pci_get_device_by_id(uint16_t vendorId, uint16_t deviceId);
 103
 104 /**
 105  * @brief 初始化PCI设备的基地址寄存器。返回由该基地址代表的，
 106  * 设备所使用的MMIO或I/O地址空间的，大小。
 107  * 参阅：PCI LB Spec. (Rev 3) Section 6.2.5.1, Implementation Note.
 108  *
 109  * @param dev The PCI device
 110  * @param bar_out Value in BAR
 111  * @param bar_num The index of BAR (starting from 1)
 112  * @return size_t
 113  */
 114 size_t
 115 pci_bar_sizing(struct pci_device* dev, uint32_t* bar_out, uint32_t bar_num);
 116
 117 /**
 118  * @brief 配置并启用设备MSI支持。
 119  * 参阅：PCI LB Spec. (Rev 3) Section 6.8 & 6.8.1
 120  * 以及：Intel Manual, Vol 3, Section 10.11
 121  *
 122  * @param device PCI device
 123  * @param vector interrupt vector.
 124  */
 125 void
 126 pci_setup_msi(struct pci_device* device, int vector);
 127
 128 #endif /* __LUNAIX_PCI_H */