max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More content

Browse Source
This commit is contained in:
Ulf Lilleengen
2021-12-10 12:27:44 +01:00
parent b48fcd9229
commit e93f2679b1
3 changed files with 47 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/modules/ROOT/pages/stm32.adoc
View File

@ -1,3 +1,24 @@
= Embassy STM32 HAL
TODO
The link:https://github.com/embassy-rs/embassy/tree/master/embassy-stm32[Embassy STM32 HAL] is based on the `stm32-metapac` project.
== The infinite variant problem
STM32 microcontrollers comes in many families and flavors, and supporting all of them is a big undertaking. Embassy has taken advantage of the fact
that the STM32 peripheral versions are shared across chip families. Instead of re-implementing the SPI
peripheral for every STM32 chip family, embassy have a single SPI implementation that depends on
code-generated register types that are identical for STM32 families with the same version of a given peripheral.
=== The metapac
The `stm32-metapac` module uses pre-generated chip and register definitions for STM32 chip families to generate register types. This is done at compile time based on Cargo feataure flags.
The chip and register definitions are located in a separate module, `stm32-data`, which is modified whenever a bug is found in the definitions, or when adding support for new chip families.
=== The HAL
The `embassy-stm32` module contains the HAL implementation for all STM32 families. The implementation uses automatically derived feature flags to support the correct version of a given peripheral for a given chip family.
== Timer driver
The STM32 timer driver operates at 32768 Hz by default.