[racl,racl_ctrl,doc] Allow description for RACL policies

Signed-off-by: David Schrammel <[email protected]>
lowRISC · Feb 13, 2025 · 3834170 · 3834170
1 parent eedd585
commit 3834170
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 18 deletions.
diff --git a/hw/ip_templates/racl_ctrl/README.md b/hw/ip_templates/racl_ctrl/README.md
@@ -35,19 +35,19 @@ racl_mappings: {
   }
   policies: {
     Null: [
-      // Standard policies allowing all roles to access a register
       { name: "ALL_RD_WR"
+        desc: "Standard policies allowing all roles to access a register"
         allowed_rd: [ "ROT", "ROLE1", "SOC" ]
         allowed_wr: [ "ROT", "ROLE1", "SOC" ]
       }
-      // Standard policies allowing only the ROT role to access a register
       { name: "ROT_PRIVATE"
+        desc: "Standard policies allowing only the ROT role to access a register"
         rot_private: true
         allowed_rd: [ "ROT" ]
         allowed_wr: [ "ROT" ]
       }
-      // Custom policy
       { name: "SOC_ROT"
+        desc: "Custom policy"
         allowed_rd: [ "ROT", "SOC" ]
         allowed_wr: [ "ROT", "SOC" ]
       }

diff --git a/hw/top_darjeeling/data/autogen/top_darjeeling.gen.hjson b/hw/top_darjeeling/data/autogen/top_darjeeling.gen.hjson
@@ -17728,6 +17728,7 @@
       [
         {
           name: ALL_RD_WR
+          desc: Standard policies allowing all roles to access a register
           allowed_rd:
           [
             ROT
@@ -17746,6 +17747,7 @@
         {
           name: ROT_PRIVATE
           rot_private: true
+          desc: Standard policies allowing only the ROT role to access a register
           allowed_rd:
           [
             ROT
@@ -17759,6 +17761,7 @@
         }
         {
           name: SOC_ROT
+          desc: Custom policy
           allowed_rd:
           [
             ROT

diff --git a/hw/top_darjeeling/data/racl/racl.hjson b/hw/top_darjeeling/data/racl/racl.hjson
@@ -18,19 +18,19 @@
   }
   policies: {
     Null: [
-      // Standard policies allowing all roles to access a register
       { name: "ALL_RD_WR"
+        desc: "Standard policies allowing all roles to access a register"
         allowed_rd: [ "ROT", "ROLE1", "SOC" ]
         allowed_wr: [ "ROT", "ROLE1", "SOC" ]
       }
-      // Standard policies allowing only the ROT role to access a register
       { name: "ROT_PRIVATE"
         rot_private: true
+        desc: "Standard policies allowing only the ROT role to access a register"
         allowed_rd: [ "ROT" ]
         allowed_wr: [ "ROT" ]
       }
-      // Custom policy
       { name: "SOC_ROT"
+        desc: "Custom policy"
         allowed_rd: [ "ROT", "SOC" ]
         allowed_wr: [ "ROT", "SOC" ]
       }

diff --git a/hw/top_darjeeling/ip_autogen/racl_ctrl/README.md b/hw/top_darjeeling/ip_autogen/racl_ctrl/README.md
@@ -35,19 +35,19 @@ racl_mappings: {
   }
   policies: {
     Null: [
-      // Standard policies allowing all roles to access a register
       { name: "ALL_RD_WR"
+        desc: "Standard policies allowing all roles to access a register"
         allowed_rd: [ "ROT", "ROLE1", "SOC" ]
         allowed_wr: [ "ROT", "ROLE1", "SOC" ]
       }
-      // Standard policies allowing only the ROT role to access a register
       { name: "ROT_PRIVATE"
+        desc: "Standard policies allowing only the ROT role to access a register"
         rot_private: true
         allowed_rd: [ "ROT" ]
         allowed_wr: [ "ROT" ]
       }
-      // Custom policy
       { name: "SOC_ROT"
+        desc: "Custom policy"
         allowed_rd: [ "ROT", "SOC" ]
         allowed_wr: [ "ROT", "SOC" ]
       }

diff --git a/hw/top_darjeeling/ip_autogen/racl_ctrl/data/top_darjeeling_racl_ctrl.ipconfig.hjson b/hw/top_darjeeling/ip_autogen/racl_ctrl/data/top_darjeeling_racl_ctrl.ipconfig.hjson
@@ -14,6 +14,7 @@
     [
       {
         name: ALL_RD_WR
+        desc: Standard policies allowing all roles to access a register
         allowed_rd:
         [
           ROT
@@ -32,6 +33,7 @@
       {
         name: ROT_PRIVATE
         rot_private: true
+        desc: Standard policies allowing only the ROT role to access a register
         allowed_rd:
         [
           ROT
@@ -45,6 +47,7 @@
       }
       {
         name: SOC_ROT
+        desc: Custom policy
         allowed_rd:
         [
           ROT

diff --git a/hw/top_darjeeling/ip_autogen/racl_ctrl/doc/racl_configuration.md b/hw/top_darjeeling/ip_autogen/racl_ctrl/doc/racl_configuration.md
@@ -5,11 +5,11 @@
 
 ### RACL group: Null
 
-| Policy Name   |   Index |
-|:--------------|--------:|
-| ALL_RD_WR     |       0 |
-| ROT_PRIVATE   |       1 |
-| SOC_ROT       |       2 |
+| Policy Name   |   Index | Description                                                       |
+|:--------------|--------:|:------------------------------------------------------------------|
+| ALL_RD_WR     |       0 | Standard policies allowing all roles to access a register         |
+| ROT_PRIVATE   |       1 | Standard policies allowing only the ROT role to access a register |
+| SOC_ROT       |       2 | Custom policy                                                     |
 
 
 ## RACL configuration

diff --git a/util/raclgen/lib.py b/util/raclgen/lib.py
@@ -270,14 +270,13 @@ def gen_md_header(racl_config: Dict[str, object], output: TextIO = sys.stdout):
     output.write(title('RACL groups', 2))
     output.write('\n')
 
-    header = ['Policy Name', 'Index']
+    header = ['Policy Name', 'Index', 'Description']
 
     for racl_group in racl_config['policies']:
         policies_for_racl_group = racl_config['policies'][racl_group]
-        policy_names = [policy['name'] for policy in policies_for_racl_group]
         rows: List[List[str]] = []
-        for policy_idx, policy_name in enumerate(policy_names):
-            rows.append([policy_name, str(policy_idx)])
+        for policy_idx, policy in enumerate(policies_for_racl_group):
+            rows.append([policy['name'], str(policy_idx), policy.get('desc', '')])
 
         output.write(title(f'RACL group: {racl_group}', 3))
         output.write(table(header, rows))