Compare commits

2 Commits
Author SHA1 Message Date
ktims 8917696367 bootloader: enter ISP from a boot request honoured before peripheral setup
Build and Release Firmware / firmware (ak4490) (push) Successful in 18s
Build and Release Firmware / firmware (cs4398) (push) Successful in 17s
Build and Release Firmware / firmware (evk) (push) Successful in 17s
Build and Release Firmware / cli (aarch64-unknown-linux-musl) (push) Successful in 1m0s
Build and Release Firmware / cli (universal2-apple-darwin) (push) Successful in 51s
Build and Release Firmware / cli (x86_64-pc-windows-gnu) (push) Successful in 1m5s
Build and Release Firmware / cli (x86_64-unknown-linux-musl) (push) Successful in 57s
Build and Release Firmware / release (push) Successful in 7s
2026-11-11 21:57:39 -07:00
ktims cc92b55df4 build: build for apple
Build and Release Firmware / firmware (ak4490) (push) Successful in 17s
Build and Release Firmware / firmware (cs4398) (push) Successful in 16s
Build and Release Firmware / firmware (evk) (push) Successful in 15s
Build and Release Firmware / cli (aarch64-unknown-linux-musl) (push) Successful in 1m58s
Build and Release Firmware / cli (universal2-apple-darwin) (push) Successful in 1m16s
Build and Release Firmware / cli (x86_64-pc-windows-gnu) (push) Successful in 1m26s
Build and Release Firmware / cli (x86_64-unknown-linux-musl) (push) Successful in 1m14s
Build and Release Firmware / release (push) Successful in 7s
2026-11-11 18:57:25 -07:00
10 changed files with 197 additions and 73 deletions

No files matched your search

