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 #include <lunaix/types.h>
   7
   8 #define PCI_CONFIG_ADDR 0xcf8
   9 #define PCI_CONFIG_DATA 0xcfc
  10
  11 #define PCI_TDEV 0x0
  12 #define PCI_TPCIBRIDGE 0x1
  13 #define PCI_TCARDBRIDGE 0x2
  14
  15 #define PCI_VENDOR_INVLD 0xffff
  16
  17 #define PCI_REG_VENDOR_DEV 0
  18 #define PCI_REG_STATUS_CMD 0x4
  19 #define PCI_REG_BAR(num) (0x10 + (num - 1) * 4)
  20
  21 #define PCI_DEV_VENDOR(x) ((x)&0xffff)
  22 #define PCI_DEV_DEVID(x) ((x) >> 16)
  23 #define PCI_INTR_IRQ(x) ((x)&0xff)
  24 #define PCI_INTR_PIN(x) (((x)&0xff00) >> 8)
  25 #define PCI_DEV_CLASS(x) ((x) >> 8)
  26 #define PCI_DEV_REV(x) (((x)&0xff))
  27 #define PCI_BUS_NUM(x) (((x) >> 16) & 0xff)
  28 #define PCI_SLOT_NUM(x) (((x) >> 11) & 0x1f)
  29 #define PCI_FUNCT_NUM(x) (((x) >> 8) & 0x7)
  30
  31 #define PCI_BAR_MMIO(x) (!((x)&0x1))
  32 #define PCI_BAR_CACHEABLE(x) ((x)&0x8)
  33 #define PCI_BAR_TYPE(x) ((x)&0x6)
  34 #define PCI_BAR_ADDR_MM(x) ((x) & ~0xf)
  35 #define PCI_BAR_ADDR_IO(x) ((x) & ~0x3)
  36
  37 #define PCI_MSI_ADDR(msi_base) ((msi_base) + 4)
  38 #define PCI_MSI_DATA(msi_base, offset) ((msi_base) + 8 + offset)
  39 #define PCI_MSI_MASK(msi_base, offset) ((msi_base) + 0xc + offset)
  40
  41 #define MSI_CAP_64BIT 0x80
  42 #define MSI_CAP_MASK 0x100
  43 #define MSI_CAP_ENABLE 0x1
  44
  45 #define PCI_RCMD_DISABLE_INTR (1 << 10)
  46 #define PCI_RCMD_FAST_B2B (1 << 9)
  47 #define PCI_RCMD_BUS_MASTER (1 << 2)
  48 #define PCI_RCMD_MM_ACCESS (1 << 1)
  49 #define PCI_RCMD_IO_ACCESS 1
  50
  51 #define PCI_ADDRESS(bus, dev, funct)                                           \
  52     (((bus)&0xff) << 16) | (((dev)&0xff) << 11) | (((funct)&0xff) << 8) |      \
  53       0x80000000
  54
  55 typedef unsigned int pci_reg_t;
  56
  57 // PCI device header format
  58 // Ref: "PCI Local Bus Specification, Rev.3, Section 6.1"
  59
  60 #define BAR_TYPE_MMIO 0x1
  61 #define BAR_TYPE_CACHABLE 0x2
  62 #define PCI_DRV_NAME_LEN 32
  63
  64 struct pci_driver;
  65
  66 struct pci_base_addr
  67 {
  68     u32_t start;
  69     u32_t size;
  70     u32_t type;
  71 };
  72
  73 struct pci_device
  74 {
  75     struct llist_header dev_chain;
  76     u32_t device_info;
  77     u32_t class_info;
  78     u32_t cspace_base;
  79     u32_t msi_loc;
  80     uint16_t intr_info;
  81     struct
  82     {
  83         struct pci_driver* type;
  84         void* instance;
  85     } driver;
  86     struct pci_base_addr bar[6];
  87 };
  88
  89 typedef void* (*pci_drv_init)(struct pci_device*);
  90
  91 struct pci_driver
  92 {
  93     struct llist_header drivers;
  94     u32_t dev_info;
  95     u32_t dev_class;
  96     pci_drv_init create_driver;
  97     char name[PCI_DRV_NAME_LEN];
  98 };
  99
 100 // PCI Configuration Space (C-Space) r/w:
 101 //      Refer to "PCI Local Bus Specification, Rev.3, Section 3.2.2.3.2"
 102
 103 static inline pci_reg_t
 104 pci_read_cspace(u32_t base, int offset)
 105 {
 106     io_outl(PCI_CONFIG_ADDR, base | (offset & ~0x3));
 107     return io_inl(PCI_CONFIG_DATA);
 108 }
 109
 110 static inline void
 111 pci_write_cspace(u32_t base, int offset, pci_reg_t data)
 112 {
 113     io_outl(PCI_CONFIG_ADDR, base | (offset & ~0x3));
 114     io_outl(PCI_CONFIG_DATA, data);
 115 }
 116
 117 /**
 118  * @brief 初始化PCI。这主要是通过扫描PCI总线进行拓扑重建。注意，该
 119  * 初始化不包括针对每个设备的初始化，因为那是设备驱动的事情。
 120  *
 121  */
 122 void
 123 pci_init();
 124
 125 /**
 126  * @brief 根据类型代码（Class Code）去在拓扑中寻找一个设备
 127  * 类型代码请参阅： PCI LB Spec. Appendix D.
 128  *
 129  * @return struct pci_device*
 130  */
 131 struct pci_device* pci_get_device_by_class(u32_t class);
 132
 133 /**
 134  * @brief 根据设备商ID和设备ID，在拓扑中寻找一个设备
 135  *
 136  * @param vendorId
 137  * @param deviceId
 138  * @return struct pci_device*
 139  */
 140 struct pci_device*
 141 pci_get_device_by_id(uint16_t vendorId, uint16_t deviceId);
 142
 143 /**
 144  * @brief 初始化PCI设备的基地址寄存器。返回由该基地址代表的，
 145  * 设备所使用的MMIO或I/O地址空间的，大小。
 146  * 参阅：PCI LB Spec. (Rev 3) Section 6.2.5.1, Implementation Note.
 147  *
 148  * @param dev The PCI device
 149  * @param bar_out Value in BAR
 150  * @param bar_num The index of BAR (starting from 1)
 151  * @return size_t
 152  */
 153 size_t
 154 pci_bar_sizing(struct pci_device* dev, u32_t* bar_out, u32_t bar_num);
 155
 156 /**
 157  * @brief 配置并启用设备MSI支持。
 158  * 参阅：PCI LB Spec. (Rev 3) Section 6.8 & 6.8.1
 159  * 以及：Intel Manual, Vol 3, Section 10.11
 160  *
 161  * @param device PCI device
 162  * @param vector interrupt vector.
 163  */
 164 void
 165 pci_setup_msi(struct pci_device* device, int vector);
 166
 167 void
 168 pci_add_driver(const char* name,
 169                u32_t class,
 170                u32_t vendor,
 171                u32_t devid,
 172                pci_drv_init init);
 173
 174 int
 175 pci_bind_driver(struct pci_device* pci_dev);
 176
 177 #endif /* __LUNAIX_PCI_H */