Correct the I2C bus descriptions in the hardware reference - #42
Conversation
1a7e812 to
e9c87df
Compare
Code review — PR #42Scope: Verification of the change itselfConfirmed from the netlist in
The TMP112A hangs off the RP2040's private bus and is absent from I2C1. Not verified against hardware: P2 — Moderate
Why it matters here rather than as a standalone nit: a reader who has just lost the 0x4b row reads the next sentence, sees "controller I2C bus", and lands on exactly the wrong conclusion this PR set out to prevent. Pre-existing, same paragraph as the edit. Routing decision needed: fix in this PR, or file a follow-up issue. P3 — Low (applied)
AdvisoryThe stated reason for omitting replacement prose — the sensor is not visible to the user — does not hold as written. Coverage
Verdict: ready with fixes. The removal is correct and verified against the netlist. Finding 2 is applied. Finding 1 needs a routing decision — fix here or file an issue — before merge. |
|
Finding 1 fixed in 5717188. One correction to what I proposed above: I2C0 is not on GPIO 0/1. Traced through the netlist, the four buses are distinct:
New text:
One observation left unactioned, since it is outside this PR's scope: line 171 says "All remaining GPIO pins are available for HATs and user applications." GPIO 0/1 are the HAT ID EEPROM pins and R135/R136 tie them to MIPI1, so a HAT EEPROM and a MIPI1 display share that bus. Worth a sentence somewhere, or a deliberate decision that it is too niche to document. |
The TMP112A sits on the RP2040's own I2C bus, so the CM5 never sees it at 0x4b.
5717188 to
eb9d3d7
Compare
Translation statusda — 20 current Every translation of the pages in scope is current. |
I2C0 is not the controller bus: the RP2040 is absent from that net. It reaches MIPI0 from the CM5 SDA0/SCL0 pins. MIPI1 runs off ID_SD/ID_SC through 0R links R135/R136, which carry the 2.2k pull-ups R54/R55. HDMI DDC has its own CM5 pins.
Each page loses the 0x4b row, says the bus has one onboard device, and gets the corrected MIPI and HDMI bus description. Glossaries gain the terms the new sentence needed: resistor, onboard, dedicated, pull-up.
eb9d3d7 to
b68e7d3
Compare
The hardware reference listed the TMP112A at 0x4b on the system I2C bus. The sensor is wired to the RP2040's own I2C bus (
temp_sensor.kicad_schis a subsheet ofcontrol_mcu.kicad_sch, connected to the localI2Cmbus), so the CM5 never sees it there. Anyone scanning I2C1 would find only the controller at 0x6d.Review of that removal turned up a second error in the same paragraph. The sentence describing I2C0 was wrong on four counts, and losing the 0x4b row above it would have left a reader concluding the sensor lives on the bus it names. Traced through the netlist, the buses are distinct:
I2C_DPHY1Both corrections are carried into all nine translations, each against its own glossary, with the glossaries extended where the new sentence needed a term they did not fix (resistor, onboard, dedicated, pull-up).
translation_status.pyreports every language current;mkdocs build --strict,check_anchors.py,check_glossary.pyandcheck_typography.pypass. The one glossary miss the checker reports, French blackout, predates this branch and is filed as #44.🤖 Generated with Claude Code