drivers/pci/pci_rom.c

   1 /*
   2  * Copyright (C) 2014 Google, Inc
   3  *
   4  * From coreboot, originally based on the Linux kernel (drivers/pci/pci.c).
   5  *
   6  * Modifications are:
   7  * Copyright (C) 2003-2004 Linux Networx
   8  * (Written by Eric Biederman <ebiederman@lnxi.com> for Linux Networx)
   9  * Copyright (C) 2003-2006 Ronald G. Minnich <rminnich@gmail.com>
  10  * Copyright (C) 2004-2005 Li-Ta Lo <ollie@lanl.gov>
  11  * Copyright (C) 2005-2006 Tyan
  12  * (Written by Yinghai Lu <yhlu@tyan.com> for Tyan)
  13  * Copyright (C) 2005-2009 coresystems GmbH
  14  * (Written by Stefan Reinauer <stepan@coresystems.de> for coresystems GmbH)
  15  *
  16  * PCI Bus Services, see include/linux/pci.h for further explanation.
  17  *
  18  * Copyright 1993 -- 1997 Drew Eckhardt, Frederic Potter,
  19  * David Mosberger-Tang
  20  *
  21  * Copyright 1997 -- 1999 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
  22
  23  * SPDX-License-Identifier:     GPL-2.0
  24  */
  25
  26 #include <common.h>
  27 #include <bios_emul.h>
  28 #include <errno.h>
  29 #include <malloc.h>
  30 #include <pci.h>
  31 #include <pci_rom.h>
  32 #include <vbe.h>
  33 #include <video_fb.h>
  34
  35 #ifdef CONFIG_HAVE_ACPI_RESUME
  36 #include <asm/acpi.h>
  37 #endif
  38
  39 __weak bool board_should_run_oprom(pci_dev_t dev)
  40 {
  41         return true;
  42 }
  43
  44 static bool should_load_oprom(pci_dev_t dev)
  45 {
  46 #ifdef CONFIG_HAVE_ACPI_RESUME
  47         if (acpi_get_slp_type() == 3)
  48                 return false;
  49 #endif
  50         if (IS_ENABLED(CONFIG_ALWAYS_LOAD_OPROM))
  51                 return 1;
  52         if (board_should_run_oprom(dev))
  53                 return 1;
  54
  55         return 0;
  56 }
  57
  58 __weak uint32_t board_map_oprom_vendev(uint32_t vendev)
  59 {
  60         return vendev;
  61 }
  62
  63 static int pci_rom_probe(pci_dev_t dev, uint class,
  64                          struct pci_rom_header **hdrp)
  65 {
  66         struct pci_rom_header *rom_header;
  67         struct pci_rom_data *rom_data;
  68         u16 vendor, device;
  69         u16 rom_vendor, rom_device;
  70         u32 rom_class;
  71         u32 vendev;
  72         u32 mapped_vendev;
  73         u32 rom_address;
  74
  75         pci_read_config_word(dev, PCI_VENDOR_ID, &vendor);
  76         pci_read_config_word(dev, PCI_DEVICE_ID, &device);
  77         vendev = vendor << 16 | device;
  78         mapped_vendev = board_map_oprom_vendev(vendev);
  79         if (vendev != mapped_vendev)
  80                 debug("Device ID mapped to %#08x\n", mapped_vendev);
  81
  82 #ifdef CONFIG_X86_OPTION_ROM_ADDR
  83         rom_address = CONFIG_X86_OPTION_ROM_ADDR;
  84 #else
  85
  86         if (pciauto_setup_rom(pci_bus_to_hose(PCI_BUS(dev)), dev)) {
  87                 debug("Cannot find option ROM\n");
  88                 return -ENOENT;
  89         }
  90
  91         pci_read_config_dword(dev, PCI_ROM_ADDRESS, &rom_address);
  92         if (rom_address == 0x00000000 || rom_address == 0xffffffff) {
  93                 debug("%s: rom_address=%x\n", __func__, rom_address);
  94                 return -ENOENT;
  95         }
  96
  97         /* Enable expansion ROM address decoding. */
  98         pci_write_config_dword(dev, PCI_ROM_ADDRESS,
  99                                rom_address | PCI_ROM_ADDRESS_ENABLE);
 100 #endif
 101         debug("Option ROM address %x\n", rom_address);
 102         rom_header = (struct pci_rom_header *)(unsigned long)rom_address;
 103
 104         debug("PCI expansion ROM, signature %#04x, INIT size %#04x, data ptr %#04x\n",
 105               le16_to_cpu(rom_header->signature),
 106               rom_header->size * 512, le16_to_cpu(rom_header->data));
 107
 108         if (le16_to_cpu(rom_header->signature) != PCI_ROM_HDR) {
 109                 printf("Incorrect expansion ROM header signature %04x\n",
 110                        le16_to_cpu(rom_header->signature));
 111                 return -EINVAL;
 112         }
 113
 114         rom_data = (((void *)rom_header) + le16_to_cpu(rom_header->data));
 115         rom_vendor = le16_to_cpu(rom_data->vendor);
 116         rom_device = le16_to_cpu(rom_data->device);
 117
 118         debug("PCI ROM image, vendor ID %04x, device ID %04x,\n",
 119               rom_vendor, rom_device);
 120
 121         /* If the device id is mapped, a mismatch is expected */
 122         if ((vendor != rom_vendor || device != rom_device) &&
 123             (vendev == mapped_vendev)) {
 124                 printf("ID mismatch: vendor ID %04x, device ID %04x\n",
 125                        rom_vendor, rom_device);
 126                 /* Continue anyway */
 127         }
 128
 129         rom_class = (le16_to_cpu(rom_data->class_hi) << 8) | rom_data->class_lo;
 130         debug("PCI ROM image, Class Code %06x, Code Type %02x\n",
 131               rom_class, rom_data->type);
 132
 133         if (class != rom_class) {
 134                 debug("Class Code mismatch ROM %06x, dev %06x\n",
 135                       rom_class, class);
 136         }
 137         *hdrp = rom_header;
 138
 139         return 0;
 140 }
 141
 142 int pci_rom_load(uint16_t class, struct pci_rom_header *rom_header,
 143                  struct pci_rom_header **ram_headerp)
 144 {
 145         struct pci_rom_data *rom_data;
 146         unsigned int rom_size;
 147         unsigned int image_size = 0;
 148         void *target;
 149
 150         do {
 151                 /* Get next image, until we see an x86 version */
 152                 rom_header = (struct pci_rom_header *)((void *)rom_header +
 153                                                             image_size);
 154
 155                 rom_data = (struct pci_rom_data *)((void *)rom_header +
 156                                 le16_to_cpu(rom_header->data));
 157
 158                 image_size = le16_to_cpu(rom_data->ilen) * 512;
 159         } while ((rom_data->type != 0) && (rom_data->indicator == 0));
 160
 161         if (rom_data->type != 0)
 162                 return -EACCES;
 163
 164         rom_size = rom_header->size * 512;
 165
 166 #ifdef PCI_VGA_RAM_IMAGE_START
 167         target = (void *)PCI_VGA_RAM_IMAGE_START;
 168 #else
 169         target = (void *)malloc(rom_size);
 170         if (!target)
 171                 return -ENOMEM;
 172 #endif
 173         if (target != rom_header) {
 174                 ulong start = get_timer(0);
 175
 176                 debug("Copying VGA ROM Image from %p to %p, 0x%x bytes\n",
 177                       rom_header, target, rom_size);
 178                 memcpy(target, rom_header, rom_size);
 179                 if (memcmp(target, rom_header, rom_size)) {
 180                         printf("VGA ROM copy failed\n");
 181                         return -EFAULT;
 182                 }
 183                 debug("Copy took %lums\n", get_timer(start));
 184         }
 185         *ram_headerp = target;
 186
 187         return 0;
 188 }
 189
 190 static struct vbe_mode_info mode_info;
 191
 192 int vbe_get_video_info(struct graphic_device *gdev)
 193 {
 194 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
 195         struct vesa_mode_info *vesa = &mode_info.vesa;
 196
 197         gdev->winSizeX = vesa->x_resolution;
 198         gdev->winSizeY = vesa->y_resolution;
 199
 200         gdev->plnSizeX = vesa->x_resolution;
 201         gdev->plnSizeY = vesa->y_resolution;
 202
 203         gdev->gdfBytesPP = vesa->bits_per_pixel / 8;
 204
 205         switch (vesa->bits_per_pixel) {
 206         case 24:
 207                 gdev->gdfIndex = GDF_32BIT_X888RGB;
 208                 break;
 209         case 16:
 210                 gdev->gdfIndex = GDF_16BIT_565RGB;
 211                 break;
 212         default:
 213                 gdev->gdfIndex = GDF__8BIT_INDEX;
 214                 break;
 215         }
 216
 217         gdev->isaBase = CONFIG_SYS_ISA_IO_BASE_ADDRESS;
 218         gdev->pciBase = vesa->phys_base_ptr;
 219
 220         gdev->frameAdrs = vesa->phys_base_ptr;
 221         gdev->memSize = vesa->bytes_per_scanline * vesa->y_resolution;
 222
 223         gdev->vprBase = vesa->phys_base_ptr;
 224         gdev->cprBase = vesa->phys_base_ptr;
 225
 226         return gdev->winSizeX ? 0 : -ENOSYS;
 227 #else
 228         return -ENOSYS;
 229 #endif
 230 }
 231
 232 int pci_run_vga_bios(pci_dev_t dev, int (*int15_handler)(void), int exec_method)
 233 {
 234         struct pci_rom_header *rom, *ram;
 235         int vesa_mode = -1;
 236         uint class;
 237         bool emulate;
 238         int ret;
 239
 240         /* Only execute VGA ROMs */
 241         pci_read_config_dword(dev, PCI_REVISION_ID, &class);
 242         if (((class >> 16) ^ PCI_CLASS_DISPLAY_VGA) & 0xff00) {
 243                 debug("%s: Class %#x, should be %#x\n", __func__, class,
 244                       PCI_CLASS_DISPLAY_VGA);
 245                 return -ENODEV;
 246         }
 247         class >>= 8;
 248
 249         if (!should_load_oprom(dev))
 250                 return -ENXIO;
 251
 252         ret = pci_rom_probe(dev, class, &rom);
 253         if (ret)
 254                 return ret;
 255
 256         ret = pci_rom_load(class, rom, &ram);
 257         if (ret)
 258                 return ret;
 259
 260         if (!board_should_run_oprom(dev))
 261                 return -ENXIO;
 262
 263 #if defined(CONFIG_FRAMEBUFFER_SET_VESA_MODE) && \
 264                 defined(CONFIG_FRAMEBUFFER_VESA_MODE)
 265         vesa_mode = CONFIG_FRAMEBUFFER_VESA_MODE;
 266 #endif
 267         debug("Selected vesa mode %#x\n", vesa_mode);
 268
 269         if (exec_method & PCI_ROM_USE_NATIVE) {
 270 #ifdef CONFIG_X86
 271                 emulate = false;
 272 #else
 273                 if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
 274                         printf("BIOS native execution is only available on x86\n");
 275                         return -ENOSYS;
 276                 }
 277                 emulate = true;
 278 #endif
 279         } else {
 280 #ifdef CONFIG_BIOSEMU
 281                 emulate = true;
 282 #else
 283                 if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
 284                         printf("BIOS emulation not available - see CONFIG_BIOSEMU\n");
 285                         return -ENOSYS;
 286                 }
 287                 emulate = false;
 288 #endif
 289         }
 290
 291         if (emulate) {
 292 #ifdef CONFIG_BIOSEMU
 293                 BE_VGAInfo *info;
 294
 295                 ret = biosemu_setup(dev, &info);
 296                 if (ret)
 297                         return ret;
 298                 biosemu_set_interrupt_handler(0x15, int15_handler);
 299                 ret = biosemu_run(dev, (uchar *)ram, 1 << 16, info, true,
 300                                   vesa_mode, &mode_info);
 301                 if (ret)
 302                         return ret;
 303 #endif
 304         } else {
 305 #ifdef CONFIG_X86
 306                 bios_set_interrupt_handler(0x15, int15_handler);
 307
 308                 bios_run_on_x86(dev, (unsigned long)ram, vesa_mode,
 309                                 &mode_info);
 310 #endif
 311         }
 312         debug("Final vesa mode %#x\n", mode_info.video_mode);
 313
 314         return 0;
 315 }