5eroRISC Security Research Using Rust and RISC-V

The original template is based upon https://github.com/riscv-rust/riscv-rust-quickstart This template is maintained by dkhayes117 for educational purposes.

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-compiled core crate) for the RISC-V target. Run:

$ rustup target add riscv32imac-unknown-none-elf

• RISC-V toolchain for SiFive boards

• 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.

1. 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

2. If you have an old HiFive1 board, edit Cargo.toml: replace board-hifive1-revb with board-hifive1.

3. Run the programmer software.

• HiFive1 Rev B:

/path/to/JLinkGDBServer -device FE310 -if JTAG -speed 4000 -port 3333 -nogui

• HiFive1:

/path/to/openocd -f board/sifive-hifive1.cfg

4. Build the template application or one of the examples.

$ cargo build
or
$ cargo build --example leds_blink

5. Run the template application or one of the examples.

$ cargo run
or
$ cargo run --example leds_blink

Troubleshooting

Rust versions 1.45.0..1.45.2 contain a bug that marks some of the ELF sections as PROGBITS. This may result in huge binaries as well as overwrite the HiFive1 bootloader with zeros. It's recommended to use stable Rust 1.46.0.

If your bootloader is damaged, you will not see the green led blinking when you reset the board. In this case, you can restore the bootloader with the procedure described in the hifive1-recover repo.

Debugging

Run your program, then use GDBserver to debug the program with continue, next, step, break, etc by stopping the program with ctrl+C.

gdb$ target remote localhost:3333
gdb$ break src/main.rs:1
gdb$ layout regs
gdb$ jump _start
gdb$ list

These are a few commands to get started debugging a program. Use next to go line by line, step goes through each instruction, continue jumps to breakpoints.

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.