diff --git a/documentation/API-GUIDELINES.md b/documentation/API-GUIDELINES.md index ca4b86566c..28c41026d8 100644 --- a/documentation/API-GUIDELINES.md +++ b/documentation/API-GUIDELINES.md @@ -82,6 +82,7 @@ In general, the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines - This helps us reducing the need of introducing breaking changes if we implement additional functionalities. - Avoid abbreviations and contractions in the API, where possible. - Saving a few characters may introduce ambiguity, e.g `SpiTransDone`, is it `Transmit` or `Transfer`? + - Common abbreviations, that are well understood such as `Dma` are perfectly fine. ## Maintainability diff --git a/esp-hal/CHANGELOG.md b/esp-hal/CHANGELOG.md index 053097ab51..0de0a82412 100644 --- a/esp-hal/CHANGELOG.md +++ b/esp-hal/CHANGELOG.md @@ -73,6 +73,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Updated `esp-pacs` with support for Wi-Fi on the ESP32 and made the peripheral non virtual - `SpiBitOrder`, `SpiDataMode`, `SpiMode` were renamed to `BitOder`, `DataMode` and `Mode` (#2828) - `crate::Mode` was renamed to `crate::DriverMode` (#2828) +- Renamed some I2C error variants (#2844) + ### Fixed - Xtensa devices now correctly enable the `esp-hal-procmacros/rtc-slow` feature (#2594) diff --git a/esp-hal/MIGRATING-0.22.md b/esp-hal/MIGRATING-0.22.md index b129771528..1d729671b8 100644 --- a/esp-hal/MIGRATING-0.22.md +++ b/esp-hal/MIGRATING-0.22.md @@ -300,3 +300,16 @@ is not compatible with the hardware. - spi_dma.transfer(dma_rx_buf, dma_tx_buf); + spi_dma.transfer(5, dma_rx_buf, 5, dma_tx_buf); ``` + +## I2C Error changes + +To avoid abbreviations and contractions (as per the esp-hal guidelines), some error variants have changed + +```diff +- Error::ExecIncomplete ++ Error::ExecutionIncomplete +- Error::CommandNrExceeded ++ Error::CommandNumberExceeded +- Error::ExceedingFifo ++ Error::FifoExceeded +``` diff --git a/esp-hal/src/i2c/master/mod.rs b/esp-hal/src/i2c/master/mod.rs index 6427dd8eef..fc637ffba6 100644 --- a/esp-hal/src/i2c/master/mod.rs +++ b/esp-hal/src/i2c/master/mod.rs @@ -91,7 +91,7 @@ const MAX_ITERATIONS: u32 = 1_000_000; #[non_exhaustive] pub enum Error { /// The transmission exceeded the FIFO size. - ExceedingFifo, + FifoExceeded, /// The acknowledgment check failed. AckCheckFailed, /// A timeout occurred during transmission. @@ -101,7 +101,7 @@ pub enum Error { /// The execution of the I2C command was incomplete. ExecutionIncomplete, /// The number of commands issued exceeded the limit. - CommandNrExceeded, + CommandNumberExceeded, /// Zero length read or write operation. InvalidZeroLength, } @@ -111,7 +111,7 @@ impl core::error::Error for Error {} impl core::fmt::Display for Error { fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { match self { - Error::ExceedingFifo => write!(f, "The transmission exceeded the FIFO size"), + Error::FifoExceeded => write!(f, "The transmission exceeded the FIFO size"), Error::AckCheckFailed => write!(f, "The acknowledgment check failed"), Error::TimeOut => write!(f, "A timeout occurred during transmission"), Error::ArbitrationLost => write!(f, "The arbitration for the bus was lost"), @@ -204,7 +204,7 @@ impl embedded_hal::i2c::Error for Error { use embedded_hal::i2c::{ErrorKind, NoAcknowledgeSource}; match self { - Self::ExceedingFifo => ErrorKind::Overrun, + Self::FifoExceeded => ErrorKind::Overrun, Self::ArbitrationLost => ErrorKind::ArbitrationLoss, Self::AckCheckFailed => ErrorKind::NoAcknowledge(NoAcknowledgeSource::Unknown), _ => ErrorKind::Other, @@ -1337,7 +1337,7 @@ impl Driver<'_> { let max_len = if start { 254usize } else { 255usize }; if bytes.len() > max_len { // we could support more by adding multiple write operations - return Err(Error::ExceedingFifo); + return Err(Error::FifoExceeded); } let write_len = if start { bytes.len() + 1 } else { bytes.len() }; @@ -1395,7 +1395,7 @@ impl Driver<'_> { }; if buffer.len() > max_len { // we could support more by adding multiple read operations - return Err(Error::ExceedingFifo); + return Err(Error::FifoExceeded); } if start {