lowRISC / lowRISC/opentitan

[i3c/doc] Programmers Guide documentation requires completion

Open
#31,317 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

### Description

An issue to capture the known omissions and deficiencies of the present Programmers Guide documentation.

- Target transceiver reset and connection/disconnection needs description, along with the expected delays involved, e.g. the Bus Available condition.
- In particular the TTI, being bespoke, requires thorough documentation on how to develop a software driver for the TTI.

Contributor guide

Open the contributing guide

Research direction

Start by locating the current i3c Programmers Guide and its TTI sections, then review the existing descriptions of transceiver reset, connection and disconnection behavior. Document the expected delays, including the Bus Available condition, and provide thorough guidance for developing a software driver for the bespoke TTI. Done means the listed omissions and deficiencies are covered in the guide.

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
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.