Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.58 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.58 KB

f4 - A hardware abstraction layer for STM32F4x microcontrollers

This crate is heavily inspired by jparic's phenomenal work on svd2rust and rtfm, as well as the many supporting libraries he has designed. The underlying stm32f40x library is generated from the manufacturer's SVD file with minimal changes using the svd2rust project.

The f4 crate is a work-in-progress, and the API is subject to change. I am currently building it out as the foundation for a project and will be adding features and refactoring as the project demands. My hope is that the end product will be useful to others as well.

Compatibility

This crate strives to implement compatibility with the embedded-hal project wherever possible. However, due to limited resources (read: limited time!), only the subset of features that are required for my use case will be initially supported. If there's a feature you'd really like to see added, feel free to raise an issue (or better yet, make a pull request!), and I will try and make it happen.

Project Goals

The primary goals of the f4 crate are:

  • to make a thread-safe access to the STM32F4's peripherals
  • to provide an ergonomic and readable interface to the hardware
  • to provide useful debugging tools and informative error messages
  • to provide an interface that is as close as possible to idiomatic Rust

Please note that, in its current state, this crate does not yet accomplish these goals!