diff options
Diffstat (limited to 'docs/install/index.md')
| -rw-r--r-- | docs/install/index.md | 163 |
1 files changed, 85 insertions, 78 deletions
diff --git a/docs/install/index.md b/docs/install/index.md index 4bd14cf1..70dd554e 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -4,10 +4,10 @@ title: Installation instructions This section relates to installing Libreboot on supported targets. -**NOTE: if running flashrom -p internal for software based flashing, and -you get an error related to /dev/mem access, you should reboot with -iomem=relaxed kernel parameter before running flashrom, or use a kernel -that has CONFIG\_STRICT\_DEVMEM not enabled.** +NOTE: if running `flashrom -p internal` for software based flashing, and you +get an error related to `/dev/mem` access, you should reboot with +`iomem=relaxed` kernel parameter before running flashrom, or use a kernel that +has `CONFIG_STRICT_DEVMEM` not enabled. Which systems are Libreboot compatible with? -------------------------------------------- @@ -28,14 +28,11 @@ Flashing via software methods, on system: - [Apple MacBook2,1](#flashrom_macbook21) - [ASUS Chromebook C201](c201.md) -Setting up programmers, for external flashing via hardware method +Setting up programmers, for external SPI flashing ----------------------------------------------------------------- -- [How to program an SPI flash chip with the BeagleBone - Black](bbb_setup.md) - -- [How to program an SPI flash chip with the Raspberry - Pi](rpi_setup.md) +- [BeagleBone Black Setup](bbb_setup.md) +- [Raspberry Pi Setup](rpi_setup.md) Flashing via hardware methods, on system: ----------------------------------------- @@ -63,15 +60,14 @@ source code. These images are provided for user convenience, so that they don't have to build anything from source on their own. The ROM images in each archive use the following at the end of the file -name, if they are built with the GRUB payload: -**\_*keymap*\_*mode*.rom** +name, if they are built with the GRUB payload: `*_*keymap*_*mode*.rom` -Available *modes*: **vesafb** or **txtmode**. The *vesafb* ROM images -are recommended, in most cases; *txtmode* ROM images come with +Available `modes`: `vesafb` or `txtmode`. The `vesafb` ROM images +are recommended, in most cases; `txtmode` ROM images come with MemTest86+, which requires text-mode instead of the usual framebuffer used by coreboot native graphics initialization. -*keymap* can be one of several keymaps that keyboard supports (there are +`keymap` can be one of several keymaps that keyboard supports (there are quite a few), which affects the keyboard layout configuration that is used in GRUB. It doesn't matter which ROM image you choose here, as far as the keymap in GNU+Linux is concerned. @@ -87,12 +83,10 @@ Libreboot comes with ROM images built for QEMU, by default: Examples of how to use libreboot ROM images in QEMU: -- \$ **qemu-system-i386 -M q35 -m 512 -bios - qemu\_q35\_ich9\_keymap\_mode.rom** -- \$ **qemu-system-i386 -M pc -m 512 -bios - qemu\_i440fx\_piix4\_keymap\_mode.rom** + $ qemu-system-i386 -M q35 -m 512 -bios qemu_q35_ich9_keymap_mode.rom + $ qemu-system-i386 -M pc -m 512 -bios qemu_i440fx_piix4_keymap_mode.rom -You can optionally specify the **-serial stdio** argument, so that QEMU +You can optionally specify the `-serial stdio` argument, so that QEMU will emulate a serial terminal on the standard input/output (most likely your terminal emulator or TTY). @@ -108,8 +102,8 @@ any dedicated hardware. In other words, you can do everything entirely in software, directly from the OS that is running on your libreboot system. -**If you are using libreboot\_src or git, then make sure that you built -the sources first (see [../git/\#build](../git/#build)).** +*If you are using `libreboot_src` or git, then make sure that you built the +sources first (see [../git/\#build](../git/#build)).* Look at the [list of ROM images](#rom) to see which image is compatible with your device. @@ -149,9 +143,9 @@ now have a backup of the old image). Keeping at least one spare LPC PLCC chip with working firmware on it is highly recommended, in case of bricks. -**DO NOT hot-swap the chip with your bare hands. Use a PLCC chip +*DO NOT hot-swap the chip with your bare hands. Use a PLCC chip extractor. These can be found online. See -<http://www.coreboot.org/Developer_Manual/Tools#Chip_removal_tools>** +<http://www.coreboot.org/Developer_Manual/Tools#Chip_removal_tools>* Do check the HCL entry: [../hardware/kfsn4-dre.md](../hardware/kfsn4-dre.md) @@ -165,9 +159,9 @@ If you already have coreboot or libreboot installed, without write protection on the flash chip, then you can do it in software (otherwise, see link above). -**DO NOT hot-swap the chip with your bare hands. Use a PDIP-8 chip +*DO NOT hot-swap the chip with your bare hands. Use a PDIP-8 chip extractor. These can be found online. See -<http://www.coreboot.org/Developer_Manual/Tools#Chip_removal_tools>** +<http://www.coreboot.org/Developer_Manual/Tools#Chip_removal_tools>* Do check the HCL entry: [../hardware/kgpe-d16.md](../hardware/kgpe-d16.md) @@ -181,9 +175,9 @@ If you already have coreboot or libreboot installed, without write protection on the flash chip, then you can do it in software (otherwise, see link above). -**DO NOT hot-swap the chip with your bare hands. Use a PDIP-8 chip +*DO NOT hot-swap the chip with your bare hands. Use a PDIP-8 chip extractor. These can be found online. See -<http://www.coreboot.org/Developer_Manual/Tools#Chip_removal_tools>** +<http://www.coreboot.org/Developer_Manual/Tools#Chip_removal_tools>* Do check the HCL entry: [../hardware/kcma-d8.md](../hardware/kcma-d8.md) @@ -215,13 +209,13 @@ write-protected SPI flash requires external re-flashing, as is also the case when running the proprietary firmware). If you did not write-protect the flash chip, or it came to you without -any write-protection (***libreboot does not write-protect the flash chip -by default, so this probably applies to you***), read on! +any write-protection (*libreboot does not write-protect the flash chip +by default, so this probably applies to you*), read on! MAC address on GM45 (X200/R400/T400/T500/W500) ----------------------------------------- -**Users of the X200/R400/T400/T500/W500 take note:** The MAC address for the +*Users of the X200/R400/T400/T500/W500 take note:* The MAC address for the onboard ethernet chipset is located inside the flash chip. Libreboot ROM images for these laptops contain a generic MAC address by default, but this is not what you want. *Make sure to change the MAC address inside @@ -241,20 +235,21 @@ Apple iMac 5,2? Internal flashing works, even when flashing from Apple EFI to libreboot. Continue reading the instructions below. -**NOTE: If you're flashing an older version of Libreboot, the iMac5,2 +*NOTE: If you're flashing an older version of Libreboot, the iMac5,2 motherboard is compatible with the MacBook2,1. Simply flash a MacBook2,1 -ROM image, and it should work.** +ROM image, and it should work.* Flash chip size --------------- Use this to find out: + # flashrom -p internal -V All good? --------- -Excellent! Moving on\... +Excellent! Moving on... Download the *libreboot\_util.tar.xz* archive, and extract it. Inside, you will find a directory called *flashrom*. This contains statically @@ -268,6 +263,7 @@ appropriate executable. It is also possible for you to build these executables from the libreboot source code archives. How to update the flash chip contents: + $ sudo ./flash update [yourrom.rom](#rom) Ocassionally, coreboot changes the name of a given board. If flashrom @@ -276,88 +272,100 @@ correct ROM image, then run this alternative command: $ sudo ./flash forceupdate [yourrom.rom](#rom) -You should see **"Verifying flash\... VERIFIED."** written at the end -of the flashrom output. **Shut down** after you see this, and then boot +You should see `Verifying flash... VERIFIED.` written at the end +of the flashrom output. *Shut down* after you see this, and then boot up again after a few seconds. ThinkPad X60/T60: Initial installation guide (if running the proprietary firmware) {#flashrom_lenovobios} ================================================================================== -**This is for the ThinkPad X60 and T60 while running Lenovo BIOS. If you +*This is for the ThinkPad X60 and T60 while running Lenovo BIOS. If you already have coreboot or libreboot running, then go to -[\#flashrom](#flashrom) instead!** +[\#flashrom](#flashrom) instead!* -**If you are flashing a Lenovo ThinkPad T60, be sure to read -[../hardware/\#supported\_t60\_list](../hardware/#supported_t60_list)** +*If you are flashing a Lenovo ThinkPad T60, be sure to read +[../hardware/\#supported\_t60\_list](../hardware/#supported_t60_list)* -**If you are using libreboot\_src or git, then make sure that you built -the sources first (see [../git/\#build](../git/#build)).** +*If you are using libreboot\_src or git, then make sure that you built +the sources first (see [../git/\#build](../git/#build)).* -**Warning: this guide will not instruct the user how to backup the +*Warning: this guide will not instruct the user how to backup the original Lenovo BIOS firmware. These backups are tied to each system, and will not work on any other. For that, please refer to -<http://www.coreboot.org/Board:lenovo/x60/Installation>.** +<http://www.coreboot.org/Board:lenovo/x60/Installation>.* + +*If you're using libreboot 20150518, note that there is a mistake in +the flashing script. do this: * -**If you're using libreboot 20150518, note that there is a mistake in -the flashing script. do this: *rm -f patch && wget -O flash -https://notabug.org/libreboot/libreboot/raw/9d850543ad90b72e0e333c98075530b31e5d23f1/flash -&& chmod +x flash*** + rm -f patch + wget -O flash https://notabug.org/libreboot/libreboot/raw/9d850543ad90b72e0e333c98075530b31e5d23f1/flash + chmod +x flash The first half of the procedure is as follows: $ sudo ./flash i945lenovo\_firstflash [yourrom.rom](#rom). -You should see within the output the following:\ -**"Updated BUC.TS=1 - 64kb address ranges at 0xFFFE0000 and 0xFFFF0000 -are swapped"**. +You should see within the output the following: + + Updated BUC.TS=1 - 64kb address ranges at 0xFFFE0000 and 0xFFFF0000 are + swapped + +You should also see within the output the following: + + Your flash chip is in an unknown state + ... + FAILED + ... + DO NOT REBOOT OR POWEROFF -You should also see within the output the following:\ -**"Your flash chip is in an unknown state"**, **"FAILED"** and -**"DO NOT REBOOT OR POWEROFF"**\ -Seeing this means that the operation was a **resounding** success! -**DON'T PANIC**. +Seeing this means that the operation was a *resounding* success! +*DON'T PANIC*. See this link for more details: <http://thread.gmane.org/gmane.linux.bios.flashrom/575>. -If the above is what you see, then **SHUT DOWN**. Wait a few seconds, +If the above is what you see, then *SHUT DOWN*. Wait a few seconds, and then boot; libreboot is running, but there is a 2nd procedure -**\*needed\*** (see below). +needed (see below). When you have booted up again, you must also do this: $ sudo ./flash i945lenovo\_secondflash [yourrom.rom](#rom) -If flashing fails at this stage, try the following:\ -\$ **sudo ./flashrom/i686/flashrom -p -internal:laptop=force\_I\_want\_a\_brick -w [yourrom.rom](#rom)** +If flashing fails at this stage, try the following: -You should see within the output the following:\ -**"Updated BUC.TS=0 - 128kb address range 0xFFFE0000-0xFFFFFFFF is -untranslated"** + # sudo ./flashrom/i686/flashrom -p -You should also see within the output the following:\ -**"Verifying flash\... VERIFIED."** +internal:laptop=force\_I\_want\_a\_brick -w [yourrom.rom](#rom) + +You should see within the output the following: + + Updated BUC.TS=0 - 128kb address range 0xFFFE0000-0xFFFFFFFF is + untranslated + +You should also see within the output the following: + + Verifying flash... VERIFIED. MacBook2,1: Initial installation guide (if running the proprietary firmware) {#flashrom_macbook21} ============================================================================ -**If you have a MacBook1,1, refer to -[../hardware/\#macbook11](../hardware/#macbook11) for flashing instructions.** +*If you have a MacBook1,1, refer to +[../hardware/\#macbook11](../hardware/#macbook11) for flashing instructions.* -**This is for the MacBook2,1 while running Apple EFI firmware. If you +*This is for the MacBook2,1 while running Apple EFI firmware. If you already have coreboot or libreboot running, then go to -[\#flashrom](#flashrom) instead!** +[\#flashrom](#flashrom) instead!* Be sure to read the information in [../hardware/\#macbook21](../hardware/#macbook21). -**Warning: this guide will not instruct the user how to backup the +*Warning: this guide will not instruct the user how to backup the original Apple EFI firmware. For that, please refer to -<http://www.coreboot.org/Board:apple/macbook21>.** +<http://www.coreboot.org/Board:apple/macbook21>.* -**If you are using libreboot\_src or git, then make sure that you built -the sources first (see [../git/\#build](../git/#build)).** +*If you are using libreboot\_src or git, then make sure that you built +the sources first (see [../git/\#build](../git/#build)).* Look at the [list of ROM images](#rom) to see which image is compatible with your device. @@ -366,15 +374,14 @@ Use this flashing script, to install libreboot: $ sudo ./flash i945apple\_firstflash [yourrom.rom](#rom) -You should also see within the output the following:\ -**"Verifying flash\... VERIFIED."** +You should also see within the output the following: + + Verifying flash... VERIFIED. Shut down. Copyright © 2014, 2015, 2016 Leah Rowe <info@minifree.org>\ - - Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License Version 1.3 or any later version published by the Free Software Foundation |