repository·main·Indexed 24 days ago
https://github.com/rp-rs/rp-halA collection of high-level Rust Hardware Abstraction Layers (HALs) for Raspberry Pi RP2040 and RP235x microcontrollers. Includes rp2040-hal, rp235x-hal, and supporting crates like rp-binary-info and rp-hal-common. Provides guidance on toolchain setup for thumbv6m, thumbv8m, and RISC-V targets, flashing via probe-rs or picotool, and utilizing Board Support Packages (BSPs).
rp-hal-common is a shared library containing code and types that are useful to both the rp2040-hal and rp235x-hal crates. It serves as a common foundation for the Raspberry Pi RP-series Hardware Abstraction Layers (HALs).The rp-hal repository is organized into several crates depending on your target hardware and needs:
rp2040-hal: High-level drivers for the RP2040's internal peripherals (SPI, I2C, etc.). It is hardware-agnostic regarding board pin-outs.rp235x-hal: High-level drivers for the RP235x family (including RP2350A, RP2350B, RP2354A, and RP2354B). It supports both ARM and RISC-V modes.rp2040-hal-examples / rp235x-hal-examples: Practical examples for GPIO, I2C, SPI, UART, PWM, PIO, and more.rp-binary-info: A library used to generate picotool compatible metadata (name, version, etc.) within your Rust binaries.rp-hal-common: Shared code used internally to unify the two HALs.The rp235x-hal package provides high-level Rust drivers for the Raspberry Pi RP235x microcontroller family, including:
It implements the embedded-hal hardware abstraction interfaces. It is designed to be used directly for generic RP235x development or via Board Support Packages (BSPs) for specific hardware configurations.
rp-binary-info provides the code and types necessary to generate "Binary Info" metadata that is compatible with Picotool. This allows developers to embed specific metadata into their binaries that can be inspected by Picotool tools.The rp2040-hal package provides high-level drivers, but the examples in this folder are non-board specific.
If you are using a specific development board (like a Raspberry Pi Pico), it is recommended to use a Board Support Package (BSP) crate. BSPs pre-configure the pins according to the specific PCB design, making them easier to use than the generic HAL.
You can find supported boards in the rp-hal-boards repository.
The existing test suite requires specific physical pin connections on the hardware (e.g., a Raspberry Pi Pico) to perform loopback testing. If you add new tests, ensure they are compatible with this existing configuration so the entire suite can run with a single setup.
Required Connections:
| Test Type | GPIO Connection | Pico Pin Mapping |
|---|---|---|
| SPI Loopback | GPIO 4 $\leftrightarrow$ GPIO 7 | Pins 6 and 10 |
| I2C Loopback | GPIO 0 $\leftrightarrow$ GPIO 2 AND GPIO 1 $\leftrightarrow$ GPIO 3 | Pins 1 & 4 AND Pins 2 & 5 |
When developing for RP235x, you have two main choices for hardware abstraction:
rp235x-hal (Hardware Abstraction Layer): A library of high-level Rust drivers for the RP235x family. It is generic and does not assume a specific pinout or board layout. Use this if you are designing your own PCB or need low-level peripheral control.Recommendation: If you are using a supported development board, use the corresponding BSP crate instead of the HAL directly to avoid manual pin configuration.
The rp2040-hal crate provides high-level drivers and implements generic embedded-hal traits. However, if you are using a specific development board (like a Raspberry Pi Pico), you should use a Board Support Package (BSP) crate instead.
BSPs use rp2040-hal internally but pre-configure the pins and peripherals according to the specific PCB design of that board, making it easier to get started with hardware-specific layouts.
rp2040-hal crate implements traits from the embedded-hal ecosystem. It supports both version 0.2 and version 1.0 of embedded-hal simultaneously, allowing you to use different drivers incrementally as you upgrade your codebase.rp235x-hal crate implements traits from both embedded-hal version 0.2 and version 1.0. This allows you to use different driver versions simultaneously and upgrade your drivers incrementally.You can build specific examples using cargo build with the --bin flag.
By default, cargo build targets Arm mode. To build a specific example like blinky:
$ cargo build --bin blinkyTo build for RISC-V, you must explicitly specify the target:
$ cargo build --target=riscv32imac-unknown-none-elf --bin blinkyTo build a production-ready binary, add the --release flag to either command.
To use the rp235x-hal drivers in your Rust project, add the crate to your Cargo.toml file. You can use a wildcard to pull the latest version or specify a version for stability.
If you are using a specific board, it is recommended to use a Board Support Package (BSP) instead, as BSPs pre-configure the pins for your specific PCB design.