diff options
Diffstat (limited to 'embassy-embedded-hal/src/adapter')
| -rw-r--r-- | embassy-embedded-hal/src/adapter/blocking_async.rs | 173 | ||||
| -rw-r--r-- | embassy-embedded-hal/src/adapter/mod.rs | 5 | ||||
| -rw-r--r-- | embassy-embedded-hal/src/adapter/yielding_async.rs | 232 |
3 files changed, 410 insertions, 0 deletions
diff --git a/embassy-embedded-hal/src/adapter/blocking_async.rs b/embassy-embedded-hal/src/adapter/blocking_async.rs new file mode 100644 index 000000000..171ff6c9f --- /dev/null +++ b/embassy-embedded-hal/src/adapter/blocking_async.rs | |||
| @@ -0,0 +1,173 @@ | |||
| 1 | //! Adapters between embedded-hal traits. | ||
| 2 | |||
| 3 | use embedded_hal_02::{blocking, serial}; | ||
| 4 | |||
| 5 | /// Wrapper that implements async traits using blocking implementations. | ||
| 6 | /// | ||
| 7 | /// This allows driver writers to depend on the async traits while still supporting embedded-hal peripheral implementations. | ||
| 8 | /// | ||
| 9 | /// BlockingAsync will implement any async trait that maps to embedded-hal traits implemented for the wrapped driver. | ||
| 10 | /// | ||
| 11 | /// Driver users are then free to choose which implementation that is available to them. | ||
| 12 | pub struct BlockingAsync<T> { | ||
| 13 | wrapped: T, | ||
| 14 | } | ||
| 15 | |||
| 16 | impl<T> BlockingAsync<T> { | ||
| 17 | /// Create a new instance of a wrapper for a given peripheral. | ||
| 18 | pub fn new(wrapped: T) -> Self { | ||
| 19 | Self { wrapped } | ||
| 20 | } | ||
| 21 | } | ||
| 22 | |||
| 23 | // | ||
| 24 | // I2C implementations | ||
| 25 | // | ||
| 26 | impl<T, E> embedded_hal_1::i2c::ErrorType for BlockingAsync<T> | ||
| 27 | where | ||
| 28 | E: embedded_hal_1::i2c::Error + 'static, | ||
| 29 | T: blocking::i2c::WriteRead<Error = E> + blocking::i2c::Read<Error = E> + blocking::i2c::Write<Error = E>, | ||
| 30 | { | ||
| 31 | type Error = E; | ||
| 32 | } | ||
| 33 | |||
| 34 | impl<T, E> embedded_hal_async::i2c::I2c for BlockingAsync<T> | ||
| 35 | where | ||
| 36 | E: embedded_hal_1::i2c::Error + 'static, | ||
| 37 | T: blocking::i2c::WriteRead<Error = E> + blocking::i2c::Read<Error = E> + blocking::i2c::Write<Error = E>, | ||
| 38 | { | ||
| 39 | async fn read(&mut self, address: u8, read: &mut [u8]) -> Result<(), Self::Error> { | ||
| 40 | self.wrapped.read(address, read) | ||
| 41 | } | ||
| 42 | |||
| 43 | async fn write(&mut self, address: u8, write: &[u8]) -> Result<(), Self::Error> { | ||
| 44 | self.wrapped.write(address, write) | ||
| 45 | } | ||
| 46 | |||
| 47 | async fn write_read(&mut self, address: u8, write: &[u8], read: &mut [u8]) -> Result<(), Self::Error> { | ||
| 48 | self.wrapped.write_read(address, write, read) | ||
| 49 | } | ||
| 50 | |||
| 51 | async fn transaction( | ||
| 52 | &mut self, | ||
| 53 | address: u8, | ||
| 54 | operations: &mut [embedded_hal_1::i2c::Operation<'_>], | ||
| 55 | ) -> Result<(), Self::Error> { | ||
| 56 | let _ = address; | ||
| 57 | let _ = operations; | ||
| 58 | todo!() | ||
| 59 | } | ||
| 60 | } | ||
| 61 | |||
| 62 | // | ||
| 63 | // SPI implementatinos | ||
| 64 | // | ||
| 65 | |||
| 66 | impl<T, E> embedded_hal_async::spi::ErrorType for BlockingAsync<T> | ||
| 67 | where | ||
| 68 | E: embedded_hal_1::spi::Error, | ||
| 69 | T: blocking::spi::Transfer<u8, Error = E> + blocking::spi::Write<u8, Error = E>, | ||
| 70 | { | ||
| 71 | type Error = E; | ||
| 72 | } | ||
| 73 | |||
| 74 | impl<T, E> embedded_hal_async::spi::SpiBus<u8> for BlockingAsync<T> | ||
| 75 | where | ||
| 76 | E: embedded_hal_1::spi::Error + 'static, | ||
| 77 | T: blocking::spi::Transfer<u8, Error = E> + blocking::spi::Write<u8, Error = E>, | ||
| 78 | { | ||
| 79 | async fn transfer<'a>(&'a mut self, read: &'a mut [u8], write: &'a [u8]) -> Result<(), Self::Error> { | ||
| 80 | // Ensure we write the expected bytes | ||
| 81 | for i in 0..core::cmp::min(read.len(), write.len()) { | ||
| 82 | read[i] = write[i].clone(); | ||
| 83 | } | ||
| 84 | self.wrapped.transfer(read)?; | ||
| 85 | Ok(()) | ||
| 86 | } | ||
| 87 | |||
| 88 | async fn transfer_in_place<'a>(&'a mut self, _: &'a mut [u8]) -> Result<(), Self::Error> { | ||
| 89 | todo!() | ||
| 90 | } | ||
| 91 | } | ||
| 92 | |||
| 93 | impl<T, E> embedded_hal_async::spi::SpiBusFlush for BlockingAsync<T> | ||
| 94 | where | ||
| 95 | E: embedded_hal_1::spi::Error + 'static, | ||
| 96 | T: blocking::spi::Transfer<u8, Error = E> + blocking::spi::Write<u8, Error = E>, | ||
| 97 | { | ||
| 98 | async fn flush(&mut self) -> Result<(), Self::Error> { | ||
| 99 | Ok(()) | ||
| 100 | } | ||
| 101 | } | ||
| 102 | |||
| 103 | impl<T, E> embedded_hal_async::spi::SpiBusWrite<u8> for BlockingAsync<T> | ||
| 104 | where | ||
| 105 | E: embedded_hal_1::spi::Error + 'static, | ||
| 106 | T: blocking::spi::Transfer<u8, Error = E> + blocking::spi::Write<u8, Error = E>, | ||
| 107 | { | ||
| 108 | async fn write(&mut self, data: &[u8]) -> Result<(), Self::Error> { | ||
| 109 | self.wrapped.write(data)?; | ||
| 110 | Ok(()) | ||
| 111 | } | ||
| 112 | } | ||
| 113 | |||
| 114 | impl<T, E> embedded_hal_async::spi::SpiBusRead<u8> for BlockingAsync<T> | ||
| 115 | where | ||
| 116 | E: embedded_hal_1::spi::Error + 'static, | ||
| 117 | T: blocking::spi::Transfer<u8, Error = E> + blocking::spi::Write<u8, Error = E>, | ||
| 118 | { | ||
| 119 | async fn read(&mut self, data: &mut [u8]) -> Result<(), Self::Error> { | ||
| 120 | self.wrapped.transfer(data)?; | ||
| 121 | Ok(()) | ||
| 122 | } | ||
| 123 | } | ||
| 124 | |||
| 125 | // Uart implementatinos | ||
| 126 | impl<T, E> embedded_hal_1::serial::ErrorType for BlockingAsync<T> | ||
| 127 | where | ||
| 128 | T: serial::Read<u8, Error = E>, | ||
| 129 | E: embedded_hal_1::serial::Error + 'static, | ||
| 130 | { | ||
| 131 | type Error = E; | ||
| 132 | } | ||
| 133 | |||
| 134 | /// NOR flash wrapper | ||
| 135 | use embedded_storage::nor_flash::{ErrorType, NorFlash, ReadNorFlash}; | ||
| 136 | use embedded_storage_async::nor_flash::{NorFlash as AsyncNorFlash, ReadNorFlash as AsyncReadNorFlash}; | ||
| 137 | |||
| 138 | impl<T> ErrorType for BlockingAsync<T> | ||
| 139 | where | ||
| 140 | T: ErrorType, | ||
| 141 | { | ||
| 142 | type Error = T::Error; | ||
| 143 | } | ||
| 144 | |||
| 145 | impl<T> AsyncNorFlash for BlockingAsync<T> | ||
| 146 | where | ||
| 147 | T: NorFlash, | ||
| 148 | { | ||
| 149 | const WRITE_SIZE: usize = <T as NorFlash>::WRITE_SIZE; | ||
| 150 | const ERASE_SIZE: usize = <T as NorFlash>::ERASE_SIZE; | ||
| 151 | |||
| 152 | async fn write(&mut self, offset: u32, data: &[u8]) -> Result<(), Self::Error> { | ||
| 153 | self.wrapped.write(offset, data) | ||
| 154 | } | ||
| 155 | |||
| 156 | async fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error> { | ||
| 157 | self.wrapped.erase(from, to) | ||
| 158 | } | ||
| 159 | } | ||
| 160 | |||
| 161 | impl<T> AsyncReadNorFlash for BlockingAsync<T> | ||
| 162 | where | ||
| 163 | T: ReadNorFlash, | ||
| 164 | { | ||
| 165 | const READ_SIZE: usize = <T as ReadNorFlash>::READ_SIZE; | ||
| 166 | async fn read(&mut self, address: u32, data: &mut [u8]) -> Result<(), Self::Error> { | ||
| 167 | self.wrapped.read(address, data) | ||
| 168 | } | ||
| 169 | |||
| 170 | fn capacity(&self) -> usize { | ||
| 171 | self.wrapped.capacity() | ||
| 172 | } | ||
| 173 | } | ||
diff --git a/embassy-embedded-hal/src/adapter/mod.rs b/embassy-embedded-hal/src/adapter/mod.rs new file mode 100644 index 000000000..787ac2979 --- /dev/null +++ b/embassy-embedded-hal/src/adapter/mod.rs | |||
| @@ -0,0 +1,5 @@ | |||
| 1 | mod blocking_async; | ||
| 2 | mod yielding_async; | ||
| 3 | |||
| 4 | pub use blocking_async::BlockingAsync; | ||
| 5 | pub use yielding_async::YieldingAsync; | ||
diff --git a/embassy-embedded-hal/src/adapter/yielding_async.rs b/embassy-embedded-hal/src/adapter/yielding_async.rs new file mode 100644 index 000000000..96d5cca8e --- /dev/null +++ b/embassy-embedded-hal/src/adapter/yielding_async.rs | |||
| @@ -0,0 +1,232 @@ | |||
| 1 | use embassy_futures::yield_now; | ||
| 2 | |||
| 3 | /// Wrapper that yields for each operation to the wrapped instance | ||
| 4 | /// | ||
| 5 | /// This can be used in combination with BlockingAsync<T> to enforce yields | ||
| 6 | /// between long running blocking operations. | ||
| 7 | pub struct YieldingAsync<T> { | ||
| 8 | wrapped: T, | ||
| 9 | } | ||
| 10 | |||
| 11 | impl<T> YieldingAsync<T> { | ||
| 12 | /// Create a new instance of a wrapper that yields after each operation. | ||
| 13 | pub fn new(wrapped: T) -> Self { | ||
| 14 | Self { wrapped } | ||
| 15 | } | ||
| 16 | } | ||
| 17 | |||
| 18 | // | ||
| 19 | // I2C implementations | ||
| 20 | // | ||
| 21 | impl<T> embedded_hal_1::i2c::ErrorType for YieldingAsync<T> | ||
| 22 | where | ||
| 23 | T: embedded_hal_1::i2c::ErrorType, | ||
| 24 | { | ||
| 25 | type Error = T::Error; | ||
| 26 | } | ||
| 27 | |||
| 28 | impl<T> embedded_hal_async::i2c::I2c for YieldingAsync<T> | ||
| 29 | where | ||
| 30 | T: embedded_hal_async::i2c::I2c, | ||
| 31 | { | ||
| 32 | async fn read(&mut self, address: u8, read: &mut [u8]) -> Result<(), Self::Error> { | ||
| 33 | self.wrapped.read(address, read).await?; | ||
| 34 | yield_now().await; | ||
| 35 | Ok(()) | ||
| 36 | } | ||
| 37 | |||
| 38 | async fn write(&mut self, address: u8, write: &[u8]) -> Result<(), Self::Error> { | ||
| 39 | self.wrapped.write(address, write).await?; | ||
| 40 | yield_now().await; | ||
| 41 | Ok(()) | ||
| 42 | } | ||
| 43 | |||
| 44 | async fn write_read(&mut self, address: u8, write: &[u8], read: &mut [u8]) -> Result<(), Self::Error> { | ||
| 45 | self.wrapped.write_read(address, write, read).await?; | ||
| 46 | yield_now().await; | ||
| 47 | Ok(()) | ||
| 48 | } | ||
| 49 | |||
| 50 | async fn transaction( | ||
| 51 | &mut self, | ||
| 52 | address: u8, | ||
| 53 | operations: &mut [embedded_hal_1::i2c::Operation<'_>], | ||
| 54 | ) -> Result<(), Self::Error> { | ||
| 55 | self.wrapped.transaction(address, operations).await?; | ||
| 56 | yield_now().await; | ||
| 57 | Ok(()) | ||
| 58 | } | ||
| 59 | } | ||
| 60 | |||
| 61 | // | ||
| 62 | // SPI implementations | ||
| 63 | // | ||
| 64 | |||
| 65 | impl<T> embedded_hal_async::spi::ErrorType for YieldingAsync<T> | ||
| 66 | where | ||
| 67 | T: embedded_hal_async::spi::ErrorType, | ||
| 68 | { | ||
| 69 | type Error = T::Error; | ||
| 70 | } | ||
| 71 | |||
| 72 | impl<T> embedded_hal_async::spi::SpiBus<u8> for YieldingAsync<T> | ||
| 73 | where | ||
| 74 | T: embedded_hal_async::spi::SpiBus, | ||
| 75 | { | ||
| 76 | async fn transfer<'a>(&'a mut self, read: &'a mut [u8], write: &'a [u8]) -> Result<(), Self::Error> { | ||
| 77 | self.wrapped.transfer(read, write).await?; | ||
| 78 | yield_now().await; | ||
| 79 | Ok(()) | ||
| 80 | } | ||
| 81 | |||
| 82 | async fn transfer_in_place<'a>(&'a mut self, words: &'a mut [u8]) -> Result<(), Self::Error> { | ||
| 83 | self.wrapped.transfer_in_place(words).await?; | ||
| 84 | yield_now().await; | ||
| 85 | Ok(()) | ||
| 86 | } | ||
| 87 | } | ||
| 88 | |||
| 89 | impl<T> embedded_hal_async::spi::SpiBusFlush for YieldingAsync<T> | ||
| 90 | where | ||
| 91 | T: embedded_hal_async::spi::SpiBusFlush, | ||
| 92 | { | ||
| 93 | async fn flush(&mut self) -> Result<(), Self::Error> { | ||
| 94 | self.wrapped.flush().await?; | ||
| 95 | yield_now().await; | ||
| 96 | Ok(()) | ||
| 97 | } | ||
| 98 | } | ||
| 99 | |||
| 100 | impl<T> embedded_hal_async::spi::SpiBusWrite<u8> for YieldingAsync<T> | ||
| 101 | where | ||
| 102 | T: embedded_hal_async::spi::SpiBusWrite<u8>, | ||
| 103 | { | ||
| 104 | async fn write(&mut self, data: &[u8]) -> Result<(), Self::Error> { | ||
| 105 | self.wrapped.write(data).await?; | ||
| 106 | yield_now().await; | ||
| 107 | Ok(()) | ||
| 108 | } | ||
| 109 | } | ||
| 110 | |||
| 111 | impl<T> embedded_hal_async::spi::SpiBusRead<u8> for YieldingAsync<T> | ||
| 112 | where | ||
| 113 | T: embedded_hal_async::spi::SpiBusRead<u8>, | ||
| 114 | { | ||
| 115 | async fn read(&mut self, data: &mut [u8]) -> Result<(), Self::Error> { | ||
| 116 | self.wrapped.read(data).await?; | ||
| 117 | yield_now().await; | ||
| 118 | Ok(()) | ||
| 119 | } | ||
| 120 | } | ||
| 121 | |||
| 122 | /// | ||
| 123 | /// NOR flash implementations | ||
| 124 | /// | ||
| 125 | impl<T: embedded_storage::nor_flash::ErrorType> embedded_storage::nor_flash::ErrorType for YieldingAsync<T> { | ||
| 126 | type Error = T::Error; | ||
| 127 | } | ||
| 128 | |||
| 129 | impl<T: embedded_storage_async::nor_flash::ReadNorFlash> embedded_storage_async::nor_flash::ReadNorFlash | ||
| 130 | for YieldingAsync<T> | ||
| 131 | { | ||
| 132 | const READ_SIZE: usize = T::READ_SIZE; | ||
| 133 | |||
| 134 | async fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> { | ||
| 135 | self.wrapped.read(offset, bytes).await?; | ||
| 136 | Ok(()) | ||
| 137 | } | ||
| 138 | |||
| 139 | fn capacity(&self) -> usize { | ||
| 140 | self.wrapped.capacity() | ||
| 141 | } | ||
| 142 | } | ||
| 143 | |||
| 144 | impl<T: embedded_storage_async::nor_flash::NorFlash> embedded_storage_async::nor_flash::NorFlash for YieldingAsync<T> { | ||
| 145 | const WRITE_SIZE: usize = T::WRITE_SIZE; | ||
| 146 | const ERASE_SIZE: usize = T::ERASE_SIZE; | ||
| 147 | |||
| 148 | async fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> { | ||
| 149 | self.wrapped.write(offset, bytes).await?; | ||
| 150 | yield_now().await; | ||
| 151 | Ok(()) | ||
| 152 | } | ||
| 153 | |||
| 154 | async fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error> { | ||
| 155 | // Yield between each actual erase | ||
| 156 | for from in (from..to).step_by(T::ERASE_SIZE) { | ||
| 157 | let to = core::cmp::min(from + T::ERASE_SIZE as u32, to); | ||
| 158 | self.wrapped.erase(from, to).await?; | ||
| 159 | yield_now().await; | ||
| 160 | } | ||
| 161 | Ok(()) | ||
| 162 | } | ||
| 163 | } | ||
| 164 | |||
| 165 | #[cfg(test)] | ||
| 166 | mod tests { | ||
| 167 | use embedded_storage_async::nor_flash::NorFlash; | ||
| 168 | |||
| 169 | use super::*; | ||
| 170 | |||
| 171 | extern crate std; | ||
| 172 | |||
| 173 | #[derive(Default)] | ||
| 174 | struct FakeFlash(Vec<(u32, u32)>); | ||
| 175 | |||
| 176 | impl embedded_storage::nor_flash::ErrorType for FakeFlash { | ||
| 177 | type Error = std::convert::Infallible; | ||
| 178 | } | ||
| 179 | |||
| 180 | impl embedded_storage_async::nor_flash::ReadNorFlash for FakeFlash { | ||
| 181 | const READ_SIZE: usize = 1; | ||
| 182 | |||
| 183 | async fn read(&mut self, _offset: u32, _bytes: &mut [u8]) -> Result<(), Self::Error> { | ||
| 184 | unimplemented!() | ||
| 185 | } | ||
| 186 | |||
| 187 | fn capacity(&self) -> usize { | ||
| 188 | unimplemented!() | ||
| 189 | } | ||
| 190 | } | ||
| 191 | |||
| 192 | impl embedded_storage_async::nor_flash::NorFlash for FakeFlash { | ||
| 193 | const WRITE_SIZE: usize = 4; | ||
| 194 | const ERASE_SIZE: usize = 128; | ||
| 195 | |||
| 196 | async fn write(&mut self, _offset: u32, _bytes: &[u8]) -> Result<(), Self::Error> { | ||
| 197 | unimplemented!() | ||
| 198 | } | ||
| 199 | |||
| 200 | async fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error> { | ||
| 201 | self.0.push((from, to)); | ||
| 202 | Ok(()) | ||
| 203 | } | ||
| 204 | } | ||
| 205 | |||
| 206 | #[futures_test::test] | ||
| 207 | async fn can_erase() { | ||
| 208 | let fake = FakeFlash::default(); | ||
| 209 | let mut yielding = YieldingAsync::new(fake); | ||
| 210 | |||
| 211 | yielding.erase(0, 256).await.unwrap(); | ||
| 212 | |||
| 213 | let fake = yielding.wrapped; | ||
| 214 | assert_eq!(2, fake.0.len()); | ||
| 215 | assert_eq!((0, 128), fake.0[0]); | ||
| 216 | assert_eq!((128, 256), fake.0[1]); | ||
| 217 | } | ||
| 218 | |||
| 219 | #[futures_test::test] | ||
| 220 | async fn can_erase_wrong_erase_size() { | ||
| 221 | let fake = FakeFlash::default(); | ||
| 222 | let mut yielding = YieldingAsync::new(fake); | ||
| 223 | |||
| 224 | yielding.erase(0, 257).await.unwrap(); | ||
| 225 | |||
| 226 | let fake = yielding.wrapped; | ||
| 227 | assert_eq!(3, fake.0.len()); | ||
| 228 | assert_eq!((0, 128), fake.0[0]); | ||
| 229 | assert_eq!((128, 256), fake.0[1]); | ||
| 230 | assert_eq!((256, 257), fake.0[2]); | ||
| 231 | } | ||
| 232 | } | ||
