BIOS: Implement HelpText and DisplayName properties
Introduce HelpText and DisplayName fields in the PLDM BIOS JSONs, these should
be parsed and passed to the D-Bus APIs that populates the BIOS table.
https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/xyz/openbmc_project/BIOSConfig/Manager.interface.yaml#L68
Also, they have the same names in the Redfish schema.
https://redfish.dmtf.org/schemas/v1/AttributeRegistry.v1_3_3.json
Tested: test with JSON
https://gist.github.com/lxwinspur/2afffff2e445fddf90dfed6eceef4014
busctl get-property xyz.openbmc_project.BIOSConfigManager
/xyz/openbmc_project/bios_config/manager
xyz.openbmc_project.BIOSConfig.Manager BaseBIOSTable
a{s(sbsssvva(sv))} 5
"CodeUpdatePolicy"
"xyz.openbmc_project.BIOSConfig.Manager.AttributeType.Enumeration"
true "CodeUpdatePolicy DisplayName" "CodeUpdatePolicy HelpText" "" s
"Concurrent" s "Concurrent" 2
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.OneOf" s "Concurrent"
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.OneOf" s "Disruptive"
"Led"
"xyz.openbmc_project.BIOSConfig.Manager.AttributeType.Enumeration"
false "Led DisplayName" "Led HelpText" "" s "Off" s "Off" 2
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.OneOf" s "On"
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.OneOf" s "Off"
"Model"
"xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String"
false "Model DisplayName" "Model HelpText" "" s "powersupply0" s "FP5280G2" 2
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.MinStringLength" x 1
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.MaxStringLength" x 100
"OUTLET"
"xyz.openbmc_project.BIOSConfig.Manager.AttributeType.Integer"
false "OUTLET DisplayName" "OUTLET HelpText" "" x 9127925392260618112 x 0 3
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.LowerBound" x 0
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.UpperBound" x 68002
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.ScalarIncrement" x 1
"str_example3"
"xyz.openbmc_project.BIOSConfig.Manager.AttributeType.String"
true "str_example3 DisplayName" "str_example3 HelpText" "" s "ef" s "ef" 2
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.MinStringLength" x 1
"xyz.openbmc_project.BIOSConfig.Manager.BoundType.MaxStringLength" x 100
Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: I4e0e28a6fbaeb409b4d57dfcb54d79aee1c5b211
diff --git a/test/libpldmresponder_bios_enum_attribute_test.cpp b/test/libpldmresponder_bios_enum_attribute_test.cpp
index 4a91dcb..b9a5277 100644
--- a/test/libpldmresponder_bios_enum_attribute_test.cpp
+++ b/test/libpldmresponder_bios_enum_attribute_test.cpp
@@ -35,7 +35,9 @@
"attribute_name" : "CodeUpdatePolicy",
"possible_values" : [ "Concurrent", "Disruptive" ],
"default_values" : [ "Concurrent" ],
- "readOnly" : true
+ "readOnly" : true,
+ "helpText" : "HelpText",
+ "displayName" : "DisplayName"
})"_json;
BIOSEnumAttribute enumReadOnly{jsonEnumReadOnly, nullptr};
@@ -49,7 +51,9 @@
"attribute_name" : "CodeUpdatePolicy",
"possible_value" : [ "Concurrent", "Disruptive" ],
"default_values" : [ "Concurrent" ],
- "readOnly" : true
+ "readOnly" : true,
+ "helpText" : "HelpText",
+ "displayName" : "DisplayName"
})"_json; // possible_value -> possible_values
EXPECT_THROW((BIOSEnumAttribute{jsonEnumReadOnlyError, nullptr}),
Json::exception);
@@ -59,6 +63,8 @@
"possible_values" : [ "Perm", "Temp" ],
"default_values" : [ "Perm" ],
"readOnly" : false,
+ "helpText" : "HelpText",
+ "displayName" : "DisplayName",
"dbus":
{
"object_path" : "/xyz/abc/def",
@@ -83,7 +89,9 @@
"attribute_name" : "CodeUpdatePolicy",
"possible_values" : [ "Concurrent", "Disruptive" ],
"default_values" : [ "Disruptive" ],
- "readOnly" : true
+ "readOnly" : true,
+ "helpText" : "HelpText",
+ "displayName" : "DisplayName"
})"_json;
std::vector<uint8_t> expectedAttrEntry{
@@ -121,6 +129,8 @@
"possible_values" : [ "Concurrent", "Disruptive" ],
"default_values" : [ "Disruptive" ],
"readOnly" : false,
+ "helpText" : "HelpText",
+ "displayName" : "DisplayName",
"dbus":
{
"object_path" : "/xyz/abc/def",
@@ -171,6 +181,8 @@
"possible_values" : [ "Concurrent", "Disruptive" ],
"default_values" : [ "Disruptive" ],
"readOnly" : false,
+ "helpText" : "HelpText",
+ "displayName" : "DisplayName",
"dbus":
{
"object_path" : "/xyz/abc/def",
@@ -216,4 +228,4 @@
attrValueEntry.data()),
reinterpret_cast<pldm_bios_attr_table_entry*>(attrEntry.data()),
biosStringTable);
-}
\ No newline at end of file
+}