Index — ALP SDK getting-started reading order

ALP SDK Getting Started
1

Welcome. If you’ve just landed here, read these in order — they’re written so you can stop at any point and have a working firmware build.

  1. docs/getting-started.md — host setup (Linux / macOS / Windows 11+), toolchain install, your first build.
  2. docs/firmware-quickstart.md — per-SoM choices, idiomatic patterns for the on-module chips (PMICs, RTC, Wi-Fi/BT, Ethernet PHYs, DEEPX), and pointers into the rest of the doc tree.
  3. docs/board-config.md — full board.yaml schema reference. The 30-second quick start in the SDK README is the TL;DR.
  4. Pick your SoM one-pager — docs/soms/aen.md, docs/soms/v2n.md, docs/soms/v2n-m1.md, docs/soms/imx93.md. Each lists what’s exposed, where examples live, and any bring-up gotchas.
  5. Glossary + troubleshooting — docs/glossary.md, docs/troubleshooting.md.

Two consumer paths — pick whichever fits:

  • Standalone / hand-written firmware — write a Zephyr (or Yocto, or bare-metal) app against <alp/...> headers directly. Capability validation runs at runtime in *_open; alp_last_error() tells you why an open failed.
  • alp-studio codegen — the studio reads block manifests, runs the pin allocator over the active SoM’s manifest, and emits C that calls the same <alp/...> API.

Stuck? Reply to this topic or open an issue at https://github.com/alplabai/alp-sdk/issues.