Add generator for capstone

Author: cmd05

backends/generators/tasks.rake

@@ -1,13 +1,17 @@
+# typed: false
 # frozen_string_literal: true
 
 require "udb/resolver"
-require 'json'
-require 'tempfile'
+require "json"
+require "tempfile"
 
 directory "#{$root}/gen/go"
 directory "#{$root}/gen/c_header"
 directory "#{$root}/gen/sverilog"
 
+UDB_CAPSTONE_DIR = "#{$root}/tools/python-packages/udb-capstone"
+directory UDB_CAPSTONE_DIR
+
 def with_resolved_exception_codes(cfg_arch)
   # Process ERB templates in exception codes using Ruby ERB processing
   resolved_exception_codes = []
@@ -127,4 +131,28 @@ namespace :gen do
          "--output=#{output_dir}riscv_decode_package.svh --include-all"
     end
   end
+
+  desc <<~DESC
+    Generate Capstone CSR switch from RISC-V CSR definitions
+
+    Options:
+     * CONFIG - Configuration name (defaults to "_")
+     * OUTPUT_DIR - Output directory for generated Capstone code (defaults to "#{$root}/gen/capstone/")
+  DESC
+  task capstone: "#{$root}/gen/capstone/" do
+    config_name = ENV["CONFIG"] || "_"
+    output_dir = ENV["OUTPUT_DIR"] || "#{$root}/gen/capstone/"
+
+    # Ensure the output directory exists
+    FileUtils.mkdir_p output_dir
+
+    # Get the arch paths based on the config
+    resolver = Udb::Resolver.new
+    cfg_arch = resolver.cfg_arch_for(config_name)
+    inst_dir = cfg_arch.path / "inst"
+    csr_dir = cfg_arch.path / "csr"
+
+    # Run the Capstone CSR switch generator Python script
+    sh "#{$root}/.home/.venv/bin/python3 #{UDB_CAPSTONE_DIR}/generate_csr_switch.py --csr-dir=#{csr_dir} --arch=BOTH --output=#{output_dir}csr_switch.c"
+  end
 end

tools/python-packages/udb-capstone/generate_csr_switch.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+
+# Copyright (c) Salil Mittal
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+"""
+Generate a C function mapping RISC-V CSR numbers to names using a switch statement.
+"""
+
+import sys
+import os
+
+# Import functions from generator.py
+generator_dir = os.path.abspath(
+    os.path.join(os.path.dirname(__file__), "../../../backends/generators")
+)
+sys.path.append(generator_dir)
+from generator import load_csrs
+
+
+def generate_csr_switch(csrs, output_file):
+    with open(output_file, "w", encoding="utf-8") as f:
+        fn_str = "/* SP" + "DX-License-Identifier: BSD-3-Clause */" + '"'
+        fn_str = """
+ /* Copyright (c) 2025 RISC-V International */
+ /*
+  * This file is auto-generated by riscv-unified-db
+  */
+static const char *getCSRSystemRegisterName(unsigned CsrNo)
+{
+	switch (CsrNo) {
+"""
+        for addr, name in sorted(csrs.items()):
+            fn_str += f'\tcase 0x{addr:04x}:\n\t\treturn "{name.lower()}";\n'
+
+        fn_str += """	}
+	return NULL;
+}
+"""
+        f.write(fn_str)
+
+
+def main():
+    import argparse
+
+    parser = argparse.ArgumentParser(description="Generate C switch for RISC-V CSRs")
+    parser.add_argument(
+        "--csr-dir",
+        default=os.path.abspath(
+            os.path.join(os.path.dirname(__file__), "../../../arch/csr/")
+        ),
+        help="Directory containing CSR YAML files",
+    )
+    parser.add_argument(
+        "--extensions",
+        default="",
+        help="Comma-separated list of enabled extensions (default: all)",
+    )
+    parser.add_argument(
+        "--arch",
+        default="BOTH",
+        choices=["RV32", "RV64", "BOTH"],
+        help="Target architecture (RV32, RV64, BOTH)",
+    )
+    parser.add_argument(
+        "--output",
+        default=os.path.join(os.path.dirname(__file__), "csr_switch.c"),
+        help="Output C file name",
+    )
+    args = parser.parse_args()
+
+    enabled_extensions = (
+        [ext.strip() for ext in args.extensions.split(",") if ext.strip()]
+        if args.extensions
+        else []
+    )
+    include_all = not enabled_extensions
+    csrs = load_csrs(args.csr_dir, enabled_extensions, include_all, args.arch)
+
+    generate_csr_switch(csrs, args.output)
+    print(f"Generated: {args.output}")
+
+
+if __name__ == "__main__":
+    main()