Merge branch 'main' into misa-readonly-zero

Signed-off-by: Jevin Jojo <[email protected]>

Author: jevinjojo

.github/workflows/merge.yml

@@ -6,18 +6,26 @@ on:
   merge_group:
     types: [checks_requested]
   workflow_dispatch:
+  workflow_call:
+    inputs:
+      dry-run:
+        required: true
+        type: boolean
 env:
   SINGULARITY: 1
 jobs:
   build-reuse-manifest:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: singularity setup
+        uses: ./.github/actions/singularity-setup
       - name: run reuse
         run: ./bin/reuse spdx
   build-udb-api-doc:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -27,6 +35,7 @@ jobs:
       - name: Generate UDB API Docs
         run: ./do gen:udb:api_doc
   build-isa-explorer-csr:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -36,6 +45,7 @@ jobs:
       - name: Generate ISA Explorer CSR
         run: ./do gen:isa_explorer_browser_csr
   build-isa-explorer-ext:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -45,24 +55,27 @@ jobs:
       - name: Generate ISA Explorer Extension
         run: ./do gen:isa_explorer_browser_ext
   build-isa-explorer-inst:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
         uses: actions/checkout@v4
       - name: singularity setup
         uses: ./.github/actions/singularity-setup
       - name: Generate ISA Explorer Instructions
-        run: ./do gen:isa_explorer_browser_insts
+        run: ./do gen:isa_explorer_browser_inst
   build-isa-explorer-spreadsheet:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
         uses: actions/checkout@v4
       - name: singularity setup
         uses: ./.github/actions/singularity-setup
       - name: Generate ISA Explorer Spreadsheet
-        run: ./do gen:isa_explorer_browser_spreadsheet
+        run: ./do gen:isa_explorer_spreadsheet
   build-html-isa-manual:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     env:
       MANUAL_NAME: isa
@@ -75,6 +88,7 @@ jobs:
       - name: Generate HTML ISA manual
         run: ./do gen:html_manual
   build-html-cfg-isa-manual:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -84,6 +98,7 @@ jobs:
       - name: Generate HTML ISA manual for a config
         run: ./do gen:html[example_rv64_with_overlay]
   build-instruction-appendix:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -93,6 +108,7 @@ jobs:
       - name: Generate instruction appendix
         run: ./do gen:instruction_appendix
   build-rvi20-profile:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -102,6 +118,7 @@ jobs:
       - name: Generate RVI20
         run: ./do gen:profile_release_pdf[RVI20]
   build-rva20-profile:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -111,6 +128,7 @@ jobs:
       - name: Generate RVA20
         run: ./do gen:profile_release_pdf[RVA20]
   build-rva22-profile:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -120,6 +138,7 @@ jobs:
       - name: Generate RVA22
         run: ./do gen:profile_release_pdf[RVA22]
   build-rva23-profile:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -129,6 +148,7 @@ jobs:
       - name: Generate RVA23
         run: ./do gen:profile_release_pdf[RVA23]
   build-rvb23-profile:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -138,6 +158,7 @@ jobs:
       - name: Generate RVB23
         run: ./do gen:profile_release_pdf[RVB23]
   build-ac100-crd:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -147,6 +168,7 @@ jobs:
       - name: Generate AC100 CRD
         run: ./do gen:proc_crd_pdf[AC100]
   build-ac200-crd:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -156,6 +178,7 @@ jobs:
       - name: Generate AC200 CRD
         run: ./do gen:proc_crd_pdf[AC200]
   build-mc100-32-crd:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -165,6 +188,7 @@ jobs:
       - name: Generate MC100-32 CRD
         run: ./do gen:proc_crd_pdf[MC100-32]
   build-mc100-64-crd:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -174,6 +198,7 @@ jobs:
       - name: Generate MC100-64 CRD
         run: ./do gen:proc_crd_pdf[MC100-64]
   build-mc200-32-crd:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -183,6 +208,7 @@ jobs:
       - name: Generate MC200-32 CRD
         run: ./do gen:proc_crd_pdf[MC200-32]
   build-mc200-64-crd:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -192,6 +218,7 @@ jobs:
       - name: Generate MC200-64 CRD
         run: ./do gen:proc_crd_pdf[MC200-64]
   build-mc300-32-crd:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -201,6 +228,7 @@ jobs:
       - name: Generate MC300-32 CRD
         run: ./do gen:proc_crd_pdf[MC300-32]
   build-mc300-64-crd:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action
