29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
# Firmware
|
|
|
|
This directory is the Kaptan flight-controller firmware workspace. It owns the
|
|
Rust workspace manifest, board declarations, platform implementation, reusable
|
|
firmware crates, simulator, firmware scripts, and firmware test fixtures.
|
|
|
|
```text
|
|
firmware/
|
|
├── boards/ immutable board declarations and linker layouts
|
|
├── libs/ reusable no_std firmware crates
|
|
├── platforms/ hardware platform composition
|
|
├── tools/ SITL and firmware development tooling
|
|
├── scripts/ packaging, analysis, and coverage helpers
|
|
└── tests/ firmware integration-test fixtures
|
|
```
|
|
|
|
This workspace owns its Makefile. From this directory, list its commands with:
|
|
|
|
```sh
|
|
make help
|
|
```
|
|
|
|
From the repository root, the firmware path is a direct Cargo proxy. For
|
|
example, `make firmware -- test --workspace --locked --offline` runs the host
|
|
test suite. Build and package every supported board with
|
|
`make firmware/boards`, or select one board by its directory path.
|
|
Run `make firmware clippy` for Rust lints and `make firmware docs` for API
|
|
documentation with warnings denied.
|