Logo

rp-hal

High-level Rust drivers for the Raspberry Silicon RP2040 Microcontroller
Explore the API docs »

View Demos · Report a Bug · Chat on Matrix

Table of Contents
  1. Introduction
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements
## Introduction This is the `rp2040-hal` package - a library crate of high-level Rust drivers for the Raspberry Silicon RP2040 microcontroller, along with a collection of non-board specific example programs for you to study. You should use this crate in your application if you want to write code for the RP2040 microcontroller. The *HAL* in the name standards for *Hardware Abstraction Layer*, and comes from the fact that many of the drivers included implement the generic hardware-abstraction interfaces defined in the Rust Embedded Working Group's [embedded-hal](https://github.com/rust-embedded/embedded-hal) crate. We also provide a series of *Board Support Package* (BSP) crates, which take this HAL crate and pre-configure the pins according to a specific PCB design. If you are using one of the supported boards, you should use one of those crates in preference, and return here to see documentation about specific peripherals on the RP2040 and how to use them. See the `boards` folder in https://github.com/rp-rs/rp-hal/ for more details. ## Getting Started To include this crate in your project, amend your `Cargo.toml` file to include ```toml rp2040-hal = "0.5.0" ``` To obtain a copy of the source code (e.g. if you want to propose a bug-fix or new feature, or simply to study the code), run: ```console $ git clone https://github.com/rp-rs/rp-hal.git ``` For details on how to program an RP2040 microcontroller, see the [top-level rp-hal README](https://github.com/rp-rs/rp-hal/). ## Roadmap NOTE This HAL is under active development. As such, it is likely to remain volatile until a 1.0.0 release. See the [open issues](https://github.com/rp-rs/rp-hal/issues) for a list of proposed features (and known issues). ### Support for embedded-hal 1.0 We plan to support embedded-hal 1.0 soon after it is released. For now, there is preliminary support for alpha versions of embedded-hal, which can be enabled with the feature `eh1_0_alpha`. Please note that this support does not provide any semver compatibility guarantees: With that feature activated, there will be breaking changes even in minor versions of rp2040-hal. Support for embedded-hal 1.0(-alpha) exists in parallel to support for embedded-hal 0.2: Traits of both versions are implemented and can be used at the same time. The new blocking [SPI traits](https://docs.rs/embedded-hal/1.0.0-alpha.8/embedded_hal/spi/blocking/index.html) are not yet implemented. ### Support for critical-section 0.2 While `rp2040-hal` uses critical-section 1.0, it still provides support for version 0.2. That version is deprecated, and support will be removed in a future release. Please upgrade. ## Contributing Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request ## License Distributed under the MIT OR Apache2.0 License. See `MIT` or `APACHE2.0` for more information. ## Contact Project Link: [https://github.com/rp-rs/rp-hal/issues](https://github.com/rp-rs/rp-hal/issues) Matrix: [#rp-rs:matrix.org](https://matrix.to/#/#rp-rs:matrix.org) ## Acknowledgements * [Othneil Drew's README template](https://github.com/othneildrew)