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>
54 #include <linux/delay.h>
57 /* Length of the BIOS image */
58 #define MAX_BIOSLEN (128 * 1024L)
60 /* Place to save PCI BAR's that we change and later restore */
61 static u32 saveROMBaseAddress;
62 static u32 saveBaseAddress10;
63 static u32 saveBaseAddress14;
64 static u32 saveBaseAddress18;
65 static u32 saveBaseAddress20;
67 /* Addres im memory of VBE region */
68 const int vbe_offset = 0x2000;
70 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
71 static const void *bios_ptr(const void *buf, BE_VGAInfo *vga_info,
76 seg_ofs = le32_to_cpu(x86_dword_ptr);
77 flat = ((seg_ofs & 0xffff0000) >> 12) | (seg_ofs & 0xffff);
79 return vga_info->BIOSImage + flat - 0xc0000;
81 return buf + (flat - vbe_offset);
84 static int atibios_debug_mode(BE_VGAInfo *vga_info, RMREGS *regs,
85 int vesa_mode, struct vbe_mode_info *mode_info)
87 void *buffer = (void *)(M.mem_base + vbe_offset);
88 u16 buffer_seg = (((unsigned long)vbe_offset) >> 4) & 0xff00;
89 u16 buffer_adr = ((unsigned long)vbe_offset) & 0xffff;
90 struct vesa_mode_info *vm;
91 struct vbe_info *info;
92 const u16 *modes_bios, *ptr;
96 debug("VBE: Getting information\n");
97 regs->e.eax = VESA_GET_INFO;
98 regs->e.esi = buffer_seg;
99 regs->e.edi = buffer_adr;
101 memset(info, '\0', sizeof(*info));
102 strcpy(info->signature, "VBE2");
103 BE_int86(0x10, regs, regs);
104 if (regs->e.eax != 0x4f) {
105 debug("VESA_GET_INFO: error %x\n", regs->e.eax);
108 debug("version %x\n", le16_to_cpu(info->version));
109 debug("oem '%s'\n", (char *)bios_ptr(buffer, vga_info,
110 info->oem_string_ptr));
111 debug("vendor '%s'\n", (char *)bios_ptr(buffer, vga_info,
112 info->vendor_name_ptr));
113 debug("product '%s'\n", (char *)bios_ptr(buffer, vga_info,
114 info->product_name_ptr));
115 debug("rev '%s'\n", (char *)bios_ptr(buffer, vga_info,
116 info->product_rev_ptr));
117 modes_bios = bios_ptr(buffer, vga_info, info->modes_ptr);
119 for (ptr = modes_bios; *ptr != 0xffff; ptr++)
120 debug("%x ", le16_to_cpu(*ptr));
121 debug("\nmemory %dMB\n", le16_to_cpu(info->total_memory) >> 4);
122 size = (ptr - modes_bios) * sizeof(u16) + 2;
123 modes = malloc(size);
126 memcpy(modes, modes_bios, size);
128 regs->e.eax = VESA_GET_CUR_MODE;
129 BE_int86(0x10, regs, regs);
130 if (regs->e.eax != 0x4f) {
131 debug("VESA_GET_CUR_MODE: error %x\n", regs->e.eax);
134 debug("Current mode %x\n", regs->e.ebx);
136 for (ptr = modes; *ptr != 0xffff; ptr++) {
137 int mode = le16_to_cpu(*ptr);
141 debug("Mode %x: ", mode);
142 memset(buffer, '\0', sizeof(struct vbe_mode_info));
143 regs->e.eax = VESA_GET_MODE_INFO;
147 regs->e.esi = buffer_seg;
148 regs->e.edi = buffer_adr;
149 BE_int86(0x10, regs, regs);
150 if (regs->e.eax != 0x4f) {
151 debug("VESA_GET_MODE_INFO: error %x\n", regs->e.eax);
154 memcpy(mode_info->mode_info_block, buffer,
155 sizeof(struct vesa_mode_info));
156 mode_info->valid = true;
157 vm = &mode_info->vesa;
158 attr = le16_to_cpu(vm->mode_attributes);
159 linear_ok = attr & 0x80;
160 debug("res %d x %d, %d bpp, mm %d, (Linear %s, attr %02x)\n",
161 le16_to_cpu(vm->x_resolution),
162 le16_to_cpu(vm->y_resolution),
163 vm->bits_per_pixel, vm->memory_model,
164 linear_ok ? "OK" : "not available",
166 debug("\tRGB pos=%d,%d,%d, size=%d,%d,%d\n",
167 vm->red_mask_pos, vm->green_mask_pos, vm->blue_mask_pos,
168 vm->red_mask_size, vm->green_mask_size,
175 static int atibios_set_vesa_mode(RMREGS *regs, int vesa_mode,
176 struct vbe_mode_info *mode_info)
178 void *buffer = (void *)(M.mem_base + vbe_offset);
179 u16 buffer_seg = (((unsigned long)vbe_offset) >> 4) & 0xff00;
180 u16 buffer_adr = ((unsigned long)vbe_offset) & 0xffff;
181 struct vesa_mode_info *vm;
183 debug("VBE: Setting VESA mode %#04x\n", vesa_mode);
184 regs->e.eax = VESA_SET_MODE;
185 regs->e.ebx = vesa_mode;
186 /* request linear framebuffer mode and don't clear display */
187 regs->e.ebx |= (1 << 14) | (1 << 15);
188 BE_int86(0x10, regs, regs);
189 if (regs->e.eax != 0x4f) {
190 debug("VESA_SET_MODE: error %x\n", regs->e.eax);
194 memset(buffer, '\0', sizeof(struct vbe_mode_info));
195 debug("VBE: Geting info for VESA mode %#04x\n", vesa_mode);
196 regs->e.eax = VESA_GET_MODE_INFO;
197 regs->e.ecx = vesa_mode;
198 regs->e.esi = buffer_seg;
199 regs->e.edi = buffer_adr;
200 BE_int86(0x10, regs, regs);
201 if (regs->e.eax != 0x4f) {
202 debug("VESA_GET_MODE_INFO: error %x\n", regs->e.eax);
206 memcpy(mode_info->mode_info_block, buffer,
207 sizeof(struct vesa_mode_info));
208 mode_info->valid = true;
209 mode_info->video_mode = vesa_mode;
210 vm = &mode_info->vesa;
211 vm->x_resolution = le16_to_cpu(vm->x_resolution);
212 vm->y_resolution = le16_to_cpu(vm->y_resolution);
213 vm->bytes_per_scanline = le16_to_cpu(vm->bytes_per_scanline);
214 vm->phys_base_ptr = le32_to_cpu(vm->phys_base_ptr);
215 vm->mode_attributes = le16_to_cpu(vm->mode_attributes);
216 debug("VBE: Init complete\n");
220 #endif /* CONFIG_FRAMEBUFFER_SET_VESA_MODE */
222 /****************************************************************************
224 pcidev - PCI device info for the video card on the bus to boot
225 vga_info - BIOS emulator VGA info structure
228 This function executes the BIOS POST code on the controller. We assume that
229 at this stage the controller has its I/O and memory space enabled and
230 that all other controllers are in a disabled state.
231 ****************************************************************************/
233 static void PCI_doBIOSPOST(struct udevice *pcidev, BE_VGAInfo *vga_info,
234 int vesa_mode, struct vbe_mode_info *mode_info)
236 static void PCI_doBIOSPOST(pci_dev_t pcidev, BE_VGAInfo *vga_info,
237 int vesa_mode, struct vbe_mode_info *mode_info)
246 /* Determine the value to store in AX for BIOS POST. Per the PCI specs,
247 AH must contain the bus and AL must contain the devfn, encoded as
250 memset(®s, 0, sizeof(regs));
251 memset(&sregs, 0, sizeof(sregs));
253 bdf = dm_pci_get_bdf(pcidev);
254 regs.x.ax = (int)PCI_BUS(bdf) << 8 |
255 (int)PCI_DEV(bdf) << 3 | (int)PCI_FUNC(bdf);
257 regs.x.ax = ((int)PCI_BUS(pcidev) << 8) |
258 ((int)PCI_DEV(pcidev) << 3) | (int)PCI_FUNC(pcidev);
260 /*Setup the X86 emulator for the VGA BIOS*/
263 /*Execute the BIOS POST code*/
264 BE_callRealMode(0xC000, 0x0003, ®s, &sregs);
269 #ifdef CONFIG_FRAMEBUFFER_SET_VESA_MODE
270 /* Useful for debugging */
272 atibios_debug_mode(vga_info, ®s, vesa_mode, mode_info);
274 atibios_set_vesa_mode(®s, vesa_mode, mode_info);
278 /****************************************************************************
280 pcidev - PCI device info for the video card on the bus
281 bar - Place to return the base address register offset to use
284 The address to use to map the secondary BIOS (AGP devices)
287 Searches all the PCI base address registers for the device looking for a
288 memory mapping that is large enough to hold our ROM BIOS. We usually end up
289 finding the framebuffer mapping (usually BAR 0x10), and we use this mapping
290 to map the BIOS for the device into. We use a mapping that is already
291 assigned to the device to ensure the memory range will be passed through
292 by any PCI->PCI or AGP->PCI bridge that may be present.
294 NOTE: Usually this function is only used for AGP devices, but it may be
295 used for PCI devices that have already been POST'ed and the BIOS
296 ROM base address has been zero'ed out.
298 NOTE: This function leaves the original memory aperture disabled by leaving
299 it programmed to all 1's. It must be restored to the correct value
301 ****************************************************************************/
303 static u32 PCI_findBIOSAddr(struct udevice *pcidev, int *bar)
305 static u32 PCI_findBIOSAddr(pci_dev_t pcidev, int *bar)
310 for (*bar = 0x10; *bar <= 0x14; (*bar) += 4) {
312 dm_pci_read_config32(pcidev, *bar, &base);
314 pci_read_config_dword(pcidev, *bar, &base);
318 dm_pci_write_config32(pcidev, *bar, 0xFFFFFFFF);
319 dm_pci_read_config32(pcidev, *bar, &size);
321 pci_write_config_dword(pcidev, *bar, 0xFFFFFFFF);
322 pci_read_config_dword(pcidev, *bar, &size);
324 size = ~(size & ~0xFF) + 1;
325 if (size >= MAX_BIOSLEN)
332 /****************************************************************************
334 Some non-x86 Linux kernels map PCI relocateable I/O to values that
335 are above 64K, which will not work with the BIOS image that requires
336 the offset for the I/O ports to be a maximum of 16-bits. Ideally
337 someone should fix the kernel to map the I/O ports for VGA compatible
338 devices to a different location (or just all I/O ports since it is
339 unlikely you can have enough devices in the machine to use up all
340 64K of the I/O space - a total of more than 256 cards would be
343 Anyway to fix this we change all I/O mapped base registers and
344 chop off the top bits.
345 ****************************************************************************/
347 static void PCI_fixupIObase(struct udevice *pcidev, int reg, u32 *base)
349 static void PCI_fixupIObase(pci_dev_t pcidev, int reg, u32 * base)
352 if ((*base & 0x1) && (*base > 0xFFFE)) {
355 dm_pci_write_config32(pcidev, reg, *base);
357 pci_write_config_dword(pcidev, reg, *base);
363 /****************************************************************************
365 pcidev - PCI device info for the video card on the bus
368 Pointers to the mapped BIOS image
371 Maps a pointer to the BIOS image on the graphics card on the PCI bus.
372 ****************************************************************************/
374 void *PCI_mapBIOSImage(struct udevice *pcidev)
376 void *PCI_mapBIOSImage(pci_dev_t pcidev)
383 /*Save PCI BAR registers that might get changed*/
385 dm_pci_read_config32(pcidev, PCI_ROM_ADDRESS, &saveROMBaseAddress);
386 dm_pci_read_config32(pcidev, PCI_BASE_ADDRESS_0, &saveBaseAddress10);
387 dm_pci_read_config32(pcidev, PCI_BASE_ADDRESS_1, &saveBaseAddress14);
388 dm_pci_read_config32(pcidev, PCI_BASE_ADDRESS_2, &saveBaseAddress18);
389 dm_pci_read_config32(pcidev, PCI_BASE_ADDRESS_4, &saveBaseAddress20);
391 pci_read_config_dword(pcidev, PCI_ROM_ADDRESS, &saveROMBaseAddress);
392 pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_0, &saveBaseAddress10);
393 pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_1, &saveBaseAddress14);
394 pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_2, &saveBaseAddress18);
395 pci_read_config_dword(pcidev, PCI_BASE_ADDRESS_4, &saveBaseAddress20);
398 /*Fix up I/O base registers to less than 64K */
399 if(saveBaseAddress14 != 0)
400 PCI_fixupIObase(pcidev, PCI_BASE_ADDRESS_1, &saveBaseAddress14);
402 PCI_fixupIObase(pcidev, PCI_BASE_ADDRESS_4, &saveBaseAddress20);
404 /* Some cards have problems that stop us from being able to read the
405 BIOS image from the ROM BAR. To fix this we have to do some chipset
406 specific programming for different cards to solve this problem.
409 BIOSImageBus = PCI_findBIOSAddr(pcidev, &BIOSImageBAR);
410 if (BIOSImageBus == 0) {
411 printf("Find bios addr error\n");
416 BIOSImage = dm_pci_bus_to_virt(pcidev, BIOSImageBus,
417 PCI_REGION_MEM, 0, MAP_NOCACHE);
419 /*Change the PCI BAR registers to map it onto the bus.*/
420 dm_pci_write_config32(pcidev, BIOSImageBAR, 0);
421 dm_pci_write_config32(pcidev, PCI_ROM_ADDRESS, BIOSImageBus | 0x1);
423 BIOSImage = pci_bus_to_virt(pcidev, BIOSImageBus,
424 PCI_REGION_MEM, 0, MAP_NOCACHE);
426 /*Change the PCI BAR registers to map it onto the bus.*/
427 pci_write_config_dword(pcidev, BIOSImageBAR, 0);
428 pci_write_config_dword(pcidev, PCI_ROM_ADDRESS, BIOSImageBus | 0x1);
432 /*Check that the BIOS image is valid. If not fail, or return the
433 compiled in BIOS image if that option was enabled
435 if (BIOSImage[0] != 0x55 || BIOSImage[1] != 0xAA || BIOSImage[2] == 0) {
442 /****************************************************************************
444 pcidev - PCI device info for the video card on the bus
447 Unmaps the BIOS image for the device and restores framebuffer mappings
448 ****************************************************************************/
450 void PCI_unmapBIOSImage(struct udevice *pcidev, void *BIOSImage)
452 dm_pci_write_config32(pcidev, PCI_ROM_ADDRESS, saveROMBaseAddress);
453 dm_pci_write_config32(pcidev, PCI_BASE_ADDRESS_0, saveBaseAddress10);
454 dm_pci_write_config32(pcidev, PCI_BASE_ADDRESS_1, saveBaseAddress14);
455 dm_pci_write_config32(pcidev, PCI_BASE_ADDRESS_2, saveBaseAddress18);
456 dm_pci_write_config32(pcidev, PCI_BASE_ADDRESS_4, saveBaseAddress20);
459 void PCI_unmapBIOSImage(pci_dev_t pcidev, void *BIOSImage)
461 pci_write_config_dword(pcidev, PCI_ROM_ADDRESS, saveROMBaseAddress);
462 pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_0, saveBaseAddress10);
463 pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_1, saveBaseAddress14);
464 pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_2, saveBaseAddress18);
465 pci_write_config_dword(pcidev, PCI_BASE_ADDRESS_4, saveBaseAddress20);
469 /****************************************************************************
471 pcidev - PCI device info for the video card on the bus to boot
472 VGAInfo - BIOS emulator VGA info structure
475 true if successfully initialised, false if not.
478 Loads and POST's the display controllers BIOS, directly from the BIOS
479 image we can extract over the PCI bus.
480 ****************************************************************************/
482 static int PCI_postController(struct udevice *pcidev, uchar *bios_rom,
483 int bios_len, BE_VGAInfo *vga_info,
484 int vesa_mode, struct vbe_mode_info *mode_info)
486 static int PCI_postController(pci_dev_t pcidev, uchar *bios_rom, int bios_len,
487 BE_VGAInfo *vga_info, int vesa_mode,
488 struct vbe_mode_info *mode_info)
499 copy_of_bios = bios_rom;
500 bios_image_len = bios_len;
503 * Allocate memory to store copy of BIOS from display
506 mapped_bios = PCI_mapBIOSImage(pcidev);
507 if (mapped_bios == NULL) {
508 printf("videoboot: Video ROM failed to map!\n");
512 bios_image_len = mapped_bios[2] * 512;
514 copy_of_bios = malloc(bios_image_len);
515 if (copy_of_bios == NULL) {
516 printf("videoboot: Out of memory!\n");
519 memcpy(copy_of_bios, mapped_bios, bios_image_len);
520 PCI_unmapBIOSImage(pcidev, mapped_bios);
523 /*Save information in vga_info structure*/
525 bdf = dm_pci_get_bdf(pcidev);
526 vga_info->function = PCI_FUNC(bdf);
527 vga_info->device = PCI_DEV(bdf);
528 vga_info->bus = PCI_BUS(bdf);
530 vga_info->function = PCI_FUNC(pcidev);
531 vga_info->device = PCI_DEV(pcidev);
532 vga_info->bus = PCI_BUS(pcidev);
534 vga_info->pcidev = pcidev;
535 vga_info->BIOSImage = copy_of_bios;
536 vga_info->BIOSImageLen = bios_image_len;
538 /*Now execute the BIOS POST for the device*/
539 if (copy_of_bios[0] != 0x55 || copy_of_bios[1] != 0xAA) {
540 printf("videoboot: Video ROM image is invalid!\n");
544 PCI_doBIOSPOST(pcidev, vga_info, vesa_mode, mode_info);
546 /*Reset the size of the BIOS image to the final size*/
547 vga_info->BIOSImageLen = copy_of_bios[2] * 512;
552 int biosemu_setup(struct udevice *pcidev, BE_VGAInfo **vga_infop)
554 int biosemu_setup(pci_dev_t pcidev, BE_VGAInfo **vga_infop)
559 pci_dev_t bdf = dm_pci_get_bdf(pcidev);
561 printf("videoboot: Booting PCI video card bus %d, function %d, device %d\n",
562 PCI_BUS(bdf), PCI_FUNC(bdf), PCI_DEV(bdf));
564 printf("videoboot: Booting PCI video card bus %d, function %d, device %d\n",
565 PCI_BUS(pcidev), PCI_FUNC(pcidev), PCI_DEV(pcidev));
567 /*Initialise the x86 BIOS emulator*/
568 if ((VGAInfo = malloc(sizeof(*VGAInfo))) == NULL) {
569 printf("videoboot: Out of memory!\n");
572 memset(VGAInfo, 0, sizeof(*VGAInfo));
573 BE_init(0, 65536, VGAInfo, 0);
574 *vga_infop = VGAInfo;
579 void biosemu_set_interrupt_handler(int intnum, int (*int_func)(void))
581 X86EMU_setupIntrFunc(intnum, (X86EMU_intrFuncs)int_func);
585 int biosemu_run(struct udevice *pcidev, uchar *bios_rom, int bios_len,
586 BE_VGAInfo *vga_info, int clean_up, int vesa_mode,
587 struct vbe_mode_info *mode_info)
589 int biosemu_run(pci_dev_t pcidev, uchar *bios_rom, int bios_len,
590 BE_VGAInfo *vga_info, int clean_up, int vesa_mode,
591 struct vbe_mode_info *mode_info)
594 /*Post all the display controller BIOS'es*/
595 if (!PCI_postController(pcidev, bios_rom, bios_len, vga_info,
596 vesa_mode, mode_info))
600 * Cleanup and exit the emulator if requested. If the BIOS emulator
601 * is needed after booting the card, we will not call BE_exit and
602 * leave it enabled for further use (ie: VESA driver etc).
606 if (vga_info->BIOSImage &&
607 (ulong)(vga_info->BIOSImage) != 0xc0000)
608 free(vga_info->BIOSImage);
615 /****************************************************************************
617 pcidev - PCI device info for the video card on the bus to boot
618 pVGAInfo - Place to return VGA info structure is requested
619 cleanUp - true to clean up on exit, false to leave emulator active
622 Boots the PCI/AGP video card on the bus using the Video ROM BIOS image
623 and the X86 BIOS emulator module.
624 ****************************************************************************/
626 int BootVideoCardBIOS(struct udevice *pcidev, BE_VGAInfo **pVGAInfo,
629 int BootVideoCardBIOS(pci_dev_t pcidev, BE_VGAInfo **pVGAInfo, int clean_up)
635 ret = biosemu_setup(pcidev, &VGAInfo);
638 ret = biosemu_run(pcidev, NULL, 0, VGAInfo, clean_up, -1, NULL);
642 /* Return VGA info pointer if the caller requested it*/