Documentation for “Zerocat Coreboot Machines”
Generated on: Sat, 18 Jun 2022 13:12:41 +0200
Repository: git://zerocat.org/zerocat/projects/coreboot-machines
Version: v0.16.8
Branch: master

Zerocat Coreboot Machines
– Create very satisfying free software devices.

Copyright (C) 2017, 2018, 2019, 2020, 2021, 2022 Kai Mertens kmx@posteo.net

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; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Section #../doc/NEWS.md

NEWS

Version Tags

Within this project’s git repository, versions are tagged according to the following pattern:

    v<major>.<minor>.<revision>

Changes ...

Changes between v0.16.7 and v0.16.8

Changes between v0.16.6 and v0.16.7

Changes between v0.16.5 and v0.16.6

Changes between v0.16.4 and v0.16.5

Changes between v0.16.3 and v0.16.4

Changes between v0.16.2 and v0.16.3

This version comes with an upgraded documentation system, according to: Zerocat Project Template v0.0.12

Changes between v0.16.1 and v0.16.2

Changes between v0.16.0 and v0.16.1

Changes between v0.15.0 and v0.16.0

Changes between v0.14.0 and v0.15.0

Section #../doc/README.md

README

Project Goal

The goal of Zerocat Coreboot Machines is to help you turn ThinkPad laptops into very satisfying free software devices: Create free firmware images (but use blobs if required), modify your hardware, install a fully free/libre operating system, improve configurations and follow best practice recommendations.

Paths

All paths within this document are relative to the location of this source file, which is located in this project’s doc/ folder.

Prerequisites

It is assumed that you are running a GNU/Linux-libre operating system.

Use git to clone the project’s sources:

    git clone git://zerocat.org/zerocat/projects/coreboot-machines

Change into the project’s documentation folder:

    cd coreboot-machines/doc/

Study this README.md to get started:

    cat ../doc/README.md

GNU Guix System

If you are on GNU Guix System, use make to create a dedicated profile, once. This allows you to match your environment to the one used by Zerocat, thus producing bit-identical results:

    make -C ../guix pull

Create an empty environment with dedicated guix channel:

    make -C ../guix environment

Create a shell with all prerequisites set up:

    make -C ../guix shell

To leave the shell and the environment, later on, when you are done with this project, type:

    exit
    exit

To remove this project’s handy guix profile, type:

    make -C ../guix clean

This will remove symlinks only. If you want to remove the profile from your system, run the GNU Guix Garbage Collector.

To list all available targets, type:

    make -C ../guix help

To clean-up, type:

    make -C ../guix clean

Other Distro

If you are on another distro, check file ../guix/manifest.scm and install the listed packages with your package manager, manually. Adapt package names as required.

Make Documentation

To build the documentation, type:

    make -C ../doc

To get a full list of available targets, type:

    make -C ../doc help

To clean-up, type:

    make -C ../doc clean
Section #../doc/COPYING.md

Copying

Zerocat Coreboot Machines ships copyrighted work.

Zerocat Coreboot Machines is free software. It makes use of free software approved licenses only and should be freely distributable:

Authorship, copyright and license information may be provided in more detail on a per-folder and/or per-file basis. Check the sources.

Please report a bug if you find the distribution hindered.
See Zerocat Website for contact information.

Section #../doc/CONTRIBUTING.md

Contributing

Documentation Files

Documentation source files are written in markdown syntax. They should carry their individual copyright and license notices right below the title giving headline, e.g.:

    <Title-of-Document>
    ===================

    Copyright (C) <Year>  <Name-of-Author> <Email-Address>  

    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;
    with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
    Texts. A copy of the license is included in the section entitled
    "GNU Free Documentation License".

    <Other-Headline>
    ----------------

    ...content...

The generated documentation carries a license notice right at top on its title page, with copyright statements generated from git log output.

Sections of the generated documentation are build from selected markdown source files, with their individual copyright and license notice stripped.

In order to enrich the generated documentation ...

... and adapt ../doc/Makefile to produce nice output.

In case more tools are needed, don't forget to update ../guix/manifest.scm.

Images

To make your image look nice within the documentation, select a landscape layout of 16:9 aspect ratio.

Use ImageMagick to prepare your image, e.g.:

