1 /****************************************************************************
3 * Video BOOT Graphics Card POST Module
5 * ========================================================================
6 * Copyright (C) 2007 Freescale Semiconductor, Inc.
7 * Jason Jin <Jason.jin@freescale.com>
9 * Copyright (C) 1991-2004 SciTech Software, Inc. All rights reserved.
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.
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.
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
24 * See http://www.scitechsoft.com/license/ for information about
25 * the licensing options available and how to purchase a Commercial
28 * Contact license@scitechsoft.com if any conditions of this licensing
29 * are not clear to you, or you have questions about licensing options.
31 * ========================================================================
34 * Environment: Linux Kernel
35 * Developer: Kendall Bennett
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.
41 * Note that at present this module does *not* support
42 * multiple controllers.
44 * The orignal name of this file is warmboot.c.
45 * Jason ported this file to u-boot to run the ATI video card
47 ****************************************************************************/
49 #include <bios_emul.h>
55 /* Length of the BIOS image */
56 #define MAX_BIOSLEN (128 * 1024L)
58 /* Place to save PCI BAR's that we change and later restore */
59 static u32 saveROMBaseAddress;
60 static u32 saveBaseAddress10;
61 static u32 saveBaseAddress14;
62 static u32 saveBaseAddress18;
63 static u32 saveBaseAddress20;
65 static void atibios_set_vesa_mode(RMREGS *regs, int vesa_mode,
66 struct vbe_mode_info *mode_info)
68 debug("VBE: Setting VESA mode %#04x\n", vesa_mode);
69 /* request linear framebuffer mode */
70 vesa_mode |= (1 << 14);
71 /* request clearing of framebuffer */
72 vesa_mode &= ~(1 << 15);
73 regs->e.eax = VESA_SET_MODE;
74 regs->e.ebx = vesa_mode;
75 BE_int86(0x10, regs, regs);
78 void *buffer = (void *)(M.mem_base + offset);
80 u16 buffer_seg = (((unsigned long)offset) >> 4) & 0xff00;
81 u16 buffer_adr = ((unsigned long)offset) & 0xffff;
82 regs->e.eax = VESA_GET_MODE_INFO;
84 regs->e.ecx = vesa_mode;
86 regs->e.esi = buffer_seg;
87 regs->e.edi = buffer_adr;
88 BE_int86(0x10, regs, regs);
89 memcpy(mode_info->mode_info_block, buffer,
90 sizeof(struct vbe_mode_info));
91 mode_info->valid = true;
93 vesa_mode |= (1 << 14);
94 /* request clearing of framebuffer */
95 vesa_mode &= ~(1 << 15);
96 regs->e.eax = VESA_SET_MODE;
97 regs->e.ebx = vesa_mode;
98 BE_int86(0x10, regs, regs);
101 /****************************************************************************
103 pcidev - PCI device info for the video card on the bus to boot
104 vga_info - BIOS emulator VGA info structure
107 This function executes the BIOS POST code on the controller. We assume that
108 at this stage the controller has its I/O and memory space enabled and
109 that all other controllers are in a disabled state.
110 ****************************************************************************/
111 static void PCI_doBIOSPOST(pci_dev_t pcidev, BE_VGAInfo *vga_info,
112 int vesa_mode, struct vbe_mode_info *mode_info)
117 /* Determine the value to store in AX for BIOS POST. Per the PCI specs,
118 AH must contain the bus and AL must contain the devfn, encoded as
121 memset(®s, 0, sizeof(regs));
122 memset(&sregs, 0, sizeof(sregs));
123 regs.x.ax = ((int)PCI_BUS(pcidev) << 8) |
124 ((int)PCI_DEV(pcidev) << 3) | (int)PCI_FUNC(pcidev);
126 /*Setup the X86 emulator for the VGA BIOS*/
129 /*Execute the BIOS POST code*/
130 BE_callRealMode(0xC000, 0x0003, ®s, &sregs);
136 atibios_set_vesa_mode(®s, vesa_mode, mode_info);
139 /****************************************************************************
141 pcidev - PCI device info for the video card on the bus
142 bar - Place to return the base address register offset to use
145 The address to use to map the secondary BIOS (AGP devices)
148 Searches all the PCI base address registers for the device looking for a
149 memory mapping that is large enough to hold our ROM BIOS. We usually end up
150 finding the framebuffer mapping (usually BAR 0x10), and we use this mapping
151 to map the BIOS for the device into. We use a mapping that is already
152 assigned to the device to ensure the memory range will be passed through
153 by any PCI->PCI or AGP->PCI bridge that may be present.
155 NOTE: Usually this function is only used for AGP devices, but it may be
156 used for PCI devices that have already been POST'ed and the BIOS
157 ROM base address has been zero'ed out.
159 NOTE: This function leaves the original memory aperture disabled by leaving
160 it programmed to all 1's. It must be restored to the correct value
162 ****************************************************************************/
163 static u32 PCI_findBIOSAddr(pci_dev_t pcidev, int *bar)
167 for (*bar = 0x10; *bar <= 0x14; (*bar) += 4) {
168 pci_read_config_dword(pcidev, *bar, &base);
170 pci_write_config_dword(pcidev, *bar, 0xFFFFFFFF);
171 pci_read_config_dword(pcidev, *bar, &size);
172 size = ~(size & ~0xFF) + 1;
173 if (size >= MAX_BIOSLEN)
180 /****************************************************************************
182 Some non-x86 Linux kernels map PCI relocateable I/O to values that
183 are above 64K, which will not work with the BIOS image that requires
184 the offset for the I/O ports to be a maximum of 16-bits. Ideally
185 someone should fix the kernel to map the I/O ports for VGA compatible
186 devices to a different location (or just all I/O ports since it is
187 unlikely you can have enough devices in the machine to use up all
188 64K of the I/O space - a total of more than 256 cards would be
191 Anyway to fix this we change all I/O mapped base registers and
192 chop off the top bits.
193 ****************************************************************************/
194 static void PCI_fixupIObase(pci_dev_t pcidev, int reg, u32 * base)
196 if ((*base & 0x1) && (*base > 0xFFFE)) {
198 pci_write_config_dword(pcidev, reg, *base);
203 /****************************************************************************
205 pcidev - PCI device info for the video card on the bus
208 Pointers to the mapped BIOS image
211 Maps a pointer to the BIOS image on the graphics card on the PCI bus.
212 ****************************************************************************/
213 void *PCI_mapBIOSImage(pci_dev_t pcidev)
219 /*Save PCI BAR registers that might get changed*/
220 pci_read_config_dword(pcidev, PCI_ROM_ADDRESS, &saveROMBaseAddress);
221 pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_0, &saveBaseAddress10);
222 pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_1, &saveBaseAddress14);
223 pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_2, &saveBaseAddress18);
224 pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_4, &saveBaseAddress20);
226 /*Fix up I/O base registers to less than 64K */
227 if(saveBaseAddress14 != 0)
228 PCI_fixupIObase(pcidev, PCI_BASE_ADDRESS_1, &saveBaseAddress14);
230 PCI_fixupIObase(pcidev, PCI_BASE_ADDRESS_4, &saveBaseAddress20);
232 /* Some cards have problems that stop us from being able to read the
233 BIOS image from the ROM BAR. To fix this we have to do some chipset
234 specific programming for different cards to solve this problem.
237 BIOSImageBus = PCI_findBIOSAddr(pcidev, &BIOSImageBAR);
238 if (BIOSImageBus == 0) {
239 printf("Find bios addr error\n");
243 BIOSImage = pci_bus_to_virt(pcidev, BIOSImageBus,
244 PCI_REGION_MEM, 0, MAP_NOCACHE);
246 /*Change the PCI BAR registers to map it onto the bus.*/
247 pci_write_config_dword(pcidev, BIOSImageBAR, 0);
248 pci_write_config_dword(pcidev, PCI_ROM_ADDRESS, BIOSImageBus | 0x1);
252 /*Check that the BIOS image is valid. If not fail, or return the
253 compiled in BIOS image if that option was enabled
255 if (BIOSImage[0] != 0x55 || BIOSImage[1] != 0xAA || BIOSImage[2] == 0) {
262 /****************************************************************************
264 pcidev - PCI device info for the video card on the bus
267 Unmaps the BIOS image for the device and restores framebuffer mappings
268 ****************************************************************************/
269 void PCI_unmapBIOSImage(pci_dev_t pcidev, void *BIOSImage)
271 pci_write_config_dword(pcidev, PCI_ROM_ADDRESS, saveROMBaseAddress);
272 pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_0, saveBaseAddress10);
273 pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_1, saveBaseAddress14);
274 pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_2, saveBaseAddress18);
275 pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_4, saveBaseAddress20);
278 /****************************************************************************
280 pcidev - PCI device info for the video card on the bus to boot
281 VGAInfo - BIOS emulator VGA info structure
284 true if successfully initialised, false if not.
287 Loads and POST's the display controllers BIOS, directly from the BIOS
288 image we can extract over the PCI bus.
289 ****************************************************************************/
290 static int PCI_postController(pci_dev_t pcidev, uchar *bios_rom, int bios_len,
291 BE_VGAInfo *vga_info, int vesa_mode,
292 struct vbe_mode_info *mode_info)
299 copy_of_bios = bios_rom;
300 bios_image_len = bios_len;
303 * Allocate memory to store copy of BIOS from display
306 mapped_bios = PCI_mapBIOSImage(pcidev);
307 if (mapped_bios == NULL) {
308 printf("videoboot: Video ROM failed to map!\n");
312 bios_image_len = mapped_bios[2] * 512;
314 copy_of_bios = malloc(bios_image_len);
315 if (copy_of_bios == NULL) {
316 printf("videoboot: Out of memory!\n");
319 memcpy(copy_of_bios, mapped_bios, bios_image_len);
320 PCI_unmapBIOSImage(pcidev, mapped_bios);
323 /*Save information in vga_info structure*/
324 vga_info->function = PCI_FUNC(pcidev);
325 vga_info->device = PCI_DEV(pcidev);
326 vga_info->bus = PCI_BUS(pcidev);
327 vga_info->pcidev = pcidev;
328 vga_info->BIOSImage = copy_of_bios;
329 vga_info->BIOSImageLen = bios_image_len;
331 /*Now execute the BIOS POST for the device*/
332 if (copy_of_bios[0] != 0x55 || copy_of_bios[1] != 0xAA) {
333 printf("videoboot: Video ROM image is invalid!\n");
337 PCI_doBIOSPOST(pcidev, vga_info, vesa_mode, mode_info);
339 /*Reset the size of the BIOS image to the final size*/
340 vga_info->BIOSImageLen = copy_of_bios[2] * 512;
344 int biosemu_setup(pci_dev_t pcidev, BE_VGAInfo **vga_infop)
348 printf("videoboot: Booting PCI video card bus %d, function %d, device %d\n",
349 PCI_BUS(pcidev), PCI_FUNC(pcidev), PCI_DEV(pcidev));
351 /*Initialise the x86 BIOS emulator*/
352 if ((VGAInfo = malloc(sizeof(*VGAInfo))) == NULL) {
353 printf("videoboot: Out of memory!\n");
356 memset(VGAInfo, 0, sizeof(*VGAInfo));
357 BE_init(0, 65536, VGAInfo, 0);
358 *vga_infop = VGAInfo;
363 void biosemu_set_interrupt_handler(int intnum, int (*int_func)(void))
365 X86EMU_setupIntrFunc(intnum, (X86EMU_intrFuncs)int_func);
368 int biosemu_run(pci_dev_t pcidev, uchar *bios_rom, int bios_len,
369 BE_VGAInfo *vga_info, int clean_up, int vesa_mode,
370 struct vbe_mode_info *mode_info)
372 /*Post all the display controller BIOS'es*/
373 if (!PCI_postController(pcidev, bios_rom, bios_len, vga_info,
374 vesa_mode, mode_info))
378 * Cleanup and exit the emulator if requested. If the BIOS emulator
379 * is needed after booting the card, we will not call BE_exit and
380 * leave it enabled for further use (ie: VESA driver etc).
384 if (vga_info->BIOSImage)
385 free(vga_info->BIOSImage);
393 /****************************************************************************
395 pcidev - PCI device info for the video card on the bus to boot
396 pVGAInfo - Place to return VGA info structure is requested
397 cleanUp - true to clean up on exit, false to leave emulator active
400 Boots the PCI/AGP video card on the bus using the Video ROM BIOS image
401 and the X86 BIOS emulator module.
402 ****************************************************************************/
403 int BootVideoCardBIOS(pci_dev_t pcidev, BE_VGAInfo **pVGAInfo, int clean_up)
408 ret = biosemu_setup(pcidev, &VGAInfo);
411 ret = biosemu_run(pcidev, NULL, 0, VGAInfo, clean_up, -1, NULL);
415 /* Return VGA info pointer if the caller requested it*/