SeaBIOS

From coreboot
Revision as of 17:26, 2 August 2009 by KevinOConnor (talk | contribs) (→‎Adding sgabios support: Note new seabios ability to suppress duplicate screen writes.)
Jump to navigation Jump to search

The wiki is being retired!

Documentation is now handled by the same processes we use for code: Add something to the Documentation/ directory in the coreboot repo, and it will be rendered to https://doc.coreboot.org/. Contributions welcome!

SeaBIOS (previously known as LegacyBIOS) is an open-source legacy BIOS implementation, which can also be used as coreboot payload.

Use cases

Any software requiring 16-bit BIOS services benefits from SeaBIOS, e.g. Windows or Linux (booting through standard GRUB). Linux booting will work out of the box. Generally Windows booting will also work, but Windows might require some more ACPI tweaks therefore it may not complete the boot (STOP 0xA5).

So far ASUS M2V-MX SE and GIGABYTE GA-M57SLI-S4 have known good working ACPI and are able to boot XP/Vista/Windows 7. Please ask on the mailing list for the status of other boards/chipsets.

Windows XP

Windows XP has been booted on real hardware with coreboot and SeaBIOS. Some patches are required.

Windows Vista

Windows Vista (64/32 bit) has been booted on real hardware with coreboot and SeaBIOS. Some patches are required.

Windows 7 Beta

Windows 7 Beta (64 bit) has been booted on real hardware with coreboot and SeaBIOS. Some patches required.

GRUB

GRUB works with coreboot and SeaBIOS on real hardware and boots Linux just fine.

Building

SeaBIOS

You can download the latest version of SeaBIOS through a git repository:

<source lang="bash"> $ git clone git://git.linuxtogo.org/home/kevin/seabios.git seabios $ cd seabios </source>

There's also a gitweb facility to browse the latest source code online.

Edit src/config.h and set the following values:

<source lang="C">

  1. define CONFIG_COREBOOT 1
  2. define CONFIG_DEBUG_SERIAL 1
  3. define CONFIG_OPTIONROMS_DEPLOYED 0
  4. define CONFIG_COREBOOT_FLASH 1
  5. define CONFIG_VGAHOOKS 1

</source>

Then:

<source lang="bash"> $ make </source>

The final SeaBIOS payload file is out/bios.bin.elf, which can be used with coreboot v2 or v3.

Compiled SeaBIOS images

It is also possible to download a compiled SeaBIOS image. The latest released version compiled for coreboot is: http://linuxtogo.org/~kevin/SeaBIOS/bios.bin.elf-0.4.1

Other versions are also available at: http://linuxtogo.org/~kevin/SeaBIOS/

coreboot

For best results, use coreboot-v2 and edit the targets/..../Config.lb with the following:

option CONFIG_CBFS = 1
option HAVE_HIGH_TABLES = 1
...
romimage "fallback"
	...
	payload /path/to/seabios/out/bios.bin.elf
end

Unfortunately, many boards don't have HAVE_HIGH_TABLES support, yet. If the build fails complaining about this option, one can edit the src/mainboard/<vendor>/<board>/Options.lb file and add a "uses HAVE_HIGH_TABLES" line. Then one can edit src/arch/i386/boot/tables.c and change the lines:

<source lang="C"> uint64_t high_tables_base = 0; uint64_t high_tables_size; </source>

to:

<source lang="C"> uint64_t high_tables_base = ( <memorysize> ) * 1024 * 1024 - (64 * 1024); uint64_t high_tables_size = 64 * 1024; </source>

where <memorysize> is the amount of memory (in MiB) available on the target machine, but not more than 3072. So, if you have more than 3GiB of RAM installed, put 3072. Otherwise, put the number of MiB of RAM installed in your machine.

Alternatively, one can add proper support for HAVE_HIGH_TABLES.

Once the above is done, the final image will be in coreboot.rom.

SeaBIOS and CBFS

SeaBIOS can read the coreboot flash filesystem and extract option ROMs and payloads.

When SeaBIOS scans the target machine's PCI devices, it will recognize option ROMs in CBFS that have the form pciVVVV,DDDD.rom. It will also run any file in the directory vgaroms/ as a vga option rom not specific to a device and files in genroms/ as a generic option ROM not specific to a device. In the above cases, SeaBIOS will recognize files with a .lzma suffix, and automatically decompress them (eg, pci1106,3344.rom.lzma and vgaroms/sgabios.bin.lzma).