@@ -210,6 +238,7 @@ jobs:
       - name: Generate MC300-64 CRD
         run: ./do gen:proc_crd_pdf[MC300-64]
   build-mc100-32-ctp:
+    if: (github.event_name == 'merge_queue') || (inputs.dry-run == false)
     runs-on: ubuntu-latest
     steps:
       - name: Clone Github Repo Action

.github/workflows/regress.yml

@@ -201,3 +201,18 @@ jobs:
         uses: ./.github/actions/singularity-setup
       - name: Run cpp unit tests
         run: ./do test:cpp_hart CONFIG=rv64 JOBS=4
+  regress-xqci-doc:
+    runs-on: ubuntu-latest
+    env:
+      SINGULARITY: 1
+    steps:
+      - name: Clone Github Repo Action
+        uses: actions/checkout@v4
+      - name: singularity setup
+        uses: ./.github/actions/singularity-setup
+      - name: Run cpp unit tests
+        run: ./do gen:ext_pdf EXT=Xqci CFG=qc_iu.yaml VERSION=latest
+  call-deploy:
+    uses: ./.github/workflows/merge.yml
+    with:
+      dry-run: true

backends/cfg_html_doc/templates/inst.adoc.erb

@@ -42,21 +42,55 @@ RV64::
 <%= inst.description %>
 
 == Access
-<%- if cfg_arch.ext?(:H) -%>
-[cols="^,^,^,^,^"]
-<%- else -%>
-[cols="^,^,^"]
-<%- end -%>
+<%-
+  # Determine which privilege modes to display based on implemented extensions
+  modes = ["M"]  # M-mode is always present
+  mode_headers = ["M"]
+  mode_values = ["[.access-always]#Always#"]
+
+  # Add S-mode if S extension is implemented
+  if cfg_arch.ext?(:S)
+    if cfg_arch.ext?(:H)
+      modes << "HS"
+      mode_headers << "HS"
+    else
+      modes << "S"
+      mode_headers << "S"
+    end
+    mode_values << "[.access-#{inst.access['s']}]##{inst.access['s'].capitalize}#"
+  end
+
+  # Add U-mode if U extension is implemented
+  if cfg_arch.ext?(:U)
+    modes << "U"
+    mode_headers << "U"
+    mode_values << "[.access-#{inst.access['u']}]##{inst.access['u'].capitalize}#"
+  end
+
+  # Add virtual modes if H extension is implemented
+  if cfg_arch.ext?(:H)
+    # Always add VS mode when H extension is present
+    modes << "VS"
+    mode_headers << "VS"
+    mode_values << "[.access-#{inst.access['vs']}]##{inst.access['vs'].capitalize}#"
+
+    # Only add VU mode if both H and U extensions are present
+    if cfg_arch.ext?(:U)
+      modes << "VU"
+      mode_headers << "VU"
+      mode_values << "[.access-#{inst.access['vu']}]##{inst.access['vu'].capitalize}#"
+    end
+  end
+
+  # Generate column specification
+  col_spec = "^," * modes.size
+  col_spec = col_spec.chomp(",")
+-%>
+[cols="<%= col_spec %>"]
 |===
-| M | <%- if cfg_arch.ext?(:H) -%>HS<%- else -%>S<%- end -%> | U <%- if cfg_arch.ext?(:H) -%> | VS | VU <%- end -%>
-
-| [.access-always]#Always#
-| [.access-<%=inst.access['s']%>]#<%= inst.access['s'].capitalize %>#
-| [.access-<%=inst.access['u']%>]#<%= inst.access['u'].capitalize %>#
-<% if cfg_arch.ext?(:H) %>
-| [.access-<%=inst.access['vs']%>]#<%= inst.access['vs'].capitalize %>#
-| [.access-<%=inst.access['vu']%>]#<%= inst.access['vu'].capitalize %>#
-<% end %>
+| <%= mode_headers.join(" | ") %>
+
+| <%= mode_values.join("\n| ") %>
 |===
 
 <%- if inst.access_detail? -%>

backends/ext_pdf_doc/tasks.rake

