commit 473d2c9b5a1b3f89c60f004eaa6eb2a09caa5cb9
author Carol Wang <wangkair@cn.ibm.com> Thu Aug 22 16:03:34 2019 +0800
committer Carol Wang <wangkair@cn.ibm.com> Thu Sep 26 17:37:39 2019 +0800
tree 1554791841986f462c4ca38b25a0105fca046e76
parent a2fa0709861cdea1d3408eee8706d738ed19eb32

BIOS: Define JSON structure for BIOS String type

Give a sample of JSON configuration file for BIOS string type.
Take one entry for example:
      {
         "attribute_name" : "str_example1",
         "string_type" : "ASCII",
         "minimum_string_length" : 1,
         "maximum_string_length" : 100,
         "default_string_length" : 3,
         "default_string" : "abc",
         "dbus":
            {
               "object_path" : "/xyz/abc/def",
               "interface" : "xyz.openbmc_project.str_example1.value",
               "property_name" : "Str_example1",
               "property_type" : "string"
            }
      }

Signed-off-by: Carol Wang <wangkair@cn.ibm.com>
Change-Id: I6217ddf75aa60dfb46e4384f81f2ff39c922d3bb

libpldmresponder/examples/bios/string_attrs.json

diff --git a/libpldmresponder/examples/bios/string_attrs.json b/libpldmresponder/examples/bios/string_attrs.json
new file mode 100644
index 0000000..7346994
--- /dev/null
+++ b/libpldmresponder/examples/bios/string_attrs.json
@@ -0,0 +1,47 @@
+# This is a sample JSON configuration file for BIOS string type
+{
+   "entries":[
+      {
+         "attribute_name" : "str_example1",
+         # Possible values of string type {Unknown=0x00, ASCII=0x01, Hex=0x02,
+         # UTF-8=0x03, UTF-16LE=0x04, UTF-16BE=0x05, Vendor Specific=0xFF}
+         "string_type" : "ASCII",
+         "minimum_string_length" : 1,
+         "maximum_string_length" : 100,
+         "default_string_length" : 3,
+         "default_string" : "abc",
+         # This BIOS attribute has a D-Bus property as backend.
+         "dbus":
+            {
+               "object_path" : "/xyz/abc/def",
+               "interface" : "xyz.openbmc_project.str_example1.value",
+               "property_name" : "Str_example1",
+               "property_type" : "string"
+            }
+      },
+      {
+         "attribute_name" : "str_example2",
+         "string_type" : "Hex",
+         "minimum_string_length" : 0,
+         "maximum_string_length" : 100,
+         "default_string_length" : 0,
+         "default_string" : "",
+         "dbus":
+            {
+               "object_path" : "/xyz/abc/def",
+               "interface" : "xyz.openbmc_project.str_example2.value",
+               "property_name" : "Str_example2",
+               "property_type" : "string"
+            }
+      },
+      {
+         # This is an example of BIOS String Read only attribute
+         "attribute_name" : "str_example3",
+         "string_type" : "Unknown",
+         "minimum_string_length" : 1,
+         "maximum_string_length" : 100,
+         "default_string_length" : 2,
+         "default_string" : "ef"
+      }
+    ]
+}