summaryrefslogtreecommitdiff
path: root/src/esp32p4/selftest.zig
diff options
context:
space:
mode:
Diffstat (limited to 'src/esp32p4/selftest.zig')
-rw-r--r--src/esp32p4/selftest.zig10
1 files changed, 3 insertions, 7 deletions
diff --git a/src/esp32p4/selftest.zig b/src/esp32p4/selftest.zig
index 0d692d98..97b43059 100644
--- a/src/esp32p4/selftest.zig
+++ b/src/esp32p4/selftest.zig
@@ -35,22 +35,18 @@
//!
//! Four of its modules and no more: `soc` (mask-ROM printf, the cycle counter), `hal` (UART0, the
//! systimer, clock/reset), `config` (this build's `cpu_mhz`) and `heap` (the coalescing allocator).
-//! They arrive as the `zig_p4` dependency, which also supplies what makes this an image at all -
-//! the generated linker script, `ENTRY(_start)` and the app descriptor via `firmware(...).attach`,
-//! then `ImageStep`, `FlashStep` and `SelftestStep`.
+//! The sibling `05-zig-p4` build supplies these modules and the firmware image tooling.
//!
//! `input_rescue` is the fifth import and is NOT that package's: it is the sibling file in this
//! directory, handed over as a named MODULE rather than imported as a path. Deliberately so - the
//! `pub` on `FakePort`'s methods below is what lets that module reach them by duck typing across the
-//! boundary, and both builds, this repository's `esp32p4-test` and the toolchain's `selftest`, wire
-//! the identical root the identical way. One file, one arrangement, nothing to drift.
+//! boundary. The toolchain's `selftest` step wires this root and that module together.
//!
//! Not a `zig test` binary, deliberately. Zig's test runner wants an OS, and `std.testing.allocator`
//! is a debug allocator over the page allocator, which on freestanding is either a compile error or
//! a lie. A hand-rolled harness is thirty lines and answers to nobody.
//!
-//! Run with: zig build esp32p4-test -Dplatform=esp32p4 -Desp32p4-firmware (from here)
-//! or: zig build selftest (from ../05-zig-p4)
+//! From `../05-zig-p4`, `zig build selftest` flashes and runs this suite on hardware.
const std = @import("std");
const soc = @import("soc");