If your image is big, reduce it to a maximal width of 2000 pixel:

    mogrify -resize 2000x <image>

Please clean image files from metadata, before committing, i.e.:

    mogrify -strip <image>

If you embed your image into a markdown documentation file, use this syntax:

   ![<path/to/image>][]

   [<path/to/image>]:     <path/to/image>     "title message"

or alternatly:

   ![<path/to/image>][my-image-shortcut]

   [my-image-shortcut]:   <path/to/image>     "title message"

These patterns will guarantee that <img> tags will have their src, alt and title attributes properly set within the html output.

Code Files

Please use this license header for code source files:

    Zerocat Coreboot Machines --- Create very satisfying free software devices.

    Copyright (C) <Year>  <Name-of-Author> <Email-Address>

    This file is part of Zerocat Coreboot Machines.

    Zerocat Coreboot Machines is free software: you can redistribute it
    and/or modify it under the terms of the GNU General Public
    License as published by the Free Software Foundation, either
    version 3 of the License, or (at your option) any later
    version.

    Zerocat Coreboot Machines is distributed in the hope that it will be
    useful, but WITHOUT ANY WARRANTY; without even the implied
    warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
    PURPOSE. See the GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Zerocat Coreboot Machines.
    If not, see <http://www.gnu.org/licenses/>.

Shell Scripts

If you intend to write shell scripts, use this skeleton to make them work for GNU Guix:

    #!/bin/sh

    # Re-exec if we are not using Bash or are using Bash in POSIX mode.
    if [ -z "$BASH" ] || [ "$BASH" = "/bin/sh" ]; then
      bash=`command -v bash`
      if [ -z "$bash" ]; then
        echo "Couldn't find Bash, sorry!"
        exit 1
      else
        exec "$bash" "$0" "$@"
      fi
    fi

    # We're using Bash now.
    set -o errexit
    set -o nounset
    set -o pipefail

    # Your code goes here ...

ChangeLog

Update ../doc/NEWS.md and list your contributions.

You can use git shortlog to get a starting point for your edit.

Section #../doc/MAINPAGE.md

MAINPAGE

Turn a small, but interesting set of ThinkPad laptops into very satisfying free software devices! Create new firmware, modify your hardware, install a fully free/libre operating system, and use it according to best practice recommendations.

Worked Example: Zerocat X230-Tablet

X230 Tablet with Zerocat Boot Menu

X230 Tablet with Zerocat Boot Menu

Supported Machines

¹ The set of frequently tested laptops is much smaller!
² TFT 1440×900px is supported by coreboot@4.8.1 only.
³ Avoid freezes with linux kernel option intel_idle.max_cstate=2.
° Do not touch the IME firmware.

Feature Chart of Zerocat’s Firmware

Tools and their Versions

In general, these project versions are used as default:

Some fallback versions are still supported:

Operating Systems

This project puts extra focus on fully free/libre operating systems:

  1. GNU Guix System

    This system can be run from fully encrypted partitions.

    Files like ../templates/zerocat-system-x86_64-encrypted.scm might help you to configure your GNU Guix System right after installation.

    Utility script ../util/grub-mkconfig-coreboot-guix.sh should help you to set up an optimized grub configuration file for GNU Guix System. This file works well with Zerocat’s boot menu.

  2. Trisquel GNU/Linux-libre

    The default installer will set up an unencrypted root partition.

    Trisquel is required by this project and its toolchain, as the GNU Ada-Compiler is needed to build the coreboot firmware.

  3. Parabola GNU/Linux-libre

    This system can be run from fully encrypted partitions.

    Project Zerocat Parabola Setup helps you to install this system.

  4. Hyperbola GNU/Linux-libre

    This system can be run from fully encrypted partitions.

    Project Zerocat Hyperbola Setup helps you to install this system.

See ../doc/supported-distros.md for more test results.

Get Started

To get started, see the following sections:

  1. ../doc/README.md
  2. ../doc/MAINPAGE.md
  3. ../doc/toolchain.md
  4. ../doc/x220-x230-microphone-hack.md
  5. ../doc/best-practice.md

Accessories

Once you have liberated your laptop, protect it!
Project Zerocat Sleeve helps you to make a nice sleeve for it.

Disclaimer

These sources are distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Proceed with care, good luck!
Please report bugs.

