riscv-rust-quickstart
A template for building Rust applications for HiFive1 boards
This project is developed and maintained by the RISC-V team.
Dependencies
To build embedded programs using this template you'll need:
-
Rust 1.36 or a newer toolchain. e.g.
rustup default stable
-
The
cargo generate
subcommand. Installation instructions. -
rust-std
components (pre-compiledcore
crate) for the RISC-V target. Run:
$ rustup target add riscv32imac-unknown-none-elf
-
RISC-V toolchain for SiFive boards
- Extract this package.
- See "Set up
gdb
", below.
-
Programmer software
- HiFive1 Rev B: Segger JLink software & documentation pack for Linux
- HiFive1: OpenOCD from SiFive
Using this template
NOTE: This is the very short version that only covers building programs. For the long version, which additionally covers flashing, running and debugging programs, check the embedded Rust book.
- Instantiate the template.
$ cargo generate --git https://github.com/riscv-rust/riscv-rust-quickstart
Project Name: app
Creating project called `app`...
Done! New project created /tmp/app
$ cd app
-
If you have an old HiFive1 board, edit
Cargo.toml
: replaceboard-hifive1-revb
withboard-hifive1
. -
Set up
gdb
:
- Open
.cargo/config
- Edit the line that reads
runner = "riscv32imac-unknown-elf-gdb -q -x gdb_init"
to read:
runner = "/path/to/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14/bin/riscv64-unknown-elf-gdb -q -x gdb_init"
or ensure that riscv64-unknown-elf-gdb
is on your $PATH
.
(riscv64-unknown-elf-gdb
was downloaded and extracted in the RISC-V toolchain for SiFive boards
step, above.)
- Run the programmer software.
- HiFive1 Rev B:
/path/to/JLinkGDBServer -device FE310 -if JTAG -speed 4000 -port 3333
- HiFive1:
/path/to/openocd -f board/sifive-hifive1.cfg
- Build the template application or one of the examples.
$ cargo build
or
$ cargo build --example leds_blink
- Run the template application or one of the examples.
$ cargo run
or
$ cargo run --example leds_blink
License
Copyright 2017-2019 RISC-V team
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.