diff options
Diffstat (limited to 'posts/2019-04-02-17:57-flashing-coreboot-on-a-lenovo-thinkpad-x220-with-a-ch341a-usb-programmer-tutorial.md')
| -rw-r--r-- | posts/2019-04-02-17:57-flashing-coreboot-on-a-lenovo-thinkpad-x220-with-a-ch341a-usb-programmer-tutorial.md | 432 |
1 files changed, 432 insertions, 0 deletions
diff --git a/posts/2019-04-02-17:57-flashing-coreboot-on-a-lenovo-thinkpad-x220-with-a-ch341a-usb-programmer-tutorial.md b/posts/2019-04-02-17:57-flashing-coreboot-on-a-lenovo-thinkpad-x220-with-a-ch341a-usb-programmer-tutorial.md new file mode 100644 index 0000000..3045d39 --- /dev/null +++ b/posts/2019-04-02-17:57-flashing-coreboot-on-a-lenovo-thinkpad-x220-with-a-ch341a-usb-programmer-tutorial.md @@ -0,0 +1,432 @@ +title: Flashing coreboot on a Lenovo Thinkpad X220 with a ch341a USB programmer Tutorial +author: Andreas +date: 2019-04-02 17:57 +tags: Lenovo Thinkpad X220, coreboot, flashrom, Raspberry Pi, ch341a +--- + +In this tutorial, we will go through the steps to get [coreboot](https://www.coreboot.org/) compiled and flashed on a **Lenovo Thinkpad X220** laptop. +We'll also change the Wifi card so that Wifi will work with a libre kernel driver. + +***Updated 2022-01-13: Use latest coreboot-4.15 release*** + +# Prerequisites + + + +Things you need: + +- Lenovo Thinkpad X220 +- Atheros AR9382 AR5BHB116 Mini PCIE Dual Band Wifi card +- ch341a USB programmer or Raspberry Pi +- Pomona 5250 SOIC-8 clip +- 6 x 10 cm female - female jumper wires +- Screwdriver + +This tutorial assumes you're using a GNU/Linux distro and are familiar +with how to use a terminal. + +[Debian GNU/Linux](https://www.debian.org/) 11 (bullseye) was used to +compile the coreboot image produced in this tutorial. + +Files needed: + +[`dejavusansmono.pf2`](/static/blog/media/x220/dejavusansmono.pf2)\ +[`grub.cfg`](/static/blog/media/x220/grub.cfg)\ +[`background.jpg`](/static/blog/media/x220/background.jpg) + +For more information about DejaVu Fonts, see:\ +[https://dejavu-fonts.github.io/](https://dejavu-fonts.github.io/) + +For DejaVu Font license, see:\ +[https://dejavu-fonts.github.io/License.html](https://dejavu-fonts.github.io/License.html) + +'**background.jpg**' is borrowed from the libreboot project and it's license +information is as follows: + +```plaintext +These images are based on http://libreboot.org/logo/logo.svg +which is Copyright 2014 Marcus Moeller and released under CC-0 +https://creativecommons.org/publicdomain/zero/1.0/legalcode +``` + +# Packages needed to compile flashrom/coreboot/grub + +```sh +sudo apt-get build-dep flashrom grub +sudo apt-get install git build-essential gnat flex bison libncurses5-dev libfreetype-dev pkg-config unifont wget +``` + +# Compile flashrom + +Clone flashrom git repository: + +```sh +git clone https://review.coreboot.org/flashrom.git +``` + +Compile flashrom: + +```sh +cd flashrom +sudo make install +sudo cp /usr/local/sbin/flashrom /usr/local/bin/ +``` + +# Compile GRUB + +See '**Prerequisites**' above for the files needed. + +Clone GRUB git repository: + +```sh +git clone https://git.savannah.gnu.org/git/grub.git +``` + +Compile GRUB: + +```sh +cd grub +./bootstrap +./configure --with-platform=coreboot +make -j4 +``` + +Create '**pack-payload-minimal.sh**' script file: + +```sh +touch pack-payload-minimal.sh +chmod +x pack-payload-minimal.sh +``` + +Paste the following in '**pack-payload-minimal.sh**': + +```sh +#! /bin/bash + +# ./pack-payload-minimal.sh – To be invoked within GRUB project folder, packs +# an executable elf payload file for the coreboot project, using just one +# keyboard layout file. Adapt “settings” to your needs. Specify a lighter +# pf2-fontfile if available on your system. + +# settings +elf_output="grub2.elf" +#pf2_fontfile="unicode.pf2" +pf2_fontfile="dejavusansmono.pf2" +keyboard_layout="se" +grub_modules="cbfs" + +# generate keyboard layout +ckbcomp "${keyboard_layout}" | ./grub-mklayout -o "${keyboard_layout}.gkb" + +# pack the GRUB payload file +./grub-mkstandalone \ + --grub-mkimage=./grub-mkimage \ + -O i386-coreboot \ + -o "${elf_output}" \ + -d grub-core \ + --fonts= \ + --themes= \ + --locales= \ + --modules="${grub_modules}" \ + /boot/grub/grub.cfg=coreboot.cfg \ + /boot/grub/fonts/${pf2_fontfile}="${pf2_fontfile}" \ + /boot/grub/layouts/${keyboard_layout}.gkb="${keyboard_layout}.gkb" + +# message +echo "Payload ${elf_output} has been packed with:" +echo " * fontfile: ${pf2_fontfile}" +echo " * keyboard layout: ${keyboard_layout}" +echo " * GRUB modules, to be preloaded: ${grub_modules}" + +# code snippet suggestion +echo "Don't forget to add 'keymap ${keyboard_layout}' to your GRUB Configuration File." + +# clean up +rm "${keyboard_layout}.gkb" +``` + +Execute the script to create '**grub2.elf**' file: + +```sh +./pack-payload-minimal.sh +``` + +# Connect programmer to flash chip + +See [`Setup Raspberry Pi for flashing with flashrom Tutorial`](../../2022/setup-raspberry-pi-for-flashing-with-flashrom-tutorial/) +if you're using a Raspberry Pi. + +Remove the following parts to access the flash chip: + +```plaintext +Battery +Keyboard +Palmrest +``` + + + +Connect Pomona 5250 to flash chip like this: + +```plaintext +Screen (furthest from you) + __ + MOSI 5 --| |-- 4 GND + CLK 6 --| |-- 3 N/C + N/C 7 --| |-- 2 MISO + 3.3v 8 --|__|-- 1 CS + + N/C = Not connected / Not used + + Edge (closest to you) +``` + + + +# Read Factory BIOS + +Read Factory BIOS 3 times if using **ch341a**: + +```sh +sudo flashrom -p ch341a_spi -r factory_bios_01.rom -V +sudo flashrom -p ch341a_spi -r factory_bios_02.rom -V +sudo flashrom -p ch341a_spi -r factory_bios_03.rom -V +``` + +Read Factory BIOS 3 times if using **Raspberry Pi**: + +```sh +sudo flashrom -p linux_spi:dev=/dev/spidev0.0,spispeed=32768 -r factory_bios_01.rom -V +sudo flashrom -p linux_spi:dev=/dev/spidev0.0,spispeed=32768 -r factory_bios_02.rom -V +sudo flashrom -p linux_spi:dev=/dev/spidev0.0,spispeed=32768 -r factory_bios_03.rom -V +``` + +Make sure checksums are identical: + +```plaintext +sha512sum *.rom +``` + +# Download coreboot + +Download coreboot: + +```sh +wget https://coreboot.org/releases/coreboot-4.15.tar.xz +wget https://coreboot.org/releases/coreboot-blobs-4.15.tar.xz +``` + +**coreboot-blobs-4.15.tar.xz** is needed for CPU microcode updates. + +Extract coreboot and blobs needed: + +```sh +tar xvf coreboot-4.15.tar.xz +tar xvf coreboot-blobs-4.15.tar.xz --strip-components=1 -C coreboot-4.15 +``` + +Create folder to hold '**descriptor/gbe/me.bin**' files: + +```sh +mkdir -pv coreboot-4.15/3rdparty/blobs/mainboard/lenovo/x220/ +``` + +Extract blob files from Factory BIOS (see '**flashrom/util/ich_descriptors_tool**' folder: + +```sh +cd ~/misc-src/flashrom/util/ich_descriptors_tool +./ich_descriptors_tool -f your/path/to/factory_bios.rom -d +``` + +Copy blob files to coreboot folder: + +```sh +cp factory_bios.rom.Descriptor.bin ~/misc-src/coreboot-4.15/3rdparty/blobs/mainboard/lenovo/x220/descriptor.bin +cp factory_bios.rom.GbE.bin ~/misc-src/coreboot-4.15/3rdparty/blobs/mainboard/lenovo/x220/gbe.bin +cp factory_bios.rom.ME.bin ~/misc-src/coreboot-4.15/3rdparty/blobs/mainboard/lenovo/x220/me.bin +``` + +# Setup and compile coreboot + +Enter coreboot folder: + +```sh +cd coreboot-4.15 +``` + +Build toolchain needed first (this will take a long time, be patient): + +```sh +make crossgcc-i386 CPUS=4 +``` + +coreboot settings menu: + +```sh +make menuconfig +``` + +Set the following options: + +```plaintext +NOTE: Leave default values as is and specifically set the following +options: + +mainboard -| + |-Mainboard vendor (Lenovo) + |-Mainboard model (ThinkPad X220) + |-ROM chip size (8192 KB (8 MB)) + |-(0x300000) Size of CBFS filesystem in ROM +chipset ---| + |-Include CPU microcode in CBFS (Generate from tree) + |-[*] Add Intel descriptor.bin file (leave default path as is) + |-(3rdparty/blobs/mainboard/$(MAINBOARDDIR)/descriptor.bin) Path and filename of the descriptor.bin file + |-[*] Add Intel ME/TXE firmware (leave default path as is) + |-(3rdparty/blobs/mainboard/$(MAINBOARDDIR)/me.bin) Path to management engine firmware + |- [*] Verify the integrity of the supplied ME/TXE firmware + |- [*] Strip down the Intel ME/TXE firmware + |-[*] Add gigabit ethernet firmware (leave default path as is) + |-(3rdparty/blobs/mainboard/$(MAINBOARDDIR)/gbe.bin) Path to gigabit ethernet firmware +Devices ---| + |-Graphics initialization (Use libgfxinit) + |-Display + |- Framebuffer mode (Linear "high-resolution" framebuffer) +payload ---| + |-Add a payload (An ELF executable payload) + |-"(/path/to/grub/grub2.elf)" Payload path and filename +``` + +If you don't want to include CPU microcode updates: + +```plaintext +chipset ---| + |-Include CPU microcode in CBFS (Do not include microcode updates) +``` + +This will create a '**.config**' file containing all settings. + +Compile coreboot: + +```sh +make -j4 +``` + +This will create '**build/coreboot.rom**' image with the size of 8mb. + +# Add custom files to 'coreboot.rom' image + +Add '**grub.cfg**' and '**background.jpg**' to coreboot.rom. See +'**Prerequisites**' above for the files needed. + +Make sure '**cbfstool**' is built: + +```sh +cd coreboot-4.15/util/cbfstool +make -j4 +``` + +Add custom GRUB configuration file: + +```sh +./cbfstool ../../build/coreboot.rom add -t raw -n etc/grub.cfg -f your/path/to/grub.cfg +``` + +Check so that '**etc/grub.cfg**' exists in coreboot.rom: + +```sh +./cbfstool ../../build/coreboot.rom print +``` + +Add background image: + +```sh +./cbfstool ../../build/coreboot.rom add -t raw -n background.jpg -f your/path/to/background.jpg +``` + +Check so that '**background.jpg**' exists in coreboot.rom: + +```sh +./cbfstool ../../build/coreboot.rom print +``` + +Done! Now it's time to flash the new '**coreboot.rom**' image! + +# Flash coreboot image + +See '**Connect programmer to flash chip**' for details on how +to connect programmer. + +Flash coreboot using **ch341a** USB programmer: + +```sh +sudo flashrom -p ch341a_spi -w coreboot.rom -V +``` + +Flash coreboot using **Raspberry Pi** programmer: + +```sh +sudo flashrom -p linux_spi:dev=/dev/spidev0.0,spispeed=32768 -w coreboot.rom -V +``` + +# Change Wifi card + +Remove the following parts to access the Wifi card: + +```sh +Battery +Keyboard +Palmrest +``` + +See '**Connect programmer to flash chip**' for details on +where the Wifi card is located. + +Now you can install a libre distro such as [Debian +GNU/Linux](https://www.debian.org/). + +# Boot Debian GNU/Linux netinst iso from usb in GRUB2 + +Download Debian GNU/Linux netinst from [here](https://www.debian.org/). + +Check name of USB device: + +```sh +sudo fdisk -l +``` + +Create bootable USB drive: + +```sh +sudo dd bs=4M if=/path/to/debian-img.iso of=/dev/YOUR_USB status=progress oflag=sync +``` + +Start the computer up and in the GRUB2 menu press '**c**' to enter +command line and from there type the following: + +```sh +set root='usb0' +linux /install.amd/vmlinuz +initrd /install.amd/initrd.gz +boot +``` + +Install Debian GNU/Linux normally and put GRUB2 on master boot record at +the end of installation process. After reboot default option in GRUB2 +menu on the flashchip will load GRUB2 on the AHCI HDD you installed on. + +# Download compiled coreboot image + +The resulting coreboot image from this tutorial can be downloaded here: + +[`lenovo-thinkpad-x220_coreboot-4-15-grub-master-with-cpu-microcode.rom`](/static/blog/files/x220/lenovo-thinkpad-x220_coreboot-4-15-grub-master-with-cpu-microcode.rom) + +Congratulations! We’re done. + +# Recommended reading + +[https://www.coreboot.org/](https://www.coreboot.org/)\ +[https://www.flashrom.org/](https://www.flashrom.org/)\ +[https://www.thinkwiki.org/wiki/Category:X220](https://www.thinkwiki.org/wiki/Category:X220)\ +[https://download.lenovo.com/ibmdl/pub/pc/pccbbs/mobiles_pdf/0a60739.pdf](https://download.lenovo.com/ibmdl/pub/pc/pccbbs/mobiles_pdf/0a60739.pdf)\ +[https://dejavu-fonts.github.io/](https://dejavu-fonts.github.io/)\ +[https://dejavu-fonts.github.io/License.html](https://dejavu-fonts.github.io/License.html) |