How-to Guides¶
Step-by-step instructions for specific tasks. Assumes a working build environment.
For first-time setup, start with Build the ToloMEO Reference Image.
Development¶
| Guide | Covers |
|---|---|
| Configure the Development Environment | Builds that survive VS Code sessions, shared state mirrors, host cache directories, a local sstate HTTP server, parallelism tuning |
Configuration¶
| Guide | Covers |
|---|---|
| Configure meta-tolomeo for Your Machine | Overriding the TLM_ interface, redirecting OTA paths, checking the machine configuration |
| Manage User Accounts | Declaring production image accounts with TLM_USERS, adding an account, and supplying password hashes |
Security¶
| Guide | Covers |
|---|---|
| Generate a HAB4 PKI Tree | CST keys, SRK table, and eFuse programming (i.MX8M) |
| Generate an AHAB PKI Tree | SPSDK keys, SRK hash, and eFuse programming (i.MX9) |
| Enable NXP Authenticated Boot | HAB4 and AHAB boot image signing for i.MX8M and i.MX9 |
| Enable FIT Image Signing | RSA signing of the Linux kernel FIT image |
| Manage the CVE Database | NVD database fetch, API key, backup seeding, and scheduled refresh |
| Export SBOM and VEX | CycloneDX SBOM/VEX generation, kernel CVE enrichment, supplier setup |
Update¶
| Guide | Covers |
|---|---|
| Configure Update Modes | Enabling the OTA file, OTA streaming and USB update modes through DISTRO_FEATURES |
| Generate a Signed Update Package | RSA signing key pair, key location, and a signed full update package |
| Generate a Delta Update | Incremental (rdiff) update packages with binary diffs |
| Generate an Encrypted Artifact | AES-256-CBC encrypted .swu packages |
Offline¶
| Guide | Covers |
|---|---|
| Enable Offline Capabilities | Licensed access token, opt-in build with kas/offline.yml, enabling the layer in your own project |
QEMU¶
| Guide | Covers |
|---|---|
| Run in Standalone Mode | Running a ToloMEO image in QEMU without the devcontainer |
| Test Updates in QEMU | Triggering OTA and USB updates against a QEMU instance |
| Run oeqa Tests in QEMU | Running the oeqa runtime suite (systemd, platform, cloud) and ptests against a QEMU image |