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