diff options
| author | Barnaby Walters <[email protected]> | 2024-01-11 19:55:15 +0100 |
|---|---|---|
| committer | Barnaby Walters <[email protected]> | 2024-01-11 19:55:15 +0100 |
| commit | ccf61f50feba45c496de1c3dc49b58cad5b8f7a1 (patch) | |
| tree | 4f2febb95ad0b08e33092d8b5bbf5771f9e617e1 | |
| parent | 4caafe10aeb0b884a820f1e317f131b61e701e3c (diff) | |
Corrections from review
| -rw-r--r-- | embassy-stm32/README.md | 5 |
1 files changed, 1 insertions, 4 deletions
diff --git a/embassy-stm32/README.md b/embassy-stm32/README.md index b9b1f7820..7cce97d5e 100644 --- a/embassy-stm32/README.md +++ b/embassy-stm32/README.md | |||
| @@ -19,10 +19,7 @@ In practice, this works as follows: | |||
| 19 | 19 | ||
| 20 | Be aware that, while embassy-stm32 strives to consistently support all peripherals across all chips, this approach can lead to slightly different APIs and capabilities being available on different families. Check the [documentation](https://docs.embassy.dev/embassy-stm32/) for the specific chip you’re using to confirm exactly what’s available. | 20 | Be aware that, while embassy-stm32 strives to consistently support all peripherals across all chips, this approach can lead to slightly different APIs and capabilities being available on different families. Check the [documentation](https://docs.embassy.dev/embassy-stm32/) for the specific chip you’re using to confirm exactly what’s available. |
| 21 | 21 | ||
| 22 | ## Minimum supported Rust version (MSRV) | 22 | ## embassy-time Time Driver |
| 23 | Embassy is guaranteed to compile on the latest stable Rust version at the time of release. It might compile with older versions but that may change in any new patch release. | ||
| 24 | |||
| 25 | ## embassy-time Timer Driver | ||
| 26 | If the `time` feature is enabled, embassy-stm32 provides a timer driver for use with [embassy-time](https://docs.embassy.dev/embassy-time/). You can pick which hardware timer is used for this internally via the `time-driver-*` features, or let embassy pick with `time-driver-any`. | 23 | If the `time` feature is enabled, embassy-stm32 provides a timer driver for use with [embassy-time](https://docs.embassy.dev/embassy-time/). You can pick which hardware timer is used for this internally via the `time-driver-*` features, or let embassy pick with `time-driver-any`. |
| 27 | 24 | ||
| 28 | embassy-time has a default tick rate of 1MHz, which is fast enough to cause problems with the 16-bit timers currently supported by the embassy-stm32 time driver (specifically, if a critical section delays an IRQ by more than 32ms). To avoid this, it’s recommended to pick a lower tick rate. 32.768kHz is a reasonable default for many purposes. \ No newline at end of file | 25 | embassy-time has a default tick rate of 1MHz, which is fast enough to cause problems with the 16-bit timers currently supported by the embassy-stm32 time driver (specifically, if a critical section delays an IRQ by more than 32ms). To avoid this, it’s recommended to pick a lower tick rate. 32.768kHz is a reasonable default for many purposes. \ No newline at end of file |