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 vendev;
  71         u32 mapped_vendev;
  72         u32 rom_address;
  73
  74         pci_read_config_word(dev, PCI_VENDOR_ID, &vendor);
  75         pci_read_config_word(dev, PCI_DEVICE_ID, &device);
  76         vendev = vendor << 16 | device;
  77         mapped_vendev = board_map_oprom_vendev(vendev);
  78         if (vendev != mapped_vendev)
  79                 debug("Device ID mapped to %#08x\n", mapped_vendev);
  80
  81 #ifdef CONFIG_X86_OPTION_ROM_ADDR
  82         rom_address = CONFIG_X86_OPTION_ROM_ADDR;
  83 #else
  84         pci_write_config_dword(dev, PCI_ROM_ADDRESS, (u32)PCI_ROM_ADDRESS_MASK);
  85         pci_read_config_dword(dev, PCI_ROM_ADDRESS, &rom_address);
  86         if (rom_address == 0x00000000 || rom_address == 0xffffffff) {
  87                 debug("%s: rom_address=%x\n", __func__, rom_address);
  88                 return -ENOENT;
  89         }
  90
  91         /* Enable expansion ROM address decoding. */
  92         pci_write_config_dword(dev, PCI_ROM_ADDRESS,
  93                                rom_address | PCI_ROM_ADDRESS_ENABLE);
  94 #endif
  95         debug("Option ROM address %x\n", rom_address);
  96         rom_header = (struct pci_rom_header *)rom_address;
  97
  98         debug("PCI expansion ROM, signature %#04x, INIT size %#04x, data ptr %#04x\n",
  99               le16_to_cpu(rom_header->signature),
 100               rom_header->size * 512, le16_to_cpu(rom_header->data));
 101
 102         if (le16_to_cpu(rom_header->signature) != PCI_ROM_HDR) {
 103                 printf("Incorrect expansion ROM header signature %04x\n",
 104                        le16_to_cpu(rom_header->signature));
 105                 return -EINVAL;
 106         }
 107
 108         rom_data = (((void *)rom_header) + le16_to_cpu(rom_header->data));
 109         rom_vendor = le16_to_cpu(rom_data->vendor);
 110         rom_device = le16_to_cpu(rom_data->device);
 111
 112         debug("PCI ROM image, vendor ID %04x, device ID %04x,\n",
 113               rom_vendor, rom_device);
 114
 115         /* If the device id is mapped, a mismatch is expected */
 116         if ((vendor != rom_vendor || device != rom_device) &&
 117             (vendev == mapped_vendev)) {
 118                 printf("ID mismatch: vendor ID %04x, device ID %04x\n",
 119                        rom_vendor, rom_device);
 120                 return -EPERM;
 121         }
 122
 123         debug("PCI ROM image, Class Code %04x%02x, Code Type %02x\n",
 124               rom_data->class_hi, rom_data->class_lo, rom_data->type);
 125
 126         if (class != ((rom_data->class_hi << 8) | rom_data->class_lo)) {
 127                 debug("Class Code mismatch ROM %08x, dev %08x\n",
 128                       (rom_data->class_hi << 8) | rom_data->class_lo,
 129                       class);
 130         }
 131         *hdrp = rom_header;
 132
 133         return 0;
 134 }
 135
 136 int pci_rom_load(uint16_t class, struct pci_rom_header *rom_header,
 137                  struct pci_rom_header **ram_headerp)
 138 {
 139         struct pci_rom_data *rom_data;
 140         unsigned int rom_size;
 141         unsigned int image_size = 0;
 142         void *target;
 143
 144         do {
 145                 /* Get next image, until we see an x86 version */
 146                 rom_header = (struct pci_rom_header *)((void *)rom_header +
 147                                                             image_size);
 148
 149                 rom_data = (struct pci_rom_data *)((void *)rom_header +
 150                                 le16_to_cpu(rom_header->data));
 151
 152                 image_size = le16_to_cpu(rom_data->ilen) * 512;
 153         } while ((rom_data->type != 0) && (rom_data->indicator == 0));
 154
 155         if (rom_data->type != 0)
 156                 return -EACCES;
 157
 158         rom_size = rom_header->size * 512;
 159
 160         target = (void *)PCI_VGA_RAM_IMAGE_START;
 161         if (target != rom_header) {
 162                 ulong start = get_timer(0);
 163
 164                 debug("Copying VGA ROM Image from %p to %p, 0x%x bytes\n",
 165                       rom_header, target, rom_size);
 166                 memcpy(target, rom_header, rom_size);
 167                 if (memcmp(target, rom_header, rom_size)) {
 168                         printf("VGA ROM copy failed\n");
 169                         return -EFAULT;
 170                 }
 171                 debug("Copy took %lums\n", get_timer(start));
 172         }
 173         *ram_headerp = target;
 174
 175         return 0;
 176 }
 177
 178 static struct vbe_mode_info mode_info;
 179
 180 int vbe_get_video_info(struct graphic_device *gdev)
 181 {
 182 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
 183         struct vesa_mode_info *vesa = &mode_info.vesa;
 184
 185         gdev->winSizeX = vesa->x_resolution;
 186         gdev->winSizeY = vesa->y_resolution;
 187
 188         gdev->plnSizeX = vesa->x_resolution;
 189         gdev->plnSizeY = vesa->y_resolution;
 190
 191         gdev->gdfBytesPP = vesa->bits_per_pixel / 8;
 192
 193         switch (vesa->bits_per_pixel) {
 194         case 24:
 195                 gdev->gdfIndex = GDF_32BIT_X888RGB;
 196                 break;
 197         case 16:
 198                 gdev->gdfIndex = GDF_16BIT_565RGB;
 199                 break;
 200         default:
 201                 gdev->gdfIndex = GDF__8BIT_INDEX;
 202                 break;
 203         }
 204
 205         gdev->isaBase = CONFIG_SYS_ISA_IO_BASE_ADDRESS;
 206         gdev->pciBase = vesa->phys_base_ptr;
 207
 208         gdev->frameAdrs = vesa->phys_base_ptr;
 209         gdev->memSize = vesa->bytes_per_scanline * vesa->y_resolution;
 210
 211         gdev->vprBase = vesa->phys_base_ptr;
 212         gdev->cprBase = vesa->phys_base_ptr;
 213
 214         return gdev->winSizeX ? 0 : -ENOSYS;
 215 #else
 216         return -ENOSYS;
 217 #endif
 218 }
 219
 220 int pci_run_vga_bios(pci_dev_t dev, int (*int15_handler)(void), bool emulate)
 221 {
 222         struct pci_rom_header *rom, *ram;
 223         int vesa_mode = -1;
 224         uint16_t class;
 225         int ret;
 226
 227         /* Only execute VGA ROMs */
 228         pci_read_config_word(dev, PCI_CLASS_DEVICE, &class);
 229         if ((class ^ PCI_CLASS_DISPLAY_VGA) & 0xff00) {
 230                 debug("%s: Class %#x, should be %#x\n", __func__, class,
 231                       PCI_CLASS_DISPLAY_VGA);
 232                 return -ENODEV;
 233         }
 234
 235         if (!should_load_oprom(dev))
 236                 return -ENXIO;
 237
 238         ret = pci_rom_probe(dev, class, &rom);
 239         if (ret)
 240                 return ret;
 241
 242         ret = pci_rom_load(class, rom, &ram);
 243         if (ret)
 244                 return ret;
 245
 246         if (!board_should_run_oprom(dev))
 247                 return -ENXIO;
 248
 249 #if defined(CONFIG_FRAMEBUFFER_SET_VESA_MODE) && \
 250                 defined(CONFIG_FRAMEBUFFER_VESA_MODE)
 251         vesa_mode = CONFIG_FRAMEBUFFER_VESA_MODE;
 252 #endif
 253         debug("Selected vesa mode %#x\n", vesa_mode);
 254         if (emulate) {
 255 #ifdef CONFIG_BIOSEMU
 256                 BE_VGAInfo *info;
 257
 258                 ret = biosemu_setup(dev, &info);
 259                 if (ret)
 260                         return ret;
 261                 biosemu_set_interrupt_handler(0x15, int15_handler);
 262                 ret = biosemu_run(dev, (uchar *)ram, 1 << 16, info, true,
 263                                   vesa_mode, &mode_info);
 264                 if (ret)
 265                         return ret;
 266 #else
 267                 printf("BIOS emulation not available - see CONFIG_BIOSEMU\n");
 268                 return -ENOSYS;
 269 #endif
 270         } else {
 271 #ifdef CONFIG_X86
 272                 bios_set_interrupt_handler(0x15, int15_handler);
 273
 274                 bios_run_on_x86(dev, (unsigned long)ram, vesa_mode,
 275                                 &mode_info);
 276 #else
 277                 printf("BIOS native execution is only available on x86\n");
 278                 return -ENOSYS;
 279 #endif
 280         }
 281         debug("Final vesa mode %#x\n", mode_info.video_mode);
 282
 283         return 0;
 284 }