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 EXPORT_PCI_DEVICE(id, pci_devdef, stage)                               \
  10     EXPORT_DEVICE(id, &(pci_devdef)->devdef, stage)
  11
  12 #define PCI_MATCH_EXACT -1
  13 #define PCI_MATCH_ANY 0
  14 #define PCI_MATCH_VENDOR 0xffff
  15
  16 #define PCI_TDEV 0x0
  17 #define PCI_TPCIBRIDGE 0x1
  18 #define PCI_TCARDBRIDGE 0x2
  19
  20 #define PCI_VENDOR_INVLD 0xffff
  21
  22 #define PCI_REG_VENDOR_DEV 0
  23 #define PCI_REG_STATUS_CMD 0x4
  24 #define PCI_REG_BAR(num) (0x10 + (num - 1) * 4)
  25
  26 #define PCI_DEV_VENDOR(x) ((x) & 0xffff)
  27 #define PCI_DEV_DEVID(x) (((x) & 0xffff0000) >> 16)
  28 #define PCI_INTR_IRQ(x) ((x) & 0xff)
  29 #define PCI_INTR_PIN(x) (((x) & 0xff00) >> 8)
  30 #define PCI_DEV_CLASS(x) ((x) >> 8)
  31 #define PCI_DEV_REV(x) (((x) & 0xff))
  32 #define PCI_BUS_NUM(x) (((x) >> 16) & 0xff)
  33 #define PCI_SLOT_NUM(x) (((x) >> 11) & 0x1f)
  34 #define PCI_FUNCT_NUM(x) (((x) >> 8) & 0x7)
  35
  36 #define PCI_BAR_MMIO(x) (!((x) & 0x1))
  37 #define PCI_BAR_CACHEABLE(x) ((x) & 0x8)
  38 #define PCI_BAR_TYPE(x) ((x) & 0x6)
  39 #define PCI_BAR_ADDR_MM(x) ((x) & ~0xf)
  40 #define PCI_BAR_ADDR_IO(x) ((x) & ~0x3)
  41
  42 #define PCI_MSI_ADDR(msi_base) ((msi_base) + 4)
  43 #define PCI_MSI_DATA(msi_base, offset) ((msi_base) + 8 + offset)
  44 #define PCI_MSI_MASK(msi_base, offset) ((msi_base) + 0xc + offset)
  45
  46 #define MSI_CAP_64BIT 0x80
  47 #define MSI_CAP_MASK 0x100
  48 #define MSI_CAP_ENABLE 0x1
  49
  50 #define PCI_RCMD_DISABLE_INTR (1 << 10)
  51 #define PCI_RCMD_FAST_B2B (1 << 9)
  52 #define PCI_RCMD_BUS_MASTER (1 << 2)
  53 #define PCI_RCMD_MM_ACCESS (1 << 1)
  54 #define PCI_RCMD_IO_ACCESS 1
  55
  56 #define PCI_CFGADDR(pciloc) ((u32_t)(pciloc) << 8) | 0x80000000UL
  57
  58 #define PCILOC(bus, dev, funct)                                                \
  59     (((bus) & 0xff) << 8) | (((dev) & 0x1f) << 3) | ((funct) & 0x7)
  60 #define PCILOC_BUS(loc) (((loc) >> 8) & 0xff)
  61 #define PCILOC_DEV(loc) (((loc) >> 3) & 0x1f)
  62 #define PCILOC_FN(loc) ((loc) & 0x7)
  63
  64 #define PCI_ID_ANY (-1)
  65
  66 typedef unsigned int pci_reg_t;
  67 typedef u16_t pciaddr_t;
  68
  69 // PCI device header format
  70 // Ref: "PCI Local Bus Specification, Rev.3, Section 6.1"
  71
  72 #define BAR_TYPE_MMIO 0x1
  73 #define BAR_TYPE_CACHABLE 0x2
  74 #define PCI_DRV_NAME_LEN 32
  75
  76 struct pci_base_addr
  77 {
  78     u32_t start;
  79     u32_t size;
  80     u32_t type;
  81 };
  82
  83 struct pci_device
  84 {
  85     struct device dev;
  86     struct llist_header dev_chain;
  87     struct hlist_node dev_cache;
  88
  89     struct
  90     {
  91         struct device* dev;
  92         struct device_def* def;
  93     } binding;
  94
  95     pciaddr_t loc;
  96     u16_t intr_info;
  97     u32_t device_info;
  98     u32_t class_info;
  99     u32_t cspace_base;
 100     u32_t msi_loc;
 101     struct pci_base_addr bar[6];
 102 };
 103 #define PCI_DEVICE(devbase) (container_of((devbase), struct pci_device, dev))
 104
 105 struct pci_device_list
 106 {
 107     struct llist_header peers;
 108     struct pci_device* pcidev;
 109 };
 110
 111 typedef void* (*pci_drv_init)(struct pci_device*);
 112
 113 #define PCI_DEVIDENT(vendor, id)                                               \
 114     ((((id) & 0xffff) << 16) | (((vendor) & 0xffff)))
 115
 116 struct pci_device_def
 117 {
 118     u32_t dev_class;
 119     u32_t dev_ident;
 120     u32_t ident_mask;
 121     struct device_def devdef;
 122 };
 123 #define pcidev_def(dev_def_ptr)                                                \
 124     container_of((dev_def_ptr), struct pci_device_def, devdef)
 125
 126 #define binded_pcidev(pcidev) ((pcidev)->binding.def)
 127
 128 /**
 129  * @brief 根据类型代码（Class Code）去在拓扑中寻找一个设备
 130  * 类型代码请参阅： PCI LB Spec. Appendix D.
 131  *
 132  * @return struct pci_device*
 133  */
 134 struct pci_device* pci_get_device_by_class(u32_t class);
 135
 136 /**
 137  * @brief 根据设备商ID和设备ID，在拓扑中寻找一个设备
 138  *
 139  * @param vendorId
 140  * @param deviceId
 141  * @return struct pci_device*
 142  */
 143 struct pci_device*
 144 pci_get_device_by_id(u16_t vendorId, u16_t deviceId);
 145
 146 /**
 147  * @brief 初始化PCI设备的基地址寄存器。返回由该基地址代表的，
 148  * 设备所使用的MMIO或I/O地址空间的，大小。
 149  * 参阅：PCI LB Spec. (Rev 3) Section 6.2.5.1, Implementation Note.
 150  *
 151  * @param dev The PCI device
 152  * @param bar_out Value in BAR
 153  * @param bar_num The index of BAR (starting from 1)
 154  * @return size_t
 155  */
 156 size_t
 157 pci_bar_sizing(struct pci_device* dev, u32_t* bar_out, u32_t bar_num);
 158
 159 /**
 160  * @brief Bind an abstract device instance to the pci device
 161  *
 162  * @param pcidev pci device
 163  * @param devobj abstract device instance
 164  */
 165 void
 166 pci_bind_instance(struct pci_device* pcidev, void* devobj);
 167
 168 void
 169 pci_probe_bar_info(struct pci_device* device);
 170
 171 void
 172 pci_probe_msi_info(struct pci_device* device);
 173
 174 int
 175 pci_bind_definition(struct pci_device_def* pcidev_def, int* more);
 176
 177 int
 178 pci_bind_definition_all(struct pci_device_def* pcidef);
 179
 180 #endif /* __LUNAIX_PCI_H */