procyberian/firmware-open
2
0
Fork 0
mirror of https://github.com/system76/firmware-open.git synced 2025-07-04 13:19:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
firmware-open/docs/building.md
Tim Crawford 4fc740e789 docs: Add note about checking out submodules 
Signed-off-by: Tim Crawford <tcrawford@system76.com>
2025-04-28 13:38:52 -06:00

1.1 KiB
Raw Permalink Blame History

Building

After cloning the repo, ensure all submodules are cloned.

git submodule update --init --checkout --recursive

Dependencies can be installed with the provided scripts.

./scripts/install-deps.sh
./scripts/install-rust.sh
./scripts/coreboot-sdk.sh
./ec/scripts/deps.sh

If rustup was installed for the first time, it will be required to source the environment file it installed to use the correct Rust toolchain.

. ~/.cargo/env

A script is provided to build the firmware. The available targets for building are the model folders in models/. For example, to build for QEMU:

./scripts/build.sh qemu

Once built, the firmware must be flashed to use. Several scripts are available to flash the new firmware, depending on how it is going to be written.

  • scripts/qemu.sh: Run the firmware in QEMU (specific to the QEMU model)
  • scripts/flash.sh: Flash using firmware-update
  • scripts/ch341a-flash.sh: Flash using a CH341A programmer
  • scripts/spipi-flash.sh: Flash using a Raspberry Pi

See Flashing firmware for more details.