drivers/bios_emulator/atibios.c

   1 /****************************************************************************
   2 *
   3 *                    Video BOOT Graphics Card POST Module
   4 *
   5 *  ========================================================================
   6 *   Copyright (C) 2007 Freescale Semiconductor, Inc. All rights reserved.
   7 *   Jason Jin <Jason.jin@freescale.com>
   8 *
   9 *   Copyright (C) 1991-2004 SciTech Software, Inc. All rights reserved.
  10 *
  11 *   This file may be distributed and/or modified under the terms of the
  12 *   GNU General Public License version 2.0 as published by the Free
  13 *   Software Foundation and appearing in the file LICENSE.GPL included
  14 *   in the packaging of this file.
  15 *
  16 *   Licensees holding a valid Commercial License for this product from
  17 *   SciTech Software, Inc. may use this file in accordance with the
  18 *   Commercial License Agreement provided with the Software.
  19 *
  20 *   This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING
  21 *   THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22 *   PURPOSE.
  23 *
  24 *   See http://www.scitechsoft.com/license/ for information about
  25 *   the licensing options available and how to purchase a Commercial
  26 *   License Agreement.
  27 *
  28 *   Contact license@scitechsoft.com if any conditions of this licensing
  29 *   are not clear to you, or you have questions about licensing options.
  30 *
  31 *  ========================================================================
  32 *
  33 * Language:     ANSI C
  34 * Environment:  Linux Kernel
  35 * Developer:    Kendall Bennett
  36 *
  37 * Description:  Module to implement booting PCI/AGP controllers on the
  38 *               bus. We use the x86 real mode emulator to run the BIOS on
  39 *               graphics controllers to bring the cards up.
  40 *
  41 *               Note that at present this module does *not* support
  42 *               multiple controllers.
  43 *
  44 *               The orignal name of this file is warmboot.c.
  45 *               Jason ported this file to u-boot to run the ATI video card
  46 *               BIOS in u-boot.
  47 ****************************************************************************/
  48 #include <common.h>
  49 #include "biosemui.h"
  50 #include <malloc.h>
  51
  52 /* Length of the BIOS image */
  53 #define MAX_BIOSLEN         (128 * 1024L)
  54
  55 /* Define some useful types and macros */
  56 #define true                1
  57 #define false               0
  58
  59 /* Place to save PCI BAR's that we change and later restore */
  60 static u32 saveROMBaseAddress;
  61 static u32 saveBaseAddress10;
  62 static u32 saveBaseAddress14;
  63 static u32 saveBaseAddress18;
  64 static u32 saveBaseAddress20;
  65
  66 /****************************************************************************
  67 PARAMETERS:
  68 pcidev  - PCI device info for the video card on the bus to boot
  69 VGAInfo - BIOS emulator VGA info structure
  70
  71 REMARKS:
  72 This function executes the BIOS POST code on the controller. We assume that
  73 at this stage the controller has its I/O and memory space enabled and
  74 that all other controllers are in a disabled state.
  75 ****************************************************************************/
  76 static void PCI_doBIOSPOST(pci_dev_t pcidev, BE_VGAInfo * VGAInfo)
  77 {
  78         RMREGS regs;
  79         RMSREGS sregs;
  80
  81         /* Determine the value to store in AX for BIOS POST. Per the PCI specs,
  82          AH must contain the bus and AL must contain the devfn, encoded as
  83          (dev << 3) | fn
  84          */
  85         memset(&regs, 0, sizeof(regs));
  86         memset(&sregs, 0, sizeof(sregs));
  87         regs.x.ax = ((int)PCI_BUS(pcidev) << 8) |
  88             ((int)PCI_DEV(pcidev) << 3) | (int)PCI_FUNC(pcidev);
  89
  90         /*Setup the X86 emulator for the VGA BIOS*/
  91         BE_setVGA(VGAInfo);
  92
  93         /*Execute the BIOS POST code*/
  94         BE_callRealMode(0xC000, 0x0003, &regs, &sregs);
  95
  96         /*Cleanup and exit*/
  97         BE_getVGA(VGAInfo);
  98 }
  99
 100 /****************************************************************************
 101 PARAMETERS:
 102 pcidev  - PCI device info for the video card on the bus
 103 bar     - Place to return the base address register offset to use
 104
 105 RETURNS:
 106 The address to use to map the secondary BIOS (AGP devices)
 107
 108 REMARKS:
 109 Searches all the PCI base address registers for the device looking for a
 110 memory mapping that is large enough to hold our ROM BIOS. We usually end up
 111 finding the framebuffer mapping (usually BAR 0x10), and we use this mapping
 112 to map the BIOS for the device into. We use a mapping that is already
 113 assigned to the device to ensure the memory range will be passed through
 114 by any PCI->PCI or AGP->PCI bridge that may be present.
 115
 116 NOTE: Usually this function is only used for AGP devices, but it may be
 117       used for PCI devices that have already been POST'ed and the BIOS
 118       ROM base address has been zero'ed out.
 119
 120 NOTE: This function leaves the original memory aperture disabled by leaving
 121       it programmed to all 1's. It must be restored to the correct value
 122       later.
 123 ****************************************************************************/
 124 static u32 PCI_findBIOSAddr(pci_dev_t pcidev, int *bar)
 125 {
 126         u32 base, size;
 127
 128         for (*bar = 0x10; *bar <= 0x14; (*bar) += 4) {
 129                 pci_read_config_dword(pcidev, *bar, &base);
 130                 if (!(base & 0x1)) {
 131                         pci_write_config_dword(pcidev, *bar, 0xFFFFFFFF);
 132                         pci_read_config_dword(pcidev, *bar, &size);
 133                         size = ~(size & ~0xFF) + 1;
 134                         if (size >= MAX_BIOSLEN)
 135                                 return base & ~0xFF;
 136                 }
 137         }
 138         return 0;
 139 }
 140
 141 /****************************************************************************
 142 REMARKS:
 143 Some non-x86 Linux kernels map PCI relocateable I/O to values that
 144 are above 64K, which will not work with the BIOS image that requires
 145 the offset for the I/O ports to be a maximum of 16-bits. Ideally
 146 someone should fix the kernel to map the I/O ports for VGA compatible
 147 devices to a different location (or just all I/O ports since it is
 148 unlikely you can have enough devices in the machine to use up all
 149 64K of the I/O space - a total of more than 256 cards would be
 150 necessary).
 151
 152 Anyway to fix this we change all I/O mapped base registers and
 153 chop off the top bits.
 154 ****************************************************************************/
 155 static void PCI_fixupIObase(pci_dev_t pcidev, int reg, u32 * base)
 156 {
 157         if ((*base & 0x1) && (*base > 0xFFFE)) {
 158                 *base &= 0xFFFF;
 159                 pci_write_config_dword(pcidev, reg, *base);
 160
 161         }
 162 }
 163
 164 /****************************************************************************
 165 PARAMETERS:
 166 pcidev  - PCI device info for the video card on the bus
 167
 168 RETURNS:
 169 Pointers to the mapped BIOS image
 170
 171 REMARKS:
 172 Maps a pointer to the BIOS image on the graphics card on the PCI bus.
 173 ****************************************************************************/
 174 void *PCI_mapBIOSImage(pci_dev_t pcidev)
 175 {
 176         u32 BIOSImagePhys;
 177         int BIOSImageBAR;
 178         u8 *BIOSImage;
 179
 180         /*Save PCI BAR registers that might get changed*/
 181         pci_read_config_dword(pcidev, PCI_ROM_ADDRESS, &saveROMBaseAddress);
 182         pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_0, &saveBaseAddress10);
 183         pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_1, &saveBaseAddress14);
 184         pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_2, &saveBaseAddress18);
 185         pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_4, &saveBaseAddress20);
 186
 187         /*Fix up I/O base registers to less than 64K */
 188         if(saveBaseAddress14 != 0)
 189                 PCI_fixupIObase(pcidev, PCI_BASE_ADDRESS_1, &saveBaseAddress14);
 190         else
 191                 PCI_fixupIObase(pcidev, PCI_BASE_ADDRESS_4, &saveBaseAddress20);
 192
 193         /* Some cards have problems that stop us from being able to read the
 194          BIOS image from the ROM BAR. To fix this we have to do some chipset
 195          specific programming for different cards to solve this problem.
 196         */
 197
 198         if ((BIOSImagePhys = PCI_findBIOSAddr(pcidev, &BIOSImageBAR)) == 0) {
 199                 printf("Find bios addr error\n");
 200                 return NULL;
 201         }
 202
 203         BIOSImage = (u8 *) BIOSImagePhys;
 204
 205         /*Change the PCI BAR registers to map it onto the bus.*/
 206         pci_write_config_dword(pcidev, BIOSImageBAR, 0);
 207         pci_write_config_dword(pcidev, PCI_ROM_ADDRESS, BIOSImagePhys | 0x1);
 208
 209         udelay(1);
 210
 211         /*Check that the BIOS image is valid. If not fail, or return the
 212          compiled in BIOS image if that option was enabled
 213          */
 214         if (BIOSImage[0] != 0x55 || BIOSImage[1] != 0xAA || BIOSImage[2] == 0) {
 215                 return NULL;
 216         }
 217
 218         return BIOSImage;
 219 }
 220
 221 /****************************************************************************
 222 PARAMETERS:
 223 pcidev  - PCI device info for the video card on the bus
 224
 225 REMARKS:
 226 Unmaps the BIOS image for the device and restores framebuffer mappings
 227 ****************************************************************************/
 228 void PCI_unmapBIOSImage(pci_dev_t pcidev, void *BIOSImage)
 229 {
 230         pci_write_config_dword(pcidev, PCI_ROM_ADDRESS, saveROMBaseAddress);
 231         pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_0, saveBaseAddress10);
 232         pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_1, saveBaseAddress14);
 233         pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_2, saveBaseAddress18);
 234         pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_4, saveBaseAddress20);
 235 }
 236
 237 /****************************************************************************
 238 PARAMETERS:
 239 pcidev  - PCI device info for the video card on the bus to boot
 240 VGAInfo - BIOS emulator VGA info structure
 241
 242 RETURNS:
 243 True if successfully initialised, false if not.
 244
 245 REMARKS:
 246 Loads and POST's the display controllers BIOS, directly from the BIOS
 247 image we can extract over the PCI bus.
 248 ****************************************************************************/
 249 static int PCI_postController(pci_dev_t pcidev, BE_VGAInfo * VGAInfo)
 250 {
 251         u32 BIOSImageLen;
 252         uchar *mappedBIOS;
 253         uchar *copyOfBIOS;
 254
 255         /*Allocate memory to store copy of BIOS from display controller*/
 256         if ((mappedBIOS = PCI_mapBIOSImage(pcidev)) == NULL) {
 257                 printf("videoboot: Video ROM failed to map!\n");
 258                 return false;
 259         }
 260
 261         BIOSImageLen = mappedBIOS[2] * 512;
 262
 263         if ((copyOfBIOS = malloc(BIOSImageLen)) == NULL) {
 264                 printf("videoboot: Out of memory!\n");
 265                 return false;
 266         }
 267         memcpy(copyOfBIOS, mappedBIOS, BIOSImageLen);
 268
 269         PCI_unmapBIOSImage(pcidev, mappedBIOS);
 270
 271         /*Save information in VGAInfo structure*/
 272         VGAInfo->function = PCI_FUNC(pcidev);
 273         VGAInfo->device = PCI_DEV(pcidev);
 274         VGAInfo->bus = PCI_BUS(pcidev);
 275         VGAInfo->pcidev = pcidev;
 276         VGAInfo->BIOSImage = copyOfBIOS;
 277         VGAInfo->BIOSImageLen = BIOSImageLen;
 278
 279         /*Now execute the BIOS POST for the device*/
 280         if (copyOfBIOS[0] != 0x55 || copyOfBIOS[1] != 0xAA) {
 281                 printf("videoboot: Video ROM image is invalid!\n");
 282                 return false;
 283         }
 284
 285         PCI_doBIOSPOST(pcidev, VGAInfo);
 286
 287         /*Reset the size of the BIOS image to the final size*/
 288         VGAInfo->BIOSImageLen = copyOfBIOS[2] * 512;
 289         return true;
 290 }
 291
 292 /****************************************************************************
 293 PARAMETERS:
 294 pcidev      - PCI device info for the video card on the bus to boot
 295 pVGAInfo    - Place to return VGA info structure is requested
 296 cleanUp     - True to clean up on exit, false to leave emulator active
 297
 298 REMARKS:
 299 Boots the PCI/AGP video card on the bus using the Video ROM BIOS image
 300 and the X86 BIOS emulator module.
 301 ****************************************************************************/
 302 int BootVideoCardBIOS(pci_dev_t pcidev, BE_VGAInfo ** pVGAInfo, int cleanUp)
 303 {
 304         BE_VGAInfo *VGAInfo;
 305
 306         printf("videoboot: Booting PCI video card bus %d, function %d, device %d\n",
 307              PCI_BUS(pcidev), PCI_FUNC(pcidev), PCI_DEV(pcidev));
 308
 309         /*Initialise the x86 BIOS emulator*/
 310         if ((VGAInfo = malloc(sizeof(*VGAInfo))) == NULL) {
 311                 printf("videoboot: Out of memory!\n");
 312                 return false;
 313         }
 314         memset(VGAInfo, 0, sizeof(*VGAInfo));
 315         BE_init(0, 65536, VGAInfo, 0);
 316
 317         /*Post all the display controller BIOS'es*/
 318         PCI_postController(pcidev, VGAInfo);
 319
 320         /*Cleanup and exit the emulator if requested. If the BIOS emulator
 321         is needed after booting the card, we will not call BE_exit and
 322         leave it enabled for further use (ie: VESA driver etc).
 323         */
 324         if (cleanUp) {
 325                 BE_exit();
 326                 if (VGAInfo->BIOSImage)
 327                         free(VGAInfo->BIOSImage);
 328                 free(VGAInfo);
 329                 VGAInfo = NULL;
 330         }
 331         /*Return VGA info pointer if the caller requested it*/
 332         if (pVGAInfo)
 333                 *pVGAInfo = VGAInfo;
 334         return true;
 335 }