Section #../doc/toolchain.md

Toolchain

This project comes with a Set of Bash Scripts for the Trisquel GNU/Linux-libre Operating System, i.e. “Trisquel 10.0.1 (trisquel10.0.1amd64.iso)”. Experimental support for GNU Guix has been added, but this is Work in Progress. The set should help you to easily generate your custom Zerocat ROM for a small but interesting set of ThinkPad laptops, see #../doc/MAINPAGE.md.

The toolchain is formed by scripts:

  1. ../src/setup-toolbox.sh
  2. ../src/gen-payload-seabios.sh
  3. ../src/gen-payload-grub.sh
  4. ../src/gen-rom-zerocat.sh

Please also make use of ../util/get-sysinfo.sh, which is an optional script. It retrieves useful system information and should be run twice on your target machine: Before and after your successful flash procedure.

Note that all scripts might be invoked with option --help to display usage information.

The intended order of script invocation is like:

  1. Change into folder src/:

        $ cd src/
    
  2. Invoke:

        $ bash setup-toolbox.sh --check
    

    This will check whether required programs and packages are available on your system. If any error is reported, please install the appropriate package and run the check again.

  3. Switch your internet connection on.

  4. Invoke:

        $ bash setup-toolbox.sh \
            --toolbox \
            --add-project coreboot seabios grub
    

    This will create a new, unique, empty toolbox folder and will populate it with sources of required external projects as like coreboot, seabios and grub. The script also runs apropriate git checkout commands in conjunction with ./configure or make, where applicable. More projects like libreboot, bios_extract, fcode-utils, UEFITool and flashrom might be specified as well, but they are not yet used by the scripts.

    Regarding grub, a review of its configuration will be displayed and your key input is required to continue.

    In case of script failure due to network issues, convenient resume options are lacking by the moment. In such a case, please specify the toolbox folder in use along with the broken project and try again. Make sure you will end up with your toolbox folder correctly populated.

    Per default, the following project versions are used:

    Set 1:

    • coreboot@4.14
    • grub@grub-2.06
    • seabios@rel-1.14.0

    You might override default versions by appending a different version string, i.e. coreboot@4.8.1 (not valid for x201) or grub@2.02.

    Set 2:

    • libreboot@r20160907
    • bios_extract@effb120
    • fcode_utils@v1.0.2
    • uefitool@0.26.0
    • flashrom@v1.2
  5. Internet connection is not required any more.

  6. Invoke:

        $ bash gen-payload-seabios.sh --usage
    

    This will list detailed usage information. In order to build the SeaBIOS payload for platform i386-coreboot, please pick your use case, e.g.:

    • In case you are heading to flash machines that do not require an external VGA Option ROM, invoke:

      $ bash gen-payload-seabios.sh \
          --toolbox <path/to/toolbox-folder> \
          --gen-payload
      
    • In case you are heading to flash machines that do require an external VGA Option ROM, invoke:

      $ bash gen-payload-seabios.sh \
          --toolbox <path/to/toolbox-folder> \
          --gen-payload \
          --config-no-vgarom
      

      That external ROM must be passed to ../src/gen-rom-zerocat.sh later on.

  7. Invoke:

        $ bash gen-payload-grub.sh --usage
    

    This will list detailed usage information. Please pick your use case, e.g.:

    • In order to generate the GRUB executable payload file for platform i386-coreboot, you might invoke:

      $ bash gen-payload-grub.sh \
          --clean \
          --toolbox <path/to/toolbox-folder> \
          --payload-dir <path/to/grub-payload-folder> \
          --gen-keymaps \
          --gen-payload
      

      This will pack the GRUB executable payload file for platform i386-coreboot, small version. The output’s name is hardcoded to grub@${version_grub}_i386-coreboot.elf.

    • In order to generate generic GRUB configuration files, you might – as a next step – invoke:

      $ bash gen-payload-grub.sh \
          --mostlyclean \
          --toolbox <path/to/toolbox-folder> \
          --payload-dir <path/to/grub-payload-folder> \
          --gen-config \
          --config-grub \
          --config-seabios \
          --strip-comments
      
    • In case you are heading for T60 machines, use additional options which remove incompatible menu entries from the GRUB boot menu:

      $ bash gen-payload-grub.sh \
          --mostlyclean \
          --toolbox <path/to/toolbox-folder> \
          --payload-dir <path/to/grub-payload-folder> \
          --gen-config \
          --config-grub \
          --config-seabios \
          --config-no-poweroff \
          --strip-comments
      
    • And finally, you might specify a dedicated Zerocat Background, if you like to:

      $ bash gen-payload-grub.sh \
          --payload-dir <path/to/grub-payload-folder> \
          --config-background <path/to/PNG-Image>
      

      This option might be used three times more in case you want to provide images of the flash procedure, for instance.

    In case you want to set up GRUB authorization, use option --config-authorization <user> <password> <scheme>.
    See --help output for details.

    In case you are using grub@2.02, feel free to set option --config-morse on an x60, t60, x200 and t400 target.

  8. Invoke:

        $ bash gen-rom-zerocat.sh --usage
    

    This will list detailed usage information of the last script to use. Please pick your target, e.g.:

    • In order to build your ROM for a ZC-X200, you might invoke:

      $ bash gen-rom-zerocat.sh \
          --toolbox <path/to/toolbox-folder> \
          --target x200 --chipsize 8mb \
          --ifd-lock-regions --ifd-medisable \
          --ime none --gbe set_<macaddr-without-colons> \
          --payload-grub-dir <path/to/grub-payload-folder>
      

      This will set up Zerocat’s ROM with region ME deleted. The MAC Address of the onboard Ethernet Controller will be set to a custom value. Please specify your device’s hexadecimal number which is located on a sticker close to the second RAM socket. However, you might set an arbitrary address as well. The x200 is known to run fine without CPU microcode updates, hence no option --microcode.

    • In order to build your ROM for a ZC-X201, you might invoke:

      $ bash gen-rom-zerocat.sh \
          --toolbox <path/to/toolbox-folder> \
          --target x201 \
          --rom-factory <path/to/factory.bin> \
          --ifd-lock-regions \
          --ime keep --gbe keep \
          --microcode \
          --payload-grub-dir <path/to/grub-payload-folder>
      

      This will set up Zerocat’s ROM with region ME untouched. The GbE Firmware is in use as extracted from the vendor ROM. If you try to modify the IME or the AltMeDisable bit, the fan is not controlled and your machine is likely to get overheated. Reboots fromout the GRUB Bootmenu will get stuck.

    • In order to build your ROM for a ZC-X230, you might invoke:

      $ bash gen-rom-zerocat.sh \
          --toolbox <path/to/toolbox-folder> \
          --target x230 \
          --rom-factory <path/to/factory.bin> \
          --ifd-lock-regions --ifd-altmedisable \
          --ime xtrunc --gbe set_<macaddr-without-colons> \
          --microcode \
          --payload-grub-dir <path/to/grub-payload-folder>
      

      This will set up Zerocat’s ROM with region ME cleaned and extremely shrunk, and region BIOS increased. The MAC Address of the onboard Ethernet Controller will be set to a custom value. Please specify your device’s hexadecimal number which is located on a sticker close to the second RAM socket. However, you might set an arbitrary address as well. The X230 seems to freeze in case CPU microcode updates are not provided, hence option --microcode. However, omit this option in case you want your machine to boot up in a blobfree manner. You might try to load updates later on with your operating system.

    • In order to build your ROM for a ZC-T430, you might invoke:

      $ bash gen-rom-zerocat.sh \
          --toolbox <path/to/toolbox-folder> \
          --target t430 \
          --rom-factory <path/to/factory.bin> \
          --ifd-lock-regions --ifd-altmedisable \
          --ime xtrunc --gbe set_<macaddr-without-colons> \
          --microcode \
          --payload-grub-dir <path/to/grub-payload-folder>
      

      This will set up Zerocat’s ROM with region ME cleaned and extremely shrunk, and region BIOS increased. The MAC Address of the onboard Ethernet Controller will be set to a custom value. Please specify your device’s hexadecimal number which is located on a sticker close to the second RAM socket. However, you might set an arbitrary address as well. The T430 seems to freeze in case CPU microcode updates are not provided, hence option --microcode. However, omit this option in case you want your machine to boot up in a blobfree manner. You might try to load updates later on with your operating system.

    • In order to build your ROM for a ZC-X1CarbonGen1, you might invoke:

      $ bash gen-rom-zerocat.sh \
          --toolbox <path/to/toolbox-folder> \
          --target x1_carbon_gen1 \
          --rom-factory <path/to/factory.bin> \
          --ifd-lock-regions --ifd-altmedisable \
          --ime xtrunc \
          --microcode \
          --payload-grub-dir <path/to/grub-payload-folder>
      

      This will set up Zerocat’s ROM with region ME cleaned and exremely shrunk, and region BIOS increased. The X1 seems to freeze in case CPU microcode updates are not provided, hence option --microcode. However, omit this option in case you want your machine to boot up in a blobfree manner. You might try to load updates later on with your operating system.

    • In order to build your ROM for a ZC-X220, you might invoke:

      $ bash gen-rom-zerocat.sh \
          --toolbox <path/to/toolbox-folder> \
          --target x220 \
          --rom-factory <path/to/factory.bin> \
          --ifd-lock-regions --ifd-altmedisable \
          --ime xtrunc --gbe set_<macaddr-without-colons> \
          --payload-grub-dir <path/to/grub-payload-folder>
      

      This will set up Zerocat’s ROM with region ME cleaned and shrunk, and region BIOS increased. The MAC Address of the onboard Ethernet Controller will be set to a custom value. Please specify your device’s hexadecimal number which is located on a sticker close to the second RAM socket. However, you might set an arbitrary address as well. The x220 seems to run fine without CPU microcode updates, hence no option --microcode.

    • In order to build your ROM for a ZC-T420, you might invoke:

      $ bash gen-rom-zerocat.sh \
          --toolbox <path/to/toolbox-folder> \
          --target t420 \
          --rom-factory <path/to/factory.bin> \
          --ifd-lock-regions --ifd-altmedisable \
          --ime trunc --gbe set_<macaddr-without-colons> \
          --payload-grub-dir <path/to/grub-payload-folder>
      

      This will set up Zerocat’s ROM with region ME cleaned and shrunk, and region BIOS increased. The MAC Address of the onboard Ethernet Controller will be set to a custom value. Please specify your device’s hexadecimal number which is located on a sticker close to the second RAM socket. However, you might set an arbitrary address as well. The t420 seems to run fine without CPU microcode updates, hence no option --microcode.

    • In order to build your ROM for a ZC-T60 with ATI Graphics (Mobility Radeon X1300), you might invoke:

      $ bash gen-rom-zerocat.sh \
          --toolbox <path/to/toolbox-folder> \
          --target t60_ati_mobility_radeon_x1300 \
          --rom-vga <path/to/pci1002,7149.rom> \
          --payload-grub-dir <path/to/grub-payload-folder>
      

      Note file pci1002,7149.rom is an external, proprietary VGA Option ROM that you should have extracted from memory, before. See ../doc/t60-vgarom-extraction.md for details. The t60 seems to run fine without CPU microcode updates, hence no option --microcode.

    Upon script start, previously configured GRUB settings will be detected automatically, and secondary payloads will be compiled as required. Please take your time to review the reported settings.

    Occasionally, the script will require some user interaction. You should be safe to enter “yes” if asked to do so.

    If the script succeeds, a new folder has been created. It contains a fully configured zerocat.rom along with more files, checksums, backups and subfolders. The ROM can now be flashed to your target machine’s SPI chip. In case your target has a virtual SPI Chip formed by two physical ones, the ROM has been split into zerocat.rom.bottom for chip #1 and zerocat.rom.top for chip #2.

    Note, for targets other than x200, t400, t500, option --ifd-altmedisable is not available with coreboot@4.8.1.

