update docs/maintain to match Canoeboot 20241207

Signed-off-by: Leah Rowe <info@minifree.org>
master
Leah Rowe 2024-12-05 21:21:37 +00:00
parent 60c02624a7
commit 7f71d26555
1 changed files with 65 additions and 0 deletions

View File

@ -278,6 +278,18 @@ convenience of users, and this is copied to release archives. Flashrom is the
program that you will use to read, erase and write the flash, containing
coreboot firmware.
src/gpio-scripts
----------------
This is a fork of the original gpio-scripts. The fork is maintained by Riku
Viitanen, based on code written by Angel Pons (author of the Haswell native
raminit patches and many other excellent works), but Riku's version parses
the inteltool log files. This is useful for adapting GPIO configs on Intel
machines, when porting new boards to coreboot.
NOTE: Not included in Canoeboot yet, but `intelp2m` is used instead for this
purpose, on much newer Intel systems (from around Skylake era or later).
src/grub/TREE
---------------
@ -312,6 +324,15 @@ tree contains NVMe SSD support but not xHCI support. The `default` tree contains
no NVMe or xHCI support. All trees otherwise have the same fixes on top of
upstream GRUB, e.g. fix for Dell Latitude keyboard controllers.
src/int/
--------
Riku Viitanen wrote this tool for debugging, when implementing MXM option ROM
support in coreboot and SeaBIOS, for the HP EliteBook 8560w.
NOTE: The EliteBook 8560w isn't actually supported in Canoeboot yet, but this
could be used for other boards in the future.
src/memtest86plus/
---------------
@ -320,6 +341,23 @@ Please also visit: <https://www.memtest.org/>
This is provided inside ROM images, as a payload executed from main GRUB or
SeaBIOS payload. It checks for corrupted memory.
src/mxmdump/
------------
Riku Viitanen wrote this utility, for dumping the MXM config on graphics cards
that use it. The HP EliteBook 8560w uses these cards, and normally you would
just run a VGA option ROM to get a display at boot time. The MXM cards
additionally contain a configuration called MXM, which basically describes
ports and several power management capabilities.
MXM data is loaded via an INT15H handler, which Riku also implemented in
SeaBIOS. If the MXM data is not handled, the VGA option ROM (when executed)
will often complain and refuse to boot; some of them can be hacked to bypass
this fact, but such hacks are no longer required because of Riku's tool.
NOTE: The EliteBook 8560w isn't supported in Canoeboot yet, but this tool
could be used for other machines in the future.
src/seabios/
---------------
@ -346,6 +384,23 @@ provides UEFI. Information about that can be found on these resources:
This is currently the only payload on *ARM* systems, within Canoeboot.
U-Boot is also available on x86 machines, since the Libreboot 20241205 release.
More information can be found on the [U-Boot x86 page](../install/uboot-x86.md);
it is available as an alternative to the traditional SeaBIOS and GRUB payloads,
and it can successfully boot UEFI applications on x86 Canoeboot systems.
src/pcsx-redux
----------------
PCSX-Redux is a Sony Playstation (PS1/PSX) emulator, but Canoeboot only uses
one part from it: the Open BIOS. This is used by Canoeboot to provide an
open BIOS for the Sony Playstation!
More information available on the [PlayStation page](../install/playstation.md).
This is automatically compiled by the main build script, and the resulting
BIOS image is provided in Canoeboot release archives.
src/pico-serprog
---------------------------
@ -1170,6 +1225,12 @@ This function also contains `x_()` which cbmk uses to execute commands
and ensure that they cause an exit (with non-zero status) from cbmk, if they
return an error state.
This also includes the `mk()` function, which can be used as shorthand to
build multiple projects, but it doesn't handle targets within multi-tree projects,
so if for example you say `mk coreboot`, it would build every coreboot target.
This is useful for the release build logic, because now it can much more simply
build all of Canoeboot, while still being flexible about it.
include/rom.sh
-----------
@ -1238,6 +1299,10 @@ When the ROM is finished compiling, it will appear under a directory in `bin/`
This script is the beating heart of Canoeboot. Break it, and you break
Canoeboot!
CCACHE is automatically used, when building coreboot, but not currently for
other projects. This is done by cooking coreboot configs at build time, enabling
coreboot's build option for it.
Serprog images:
--------------