CVA6 documentation is published as a Read the Docs documentation.
It can be generated by running make
in this directory.
This generates all necessary sub-documents.
For each supported target (e.g. cv32a65x
), there are two manuals included in the main documentation: a tailored RISC-V instruction set manual, and a design documentation.
These documents are generated when building the main documentation.
Instruction set manuals (privileged & unprivileged) are based on the official RISC-V Instruction Set Manual repository. Some parts are stripped down or annotated to only include what's relevant for each specific configuration.
These manuals can be manually generated with: make -C 04_cv32a65x/riscv priv-html unpriv-html
.
Replace 04_cv32a65x
with the desired target.
Some of the files used in this documentation (config.adoc
) are directly generated from the RTL.
Design documentation describes the internal architecture of the CVA6 processor.
It can be manually generated with: make -C 04_cv32a65x/design design-html
.
Some of the files used in this documentation (config.adoc
, parameters.adoc
, port_*.adoc
, csr.adoc
, isa.adoc
) are directly generated from the RTL.