Done, now head for flashing!
Good luck!

Section #../doc/t60-vgarom-extraction.md

T60 VGAROM Extraction

Some T60 configurations require an extracted proprietary VGA Option ROM. The ROM is to be extracted from memory, as vendor’s BIOS patches the VGA Option ROM loaded from chip.

Please compare this information to: Coreboot VGA Support Page

How-to

Section #../doc/x220-x230-microphone-hack.md

X220/X230 Microphone Hack

LED-Board with Microphones

Note the X220 and X230 LED-Board not only holds the system status LEDs, but as well two digital microphones. The LED-Board is connected to the motherboard via cable, which uses a 16-pin connector on the LED-Board versus a 30-pin connector at the system board.

LED-Board Connector, 16-Pin

On the X220, the pinout of the 16-Pin LED-Board Connector is estimated as like:

            +------------------------------------------------------+
            | +-----------------+-----------------------------+    |
            | |                 |                             |    |
            | |                 |                             |    |
············|·|·················|······                       |    |
  o o o o o o o o o o o o o o o o     : Short Edge            |    |
··|·|·|·|·|·····|·|·|·|·|·|·|·|········                       |    |
  | | | | |     | | | | | | | |                               |    |
  | | | | |     | | | | | | | +---------> Not Connected       |    |
  | | v v v     | | | | | | |                                 |    |
  | | MICBUS    | | | | | | |                                 |    |
  | |           | | | | | +-|----------->[LED Standby   ]<----+    |
  v v           | | | | +---|----------->[LED Batt1     ]<----+    |
  MIC           | | | +-----|----------->[LED Batt2     ]<----+    |
  PWR           +-|-|-------|----------->[LED WiFi      ]<----+    |
                  | +-------|----------->[LED HDD       ]<---------+
                  +---------|----------->[LED Bluetooth ]----+
                            |                                |
                            +--------------------------------+--- GND