SeaBIOS will also load payloads found in the CBFS directory img/.

The examples below show some common uses of this feature.

Adding a VGA option ROM

It is frequently necessary to add a VGA option ROM to CBFS in order to use a VGA adapter that is built-in to a motherboard. Note, VGA adapters on external cards do not require this step as SeaBIOS will automatically extract the VGA bios directly from the card.

The first step is to find the vendor and device ID of the built-in VGA adapter. This information can be found from lspci:

<source lang="bash"> $ lspci -vnn ... 01:00.0 VGA compatible controller [0300]: VIA Technologies, Inc. UniChrome Pro IGP [1106:3344] (rev 01) (prog-if 00 [VGA controller]) </source>

In the above example, the VGA vendor/device ID is 1106:3344. Obtain the VGA ROM (eg, vgabios.bin) and add it to the ROM with:

<source lang="bash"> $ ./cbfs/cbfstool coreboot.rom add /path/to/vgabios.bin pci1106,3344.rom 0 $ ./cbfs/cbfstool coreboot.rom print </source>

Alternatively, SeaBIOS supports LZMA compressed option ROMs. Use the following to add a compressed option ROM instead:

<source lang="bash"> $ lzma -zc /path/to/vgabios.bin > vgabios.bin.lzma $ ./cbfs/cbfstool coreboot.rom add vgabios.bin.lzma pci1106,3344.rom.lzma 0 $ ./cbfs/cbfstool coreboot.rom print </source>

After the above is done, one can write the coreboot.rom file to flash. SeaBIOS will extract the VGA ROM and run it during boot.

Adding gpxe support

A gpxe option ROM can nicely complement SeaBIOS and coreboot by adding network boot support. Adding gpxe is similar to #Adding a VGA option ROM. The first step is to find the Ethernet vendor/device ID. For example:

<source lang="bash"> $ lspci -vnn ... 00:09.0 Ethernet controller [0200]: Realtek Semiconductor Co., Ltd. RTL-8110SC/8169SC Gigabit Ethernet [10ec:8167] (rev 10) </source>

Then one can build a gpxe option ROM. For example:

<source lang="bash"> $ cd /path/to/gpxe/src/ $ make bin/10ec8167.rom </source>

And add it to the coreboot image. For example:

<source lang="bash"> $ ./cbfs/cbfstool coreboot.rom add /path/to/gpxe/src/bin/10ec8167.rom pci10ec,8167.rom 0 $ ./cbfs/cbfstool coreboot.rom print </source>

As with VGA option ROMs, the gpxe option ROM may be compressed with LZMA. However, compression won't significantly reduce gpxe's size as it implements its own compression.

In addition to gpxe, other option ROMs can be added in the same manor.

Adding sgabios support

An sgabios option ROM can forward some VGA BIOS requests over a serial port.

Unfortunately, the current version of sgabios (as of 20090617) does not implement a proper checksum. As a work around, a tool from the seabios source repo can fix the checksum: <source lang="bash"> $ /path/to/seabios/tools/buildrom.py /path/to/sgabios.bin sgabios-fixed.bin </source>

Once the above is done, place the ROM file in the vgaroms/ directory of CBFS. For example:

<source lang="bash"> $ ./cbfs/cbfstool coreboot.rom add sgabios-fixed.bin vgaroms/sgabios.bin 0 $ ./cbfs/cbfstool coreboot.rom print </source>

When using sgabios, all the characters that SeaBIOS writes to the screen will be seen twice - once from SeaBIOS sending the character to the serial port and once from sgabios forwarding the character. To prevent the duplicates one can edit the SeaBIOS src/config.h file and set the following:

<source lang="C">

  1. define CONFIG_SCREEN_AND_DEBUG 0

</source>

Adding payloads

Most payloads can also be launched from SeaBIOS. To add a payload, build the corresponding .elf file and then add it to the coreboot.rom file in the img/ directory. For example:

<source lang="bash"> $ ./cbfs/cbfstool coreboot.rom add-payload /path/to/payload.elf img/MyPayload l $ ./cbfs/cbfstool coreboot.rom print </source>

During boot, one can press the F12 key to get a boot menu. SeaBIOS will show all files in the img/ directory, and one can instruct SeaBIOS to run them.

Note, SeaBIOS currently supports uncompressed and LZMA compressed payloads. The nrv2b compression algorithm is not supported.