drivers/pci/pci_rom.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2014 Google, Inc
   4  *
   5  * From coreboot, originally based on the Linux kernel (drivers/pci/pci.c).
   6  *
   7  * Modifications are:
   8  * Copyright (C) 2003-2004 Linux Networx
   9  * (Written by Eric Biederman <ebiederman@lnxi.com> for Linux Networx)
  10  * Copyright (C) 2003-2006 Ronald G. Minnich <rminnich@gmail.com>
  11  * Copyright (C) 2004-2005 Li-Ta Lo <ollie@lanl.gov>
  12  * Copyright (C) 2005-2006 Tyan
  13  * (Written by Yinghai Lu <yhlu@tyan.com> for Tyan)
  14  * Copyright (C) 2005-2009 coresystems GmbH
  15  * (Written by Stefan Reinauer <stepan@coresystems.de> for coresystems GmbH)
  16  *
  17  * PCI Bus Services, see include/linux/pci.h for further explanation.
  18  *
  19  * Copyright 1993 -- 1997 Drew Eckhardt, Frederic Potter,
  20  * David Mosberger-Tang
  21  *
  22  * Copyright 1997 -- 1999 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
  23  */
  24
  25 #define LOG_CATEGORY UCLASS_PCI
  26
  27 #include <common.h>
  28 #include <bios_emul.h>
  29 #include <bootstage.h>
  30 #include <dm.h>
  31 #include <errno.h>
  32 #include <init.h>
  33 #include <log.h>
  34 #include <malloc.h>
  35 #include <pci.h>
  36 #include <pci_rom.h>
  37 #include <vbe.h>
  38 #include <video.h>
  39 #include <video_fb.h>
  40 #include <acpi/acpi_s3.h>
  41 #include <asm/global_data.h>
  42 #include <linux/screen_info.h>
  43
  44 DECLARE_GLOBAL_DATA_PTR;
  45
  46 __weak bool board_should_run_oprom(struct udevice *dev)
  47 {
  48 #if defined(CONFIG_X86) && defined(CONFIG_HAVE_ACPI_RESUME)
  49         if (gd->arch.prev_sleep_state == ACPI_S3) {
  50                 if (IS_ENABLED(CONFIG_S3_VGA_ROM_RUN))
  51                         return true;
  52                 else
  53                         return false;
  54         }
  55 #endif
  56
  57         return true;
  58 }
  59
  60 __weak bool board_should_load_oprom(struct udevice *dev)
  61 {
  62         return true;
  63 }
  64
  65 __weak uint32_t board_map_oprom_vendev(uint32_t vendev)
  66 {
  67         return vendev;
  68 }
  69
  70 static int pci_rom_probe(struct udevice *dev, struct pci_rom_header **hdrp)
  71 {
  72         struct pci_child_plat *pplat = dev_get_parent_plat(dev);
  73         struct pci_rom_header *rom_header;
  74         struct pci_rom_data *rom_data;
  75         u16 rom_vendor, rom_device;
  76         u32 rom_class;
  77         u32 vendev;
  78         u32 mapped_vendev;
  79         u32 rom_address;
  80
  81         vendev = pplat->vendor << 16 | pplat->device;
  82         mapped_vendev = board_map_oprom_vendev(vendev);
  83         if (vendev != mapped_vendev)
  84                 debug("Device ID mapped to %#08x\n", mapped_vendev);
  85
  86 #ifdef CONFIG_VGA_BIOS_ADDR
  87         rom_address = CONFIG_VGA_BIOS_ADDR;
  88 #else
  89
  90         dm_pci_read_config32(dev, PCI_ROM_ADDRESS, &rom_address);
  91         if (rom_address == 0x00000000 || rom_address == 0xffffffff) {
  92                 debug("%s: rom_address=%x\n", __func__, rom_address);
  93                 return -ENOENT;
  94         }
  95
  96         /* Enable expansion ROM address decoding. */
  97         dm_pci_write_config32(dev, PCI_ROM_ADDRESS,
  98                               rom_address | PCI_ROM_ADDRESS_ENABLE);
  99 #endif
 100         debug("Option ROM address %x\n", rom_address);
 101         rom_header = (struct pci_rom_header *)(unsigned long)rom_address;
 102
 103         debug("PCI expansion ROM, signature %#04x, INIT size %#04x, data ptr %#04x\n",
 104               le16_to_cpu(rom_header->signature),
 105               rom_header->size * 512, le16_to_cpu(rom_header->data));
 106
 107         if (le16_to_cpu(rom_header->signature) != PCI_ROM_HDR) {
 108                 printf("Incorrect expansion ROM header signature %04x\n",
 109                        le16_to_cpu(rom_header->signature));
 110 #ifndef CONFIG_VGA_BIOS_ADDR
 111                 /* Disable expansion ROM address decoding */
 112                 dm_pci_write_config32(dev, PCI_ROM_ADDRESS, rom_address);
 113 #endif
 114                 return -EINVAL;
 115         }
 116
 117         rom_data = (((void *)rom_header) + le16_to_cpu(rom_header->data));
 118         rom_vendor = le16_to_cpu(rom_data->vendor);
 119         rom_device = le16_to_cpu(rom_data->device);
 120
 121         debug("PCI ROM image, vendor ID %04x, device ID %04x,\n",
 122               rom_vendor, rom_device);
 123
 124         /* If the device id is mapped, a mismatch is expected */
 125         if ((pplat->vendor != rom_vendor || pplat->device != rom_device) &&
 126             (vendev == mapped_vendev)) {
 127                 printf("ID mismatch: vendor ID %04x, device ID %04x\n",
 128                        rom_vendor, rom_device);
 129                 /* Continue anyway */
 130         }
 131
 132         rom_class = (le16_to_cpu(rom_data->class_hi) << 8) | rom_data->class_lo;
 133         debug("PCI ROM image, Class Code %06x, Code Type %02x\n",
 134               rom_class, rom_data->type);
 135
 136         if (pplat->class != rom_class) {
 137                 debug("Class Code mismatch ROM %06x, dev %06x\n",
 138                       rom_class, pplat->class);
 139         }
 140         *hdrp = rom_header;
 141
 142         return 0;
 143 }
 144
 145 /**
 146  * pci_rom_load() - Load a ROM image and return a pointer to it
 147  *
 148  * @rom_header:         Pointer to ROM image
 149  * @ram_headerp:        Returns a pointer to the image in RAM
 150  * @allocedp:           Returns true if @ram_headerp was allocated and needs
 151  *                      to be freed
 152  * Return: 0 if OK, -ve on error. Note that @allocedp is set up regardless of
 153  * the error state. Even if this function returns an error, it may have
 154  * allocated memory.
 155  */
 156 static int pci_rom_load(struct pci_rom_header *rom_header,
 157                         struct pci_rom_header **ram_headerp, bool *allocedp)
 158 {
 159         struct pci_rom_data *rom_data;
 160         unsigned int rom_size;
 161         unsigned int image_size = 0;
 162         void *target;
 163
 164         *allocedp = false;
 165         do {
 166                 /* Get next image, until we see an x86 version */
 167                 rom_header = (struct pci_rom_header *)((void *)rom_header +
 168                                                             image_size);
 169
 170                 rom_data = (struct pci_rom_data *)((void *)rom_header +
 171                                 le16_to_cpu(rom_header->data));
 172
 173                 image_size = le16_to_cpu(rom_data->ilen) * 512;
 174         } while ((rom_data->type != 0) && (rom_data->indicator == 0));
 175
 176         if (rom_data->type != 0)
 177                 return -EACCES;
 178
 179         rom_size = rom_header->size * 512;
 180
 181 #ifdef PCI_VGA_RAM_IMAGE_START
 182         target = (void *)PCI_VGA_RAM_IMAGE_START;
 183 #else
 184         target = (void *)malloc(rom_size);
 185         if (!target)
 186                 return -ENOMEM;
 187         *allocedp = true;
 188 #endif
 189         if (target != rom_header) {
 190                 ulong start = get_timer(0);
 191
 192                 debug("Copying VGA ROM Image from %p to %p, 0x%x bytes\n",
 193                       rom_header, target, rom_size);
 194                 memcpy(target, rom_header, rom_size);
 195                 if (memcmp(target, rom_header, rom_size)) {
 196                         printf("VGA ROM copy failed\n");
 197                         return -EFAULT;
 198                 }
 199                 debug("Copy took %lums\n", get_timer(start));
 200         }
 201         *ram_headerp = target;
 202
 203         return 0;
 204 }
 205
 206 struct vbe_mode_info mode_info;
 207
 208 void setup_video(struct screen_info *screen_info)
 209 {
 210         struct vesa_mode_info *vesa = &mode_info.vesa;
 211
 212         /* Sanity test on VESA parameters */
 213         if (!vesa->x_resolution || !vesa->y_resolution)
 214                 return;
 215
 216         screen_info->orig_video_isVGA = VIDEO_TYPE_VLFB;
 217
 218         screen_info->lfb_width = vesa->x_resolution;
 219         screen_info->lfb_height = vesa->y_resolution;
 220         screen_info->lfb_depth = vesa->bits_per_pixel;
 221         screen_info->lfb_linelength = vesa->bytes_per_scanline;
 222         screen_info->lfb_base = vesa->phys_base_ptr;
 223         screen_info->lfb_size =
 224                 ALIGN(screen_info->lfb_linelength * screen_info->lfb_height,
 225                       65536);
 226         screen_info->lfb_size >>= 16;
 227         screen_info->red_size = vesa->red_mask_size;
 228         screen_info->red_pos = vesa->red_mask_pos;
 229         screen_info->green_size = vesa->green_mask_size;
 230         screen_info->green_pos = vesa->green_mask_pos;
 231         screen_info->blue_size = vesa->blue_mask_size;
 232         screen_info->blue_pos = vesa->blue_mask_pos;
 233         screen_info->rsvd_size = vesa->reserved_mask_size;
 234         screen_info->rsvd_pos = vesa->reserved_mask_pos;
 235 }
 236
 237 int dm_pci_run_vga_bios(struct udevice *dev, int (*int15_handler)(void),
 238                         int exec_method)
 239 {
 240         struct pci_child_plat *pplat = dev_get_parent_plat(dev);
 241         struct pci_rom_header *rom = NULL, *ram = NULL;
 242         int vesa_mode = -1;
 243         bool emulate, alloced;
 244         int ret;
 245
 246         /* Only execute VGA ROMs */
 247         if (((pplat->class >> 8) ^ PCI_CLASS_DISPLAY_VGA) & 0xff00) {
 248                 debug("%s: Class %#x, should be %#x\n", __func__, pplat->class,
 249                       PCI_CLASS_DISPLAY_VGA);
 250                 return -ENODEV;
 251         }
 252
 253         if (!board_should_load_oprom(dev))
 254                 return log_msg_ret("Should not load OPROM", -ENXIO);
 255
 256         ret = pci_rom_probe(dev, &rom);
 257         if (ret)
 258                 return ret;
 259
 260         ret = pci_rom_load(rom, &ram, &alloced);
 261         if (ret)
 262                 goto err;
 263
 264         if (!board_should_run_oprom(dev)) {
 265                 ret = -ENXIO;
 266                 goto err;
 267         }
 268
 269 #if defined(CONFIG_FRAMEBUFFER_SET_VESA_MODE) && \
 270                 defined(CONFIG_FRAMEBUFFER_VESA_MODE)
 271         vesa_mode = CONFIG_FRAMEBUFFER_VESA_MODE;
 272 #endif
 273         debug("Selected vesa mode %#x\n", vesa_mode);
 274
 275         if (exec_method & PCI_ROM_USE_NATIVE) {
 276 #ifdef CONFIG_X86
 277                 emulate = false;
 278 #else
 279                 if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
 280                         printf("BIOS native execution is only available on x86\n");
 281                         ret = -ENOSYS;
 282                         goto err;
 283                 }
 284                 emulate = true;
 285 #endif
 286         } else {
 287 #ifdef CONFIG_BIOSEMU
 288                 emulate = true;
 289 #else
 290                 if (!(exec_method & PCI_ROM_ALLOW_FALLBACK)) {
 291                         printf("BIOS emulation not available - see CONFIG_BIOSEMU\n");
 292                         ret = -ENOSYS;
 293                         goto err;
 294                 }
 295                 emulate = false;
 296 #endif
 297         }
 298
 299         if (emulate) {
 300 #ifdef CONFIG_BIOSEMU
 301                 BE_VGAInfo *info;
 302
 303                 ret = biosemu_setup(dev, &info);
 304                 if (ret)
 305                         goto err;
 306                 biosemu_set_interrupt_handler(0x15, int15_handler);
 307                 ret = biosemu_run(dev, (uchar *)ram, 1 << 16, info,
 308                                   true, vesa_mode, &mode_info);
 309                 if (ret)
 310                         goto err;
 311 #endif
 312         } else {
 313 #if defined(CONFIG_X86) && (CONFIG_IS_ENABLED(X86_32BIT_INIT) || CONFIG_TPL)
 314                 bios_set_interrupt_handler(0x15, int15_handler);
 315
 316                 bios_run_on_x86(dev, (unsigned long)ram, vesa_mode,
 317                                 &mode_info);
 318 #endif
 319         }
 320         debug("Final vesa mode %#x\n", mode_info.video_mode);
 321         ret = 0;
 322
 323 err:
 324         if (alloced)
 325                 free(ram);
 326         return ret;
 327 }
 328
 329 #ifdef CONFIG_DM_VIDEO
 330 int vbe_setup_video_priv(struct vesa_mode_info *vesa,
 331                          struct video_priv *uc_priv,
 332                          struct video_uc_plat *plat)
 333 {
 334         if (!vesa->x_resolution)
 335                 return log_msg_ret("No x resolution", -ENXIO);
 336         uc_priv->xsize = vesa->x_resolution;
 337         uc_priv->ysize = vesa->y_resolution;
 338         uc_priv->line_length = vesa->bytes_per_scanline;
 339         switch (vesa->bits_per_pixel) {
 340         case 32:
 341         case 24:
 342                 uc_priv->bpix = VIDEO_BPP32;
 343                 break;
 344         case 16:
 345                 uc_priv->bpix = VIDEO_BPP16;
 346                 break;
 347         default:
 348                 return -EPROTONOSUPPORT;
 349         }
 350
 351         /* Use double buffering if enabled */
 352         if (IS_ENABLED(CONFIG_VIDEO_COPY) && plat->base)
 353                 plat->copy_base = vesa->phys_base_ptr;
 354         else
 355                 plat->base = vesa->phys_base_ptr;
 356         log_debug("base = %lx, copy_base = %lx\n", plat->base, plat->copy_base);
 357         plat->size = vesa->bytes_per_scanline * vesa->y_resolution;
 358
 359         return 0;
 360 }
 361
 362 int vbe_setup_video(struct udevice *dev, int (*int15_handler)(void))
 363 {
 364         struct video_uc_plat *plat = dev_get_uclass_plat(dev);
 365         struct video_priv *uc_priv = dev_get_uclass_priv(dev);
 366         int ret;
 367
 368         /* If we are running from EFI or coreboot, this can't work */
 369         if (!ll_boot_init()) {
 370                 printf("Not available (previous bootloader prevents it)\n");
 371                 return -EPERM;
 372         }
 373         bootstage_start(BOOTSTAGE_ID_ACCUM_LCD, "vesa display");
 374         ret = dm_pci_run_vga_bios(dev, int15_handler, PCI_ROM_USE_NATIVE |
 375                                         PCI_ROM_ALLOW_FALLBACK);
 376         bootstage_accum(BOOTSTAGE_ID_ACCUM_LCD);
 377         if (ret) {
 378                 debug("failed to run video BIOS: %d\n", ret);
 379                 return ret;
 380         }
 381
 382         ret = vbe_setup_video_priv(&mode_info.vesa, uc_priv, plat);
 383         if (ret) {
 384                 if (ret == -ENFILE) {
 385                         /*
 386                          * See video-uclass.c for how to set up reserved memory
 387                          * in your video driver
 388                          */
 389                         log_err("CONFIG_VIDEO_COPY enabled but driver '%s' set up no reserved memory\n",
 390                                 dev->driver->name);
 391                 }
 392
 393                 debug("No video mode configured\n");
 394                 return ret;
 395         }
 396
 397         printf("Video: %dx%dx%d\n", uc_priv->xsize, uc_priv->ysize,
 398                mode_info.vesa.bits_per_pixel);
 399
 400         return 0;
 401 }
 402 #endif