How to Disable the Microphones

X220: TFT Connector, five contacts covered.

X220: TFT Connector, five contacts covered.

In case you want to disable the microphones on the X220, just follow the routes of the first five wires towards the TFT’s right hand sysboard connector and cover its first five contacts with a small adhesive strip. This seems to apply to the X230 as well.

Section #../doc/gbe-phy-configuration-i82579lmv.md

GbE PHY Configuration i82579LM/V

82579LM/V GbE PHY Configuration for Intel 6 Series Express Chipset.

Specifications

File: ../templates/i82579lmv-gbe-6series.spec

To be used with coreboot’s bincfg utility.

Do not change names for macaddress, l1_gbedis and checksum_gbe, these words are updated by the toolchain.

Settings

File: ../templates/i82579lmv-gbe-6series.set

To be used with coreboot’s bincfg utility.
Seems to be applicable for Intel 7 Series Express Chipset as well.

Refer to ../templates/i82579lmv-gbe-6series.spec for applicable namespace.

Section #../doc/how-to-modify-ifd.md

How To Modify The Intel Flash Descriptor

Most Intel Machines use their onboard flash chip to hold not just BIOS firmware, instead different firmare regions are set up to give space for other firmware as well. The first 4096 Bytes of that chip hold Intel’s description table which exactly describes position, size and access restrictions of these regions. This table is called “Intel Firmware Descriptor” or “Intel Flash Descriptor”, in short: “IFD”.

