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 #define PCI_BAR_COUNT 6
  42
  43 #define PCI_MSI_ADDR_LO(msi_base) ((msi_base) + 4)
  44 #define PCI_MSI_ADDR_HI(msi_base) ((msi_base) + 8)
  45 #define PCI_MSI_DATA(msi_base, offset) ((msi_base) + 8 + offset)
  46 #define PCI_MSI_MASK(msi_base, offset) ((msi_base) + 0xc + offset)
  47
  48 #define MSI_CAP_64BIT 0x80
  49 #define MSI_CAP_MASK 0x100
  50 #define MSI_CAP_ENABLE 0x1
  51
  52 #define PCI_RCMD_DISABLE_INTR (1 << 10)
  53 #define PCI_RCMD_FAST_B2B (1 << 9)
  54 #define PCI_RCMD_BUS_MASTER (1 << 2)
  55 #define PCI_RCMD_MM_ACCESS (1 << 1)
  56 #define PCI_RCMD_IO_ACCESS 1
  57
  58 #define PCI_CFGADDR(pciloc) ((u32_t)(pciloc) << 8) | 0x80000000UL
  59
  60 #define PCILOC(bus, dev, funct)                                                \
  61     (((bus) & 0xff) << 8) | (((dev) & 0x1f) << 3) | ((funct) & 0x7)
  62 #define PCILOC_BUS(loc) (((loc) >> 8) & 0xff)
  63 #define PCILOC_DEV(loc) (((loc) >> 3) & 0x1f)
  64 #define PCILOC_FN(loc) ((loc) & 0x7)
  65
  66 #define PCI_ID_ANY (-1)
  67
  68 typedef unsigned int pci_reg_t;
  69 typedef u16_t pciaddr_t;
  70
  71 // PCI device header format
  72 // Ref: "PCI Local Bus Specification, Rev.3, Section 6.1"
  73
  74 #define BAR_TYPE_MMIO 0x1
  75 #define BAR_TYPE_CACHABLE 0x2
  76 #define PCI_DRV_NAME_LEN 32
  77
  78 struct pci_base_addr
  79 {
  80     u32_t start;
  81     u32_t size;
  82     u32_t type;
  83 };
  84
  85 struct pci_device
  86 {
  87     struct device dev;
  88     struct llist_header dev_chain;
  89     struct hlist_node dev_cache;
  90
  91     struct
  92     {
  93         struct device* dev;
  94         struct device_def* def;
  95     } binding;
  96
  97     pciaddr_t loc;
  98     u16_t intr_info;
  99     u32_t device_info;
 100     u32_t class_info;
 101     u32_t cspace_base;
 102     u32_t msi_loc;
 103     struct pci_base_addr bar[6];
 104 };
 105 #define PCI_DEVICE(devbase) (container_of((devbase), struct pci_device, dev))
 106
 107 struct pci_device_list
 108 {
 109     struct llist_header peers;
 110     struct pci_device* pcidev;
 111 };
 112
 113 typedef void* (*pci_drv_init)(struct pci_device*);
 114
 115 #define PCI_DEVIDENT(vendor, id)                                               \
 116     ((((id) & 0xffff) << 16) | (((vendor) & 0xffff)))
 117
 118 struct pci_device_def
 119 {
 120     struct device_def devdef;
 121
 122     bool (*test_compatibility)(struct pci_device_def*, struct pci_device*);
 123 };
 124 #define pcidev_def(dev_def_ptr)                                                \
 125     container_of((dev_def_ptr), struct pci_device_def, devdef)
 126
 127 #define binded_pcidev(pcidev) ((pcidev)->binding.def)
 128
 129 /**
 130  * @brief 根据类型代码（Class Code）去在拓扑中寻找一个设备
 131  * 类型代码请参阅： PCI LB Spec. Appendix D.
 132  *
 133  * @return struct pci_device*
 134  */
 135 struct pci_device* pci_get_device_by_class(u32_t class);
 136
 137 /**
 138  * @brief 根据设备商ID和设备ID，在拓扑中寻找一个设备
 139  *
 140  * @param vendorId
 141  * @param deviceId
 142  * @return struct pci_device*
 143  */
 144 struct pci_device*
 145 pci_get_device_by_id(u16_t vendorId, u16_t deviceId);
 146
 147 /**
 148  * @brief 初始化PCI设备的基地址寄存器。返回由该基地址代表的，
 149  * 设备所使用的MMIO或I/O地址空间的，大小。
 150  * 参阅：PCI LB Spec. (Rev 3) Section 6.2.5.1, Implementation Note.
 151  *
 152  * @param dev The PCI device
 153  * @param bar_out Value in BAR
 154  * @param bar_num The index of BAR (starting from 1)
 155  * @return size_t
 156  */
 157 size_t
 158 pci_bar_sizing(struct pci_device* dev, u32_t* bar_out, u32_t bar_num);
 159
 160 /**
 161  * @brief Bind an abstract device instance to the pci device
 162  *
 163  * @param pcidev pci device
 164  * @param devobj abstract device instance
 165  */
 166 void
 167 pci_bind_instance(struct pci_device* pcidev, void* devobj);
 168
 169 void
 170 pci_probe_bar_info(struct pci_device* device);
 171
 172 void
 173 pci_setup_msi(struct pci_device* device, int vector);
 174
 175 void
 176 pci_probe_msi_info(struct pci_device* device);
 177
 178 int
 179 pci_bind_definition(struct pci_device_def* pcidev_def, bool* more);
 180
 181 int
 182 pci_bind_definition_all(struct pci_device_def* pcidef);
 183
 184 static inline unsigned int
 185 pci_device_vendor(struct pci_device* pcidev)
 186 {
 187     return PCI_DEV_VENDOR(pcidev->device_info);
 188 }
 189
 190 static inline unsigned int
 191 pci_device_devid(struct pci_device* pcidev)
 192 {
 193     return PCI_DEV_DEVID(pcidev->device_info);
 194 }
 195
 196 static inline unsigned int
 197 pci_device_class(struct pci_device* pcidev)
 198 {
 199     return PCI_DEV_CLASS(pcidev->class_info);
 200 }
 201
 202 static inline struct pci_base_addr*
 203 pci_device_bar(struct pci_device* pcidev, int index)
 204 {
 205     return &pcidev->bar[index];
 206 }
 207
 208 static inline void
 209 pci_cmd_set_mmio(pci_reg_t* cmd)
 210 {
 211     *cmd |= PCI_RCMD_MM_ACCESS;
 212 }
 213
 214
 215 static inline void
 216 pci_cmd_set_pmio(pci_reg_t* cmd)
 217 {
 218     *cmd |= PCI_RCMD_IO_ACCESS;
 219 }
 220
 221 static inline void
 222 pci_cmd_set_msi(pci_reg_t* cmd)
 223 {
 224     *cmd |= PCI_RCMD_DISABLE_INTR;
 225 }
 226
 227 static inline void
 228 pci_cmd_set_bus_master(pci_reg_t* cmd)
 229 {
 230     *cmd |= PCI_RCMD_BUS_MASTER;
 231 }
 232
 233 static inline void
 234 pci_cmd_set_fast_b2b(pci_reg_t* cmd)
 235 {
 236     *cmd |= PCI_RCMD_FAST_B2B;
 237 }
 238
 239 static inline bool
 240 pci_bar_mmio_space(struct pci_base_addr* bar)
 241 {
 242     return (bar->type & BAR_TYPE_MMIO);
 243 }
 244
 245 static inline bool
 246 pci_capability_msi(struct pci_device* pcidev)
 247 {
 248     return !!pcidev->msi_loc;
 249 }
 250
 251 static inline int
 252 pci_intr_irq(struct pci_device* pcidev)
 253 {
 254     return PCI_INTR_IRQ(pcidev->intr_info);
 255 }
 256
 257 void
 258 pci_apply_command(struct pci_device* pcidev, pci_reg_t cmd);
 259
 260 pci_reg_t
 261 pci_read_cspace(ptr_t base, int offset);
 262
 263 void
 264 pci_write_cspace(ptr_t base, int offset, pci_reg_t data);
 265
 266 u16_t
 267 pci_config_msi_data(int vector);
 268
 269 ptr_t
 270 pci_get_msi_base();
 271
 272
 273 #endif /* __LUNAIX_PCI_H */