Crate stm32ral

Source
Expand description

This project provides a register access layer (RAL) for all STM32 microcontrollers.

When built, you must specify a device feature, such as stm32f405. This will cause all modules in that device’s module to be re-exported from the top level, so that for example stm32ral::gpio will resolve to stm32ral::stm32f4::stm32f405::gpio.

In the generated documentation, all devices are visible inside their family modules, but when built for a specific device, only that devices’ constants will be available.

See the README for example usage.

Modules§

cortex_m
Parent module for all CORTEX_M devices.
stm32f0
Parent module for all STM32F0 devices.
stm32f1
Parent module for all STM32F1 devices.
stm32f2
Parent module for all STM32F2 devices.
stm32f3
Parent module for all STM32F3 devices.
stm32f4
Parent module for all STM32F4 devices.
stm32f7
Parent module for all STM32F7 devices.
stm32g0
Parent module for all STM32G0 devices.
stm32g4
Parent module for all STM32G4 devices.
stm32h7
Parent module for all STM32H7 devices.
stm32l0
Parent module for all STM32L0 devices.
stm32l1
Parent module for all STM32L1 devices.
stm32l4
Parent module for all STM32L4 devices.
stm32l5
Parent module for all STM32L5 devices.
stm32mp
Parent module for all STM32MP devices.
stm32wb
Parent module for all STM32WB devices.
stm32wl
Parent module for all STM32WL devices.

Macros§

modify_reg
Modify a RWRegister or UnsafeRWRegister.
read_reg
Read the value from a RORegister, RWRegister, UnsafeRORegister, or UnsafeRWRegister.
reset_reg
Reset a RWRegister, UnsafeRWRegister, WORegister, or UnsafeWORegister to its reset value.
write_reg
Write to a RWRegister or UnsafeRWRegister.

Structs§

RORegister
A read-only register of type T.
RWRegister
A read-write register of type T.
UnsafeRORegister
A read-only register of type T, where read access is unsafe.
UnsafeRWRegister
A read-write register of type T, where read/write access is unsafe.
UnsafeWORegister
A write-only register of type T, where write access is unsafe.
WORegister
A write-only register of type T.