Move field descriptions to a config file.

Author: qwandor

Cargo.lock

@@ -16,4 +16,6 @@ clap = { version = "4.5.51", features = ["derive"] }
 eyre = "0.6.12"
 log = "0.4.28"
 pretty_env_logger = "0.5.0"
+serde = { version = "1.0.228", features = ["derive"] }
 serde_json = "1.0.145"
+toml = "0.9.8"

generate-sysregs/Cargo.toml

@@ -0,0 +1,60 @@
+[registers.ICC_SRE_EL2]
+
+[registers.SCR_EL3.field_descriptions]
+NS = "Non-secure."
+IRQ = "Take physical IRQs at EL3."
+FIQ = "Take physical FIQs at EL3."
+EA = "Take external abort and SError exceptions at EL3."
+SMD = "Disable SMC instructions."
+HCE = "Enable HVC instructions."
+SIF = "Disable execution from non-secure memory."
+RW = "Enable AArch64 in lower ELs."
+ST = "Trap physical secure timer to EL3."
+TWI = "Trap WFI to EL3."
+TWE = "Trap WFE to EL3."
+TLOR = "Trap LOR register access to EL3."
+TERR = "Trap error record register access to EL3."
+APK = "Don't trap PAC key registers to EL3."
+API = "Don't trap PAuth instructions to EL3."
+EEL2 = "Enable Secure EL2."
+EASE = "Synchronous external aborts are taken as SErrors."
+NMEA = "Take SError exceptions at EL3."
+FIEN = "Enable fault injection at lower ELs."
+TID3 = "Trap ID group 3 registers to EL3."
+TID5 = "Trap ID group 5 register to EL3."
+EnSCXT = "Enable SCXT at lower ELs."
+ATA = "Enable memory tagging at lower ELs."
+FGTEn = "Enable fine-grained traps to EL2."
+ECVEn = "Enable access to CNTPOFF_EL2."
+TWEDEn = "Enable a configurable delay for WFE traps."
+TME = "Enable access to TME at lower ELs."
+AMVOFFEN = "Enable acivity monitors virtual offsets."
+EnAS0 = "Enable ST64BV0 at lower ELs."
+ADEn = "Enable ACCDATA_EL1 at lower ELs."
+HXEn = "Enable HCRX_EL2."
+GCSEn = "Enable gaurded control stack."
+TRNDR = "Trap RNDR and RNDRRS to EL3."
+EnTP2 = "Enable TPIDR2_EL0 at lower ELs."
+RCWMASKEn = "Enable RCW and RCWS mask registers at lower ELs."
+TCR2En = "Enable TCR2_ELx registers at lower ELs."
+SCTLR2En = "Enable SCTLR2_ELx rogisters at lower ELs."
+PIEn = "Enable permission indirection and overlay registers at lower ELs."
+AIEn = "Enable MAIR2_ELx and AMAIR2_ELx at lower ELs."
+D128En = "Enable 128-bit system registers at  lower ELs."
+GPF = "Route GPFs to EL3."
+MECEn = "Enable MECID registers at EL2."
+EnFPM = "Enable access to FPMR at lower ELs."
+TMEA = "Take synchronous external abort and physical SError exception to EL3."
+TWERR = "Trap writes to Error Record registers to EL3."
+PFAREn = "Enable access to physical fault address registers at lower ELs."
+SRMASKEn = "Enable access to mask registers at lower ELs."
+EnIDCP128 = "Enable implementation-defined 128-bit system registers."
+DSE = "A delegated SError exception is pending."
+EnDSE = "Enable delegated SError exceptions."
+FGTEn2 = "Enable fine-grained traps to EL2."
+HDBSSEn = "Enable HDBSSBR_EL2 and HDBSSPROD_EL2 registers at EL2."
+HACDBSEn = "Enable HACDBSBR_EL2 and HACDBSCONS_EL2 registers at EL2."
+NSE = "Non-secure realm world bit."
+
+[registers.CLIDR_EL1.field_descriptions]
+LoC = "Level of Coherence for the cache hierarchy."

generate-sysregs/registers.toml

@@ -0,0 +1,29 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use serde::{Deserialize, Serialize};
+use std::collections::BTreeMap;
+
+#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct Config {
+    pub registers: BTreeMap<String, RegisterConfig>,
+}
+
+#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct RegisterConfig {
+    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
+    pub field_descriptions: BTreeMap<String, String>,
+}