feat: add GPR Information to UDB

spec/schemas/register_file_schema.json

@@ -0,0 +1,123 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+
+  "title": "Register File Schema",
+  "description": "Schema for describing a register file",
+
+  "$defs": {
+    "register_entry": {
+      "type": "object",
+      "required": ["name"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "$ref": "schema_defs.json#/$defs/register_name"
+        },
+        "abi_mnemonics": {
+          "type": "array",
+          "items": {
+            "$ref": "schema_defs.json#/$defs/register_alias"
+          },
+          "minItems": 1,
+          "uniqueItems": true,
+          "description": "ABI mnemonic names for the register"
+        },
+        "description": {
+          "$ref": "schema_defs.json#/$defs/spec_text"
+        },
+        "when": {
+          "$ref": "schema_defs.json#/$defs/requires_entry"
+        },
+        "arch_read()": {
+          "type": "string",
+          "description": "Function describing the architecturally defined read behavior. Use this for architecturally mandated effects (e.g., x0 always reads as zero)."
+        },
+        "arch_write(value)": {
+          "type": "string",
+          "description": "Function describing the architecturally defined write behavior. Given a 'value', return the architecturally required result (e.g., x0 ignores writes and always yields zero)."
+        },
+        "caller_saved": {
+          "type": "boolean",
+          "default": false,
+          "description": "Whether the register is caller-saved"
+        },
+        "callee_saved": {
+          "type": "boolean",
+          "default": false,
+          "description": "Whether the register is callee-saved"
+        },
+        "roles": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "zero",
+              "return_address",
+              "stack_pointer",
+              "global_pointer",
+              "thread_pointer",
+              "frame_pointer",
+              "return_value",
+              "argument",
+              "temporary"
+            ]
+          },
+          "uniqueItems": true
+        }
+      }
+    },
+    "register_file": {
+      "type": "object",
+      "required": [
+        "$schema",
+        "kind",
+        "name",
+        "long_name",
+        "description",
+        "register_length",
+        "registers"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "$schema": {
+          "format": "uri-reference",
+          "const": "register_file_schema.json#",
+          "description": "Path to schema, relative to <UDB ROOT>/schemas"
+        },
+        "kind": {
+          "const": "register_file"
+        },
+        "name": {
+          "$ref": "schema_defs.json#/$defs/register_file_name"
+        },
+        "long_name": {
+          "type": "string"
+        },
+        "description": {
+          "$ref": "schema_defs.json#/$defs/spec_text"
+        },
+        "definedBy": {
+          "$ref": "schema_defs.json#/$defs/requires_entry"
+        },
+        "register_class": {
+          "type": "string",
+          "enum": ["general_purpose", "floating_point", "vector"]
+        },
+        "register_length": {
+          "$ref": "schema_defs.json#/$defs/bit_length_value"
+        },
+        "registers": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/register_entry"
+          }
+        },
+        "$source": {
+          "type": "string",
+          "format": "uri-reference"
+        }
+      }
+    }
+  }
+}

spec/schemas/schema_defs.json

@@ -43,6 +43,35 @@
       ],
       "description": "Location of a field in a register"
     },
