diff options
| author | hathach <[email protected]> | 2026-08-20 14:30:59 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2026-08-21 00:47:27 +0700 |
| commit | 872b4fbdc3c607b522211839a6b3b82e18310a1b (patch) | |
| tree | ebb5e40aa6774417ad2d3f2f8968dd17c78b83ba /docs/reference/index.rst | |
| parent | 9466f3cda69b052679e7bb078b5cf7906ddbea27 (diff) | |
docs: add hardware-in-the-loop rig reference
Document the ci and hfp HIL rigs in enough detail to reproduce one: bill of
materials with photos, BIOS/IOMMU and vfio-pci passthrough on the Proxmox
host, the Renesas uPD720201 firmware install, the guest software and
permissions, the one-hub-per-root-port USB topology rule and the per-box
split of probe and DUT hubs, how CI drives the rigs, and the operational
gotchas.
The attached-board table is generated from test/hil/tinyusb.json and
test/hil/hfp.json by tools/gen_doc.py into docs/reference/hil_boards.md,
which the page includes. Sphinx excludes that partial so it is not also
built as an orphan document.
Also exclude docs/superpowers/ from the Sphinx build: it holds internal
plans, specs and handoffs rather than published documentation, and since
nothing references them from a toctree each emitted "document isn't
included in any toctree" -- 26 warnings in total, so build_doc.py -W could
never pass. It now does.
Diffstat (limited to 'docs/reference/index.rst')
| -rw-r--r-- | docs/reference/index.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/reference/index.rst b/docs/reference/index.rst index c66ce618f..85fd767ea 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -14,4 +14,5 @@ Complete reference documentation for TinyUSB APIs, configuration, and supported dependencies concurrency device_issues + hardware-in-the-loop glossary |