docs: Add I2C server slave mode extensions for MCTP support #31
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
- Document new slave operations: ConfigureSlaveAddress, EnableSlaveReceive, DisableSlaveReceive, CheckSlaveBuffer - Define architecture for MCTP driver as I2C server client - Add comprehensive API documentation with usage examples - Include error handling patterns and response codes - Document multi-address slave support and hardware considerations - Provide complete MCTP-over-I2C integration example - Add glossary of I2C, Hubris, and protocol terms Enables peer-to-peer management protocols while maintaining clean separation between transport (I2C server) and protocol (MCTP driver) layers.
FerralCoder
requested changes
Sep 16, 2025
|
|
||
| ## Architecture Context | ||
|
|
||
| The I2C server provides transport services to multiple client tasks in the Hubris system: |
There was a problem hiding this comment.
add note that the following diagram is just an example for illustration purposes (to avoid confusion that these are all expected to be components in the final product)
|
|
||
| **Usage Patterns**: | ||
|
|
||
| - **Sensor Manager**: Uses I2C **master** operations directly to read sensors, configure devices |
There was a problem hiding this comment.
Eliminate all uses of Master/Slave terminology. Instead use HostController, HC, Controller, etc and TargetDevice or Device
| @@ -0,0 +1,744 @@ | |||
| # I2C IPC Protocol Extensions for MCTP Support | |||
There was a problem hiding this comment.
the title here is good but please rename the file to make it more clear that this related to MCTP. Otherwise I could see this documentation easily being overlooked in the context of MCTP
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.
Enables peer-to-peer management protocols while maintaining clean separation between transport (I2C server) and protocol (MCTP driver) layers.