Add in-repo project docs: goals, state, hardware, module-PHY transports, module diagnostics, and measurement lessons

2026-08-10 10:34:26 -07:00
parent 6d73221123
commit 6597a11c33
10 changed files with 253 additions and 0 deletions
@@ -0,0 +1,12 @@
+# cabletest docs
+
+Project knowledge that moves and versions with the repo.
+
+- [goals.md](goals.md) — what cabletest is for and what it must output.
+- [state.md](state.md) — where things are now: committed vs stashed, hardware in flight, bringup plan, open items.
+- [hardware.md](hardware.md) — the box, interfaces, host tuning, how to run.
+- [transports.md](transports.md) — how to reach module-PHY diagnostics, why the NIC choice governs it, and the register-level protocols.
+- [modules.md](modules.md) — per-module diagnostics, register maps, cable-length physics, and the Marvell brick hazard.
+- [measurement.md](measurement.md) — how to measure correctly; performance results and dead ends.
+
+Vendor PDFs (BCM84891L transport + command handler, Marvell 88E151x datasheet) live alongside these.