Update README and HAL changelog

atsamd-rs · Sep 11, 2024 · 70698f8 · 70698f8
1 parent 906331c
commit 70698f8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -91,6 +91,11 @@ The Peripheral Access Crates (PACs) are automatically generated from Microchip S
 [wio_terminal]: https://github.com/atsamd-rs/atsamd/tree/master/boards/wio_terminal
 [xiao_m0]: https://github.com/atsamd-rs/atsamd/tree/master/boards/xiao_m0
 
+
+### `async` APIs
+
+[`atsamd_hal`](https://crates.io/crate/atsamd-hal) provides APIs for using `async`/`await` constructs with some of its peripherals. To enable `async` support, use the `async` Cargo feature. Detailed documentation is provided in the `atsamd_hal::async_hal` module.
+
 ### Examples
 
 The BSPs include examples to quickly get up and running with the board. Building the examples

diff --git a/hal/CHANGELOG.md b/hal/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Unreleased Changes
 
+- Add `async` APIs:
+  - Implemented: I2C, SPI, UART, EIC, timers, DMAC
+- *Breaking*: EIC API
+- *Breaking*: DMAC transfers no longer accept wakers. Use the async APIs instead.
+- *Deprecated*: `SpiFuture` will be removed in a following version. Use the async APIs instead.
 - Upgrade PACs to latest SVD and `svd2rust`:
   - All peripheral types are now `PascalCase`
   - All register field accessors are now methods instead of struct members