+    "bit_length_value": {
+      "description": "Bit width value for a register or field",
+      "oneOf": [
+        {
+          "type": "integer",
+          "minimum": 1
+        },
+        {
+          "type": "string",
+          "minLength": 1,
+          "enum": ["MXLEN", "FLEN", "VLEN"]
+        }
+      ]
+    },
+    "register_name": {
+      "type": "string",
+      "pattern": "^[A-Za-z][A-Za-z0-9_.-]*$",
+      "description": "Register name"
+    },
+    "register_file_name": {
+      "type": "string",
+      "pattern": "^[A-Z]$",
+      "description": "Register file name"
+    },
+    "register_alias": {
+      "type": "string",
+      "pattern": "^[A-Za-z][A-Za-z0-9_.-]*$",
+      "description": "Register alias or ABI mnemonic"
+    },
     "possibly_split_field_location": {
       "description": "Location specifier for a field",
       "oneOf": [

spec/std/isa/README.adoc

@@ -29,8 +29,8 @@ Three standard configs are present:
  * `rv64`: A configuration where only `MXLEN` is known to be 64, i.e., the RV64 ISA.
 
 The architecture is specified in a series of https://en.wikipedia.org/wiki/YAML[YAML]
-files for _Extensions_, _Instructions_, and _Control and Status Registers (CSRs)_.
-Each extension/instruction/CSR has its own file.
+files for _Extensions_, _Instructions_, _RegFiles_, and _Control and Status Registers (CSRs)_.
+Each extension/instruction/regfile/CSR has its own file.
 
 == Flow
 
@@ -142,6 +142,40 @@ H: # <1>
 
 === Instructions
 
+=== Register Files
+
+.Example register file specification
+[source,yaml]
+----
+$schema: register_file_schema.json#
+kind: register_file
+name: X
+long_name: Integer General Purpose Registers
+definedBy: I
+register_class: general_purpose
+register_length: MXLEN # <1>
+registers:
+  - name: x0    # <2>
+    abi_mnemonics: [zero] # <3>
+    roles: [zero]
+    arch_read(): | # <4>
+      return 0;
+    arch_write(value): |
+      # x0 ignores all writes
+  - name: x1
+    abi_mnemonics: [ra]
+    roles: [return_address]
+  - name: x8
+    abi_mnemonics: [s0, fp] # <5>
+    roles: [callee_saved, frame_pointer]
+----
+
+<1> The registers in a register file have identical fixed widths, either an explicit width or from a parameter (e.g. MXLEN or VLEN).
+<2> Each register has a unique name (e.g., x0, x1, x2, etc.). The register's index is inferred from its position in the array (starting from 0).
+<3> Registers can optionally have ABI mnemonics (e.g., ra, sp, fp, etc.).
+<4> Individual registers can define `arch_read()` and `arch_write()` for architecturally mandated behavior (e.g., x0 hardwired to zero).
+<5> A register can have multiple ABI mnemonics (e.g., x8 is known as both s0 and fp).
+
 [source,yaml]
 ----
 add: # <1>

spec/std/isa/register_file/F.yaml

@@ -0,0 +1,165 @@
+# Copyright (c) Animesh Agarwal
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# yaml-language-server: $schema=../../../../schemas/register_file_schema.json
+
+$schema: register_file_schema.json#
+kind: register_file
+name: F
+long_name: Floating-Point Registers
+description: |
+  The 'F' register file contains the 32 floating-point registers used by
+  RISC-V floating-point extensions. Each register stores FLEN bits of state and
+  participates in the standard calling convention defined by the RISC-V ABI spec.
+definedBy: F
+register_class: floating_point
+register_length: FLEN
+registers:
+  - name: f0
+    abi_mnemonics: [ft0]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f1
+    abi_mnemonics: [ft1]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f2
+    abi_mnemonics: [ft2]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f3
+    abi_mnemonics: [ft3]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f4
+    abi_mnemonics: [ft4]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f5
+    abi_mnemonics: [ft5]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f6
+    abi_mnemonics: [ft6]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f7
+    abi_mnemonics: [ft7]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f8
+    abi_mnemonics: [fs0]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f9
+    abi_mnemonics: [fs1]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f10
+    abi_mnemonics: [fa0]
+    caller_saved: true
+    roles: [argument, return_value]
+    description: Floating-point argument / return value register 0.
+  - name: f11
+    abi_mnemonics: [fa1]
+    caller_saved: true
+    roles: [argument, return_value]
+    description: Floating-point argument / return value register 1.
+  - name: f12
+    abi_mnemonics: [fa2]
+    caller_saved: true
+    roles: [argument]
+    description: Floating-point argument register 2.
+  - name: f13
+    abi_mnemonics: [fa3]
+    caller_saved: true
+    roles: [argument]
+    description: Floating-point argument register 3.
+  - name: f14
+    abi_mnemonics: [fa4]
+    caller_saved: true
+    roles: [argument]
+    description: Floating-point argument register 4.
+  - name: f15
+    abi_mnemonics: [fa5]
+    caller_saved: true
+    roles: [argument]
+    description: Floating-point argument register 5.
+  - name: f16
+    abi_mnemonics: [fa6]
+    caller_saved: true
+    roles: [argument]
+    description: Floating-point argument register 6.
+  - name: f17
+    abi_mnemonics: [fa7]
+    caller_saved: true
+    roles: [argument]
+    description: Floating-point argument register 7.
+  - name: f18
+    abi_mnemonics: [fs2]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f19
+    abi_mnemonics: [fs3]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f20
+    abi_mnemonics: [fs4]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f21
+    abi_mnemonics: [fs5]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f22
+    abi_mnemonics: [fs6]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f23
+    abi_mnemonics: [fs7]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f24
+    abi_mnemonics: [fs8]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f25
+    abi_mnemonics: [fs9]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f26
+    abi_mnemonics: [fs10]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f27
+    abi_mnemonics: [fs11]
+    callee_saved: true
+    description: Callee-saved floating-point register.
+  - name: f28
+    abi_mnemonics: [ft8]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f29
+    abi_mnemonics: [ft9]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f30
+    abi_mnemonics: [ft10]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.
+  - name: f31
+    abi_mnemonics: [ft11]
+    caller_saved: true
+    roles: [temporary]
+    description: Caller-saved temporary register.