4 May 2024
Article published by: Leah Rowe in GNU Leah Mode™
Date of publication: 4 May 2024
Do not use the Canoeboot 20240504 release, because it had problems with it. Please use the Canoeboot 20240612 release instead.
Canoeboot is a free/libre BIOS/UEFI replacement on x86 and ARM, providing boot firmware that initialises the hardware in your computer, to then load an operating system (e.g. Linux). It is specifically a coreboot distribution, in the same way that there are distributions. It provides an automated build system to produce coreboot ROM images with a variety of payloads such as GRUB or SeaBIOS, with regular well-tested releases to make coreboot as easy to use as possible for non-technical users. From a project management perspective, this works in exactly the same way as a distro, providing the same type of infrastructure, but for your boot firmware instead of your operating system. It makes use of coreboot for hardware initialisation, and then a payload such as SeaBIOS or GRUB to boot your operating system; on ARM(chromebooks), we provide U-Boot (as a coreboot payload).
Canoeboot provides many additional benefits such as fast boot speeds, greater security and greater customisation, but the primary benefit is software freedom. With use of GRUB in the flash, you can make use of many advanced features such as the ability to boot from an encrypted /boot partition and verify kernel GPG signature at boot time. Canoeboot’s GRUB payload is heavily patched; for example, today’s release uses GRUB based on version 2.12, but Canoeboot adds argon2 KDF support (for LUKS2) and xHCI support - you can use USB 3.0 devices natively, in GRUB, including distro install media via USB3. Some desktops supported by Canoeboot can have USB3 cards installed on them.
Another example of the type of benefit you could get from Canoeboot: you can boot from NVMe SSDs in the SeaBIOS payload, if your board can take them (e.g. desktop board with an NVMe adapter in the PCI-E slot). If your vendor’s BIOS/UEFI firmware only supports SATA, then this is a nice bonus for you. With Canoeboot, you get continued firmware updates over time, adding new features on both older and newer hardware. Canoeboot still provides updates for machines that are nearly 20 years old, while also supporting newer machines. More hardware support is being added all the time!
These and other examples are just the start. Canoeboot provides a superior boot experience compared to proprietary BIOS/UEFI, giving you the same power and level of control that a fully free Linux system would afford. It’s your computer to boot however you wish. Canoeboot lets you get more out of the hardware. All your favourite distros are compatible, even Qubes(on most machines).
If you’re fed up of the control that proprietary UEFI vendors have over you, then Canoeboot is for you. Although many would agree that it is a major step forward for most users, it’s actually a conservative idea socially. It used to be that computers were much more open for learning, and tinkering. Canoeboot implements this old idea in spirit and in practise, helping you wrest back control. Unlike the hardware vendors, Canoeboot does not see you as a security threat; we regard the ability to use, study, modify and redistribute software freely to be a human right that everyone must have, and the same is true of hardware. Your computer is your property to use as you wish. Free Software protects you, by ensuring that you always have control of the machine.
This release supports the following hardware:
This was broken in the previous Canoeboot release, but now it works again.
S3 suspend/resume (when you put the laptop to sleep and later wake it up).
The previous Canoeboot release used a revision from GRUB 2.12-rc1, but now it uses the GRUB 2.12 released during December 2023, with some additional revisions and patches on top of that.
We don’t use UEFI on x86, but the GRUB config in Canoeboot’s GRUB payload has now been modified, to also scan grub.cfg from EFI/ directories. It also now scans directly for extlinux and syslinux configs, in addition to GRUB configs (GRUB can parse syslinux/extlinux configs). This should make Canoeboot’s GRUB payload more compatible with a wider variety of distro setups.
The above change pertaining to ESP has also been applied to booting of installers (e.g. USB media). Syslinux/Extlinux/GRUB config scanning has been merged together there, so now a lot more distro installers should boot automatically, without manual tweaking/intervention from the user.
The script at script/update/release now supports generating standalone U-Boot source archives, like so:
./update release -m u-boot
The usual -d option also works, for specifying a directory other than release/. Canoeboot still provides U-Boot embedded within the larger source release archive, and does not yet actually provide U-Boot as a standalone project, but some people may find this useful.
Flashprog started due to disagreement between its founder (Nico Huber) and the new leadership of the flashrom project. Flashprog focusus on stability, while also adding newer chips all the time. Indeed, flashrom started becoming unreliable on a lot of older platforms such as i945 thinkpads, whereas flashprog is more stable.
Canoeboot will use flashprog from now on, not flashrom.
The following log will now acount for changes since Canoeboot 20231107, from most recent descending to very earliest commits. The most interesting changes are highlighted in bold:
sript/update/release: Report on the terminal when a tarball is being created, to avoid giving the impression that the script has crashed when making very large tar archives.dell_flash_unlock: Set iopl level back to 0 when done (patch by Nicholas Chin)dell_flash_unlock: Fix ec_set_fdo() signature (patch courtesy Nicholas Chin)ata devices in GRUB, rather than ahci. Patch courtesy of livio.update/trees: Simplified handling of defconfig files. The new code is more reliable, and will not have to be modified as much when adding new options for changing configs.nproc to decide build threads; set it to 1 instead. The user can manually specify build threads when running cbmk. This is because nproc is not available on all systems.export CBMK_STATUS=n./build roms list: Allow filtering based on status. E.g. command: ./build roms list stablestatus="stable" or status="untested". If it’s not marked stable, a given board will provide a y/n confirmation screen on build, asking if you want to skip the build (this dialog is disabled in release builds) - there is another: release variable in target.cfg can be set to n, to always skip building that target, but only skip on release builds. This is better than documenting board status on the website, because it’s automated in cbmk. A warn.txt file can be provided in the board directory inside cbmk, with a message that will be printed when building; you can use this to warn the user about specific issues.err.sh, to ensure that they are always exported and therefore universally consistent in all parts of cbmk, once set (unless overridden by a given script)./tmp files. Fewer/no files are left behind now, after a build has completed.CBMK_THREADS. This is useful if you’re on a host with limited RAM.xarch too, to define which coreboot tree to use for crossgcc. Although cbmk uses coreboot/default for u-boot, a special tree of canoeboot had gru bob/kevin in coreboot/cros again, and it was seen that u-boot was being compiled from crossgcc for coreboot/default, not coreboot/cros, while the latter was used for actual coreboot firmware. In such a scenario, cbmk can now correctly re-use the same crossgcc build, thus saving time.xtree and tree_depend variables in target.cfg files, for each coreboot tree and, in the case of xtree, it can be defined in a given coreboot board target.-Werror when building, to prevent treating warnings as errors. This fixes the build on several distros, where CFLAGS is very strict.build/roms: general code cleanup and optimisations, for example grub.elf is no longer re-built if it already exists. Dependency checking is simplified.include/git.sh which handles downloading of sources.target.cfg files are now possible for single-tree projects, not just multi-tree projects. For single-tree projects, it goes at config/projectname/target.cfg, and it goes on the existing config/projectname/tree/target.cfg location for multi-tree projects.script/update/trees: Support adding custom arguments to the make command, when running a makefile within a project. This is defined by makeargs in the target.cfg file for a given project.script/update/trees - it is no longer hardcoded, for the uefitool package (from which we run uefiextract). Simply: define cmakedir in a project target.cfg file. It could even be cmakedir="." if you wish, so that all of it is built, though we specify cmakedir="UEFIExtract" for uefitool.script/update/trees and script/build/grub - now, generic autoconf handling is present in script/update/trees, so it can be used for any project, including GRUB, and arguments for configure/autogen/bootstrap scripts are configurable in project target.cfg files. The actual running of grub-mkstandalone is now handled from script/build/roms. This reduces the number of shell scripts from 12 to 11, in cbmk.script/build/serprog: Return error status (exit) if basename fails, when processing various board targets available on stm32/rp2040 projects. Patch courtesy of Leah Rowe in GNU Leah Mode.script/build/roms: Rename check_target to configure_target and prepare_target to configure_dependencies, for increased code clarity.git/pico-serprog: Use Riku’s newer revision, which sets the drive level to 12mA by default, up to the previous default of 4mA. The new level is within safety specifications on all flash ICs, but will result in greater reliability, especially on ISP-based flashing setups. Also merged a fix by Riku Viitanen, fixing a build error on boards where PICO_DEFAULT_LED_PIN is not defined by the pico sdk; in these cases, the status LED is simply unused.script/build/roms: Improved error handling for ROM image build functions, which run inside subshells. They now more reliably cause an exit from cbmk, under error conditions, and those exits are guaranteed now to be non-zero. Patch courtesy of Leah Rowe in GNU Leah Mode.script/build/roms: Remove redundant check on cros roms, where it checked whether initmode was normal; on these setups, it’s always libgfxinit.script/update/release: Don’t insert crossgcc tarballs into release archives. These are re-inserted needlessly, when they are already hosted by the GNU project and have decent mirrors in general. I always keep backups of these anyway, and do several mirrors, and not including them reduces the size of the Canoeboot release archives. This means that the release archives now require an internet connection to use, because crossgcc tarballs will be downloaded at build time, but they are the same tarballs that you would download as part of a release anyway, but now if you’re only building for one coreboot tree within cbmk, you only need to download one set of archives instead of getting them all. Patch courtesy of Leah Rowe in GNU Leah Mode.script/build/serprog: general code cleanup, generalising a lot more code, especially the if/else chains for checking what type of firmware is build. Patch courtesy of Leah Rowe in GNU Leah Mode.script/build/roms: remove the modify_coreboot_rom function. Fake PIKE2008 ROMs are now inserted by defining option roms in the coreboot config, where the given path is /dev/null. The top swap setting on i945 is now enabled via CONFIG_INTEL_ADD_TOP_SWAP_BOOTBLOCK in the coreboot build system - basically, what this does is cat two identical copies of the bootblock together and insert the larger bootblock file (twice the size) at the end of the flash, whereas previously we did this in cbmk using dd. The benefit of the new setup is that it results in higher build speeds, and now the duplicated bootblock now appears in CBFS, so cbfstool will prevent overwriting it.script/update/trees: Greatly simplified crossgcc handling. Now the list of crossgcc targets are directly defined in target.cfg files, and the for loop in update/trees just goes through it, checking the relevant toolchain. Patch courtesy of Leah Rowe in GNU Leah Mode.include/git.sh: Simplified submodule handling by not using subshells for running cd to a git repository. Instead, the -C option is used in Git.initialise_command (now initcmd) function: simplify handling of arguments, when determining what command was passed, and how to run it. Patch courtesy Leah Rowe in GNU Leah Mode.script/update/release: remove unnecessary “continue” command at the end of a for loop.include/option.sh: general code cleanup in the scan_config() function, on the if/else block assigning variables after scanning configs.include/option.sh: print errors to stdout instead, on the item() functioninclude/git.sh: reduced code indentation, on the part that applies patches in a git repository.include/git.sh: simplify tree name check, by breaking earlier when the correct tree name is found on a multi-tree project. Patch courtesy of Leah Rowe in GNU Leah Mode.grub.cfg: Support scanning for extlinux configs, which are essentially the same as syslinux ones. If found, they are passed through GRUB’s syslinux parser, which then presents a menu as if it were a GRUB configuration. This should increase compatibility with distros that use extlinux.grub.cfg: Handle GRUB and syslinux/extlinux configs, on the USB boot menu option. Now it scans for both, thus increasing compatibility with many modern distro installers. Before this change, Canoeboot’s design was made with BIOS systems in mind, because we historically only supported systems that were BIOS-based, whereas GRUB is more common as a bootloader on UEFI-based install media, but in the past we mostly assumed isolinux/syslinux for that.grub.cfg: support ESP and extlinux setups.grub.cfg: Don’t boot linux unless there is a grub.cfg file provided on the HDD/SSD. Previously, a fallback entry existed as a last resort, if all else failed, but it made several assumptions that are mostly no longer valid in 2023. Patch courtesy of Leah Rowe in GNU Leah Mode.grub.cfg: scan LVMs first. This makes it more likely that an encrypted system (encrypted /boot) will boot first, once found and unlocked. Patch courtesy of Leah Rowe in GNU Leah Mode.dell-flash-unlock: in the README, link to several useful guides including Open Security Training section about BIOS and SMM internals on x86. Patch courtesy of Nicholas Chin. In general, update the README to include instructions related to disabling /dev/mem protection, and info about the newer boards now added to cbmk, that the utility can be used on.grub.cfg: Added BTRFS subvolume support, by default. Patch courtesy of the contributor, alias semigel.script/update/trees: Correctly return error status when git am fails, while applying patches. Although it was printing an error message, the script was making improper use of subshells, leading to a zero exit, when it should have exited with non-zero status in such situations. Patch/fix courtesy of Leah Rowe in GNU Leah Mode.--author in Git, when re-initialising the Git history on release archives. Patch courtesy of Leah Rowe in GNU Leah Mode.util/nvmutil: Added useful help dialog, showing usage instructions when no/invalid arguments are given. Patch courtesy of Riku Viitanen.util/nvmutil Makefile, courtesy of Riku Viitanen. It was not properly formatted to include nvmutil.c, when running make-all.Canoeboot’s build system can be configured to exclude certain boards in release archives, while still permitting them to be re-built.
All of the following boards have been disabled in the build system:
D510MO and D945GCLF images not included either, due to lack of testing.
All other boards have ROM images in this release.
Markdown file for this page: https://canoeboot.org/news/canoeboot20240504.md
This HTML page was generated by the Canoeboot Static Site Generator.
Canoeboot is discontinued. A new project was created: RBoot project, a fully free UEFI firmware distribution based on coreboot. RBoot is Canoeboot continued under a new name, with the same maintainer. The canoeboot website and release sources shall be preserved for historical purposes.