Once you are dealing with coreboot or libreboot, different necessities arise to modify this description table.

Region ME Deleted

On libreboot compatible devices (i.e. X200, T400, T500, etc.), you are likely to delete region ME, the firmware region reserved to hold the proprietary firmware update for the integrated Intel Management Engine, a powerful controller on board. But with a deleted region, more space is available and should get reassigned to region BIOS, which holds your new coreboot BIOS firmware replacement.

The Libreboot project already did that work, it offers a tool called ich9gen to create a modified firmware descriptor which can just be copied into the new coreboot ROM by means of the dd command. (This tool generates firmware for region GbE in the same go, it is bundled together. However, you might use the dd command again to seperate both regions in case you need to.)

Retrieve the sources of the libreboot project:

$ git clone https://notabug.org/libreboot/libreboot.git
$ cd libreboot

Let’s checkout at the latest release:

$ git checkout r20160907
$ cd resources/utilities/ich9deblob
$ make

Use the correct MAC address of your machine. It is usually stated on a sticker at the systemboard’s second RAM socket.

$ ./ich9gen --macaddress xx:xx:xx:xx:xx:xx

Do not use option --mac-address by mistake, as this will generate a GbE Configuration with a default MAC Address without warning the user. Do not omit the colons. Replace ‘xx’ with your hexadecimal values.

This will generate some *.bin files and "How to Use" messages, i.e.:

descriptor and gbe successfully written to the file: ich9fdgbe_8m.bin
Now do: dd if=ich9fdgbe_8m.bin of=libreboot.rom bs=1 count=12k conv=notrunc
(in other words, add the modified descriptor+gbe to your ROM image)

