secvar_devtree: add generic compatible, and new format device tree property

This patch adds a generic compatible entry to the secvar/compatible
device tree property for kernels, etc to match for basic secvar
information (e.g. the linux secvar-sysfs implementation).

The new "format" property exposes the expected format for data passing
in and out of the secvar API. In most cases, this should be the same as
the backend-specific compatible entry.

Signed-off-by: Eric Richter <erichte@linux.ibm.com>
Signed-off-by: Oliver O'Halloran <oohall@gmail.com>

1 files changed, 20 insertions, 1 deletions

diff --git a/doc/device-tree/ibm,opal/secvar/binding.rst b/doc/device-tree/ibm,opal/secvar/binding.rst
index bc86fb2..0956e49 100644
--- a/doc/device-tree/ibm,opal/secvar/binding.rst
+++ b/doc/device-tree/ibm,opal/secvar/binding.rst
@@ -42,6 +42,25 @@ Properties:
   all further images to require signature validations. See the
   "On Enforcing Secure Mode" section below.
 
+  This property also contains a generic "ibm,secvar-backend" compatible,
+  which defines the basic-level compatibility of the secvar implementation.
+  This includes the basic behavior of the API (excluding the data format),
+  and the expected device tree properties contained in this node.
+
+- format
+
+  Usage:
+    required
+  Value type:
+    string
+
+  This property defines the format of data passed in and out of the secvar
+  API. In most cases, this should be the same string as the backend-specific
+  string in compatible.
+
+  The format defined by this string should be documented by the corresponding
+  backend.
+
 - status
 
   Usage:
@@ -119,7 +138,7 @@ Example
 .. code-block:: dts
 
 	/ibm,opal/secvar {
-		compatible = "ibm,edk2-compat-v1";
+		compatible = "ibm,secvar-backend" "ibm,edk2-compat-v1";
 
                 status = "okay";
                 max-var-size = <0x1000>;