Changed $copy to be a key and only work with specific strings (right now just the description).

Author: james-ball-qualcomm

arch/csr/mie.yaml

@@ -8,7 +8,8 @@ address: 0x304
 priv_mode: M
 length: MXLEN
 definedBy: Sm
-description: "$copy: mip.yaml#/description"
+description: 
+  $copy: "mip.yaml#/description"
 fields:
   SSIE:
     location: 1

arch/csr/mip.yaml

@@ -6,13 +6,20 @@ name: mip
 long_name: Machine Interrupt Pending
 address: 0x344
 priv_mode: M
+
+# Description is shared with mie CSR (it copies it from here).
 description: |
-  The `mip` register is an MXLEN-bit read/write register containing
-  information on pending interrupts, while `mie` is the corresponding
-  MXLEN-bit read/write register containing interrupt enable bits.
-  Interrupt cause number _i_ (as reported in CSR `mcause`)
-  corresponds with bit _i_ in both `mip` and
-  `mie`. Bits 15:0 are allocated to standard interrupt causes only, while
+  The `mie` and `mip` CSRs are MXLEN-bit read/write registers used when
+  the CLINT or PLIC interrupt controllers are present.
+  Note that the CLINT refers to an interrupt controller
+  used by some RISC-V implementations but isn't a ratified
+  RISC-V International standard.
+  
+  The `mip` CSR contains information on pending interrupts, while `mie` is the corresponding
+  CSR containing interrupt enable bits.
+  Interrupt cause number _i_ (as reported in the `mcause` CSR)
+  corresponds to bit _i_ in both `mip` and `mie`. 
+  Bits 15:0 are allocated to standard interrupt causes only, while
   bits 16 and above are designated for platform use.
 
   NOTE: Interrupts designated for platform use may be designated for custom use

lib/test/test_yaml_loader.rb

@@ -346,9 +346,11 @@ def test_copy_in_the_same_document
 
       obj1:
         target10: abc
-        target11: "$copy: #/$defs/target1"
+        target11: 
+          $copy: "#/$defs/target1"
         target12: def
-        target13: "$copy: #/$defs/target3"
+        target13: 
+          $copy: "#/$defs/target3"
 
     YAML
 
@@ -382,9 +384,11 @@ def test_copy_in_the_different_document
     yaml2 = <<~YAML
       obj1:
         target10: abc
-        target11: "$copy: #{f1_path.basename}#/$defs/target1"
+        target11: 
+          $copy: "#{f1_path.basename}#/$defs/target1"
         target12: def
-        target13: "$copy: #{f1_path.basename}#/$defs/target3"
+        target13: 
+          $copy: "#{f1_path.basename}#/$defs/target3"
     YAML
 
     f2 = Tempfile.new("yml")

lib/yaml_loader.rb

@@ -136,28 +136,27 @@ def self.expand(filename, obj, yaml_opts = {})
       end
 
       final_obj
+    elsif obj.keys.include?("$copy")
+      self.get_copy_target_obj(filename, obj["$copy"], yaml_opts)
     else
       # Go through each hash entry.
       obj.each do |key, value|
-        obj[key] =
-        if value.is_a?(String) && value.start_with?("$copy:")
-          copy_target = value.delete_prefix("$copy:").lstrip
-          self.get_copy_target_obj(filename, copy_target, yaml_opts)
-        else
-          expand(filename, value, yaml_opts)
-        end
+        obj[key] = expand(filename, value, yaml_opts)
       end
       obj
     end
 
-    obj_keys = new_obj.keys
-    if obj_keys.include? "$remove"
-      remove_keys = obj["$remove"].is_a?(Array) ? obj["$remove"] : [obj["$remove"]]
-      remove_keys.each do |key|
-        new_obj.delete(key)
+    if new_obj.is_a?(Hash)
+      obj_keys = new_obj.keys
+      if obj_keys.include? "$remove"
+        remove_keys = obj["$remove"].is_a?(Array) ? obj["$remove"] : [obj["$remove"]]
+        remove_keys.each do |key|
+          new_obj.delete(key)
+        end
       end
+      new_obj.delete("$remove")
     end
-    new_obj.delete("$remove")
+
     new_obj
   end
 

schemas/csr_schema.json

@@ -193,8 +193,23 @@
           "description": "Descriptive name for the CSR"
         },
         "description": {
-          "type": "string",
-          "description": "A full Asciidoc description of the CSR, intended to be used as documentation."
+          "oneOf": [ 
+            {
+              "type": "string",
+              "description": "A full Asciidoc description of the CSR, intended to be used as documentation."
+            },
+            {
+              "type": "object",
+              "description": "A full Asciidoc description of the CSR, intended to be used as documentation.",
+              "properties": {
+                  "$copy" : {
+                      "type": "string",
+                      "format": "uri-reference"
+                  }
+                },
+              "additionalProperties": false
+            }
+          ]
         },
         "definedBy": {
           "$ref": "schema_defs.json#/$defs/requires_entry",