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!
What is LinuxBIOS?
LinuxBIOS is a Free Software project aimed at replacing the proprietary BIOS (firmware) you can find in most of today's computers.
It performs just a little bit of hardware initialization and then executes a so-called payload.
Some of the many possible payloads are: a Linux kernel, FILO, GRUB2, OpenBIOS, Open Firmware, SmartFirmware, GNUFI (UEFI), Etherboot, ADLO (for booting Windows 2000 and OpenBSD), Plan 9, or memtest86.
Our primary motivation for the project was maintenance of large clusters, but not surprisingly interest and contributions have come from people with varying backgrounds. Today LinuxBIOS can be used in a wide variety of scenarios, ranging from clusters, embedded systems, desktop PCs, servers and more.
Why do we need LinuxBIOS?
Why do we need LinuxBIOS for cluster maintainance?
Current PCs used as cluster nodes depend on a vendor-supplied BIOS for booting. The BIOS in turn relies on inherently unreliable devices such as floppy disks and hard drives to boot the operating system. In addition, current BIOS software is unable to accommodate non-standard hardware making it difficult to support experimental work. The BIOS is slow and often erroneous and redundant and, most importantly, maintenance is a nightmare. Imagine walking around with a keyboard and monitor to every one of the 128 nodes in a cluster to change one BIOS setting.
LinuxBIOS with Linux as a payload (other payloads are possible!) gunzip's the Linux kernel straight out of NVRAM and essentially requires no moving parts other than the fan. It does a minimal amount of hardware initialization before jumping to the kernel start and lets Linux do the rest. As a result, it is much faster (current record 3 seconds), which has sparked interest in the consumer electronics community as well. Moreover, updates can be performed over the network.
Using a real operating system to boot another operating system provides much greater flexibility than using a simple netboot program or the BIOS. Because Linux is the boot mechanism, it can boot over standard Ethernet or over other interconnects such as Myrinet, Quadrics, or SCI. It can use SSH connections to load the kernel, or it can use the InterMezzo caching file system or traditional NFS. Cluster nodes can be as simple as they need to be - perhaps as simple as a CPU and memory, no disk, no floppy, and no file system. The nodes will be much less autonomous thus making them easier to maintain.
Why do we need LinuxBIOS for other purposes?
Who is working on LinuxBIOS?
The LinuxBIOS project was started in the winter of 1999 in the Advanced Computing Laboratory at Los Alamos National Laboratory (LANL) by Ron Minnich. Two undergraduate students, James Hendricks and Dale Webster spent their winter vacation putting together the proof of concept implementation.
Since then, a long list of people have contributed both in discussions and actual code. Please don't be shy and let us know if you are missing from the list. It's not a purposeful omission, just an unfortunate mistake.
Who is funding LinuxBIOS?
The LinuxBIOS project is funded by the Los Alamos Computer Science Institute and the Department of Energy's Office of Science.
See also the list of LinuxBIOS sponsors.
Will LinuxBIOS work on my machine?
See the Supported Motherboards page for which mainboards are supported, and also the list of Supported Chipsets and Devices. See the Products page for a list of vendors selling products running LinuxBIOS.
If the above sources don't help, please send the following to the mailing list:
- Step 1: A very brief description of your system: CPU, northbridge, southbridge, mainboard and optionally other important details.
- Step 2: Linux lspci output for your system, generated by booting Linux via the original BIOS and runnning lspci.
- Step 3: Super I/O chip on the mainboard (report the model numbers on the actual chip, for example "Winbond W83627HF").
- Step 4: Type of BIOS device (see the question "How do I identify the BIOS chip on my mainboard?" below).
- Step 5: URL to the mainboard specifications page (optional).
- Step 6: Any other relevant information you can provide.
If you can't do step 1 above, please describe (as best you can) the specific CPU chip and the chipset used on the mainboard.
Usually in less than a day, someone will respond on the LinuxBIOS mailing list saying your mainboard is supported in the main LinuxBIOS source tree, it is currently in development, it is not yet supported or the manufacturer will not release information needed to provide LinuxBIOS support. In the latter case, please let the manufacturer know that you want LinuxBIOS support and his failure to release chipset information is making that very difficult.
What commercial products use LinuxBIOS?
See the products page.
Which different operating systems will LinuxBIOS boot?
- Linux (of course)
- Plan 9
- Windows 2000 (via ADLO)
We have looked at some of the BSD OSes but (e.g.) FreeBSD makes BIOS calls, and we don't support BIOS calls. Possibly ADLO could be used to support FreeBSD, but the right thing to do is remove FreeBSD's dependence on BIOS calls.
What chipsets and Super I/O devices are supported?
See the Supported Chipsets and Devices page.
Where is the mailing list archived?
Where do I get the code?
See the download page.
How do I build LinuxBIOS?
See the documentation.
How can I help with LinuxBIOS?
There are many ways how you can help us:
- Promote LinuxBIOS, tell all your friends about it, blog about it etc.
- Test LinuxBIOS, report any bugs you find, or let us know about any suggestions for improvements you have.
- Help us to make the list of Supported Motherboards and the list of Supported Chipsets and Devices bigger by contributing code. Please also read the Development Guidelines in that case.
- Have a look at the list of open issues/bugs and try to reproduce them or (preferrably) fix them.
- Contact Ron Minnich or Stefan Reinauer for bigger projects related to LinuxBIOS.
- Contact us on the mailing list if you have any further questions or suggestions.
What kind of hardware tools do I need?
A motherboard (or mainboard as LinuxBIOS calls it) that has a supported chipset on it. Ok... well not exactly. As long as you have the documentation for the chipset/mainboard and it's free of any NDA issues you can use an unsupported chipset/mainboard, but you have a twisty road ahead of you.
And of course you need a Linux development machine. The LinuxBIOS build environment is not supported on Windows. It may be possible to do it under cygwin but nobody has tried.
It's also handy to have one/some/all of the following:
EPROM/Flash programmer that can program the flash on your motherboard
- Willem Universal EPROM Programmer -- DOS/Windows only (work has started on Linux drivers) ~$50
- GALEP-4 -- Has beta linux drivers ~$300
- IDE adapter for PLCC32 & DIP32 sockets -- Has Linux 2.4 & 2.6 drivers ~$48EUR (kit $33EUR)
A tool that plugs into and replaces the original mainboard Flash device. The BIOS Savior has its own Flash device and a socket for the original mainboard Flash device. The Bios Savior features a switch to allow the developer to choose between which Flash device is accessed by the mainboard during read and write cycles.
A similar function is achieved by the "top hat flash" which comes at no extra cost with many Elitegroup mainboards like KN3 with MCP55 southbridge. After bootup, it can manually be lifted off the original BIOS chip socket, so the original BIOS can be reflashed after a failure.
See the What is a POST Card? question in this FAQ.
Compact Flash IDE adaptor
- http://www.hsc-us.com/industrial/adapter/ATP.html (2xCF, one with hotswap!)
- http://www.mesanet.com/ (Choose DISK EMULATORS then CFADPTHD in the menu. 2xCF)
For hardware debugging purposes.
In Circuit Emulator hardware debugger
In Circuit chip programmer
Should allow you to program your BIOS even if it is soldered to the motherboard.
These hardware devices pretend to be an EPROM chip.
- http://www.linuxselfhelp.com/HOWTO/Diskless-HOWTO-10.html (a larger list -- outdated)
USB debug devices
an alternative to a serial console may be a USB debug device. They are not so common yet. Their advantage is higher speed than a serial console. One might hook an FPGA to it for profiling purposes or some automated checks. Accessing a USB debug device from within BIOS is not different than other USB devices, and is part of the USB standard.
What documentation do I need?
As much documentation as you can possibly get your hands on. At minimum, you will need the docs for the chipset.
There have been reports of people getting LinuxBIOS working by booting with the OEM BIOS. Then, they would read the static contents of the PCI config registers after boot. LinuxBIOS is then built to match the static contents read from the PCI config registers.
The problem with this approach is that chipsets generally require dynamic vs static configuration values during their initialization. The configuration register contents will change from one stage of initialization to the next. Since the contents of the registers read is only the final state of the configuration registers, the chipset won't be properly initialized if these are the only configuration values used.
Getting a mainboard up without chipset docs can be a very long and involved process.
What if my chipset docs are covered by an NDA?
If the documentation for your chipset covered by and NDA with no source release agreement you won't be able to release your code back to to the LinuxBIOS project in general or you will violate the GPL. Many vendors accept releasing the source code produced after reading such specs while they don't allow the specs themselves to be revealed. Also, you can offer them to review the code before releasing it.
Why is the code so complicated and what can I do to make it easier?
The reason is the complexity of the problem. We support a lot of hardware, and a given chip on a given board will most likely not be configured quite the same as the same chip on some other board. To help make code navigation easier, pick a target and build that target. Then, in the build directory, type make tags or make etags to get your favorite tags file.
What is this POST card thing?
A POST card will save your life. The term POST means Power On Self Test and comes from the original IBM specifications for the BIOS. Port 80 is a pre-defined port to which programs can output a byte. The POST card displays the byte in hex on its 2 digit display. We use a lot of POST codes in LinuxBIOS, so if you can tell us the POST code you see, we will have some idea of what happened.
If your LinuxBIOS machine is working properly, you will see it count up from 0xd0 to 0xd9 (while it is gunzipping the kernel) and then display 0x98 (Linux idle loop).
PCI POST cards can be found in various places. POST Cards
How do I contribute my changes?
Please carefully read the Development Guidelines for more information.
How do I identify the BIOS chip on my mainboard?
Modern mainboards store the BIOS in a reprogrammable flash ROM chip. There are hundreds of different flash ROMs, with variables such as memory size, speed, communication bus (LPC vs. ISA/PCI) and packaging to name just a few. The three most common packages are called DIP, PLCC and TSOP. The BIOS copyright holders often place a fancy sticker on the BIOS chip showing a name or logotype, BIOS version, serial number and copyright notice.
DIP: Dual In-line Package
A rectangular black plastic block with lots of pins along the two longer sides of the package. DIP ROMs can be socketed which means they are detachable from the mainboard using physical force. Since they haven't been moved in and out of the socket very much (yet, hehe) they can appear to be quite difficult to release from the socket. One way to remove a DIP from a socket is by prying a thin screwdriver in between the plastic package and the socket, along the shorter sides where there are no pins, and then gently bending the screwdriver to push the DIP upwards, away from the mainboard. Alternate between the two sides to avoid bending the pins, and don't touch any of the pins with the screwdriver, see FAQ about ESD, electro-static discharge. If the DIP is soldered directly to the mainboard, it has to be desoldered in order to be reprogrammed outside the mainboard. If you do this, it's a good idea to solder a socket to the mainboard instead, to ease any future experiments.
PLCC: Plastic Leaded Chip Carrier
Black plastic block again, but this one is much more square. PLCC is becoming the standard for mainboards because of it's smaller physical size. PLCC can also be socketed or soldered directly to the mainboard. Socketed PLCC chips can be removed using a special PLCC removal tool, or using a piece of nylon line tied in a loop around the chip and pulled swiftly straight up, or bending/prying using small screwdrivers if one is careful. PLCC sockets are often fragile so the screwdriver approach is not recommended. While the nylon line method sounds onorthodox it works well. Desoldering PLCC can be painful without specialized desoldering equipment particularly because PLCC chips have leads on all four sides of the package.
TSOP: Thin Small-Outline Package
TSOPs are often used in embedded systems where size is important and there is no need for replacement in the field. It is possible to (de)solder TSOPs by hand, but it comes close to wizardry.
How do I (re-)flash the BIOS?
Out of mainboard BIOS (re)flash
If the BIOS chip is socketed, it can be removed and flashed in a rom/flash burner and quickly re-installed. Some of these burners cost $1000 and more plus they complete a flash in 1-2 minutes, but if you are willing to wait 5 minutes for a flash and manually set DIP switches, The Enhanced Willem Universal Programmer will do the job for only $40-60 USD. There are several models of the Willem Programmer, each supporting many chips, but not all, so be sure to get one that supports your BIOS chip. If your chip is PLCC, you will also need a PLCC chip extractor/puller or just thread nylon string under the PLCC chip from corner to corner and yank up it straight up.
Inside mainboard BIOS (re)flash
Download the appropriate flash update utility. Build the romimage as explained above and use the flash update utility to update the BIOS. Be warned that not all update utilities allow you to load your own BIOS image. For example, Intel decided to disallow it for the MS440GX mainboard (probably after hearing about us!) Here are some mainboard specific directions:
LinuxBIOS v2 contains a flash utility called flashrom in the util/flashrom directory. (Old versions had "util/flash_and_burn/flash_rom" instead).
bash$ sudo ./flashrom -V Calibrating delay loop... Setting up microsecond timing loop 216M loops per second ok Found canidate at: 00000530-00000bc4 Found LinuxBIOS table at: 00000530 lb_table found at address 0xb7e1c530 LinuxBIOS header(24) checksum: 404a table(1684) checksum: 2766 entries: 14 vendor id: via part id: epia-m Enabling flash write on VT8235...OK Trying Am29F040B, 512 KB probe_29f040b: id1 0x20, id2 0xe2 Trying ST29F040B, 512 KB probe_29f040b: id1 0x20, id2 0xe2 ST29F040B found at physical address: 0xfff80000 Flash part is ST29F040B OK, only ENABLING flash write, but NOT FLASHING.
If neither utility supports your chip, then you could either use the DOS uniflash utility, or use its source code, which is also available for download from the uniflash site (in Turbo Pascal 7) as a reference for adding support for your flash chip to "flash_rom". Uniflash supports a lot of different flash chips, and chip interfaces. It has untested support for PCI expansion card flash BIOS, such as on RTL8139 Ethernet card (32pin DIL), which allows flashing on the NIC if manufacturer provides the circuitry.
SiS 630/950 M/Bs
Ollie Lho provided us with flash utilities for these boards under freebios/util/sis. flash_on turns on the flash write enable. This needs to be run before loading the DoC drivers. flash_rom allows you to use your SiS 630/950 M/Bs as a flash programmer. It currently supports JEDEC flash parts, AMD am29f040b models, MXIC MX29F002 models, and SST28SF040C models.
Get the System Update Package directly from Intel. mcopy the ten files created from running make phlash onto the Intel flash burner disk and use the update utility to burn the BIOS. To restore the original BIOS, set the recovery boot jumper on the motherboard, put the floppy in, and it will load and reflash the original BIOS. How do I actually burn a flash ROM?
Buy your favorite flash burner (we use a Needham Electronics EMP 30). Use make floppy to create the romimage and copy it to a floppy. Then use the provided software to burn the flash.
BIOS Savior RD1
There are some posts about the BIOS Savior RD1 that suggest its integrated flash device is of low quality; it may take 10 or more flash programming attempts to get a good update to the RD1 flash device. As a result, the following steps have proven to be successful while using the RD1:
- Step 1 - While the system is powered down, remove the original BIOS device from the mainboard and insert it into the RD1's socket.
- Step 2 - Insert the RD1 into the mainboard's flash BIOS socket.
- Step 3 - Boot the system with the RD1 set to boot from the original flash device from the mainboard.
- Step 4 - Program the original BIOS image (or other known good BIOS image) into the RD1's integrated flash device. Do this as many times as needed until the device is properly programmed and the system boots corectly from the RD1's integrated flash device. Be sure to check the settings on the RD1 so that the proper flash device is now being programmed. If the RD1 is not set correctly the working BIOS image will be erased and the system will not boot!
- Step 5 - Program the test BIOS image (usually LinuxBIOS images are among this group) into the original flash device from the mainboard. The original BIOS device usually programs OK on the first attempt. Be sure to check the settings again on the RD1 so that the proper flash device is being programmed!
The RD1 has been used in the above fashion with great success on the Tyan S2885 mainboard. Unfortunately the RD1 does not work on the nVidia CK8-04 CRB mainboard. The CK8-04 CRB may require a flash device that the RD1 does not support.
The RD1 has worked well as a "do nothing" adapter that allows swapping the BIOS flash device between a flash burner and a mainboard without any wear to the mainboard's BIOS socket.
Can I do any serious damage mucking around with this stuff?
Any time you stick your hand into an open machine while the power is on, you're risking life and limb. That said, there are also some other not-so-nice things that can happen if you mess up (not that we would know).
- Incorrect insertion of the flash (1 casualty)
- Incorrect jumper settings (1 casualty)
- Aggressive and/or inappropriate use of metal objects such as screwdrivers (2 casualties)
- Miscellaneous miswirings and mishandlings (3+ casualties)
A note on electrostatic discharge (ESD) and ESD protection (thanks to Bari Ari)
ESD can damage disk drives, boards, DoC's and other parts. The majority of the time, ESD events cause the component to degrade, but not fail testing procedures, resulting in failure at a later date. Because components do not fail immediately, technicians often underestimate the cost of not using ESD prevention measures. Provide at minimum some ESD protection by wearing an antistatic wrist strap attached to the chassis ground on your system when handling parts.
Always handle boards carefully. They can be extremely sensitive to ESD. Hold boards only by their edges. After removing a board from its protective wrapper or from the system, place it component side up on a grounded, static free surface. Use a conductive foam pad if available. Do not slide the board over any surface.
To further reduce the chances of ESD, you should create an ESD safe workstation that includes at minimum:
- Conductive rubber mat, with a lead wire that can be connected to a metal surface to create a ground.
- ESD wrist strap, which has a resistor inside the strap and a lead wire that can be connected to a metal surface as a ground. The grounding wire on the wrist strap should have between 1 and 10 Megaohms of resistance. The resistor should protect you in case you come in contact with a voltage source. If the resistor is bad or not included, the wrist strap is useless. An accidental shock could be serious and even deadly!
- Table or workspace that is clean, clear of dust, and away from electrical machinery or other equipment that generates electrical currents.
The idea is to ensure that all components you are going to interact with have the same charge. By connecting everything to the computer case, you ensure that the components of the case, the chair, and your body all have the same charge. If every object has the same charge, the electrons will not jump from one object to another minimizing the risk of ESD damage.
How do I turn off embedded sis630 devices?
From email@example.com Mon Mar 25 08:54:07 2002 Date: Mon, 25 Mar 2002 22:07:54 +0800 From: Andrew Ip To: Kei Furuuchi Cc: firstname.lastname@example.org Subject: Re: How to turn off unused pci device. Hi, > I have pcchips m758lmr which has audio chip besides sis630. > those functions in sis630 are not used in the motherboard. > But, the functions keep coming up. How do I turn off those? The following is from Nikolai Valdych previous message. Hope this help. -Andrew -- Andrew Ip Email: email@example.com Actualy, it was pretty simple 0x7c00 - All devices enabled, You play with first 4 bits only. Cos there are 4 devices, so you have any combination of 4 bits. Set bit to 1 to turn off the device, bit 0 to enable it. This is the device list: Multimedia Audio controler Modem controler Ethernet sis930 controler USB controler. For example, to turn off Ethernet + USB it would be: 0x7c0c -> 1100 in binary (first 4 bits) To turn off Multimedia audio : 0x7c01 -> 0001 in binary and so on... maybe there are more detail, but this is enogh for me, Ollie, again thanks! nikolai p.s. though my modem is not yet working..... damn driver......
What is a PIRQ table?
From Adam Sulmicki: I found beautfiul descrition of the BIOS implementation of the PIRQ in the red PCI book. I found the description of the $PIR data structure in the http://www.microsoft.com/whdc/archive/pciirq.mspx looking over linuxbios sources I see that it saves the $PIR data structure somewhere between 0xf0000 & 0x100000. so it seems I'll have to search for $PIR and then save it before copying over our bios. sigh. hoped for some fixed address in mem. -- Adam http://www.eax.com The Supreme Headquarters of the 32 bit registers
How do I set up etherboot with LinuxBIOS?
Note from Ron: I have edited this somewhat to remove Geode-specific items.
Christer Weinigel writes: To: firstname.lastname@example.org Cc: email@example.com Subject: Re: LinuxBIOS + Etherboot HOWTO? I had some trouble using LinuxBIOS + etherboot... My bad, I messed up and used mkelfImage-1.6 that I got from ftp.lnxi.com, when I realized that I ought to use the one from freebios/util everything started working. Here's what I did to get LinuxBIOS + Etherboot loading and booting a Linux kernel using TFTP. /Christer Get etherboot-5.0 from the CVS tree on etherboot.sourceforge.net. Modify etherboot-5.0/src/Config, comment out: # BIOS select don't change unless you know what you are doing #CFLAGS32+= -DPCBIOS and uncomment the following: # Options to make a version of Etherboot that will work under linuxBIOS. CFLAGS32+= -DLINUXBIOS -DCONFIG_TSC_CURRTICKS -DCONSOLE_SERIAL \ -DCOMCONSOLE=0x3f8 -DCOMPRESERVE -DCONFIG_PCI_DIRECT -DELF_IMAGE Compile Etherboot to make an elf file for your ethernet card: make bin32/natsemi.elf Compile and install mkelfImage from freebios/util/mkelfImage. Create a bootimage to put on your TFTP server: mkelfImage --command-line="root=/dev/hda2 console=ttyS0,38400" \ --kernel vmlinux -o /tftpboot/kernel Finally, make sure that your BOOT/DCHP server is answering and that the TFTP server is active. Tell LinuxBIOS to boot an elf Image, and tell LinuxBIOS where it is: option USE_ELF_BOOT=1 I have placed natsemi.elf in the first 64k of my BIOS flash chip, and LinuxBIOS in the second 64k. insmod bios.o dd if=natsemi.elf of=/dev/bios bs=64k dd if=linuxbios.rom of=/dev/bios bs=64k seek=1 Finally boot LinuxBIOS.
How do I set GEODE video?
Please see here.
How do I set up testbios?
Please read the testbios FAQ.
/usr/sbin/iasl: Command not found
If you see this error, you have to install iasl, Intel's ASL Optimizing Compiler:
- SUSE ships it in the pmtools package (pmtools-20050823-3.x86_64.rpm, pmtools-20050823-3.i586.rpm). If you want to run rpmbuild --rebuild: pmtools-20050823-3.src.rpm.
- Debian ships it in the iasl package (apt-get install iasl).
- You can also download the latest version of the source code.
How can I write to port 0x80 from userspace?
This might be useful sometimes:
printf "\001" | dd bs=1 seek=128 of=/dev/port
Is LinuxBIOS applying x86 microcode patches?
And if yes, can they be modified?
Answer: this field is little documented.