Programming the SPI FLASH

The OLPC LinuxBIOS includes an "olpcflash" utility that lets you reprogram the main SPI FLASH that contains LinuxBIOS and the microcode for the EC controller chip.

Layout

The spansion 25FL008A SPI 1 MiB flash on the unit is divided into 2 main areas.

• The EC area (0x0 - 0xffff)
• The LinuxBIOS area (0x10000 - 0xfffff)

The EC (Embedded Controller) area is where the code for the code for the EC lives. Changing the code in this area unless you really know what you are doing and are prepared to deal with the breakage that can occur is a Very Bad Thing. There is currently not a recovery method if you trash your EC code.

Because of this olpcflash does not mess with the first 64KiB of the part.

Usage

• If you plan to write to the SPI FLASH, make sure you won't lose power; you really don't want to have a bad BIOS flash. If possible, plug your board into an uninterruptible power supply.
• Boot to the LinuxBIOS shell prompt.
• Mount some device (e.g. a USB flash key) to use for file storage. If you want to write a new image to the SPI FLASH, make sure that image file is already on the device.
• cd to a directory on the mounted device

To Read the LinuxBIOS area.

$ olpcflash -r filename

To Write the LinuxBIOS area. (Write will erase the area first)

$ olpcflash -w filename

To Verify the contents of the LinuxBIOS area vs a file.

$ olpcflash -v filename

If the verify fails, do not power off or reboot your machine as you may not be able to reboot if the flash has been corrupted; please reattempt to write and verify the flash. If the write/verify operations continue to fail, please get help. A good channel for help is the #OLPC IRC channel on irc.freenode.net.

Testing/developement method was to compile it static and copy it to a USB key. Then using a serial console boot under the buildrom env from PLCC, mount the USB key, and run the program.

Olpcflash is in the process of getting added to buildrom and to various image files. Look for it to show up in a n image near you soon.

Known Issues

• THERE ARE NO SAFEGUARDS!!!

• Writing to the SPI FLASH is really slow.

Currently it takes a little over 11 minutes to program the part. A large part of this is due to only doing a single byte each program cycle. The part can program up to 256 bytes each cycle so that may be the next feature to add. According to the typical program time in the datasheet it will only drop to around 6 minutes though so it may not be worth it.

• Re-entry from KBC reset back into KBC run mode causes the board to reboot.

Need to ask EnE about this. For now putting the KBC back into run mode after I finish the operation is disabled. This will allow you to use verify and make sure it worked ok. If you use a PS2 keyboard you are toast at this point.

• Booting from the SPI FLASH is a bit slower than from the PLCC FLASH. The main place where

this is noticeable is just after the message "Copying LinuxBIOS to RAM."

How to do it the first time

So how can you get it going the first time, before you have an olpcflash-equipped LinuxBIOS installed?

If you have the ability to program PLCC FLASH chips for the OLPC board (see Flashing LinuxBIOS), you can just build the latest LinuxBIOS (see Building LinuxBIOS), load it into a PLCC FLASH, then boot from that.

Otherwise, you'll have to build olpcflash.c from source, put the executable file onto an external device like a USB FLASH, and run it under a Linux environment.

You can get the latest source code from the buildrom tree (see Building LinuxBIOS) in work/olpcflash/olpcflash/olpcflash.c . (Perhaps the string "olpclflash" should appear a few more times in the path; one wonders if 3 copies is enough :-)

To compile:

gcc -O olpcflash.c -o olpcflash

or if you test it under the buildrom uClibc env then you will need to add the -static option