updates

Author: playfulFence

esp-hal/src/lcd_cam/cam.rs

@@ -168,10 +168,11 @@ impl<'d> Camera<'d> {
     }
 
     /// Applies the configuration to the camera interface.
-    /// 
+    ///
     /// # Errors
     ///
-    /// A [`ConfigError`] variant will be returned if the frequency passed in `Config` is too low.
+    /// A [`ConfigError`] variant will be returned if the frequency passed in
+    /// `Config` is too low.
     pub fn apply_config(&mut self, config: &Config) -> Result<(), ConfigError> {
         let clocks = Clocks::get();
         let (i, divider) = calculate_clkm(

esp-hal/src/lcd_cam/lcd/dpi.rs

@@ -170,10 +170,11 @@ where
     }
 
     /// Applies the configuration to the peripheral.
-    /// 
+    ///
     /// # Errors
     ///
-    /// A [`ConfigError`] variant will be returned if the frequency passed in `Config` is too low.
+    /// A [`ConfigError`] variant will be returned if the frequency passed in
+    /// `Config` is too low.
     pub fn apply_config(&mut self, config: &Config) -> Result<(), ConfigError> {
         let clocks = Clocks::get();
         // Due to https://www.espressif.com/sites/default/files/documentation/esp32-s3_errata_en.pdf

esp-hal/src/lcd_cam/lcd/i8080.rs

@@ -135,10 +135,11 @@ where
     }
 
     /// Applies configuration.
-    /// 
+    ///
     /// # Errors
     ///
-    /// A [`ConfigError`] variant will be returned if the frequency passed in `Config` is too low.
+    /// A [`ConfigError`] variant will be returned if the frequency passed in
+    /// `Config` is too low.
     pub fn apply_config(&mut self, config: &Config) -> Result<(), ConfigError> {
         let clocks = Clocks::get();
         // Due to https://www.espressif.com/sites/default/files/documentation/esp32-s3_errata_en.pdf

esp-hal/src/spi/master.rs

@@ -596,6 +596,14 @@ impl Config {
     fn raw_clock_reg_value(&self) -> Result<u32, ConfigError> {
         self.reg
     }
+
+    fn validate(&self) -> Result<(), ConfigError> {
+        // Max supported frequency is 80Mhz
+        if self.frequency > HertzU32::MHz(80) {
+            return Err(ConfigError::UnsupportedFrequency);
+        }
+        Ok(())
+    }
 }
 
 #[derive(Debug)]
@@ -613,7 +621,22 @@ struct SpiPinGuard {
 #[non_exhaustive]
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-pub enum ConfigError {}
+pub enum ConfigError {
+    /// The requested frequency is not supported.
+    UnsupportedFrequency,
+}
+
+impl core::error::Error for ConfigError {}
+
+impl core::fmt::Display for ConfigError {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        match self {
+            ConfigError::UnsupportedFrequency => {
+                write!(f, " The requested frequency is not supported")
+            }
+        }
+    }
+}
 
 /// SPI peripheral driver
 ///
@@ -994,6 +1017,10 @@ where
     }
 
     /// Change the bus configuration.
+    ///
+    /// # Errors.
+    /// If frequency passed in config exceeds 80Mhz, a corresponding
+    /// [`ConfigError`] variant will be returned.
     pub fn apply_config(&mut self, config: &Config) -> Result<(), ConfigError> {
         self.driver().apply_config(config)
     }
@@ -1565,6 +1592,10 @@ mod dma {
         }
 
         /// Change the bus configuration.
+        ///
+        /// # Errors.
+        /// If frequency passed in config exceeds 80Mhz, a corresponding
+        /// [`ConfigError`] variant will be returned.
         #[instability::unstable]
         pub fn apply_config(&mut self, config: &Config) -> Result<(), ConfigError> {
             self.driver().apply_config(config)
@@ -2027,6 +2058,10 @@ mod dma {
         }
 
         /// Change the bus configuration.
+        ///
+        /// # Errors.
+        /// If frequency passed in config exceeds 80Mhz, a corresponding
+        /// [`ConfigError`] variant will be returned.
         #[instability::unstable]
         pub fn apply_config(&mut self, config: &Config) -> Result<(), ConfigError> {
             self.spi_dma.apply_config(config)
@@ -3073,6 +3108,7 @@ impl Driver {
     }
 
     fn apply_config(&self, config: &Config) -> Result<(), ConfigError> {
+        config.validate()?;
         self.ch_bus_freq(config)?;
         self.set_bit_order(config.read_bit_order, config.write_bit_order);
         self.set_data_mode(config.mode);

esp-hal/src/uart.rs

@@ -349,6 +349,14 @@ impl Config {
         };
         length
     }
+
+    fn validate(&self) -> Result<(), ConfigError> {
+        // Max supported baud rate is 5Mbaud
+        if self.baudrate == 0 || self.baudrate > 5_000_000 {
+            return Err(ConfigError::UnsupportedBaudrate);
+        }
+        Ok(())
+    }
 }
 
 /// Configuration for the AT-CMD detection functionality
@@ -455,6 +463,8 @@ pub struct UartRx<'d, Dm> {
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 #[non_exhaustive]
 pub enum ConfigError {
+    /// The requested baud rate is not supported.
+    UnsupportedBaudrate,
     /// The requested timeout is not supported.
     UnsupportedTimeout,
     /// The requested FIFO threshold is not supported.
@@ -466,6 +476,9 @@ impl core::error::Error for ConfigError {}
 impl core::fmt::Display for ConfigError {
     fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
         match self {
+            ConfigError::UnsupportedBaudrate => {
+                write!(f, "The requested baud rate is not supported")
+            }
             ConfigError::UnsupportedTimeout => write!(f, "The requested timeout is not supported"),
             ConfigError::UnsupportedFifoThreshold => {
                 write!(f, "The requested FIFO threshold is not supported")
@@ -1178,7 +1191,8 @@ where
     ///
     /// # Errors.
     /// Errors will be returned in the cases described in
-    /// [`UartRx::apply_config`].
+    /// [`UartRx::apply_config`] and if baud rate passed in config exceeds
+    /// 5MBaud or is equal to zero.
     pub fn apply_config(&mut self, config: &Config) -> Result<(), ConfigError> {
         self.rx.apply_config(config)?;
         self.tx.apply_config(config)?;
@@ -2190,6 +2204,7 @@ impl Info {
     }
 
     fn apply_config(&self, config: &Config) -> Result<(), ConfigError> {
+        config.validate()?;
         self.change_baud(config);
         self.change_data_bits(config.data_bits);
         self.change_parity(config.parity);