You should update your coreboot.rom with the apropriate dd command as a last action on it.

Region ME Cleaned

More recent machines (i.e. X220, X230, T430, T430s, etc.) do not allow you to delete region ME completely, unfortunately. However, the ME_Cleaner script is able to delete a signifcant number of sections of the firmware code. As a result, the IME controller boots up – but stays hang up in its Bring-Up-Phase. Hopefully it can't do any harm.

Shrink Binary of Region ME

Once me_cleaner.py cleaned, relocated and truncated the ME firmware, it might get shrunk even more. MECleaner’s log file suggests a new size, but this seems to be even more reducable by around 3× 4096 Bytes. Use hexdump -C to look for the last sector containing code in MECleaner’s binary output and determine the required minimal size, while maintaining flash erase sector size granularity. The dd command should be the right tool to create a smaller binary file of the truncated and shrunk ime firmware.

Create and Fix Binary of Region IFD

But useless to use this binary with coreboot without having created a new firmware descriptor binary:

Dump the flash layout with ifdtool -f and create a modified one, see Example A below.

Create a new, working flash descriptor with ifdtool -n and fix Byte Nº 0x51 (81 in decimal) with the value found in the previously extracted flash descriptor binary flashregion_0_flashdescriptor.bin, 0x1f for instance. The dd command helps you to copy that byte’s value. See Example B to see how the new flash descriptor dump should differ the default one.

Example A: Modify X230 Firmware Layout

Use ifdtool -f to extract the default layout, e.g.: X230

00000000:00000fff fd
00500000:00bfffff bios
00003000:004fffff me
00001000:00002fff gbe

Modify the layout file. This is what can be used on an X230:

00000000:00000fff fd
00001000:00002fff gbe
00003000:00017fff me
00018000:00bfffff bios

Size of ME-Region is 0x15000 Bytes instead of 0x18000 as suggested by me_cleaner.log. In comparison to the original flash layout on an X230, region BIOS has been increased – region ME has been decreased – by 0x4E8000 Bytes.

Example B: Compare X230 Descriptor Dumps

The diff -y command helps you to compare dumps (created with ifdtool -d) of the default descriptor and the new, fixed one. They should not differ but in four lines as listed:

Found Region Section                                            Found Region Section
FLREG0:    0x00000000                                           FLREG0:    0x00000000
  Flash Region 0 (Flash Descriptor): 00000000 - 00000fff          Flash Region 0 (Flash Descriptor): 00000000 - 00000fff
FLREG1:    0x0bff0500                                         | FLREG1:    0x0bff0018
  Flash Region 1 (BIOS): 00500000 - 00bfffff                  |   Flash Region 1 (BIOS): 00018000 - 00bfffff
FLREG2:    0x04ff0003                                         | FLREG2:    0x00170003
  Flash Region 2 (Intel ME): 00003000 - 004fffff              |   Flash Region 2 (Intel ME): 00003000 - 00017fff
FLREG3:    0x00020001                                           FLREG3:    0x00020001
  Flash Region 3 (GbE): 00001000 - 00002fff                       Flash Region 3 (GbE): 00001000 - 00002fff
