Merge pull request #43 from bugadani/eh1

bugadani · web-flow · commit b7eb1d0fe4bd · 2024-01-12T07:35:02.000+01:00
Prepare changes for embedded-hal 1.0 release
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,7 +29,3 @@ jobs:
         with:
           command: build
           args: --package display-interface-parallel-gpio
-      - uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --workspace --features=async
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,16 +9,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Added
 
-- Updated to embedded-hal 1.0.0-rc.1 and embedded-hal-async 1.0.0-rc.1
-- New `AsyncWriteOnlyDataCommand` trait. Available after enabling the `async` feature.
-- i2c, spi: `async/await` support via the `async` feature.
+- Updated to embedded-hal 1.0.0 and embedded-hal-async 1.0.0
+- New `AsyncWriteOnlyDataCommand` trait.
+- i2c, spi: `async/await` support.
 - parallel-gpio: Added `Generic16BitBus`
 - parallel-gpio: Added `PGPIO16BitInterface`
+- added `defmt-03` feature
 
 ## Changed
 
-- spi: `SPIInterface` now wraps objects that implement the `SpiDeviceWrite` trait from embedded-hal 1.0.0-alpha.10.
-- spi: `SPIInterface` now wraps objects that implement the `SpiDeviceWrite` trait from embedded-hal-async 0.2.0-alpha.1.
+- **Breaking** raised MSRV to 1.75
+- spi: `SPIInterface` now wraps objects that implement the `SpiDeviceWrite` trait from embedded-hal 1.0.0
+- spi: `SPIInterface` now wraps objects that implement the `SpiDeviceWrite` trait from embedded-hal-async 1.0.0
 - parallel-gpio: Fixed bug with fallible pins
 - **Breaking** parallel-gpio: `GenericxBitBus::new` is now infallible
 
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "display-interface"
 description = "Traits for interfaces used to drive displays"
-version = "0.5.0-alpha.1"
+version = "0.5.0"
 authors = ["Daniel Egger <daniel@eggers-club.de>"]
 repository = "https://github.com/therealprof/display-interface"
 documentation = "https://docs.rs/display-interface"
@@ -12,13 +12,13 @@ license = "MIT OR Apache-2.0"
 exclude = [
     ".gitignore",
 ]
-edition = "2018"
+edition = "2021"
+rust-version = "1.75"
 
 [package.metadata.docs.rs]
 all-features = true
 
 [dependencies]
-async-trait = { version = "0.1.68", optional = true }
 defmt = { version = "0.3", optional = true }
 
 [workspace]