@@ -34,6 +34,7 @@ rule %r{#{$resolver.gen_path}/ext_pdf_doc/.*/pdf/.*_extension\.pdf} => proc { |t
     "-a pdf-theme=#{ENV['THEME']}",
     "-a pdf-fontsdir=#{$root}/ext/docs-resources/fonts",
     "-a imagesdir=#{$root}/ext/docs-resources/images",
+    "-a wavedrom=#{$root}/node_modules/.bin/wavedrom-cli",
     "-r asciidoctor-diagram",
     "-r idl_highlighter",
     "-o #{t.name}",
@@ -62,6 +63,7 @@ rule %r{#{$resolver.gen_path}/ext_pdf_doc/.*/html/.*_extension\.html} => proc {
     "-v",
     "-a toc",
     "-r asciidoctor-diagram",
+    "-a wavedrom=#{$root}/node_modules/.bin/wavedrom-cli",
     "-o #{t.name}",
     adoc_file
   ].join(" ")
@@ -74,7 +76,7 @@ rule %r{#{$resolver.gen_path}/ext_pdf_doc/.*/adoc/.*_extension\.adoc} => proc {
   config_name = Pathname.new(tname).relative_path_from("#{$resolver.gen_path}/ext_pdf_doc").to_s.split("/")[0]
   arch_yaml_paths = Dir.glob("#{$resolver.resolved_spec_path(config_name)}/**/*.yaml")
   cfg_path = $resolver.gen_path / "ext_pdf_doc" / "#{config_name}.yaml"
-  cfg = Udb::AbstractConfig.create(cfg_path)
+  cfg = Udb::AbstractConfig.create(cfg_path, $resolver.cfg_info(config_name))
   arch_yaml_paths += Dir.glob("#{cfg.arch_overlay_abs}/**/*.yaml") unless cfg.arch_overlay.nil?
   [
     (EXT_PDF_DOC_DIR / "templates" / "ext_pdf.adoc.erb").to_s,

backends/ext_pdf_doc/templates/ext_pdf.adoc.erb

@@ -47,7 +47,6 @@
 // Settings
 :experimental:
 :reproducible:
-:wavedrom: <%= $root %>/node_modules/.bin/wavedrom-cli
 // needs to be changed
 :imagesoutdir: images
 :icons: font

backends/manual/templates/instruction.adoc.erb

@@ -116,15 +116,55 @@ RV64::
 <%= inst.fix_entities(inst.defined_by_condition.to_asciidoc) %>
 
 == Access
-[cols="^,^,^,^,^"]
+<%-
+  # Determine which privilege modes to display based on implemented extensions
+  modes = ["M"]  # M-mode is always present
+  mode_headers = ["M"]
+  mode_values = ["[.access-always]#Always#"]
+
+  # Add S-mode if S extension is implemented
+  if cfg_arch.ext?(:S)
+    if cfg_arch.ext?(:H)
+      modes << "HS"
+      mode_headers << "HS"
+    else
+      modes << "S"
+      mode_headers << "S"
+    end
+    mode_values << "[.access-#{inst.access['s']}]##{inst.access['s'].capitalize}#"
+  end
+
+  # Add U-mode if U extension is implemented
+  if cfg_arch.ext?(:U)
+    modes << "U"
+    mode_headers << "U"
+    mode_values << "[.access-#{inst.access['u']}]##{inst.access['u'].capitalize}#"
+  end
+
+  # Add virtual modes if H extension is implemented
+  if cfg_arch.ext?(:H)
+    # Always add VS mode when H extension is present
+    modes << "VS"
+    mode_headers << "VS"
+    mode_values << "[.access-#{inst.access['vs']}]##{inst.access['vs'].capitalize}#"
+
+    # Only add VU mode if both H and U extensions are present
+    if cfg_arch.ext?(:U)
+      modes << "VU"
+      mode_headers << "VU"
+      mode_values << "[.access-#{inst.access['vu']}]##{inst.access['vu'].capitalize}#"
+    end
+  end
+
+  # Generate column specification
+  col_spec = "^," * modes.size
+  col_spec = col_spec.chomp(",")
+-%>
+[cols="<%= col_spec %>"]
 |===
-| M | HS | U | VS | VU
+| <%= mode_headers.join(" | ") %>
 
-| [.access-always]#Always#
-| [.access-<%=inst.access['s']%>]#<%= inst.access['s'].capitalize %>#
-| [.access-<%=inst.access['u']%>]#<%= inst.access['u'].capitalize %>#
-| [.access-<%=inst.access['vs']%>]#<%= inst.access['vs'].capitalize %>#
-| [.access-<%=inst.access['vu']%>]#<%= inst.access['vu'].capitalize %>#
+| <%= mode_values.join("\n| ") %>
 |===
 
 <%- if inst.access_detail? -%>