Skip to content

Latest commit

 

History

History
189 lines (148 loc) · 6.12 KB

README.md

File metadata and controls

189 lines (148 loc) · 6.12 KB
Raw

hpm-hal

A Rust HAL and Embassy driver implementation for the HPMicro's RISC-V MCUs. The PAC(Peripheral Access Crate) is based on hpm-data.

This crate is a working-in-progress and not ready for production use.

Support Status

MCU Family Support

MCU Family PAC Demo Embassy SYSCTL GPIO UART I2C SPI DMA TMR ADC USB CAN
HPM6700 ✓ ✓ ✓ ✓ ✓+ ✓+ ✓+ ✓+ ✓+
HPM6300 ✓ ✓ ✓ ✓ ✓+ ? ? ? ?
HPM6200 ✓ ✓ ✓ ✓ ✓+
HPM5300 ✓ ✓ ✓ ✓ ✓+ ✓+ ✓+ ✓+ ✓+ ✓ ✓ ✓
HPM6800 ✓
HPM6E00 ✓ ✓ ✓ ✓ ✓+ ✓+ ✓+ ✓+ ✓+ ✓ ✓
  • ✓: Implemented
  • ?: Requires demo verification
  • !: Partially implemented
  • Blank: Not implemented
  • +: Async support

Peripheral Support

  • Basic rt code: linker, startup
    • vectored interrupt handling
    • L1C support
    • PMP for noncacheable memory
    • CPU1 support - how to?
  • Embassy time driver using MCHTMR
  • SYSCTL init
    • Resource group handling
  • PLL setting
  • GPIO, Flex, Input, Output, Async
  • DMA, both HDMA and XDMA
    • DMA v2
    • DMA v1
  • UART
    • Blocking driver
    • Async driver
    • Ring buffer based async
  • I2C
    • Blocking driver
    • Async driver
  • SPI driver
    • QSPI driver
    • Blocking
    • Async using DMA
  • ADC driver
    • ADC16
      • blocking one-shot
      • blocking periodic
      • sequence mode
      • preemption mode
    • ADC12, and differential mode
  • DAC driver
    • direct mode
    • step mode
    • buffer mode
    • buffer switch control using async
    • hw trigger control
  • RTC, with alarm driver and optional chrono datetime
  • MBX
    • blocking and async, message mode and fifo mode
    • DMA driver?
  • FEMC
    • SDRAM init
  • MCAN
    • basic mcan wrapper
    • [ ] async driver, better impl it in the App layer, see XiaoMi CyberGear motor demo
    • TSU management
  • USB via embassy-usb
    • Device
    • Host
  • XPI NOR flash driver using embedded-storage
  • RNG, in blocking mode
  • power domain handling

Related Crates

  • andes-riscv for Andes' specific CSRs
  • hpm-data and hpm-metapac for Chip metadata and PAC generation
  • hpm-riscv-rt for customized runtime (riscv-rt does not fit)

Toolchain Support

Usage

The best reference is the examples in the examples directory and Github actions workflow.

Requirements

  • A probe(debugger), optional if you are using official HPMicro's development board
    • FT2232-based (official HPMicro's development board uses this chip)
    • JLink
    • DAPLink-based probe
  • A flash tool for your probe, choose one from:
  • A RISC-V GCC toolchain if you perfer to use OpenOCD(only GDB is needed)
  • A Rust toolchain
    • rustup default nightly
    • rustup target add riscv32imafc-unknown-none-elf

Guide

Step 0. Prerequisites

Step 1. Prepare Rust Toolchain

# lock to 2024-08-23 and wait for embassy-executor to be updated
rustup default nightly-2024-08-23
rustup target add riscv32imafc-unknown-none-elf

Step 2. Clone this repo

git clone https://github.com/hpmicro/hpm-hal.git

# Or if you are using SSH

git clone git@github.com:hpmicro/hpm-hal.git

# Or if you are using GitHub CLI

gh repo clone hpmicro/hpm-hal

Step 3. Run Examples

  1. Edit examples/YOUR_BOARD/.cargo/config.toml to set the correct flash/run command for your probe.

  2. (Optional) Edit and run run-openocd.sh if using OpenOCD.

  3. Connect your probe to the target board.

  4. Run an example:

cd examples/hpm5300evk
cargo run --release --bin blinky

Note: Due to rust-embedded/riscv#196, patched linker script should be used.

License

This repo is licensed under either of

at your option.

Contributing

This crate is under active development. Before starting your work, it's better to create a "Work in Progress" (WIP) pull request describing your work to avoid conflicts.