Rename ArchDef -> ConfiguredArchitecture, ArchDefObj -> DatabaseObject, add Zce

Author: Derek Hower

Rakefile

@@ -19,14 +19,14 @@ end
 
 directory "#{$root}/.stamps"
 
-def arch_def_for(config_name)
+def cfg_arch_for(config_name)
   Rake::Task["#{$root}/.stamps/resolve-#{config_name}.stamp"].invoke
 
-  @arch_defs ||= {}
-  return @arch_defs[config_name] if @arch_defs.key?(config_name)
+  @cfg_archs ||= {}
+  return @cfg_archs[config_name] if @cfg_archs.key?(config_name)
 
-  @arch_defs[config_name] =
-    ArchDef.new(
+  @cfg_archs[config_name] =
+    ConfiguredArchitecture.new(
       config_name,
       $root / "gen" / "resolved_arch" / config_name,
       overlay_path: $root / "cfgs" / config_name / "arch_overlay"
@@ -37,7 +37,7 @@ namespace :gen do
   desc "Generate documentation for the ruby tooling"
   task tool_doc: "#{$root}/.stamps/dev_gems" do
     Dir.chdir($root) do
-      sh "bundle exec yard doc --yardopts arch_def.yardopts"
+      sh "bundle exec yard doc --yardopts cfg_arch.yardopts"
       sh "bundle exec yard doc --yardopts idl.yardopts"
     end
   end
@@ -103,9 +103,7 @@ end
 
 desc "Clean up all generated files"
 task :clean do
-  FileUtils.rm_rf $root / "gen"
-  FileUtils.rm_rf $root / ".stamps"
-  FileUtils.rm_rf $root / ".home"
+  warn "Don't run clean using Rake. Run `./do clean` (alias for `./bin/clean`) instead."
 end
 
 namespace :test do
@@ -124,16 +122,16 @@ namespace :test do
   end
   task idl: ["gen:resolved_arch", "#{$root}/.stamps/resolve-rv32.stamp", "#{$root}/.stamps/resolve-rv64.stamp"]  do
     print "Parsing IDL code for RV32..."
-    arch_def32 = arch_def_for("rv32")
+    cfg_arch32 = cfg_arch_for("rv32")
     puts "done"
 
-    arch_def32.type_check
+    cfg_arch32.type_check
 
     print "Parsing IDL code for RV64..."
-    arch_def64 = arch_def_for("rv64")
+    cfg_arch64 = cfg_arch_for("rv64")
     puts "done"
 
-    arch_def64.type_check
+    cfg_arch64.type_check
 
     puts "All IDL passed type checking"
   end
@@ -143,7 +141,7 @@ def insert_warning(str, from)
   # insert a warning on the second line
   lines = str.lines
   first_line = lines.shift
-  lines.unshift(first_line, "\n# WARNING: This file is auto-generated from #{Pathname.new(from).relative_path_from($root)}\n\n").join("")
+  lines.unshift(first_line, "\n# WARNING: This file is auto-generated from #{Pathname.new(from).relative_path_from($root)}").join("")
 end
 private :insert_warning
 

arch/csr/H/hcounteren.yaml

@@ -1,7 +1,6 @@
 # yaml-language-server: $schema=../../../schemas/csr_schema.json
 
 # WARNING: This file is auto-generated from arch/csr/H/hcounteren.layout
-
 $schema: csr_schema.json#
 kind: csr
 name: hcounteren

arch/csr/I/mcounteren.layout

@@ -80,8 +80,6 @@ description: |
   <%%- end -%>
   .
   <%%- end -%>
-
-
 definedBy: U # actually, defined by RV64, but must implement U-mode for this CSR to exist
 fields:
   CY:

arch/csr/I/mcounteren.yaml

@@ -1,7 +1,6 @@
 # yaml-language-server: $schema=../../schemas/csr_schema.json
 
 # WARNING: This file is auto-generated from arch/csr/I/mcounteren.layout
-
 $schema: csr_schema.json#
 kind: csr
 name: mcounteren
@@ -82,7 +81,6 @@ description: |
   <%- end -%>
   .
   <%- end -%>
-
 definedBy: U # actually, defined by RV64, but must implement U-mode for this CSR to exist
 fields:
   CY:

arch/csr/I/pmpcfgN.layout

@@ -22,39 +22,39 @@ fields:
     base: 64 # upper half doesn't exist in RV32
     <%- end -%>
     description: |
-        *PMP configuration for entry <%= pmpcfg_num*4 + i %>*
+      *PMP configuration for entry <%= pmpcfg_num*4 + i %>*
 
-        The bits are as follows:
+      The bits are as follows:
 
-        [separator="!",%autowidth]
-        !===
-        ! Name ! Location ! Description
+      [separator="!",%autowidth]
+      !===
+      ! Name ! Location ! Description
 
-        h! L ! <%= ((i+1)*8)-1 %>   ! Locks the entry from further modification. Additionally, when set, PMP checks also apply to M-mode for the entry.
-        h! - ! <%= ((i+1)*8)-2 %>:<%= ((i+1)*8)-3 %> ! _Reserved_ Writes shall be ignored.
-        h! A ! <%= ((i+1)*8)-4 %>:<%= ((i+1)*8)-5 %>
-        a! Address matching mode. One of:
+      h! L ! <%= ((i+1)*8)-1 %>   ! Locks the entry from further modification. Additionally, when set, PMP checks also apply to M-mode for the entry.
+      h! - ! <%= ((i+1)*8)-2 %>:<%= ((i+1)*8)-3 %> ! _Reserved_ Writes shall be ignored.
+      h! A ! <%= ((i+1)*8)-4 %>:<%= ((i+1)*8)-5 %>
+      a! Address matching mode. One of:
 
-            [when="PMP_GRANULARITY < 2"]
-            * *OFF* (0) - Null region (disabled)
-            * *TOR* (1) - Top of range
-            * *NA4* (2) - Naturally aligned four-byte region
-            * *NAPOT* (3) - Natrually aligned power of two
+          [when="PMP_GRANULARITY < 2"]
+          * *OFF* (0) - Null region (disabled)
+          * *TOR* (1) - Top of range
+          * *NA4* (2) - Naturally aligned four-byte region
+          * *NAPOT* (3) - Natrually aligned power of two
 
-            [when="PMP_GRANULARITY >= 2"]
-            * *OFF* (0) - Null region (disabled)
-            * *TOR* (1) - Top of range
-            * *NAPOT* (3) - Natrually aligned power of two
+          [when="PMP_GRANULARITY >= 2"]
+          * *OFF* (0) - Null region (disabled)
+          * *TOR* (1) - Top of range
+          * *NAPOT* (3) - Natrually aligned power of two
 
-        [when="PMP_GRANULARITY >= 2"]
-        Naturally aligned four-byte region, *NA4* (2), is not valid (not needed when the PMP granularity is larger than 4 bytes).
+      [when="PMP_GRANULARITY >= 2"]
+      Naturally aligned four-byte region, *NA4* (2), is not valid (not needed when the PMP granularity is larger than 4 bytes).
 
-        h! X ! <%= ((i)*8)+2 %> ! When clear, instruction fetchs cause an `Access Fault` for the matching region and privilege mode.
-        h! W ! <%= ((i)*8)+1 %> ! When clear, stores and AMOs cause an `Access Fault` for the matching region and privilege mode.
-        h! R ! <%= ((i)*8)+0 %> ! When clear, loads cause an `Access Fault` for the matching region and privilege mode.
-        !===
+      h! X ! <%= ((i)*8)+2 %> ! When clear, instruction fetchs cause an `Access Fault` for the matching region and privilege mode.
+      h! W ! <%= ((i)*8)+1 %> ! When clear, stores and AMOs cause an `Access Fault` for the matching region and privilege mode.
+      h! R ! <%= ((i)*8)+0 %> ! When clear, loads cause an `Access Fault` for the matching region and privilege mode.
+      !===
 
-        The combination of R = 0, W = 1 is reserved.
+      The combination of R = 0, W = 1 is reserved.
     type(): |
       if (NUM_PMP_ENTRIES > <%= pmpcfg_num*4 + i %>) {
         return CsrFieldType::RWR;

arch/csr/S/scounteren.yaml

@@ -1,7 +1,6 @@
 # yaml-language-server: $schema=../../schemas/csr_schema.json
 
 # WARNING: This file is auto-generated from arch/csr/S/scounteren.layout
-
 $schema: csr_schema.json#
 kind: csr
 name: scounteren

arch/csr/Zicntr/mcountinhibit.layout

@@ -41,8 +41,8 @@ description: |
 
 definedBy:
   anyOf:
-  - name: Sm
-  - name: Smhpm
+    - name: Sm
+    - name: Smhpm
 fields:
   CY:
     location: 0

arch/csr/Zicntr/mcountinhibit.yaml

@@ -1,7 +1,6 @@
 # yaml-language-server: $schema=../../../schemas/csr_schema.json
 
 # WARNING: This file is auto-generated from arch/csr/Zicntr/mcountinhibit.layout
-
 $schema: csr_schema.json#
 kind: csr
 name: mcountinhibit

arch/csr/Zihpm/mhpmevent10.yaml

@@ -1,6 +1,4 @@
-# WARNING: This file is auto-generated from arch/csr/Zihpm/mhpmeventN.layout
-
-# yaml-language-server: $schema=../../../schemas/csr_schema.json
+# WARNING: This file is auto-generated from arch/csr/Zihpm/mhpmeventN.layout# yaml-language-server: $schema=../../../schemas/csr_schema.json
 
 $schema: csr_schema.json#
 kind: csr

arch/csr/Zihpm/mhpmevent11.yaml

@@ -1,6 +1,4 @@
-# WARNING: This file is auto-generated from arch/csr/Zihpm/mhpmeventN.layout
-
-# yaml-language-server: $schema=../../../schemas/csr_schema.json
+# WARNING: This file is auto-generated from arch/csr/Zihpm/mhpmeventN.layout# yaml-language-server: $schema=../../../schemas/csr_schema.json
 
 $schema: csr_schema.json#
 kind: csr