Initial commit.
[platform/kernel/opensbi.git] / README.md
1 RISC-V Open Source Supervisor Binary Interface (OpenSBI)
2 ========================================================
3
4 The RISC-V Supervisor Binary Interface (SBI) is a recommended
5 interface between:
6 1. platform specific firmware running in M-mode and bootloader
7    running in S-mode
8 2. platform specific firmware running in M-mode and general
9    purpose operating system running in S-mode
10 3. hypervisor runnng in HS-mode and general purpose operating
11    system running in VS-mode.
12
13 The RISC-V SBI spec is maintained as independent project by
14 RISC-V Foundation at https://github.com/riscv/riscv-sbi-doc
15
16 The RISC-V OpenSBI project aims to provides an open-source and
17 extensible implementation of the SBI spec. This project can be
18 easily extended by RISC-V platform or RISC-V System-on-Chip vendors.
19
20
21 How to Build?
22 -------------
23
24 Below are the steps to cross-compile and install RISC-V OpenSBI:
25
26 1. Setup build environment
27 $ CROSS_COMPILE=riscv64-unknown-linux-gnu-
28
29 2. Build sources
30 $ make PLAT=<platform_name>
31 OR
32 $ make PLAT=<platform_name> O=<build_directory>
33
34 3. Install blobs
35 $ make PLAT=<platform_name> install
36 OR
37 $ make PLAT=<platform_name> I=<install_directory> install