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 <dm.h>
  29 #include <errno.h>
  30 #include <malloc.h>
  31 #include <pci.h>
  32 #include <pci_rom.h>
  33 #include <vbe.h>
  34 #include <video_fb.h>
  35 #include <linux/screen_info.h>
  36
  37 __weak bool board_should_run_oprom(struct udevice *dev)
  38 {
  39         return true;
  40 }
  41
  42 static bool should_load_oprom(struct udevice *dev)
  43 {
  44         if (IS_ENABLED(CONFIG_ALWAYS_LOAD_OPROM))
  45                 return 1;
  46         if (board_should_run_oprom(dev))
  47                 return 1;
  48
  49         return 0;
  50 }
  51
  52 __weak uint32_t board_map_oprom_vendev(uint32_t vendev)
  53 {
  54         return vendev;
  55 }
  56
  57 static int pci_rom_probe(struct udevice *dev, struct pci_rom_header **hdrp)
  58 {
  59         struct pci_child_platdata *pplat = dev_get_parent_platdata(dev);
  60         struct pci_rom_header *rom_header;
  61         struct pci_rom_data *rom_data;
  62         u16 rom_vendor, rom_device;
  63         u32 rom_class;
  64         u32 vendev;
  65         u32 mapped_vendev;
  66         u32 rom_address;
  67
  68         vendev = pplat->vendor << 16 | pplat->device;
  69         mapped_vendev = board_map_oprom_vendev(vendev);
  70         if (vendev != mapped_vendev)
  71                 debug("Device ID mapped to %#08x\n", mapped_vendev);
  72
  73 #ifdef CONFIG_VGA_BIOS_ADDR
  74         rom_address = CONFIG_VGA_BIOS_ADDR;
  75 #else
  76
  77         dm_pci_read_config32(dev, PCI_ROM_ADDRESS, &rom_address);
  78         if (rom_address == 0x00000000 || rom_address == 0xffffffff) {
  79                 debug("%s: rom_address=%x\n", __func__, rom_address);
  80                 return -ENOENT;
  81         }
  82
  83         /* Enable expansion ROM address decoding. */
  84         dm_pci_write_config32(dev, PCI_ROM_ADDRESS,
  85                               rom_address | PCI_ROM_ADDRESS_ENABLE);
  86 #endif
  87         debug("Option ROM address %x\n", rom_address);
  88         rom_header = (struct pci_rom_header *)(unsigned long)rom_address;
  89
  90         debug("PCI expansion ROM, signature %#04x, INIT size %#04x, data ptr %#04x\n",
  91               le16_to_cpu(rom_header->signature),
  92               rom_header->size * 512, le16_to_cpu(rom_header->data));
  93
  94         if (le16_to_cpu(rom_header->signature) != PCI_ROM_HDR) {
  95                 printf("Incorrect expansion ROM header signature %04x\n",
  96                        le16_to_cpu(rom_header->signature));
  97 #ifndef CONFIG_VGA_BIOS_ADDR
  98                 /* Disable expansion ROM address decoding */
  99                 dm_pci_write_config32(dev, PCI_ROM_ADDRESS, rom_address);
 100 #endif
 101                 return -EINVAL;
 102         }
 103
 104         rom_data = (((void *)rom_header) + le16_to_cpu(rom_header->data));
 105         rom_vendor = le16_to_cpu(rom_data->vendor);
 106         rom_device = le16_to_cpu(rom_data->device);
 107
 108         debug("PCI ROM image, vendor ID %04x, device ID %04x,\n",
 109               rom_vendor, rom_device);
 110
 111         /* If the device id is mapped, a mismatch is expected */
 112         if ((pplat->vendor != rom_vendor || pplat->device != rom_device) &&
 113             (vendev == mapped_vendev)) {
 114                 printf("ID mismatch: vendor ID %04x, device ID %04x\n",
 115                        rom_vendor, rom_device);
 116                 /* Continue anyway */
 117         }
 118
 119         rom_class = (le16_to_cpu(rom_data->class_hi) << 8) | rom_data->class_lo;
 120         debug("PCI ROM image, Class Code %06x, Code Type %02x\n",
 121               rom_class, rom_data->type);
 122
 123         if (pplat->class != rom_class) {
 124                 debug("Class Code mismatch ROM %06x, dev %06x\n",
 125                       rom_class, pplat->class);
 126         }
 127         *hdrp = rom_header;
 128
 129         return 0;
 130 }
 131
 132 /**
 133  * pci_rom_load() - Load a ROM image and return a pointer to it
 134  *
 135  * @rom_header:         Pointer to ROM image
 136  * @ram_headerp:        Returns a pointer to the image in RAM
 137  * @allocedp:           Returns true if @ram_headerp was allocated and needs
 138  *                      to be freed
 139  * @return 0 if OK, -ve on error. Note that @allocedp is set up regardless of
 140  * the error state. Even if this function returns an error, it may have
 141  * allocated memory.
 142  */
 143 static int pci_rom_load(struct pci_rom_header *rom_header,
 144                         struct pci_rom_header **ram_headerp, bool *allocedp)
 145 {
 146         struct pci_rom_data *rom_data;
 147         unsigned int rom_size;
 148         unsigned int image_size = 0;
 149         void *target;
 150
 151         *allocedp = false;
 152         do {
 153                 /* Get next image, until we see an x86 version */
 154                 rom_header = (struct pci_rom_header *)((void *)rom_header +
 155                                                             image_size);
 156
 157                 rom_data = (struct pci_rom_data *)((void *)rom_header +
 158                                 le16_to_cpu(rom_header->data));
 159
 160                 image_size = le16_to_cpu(rom_data->ilen) * 512;
 161         } while ((rom_data->type != 0) && (rom_data->indicator == 0));
 162
 163         if (rom_data->type != 0)
 164                 return -EACCES;
 165
 166         rom_size = rom_header->size * 512;
 167
 168 #ifdef PCI_VGA_RAM_IMAGE_START
 169         target = (void *)PCI_VGA_RAM_IMAGE_START;
 170 #else
 171         target = (void *)malloc(rom_size);
 172         if (!target)
 173                 return -ENOMEM;
 174         *allocedp = true;
 175 #endif
 176         if (target != rom_header) {
 177                 ulong start = get_timer(0);
 178
 179                 debug("Copying VGA ROM Image from %p to %p, 0x%x bytes\n",
 180                       rom_header, target, rom_size);
 181                 memcpy(target, rom_header, rom_size);
 182                 if (memcmp(target, rom_header, rom_size)) {
 183                         printf("VGA ROM copy failed\n");
 184                         return -EFAULT;
 185                 }
 186                 debug("Copy took %lums\n", get_timer(start));
 187         }
 188         *ram_headerp = target;
 189
 190         return 0;
 191 }
 192
 193 struct vbe_mode_info mode_info;
 194
 195 int vbe_get_video_info(struct graphic_device *gdev)
 196 {
 197 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
 198         struct vesa_mode_info *vesa = &mode_info.vesa;
 199
 200         gdev->winSizeX = vesa->x_resolution;
 201         gdev->winSizeY = vesa->y_resolution;
 202
 203         gdev->plnSizeX = vesa->x_resolution;
 204         gdev->plnSizeY = vesa->y_resolution;
 205
 206         gdev->gdfBytesPP = vesa->bits_per_pixel / 8;
 207
 208         switch (vesa->bits_per_pixel) {
 209         case 32:
 210         case 24:
 211                 gdev->gdfIndex = GDF_32BIT_X888RGB;
 212                 break;
 213         case 16:
 214                 gdev->gdfIndex = GDF_16BIT_565RGB;
 215                 break;
 216         default:
 217                 gdev->gdfIndex = GDF__8BIT_INDEX;
 218                 break;
 219         }
 220
 221         gdev->isaBase = CONFIG_SYS_ISA_IO_BASE_ADDRESS;
 222         gdev->pciBase = vesa->phys_base_ptr;
 223
 224         gdev->frameAdrs = vesa->phys_base_ptr;
 225         gdev->memSize = vesa->bytes_per_scanline * vesa->y_resolution;
 226
 227         gdev->vprBase = vesa->phys_base_ptr;
 228         gdev->cprBase = vesa->phys_base_ptr;
 229
 230         return gdev->winSizeX ? 0 : -ENOSYS;
 231 #else
 232         return -ENOSYS;
 233 #endif
 234 }
 235
 236 void setup_video(struct screen_info *screen_info)
 237 {
 238         struct vesa_mode_info *vesa = &mode_info.vesa;
 239
 240         /* Sanity test on VESA parameters */
 241         if (!vesa->x_resolution || !vesa->y_resolution)
 242                 return;
 243
 244         screen_info->orig_video_isVGA = VIDEO_TYPE_VLFB;
 245
 246         screen_info->lfb_width = vesa->x_resolution;
 247         screen_info->lfb_height = vesa->y_resolution;
 248         screen_info->lfb_depth = vesa->bits_per_pixel;
 249         screen_info->lfb_linelength = vesa->bytes_per_scanline;
 250         screen_info->lfb_base = vesa->phys_base_ptr;
 251         screen_info->lfb_size =
 252                 ALIGN(screen_info->lfb_linelength * screen_info->lfb_height,
 253                       65536);
 254         screen_info->lfb_size >>= 16;
 255         screen_info->red_size = vesa->red_mask_size;
 256         screen_info->red_pos = vesa->red_mask_pos;
 257         screen_info->green_size = vesa->green_mask_size;
 258         screen_info->green_pos = vesa->green_mask_pos;
 259         screen_info->blue_size = vesa->blue_mask_size;
 260         screen_info->blue_pos = vesa->blue_mask_pos;
 261         screen_info->rsvd_size = vesa->reserved_mask_size;
 262         screen_info->rsvd_pos = vesa->reserved_mask_pos;
 263 }
 264
 265 int dm_pci_run_vga_bios(struct udevice *dev, int (*int15_handler)(void),
 266                         int exec_method)
 267 {
 268         struct pci_child_platdata *pplat = dev_get_parent_platdata(dev);
 269         struct pci_rom_header *rom = NULL, *ram = NULL;
 270         int vesa_mode = -1;
 271         bool emulate, alloced;
 272         int ret;
 273
 274         /* Only execute VGA ROMs */
 275         if (((pplat->class >> 8) ^ PCI_CLASS_DISPLAY_VGA) & 0xff00) {
 276                 debug("%s: Class %#x, should be %#x\n", __func__, pplat->class,
 277                       PCI_CLASS_DISPLAY_VGA);
 278                 return -ENODEV;
 279         }
 280
 281         if (!should_load_oprom(dev))
 282                 return -ENXIO;
 283
 284         ret = pci_rom_probe(dev, &rom);
 285         if (ret)
 286                 return ret;
 287
 288         ret = pci_rom_load(rom, &ram, &alloced);
 289         if (ret)
 290                 goto err;
 291
 292         if (!board_should_run_oprom(dev)) {
 293                 ret = -ENXIO;
 294                 goto err;
 295         }
 296
 297 #if defined(CONFIG_FRAMEBUFFER_SET_VESA_MODE) && \
 298                 defined(CONFIG_FRAMEBUFFER_VESA_MODE)
 299         vesa_mode = CONFIG_FRAMEBUFFER_VESA_MODE;
 300 #endif
 301         debug("Selected vesa mode %#x\n", vesa_mode);
 302
 303         if (exec_method & PCI_ROM_USE_NATIVE) {
 304 #ifdef CONFIG_X86
 305                 emulate = false;
 306 #else
 307                 if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
 308                         printf("BIOS native execution is only available on x86\n");
 309                         ret = -ENOSYS;
 310                         goto err;
 311                 }
 312                 emulate = true;
 313 #endif
 314         } else {
 315 #ifdef CONFIG_BIOSEMU
 316                 emulate = true;
 317 #else
 318                 if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
 319                         printf("BIOS emulation not available - see CONFIG_BIOSEMU\n");
 320                         ret = -ENOSYS;
 321                         goto err;
 322                 }
 323                 emulate = false;
 324 #endif
 325         }
 326
 327         if (emulate) {
 328 #ifdef CONFIG_BIOSEMU
 329                 BE_VGAInfo *info;
 330
 331                 ret = biosemu_setup(dev, &info);
 332                 if (ret)
 333                         goto err;
 334                 biosemu_set_interrupt_handler(0x15, int15_handler);
 335                 ret = biosemu_run(dev, (uchar *)ram, 1 << 16, info,
 336                                   true, vesa_mode, &mode_info);
 337                 if (ret)
 338                         goto err;
 339 #endif
 340         } else {
 341 #ifdef CONFIG_X86
 342                 bios_set_interrupt_handler(0x15, int15_handler);
 343
 344                 bios_run_on_x86(dev, (unsigned long)ram, vesa_mode,
 345                                 &mode_info);
 346 #endif
 347         }
 348         debug("Final vesa mode %#x\n", mode_info.video_mode);
 349         ret = 0;
 350
 351 err:
 352         if (alloced)
 353                 free(ram);
 354         return ret;
 355 }