Skip to content

transceiver-messages: adds HwError::I2cTransactionTimeout #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Aaron-Hartwig merged 3 commits into from
Jan 20, 2026
Merged

transceiver-messages: adds HwError::I2cTransactionTimeout #431

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13bdbe4
adds HwError::I2cTransactionTimeout
Aaron-Hartwig Jan 16, 2026
d31c35b
feedback from Ben
Aaron-Hartwig Jan 20, 2026
03a159a
fmt
Aaron-Hartwig Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions messages/src/message.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,10 @@ pub mod version {
/// Addition to HwError: I2cSclStretchTimeout
pub const V5: u8 = 5;

pub const CURRENT: u8 = V5;
/// Addition to HwError: I2cTransactionTimeout
pub const V6: u8 = 6;

pub const CURRENT: u8 = V6;
pub const MIN: u8 = V1;
}
pub mod outer {
Expand Down Expand Up @@ -200,6 +203,16 @@ pub enum HwError {
/// CMIS 5.0 section B.2.7.3 but referred to as tRD.
#[cfg_attr(any(test, feature = "std"), error("The module stretched SCL too long"))]
I2cSclStretchTimeout,

/// An I2C transaction has gone on for too long.
///
/// While neither SFF-8636 or CMIS give guidance for transaction timeouts,
/// we are opting to use the SMBus t_timeout,min of 25ms to timeout.
#[cfg_attr(
any(test, feature = "std"),
error("The I2C transaction to the module timed out")
)]
I2cTransactionTimeout,
}

/// Deserialize the [`HwError`]s from a packet buffer that are expected, given
Expand Down Expand Up @@ -1069,7 +1082,7 @@ mod test {
#[test]
fn test_hardware_error_encoding_unchanged() {
let mut buf = [0u8; HwError::MAX_SIZE];
const TEST_DATA: [HwError; 13] = [
const TEST_DATA: [HwError; 14] = [
HwError::I2cError,
HwError::InvalidModuleIndex,
HwError::FpgaError,
Expand All @@ -1083,6 +1096,7 @@ mod test {
HwError::I2cAddressNack,
HwError::I2cByteNack,
HwError::I2cSclStretchTimeout,
HwError::I2cTransactionTimeout,
];

for (variant_id, variant) in TEST_DATA.iter().enumerate() {
Expand Down