From d2f4a9bf8df8de9f51b29659b464b4509af47dc6 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Tue, 19 Jul 2022 07:57:39 +0200 Subject: embassy-embedded-hal: docs --- embassy-embedded-hal/src/shared_bus/mod.rs | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'embassy-embedded-hal/src/shared_bus/mod.rs') diff --git a/embassy-embedded-hal/src/shared_bus/mod.rs b/embassy-embedded-hal/src/shared_bus/mod.rs index 3cd380f72..76ee413d9 100644 --- a/embassy-embedded-hal/src/shared_bus/mod.rs +++ b/embassy-embedded-hal/src/shared_bus/mod.rs @@ -8,8 +8,10 @@ pub mod asynch; pub mod blocking; +/// Error returned by I2C device implementations in this crate. #[derive(Copy, Clone, Eq, PartialEq, Debug)] pub enum I2cDeviceError { + /// An operation on the inner I2C bus failed. I2c(BUS), } @@ -24,9 +26,12 @@ where } } +/// Error returned by SPI device implementations in this crate. #[derive(Copy, Clone, Eq, PartialEq, Debug)] pub enum SpiDeviceError { + /// An operation on the inner SPI bus failed. Spi(BUS), + /// Setting the value of the Chip Select (CS) pin failed. Cs(CS), } -- cgit