Skip to content

Latest commit

 

History

History
85 lines (68 loc) · 4.15 KB

README.adoc

File metadata and controls

85 lines (68 loc) · 4.15 KB
Raw

RISC-V RPMI Specification

RPMI (RISC-V Platform Management Interface) is an extensible messaging interface between application processors and platform microcontrollers for management and control of system.

This specification is based on an earlier draft located here: https://docs.google.com/document/d/199ar3Ddd-FlzP1FR3HOkbBf1BNvLUPvJ/edit

Licensing

The files in this repository are licensed under the 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/.

Contributors

Contributors to this specification are contained in the contributors file.

For instructions on how to contribute please see the CONTRIBUTING file.

Dependencies

The PDF built in this project uses AsciiDoctor (Ruby). For more information on AsciiDoctor, specification guidelines, or building locally, see the RISC-V Documentation Developer Guide.

Discussion Forum

Discussion on RPMI occurs on RPMI mailing list.

Dependencies

The PDF built in this project uses AsciiDoctor (Ruby). For more information on AsciiDoctor, specification guidelines, or building locally, see the RISC-V Documentation Developer Guide.

Build Documents

This project uses GitHub Submodules to include the RISC-V docs-resources project to achieve a common look and feel.

When cloning this repository for the first time, you must either use git clone --recurse-submodules or execute git submodule init and git submodule update after the clone to populate the docs-resources directory. Failure to clone the submodule, will result in the PDF build fail with an error message.

The final specification in form of PDF and HTML can be generated using make command. The makefile internally uses asciidoctor so the packages required by the makefile need to be installed on the build system using make install-debs or make install-rpms.

git clone https://github.com/riscv-non-isa/riscv-rpmi

git submodule init && git submodule update

make

Editing Images

The source of all the images used in this specification is present in the images/source folder. The source file is a single drawio format file containing multiple tabs with chapter names. The source file can be opened in the publicly available tool called drawio-desktop at this link: https://github.com/jgraph/drawio-desktop/releases