[i2c, doc] Improve consistency regarding device / target mode
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
For quite some time now, OpenTitan consistently uses the terms `host` and `device` in documentation, RTL code, specifications etc. One exception is the I2C specification where other than `host` and `device` also `target` and `target device` or `target mode` occur. Actually, in most places `target` is used. Interestingly the tests for the `target` mode are then labeled with `device`.
We should improve consistency here.
Contributor guide
Research direction
Review the I2C specification and the tests labeled for target mode, then search related documentation, RTL, and specifications for the competing host/device and target terminology. Identify the project-wide convention to apply and verify that the terminology is consistent across the affected material and test labels.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100