@@ -31,6 +31,4 @@ members = [
 
 [features]
 default = []
-async = ["async-trait"]
-defmt = ["dep:defmt"]
-nightly = []
+defmt-03 = ["dep:defmt"]
diff --git a/README.md b/README.md
@@ -9,12 +9,7 @@ code duplication and missing implementations.
 
 Additional features can be enabled by adding the following features to your Cargo.toml.
 
- - `async`: enables `AsyncWriteOnlyDataCommand`. This feature uses `#[async_trait]` and can be
-   used with rustc 1.56 and newer. Using this feature requires allocator support.
- - `nightly`: Enables support for nightly-only, unstable features. Together with `async`, this will
-   enable the `async_fn_in_trait` and `impl_trait_projections` unstable features,
-   and removes the `#[async_trait]` workaround as well as the allocator requirement.
-   This feature requires a nightly Rust compiler released on or after 2022-11-17.
+ - `defmt-03`: implements `defmt::Format` for `DisplayError`.
 
 ## License
 
diff --git a/i2c/Cargo.toml b/i2c/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "display-interface-i2c"
 description = "Generic I2C implementation for display interfaces"
-version = "0.5.0-alpha.1"
+version = "0.5.0"
 authors = ["Daniel Egger <daniel@eggers-club.de>"]
 repository = "https://github.com/therealprof/display-interface"
 documentation = "https://docs.rs/display-interface-i2c"
@@ -10,18 +10,13 @@ keywords = ["graphics", "display", "embedded"]
 readme = "README.md"
 license = "MIT OR Apache-2.0"
 exclude = [".gitignore"]
-edition = "2018"
+edition = "2021"
+rust-version = "1.75"
 
 [package.metadata.docs.rs]
 all-features = true
 
 [dependencies]
-async-trait = { version = "0.1.68", optional = true }
-embedded-hal = "1.0.0-rc.1"
-embedded-hal-async = { version = "1.0.0-rc.1", optional = true }
-display-interface = { version = "0.5.0-alpha.1", path = ".." }
-
-[features]
-default = []
-async = ["async-trait", "embedded-hal-async", "display-interface/async"]
-nightly = ["display-interface/nightly"]
+embedded-hal = "1.0.0"
+embedded-hal-async = "1.0.0"
+display-interface = { version = "0.5.0", path = ".." }
diff --git a/i2c/README.md b/i2c/README.md
@@ -1,19 +1,8 @@
 # I2C interface for display interface
 
 This Rust crate contains a generic I2C implementation of a data/command
-interface for displays over any I2C driver implementing the `embedded-hal`
-`blocking::I2C::Write` trait.
-
-## Crate features
-
-Additional features can be enabled by adding the following features to your Cargo.toml.
-
- - `async`: enables `AsyncWriteOnlyDataCommand`. This feature uses `#[async_trait]` and can be
-   used with rustc 1.56 and newer. Using this feature requires allocator support.
- - `nightly`: Enables support for nightly-only, unstable features. Together with `async`, this will
-   enable the `async_fn_in_trait` and `impl_trait_projections` unstable features,
-   and removes the `#[async_trait]` workaround as well as the allocator requirement.
-   This feature requires a nightly Rust compiler released on or after 2022-11-17.
+interface for displays over any I2C driver implementing the `embedded-hal`/`embedded-hal-async`
+`i2c::I2c` trait(s).
 
 ## License
 
diff --git a/i2c/src/asynch.rs b/i2c/src/asynch.rs
@@ -2,10 +2,6 @@ use display_interface::{AsyncWriteOnlyDataCommand, DataFormat, DisplayError};
 
 use crate::I2CInterface;
 
-#[cfg(not(feature = "nightly"))]
-use alloc::boxed::Box;
-
-#[cfg_attr(not(feature = "nightly"), async_trait::async_trait(?Send))]
 impl<I2C> AsyncWriteOnlyDataCommand for I2CInterface<I2C>
 where
     I2C: embedded_hal_async::i2c::I2c,
diff --git a/i2c/src/lib.rs b/i2c/src/lib.rs
@@ -1,17 +1,8 @@
-#![no_std]
-#![cfg_attr(
-    all(feature = "async", feature = "nightly"),
-    allow(incomplete_features, unknown_lints, stable_features, async_fn_in_trait),
-    feature(async_fn_in_trait, impl_trait_projections)
-)]
-
 //! Generic I2C interface for display drivers
 
-#[cfg(all(feature = "async", not(feature = "nightly")))]
-extern crate alloc;
+#![no_std]
 
-#[cfg(feature = "async")]
-pub mod asynch;
+mod asynch;
 
 use display_interface::{DataFormat, DisplayError, WriteOnlyDataCommand};
 
@@ -22,10 +13,7 @@ pub struct I2CInterface<I2C> {
     data_byte: u8,
 }
 
