JSONschema and python improvements

silabs-ArchanaM · silabs-ArchanaM · commit cc1122ab09e2 · 2022-02-27T12:01:54.000+05:30
* JSON Schema manually updated to be more semantically valid.
* Python script improved to be more verbose with exceptions
* Templating file improved by adding an additional macro.

Signed-off-by: Archana &lt;archana.madhavan@silabs.com&gt;
diff --git a/scripts/data_files/driver_jsons/driver_opaque_schema.json b/scripts/data_files/driver_jsons/driver_opaque_schema.json
@@ -2,25 +2,31 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "properties": {
-    "prefix": {
+    "_comment": {
       "type": "string"
     },
+    "prefix": {
+      "type": "string",
+      "pattern": "^[A-Z_a-z][0-9A-Z_a-z]*$"
+    },
     "type": {
-      "type": "string"
+      "type": "string",
+      "enum": ["opaque","transparent"]
     },
     "location": {
-      "type": "string"
+      "type": "string",
+      "pattern": "^(0x|0X)?[a-fA-F0-9]+$"
     },
-    "dependency": {
+    "mbedtls/h_depend_on": {
       "type": "string"
     },
     "headers": {
       "type": "array",
-      "items": [
-        {
+      "items": {
           "type": "string"
-        }
-      ]
+        },
+        "minItems": 1,
+        "uniqueItems": true
     },
     "capabilities": {
       "type": "array",
@@ -31,71 +37,33 @@
             "_comment": {
               "type": "string"
             },
-            "depend_on": {
-              "type": "string"
-            },
-            "entry_points": {
-              "type": "array",
-              "items": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "string"
-                }
-              ]
-            }
-          },
-          "required": [
-            "_comment",
-            "depend_on",
-            "entry_points"
-          ]
-        },
-        {
-          "type": "object",
-          "properties": {
-            "_comment": {
-              "type": "string"
-            },
-            "depend_on": {
+            "mbedtls/c_depend_on": {
               "type": "string"
             },
             "entry_points": {
               "type": "array",
-              "items": [
-                {
-                  "type": "string"
+              "items": {
+                  "type": "string",
+                  "enum": ["import_key", "export_key", "export_public_key",
+                          "copy_key", "get_builtin_key"]
                 },
-                {
-                  "type": "string"
-                }
-              ]
+                "minItems": 1,
+                "uniqueItems": true
             },
             "name": {
               "type": "object",
-              "properties": {
-                "copy_key": {
-                  "type": "string"
-                },
-                "get_builtin_key": {
-                  "type": "string"
+              "patternProperties": {
+                "^[A-Z_a-z][0-9A-Z_a-z]*$": {
+                  "type": "string",
+                  "pattern": "^[A-Z_a-z][0-9A-Z_a-z]*$"
                 }
               },
-              "required": [
-                "copy_key",
-                "get_builtin_key"
-              ]
+                "minItems": 1,
+                "uniqueItems": true
             }
           },
           "required": [
-            "_comment",
-            "depend_on",
-            "entry_points",
-            "name"
+            "entry_points"
           ]
         }
       ]
@@ -105,8 +73,6 @@
     "prefix",
     "type",
     "location",
-    "dependency",
-    "headers",
     "capabilities"
   ]
 }
diff --git a/scripts/data_files/driver_jsons/driver_transparent_schema.json b/scripts/data_files/driver_jsons/driver_transparent_schema.json
@@ -2,22 +2,27 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "properties": {
-    "prefix": {
+    "_comment": {
       "type": "string"
     },
+    "prefix": {
+      "type": "string",
+      "pattern": "^[A-Z_a-z][0-9A-Z_a-z]*$"
+    },
     "type": {
-      "type": "string"
+      "type": "string",
+      "enum": ["opaque","transparent"]
     },
-    "dependency": {
+    "mbedtls/h_depend_on": {
       "type": "string"
     },
     "headers": {
       "type": "array",
-      "items": [
-        {
+      "items": {
           "type": "string"
-        }
-      ]
+        },
+        "minItems": 1,
+        "uniqueItems": true
     },
     "capabilities": {
       "type": "array",
@@ -28,79 +33,46 @@
             "_comment": {
               "type": "string"
             },
-            "depend_on": {
+            "mbedtls/c_depend_on": {
               "type": "string"
             },
             "entry_points": {
               "type": "array",
-              "items": [
-                {
-                  "type": "string"
+              "items": {
+                  "type": "string",
+                  "enum": ["import_key", "export_key", "export_public_key",
+                          "copy_key", "get_builtin_key"]
                 },
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "fallback": {
-              "type": "boolean"
-            }
-          },
-          "required": [
-            "_comment",
-            "depend_on",
-            "entry_points",
-            "fallback"
-          ]
-        },
-        {
-          "type": "object",
-          "properties": {
-            "_comment": {
-              "type": "string"
-            },
-            "depend_on": {
-              "type": "string"
-            },
-            "entry_points": {
-              "type": "array",
-              "items": [
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "fallback": {
-              "type": "boolean"
+                "minItems": 1,
+                "uniqueItems": true
             },
             "name": {
               "type": "object",
-              "properties": {
-                "export_public_key": {
-                  "type": "string"
+              "patternProperties": {
+                "^[A-Z_a-z][0-9A-Z_a-z]*$": {
+                  "type": "string",
+                  "pattern": "^[A-Z_a-z][0-9A-Z_a-z]*$"
                 }
               },
-              "required": [
-                "export_public_key"
-              ]
+                "minItems": 1,
+                "uniqueItems": true
+            },
+            "fallback": {
+              "type": "boolean",
+              "default": "false"
             }
           },
           "required": [
-            "_comment",
-            "depend_on",
-            "entry_points",
-            "fallback",
-            "name"
+            "entry_points"
           ]
         }
-      ]
+      ],
+      "default": []
     }
   },
   "required": [
     "prefix",
     "type",
-    "dependency",
-    "headers",
     "capabilities"
   ]
 }
diff --git a/scripts/data_files/driver_jsons/mbedtls_test_opaque_driver.json b/scripts/data_files/driver_jsons/mbedtls_test_opaque_driver.json
@@ -2,18 +2,18 @@
     "prefix":       "mbedtls_test",
     "type":         "opaque",
     "location":     "0x7fffff",
-    "dependency":   "defined(PSA_CRYPTO_DRIVER_TEST)",
+    "mbedtls/h_depend_on":   "defined(PSA_CRYPTO_DRIVER_TEST)",
     "headers":      ["test/drivers/test_driver.h"],
     "capabilities": [
         {
-            "_comment":     "The mbedTLS opaque driver supports import key/export key/export_public key",
-            "depend_on":    "defined(PSA_CRYPTO_DRIVER_TEST)",
+            "_comment":     "The Mbed TLS opaque driver supports import key/export key/export_public key",
+            "mbedtls/c_depend_on":    "defined(PSA_CRYPTO_DRIVER_TEST)",
             "entry_points": ["import_key", "export_key", "export_public_key"]
         },
         {
-            "_comment":     "The mbedTLS opaque driver supports copy key/ get builtin key",
-            "depend_on":    "defined(PSA_CRYPTO_DRIVER_TEST)",
-            "entry_points": ["copy_key","get_builtin_key"],
+            "_comment":     "The Mbed TLS opaque driver supports copy key/ get builtin key",
+            "mbedtls/c_depend_on":    "defined(PSA_CRYPTO_DRIVER_TEST)",
+            "entry_points": ["copy_key", "get_builtin_key", "init"],
             "name":         {"copy_key":"mbedtls_test_opaque_copy_key", "get_builtin_key":"mbedtls_test_opaque_get_builtin_key"}
         }
      ]
diff --git a/scripts/data_files/driver_jsons/mbedtls_test_transparent_driver.json b/scripts/data_files/driver_jsons/mbedtls_test_transparent_driver.json
@@ -1,18 +1,18 @@
 {
     "prefix":       "mbedtls_test",
     "type":         "transparent",
-    "dependency":   "defined(PSA_CRYPTO_DRIVER_TEST)",
+    "mbedtls/h_depend_on":   "defined(PSA_CRYPTO_DRIVER_TEST)",
     "headers":      ["test/drivers/test_driver.h"],
     "capabilities": [
         {
-            "_comment":     "The mbedTLS transparent driver supports import key/export key",
-            "depend_on":    "defined(PSA_CRYPTO_DRIVER_TEST)",
+            "_comment":     "The Mbed TLS transparent driver supports import key/export key",
+            "mbedtls/c_depend_on":    "defined(PSA_CRYPTO_DRIVER_TEST)",
             "entry_points": ["import_key", "export_key"],
             "fallback":     true
         },
         {
-            "_comment":     "The mbedTLS transparent driver supports export_public key",
-            "depend_on":    "defined(PSA_CRYPTO_DRIVER_TEST)",
+            "_comment":     "The Mbed TLS transparent driver supports export_public key",
+            "mbedtls/c_depend_on":    "defined(PSA_CRYPTO_DRIVER_TEST)",
             "entry_points": ["export_public_key"],
             "fallback":     true,
             "name":         {"export_public_key":"mbedtls_test_transparent_export_public_key"}
diff --git a/scripts/data_files/driver_templates/OS-template-opaque.jinja b/scripts/data_files/driver_templates/OS-template-opaque.jinja
@@ -1,13 +1,16 @@
+{# One Shot function's dispatch code for opaque drivers.
+Expected inputs:
+* drivers: the list of driver descriptions.
+* entry_point: the name of the entry point that this function dispatches to.
+* entry_point_param(driver): the parameters to pass to the entry point.
+* nest_indent: number of extra spaces to indent the code to.
+-#}
 {% for driver in drivers if driver.type == "opaque" -%}
 {% for capability in driver.capabilities if entry_point in capability.entry_points -%}
-#if ({% if capability.depend_on is defined -%}{{ capability.depend_on }} {% else -%} {{ 1 }} {% endif %})
+#if ({% if capability['mbedtls/c_depend_on'] is defined -%}{{ capability['mbedtls/c_depend_on'] }} {% else -%} {{ 1 }} {% endif %})
 {%- filter indent(width = nest_indent) %}
 case {{ driver.location }}:
-    {% if capability.name is defined and entry_point in capability.name.keys() -%}
-    return({{ capability.name[entry_point]}}({{entry_point_attributes(driver) | indent(20)}}));
-    {% else -%}
-    return({{driver.prefix}}_{{driver.type}}_{{entry_point}}({{entry_point_attributes(driver) | indent(20)}}));
-    {% endif -%}
+    return( {{ entry_point_name(capability, entry_point, driver) }}({{entry_point_param(driver) | indent(20)}}));
 {% endfilter -%}
 #endif
 {% endfor %}
diff --git a/scripts/data_files/driver_templates/OS-template-transparent.jinja b/scripts/data_files/driver_templates/OS-template-transparent.jinja
@@ -1,12 +1,15 @@
+{# One Shot function's dispatch code for transparent drivers.
+Expected inputs:
+* drivers: the list of driver descriptions.
+* entry_point: the name of the entry point that this function dispatches to.
+* entry_point_param(driver): the parameters to pass to the entry point.
+* nest_indent: number of extra spaces to indent the code to.
+-#}
 {% for driver in drivers if driver.type == "transparent" -%}
 {% for capability in driver.capabilities if entry_point in capability.entry_points -%}
-#if ({% if capability.depend_on is defined -%}{{ capability.depend_on }} {% else -%} {{ 1 }} {% endif %})
+#if ({% if capability['mbedtls/c_depend_on'] is defined -%}{{ capability['mbedtls/c_depend_on'] }} {% else -%} {{ 1 }} {% endif %})
 {%- filter indent(width = nest_indent) %}
-{% if capability.name is defined and entry_point in capability.name.keys() -%}
-status = {{ capability.name[entry_point]}}({{entry_point_attributes(driver) | indent(20)}});
-{% else -%}
-status = {{driver.prefix}}_{{driver.type}}_{{entry_point}}({{entry_point_attributes(driver) | indent(20)}});
-{% endif -%}
+status = {{ entry_point_name(capability, entry_point, driver) }}({{entry_point_param(driver) | indent(20)}});
 
 if( status != PSA_ERROR_NOT_SUPPORTED )
     return( status );
diff --git a/scripts/data_files/driver_templates/psa_crypto_driver_wrappers.c.jinja b/scripts/data_files/driver_templates/psa_crypto_driver_wrappers.c.jinja
diff --git a/scripts/generate_driver_wrappers.py b/scripts/generate_driver_wrappers.py
