Upgrading firmware: Difference between revisions

From OLPC
Jump to navigation Jump to search
(q7c07 13.2.9 signed release)
 
(71 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{OLPC}}{{users}}
{{OLPC}}{{users}}
== Steps for Upgrading [[Firmware]] ==


How to upgrade only the [[firmware]] on an XO laptop.
<!-- Q2D08, too many bug fixes for the ship2.2 patch - would be good for Update1. See [[TestMtg%2C_2008-01-07]]. -->
__TOC__


== Automatic ==
G1G1 donors: You can install [http://dev.laptop.org/milestone/Update.1 Update.1] also known as [[Release Notes/8.1.0|release 8.1.0]], which includes a system firmware upgrade.
To upgrade your firmware automatically, please [[Upgrading the XO|upgrade the operating system]].


However, some older firmware may need to be upgraded manually.
The following instructions are specifically for upgrades to new signed (official release) versions of the firmware distributed as .zip files. Development versions are provided as unsigned .rom files and need a developer key and a different upgrade process, as do firmware downgrades. Please refer to [[Manual Firmware Install]] for more details about the alternate methods.
You should only need to do this if a problem in the firmware affects you.


== Manual ==
:<big><font color="red">ALL steps must be followed<i> exactly</i>.</font></big>


=== Ingredients ===
# Make sure your battery is charged.
# Plug up the XO on external power.
#:If you lose power during a firmware upgrade you will brick the laptop.
=== Using a USB flash drive and another computer===
# Right click and select "save as" on the following link:
#: http://dev.laptop.org/pub/firmware/q2d14/bootfw.zip
# Create a folder called "boot" on the flash drive
# Copy the above .zip to the flash drive (do NOT unzip the file)
# Remove the flash drive
# Power off the XO, and ensure it is plugged in
# Insert the flash drive
# Power on the XO
# It should indicate that it is rewriting the firmware


*a [[USB drive]] with at least 4 MB free space,
=== Using only your XO ===
*an internet connection,
# Open the [[Terminal activity]] [[Image:Activity-terminal.svg|35px]] or a [[console]]
*a charged battery in the XO laptop,
# Type the following (press the Enter key after each line):
*external power for the XO laptop,
su -
*about ten minutes.
wget http://dev.laptop.org/pub/firmware/q2d14/bootfw.zip
cp /home/olpc/bootfw.zip /versions/boot/current/boot/
reboot
<ol><li value="3"> The laptop will then reboot twice more on its own. (Once to enable writing to the flash and then a 2nd time after its done updating.)</li></ol>


=== Recipe ===
The XO will only upgrade the system firmware if it finds that its current version is earlier than what is in bootfw.zip

* create a new folder named {{Code|boot}} on your USB drive,
* in the table below, select your XO laptop model and [[download]] the corresponding {{Code|bootfw.zip}} file; these are the latest signed firmware files from OLPC OS 13.2.5-17:
<!--
for the 13.2.5 release these were obtained with a shell script
crank:~quozl/open-firmware-signed-release-for-wiki.sh
which also generates the table rows
-->
<center>
{| border="1" cellspacing="0" cellpadding="2" class="wikitable"
! model
! version
! download
|-
| XO-1
| q2f20
| [http://dev.laptop.org/pub/firmware/q2f20/bootfw.zip bootfw.zip]
|-
| XO-1.5
| q3c17
| [http://dev.laptop.org/pub/firmware/q3c17/bootfw.zip bootfw.zip]
|-
| XO-1.75
| q4d38
| [http://dev.laptop.org/pub/firmware/q4d38/bootfw.zip bootfw.zip]
|-
| XO-4
| q7c07
| [http://dev.laptop.org/pub/firmware/q7c07/bootfw.zip bootfw.zip]
|}
</center>
* save the file to your USB drive in the folder named {{Code|boot}}, (do not expand the file, it must remain as {{Code|bootfw.zip}}),
* safely remove the USB drive,
* shutdown and turn off your XO laptop,
* make sure the battery is in place and locked,
* make sure the power cord and adapter are plugged in, the battery indicator must be on,
* insert the USB drive into the XO laptop,
* hold down the {{Code|X}} game key while pressing and releasing the power button,
* wait for the message asking you to release the game keys, and then release the {{Code|X}} game key,
* wait for update messages to be displayed,
* wait for the XO laptop to reboot.

=== Troubleshooting ===

If a USB drive is ignored by the XO:

* check that the USB drive has a folder named {{Code|boot}},
* check that the {{Code|boot}} folder has a file {{Code|bootfw.zip}},
* check that the USB drive has a partition table type of "DOS MBR" rather than "GPT", see also [[Firmware/Storage/Formats|supported combinations]],
* try a different USB drive,
* try a different USB port,
* check that the firmware actually needs upgrading; the USB drive will seem to be ignored if the version on the drive is equal to or earlier than the version on the laptop.

If the XO is faulty, firmware upgrade may not begin:
* if the display does not light up, or the XO icon does not appear, see [[fix clock]] for upgrading firmware using a [[serial adapter]].

== How it Works ==

The firmware on the XO runs when the power is turned on. It plays a startup sound. If the laptop is secured, or if the X game key is held down, it looks for boot/bootfw.zip on all available storage devices; internal storage, SD card, and USB drives. If a bootfw.zip is found, the firmware checks to see if the cryptographic signature of the file matches the OLPC keys, and if the version is later than itself. If both checks pass, the firmware checks for external power and a reasonably charged battery. If these are present, then the firmware updates itself from the file, writing to the internal SPI flash chip. Then it reboots, thus running the new firmware version.

== Developers ==

If your laptop is locked, and you cannot [[collection stick|unlock it]], you must use the ''signed'' firmware method [[#Manual|above]]. If your laptop is unlocked, see [[Firmware]] for upgrade instructions.

Latest revision as of 08:33, 20 December 2017

  This page is monitored by the OLPC team.
  For the general public

How to upgrade only the firmware on an XO laptop.

Automatic

To upgrade your firmware automatically, please upgrade the operating system.

However, some older firmware may need to be upgraded manually. You should only need to do this if a problem in the firmware affects you.

Manual

Ingredients

  • a USB drive with at least 4 MB free space,
  • an internet connection,
  • a charged battery in the XO laptop,
  • external power for the XO laptop,
  • about ten minutes.

Recipe

  • create a new folder named boot on your USB drive,
  • in the table below, select your XO laptop model and download the corresponding bootfw.zip file; these are the latest signed firmware files from OLPC OS 13.2.5-17:
model version download
XO-1 q2f20 bootfw.zip
XO-1.5 q3c17 bootfw.zip
XO-1.75 q4d38 bootfw.zip
XO-4 q7c07 bootfw.zip
  • save the file to your USB drive in the folder named boot, (do not expand the file, it must remain as bootfw.zip),
  • safely remove the USB drive,
  • shutdown and turn off your XO laptop,
  • make sure the battery is in place and locked,
  • make sure the power cord and adapter are plugged in, the battery indicator must be on,
  • insert the USB drive into the XO laptop,
  • hold down the X game key while pressing and releasing the power button,
  • wait for the message asking you to release the game keys, and then release the X game key,
  • wait for update messages to be displayed,
  • wait for the XO laptop to reboot.

Troubleshooting

If a USB drive is ignored by the XO:

  • check that the USB drive has a folder named boot,
  • check that the boot folder has a file bootfw.zip,
  • check that the USB drive has a partition table type of "DOS MBR" rather than "GPT", see also supported combinations,
  • try a different USB drive,
  • try a different USB port,
  • check that the firmware actually needs upgrading; the USB drive will seem to be ignored if the version on the drive is equal to or earlier than the version on the laptop.

If the XO is faulty, firmware upgrade may not begin:

  • if the display does not light up, or the XO icon does not appear, see fix clock for upgrading firmware using a serial adapter.

How it Works

The firmware on the XO runs when the power is turned on. It plays a startup sound. If the laptop is secured, or if the X game key is held down, it looks for boot/bootfw.zip on all available storage devices; internal storage, SD card, and USB drives. If a bootfw.zip is found, the firmware checks to see if the cryptographic signature of the file matches the OLPC keys, and if the version is later than itself. If both checks pass, the firmware checks for external power and a reasonably charged battery. If these are present, then the firmware updates itself from the file, writing to the internal SPI flash chip. Then it reboots, thus running the new firmware version.

Developers

If your laptop is locked, and you cannot unlock it, you must use the signed firmware method above. If your laptop is unlocked, see Firmware for upgrade instructions.