doc: shields: document convention for zephyr_[protocol] DT nodelabels #92355
+63
−0
Conversation
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
JarmouniA
force-pushed
the
doc_shield_comm_node_label
branch
2 times, most recently
from
b93b136 to
af0c589
Compare
Add guidance on using extra devicetree nodelabels (zephyr_i2c, zephyr_spi, zephyr_mipi_dsi) in board DTS files for common communication protocols. This convention enables shields to reference standard bus nodes in a portable and generic way. Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
JarmouniA
force-pushed
the
doc_shield_comm_node_label
branch
from
af0c589 to
05919f7
Compare
|
github-actions
bot
requested review from
avisconti,
erwango,
jfischer-no and
kartben
Comment on lines
+174
to
+176
| - I2C (``zephyr_i2c``) | ||
| - MIPI DSI (``zephyr_mipi_dsi``) | ||
| - SPI (``zephyr_spi``) |
There was a problem hiding this comment.
zephyr_i2c was actually meant to be the case above though: a well known connector (or connector family in this case), though I see how one could put it anywhere and then use a header to qwiic adapter or something, but that's not the case I had in mind. For SPI there's been no use case yet (I'm aware of one used in keyboards can't recall the name, but nothing landed upstream). Works well for dsi and udc.
There was a problem hiding this comment.
I need to think about this a little bit more.
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.
Add guidance on using extra devicetree nodelabels (zephyr_i2c, zephyr_spi, zephyr_mipi_dsi) in board DTS files for common communication protocols.
This convention enables shields to reference standard bus nodes in a portable and generic way.
This follows #89725 and #37474.