state: describe OperatingSystemState and BootProgress in README.md
This commit updates the state README file with Operating System
and Boot Progress states. The host state dbus object already
implements both the properties but the documentation in the README
did not describe why the property had to be implemented. This commit
is improving the readme by adding the documentation.
Change-Id: I047e9d55dcabb6d79dbdad7ff9f666ee3355cd5b
Signed-off-by: Sampa Misra <sampmisr@in.ibm.com>
diff --git a/xyz/openbmc_project/State/README.md b/xyz/openbmc_project/State/README.md
index ce5b243..28ac56b 100644
--- a/xyz/openbmc_project/State/README.md
+++ b/xyz/openbmc_project/State/README.md
@@ -99,3 +99,15 @@
power off. If a user desires a cold reboot then they should simply issue a
power off transition request to the chassis, and then issue an on transition
request to the host.
+
+## Operating System State and Boot Progress Properties
+
+[OperatingSystemState](https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/xyz/openbmc_project/State/OperatingSystem/Status.interface.yaml)
+property is used to track different progress states of the OS or the hypervisor
+boot, while the [BootProgress](https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/xyz/openbmc_project/State/Boot/Progress.interface.yaml)
+property is used mainly for indicating system firmware boot progress.
+The enumerations used in both the cases are influenced by standard interfaces
+like IPMI 2.0 (Section 42.2, Sensor Type Codes and Data, Table 42, Base OS
+boot status) and PLDM state spec (DSP0249, Section 6.3, State Sets Tables,
+Table 7 – Boot-Related State Sets, Set ID - 196 Boot Progress).
+