-impl<I2C> I2CInterface<I2C>
-where
-    I2C: embedded_hal::i2c::I2c,
-{
+impl<I2C> I2CInterface<I2C> {
     /// Create new I2C interface for communication with a display driver
     pub fn new(i2c: I2C, addr: u8, data_byte: u8) -> Self {
         Self {
@@ -36,7 +24,7 @@ where
     }
 
     /// Consume the display interface and return
-    /// the underlying peripherial driver
+    /// the underlying peripheral driver
     pub fn release(self) -> I2C {
         self.i2c
     }
diff --git a/parallel-gpio/Cargo.toml b/parallel-gpio/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "display-interface-parallel-gpio"
 description = "Generic parallel GPIO interface for display interfaces"
-version = "0.7.0-alpha.1"
+version = "0.7.0"
 authors = ["Daniel Egger <daniel@eggers-club.de>"]
 repository = "https://github.com/therealprof/display-interface"
 documentation = "https://docs.rs/display-interface-parallel-gpio"
@@ -10,11 +10,12 @@ keywords = ["graphics", "display", "embedded"]
 readme = "README.md"
 license = "MIT OR Apache-2.0"
 exclude = [".gitignore"]
-edition = "2018"
+edition = "2021"
+rust-version = "1.75"
 
 [package.metadata.docs.rs]
 all-features = true
 
 [dependencies]
-embedded-hal = "1.0.0-rc.1"
-display-interface = { version = "0.5.0-alpha.1", path = ".." }
+embedded-hal = "1.0.0"
+display-interface = { version = "0.5.0", path = ".." }
diff --git a/parallel-gpio/README.md b/parallel-gpio/README.md
@@ -2,7 +2,7 @@
 
 This Rust crate contains a generic parallel implementation of a data/command
 interface for displays over any GPIO driver implementing the `embedded-hal`
-`digital::v2::OutputPin` trait.
+`digital::OutputPin` trait.
 
 ## License
 
diff --git a/parallel-gpio/src/lib.rs b/parallel-gpio/src/lib.rs
@@ -1,6 +1,5 @@
-#![no_std]
-
 //! Generic parallel GPIO interface for display drivers
+#![no_std]
 
 use embedded_hal::digital::OutputPin;
 
diff --git a/spi/Cargo.toml b/spi/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "display-interface-spi"
 description = "Generic SPI implementation for display interfaces"
-version = "0.5.0-alpha.1"
+version = "0.5.0"
 authors = ["Daniel Egger <daniel@eggers-club.de>"]
 repository = "https://github.com/therealprof/display-interface"
 documentation = "https://docs.rs/display-interface-spi"
@@ -10,19 +10,14 @@ keywords = ["graphics", "display", "embedded"]
 readme = "README.md"
 license = "MIT OR Apache-2.0"
 exclude = [".gitignore"]
-edition = "2018"
+edition = "2021"
+rust-version = "1.75"
 
 [package.metadata.docs.rs]
 all-features = true
 
 [dependencies]
-async-trait = { version = "0.1.68", optional = true }
-embedded-hal = "1.0.0-rc.1"
-embedded-hal-async = { version = "1.0.0-rc.1", optional = true }
-display-interface = { version = "0.5.0-alpha.1", path = ".." }
+embedded-hal = "1.0.0"
+embedded-hal-async = "1.0.0"
+display-interface = { version = "0.5.0", path = ".." }
 byte-slice-cast = { version = "1.2.2", default-features = false }
-
-[features]
-default = []
-async = ["async-trait", "embedded-hal-async", "display-interface/async"]
-nightly = ["display-interface/nightly"]
diff --git a/spi/README.md b/spi/README.md
@@ -1,19 +1,8 @@
 # SPI interface for display interface
 
 This Rust crate contains a generic SPI implementation of a data/command
-interface for displays over any SPI driver implementing the `embedded-hal`
-`spi::SpiDeviceWrite<u8>` trait.
-
-## Crate features
-
-Additional features can be enabled by adding the following features to your Cargo.toml.
-
- - `async`: enables `AsyncWriteOnlyDataCommand`. This feature uses `#[async_trait]` and can be
-   used with rustc 1.56 and newer. Using this feature requires allocator support.
- - `nightly`: Enables support for nightly-only, unstable features. Together with `async`, this will
-   enable the `async_fn_in_trait` and `impl_trait_projections` unstable features,
-   and removes the `#[async_trait]` workaround as well as the allocator requirement.
-   This feature requires a nightly Rust compiler released on or after 2022-11-17.
+interface for displays over any SPI driver implementing the `embedded-hal`/`embedded-hal-async`
+`SpiDevice` trait(s).
 
 ## License
 
diff --git a/spi/src/asynch.rs b/spi/src/asynch.rs
@@ -6,7 +6,7 @@ use embedded_hal_async::spi::SpiDevice;
 
 use display_interface::{AsyncWriteOnlyDataCommand, DataFormat, DisplayError};
 
-use crate::SPIInterface;
+use crate::{SPIInterface, BUFFER_SIZE};
 
 type Result = core::result::Result<(), DisplayError>;
 
@@ -40,7 +40,7 @@ where
                 .map_err(|_| DisplayError::BusWriteError)
         }
         DataFormat::U8Iter(iter) => {
-            let mut buf = [0; 32];
+            let mut buf = [0; BUFFER_SIZE];
             let mut i = 0;
 
             for v in iter.into_iter() {
@@ -64,7 +64,7 @@ where
             Ok(())
         }
         DataFormat::U16LEIter(iter) => {
-            let mut buf = [0; 32];
+            let mut buf = [0; BUFFER_SIZE];
             let mut i = 0;
 
             for v in iter.map(u16::to_le) {
@@ -88,7 +88,7 @@ where
             Ok(())
         }
         DataFormat::U16BEIter(iter) => {
-            let mut buf = [0; 64];
+            let mut buf = [0; BUFFER_SIZE];
             let mut i = 0;
             let len = buf.len();
 
@@ -116,10 +116,6 @@ where
     }
 }
 
-#[cfg(not(feature = "nightly"))]
-use alloc::boxed::Box;
-
-#[cfg_attr(not(feature = "nightly"), async_trait::async_trait(?Send))]
 impl<SPI, DC> AsyncWriteOnlyDataCommand for SPIInterface<SPI, DC>
 where
     SPI: SpiDevice,
diff --git a/spi/src/lib.rs b/spi/src/lib.rs
@@ -1,24 +1,17 @@
-#![no_std]
-#![cfg_attr(
-    all(feature = "async", feature = "nightly"),
-    allow(incomplete_features, unknown_lints, stable_features, async_fn_in_trait),
-    feature(async_fn_in_trait, impl_trait_projections)
-)]
-
 //! Generic SPI interface for display drivers
 
-#[cfg(all(feature = "async", not(feature = "nightly")))]
-extern crate alloc;
+#![no_std]
 
-#[cfg(feature = "async")]
-pub mod asynch;
+mod asynch;
 
 use byte_slice_cast::*;
 use display_interface::{DataFormat, DisplayError, WriteOnlyDataCommand};
 use embedded_hal::{digital::OutputPin, spi::SpiDevice};
 
 type Result = core::result::Result<(), DisplayError>;
 
+pub(crate) const BUFFER_SIZE: usize = 64;
+
 fn send_u8<SPI>(spi: &mut SPI, words: DataFormat<'_>) -> Result
 where
     SPI: SpiDevice,
@@ -43,7 +36,7 @@ where
                 .map_err(|_| DisplayError::BusWriteError)
         }
         DataFormat::U8Iter(iter) => {
-            let mut buf = [0; 32];
+            let mut buf = [0; BUFFER_SIZE];
             let mut i = 0;
 
             for v in iter.into_iter() {
@@ -64,7 +57,7 @@ where
             Ok(())
         }
         DataFormat::U16LEIter(iter) => {
-            let mut buf = [0; 32];
+            let mut buf = [0; BUFFER_SIZE];
             let mut i = 0;
 
             for v in iter.map(u16::to_le) {
@@ -86,7 +79,7 @@ where
             Ok(())
         }
         DataFormat::U16BEIter(iter) => {
-            let mut buf = [0; 64];
+            let mut buf = [0; BUFFER_SIZE];
             let mut i = 0;
             let len = buf.len();
 
@@ -127,7 +120,7 @@ impl<SPI, DC> SPIInterface<SPI, DC> {
     }
 
     /// Consume the display interface and return
-    /// the underlying peripherial driver and GPIO pins used by it
+    /// the underlying peripheral driver and GPIO pins used by it
     pub fn release(self) -> (SPI, DC) {
         (self.spi, self.dc)
     }
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/src/prelude.rs b/src/prelude.rs
