summaryrefslogtreecommitdiff
path: root/docs/reference/index.rst
AgeCommit message (Collapse)Author
8 daysdocs: add hardware-in-the-loop rig referencehathach
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.
2026-06-02Merge remote-tracking branch 'tinyusb/master' into ch32_warningHiFiPhile
Signed-off-by: HiFiPhile <[email protected]>
2026-06-02rename to device issuesHiFiPhile
Signed-off-by: HiFiPhile <[email protected]>
2026-05-12test: add MIDI 2.0 Device and Host unit testsSaulo Veríssimo
Add unit tests for MIDI 2.0 drivers: - Device: UMP word count (all 16 message types), descriptor macro validation (length, byte layout, alt settings, endpoints), CS endpoint subtypes, traversal integrity - Host: UMP word count, callback struct validation, CS endpoint subtypes Also add Sphinx documentation for MIDI 2.0 class drivers (Device and Host API reference, lifecycle, configuration, examples). Tests: 60/60 PASS (FIFO 26/26, USBD 5/5, MIDI2 Device 18/18, MIDI2 Host 6/6, USBD internal 5/5)
2025-10-20more consolidationc1570
2025-10-20WIP improved docs (feat. LLM)c1570
2024-12-27update docs, remove uses.rst, structure.rst. Refactor docs, use README.rst ↵hathach
for docs index.rst
2024-12-27move mcu supported to README.rst, separated supported boards to boards.rsthathach
2024-12-27embed metadata to family.c and board.h to generate supported boards dochathach
2024-03-26update doc index.rst to match readme.rst (duplicated)hathach
2023-03-23update doc and generate deps listhathach
2022-05-24fix links in docsSven
changed markdown formatting to rst formatting
2021-08-03add back info to readme, use stack.svghathach
2021-07-30docs: add reference section indexperigoso
Signed-off-by: perigoso <[email protected]>