lunaix-os/hal/pci.c

   1 /**
   2  * @file pci.c
   3  * @author Lunaixsky (zelong56@gmail.com)
   4  * @brief A software implementation of PCI Local Bus Specification Revision 3.0
   5  * @version 0.1
   6  * @date 2022-06-28
   7  *
   8  * @copyright Copyright (c) 2022
   9  *
  10  */
  11 #include <hal/pci.h>
  12 #include <sys/pci_hba.h>
  13
  14 #include <klibc/string.h>
  15 #include <lunaix/fs/twifs.h>
  16 #include <lunaix/mm/valloc.h>
  17 #include <lunaix/spike.h>
  18 #include <lunaix/syslog.h>
  19
  20 LOG_MODULE("PCI")
  21
  22 static DEFINE_LLIST(pci_devices);
  23 static DECLARE_HASHTABLE(pci_devcache, 8);
  24
  25 static struct device_cat* pcidev_cat;
  26 static struct device_def pci_def;
  27
  28 void
  29 pci_probe_msi_info(struct pci_device* device);
  30
  31 static inline void
  32 pci_log_device(struct pci_device* pcidev)
  33 {
  34     pciaddr_t loc = pcidev->loc;
  35     struct device_def* binddef = pcidev->binding.def;
  36
  37     kprintf("pci.%03d:%02d:%02d, class=%p, vendor:dev=%04x:%04x",
  38             PCILOC_BUS(loc),
  39             PCILOC_DEV(loc),
  40             PCILOC_FN(loc),
  41             pcidev->class_info,
  42             PCI_DEV_VENDOR(pcidev->device_info),
  43             PCI_DEV_DEVID(pcidev->device_info));
  44 }
  45
  46 static struct pci_device*
  47 pci_create_device(pciaddr_t loc, ptr_t pci_base, int devinfo)
  48 {
  49     pci_reg_t class = pci_read_cspace(pci_base, 0x8);
  50
  51     u32_t devid = PCI_DEV_DEVID(devinfo);
  52     u32_t vendor = PCI_DEV_VENDOR(devinfo);
  53     pci_reg_t intr = pci_read_cspace(pci_base, 0x3c);
  54
  55     struct pci_device* device = vzalloc(sizeof(struct pci_device));
  56     device->class_info = class;
  57     device->device_info = devinfo;
  58     device->cspace_base = pci_base;
  59     device->intr_info = intr;
  60
  61     device_create(&device->dev, dev_meta(pcidev_cat), DEV_IFSYS, NULL);
  62
  63     pci_probe_msi_info(device);
  64     pci_probe_bar_info(device);
  65
  66     llist_append(&pci_devices, &device->dev_chain);
  67     register_device(&device->dev, &pci_def.class, "%x", loc);
  68     pci_def.class.variant++;
  69
  70     return device;
  71 }
  72
  73 int
  74 pci_bind_definition(struct pci_device_def* pcidev_def, int* more)
  75 {
  76     u32_t class = pcidev_def->dev_class;
  77     u32_t devid_mask = pcidev_def->ident_mask;
  78     u32_t devid = pcidev_def->dev_ident & devid_mask;
  79
  80     if (!pcidev_def->devdef.bind) {
  81         ERROR("pcidev %xh:%xh.%d is unbindable",
  82               pcidev_def->devdef.class.fn_grp,
  83               pcidev_def->devdef.class.device,
  84               pcidev_def->devdef.class.variant);
  85         return EINVAL;
  86     }
  87
  88     *more = 0;
  89
  90     int bind_attempted = 0;
  91     int errno = 0;
  92
  93     struct device_def* devdef;
  94     struct pci_device *pos, *n;
  95     llist_for_each(pos, n, &pci_devices, dev_chain)
  96     {
  97         if (binded_pcidev(pos)) {
  98             continue;
  99         }
 100
 101         if (class != PCI_DEV_CLASS(pos->class_info)) {
 102             continue;
 103         }
 104
 105         int matched = (pos->device_info & devid_mask) == devid;
 106
 107         if (!matched) {
 108             continue;
 109         }
 110
 111         if (bind_attempted) {
 112             *more = 1;
 113             break;
 114         }
 115
 116         bind_attempted = 1;
 117         devdef = &pcidev_def->devdef;
 118         errno = devdef->bind(devdef, &pos->dev);
 119
 120         if (errno) {
 121             ERROR("pci_loc:%x, bind (%xh:%xh.%d) failed, e=%d",
 122                   pos->loc,
 123                   devdef->class.fn_grp,
 124                   devdef->class.device,
 125                   devdef->class.variant,
 126                   errno);
 127             continue;
 128         }
 129
 130         pos->binding.def = &pcidev_def->devdef;
 131     }
 132
 133     return errno;
 134 }
 135
 136 int
 137 pci_bind_definition_all(struct pci_device_def* pcidef)
 138 {
 139     int more = 0, e = 0;
 140     do {
 141         if (!(e = pci_bind_definition(pcidef, &more))) {
 142             break;
 143         }
 144     } while (more);
 145
 146     return e;
 147 }
 148
 149 void
 150 pci_probe_device(pciaddr_t pci_loc)
 151 {
 152     u32_t base = PCI_CFGADDR(pci_loc);
 153     pci_reg_t reg1 = pci_read_cspace(base, 0);
 154
 155     // Vendor=0xffff则表示设备不存在
 156     if (PCI_DEV_VENDOR(reg1) == PCI_VENDOR_INVLD) {
 157         return;
 158     }
 159
 160     pci_reg_t hdr_type = pci_read_cspace(base, 0xc);
 161     hdr_type = (hdr_type >> 16) & 0xff;
 162
 163     // 防止堆栈溢出
 164     // QEMU的ICH9/Q35实现似乎有点问题，对于多功能设备的每一个功能的header type
 165     //  都将第七位置位。而virtualbox 就没有这个毛病。
 166     if ((hdr_type & 0x80) && PCILOC_FN(pci_loc) == 0) {
 167         hdr_type = hdr_type & ~0x80;
 168         // 探测多用途设备（multi-function device）
 169         for (int i = 1; i < 7; i++) {
 170             pci_probe_device(pci_loc + i);
 171         }
 172     }
 173
 174     struct pci_device *pos, *n;
 175     hashtable_hash_foreach(pci_devcache, pci_loc, pos, n, dev_cache)
 176     {
 177         if (pos->loc == pci_loc) {
 178             pci_log_device(pos);
 179             return;
 180         }
 181     }
 182
 183     struct pci_device* pcidev = pci_create_device(pci_loc, base, reg1);
 184     if (pcidev) {
 185         pcidev->loc = pci_loc;
 186         hashtable_hash_in(pci_devcache, &pcidev->dev_cache, pci_loc);
 187         pci_log_device(pcidev);
 188     }
 189 }
 190
 191 void
 192 pci_scan()
 193 {
 194     for (u32_t loc = 0; loc < (pciaddr_t)-1; loc += 8) {
 195         pci_probe_device((pciaddr_t)loc);
 196     }
 197 }
 198
 199 void
 200 pci_probe_bar_info(struct pci_device* device)
 201 {
 202     u32_t bar;
 203     struct pci_base_addr* ba;
 204     for (size_t i = 0; i < 6; i++) {
 205         ba = &device->bar[i];
 206         ba->size = pci_bar_sizing(device, &bar, i + 1);
 207         if (PCI_BAR_MMIO(bar)) {
 208             ba->start = PCI_BAR_ADDR_MM(bar);
 209             ba->type |= PCI_BAR_CACHEABLE(bar) ? BAR_TYPE_CACHABLE : 0;
 210             ba->type |= BAR_TYPE_MMIO;
 211         } else {
 212             ba->start = PCI_BAR_ADDR_IO(bar);
 213         }
 214     }
 215 }
 216
 217 void
 218 pci_probe_msi_info(struct pci_device* device)
 219 {
 220     // Note that Virtualbox have to use ICH9 chipset for MSI support.
 221     // Qemu seems ok with default PIIX3, Bochs is pending to test...
 222     //    See https://www.virtualbox.org/manual/ch03.html (section 3.5.1)
 223     pci_reg_t status =
 224       pci_read_cspace(device->cspace_base, PCI_REG_STATUS_CMD) >> 16;
 225
 226     if (!(status & 0x10)) {
 227         device->msi_loc = 0;
 228         return;
 229     }
 230
 231     pci_reg_t cap_ptr = pci_read_cspace(device->cspace_base, 0x34) & 0xff;
 232     u32_t cap_hdr;
 233
 234     while (cap_ptr) {
 235         cap_hdr = pci_read_cspace(device->cspace_base, cap_ptr);
 236         if ((cap_hdr & 0xff) == 0x5) {
 237             // MSI
 238             device->msi_loc = cap_ptr;
 239             return;
 240         }
 241         cap_ptr = (cap_hdr >> 8) & 0xff;
 242     }
 243 }
 244
 245 size_t
 246 pci_bar_sizing(struct pci_device* dev, u32_t* bar_out, u32_t bar_num)
 247 {
 248     pci_reg_t bar = pci_read_cspace(dev->cspace_base, PCI_REG_BAR(bar_num));
 249     if (!bar) {
 250         *bar_out = 0;
 251         return 0;
 252     }
 253
 254     pci_write_cspace(dev->cspace_base, PCI_REG_BAR(bar_num), 0xffffffff);
 255     pci_reg_t sized =
 256       pci_read_cspace(dev->cspace_base, PCI_REG_BAR(bar_num)) & ~0x1;
 257     if (PCI_BAR_MMIO(bar)) {
 258         sized = PCI_BAR_ADDR_MM(sized);
 259     }
 260     *bar_out = bar;
 261     pci_write_cspace(dev->cspace_base, PCI_REG_BAR(bar_num), bar);
 262     return ~sized + 1;
 263 }
 264
 265 struct pci_device*
 266 pci_get_device_by_id(u16_t vendorId, u16_t deviceId)
 267 {
 268     u32_t dev_info = vendorId | (deviceId << 16);
 269     struct pci_device *pos, *n;
 270     llist_for_each(pos, n, &pci_devices, dev_chain)
 271     {
 272         if (pos->device_info == dev_info) {
 273             return pos;
 274         }
 275     }
 276
 277     return NULL;
 278 }
 279
 280 struct pci_device*
 281 pci_get_device_by_class(u32_t class)
 282 {
 283     struct pci_device *pos, *n;
 284     llist_for_each(pos, n, &pci_devices, dev_chain)
 285     {
 286         if (PCI_DEV_CLASS(pos->class_info) == class) {
 287             return pos;
 288         }
 289     }
 290
 291     return NULL;
 292 }
 293
 294 static void
 295 __pci_read_cspace(struct twimap* map)
 296 {
 297     struct pci_device* pcidev = (struct pci_device*)(map->data);
 298
 299     for (size_t i = 0; i < 256; i += sizeof(pci_reg_t)) {
 300         *(pci_reg_t*)(map->buffer + i) =
 301           pci_read_cspace(pcidev->cspace_base, i);
 302     }
 303
 304     map->size_acc = 256;
 305 }
 306
 307 /*---------- TwiFS interface definition ----------*/
 308
 309 static void
 310 __pci_read_revid(struct twimap* map)
 311 {
 312     int class = twimap_data(map, struct pci_device*)->class_info;
 313     twimap_printf(map, "0x%x", PCI_DEV_REV(class));
 314 }
 315
 316 static void
 317 __pci_read_class(struct twimap* map)
 318 {
 319     int class = twimap_data(map, struct pci_device*)->class_info;
 320     twimap_printf(map, "0x%x", PCI_DEV_CLASS(class));
 321 }
 322
 323 static void
 324 __pci_read_devinfo(struct twimap* map)
 325 {
 326     int devinfo = twimap_data(map, struct pci_device*)->device_info;
 327     twimap_printf(
 328       map, "%x:%x", PCI_DEV_VENDOR(devinfo), PCI_DEV_DEVID(devinfo));
 329 }
 330
 331 static void
 332 __pci_bar_read(struct twimap* map)
 333 {
 334     struct pci_device* pcidev = twimap_data(map, struct pci_device*);
 335     int bar_index = twimap_index(map, int);
 336
 337     struct pci_base_addr* bar = &pcidev->bar[bar_index];
 338
 339     if (!bar->start && !bar->size) {
 340         twimap_printf(map, "[%d] not present \n", bar_index);
 341         return;
 342     }
 343
 344     twimap_printf(
 345       map, "[%d] base=%.8p, size=%.8p, ", bar_index, bar->start, bar->size);
 346
 347     if ((bar->type & BAR_TYPE_MMIO)) {
 348         twimap_printf(map, "mmio");
 349         if ((bar->type & BAR_TYPE_CACHABLE)) {
 350             twimap_printf(map, ", prefetchable");
 351         }
 352     } else {
 353         twimap_printf(map, "io");
 354     }
 355
 356     twimap_printf(map, "\n");
 357 }
 358
 359 static int
 360 __pci_bar_gonext(struct twimap* map)
 361 {
 362     if (twimap_index(map, int) >= 5) {
 363         return 0;
 364     }
 365     map->index += 1;
 366     return 1;
 367 }
 368
 369 static void
 370 __pci_read_binding(struct twimap* map)
 371 {
 372     struct pci_device* pcidev = twimap_data(map, struct pci_device*);
 373     struct device_def* devdef = pcidev->binding.def;
 374     if (!devdef) {
 375         return;
 376     }
 377
 378     twimap_printf(map,
 379                   "%xh:%xh.%d",
 380                   devdef->class.fn_grp,
 381                   devdef->class.device,
 382                   devdef->class.variant);
 383 }
 384
 385 static void
 386 __pci_trigger_bus_rescan(struct twimap* map)
 387 {
 388     pci_scan();
 389 }
 390
 391 void
 392 pci_build_fsmapping()
 393 {
 394     struct twifs_node *pci_class = twifs_dir_node(NULL, "pci"), *pci_dev;
 395     struct pci_device *pos, *n;
 396     struct twimap* map;
 397
 398     map = twifs_mapping(pci_class, NULL, "rescan");
 399     map->read = __pci_trigger_bus_rescan;
 400
 401     llist_for_each(pos, n, &pci_devices, dev_chain)
 402     {
 403         pci_dev = twifs_dir_node(pci_class, "%x", pos->loc);
 404
 405         map = twifs_mapping(pci_dev, pos, "config");
 406         map->read = __pci_read_cspace;
 407
 408         map = twifs_mapping(pci_dev, pos, "revision");
 409         map->read = __pci_read_revid;
 410
 411         map = twifs_mapping(pci_dev, pos, "class");
 412         map->read = __pci_read_class;
 413
 414         map = twifs_mapping(pci_dev, pos, "binding");
 415         map->read = __pci_read_binding;
 416
 417         map = twifs_mapping(pci_dev, pos, "io_bases");
 418         map->read = __pci_bar_read;
 419         map->go_next = __pci_bar_gonext;
 420     }
 421 }
 422 EXPORT_TWIFS_PLUGIN(pci_devs, pci_build_fsmapping);
 423
 424 /*---------- PCI 3.0 HBA device definition ----------*/
 425
 426 static int
 427 pci_load_devices(struct device_def* def)
 428 {
 429     pcidev_cat = device_addcat(NULL, "pci");
 430
 431     pci_scan();
 432
 433     return 0;
 434 }
 435
 436 void
 437 pci_bind_instance(struct pci_device* pcidev, void* devobj)
 438 {
 439     pcidev->dev.underlay = devobj;
 440     pcidev->binding.dev = devobj;
 441 }
 442
 443 static struct device_def pci_def = {
 444     .name = "Generic PCI",
 445     .class = DEVCLASS(DEVIF_SOC, DEVFN_BUSIF, DEV_PCI),
 446     .init = pci_load_devices
 447 };
 448 EXPORT_DEVICE(pci3hba, &pci_def, load_sysconf);