board/olpc: add readme.txt
PATCH 1/1 board/olpc: add readme.txt
This adds some instructions on how to build and run images for the OLPC XO laptops.
Signed-off-by Lubomir Rintel <[email protected]>
--- board/olpc/readme.txt | 72 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 board/olpc/readme.txt
board/olpc/readme.txt new file +72 -0
@@ -0,0 +1,72 @@ +OLPC XO Laptops +=============== + +This document explains how to build and run images that run on the OLPC +XO laptops. + +Supported models +---------------- + +* OLPC XO-1 + The original NS Geode based OLPC laptop, uses the x86 architecture. + +* OLPC XO-7.5 + The ARM-based laptop. Needs a recent enough firmware to provide a good + enough flattened device tree to the kernel. + +Configure and build +=================== + + $ make olpc_xo1_defconfig # Configure for XO-1 + $ make olpc_xo175_defconfig # Configure for XO-1.75 + $ make menuconfig # Customize the build configuration + $ make # Build + +Create the bootable media +========================= + +When the build is finished, the resulting image file will be called +"sdcard.img". It can be written directly to a SD-card or and USB flash stick. + +Please double check that you're using the right device (e.g. with "lsblk" +command). Doing the following will DESTROY ALL DATA that's currently on the +media. + + # cat output/images/sdcard.img >/dev/<device> + +Preparing the machine +===================== + +Firmware security +----------------- + +Most OLPC machines were shipped with the security system that disallows +booting unsigned software. If this is the case with your machine, in order +to run the image you've built on it you'll need to get a developer key and +deactivate the security system. + +The procedure is descriped in the OLPC wiki: +http://wiki.laptop.org/go/Activation_and_Developer_Keys + +Firmware upgrade +---------------- + +It is always preferrable to use an up to date firmware. The firmware images +are available at http://wiki.laptop.org/go/Firmware. For the XO-1.75 laptop +to boot the mainline kernel a firmware Q4E00JA or newer is needed. You can +get it at http://dev.laptop.org/~quozl/q4e00ja.rom. + +To update the firmware, place the .rom file on to your bootable media, +connect a charged battery pack and a wall adapter, and enter the Open +Firmware prompt by pressing ESC during the early boot (needs an unlocked +laptop -- see "Firmware security" above). Then use the "flash" command +to update the firmware: + + ok flash ext:\q4e00ja.rom \ Flash the "q4e00ja.rom" from the SD card + ok flash u:\q4e00ja.rom \ Flash the "q4e00ja.rom" from USB stick + +Booting the machine +=================== + +Once your machine is unlocked, it will automatically boot from your media +wherever it will detect it attached to the USB bus or the SD card slot.
Signature · 1 line
2.26.0
PATCH 1/1 board/olpc: add readme.txt
Quoted 4 lines · On Sun, 19 Apr 2020 10:39:23 +0200 Lubomir Rintel <[email protected]> wrote:
This adds some instructions on how to build and run images for the OLPC XO laptops.
Signed-off-by Lubomir Rintel <[email protected]>
Thanks, I've applied, after changing one small thing, see below.
board/olpc/readme.txt line 23
Quoted 4 lines
board/olpc/readme.txt new file +4
-0+ $ make olpc_xo1_defconfig # Configure for XO-1 + $ make olpc_xo175_defconfig # Configure for XO-1.75 + $ make menuconfig # Customize the build configuration + $ make # Build
Changed to:
===
$ make olpc_xo1_defconfig # Configure for XO-1
or:
$ make olpc_xo175_defconfig # Configure for XO-1.75
Then:
$ make menuconfig # Customize the build configuration $ make # Build
===
Indeed, the two make <foo>_defconfig commands could have been confusing for a newcomer. I made it explicit that you want to do one or the other, not both.
Thanks!
Thomas
Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin Embedded Linux and Kernel engineering https://bootlin.com