riscv-aclint
riscv-aclint copied to clipboard
= RISC-V ACLINT specification
The ACLINT (Advanced Core Local Interruptor) specification defines a set of memory mapped devices which provide inter-processor interrupt and timer functionality for each HART of a multi-HART (or multi-processor) RISC-V platform.
Discussion of ACLINT occurs on the https://lists.riscv.org/g/tech-unixplatformspec[RISC-V Unix Platform Mailing list]. It is publicly readable but posting requires being a member of the RISC-V Foundation. Any changes to the ACLINT specification needs to be discussed and approved there before being merged.
= 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/.
= Building Documents
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
.
= 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 riscv-aclint.pdf riscv-aclint.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