https://github.com/riscv/riscv-spmp

The repo contains the SPMP architectural specification, which includes capabilities like access control of read/write/execute requests by an hart, address matching, encoding of permissions, exceptions for access violation, and support for virtualization.
https://github.com/riscv/riscv-spmp

Last synced: about 2 months ago
JSON representation

The repo contains the SPMP architectural specification, which includes capabilities like access control of read/write/execute requests by an hart, address matching, encoding of permissions, exceptions for access violation, and support for virtualization.

• Host: GitHub
• URL: https://github.com/riscv/riscv-spmp
• Owner: riscv
• License: cc-by-4.0
• Created: 2022-09-06T13:08:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T12:39:15.000Z (4 months ago)
• Last Synced: 2024-11-10T00:32:52.606Z (2 months ago)
• Language: TeX
• Homepage: https://jira.riscv.org/browse/RVG-100
• Size: 8.75 MB
• Stars: 11
• Watchers: 11
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: readme.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
= RISC-V SPMP Extension

Working draft of the proposed RISC-V SPMP extension.

You can check the link:rv-spmp-spec.pdf[Latest RISC-V SPMP] file, or build the spec from source.

The structure of the repo:

* sspmp: the directory contains the specification for sspmp.

* spmp-for-hyp: the directory contains the extensions of spmp to support virtualization/hypervisor.

= License

This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0).

See the link:LICENSE[LICENSE] file for details.

= Contributors

Contributors to this specification are contained in the link:contributors.adoc[contributors] file.

For instructions on how to contribute please see the link:CONTRIBUTING.md[CONTRIBUTING] file.

= Dependencies

This project is built using AsciiDoctor (Ruby). The repository has been setup to build the PDF on

checkin using GitHub actions.  Workflow dependencies are located in the `dependencies` directory.

For more information on AsciiDoctor, specification guidelines, or building locally, see the

https://github.com/riscv/docs-dev-guide[RISC-V Documentation Developer Guide].

= Cloning the project

This project uses https://git-scm.com/book/en/v2/Git-Tools-Submodules[GitHub Submodules]

to include the https://github.com/riscv/docs-resources[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 like the following:

    $ make

    asciidoctor-pdf \

    -a toc \

    -a compress \

    -a pdf-style=docs-resources/themes/riscv-pdf.yml \

    -a pdf-fontsdir=docs-resources/fonts \

    --failure-level=ERROR \

    -o profiles.pdf profiles.adoc

    asciidoctor: ERROR: could not locate or load the built-in pdf theme `docs-resources/themes/riscv-pdf.yml'; reverting to default theme

    No such file or directory - notoserif-regular-subset.ttf not found in docs-resources/fonts

      Use --trace for backtrace

    make: *** [Makefile:7: profiles.pdf] Error 1

= Building the document

The final specification form of PDF can be generated using the `make` command.