Add manual generator

Author: Derek Hower

.github/workflows/pages.yml

@@ -45,10 +45,16 @@ jobs:
       run: ./do gen:html[generic_rv64]
     - name: Generate YARD docs
       run: ./do gen:tool_doc
-    - name: Create _site
-      run: mkdir -p _site
+    - name: Build manual
+      run: ./do gen:html_manual MANUAL_NAME=isa VERSIONS=all
+    - name: Create _site/example_cfg
+      run: mkdir -p _site/example_cfg
+    - name: Create _site/manual
+      run: mkdir -p _site/manual
     - name: Copy cfg html
-      run: cp -R gen/cfg_html_doc/generic_rv64/html _site
+      run: cp -R gen/cfg_html_doc/generic_rv64/html _site/example_cfg
+    - name: Copy manual html
+      run: cp -R gen/manual/top/all/html _site/manual
     - name: Setup Pages
       uses: actions/configure-pages@v5
     - name: Upload artifact

README.adoc

@@ -15,7 +15,7 @@ This repository contains:
 
 === Working examples:
 
- * Generate https://riscv-software-src.github.io/riscv-unified-db/html/index.html[configuration-specific documentation] taylored to the set of implemented extensions and unnamed implementation options (_e.g._, `./do gen:html[generic_rv64]`).
+ * Generate https://riscv-software-src.github.io/riscv-unified-db/manual/index.html[configuration-specific documentation] taylored to the set of implemented extensions and unnamed implementation options (_e.g._, `./do gen:html[generic_rv64]`).
  ** Only implemented extensions/instructions/CSRs are included
  ** Unreachable/unimplmented parts of the formal specification are pruned away
  ** A dedicated documentation page for every implemented instruction, including its encoding, pruned execution behavior, and what types of exceptions it may cause.

arch/ext/A.yaml

@@ -7,16 +7,16 @@ A:
     name: RISC-V International
     url: https://riscv.org
   versions:
-  - version: 2.1
+  - version: "2.1.0"
     state: ratified
     ratification_date: 2019-12
     contributors:
     - name: Unknown
       email: [email protected]
       company: Unknown
     implies:
-    - [Zaamo, 1.0]
-    - [Zalrsc, 1.0]
+    - [Zaamo, "1.0.0"]
+    - [Zalrsc, "1.0.0"]
   description: |
 
     The atomic-instruction extension, named `A`, contains

arch/ext/B.yaml

@@ -10,7 +10,7 @@ B:
     name: Creative Commons Attribution 4.0 International License
     url: https://creativecommons.org/licenses/by/4.0/
   versions:
-  - version: 1.0
+  - version: "1.0.0"
     state: ratified
     ratification_date: 2024-04
     contributors:
@@ -19,9 +19,9 @@ B:
       company: Rivos, Inc.
     url: https://drive.google.com/file/d/1SgLoasaBjs5WboQMaU3wpHkjUwV71UZn/view
     implies:
-    - [Zba, 1.0]
-    - [Zbb, 1.0]
-    - [Zbs, 1.0]
+    - [Zba, "1.0.0"]
+    - [Zbb, "1.0.0"]
+    - [Zbs, "1.0.0"]
   description: |
     The B standard extension comprises instructions provided by the `Zba`, `Zbb`, and `Zbs` extensions.
 

arch/ext/C.yaml

@@ -4,7 +4,7 @@ C:
   type: unprivileged
   long_name: Compressed instructions
   versions:
-  - version: 2.2
+  - version: "2.2.0"
     state: ratified
     ratification_date: 2019-12
   description: |

arch/ext/D.yaml

@@ -4,12 +4,12 @@ D:
   type: unprivileged
   long_name: Double-precision floating-point
   versions:
-  - version: 2.2
+  - version: "2.2.0"
     state: ratified
     ratification_date: 2019-12
     changes:
     - Define NaN-boxing scheme, changed definition of FMAX and FMIN
-    implies: [F, 2.2]
+    implies: [F, "2.2.0"]
   description: |
     The `D` extension adds
     double-precision floating-point computational instructions compliant

arch/ext/F.yaml

@@ -4,7 +4,7 @@ F:
   type: unprivileged
   long_name: Single-precision floating-point
   versions:
-  - version: 2.2
+  - version: "2.2.0"
     state: ratified
     ratification_date: 2019-12
     changes:

arch/ext/H.yaml

@@ -4,12 +4,12 @@ H:
   type: privileged
   long_name: Hypervisor
   versions:
-  - version: 1.0
+  - version: "1.0.0"
     state: ratified
     ratification_date: 2019-12
     requires:
       oneOf:
-      - [S, '>= 1.12']
+      - [S, '>= 1.12.0']
   interrupt_codes:
   - num: 2
     name: Virtual supervisor software interrupt

arch/ext/I.yaml

@@ -4,7 +4,7 @@ I:
   type: unprivileged
   long_name: Base integer ISA
   versions:
-  - version: 2.1
+  - version: "2.1.0"
     state: ratified
     ratification_date: 2019-06
     changes:
@@ -73,6 +73,11 @@ I:
   - num: 15
     name: Store/AMO page fault
     var: StoreAmoPageFault
+  - num: 18
+    name: Software Check
+    var: SoftwareCheck
+    when:
+      version: ">= 2.1.0"
   params:
     XLEN:
       description: |

arch/ext/M.yaml

@@ -4,7 +4,7 @@ M:
   type: unprivileged
   long_name: Integer multiply and divide instructions
   versions:
-  - version: 2.0
+  - version: "2.0.0"
     state: ratified
     ratification_date: 2019-12
   description: |