theater/cabletest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Restructure docs: per-device directories under modules/ and nics/ with co-located datasheets, state centralized in state.md, prose tightened into lists and tables

Browse Source
This commit is contained in:
flamingcow
2026-08-12 19:23:02 -07:00
parent dc1fa6538d
commit c57816345f
24 changed files with 511 additions and 311 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+11 -8
View File
@@ -2,12 +2,15 @@
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.
- [open-questions.md](open-questions.md) — genuinely open problems worth deeper thinking before the X520 hardware arrives.
General:
Vendor PDFs (BCM84891L transport + command handler, Marvell 88E151x datasheet) live alongside these.
- [goals.md](goals.md) — what cabletest is for and what it must output.
- [state.md](state.md) — where things are now: committed vs stashed, the box and what's in it, bringup progress, open items. **All current-placement state lives here and only here.**
- [hardware.md](hardware.md) — host rules: interface conventions, tuning, how to run.
- [measurement.md](measurement.md) — how to measure correctly; performance results and dead ends.
- [open-questions.md](open-questions.md) — the open problems, with their current answers.
Per-device (each directory: device doc + its datasheets):
- [nics/](nics/README.md) — the transport rule, the comparison table, and one directory per NIC: [x520](nics/x520/README.md), [connectx-5](nics/connectx-5/README.md), [x710](nics/x710/README.md), [e810](nics/e810/README.md), [wx1820](nics/wx1820/README.md).
- [modules/](modules/README.md) — module inventory, media-lies table, the shared IEEE register set, RollBall protocol, cable-length physics, and one directory per module: [fs](modules/fs/README.md), [wiitek](modules/wiitek/README.md), [fibergaga](modules/fibergaga/README.md).