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/ds/hashtable.h>
   8 #include <lunaix/types.h>
   9 #include <lunaix/changeling.h>
  10
  11 #include "irq.h"
  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 #define PCI_BAR_COUNT 6
  35
  36 #define PCI_MSI_ADDR_LO(msi_base) ((msi_base) + 4)
  37 #define PCI_MSI_ADDR_HI(msi_base) ((msi_base) + 8)
  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_CFGADDR(pciloc) ((u32_t)(pciloc) << 8) | 0x80000000UL
  52
  53 #define PCILOC(bus, dev, funct)                                                \
  54     (((bus) & 0xff) << 8) | (((dev) & 0x1f) << 3) | ((funct) & 0x7)
  55 #define PCILOC_BUS(loc) (((loc) >> 8) & 0xff)
  56 #define PCILOC_DEV(loc) (((loc) >> 3) & 0x1f)
  57 #define PCILOC_FN(loc) ((loc) & 0x7)
  58
  59 typedef unsigned int pci_reg_t;
  60 typedef u16_t pciaddr_t;
  61
  62 // PCI device header format
  63 // Ref: "PCI Local Bus Specification, Rev.3, Section 6.1"
  64
  65 #define BAR_TYPE_MMIO 0x1
  66 #define BAR_TYPE_CACHABLE 0x2
  67 #define PCI_DRV_NAME_LEN 32
  68
  69 struct pci_base_addr
  70 {
  71     u32_t start;
  72     u32_t size;
  73     u32_t type;
  74 };
  75
  76 struct pci_probe
  77 {
  78     morph_t mobj;
  79
  80     pciaddr_t loc;
  81     u16_t intr_info;
  82     u32_t device_info;
  83     u32_t class_info;
  84     u32_t cspace_base;
  85     u32_t msi_loc;
  86     struct pci_base_addr bar[6];
  87
  88     struct device* bind;
  89     struct irq_domain* irq_domain;
  90 };
  91 #define pci_probe_morpher   morphable_attrs(pci_probe, mobj)
  92
  93 typedef bool (*pci_id_checker_t)(struct pci_probe*);
  94
  95 struct pci_registry
  96 {
  97     struct hlist_node entries;
  98     struct device_def* definition;
  99
 100     pci_id_checker_t check_compact;
 101 };
 102
 103 bool
 104 pci_register_driver(struct device_def* def, pci_id_checker_t checker);
 105
 106 /**
 107  * @brief 初始化PCI设备的基地址寄存器。返回由该基地址代表的，
 108  * 设备所使用的MMIO或I/O地址空间的，大小。
 109  * 参阅：PCI LB Spec. (Rev 3) Section 6.2.5.1, Implementation Note.
 110  *
 111  * @param dev The PCI device
 112  * @param bar_out Value in BAR
 113  * @param bar_num The index of BAR (starting from 1)
 114  * @return size_t
 115  */
 116 size_t
 117 pci_bar_sizing(struct pci_probe* probe, u32_t* bar_out, u32_t bar_num);
 118
 119 irq_t
 120 pci_declare_msi_irq(irq_servant callback, struct pci_probe* probe);
 121
 122 int
 123 pci_assign_msi(struct pci_probe* probe, irq_t irq, void* irq_spec);
 124
 125 /**
 126  * @brief Bind an abstract device instance to the pci device
 127  *
 128  * @param pcidev pci device
 129  * @param dev abstract device instance
 130  */
 131 static inline void
 132 pci_bind_instance(struct pci_probe* probe, struct device* dev)
 133 {
 134     probe->bind = dev;
 135
 136 }
 137
 138 int
 139 pci_bind_driver(struct pci_registry* reg);
 140
 141
 142 static inline unsigned int
 143 pci_device_vendor(struct pci_probe* probe)
 144 {
 145     return PCI_DEV_VENDOR(probe->device_info);
 146 }
 147
 148 static inline unsigned int
 149 pci_device_devid(struct pci_probe* probe)
 150 {
 151     return PCI_DEV_DEVID(probe->device_info);
 152 }
 153
 154 static inline unsigned int
 155 pci_device_class(struct pci_probe* probe)
 156 {
 157     return PCI_DEV_CLASS(probe->class_info);
 158 }
 159
 160 static inline struct pci_base_addr*
 161 pci_device_bar(struct pci_probe* probe, int index)
 162 {
 163     return &probe->bar[index];
 164 }
 165
 166 static inline void
 167 pci_cmd_set_mmio(pci_reg_t* cmd)
 168 {
 169     *cmd |= PCI_RCMD_MM_ACCESS;
 170 }
 171
 172 static inline ptr_t
 173 pci_requester_id(struct pci_probe* probe)
 174 {
 175     return probe->loc;
 176 }
 177
 178 static inline void
 179 pci_cmd_set_pmio(pci_reg_t* cmd)
 180 {
 181     *cmd |= PCI_RCMD_IO_ACCESS;
 182 }
 183
 184 static inline void
 185 pci_cmd_set_msi(pci_reg_t* cmd)
 186 {
 187     *cmd |= PCI_RCMD_DISABLE_INTR;
 188 }
 189
 190 static inline void
 191 pci_cmd_set_bus_master(pci_reg_t* cmd)
 192 {
 193     *cmd |= PCI_RCMD_BUS_MASTER;
 194 }
 195
 196 static inline void
 197 pci_cmd_set_fast_b2b(pci_reg_t* cmd)
 198 {
 199     *cmd |= PCI_RCMD_FAST_B2B;
 200 }
 201
 202 static inline bool
 203 pci_bar_mmio_space(struct pci_base_addr* bar)
 204 {
 205     return (bar->type & BAR_TYPE_MMIO);
 206 }
 207
 208 static inline bool
 209 pci_capability_msi(struct pci_probe* probe)
 210 {
 211     return !!probe->msi_loc;
 212 }
 213
 214 static inline int
 215 pci_intr_irq(struct pci_probe* probe)
 216 {
 217     return PCI_INTR_IRQ(probe->intr_info);
 218 }
 219
 220 void
 221 pci_apply_command(struct pci_probe* probe, pci_reg_t cmd);
 222
 223 pci_reg_t
 224 pci_read_cspace(ptr_t base, int offset);
 225
 226 void
 227 pci_write_cspace(ptr_t base, int offset, pci_reg_t data);
 228
 229 #endif /* __LUNAIX_PCI_H */