src/device/pci_rom.c

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /* This file is part of the coreboot project. */
   3
   4 #include <console/console.h>
   5 #include <commonlib/endian.h>
   6 #include <device/device.h>
   7 #include <device/pci.h>
   8 #include <device/pci_ids.h>
   9 #include <device/pci_ops.h>
  10 #include <string.h>
  11 #include <cbfs.h>
  12 #include <cbmem.h>
  13 #include <acpi/acpigen.h>
  14
  15 /* Rmodules don't like weak symbols. */
  16 void __weak map_oprom_vendev_rev(u32 *vendev, u8 *rev) { return; }
  17 u32 __weak map_oprom_vendev(u32 vendev) { return vendev; }
  18
  19 struct rom_header *pci_rom_probe(const struct device *dev)
  20 {
  21         struct rom_header *rom_header = NULL;
  22         struct pci_data *rom_data;
  23         u8 rev = pci_read_config8(dev, PCI_REVISION_ID);
  24         u8 mapped_rev = rev;
  25         u32 vendev = (dev->vendor << 16) | dev->device;
  26         u32 mapped_vendev = vendev;
  27
  28         /* If the ROM is in flash, then don't check the PCI device for it. */
  29         if (CONFIG(CHECK_REV_IN_OPROM_NAME)) {
  30                 rom_header = cbfs_boot_map_optionrom_revision(dev->vendor, dev->device, rev);
  31                 map_oprom_vendev_rev(&mapped_vendev, &mapped_rev);
  32         } else {
  33                 rom_header = cbfs_boot_map_optionrom(dev->vendor, dev->device);
  34                 mapped_vendev = map_oprom_vendev(vendev);
  35         }
  36
  37         if (!rom_header) {
  38                 if (CONFIG(CHECK_REV_IN_OPROM_NAME) &&
  39                                 (vendev != mapped_vendev || rev != mapped_rev)) {
  40                         rom_header = cbfs_boot_map_optionrom_revision(
  41                                         mapped_vendev >> 16,
  42                                         mapped_vendev & 0xffff, mapped_rev);
  43                 } else if (vendev != mapped_vendev) {
  44                         rom_header = cbfs_boot_map_optionrom(
  45                                         mapped_vendev >> 16,
  46                                         mapped_vendev & 0xffff);
  47                 }
  48         }
  49
  50         if (rom_header) {
  51                 printk(BIOS_DEBUG, "In CBFS, ROM address for %s = %p\n",
  52                        dev_path(dev), rom_header);
  53         } else if (!CONFIG(ON_DEVICE_ROM_LOAD)) {
  54                 printk(BIOS_DEBUG, "PCI Option ROM loading disabled for %s\n",
  55                        dev_path(dev));
  56                 return NULL;
  57         } else {
  58                 uintptr_t rom_address;
  59
  60                 rom_address = pci_read_config32(dev, PCI_ROM_ADDRESS);
  61
  62                 if (rom_address == 0x00000000 || rom_address == 0xffffffff) {
  63 #if CONFIG(CPU_QEMU_X86)
  64                         if ((dev->class >> 8) == PCI_CLASS_DISPLAY_VGA)
  65                                 rom_address = 0xc0000;
  66                         else
  67 #endif
  68                                 return NULL;
  69                 } else {
  70                         /* Enable expansion ROM address decoding. */
  71                         pci_write_config32(dev, PCI_ROM_ADDRESS,
  72                                            rom_address|PCI_ROM_ADDRESS_ENABLE);
  73                 }
  74
  75                 rom_address &= PCI_ROM_ADDRESS_MASK;
  76
  77                 printk(BIOS_DEBUG, "Option ROM address for %s = %lx\n",
  78                        dev_path(dev), (unsigned long)rom_address);
  79                 rom_header = (struct rom_header *)rom_address;
  80         }
  81
  82         printk(BIOS_SPEW, "PCI expansion ROM, signature 0x%04x, "
  83                "INIT size 0x%04x, data ptr 0x%04x\n",
  84                le32_to_cpu(rom_header->signature),
  85                rom_header->size * 512, le32_to_cpu(rom_header->data));
  86
  87         if (le32_to_cpu(rom_header->signature) != PCI_ROM_HDR) {
  88                 printk(BIOS_ERR, "Incorrect expansion ROM header "
  89                        "signature %04x\n", le32_to_cpu(rom_header->signature));
  90                 return NULL;
  91         }
  92
  93         rom_data = (((void *)rom_header) + le32_to_cpu(rom_header->data));
  94
  95         printk(BIOS_SPEW, "PCI ROM image, vendor ID %04x, device ID %04x,\n",
  96                rom_data->vendor, rom_data->device);
  97         /* If the device id is mapped, a mismatch is expected */
  98         if ((dev->vendor != rom_data->vendor
  99             || dev->device != rom_data->device)
 100             && (vendev == mapped_vendev)) {
 101                 printk(BIOS_ERR, "ID mismatch: vendor ID %04x, "
 102                        "device ID %04x\n", dev->vendor, dev->device);
 103                 return NULL;
 104         }
 105
 106         printk(BIOS_SPEW, "PCI ROM image, Class Code %04x%02x, "
 107                "Code Type %02x\n", rom_data->class_hi, rom_data->class_lo,
 108                rom_data->type);
 109
 110         if (dev->class != ((rom_data->class_hi << 8) | rom_data->class_lo)) {
 111                 printk(BIOS_DEBUG, "Class Code mismatch ROM %08x, dev %08x\n",
 112                        (rom_data->class_hi << 8) | rom_data->class_lo,
 113                        dev->class);
 114                 // return NULL;
 115         }
 116
 117         return rom_header;
 118 }
 119
 120 static void *pci_ram_image_start = (void *)PCI_RAM_IMAGE_START;
 121
 122 struct rom_header *pci_rom_load(struct device *dev,
 123                                 struct rom_header *rom_header)
 124 {
 125         struct pci_data * rom_data;
 126         unsigned int rom_size;
 127         unsigned int image_size=0;
 128
 129         do {
 130                 /* Get next image. */
 131                 rom_header = (struct rom_header *)((void *) rom_header
 132                                                             + image_size);
 133
 134                 rom_data = (struct pci_data *)((void *) rom_header
 135                                 + le32_to_cpu(rom_header->data));
 136
 137                 image_size = le32_to_cpu(rom_data->ilen) * 512;
 138         } while ((rom_data->type != 0) && (rom_data->indicator != 0)); // make sure we got x86 version
 139
 140         if (rom_data->type != 0)
 141                 return NULL;
 142
 143         rom_size = rom_header->size * 512;
 144
 145         /*
 146          * We check to see if the device thinks it is a VGA device not
 147          * whether the ROM image is for a VGA device because some
 148          * devices have a mismatch between the hardware and the ROM.
 149          */
 150         if ((dev->class >> 8) == PCI_CLASS_DISPLAY_VGA) {
 151 #if !CONFIG(MULTIPLE_VGA_ADAPTERS)
 152                 extern struct device *vga_pri; /* Primary VGA device (device.c). */
 153                 if (dev != vga_pri) return NULL; /* Only one VGA supported. */
 154 #endif
 155                 if ((void *)PCI_VGA_RAM_IMAGE_START != rom_header) {
 156                         printk(BIOS_DEBUG, "Copying VGA ROM Image from %p to "
 157                                "0x%x, 0x%x bytes\n", rom_header,
 158                                PCI_VGA_RAM_IMAGE_START, rom_size);
 159                         memcpy((void *)PCI_VGA_RAM_IMAGE_START, rom_header,
 160                                rom_size);
 161                 }
 162                 return (struct rom_header *) (PCI_VGA_RAM_IMAGE_START);
 163         }
 164
 165         printk(BIOS_DEBUG, "Copying non-VGA ROM image from %p to %p, 0x%x "
 166                "bytes\n", rom_header, pci_ram_image_start, rom_size);
 167
 168         memcpy(pci_ram_image_start, rom_header, rom_size);
 169         pci_ram_image_start += rom_size;
 170         return (struct rom_header *) (pci_ram_image_start-rom_size);
 171 }
 172
 173 /* ACPI */
 174 #if CONFIG(HAVE_ACPI_TABLES)
 175
 176 /* VBIOS may be modified after oprom init so use the copy if present. */
 177 static struct rom_header *check_initialized(const struct device *dev)
 178 {
 179         struct rom_header *run_rom;
 180         struct pci_data *rom_data;
 181
 182         if (!CONFIG(VGA_ROM_RUN))
 183                 return NULL;
 184
 185         run_rom = (struct rom_header *)(uintptr_t)PCI_VGA_RAM_IMAGE_START;
 186         if (read_le16(&run_rom->signature) != PCI_ROM_HDR)
 187                 return NULL;
 188
 189         rom_data = (struct pci_data *)((u8 *)run_rom
 190                         + read_le16(&run_rom->data));
 191
 192         if (read_le32(&rom_data->signature) == PCI_DATA_HDR
 193                         && read_le16(&rom_data->device) == dev->device
 194                         && read_le16(&rom_data->vendor) == dev->vendor)
 195                 return run_rom;
 196         else
 197                 return NULL;
 198 }
 199
 200 static unsigned long
 201 pci_rom_acpi_fill_vfct(const struct device *device, acpi_vfct_t *vfct_struct,
 202                        unsigned long current)
 203 {
 204         acpi_vfct_image_hdr_t *header = &vfct_struct->image_hdr;
 205         struct rom_header *rom;
 206
 207         rom = check_initialized(device);
 208         if (!rom)
 209                 rom = pci_rom_probe(device);
 210         if (!rom) {
 211                 printk(BIOS_ERR, "pci_rom_acpi_fill_vfct failed\n");
 212                 return current;
 213         }
 214
 215         printk(BIOS_DEBUG, "           Copying %sVBIOS image from %p\n",
 216                         rom == (struct rom_header *)
 217                                         (uintptr_t)PCI_VGA_RAM_IMAGE_START ?
 218                         "initialized " : "",
 219                         rom);
 220
 221         header->DeviceID = device->device;
 222         header->VendorID = device->vendor;
 223         header->PCIBus = device->bus->secondary;
 224         header->PCIFunction = PCI_FUNC(device->path.pci.devfn);
 225         header->PCIDevice = PCI_SLOT(device->path.pci.devfn);
 226         header->ImageLength = rom->size * 512;
 227         memcpy((void *)&header->VbiosContent, rom, header->ImageLength);
 228
 229         vfct_struct->VBIOSImageOffset = (size_t)header - (size_t)vfct_struct;
 230
 231         current += header->ImageLength;
 232         return current;
 233 }
 234
 235 unsigned long
 236 pci_rom_write_acpi_tables(const struct device *device, unsigned long current,
 237                           struct acpi_rsdp *rsdp)
 238 {
 239         /* Only handle VGA devices */
 240         if ((device->class >> 8) != PCI_CLASS_DISPLAY_VGA)
 241                 return current;
 242
 243         /* Only handle enabled devices */
 244         if (!device->enabled)
 245                 return current;
 246
 247         /* AMD/ATI uses VFCT */
 248         if (device->vendor == PCI_VENDOR_ID_ATI) {
 249                 acpi_vfct_t *vfct;
 250
 251                 current = ALIGN_UP(current, 8);
 252                 vfct = (acpi_vfct_t *)current;
 253                 acpi_create_vfct(device, vfct, pci_rom_acpi_fill_vfct);
 254                 if (vfct->header.length) {
 255                         printk(BIOS_DEBUG, "ACPI:    * VFCT at %lx\n", current);
 256                         current += vfct->header.length;
 257                         acpi_add_table(rsdp, vfct);
 258                 }
 259         }
 260
 261         return current;
 262 }
 263
 264 void pci_rom_ssdt(const struct device *device)
 265 {
 266         static size_t ngfx;
 267
 268         /* Only handle VGA devices */
 269         if ((device->class >> 8) != PCI_CLASS_DISPLAY_VGA)
 270                 return;
 271
 272         /* Only handle enabled devices */
 273         if (!device->enabled)
 274                 return;
 275
 276         /* Probe for option rom */
 277         const struct rom_header *rom = pci_rom_probe(device);
 278         if (!rom || !rom->size) {
 279                 printk(BIOS_WARNING, "%s: Missing PCI Option ROM\n",
 280                        dev_path(device));
 281                 return;
 282         }
 283
 284         const char *scope = acpi_device_path(device);
 285         if (!scope) {
 286                 printk(BIOS_ERR, "%s: Missing ACPI scope\n", dev_path(device));
 287                 return;
 288         }
 289
 290         /* Supports up to four devices. */
 291         if ((CBMEM_ID_ROM0 + ngfx) > CBMEM_ID_ROM3) {
 292                 printk(BIOS_ERR, "%s: Out of CBMEM IDs.\n", dev_path(device));
 293                 return;
 294         }
 295
 296         /* Prepare memory */
 297         const size_t cbrom_length = rom->size * 512;
 298         if (!cbrom_length) {
 299                 printk(BIOS_ERR, "%s: ROM has zero length!\n",
 300                        dev_path(device));
 301                 return;
 302         }
 303
 304         void *cbrom = cbmem_add(CBMEM_ID_ROM0 + ngfx, cbrom_length);
 305         if (!cbrom) {
 306                 printk(BIOS_ERR, "%s: Failed to allocate CBMEM.\n",
 307                        dev_path(device));
 308                 return;
 309         }
 310         /* Increment CBMEM id for next device */
 311         ngfx++;
 312
 313         memcpy(cbrom, rom, cbrom_length);
 314
 315         /* write _ROM method */
 316         acpigen_write_scope(scope);
 317         acpigen_write_rom(cbrom, cbrom_length);
 318         acpigen_pop_len(); /* pop scope */
 319 }
 320 #endif