docs: README review pass — current chip status + project layout#71
Merged
Conversation
Brings the README in line with the driver's current behaviour: - Intro: drop the stale "partial-receiver-dependent 5 GHz UNII-2/3 TX" qualifier on 8821AU; it now ships TX + RX on every band like 8812. - 8821AU row: TX + RX across all bands. UNII-2/3 has a cross-receiver asymmetry against 8812AU peer receivers — note that and stop. - 8814AU row: drop stale link to a closed issue; the on-air-TX-silent fact stands on its own. - 8811AU row: drop "no DUT in the test rig" phrasing. - TxDemo description: covers both the default `libusb_open_device_with_vid_pid` path AND the Termux fd-wrap path; prior wording made the latter sound mandatory. - Project layout: add the five files that landed during the recent calibration / per-rate TX-power work — `Hal8812a_PhyRegPg.h`, `Hal8812a_TxpwrLmt.h`, `Hal8812a_TxPwrTrack.[h,cpp]`, `src/PowerTracking8812a`, `src/Iqk8812a`. Conventions enforced in this pass (apply to future README edits too): no PR/issue number references, no rig-specific hit counts, no defensive phrasing about whose chip is at fault — README states current driver behaviour, patch-note context belongs in commits. The 8821AU UNII-2/3 RX behaviour change depends on the init-time chip-wedge fix landing first; that's in a separate PR. Land this one after. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
josephnef
force-pushed
the
docs-readme-8821-unii23-rx-fixed
branch
from
623caca to
cd08208
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
1 participant
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.
Summary
Review pass on README to bring it in line with current driver behaviour and enforce project doc conventions.
Content changes
libusb_open_device_with_vid_pidpath AND the Termux fd-wrap path; the prior wording made the latter sound mandatory.Hal8812a_PhyRegPg.h,Hal8812a_TxpwrLmt.h,Hal8812a_TxPwrTrack.[h,cpp],src/PowerTracking8812a,src/Iqk8812a.Conventions enforced (apply to future README edits too)
~5900/7000,4160/4500, etc.).Merge order
The 8821AU UNII-2/3 RX behaviour change documented in the table cell depends on the init-time chip-wedge fix in the sibling PR landing first. Land this PR after that one.
🤖 Generated with Claude Code