docs: visual driver primer — the vendor-driver machinery as a picture book#283
Merged
Conversation
… book Sibling of rf-primer.md for the silicon/software side: thirteen animated sections walking a newcomer from chip anatomy and register access through efuse, FWDL/WCPU, H2C/C2H (incl. fw IO-offload), DMAC/CMAC/DLE/NIC-HFC, the BB/RF register tables and check_positive gating, LSSI + DAV/DDV RF windows, RF18/LCK channel tuning, halrf calibration (DACK/RX-DCK/IQK), the BB dynamic mechanisms (DIG), and coexistence — capped by a three-generation vendor-tree map (rtl8812au -> halmac -> G6 phl) and a term -> vendor-path -> devourer-path glossary. Thirteen new monitor-style Pillow generators under tools/, one per section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
ee19a6d to
5a517bc
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sibling of
rf-primer.mdfor the silicon/software side: where the RF primer teaches the radio physics, this one teaches the vendor-driver vocabulary a newcomer needs before touching a Realtek tree or devourer's HALs.What's inside
docs/driver-primer.md— thirteen animated sections, ordered from the silicon up:+0x10000BB windowcheck_positiveper-cut/per-RFE gatingCapped by a three-generation vendor-tree map (rtl8812au monolith → halmac → G6 phl/mac_ax/halbb/halrf) with navigation habits, and a ~50-term glossary table (term → vendor path → devourer path → section).
Each section opens with a new animation in the established DEVOURER live-monitor style — 13 new self-contained Pillow generators under
tools/*_gif.py(deterministic, seeded, samemonitor_style.pychrome as the rf-primer set).Cross-linked from the README (intro + Going deeper), the RF primer's Where to go next, and the 8822e quirks doc header.
Validation
python3 tools/X_gif.py -o docs/img/X.gif); frames visually inspected for text collisions.reference//src/path exists on master.🤖 Generated with Claude Code