Update PFR ProvisioningStatus from bool to enum type
Combined two properties "Provisioned" and 'Locked"
to single enumtype as per recommendation.
EnumTypes are:
1) NotProvisioned
2) ProvisionedButNotLocked
3) ProvisionedAndLocked
Signed-off-by: AppaRao Puli <apparao.puli@linux.intel.com>
Change-Id: Iaea836cc540d9bedb35f624a03aa8d669df6b2b9
diff --git a/designs/redfish-resource-supplement-for-pfr.md b/designs/redfish-resource-supplement-for-pfr.md
index 6565daf..fd2c7be 100644
--- a/designs/redfish-resource-supplement-for-pfr.md
+++ b/designs/redfish-resource-supplement-for-pfr.md
@@ -68,18 +68,27 @@
associated with Platform Firmware Resilience but it provides OEM objects for
manufacturer/provider specific extension moniker.
-Below are two OEM properties defined to represent the Platform Firmware
+Below are property is defined to represent the Platform Firmware
Resilience provisioning status.
- - Provisioned: The value of this property shall be a boolean indicating
- provisioned state of platform firmware.
+ - ProvisiongStatus: The value of this property indicates the provisioning
+ status of platform firmware. It is of Enum Type with below values.
- - Locked: The value of this property shall be a boolean indicating platform
- firmware provisioning is locked.
+ 1) NotProvisioned: Indicates platform firmware is not provisioned.
+ This is an unsecured state.
+
+ 2) ProvisionedButNotLocked: Indicates that the platform firmware is
+ provisioned but not locked. So re-provisioning is allowed in this
+ state.
+
+ 3) ProvisionedAndLocked: Indicates that the platform firmware is
+ provisioned and locked. So re-provisioning is not allowed in this
+ state.
PFR enabled platforms can provision or re-provision the platform resilience
-multiple times without Locking. But once the platform is locked by provisioning
-agent after, it can not be re-provisioned.
+multiple times when it is in "NotProvisioned" or "ProvisionedButNotLocked"
+states. But once the platform is transitioned to "ProvisionedAndLocked" state,
+it can not be re-provisioned.
New OemComputerSystem schema can be found at
[link](https://gerrit.openbmc-project.xyz/#/c/openbmc/bmcweb/+/24253/)
@@ -148,8 +157,7 @@
"Oem": {
"OpenBmc": {
"FirmwareProvisioning": {
- "Locked": true,
- "Provisioned": true
+ "ProvisioningStatus": "NotProvisioned"
}
}
},