#hal #hardware-abstraction #cortex-m #arm #stm32f4xx

no-std stm32f4xx-hal

Peripheral access API for STM32F4 series microcontrollers

38 releases (19 breaking)

0.20.0 Jan 14, 2024
0.19.0 Dec 11, 2023
0.18.0 Nov 20, 2023
0.17.1 Jul 25, 2023
0.2.5 Nov 17, 2018

#14 in Embedded development

Download history 5502/week @ 2024-01-28 4819/week @ 2024-02-04 5123/week @ 2024-02-11 5460/week @ 2024-02-18 4899/week @ 2024-02-25 4841/week @ 2024-03-03 5279/week @ 2024-03-10 3800/week @ 2024-03-17 3754/week @ 2024-03-24 3085/week @ 2024-03-31 3036/week @ 2024-04-07 3054/week @ 2024-04-14 3176/week @ 2024-04-21 3249/week @ 2024-04-28 2522/week @ 2024-05-05 1658/week @ 2024-05-12

11,033 downloads per month
Used in 43 crates

0BSD license

1MB
22K SLoC

stm32f4xx-hal

Crates.io Crates.io Released API docs Minimum Supported Rust Version dependency status Continuous integration

stm32f4xx-hal contains a multi device hardware abstraction on top of the peripheral access API for the STMicro STM32F4 series microcontrollers. The selection of the MCU is done by feature gates, typically specified by board support crates. Currently supported configurations are:

  • stm32f401
  • stm32f405
  • stm32f407
  • stm32f410
  • stm32f411
  • stm32f412
  • stm32f413
  • stm32f415
  • stm32f417
  • stm32f423
  • stm32f427
  • stm32f429
  • stm32f437
  • stm32f439
  • stm32f446
  • stm32f469
  • stm32f479

The idea behind this crate is to gloss over the slight differences in the various peripherals available on those MCUs so a HAL can be written for all chips in that same family without having to cut and paste crates for every single model.

Other optional features

  • rtic1 — support RTICv1 framework.
  • rtic2 — support RTICv2 framework (incompatible with rtic1, require nightly compiller).
  • defmt — implementation of defmt::Format for public enums and structures. See defmt.
  • can — bxCAN peripheral support. See bxcan.
  • i2s — I2S peripheral support. See stm32_i2s_v12x.
  • usb_fs or usb_hs — USB OTG FS/HS peripheral support. See synopsys-usb-otg.
  • fsmc_lcd — LCD support via FMC/FSMC peripheral. See display-interface.
  • sdio-host — SDIO peripheral support. See sdio-host.

Collaboration on this crate is highly welcome as are pull requests!

This crate relies on Adam Greigs fantastic stm32f4 crate to provide appropriate register definitions and implements a partial set of the embedded-hal traits.

Some of the implementation was shamelessly adapted from the stm32f1xx-hal crate originally started by Jorge Aparicio.

Setting up your project

Check if the BSP for your board exists in the stm32-rs page. If it exists, the stm32f4xx-hal crate should be already included, so you can use the bsp as BSP for your project.

Manually

Otherwise, create a new Rust project as you usually do with cargo init. The "hello world" of embedded development is usually to blink a LED. The code to do so is available in examples/delay-syst-blinky.rs. Copy that file to the main.rs of your project.

You also need to add some dependencies to your Cargo.toml:

[dependencies]
embedded-hal = "0.2"
nb = "1"
cortex-m = "0.7"
cortex-m-rt = "0.7"
# Panic behaviour, see https://crates.io/keywords/panic-impl for alternatives
panic-halt = "0.2"

[dependencies.stm32f4xx-hal]
version = "0.18.0"
features = ["stm32f407"] # replace the model of your microcontroller here
                         # and add other required features

We also need to tell Rust how to link our executable and how to lay out the result in memory. To accomplish all this, copy .cargo/config and memory.x from the stm32f4xx-hal repository to your project and make sure the sizes match up with the datasheet. Also note that there might be different kinds of memory which are not equal; to be on the safe side only specify the size of the first block at the specified address.

Fast start

To create empty project faster you could use cargo generate command. See stm32-template.

$ cargo generate --git https://github.com/burrbull/stm32-template/

Note that you need to know your chip full name.

License

0-clause BSD license.

Dependencies

~53MB
~1.5M SLoC