+31
View File
@@ -0,0 +1,31 @@
FROM ghcr.io/rust-cross/cargo-zigbuild:latest
# The base image may resolve its toolchain through $HOME, which the runner does not preserve for
# action containers, so pin it to a fixed path. entrypoint.sh re-exports this because the runner
# injects the workflow environment into action containers as well.
ENV RUSTUP_HOME=/usr/local/rustup
RUN if ! rustup default >/dev/null 2>&1; then \
rustup toolchain install stable --profile minimal --no-self-update; \
rustup default stable; \
fi
# The image ships the toolchain, zig, a macOS SDK and cargo-zigbuild, but not the bits the build and
# packaging scripts need.
RUN apt-get update \
&& apt-get install -y --no-install-recommends ca-certificates zip zstd \
&& rm -rf /var/lib/apt/lists/*
# Install every target up front so building needs no network access. `universal2-apple-darwin` is
# not a rustc target: cargo-zigbuild builds both architectures and merges them.
RUN rustup target install \
aarch64-unknown-linux-musl \
x86_64-unknown-linux-musl \
x86_64-pc-windows-gnu \
aarch64-apple-darwin \
x86_64-apple-darwin
COPY entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]
+13
View File
@@ -0,0 +1,13 @@
name: Build guac CLI
description: Cross-compile the guac CLI with cargo-zigbuild and package the artifact
inputs:
target:
description: Rust target triple, or universal2-apple-darwin
required: true
runs:
using: docker
image: Dockerfile
args:
- ${{ inputs.target }}
+26
View File
@@ -0,0 +1,26 @@
#!/bin/sh
set -eu
target="$1"
cd "${GITHUB_WORKSPACE:-$(pwd)}"
# The runner overrides env vars from the workflow for action containers, so re-assert the
# toolchain path the image installed to, and keep the registry in the workspace for caching.
export RUSTUP_HOME=/usr/local/rustup
export CARGO_HOME="${PWD}/.cargo-cache"
bin=guac-cli
case "$target" in
*windows*) bin=guac-cli.exe ;;
esac
(cd cli && cargo zigbuild --release --target "$target")
artifact="target/${target}/release/${bin}"
if [ ! -f "$artifact" ]; then
artifact="cli/${artifact}"
fi
mkdir -p dist
zip -j "dist/guac-cli-${target}.zip" "$artifact"
+21 -58
View File
@@ -5,13 +5,6 @@ on:
tags:
- "v*"
env:
TARGET: thumbv8m.main-none-eabihf
# The catthehacker image installs rust here and only symlinks ~/.rustup and ~/.cargo to it.
# actions/cache archives the symlink, not its contents, so point at the real paths.
RUSTUP_HOME: /usr/share/rust/.rustup
CARGO_HOME: /usr/share/rust/.cargo
jobs:
firmware:
runs-on: ubuntu-latest
@@ -21,8 +14,15 @@ jobs:
fail-fast: true
matrix:
variant: [cs4398, ak4490, evk]
# Job-scoped on purpose: the runner also injects workflow env into action containers, where it
# would override the cli image's own toolchain paths.
env:
FEATURES: ${{ matrix.variant }},hid
TARGET: thumbv8m.main-none-eabihf
# The catthehacker image installs rust here and only symlinks ~/.rustup and ~/.cargo to it.
# actions/cache archives the symlink, not its contents, so point at the real paths.
RUSTUP_HOME: /usr/share/rust/.rustup
CARGO_HOME: /usr/share/rust/.cargo
steps:
- name: Checkout repository
uses: actions/checkout@v4
@@ -69,10 +69,6 @@ jobs:
cli:
runs-on: ubuntu-latest
container:
# Bundles the Rust toolchain, zig and a macOS SDK, which the generic builder images lack;
# we cross-compile every target from here with cargo-zigbuild.
image: ghcr.io/rust-cross/cargo-zigbuild:latest
strategy:
fail-fast: false
matrix:
@@ -81,64 +77,31 @@ jobs:
- x86_64-pc-windows-gnu
- x86_64-unknown-linux-musl
- universal2-apple-darwin
env:
RUSTUP_HOME: /usr/local/rustup
CARGO_HOME: /usr/local/cargo
steps:
# JavaScript actions need node, which the rust-cross image does not ship. Install it (and the
# rest of the tooling the actions rely on) before anything else, as a shell step.
- name: Install Actions tooling
run: |
apt-get update
apt-get install -y --no-install-recommends ca-certificates curl git zip zstd
if ! command -v node > /dev/null; then
curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
apt-get install -y --no-install-recommends nodejs
fi
- name: Checkout repository
uses: actions/checkout@v4
- name: Cache rustup
# Building and packaging both happen in .gitea/actions/cli-build, whose image the runner
# builds from its Dockerfile and keeps in the Docker layer cache. That image carries the
# toolchain, zig, the macOS SDK and every target, so none of that is installed per job.
- name: Cache cargo registry
uses: actions/cache@v4
with:
path: ${{ env.RUSTUP_HOME }}
key: rustup-cli-${{ matrix.target }}-${{ runner.os }}
path: .cargo-cache
key: cli-registry-${{ hashFiles('**/Cargo.lock') }}
restore-keys: cli-registry-
- name: Install Rust Toolchain
run: |
rustup target install ${{ matrix.target }}
# cargo-zigbuild builds both architectures and merges them for the universal binary.
if [[ "${{ matrix.target }}" == universal2-apple-darwin ]]; then
rustup target install aarch64-apple-darwin x86_64-apple-darwin
fi
shell: bash
- name: Cache cargo
uses: Swatinem/rust-cache@v2
with:
shared-key: cli-${{ matrix.target }}
# compiled libc/compiler-rt are per target, so these stay keyed on it
- name: Cache zig build artifacts
- name: Cache build artifacts
uses: actions/cache@v4
with:
path: |
~/.cache/zig
~/.cache/cargo-zigbuild
key: zigbuild-cache-${{ matrix.target }}-${{ runner.os }}
path: target
key: cli-target-${{ matrix.target }}-${{ hashFiles('**/Cargo.lock') }}
restore-keys: cli-target-${{ matrix.target }}-
- name: Build cli (${{ matrix.target }})
working-directory: cli
run: cargo zigbuild --release --target ${{ matrix.target }}
- name: Package
run: |
bin=guac-cli
[[ "${{ matrix.target }}" == *windows* ]] && bin=guac-cli.exe
mkdir -p dist
zip -j "dist/guac-cli-${{ matrix.target }}.zip" "target/${{ matrix.target }}/release/$bin"
shell: bash
uses: ./.gitea/actions/cli-build
with:
target: ${{ matrix.target }}
- name: Upload artifact
uses: actions/upload-artifact@v3
Generated
+2 -2
View File
@@ -952,7 +952,7 @@ dependencies = [
[[package]]
name = "guac"
version = "0.3.1"
version = "0.3.2"
dependencies = [
"atomic",
"bbqueue",
@@ -978,7 +978,7 @@ dependencies = [
[[package]]
name = "guac-cli"
version = "0.3.1"
version = "0.3.2"
dependencies = [
"async-hid",
"clap",
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "guac-cli"
version = "0.3.1"
version = "0.3.2"
edition = "2024"
[dependencies]
+1 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "guac"
version = "0.3.1"
version = "0.3.2"
edition = "2024"
[features]
+67
View File
@@ -48,6 +48,73 @@ fn slot_address(index: usize) -> usize {
config_base() + CONFIG_RESERVED + index * SLOT_SIZE
}
// The spare page in the reserved area, used to carry a boot request across a reset.
const BOOT_REQUEST_MAGIC: u32 = u32::from_le_bytes(*b"BOOT");
fn boot_request_address() -> usize {
config_base() + FLASH_PAGE_SIZE
}
/// Writes a boot request and resets. The next boot hands over to the ROM before configuring
/// anything, which is the only way it gets a chip that is still in its reset state.
#[cfg(feature = "hid")]
pub fn request_bootloader(state: &mut FlashState) -> Result<(), ()> {
defmt::info!("config: requesting bootloader");
cortex_m::interrupt::free(|_| {
slow_clock_for_flash();
let address = boot_request_address();
let mut page = [0xffu8; FLASH_PAGE_SIZE];
page[..4].copy_from_slice(&BOOT_REQUEST_MAGIC.to_le_bytes());
if state.flash.erase_page(address / FLASH_PAGE_SIZE).is_err() {
defmt::error!("config: boot request erase failed");
return Err(());
}
if state
.flash
.write_native(address, GenericArray::from_slice(&page))
.is_err()
{
defmt::error!("config: boot request write failed");
return Err(());
}
Ok(())
})?;
// Let the probe client drain RTT before the reset tears it down.
cortex_m::asm::delay(15_000_000);
cortex_m::peripheral::SCB::sys_reset()
}
/// Consumes a pending boot request, clearing it first so a hand-off that fails to enter ISP cannot
/// cause a boot loop.
pub fn take_bootloader_request(flash: &mut FlashGordon) -> bool {
slow_clock_for_flash();
let address = boot_request_address();
let mut word = [0u8; FLASH_WORD_SIZE];
if read_flash(address, &mut word).is_err() {
return false;
}
if u32::from_le_bytes([word[0], word[1], word[2], word[3]]) != BOOT_REQUEST_MAGIC {
return false;
}
if flash.erase_page(address / FLASH_PAGE_SIZE).is_err() {
defmt::error!("config: boot request clear failed");
}
defmt::info!("config: boot request found");
true
}
fn config_buf() -> &'static mut [u8; SLOT_SIZE] {
// Safety: flash access is not reentrant and the buffer is only borrowed for one operation at a time.
unsafe { &mut *core::ptr::addr_of_mut!(CONFIG_BUF) }
+4 -1
View File
@@ -242,7 +242,10 @@ impl CommandState {
}
Action::Bootloader => {
ack_delay();
crate::boot_to_bootloader();
if config::request_bootloader(flash).is_err() {
defmt::error!("boot request failed, staying in the application");
}
}
Action::Commit => {
ack_delay();
+31 -10
View File
@@ -218,17 +218,32 @@ static PERF: PerfCounters = PerfCounters {
// fb: AtomicI32::new(0),
};
fn boot_to_bootloader() -> ! {
cortex_m::interrupt::disable();
fn boot_to_isp() -> ! {
// Hand the ROM a chip that is still in its reset state, with the ISP pin held low. Peripheral
// resets are left alone: holding them asserted stops the ROM's own USB from coming up.
let mut syscon = unsafe { hal::Syscon::steal() };
let mut iocon = unsafe { hal::Iocon::steal() }.enabled(&mut syscon);
let mut gpio = unsafe { hal::Gpio::steal() }.enabled(&mut syscon);
let _isp = unsafe { pins::Pio0_5::steal() }
.into_gpio_pin(&mut iocon, &mut gpio)
.into_output_low();
unsafe {
(*pac::IOCON::ptr())
.pio0_5
.modify(|_, w| w.mode().pull_down())
};
// And the boot error counter, in case the pin is not the input the ROM acts on.
unsafe {
let pmc = &*pac::PMC::ptr();
// https://community.nxp.com/t5/LPC-Microcontrollers/Configure-LPC55-to-enter-re-invoke-ROM-Bootloader-from/m-p/966990?profile.language=en
// If you write the following register, it will be set to boot from the ROM:
// PMC->AOREG1 |= (0x0A << 16); //Set to boot from ROM
// NVIC_SystemReset(); //Reset‍‍
pmc.aoreg1.modify(|r, w| w.bits(r.bits() | (0x0a << 16)));
pmc.aoreg1.modify(|r, w| w.bits(r.bits() | (0xa << 16)));
}
cortex_m::peripheral::SCB::sys_reset()
cortex_m::interrupt::disable();
defmt::info!("bootloader: entering ROM from the reset state");
cortex_m::asm::delay(15_000_000);
unsafe { cortex_m::asm::bootload(0x0300_0000 as *const u32) }
}
fn build_telemetry_report<D: Dac<I>, I>(
@@ -838,6 +853,14 @@ fn main() -> ! {
debug!("start");
// A boot request is honoured before any peripheral or clock is configured beyond what reading
// flash requires, so the ROM is entered with the chip still in its reset state.
let mut flash = hal::FlashGordon::new(hal.flash.enabled(&mut syscon));
if config::take_bootloader_request(&mut flash) {
boot_to_isp();
}
debug!("iocon");
let usb0_vbus_pin = pins::Pio0_22::take()
.unwrap()
@@ -888,8 +911,6 @@ fn main() -> ! {
// Flash controller commands require a core clock of at most 100 MHz, so the config is read
// before the system PLL takes the core to 150 MHz.
let flash = hal.flash.enabled(&mut syscon);
let mut flash = hal::FlashGordon::new(flash);
defmt::info!("config: loading");
let (running_config, active_slot) = config::load(&mut flash);
defmt::info!(