Files
.github
.vscode
docs
modules
ROOT
examples
images
pages
basic_application.adoc
examples.adoc
getting_started.adoc
hal.adoc
index.adoc
layer_by_layer.adoc
nrf.adoc
runtime.adoc
stm32.adoc
traits.adoc
nav.adoc
antora.yml
embassy
embassy-boot
embassy-hal-common
embassy-lora
embassy-macros
embassy-net
embassy-nrf
embassy-rp
embassy-stm32
embassy-traits
examples
stm32-data
stm32-gen-features
stm32-metapac
stm32-metapac-gen
tests
xtask
.gitignore
.gitmodules
LICENSE-APACHE
LICENSE-MIT
README.md
ci.sh
ci_stable.sh
rust-toolchain.toml
embassy/docs/modules/ROOT/pages/stm32.adoc
Johann Tuffe 5d86228077 Update stm32.adoc
typo
2021-12-30 09:17:06 +08:00

25 lines
1.3 KiB
Plaintext

= Embassy STM32 HAL
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 feature 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.