commit c02b52f6c3ae9a47c974d013f0a9748801a36985
author Rupert Swarbrick <rswarbrick@lowrisc.org> Wed Oct 07 15:34:16 2020 +0100
committer Rupert Swarbrick <rswarbrick@gmail.com> Fri Oct 09 08:16:38 2020 +0100
tree ec1ef3eb69db30cb8017172364e5d3dd5acce65f
parent c6da6a0750bc7b1e0dd0e473f6e3624a88a2fb95

Add hier_path to list of optional keys in validate.py

This adds hier_path as an optional key in validate.py, silencing a
reggen warning. Since we probably don't want to include it in
documentation, this teaches various bits of doc generation to cope
with a "None" index.

Signed-off-by: Rupert Swarbrick <rswarbrick@lowrisc.org>

util/reggen/gen_selfdoc.py

diff --git a/util/reggen/gen_selfdoc.py b/util/reggen/gen_selfdoc.py
index 4248902..8d8b6fa 100644
--- a/util/reggen/gen_selfdoc.py
+++ b/util/reggen/gen_selfdoc.py
@@ -208,11 +208,20 @@
 
 def doc_tbl_line(outfile, key, use, desc):
     if use is not None:
-        genout(
-            outfile, key + " | " + validate.key_use[use] + " | " +
-            validate.val_types[desc[0]][0] + " | " + desc[1] + "\n")
+        desc_key, desc_txt = desc
+        val_type = (validate.val_types[desc_key][0]
+                    if desc_key is not None else None)
     else:
-        genout(outfile, key + " | " + desc + "\n")
+        assert isinstance(desc, str)
+        val_type = None
+        desc_txt = desc
+
+    if val_type is not None:
+        genout(outfile,
+               '{} | {} | {} | {}\n'
+               .format(key, validate.key_use[use], val_type, desc_txt))
+    else:
+        genout(outfile, key + " | " + desc_txt + "\n")
 
 
 def document(outfile):

util/reggen/validate.py

diff --git a/util/reggen/validate.py b/util/reggen/validate.py
index 90c205d..c0ea0f9 100644
--- a/util/reggen/validate.py
+++ b/util/reggen/validate.py
@@ -206,17 +206,18 @@
             error += 1
             log.error(err_prefix + " missing required key " + x)
     for x in obj:
-        type = ''
+        type = None
         if x in required_keys:
             type = required_keys[x][0]
         elif x in optional_keys:
             type = optional_keys[x][0]
         elif x not in added_keys:
             log.warning(err_prefix + " contains extra key " + x)
-        if type[:2] == 'ln':
-            error += check_ln(obj, x, type == 'lnw', err_prefix)
-        if type == 'lp':
-            error += check_lp(obj, x, err_prefix)
+        if type is not None:
+            if type[:2] == 'ln':
+                error += check_ln(obj, x, type == 'lnw', err_prefix)
+            if type == 'lp':
+                error += check_lp(obj, x, err_prefix)
 
     return error
 
@@ -343,7 +344,9 @@
         "Only use this if unable to put this "
         "information in a comment at the top of the "
         "file."
-    ]
+    ],
+    'hier_path': [None,
+                  'additional hierarchy path before the reg block instance']
 }
 top_added = {
     'genrnames': ['pl', "list of register names"],