lunaix-os/includes/hal/pci.h

   1 #ifndef __LUNAIX_PCI_H
   2 #define __LUNAIX_PCI_H
   3
   4 #include <lunaix/device.h>
   5 #include <lunaix/ds/ldga.h>
   6 #include <lunaix/ds/llist.h>
   7 #include <lunaix/types.h>
   8
   9 #define PCI_TDEV 0x0
  10 #define PCI_TPCIBRIDGE 0x1
  11 #define PCI_TCARDBRIDGE 0x2
  12
  13 #define PCI_VENDOR_INVLD 0xffff
  14
  15 #define PCI_REG_VENDOR_DEV 0
  16 #define PCI_REG_STATUS_CMD 0x4
  17 #define PCI_REG_BAR(num) (0x10 + (num - 1) * 4)
  18
  19 #define PCI_DEV_VENDOR(x) ((x)&0xffff)
  20 #define PCI_DEV_DEVID(x) (((x)&0xffff0000) >> 16)
  21 #define PCI_INTR_IRQ(x) ((x)&0xff)
  22 #define PCI_INTR_PIN(x) (((x)&0xff00) >> 8)
  23 #define PCI_DEV_CLASS(x) ((x) >> 8)
  24 #define PCI_DEV_REV(x) (((x)&0xff))
  25 #define PCI_BUS_NUM(x) (((x) >> 16) & 0xff)
  26 #define PCI_SLOT_NUM(x) (((x) >> 11) & 0x1f)
  27 #define PCI_FUNCT_NUM(x) (((x) >> 8) & 0x7)
  28
  29 #define PCI_BAR_MMIO(x) (!((x)&0x1))
  30 #define PCI_BAR_CACHEABLE(x) ((x)&0x8)
  31 #define PCI_BAR_TYPE(x) ((x)&0x6)
  32 #define PCI_BAR_ADDR_MM(x) ((x) & ~0xf)
  33 #define PCI_BAR_ADDR_IO(x) ((x) & ~0x3)
  34
  35 #define PCI_MSI_ADDR(msi_base) ((msi_base) + 4)
  36 #define PCI_MSI_DATA(msi_base, offset) ((msi_base) + 8 + offset)
  37 #define PCI_MSI_MASK(msi_base, offset) ((msi_base) + 0xc + offset)
  38
  39 #define MSI_CAP_64BIT 0x80
  40 #define MSI_CAP_MASK 0x100
  41 #define MSI_CAP_ENABLE 0x1
  42
  43 #define PCI_RCMD_DISABLE_INTR (1 << 10)
  44 #define PCI_RCMD_FAST_B2B (1 << 9)
  45 #define PCI_RCMD_BUS_MASTER (1 << 2)
  46 #define PCI_RCMD_MM_ACCESS (1 << 1)
  47 #define PCI_RCMD_IO_ACCESS 1
  48
  49 #define PCI_ADDRESS(bus, dev, funct)                                           \
  50     (((bus)&0xff) << 16) | (((dev)&0xff) << 11) | (((funct)&0xff) << 8) |      \
  51       0x80000000
  52
  53 #define PCI_ID_ANY (-1)
  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_base_addr
  65 {
  66     u32_t start;
  67     u32_t size;
  68     u32_t type;
  69 };
  70
  71 struct pci_device
  72 {
  73     struct device dev;
  74     struct llist_header dev_chain;
  75     u32_t device_info;
  76     u32_t class_info;
  77     u32_t cspace_base;
  78     u32_t msi_loc;
  79     u16_t intr_info;
  80     struct pci_base_addr bar[6];
  81 };
  82
  83 typedef void* (*pci_drv_init)(struct pci_device*);
  84
  85 struct pci_device_def
  86 {
  87     u32_t dev_class;
  88     u32_t dev_vendor;
  89     u32_t dev_id;
  90     struct device_def devdef;
  91 };
  92
  93 /**
  94  * @brief 根据类型代码（Class Code）去在拓扑中寻找一个设备
  95  * 类型代码请参阅： PCI LB Spec. Appendix D.
  96  *
  97  * @return struct pci_device*
  98  */
  99 struct pci_device* pci_get_device_by_class(u32_t class);
 100
 101 /**
 102  * @brief 根据设备商ID和设备ID，在拓扑中寻找一个设备
 103  *
 104  * @param vendorId
 105  * @param deviceId
 106  * @return struct pci_device*
 107  */
 108 struct pci_device*
 109 pci_get_device_by_id(u16_t vendorId, u16_t deviceId);
 110
 111 /**
 112  * @brief 初始化PCI设备的基地址寄存器。返回由该基地址代表的，
 113  * 设备所使用的MMIO或I/O地址空间的，大小。
 114  * 参阅：PCI LB Spec. (Rev 3) Section 6.2.5.1, Implementation Note.
 115  *
 116  * @param dev The PCI device
 117  * @param bar_out Value in BAR
 118  * @param bar_num The index of BAR (starting from 1)
 119  * @return size_t
 120  */
 121 size_t
 122 pci_bar_sizing(struct pci_device* dev, u32_t* bar_out, u32_t bar_num);
 123
 124 void
 125 pci_add_driver(const char* name,
 126                u32_t class,
 127                u32_t vendor,
 128                u32_t devid,
 129                pci_drv_init init);
 130
 131 int
 132 pci_bind_driver(struct pci_device* pci_dev);
 133
 134 void
 135 pci_probe_bar_info(struct pci_device* device);
 136
 137 void
 138 pci_probe_msi_info(struct pci_device* device);
 139
 140 #endif /* __LUNAIX_PCI_H */