RMT: Various cleanups, small API enhancements

esp-hal/CHANGELOG.md

@@ -8,14 +8,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- RMT: All public types now derive `Debug` and `defmt::Format`. (#4302)
+- RMT: `Channel::apply_config` has been added. (#4302)
 
 
 ### Changed
+- RMT: `SingleShotTxTransaction` has been renamed to `TxTransaction`. (#4302)
+- RMT: `ChannelCreator::configure_tx` and `ChannelCreator::configure_rx` now take the configuration by reference. (#4302)
+- RMT: `ChannelCreator::configure_tx` and `ChannelCreator::configure_rx` don't take a pin anymore, instead `Channel::with_pin` has been added. (#4302)
 
 
 ### Fixed
 
 - ESP32: ADC1 readings are no longer inverted (#4423)
+- RMT: All blocking methods now return the channel on failure. (#4302)
+- RMT: the `place_rmt_driver_in_ram` option now also places the async interrupt handler in RAM. (#4302)
+- RMT: When dropping a Tx channel, the driver now disconnects the output pin from the peripheral. (#4302)
 
 ### Removed
 
@@ -31,6 +39,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `work_queue` is no longer public (#4357)
 - UART memory is now powered down when the driver is no longer in use. (#4354)
 
+
 ### Removed
 
 - The `WatchdogConfig` enum and watchdog timer configuration from `esp_hal::init` (#4377)

esp-hal/MIGRATING-1.0.0.md

@@ -1 +1,63 @@
 # Migration Guide from 1.0.0 to {{currentVersion}}
+
+## RMT Changes
+
+`ChannelCreator::configure_tx` and `ChannelCreator::configure_rx` have changed in a few ways:
+- both methods now take the configuration by reference,
+- the pin argument has been removed in favor of `Channel::with_pin`, which is infallible and avoids consuming the pin on error.
+
+```diff
+ let tx_config = TxChannelConfig::default();
+ let rx_config = RxChannelConfig::default();
+
+ let tx = rmt.channel0
+-    .configure_tx(tx_pin, tx_config)
+-    .unwrap();
++    .configure_tx(&tx_config)
++    .unwrap()
++    .with_pin(tx_pin);
+
+ let rx = rmt.channel2
+-    .configure_rx(rx_pin, rx_config)
+-    .unwrap();
++    .configure_rx(&rx_config)
++    .unwrap()
++    .with_pin(rx_pin);
+```
+
+`SingleShotTxTransaction` has been renamed to `TxTransaction`:
+
+```diff
+-let txn: SingleShotTxTransaction<'_, '_, PulseCode> = tx_channel.transmit(&data)?;
++let txn: TxTransaction<'_, '_, PulseCode> = tx_channel.transmit(&data)?;
+```
+
+Some blocking `Channel` methods that previously consumed the channel on error now return it in all cases:
+
+```diff
+ let mut channel = todo!("set up tx channel");
+
+ channel = match tx_channel.transmit(&data) {
+     Ok(txn) => {
+         match txn.wait() {
+             Ok(c) => c,
+             Err((e, c)) => {
+                 // TODO: Handle the error
+                 c
+             }
+         }
+     }
+-    Err(e) => {
+-        // Channel cannot be re-used here (if it had the 'static lifetime)
+-        panic!();
++    Err((e, c)) => {
++        // TODO: Handle the error
++        c
+     }
+ }
+```
+
+This applies to
+- `Channel<'_, Blocking, Tx>::transmit`,
+- `Channel<'_, Blocking, Tx>::transmit_continuously`,
+- `Channel<'_, Blocking, Rx>::receive`.