RustSBI

RISC-V Supervisor Binary Interface (SBI) implementation in Rust; runs on M-mode.

Build this project

RustSBI is usually used as a library or dependency. If you wish to, you may build RustSBI library itself using the following command:

# If you don't have the cross compile target installed, install it first
rustup target add riscv64imac-unknown-none-elf
# Build this project as library
cargo build --target riscv64imac-unknown-none-elf

The build should finish without any errors.

If you see any error like invalid register a0: unknown register, it's likely that you cross built this project into platforms other than RISC-V. RustSBI adapts to RISC-V SBI interface, so you may cross build this project into any bare metal RISC-V platform targets instead.

The target platform of RustSBI is usually a bare metal target. Under normal circumstances these targets in Rust would start with riscv??- and end with -none-elf. If a non bare metal target is built to, it would throw build error in riscv dependency crate or RustSBI library itself.

Minimum supported Rust version

To compile this project, you may need at least nightly Rust version of rustc 1.59.0-nightly (c5ecc1570 2021-12-15).

Binary downloads

RustSBI is provided with separate library and binary projects, this is the repository for RustSBI library. For specific platforms, you may visit implementation specific projects depending on the platforms you need. Chip, system and platform vendors should provide RustSBI implementation for dedicated platform as a part of platform software support package.

There are packages exists on awesome-rustsbi: it is a curated list of awesome things related to RustSBI, which includes some implementation projects maintained by individuals or the community. You may find binary downloads for useful platforms on awesone-rustsbi.

Features

Functional and extensible operating system runtime
Fully support to RISC-V SBI specification v0.3
Adapted for operating system kernel models on your choice
Written in Rust
Competitive to OpenSBI with most of its function
Bundled with a test framework for SBI implementations
Empower support, compatibility for different platforms

Frequently asked questions

Can I use RustSBI on C based kernels?

Yes, you can! RustSBI strictly follows RISC-V SBI standard. All features are prepares for all programming languages, as long as they support RISC-V SBI defined calling convention.

If your kernel language supports other SBI implementations, usually it will support RustSBI in the same way.

Talks and documents

This project is originally a part of rCore Summer of Code 2020 activities, inspired by MeowSBI and other similar projects. Now it is capable of running rCore-Tutorial and other OS kernels on wide supported RISC-V devices.

There are multiple talks related to RustSBI dated back to Aug 2020. These talks discusses from design and abstraction of RustSBI modules, to actual production and research usage scenario related to RustSBI and RISC-V bootloaders. Public slides and blog articles of these talks are available at RustSBI/slides page.

Notes on platform implementation

RustSBI should be used as a library. Under normal circumstances, RustSBI platform can be implemented with embedded Rust's embedded-hal libraries.
Contributions are welcomed! We welcome to implement and test RustSBI for both FPGA cores and real cores. Implementations for emulators are also welcomed. If you are ready, start your own binary project and use RustSBI in it!
If there is a bug in RustSBI project itself, fire an issue or pull request to let us know!

License & Copyright

This project is licensed under either of

MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
Mulan PSL v2 (LICENSE-MULAN or https://opensource.org/licenses/MulanPSL-2.0)

Documents from RISC-V SBI Specification are used in this project. These documents are (C) RISC-V Founcation under Creative Commons Attribution 4.0 International License (CC-BY 4.0). The full license text is available at https://creativecommons.org/licenses/by/4.0/.

BabyMelvin/rustsbi