Migrate Camera to a move based API (esp-rs#2242)

* Migrate Camera to a move based API * update * update * ManuallyDrop * Add default channel to transfer struct --------- Co-authored-by: Dominic Fischer <[email protected]>
Dominaezzz · Oct 2, 2024 · 30aef58 · 30aef58
1 parent 8789ca3
commit 30aef58
Show file tree

Hide file tree

Showing 5 changed files with 664 additions and 127 deletions.
diff --git a/esp-hal/CHANGELOG.md b/esp-hal/CHANGELOG.md
@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - TWAI support for ESP32-H2 (#2199)
 - Make `DmaDescriptor` methods public (#2237)
 - Added a way to configure watchdogs in `esp_hal::init` (#2180)
+- Introduce `DmaRxStreamBuf` (#2242)
 - Implement `embedded_hal_async::delay::DelayNs` for `TIMGx` timers (#2084)
 - Added `Efuse::read_bit` (#2259)
 
@@ -56,6 +57,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The `NO_PIN` constant has been removed. (#2133)
 - MSRV bump to 1.79 (#2156)
 - Allow handling interrupts while trying to lock critical section on multi-core chips. (#2197)
+- Migrate `Camera` to a move based API (#2242).
 - Removed the PS-RAM related features, replaced by `quad-psram`/`octal-psram`, `init_psram` takes a configuration parameter, it's now possible to auto-detect PS-RAM size (#2178)
 - `EspTwaiFrame` constructors now accept any type that converts into `esp_hal::twai::Id` (#2207)
 - Change `DmaTxBuf` to support PSRAM on `esp32s3` (#2161)

diff --git a/esp-hal/MIGRATING-0.20.md b/esp-hal/MIGRATING-0.20.md
@@ -227,6 +227,49 @@ We've replaced some usage of features with [esp-config](https://docs.rs/esp-conf
 + ESP_HAL_PLACE_SPI_DRIVER_IN_RAM=true
 ```
 
+## `Camera` driver now uses `DmaRxBuffer` and moves the driver into the transfer object.
+
+For one shot transfers.
+```diff
+let (rx_buffer, rx_descriptors, _, _) = dma_buffers!(32678, 0);
++ let dma_buf = DmaRxBuf::new(rx_descriptors, rx_buffer).unwrap();
+
+let lcd_cam = LcdCam::new(peripherals.LCD_CAM);
+let mut camera = Camera::new(
+     lcd_cam.cam,
+     channel.rx,
+-    rx_descriptors,
+     data_pins,
+     20u32.MHz(),
+);
+
+- let transfer = camera.read_dma(rx_buffer).unwrap();
+- transfer.wait();
++ let transfer = camera.receive(dma_buf).unwrap();
++ let (_, camera, buf) = transfer.wait();
+```
+
+For circular transfers.
+```diff
+- let (rx_buffer, rx_descriptors, _, _) = dma_buffers!(32678, 0);
++ let dma_buf = dma_rx_stream_buffer!(32678);
+
+let lcd_cam = LcdCam::new(peripherals.LCD_CAM);
+let mut camera = Camera::new(
+     lcd_cam.cam,
+     channel.rx,
+-    rx_descriptors,
+     data_pins,
+     20u32.MHz(),
+);
+
+- let mut transfer = camera.read_dma_circular(rx_buffer).unwrap();
++ let mut transfer = camera.receive(dma_buf).unwrap();
+transfer.pop(&mut [.....]);
+transfer.pop(&mut [.....]);
+transfer.pop(&mut [.....]);
+```
+
 ## PS-RAM
 
 Initializing PS-RAM now takes a chip specific config and returns start of the mapped memory and the size.