FLREG4:    0x00001fff                                           FLREG4:    0x00001fff
  Flash Region 4 (Platform Data): 00fff000 - 00000fff (unused     Flash Region 4 (Platform Data): 00fff000 - 00000fff (unused

Use Both Binaries with Coreboot

Both newly created binaries of Region 0 and Region 2 should be used for the new coreboot.rom by means of ifdtool.

Toolchain Scripts

These procedures are applied by @ref gen-rom-zerocat.sh, which should help you to do it safely via --ime clean or --ime xtrunc. Use option --usage to get invocation examples. See source code for details.

Section #../doc/supported-distros.md

Supported Distros

USB Media

Zerocat’s Boot Menu offers three different paths to boot USB live/installation media:

  1. Coreboot-GRUB2 -> USB -> Distro’s Grub2 Configuration File
  2. Coreboot-GRUB2 -> USB -> Distro’s Isolinux Configuration File
  3. Coreboot-GRUB2 -> SeaBIOS Payload -> USB -> Distro’s suggested boot path

See this table of tested USB installation media:

Distro                                      Applicable Boot Path
------                                      --------------------
GNU Guix System v1.2.0²                     1 (grub.cfg), 3 (via SeaBIOS)
Parabola Live Media – LXDE-OpenRC²          2 (isolinux.cfg), 3 (via SeaBIOS)
Hyperbola Live Media – Milky Way v0.4²      2 (isolinux.cfg)
Trisquel10²                                 2 (isolinux.cfg), 3 (via SeaBIOS)
Debian9¹                                    1 (grub.cfg), 3 (via SeaBIOS)
OpenSUSE¹                                   2 (isolinux.cfg), 3 (via SeaBIOS)
Qubes R4.0.3²                               3 (via SeaBIOS)

¹ preliminary information, to be tested more thoroughly
² confirmed information

Harddisk/SSD

Zerocat’s Boot Menu offers different paths to boot from internal disk (AHCI):

  1. Coreboot-GRUB2 -> AHCI -> Distro’s Grub2 Configuration File
  2. Coreboot-GRUB2 -> AHCI -> Distro’s Isolinux Configuration File
  3. Coreboot-GRUB2 -> AHCI -> Distro’s Kernel Linux
  4. Coreboot-GRUB2 -> SeaBIOS Payload -> Distro’s suggested boot path

See this table of tested installations:

Distro                        Applicable Boot Path
------                        --------------------
GNU Guix System²              1 (grub.cfg, coreboot_grub.cfg°), 4 (via SeaBIOS)
Hyperbola v0.4²               1 (grub.cfg), 3 (Kernel)
Parabola²                     1 (grub.cfg), 3 (Kernel)
Trisquel10¹                   1 (grub.cfg), 3 (Kernel), 4 (via SeaBIOS)
Debian9¹                      1 (grub.cfg), 4 (via SeaBIOS)
OpenSUSE²                     not yet supported
Qubes R4.0.3²                 4 (via SeaBIOS)

See this table of tested installations, using full disk encryption. Encrypted devices are to be unlocked via dedicated menu entry, first:

Distro                        Applicable Boot Path
------                        --------------------
GNU Guix System²              1 (grub.cfg, coreboot_grub.cfg°)
Hyperbola v0.4²               1 (grub.cfg), 3 (Kernel)
Parabola²                     1 (grub.cfg), 3 (Kernel)
Trisquel10²                   not applicable (boot partition is not encrypted)
Debian9²                      not yet tested
OpenSUSE²                     not yet supported
Qubes R4.0.3²                 not applicable (boot partition is not encrypted)

¹ preliminary information, to be tested more thoroughly
² confirmed information
° see ../util/grub-mkconfig-coreboot-guix.sh to create this file

Accessories

Files ../templates/zerocat-system-*.scm might help you to refine your GNU Guix System to match Zerocat products.

File ../util/grub-mkconfig-coreboot-guix.sh is provided to get your GNU Guix System booted with messages refined.

Section #../doc/best-practice.md

Best Practice

How to use your free software device, safely?

Integrated Disks

The firmware of integrated SSDs/Disks might request access to your memory according to SATA specification, so better don’t use them being plugged to the SATA port, directly. Instead, use them via standard SATA-to-USB2 adapter, which is not capable of granting direct access to your memory (DMA). Of course, this will slow down your system.

Integrated Wifi

Replace wifi cards that run with proprietary firmware. Or even better, replace cards that run with firmware at all. Use one that has no firmware, but is driven by the kernel driver only.

Section #../doc/GNU-FDL.md

GNU Free Documentation License

Version 1.3, 3 November 2008

Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. http://fsf.org/

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

The "publisher" means any person or entity that distributes copies of the Document to the public.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

11. RELICENSING

"Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A "Massive Multiauthor Collaboration" (or "MMC") contained in the site means any set of copyrightable works thus published on the MMC site.

"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

"Incorporate" means to publish or republish a Document, in whole or in part, as part of another Document.

An MMC is "eligible for relicensing" if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

    Copyright (C)  YEAR  YOUR NAME.
    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;
    with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
    A copy of the license is included in the section entitled "GNU
    Free Documentation License".

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with … Texts." line with this:

    with the Invariant Sections being LIST THEIR TITLES, with the
    Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.