[Skiboot] [PATCH] doc/opal-api: Add description of OPAL EPOW and DPO messages

[Vipin K Parashar]

Updated opal-messages.txt with description of OPAL EPOW and DPO messages

Signed-off-by: Vipin K Parashar <vipin at linux.vnet.ibm.com>
---
 doc/opal-api/opal-messages.txt | 20 +++++++++++++++-----
 hw/fsp/fsp-epow.c              |  2 +-
 2 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/doc/opal-api/opal-messages.txt b/doc/opal-api/opal-messages.txt
index fdde247..6b7c7a0 100644
--- a/doc/opal-api/opal-messages.txt
+++ b/doc/opal-api/opal-messages.txt
@@ -40,6 +40,17 @@ OPAL_MSG_MEM_ERR
 OPAL_MSG_EPOW
 -------------
 
+Used by OPAL to issue environmental and power warnings to host OS for
+conditions requiring an earlier poweroff. A few examples of these are high
+ambient temperature or system running on UPS power with low UPS battery.
+Host OS can query OPAL via GET_EPOW_STATUS API to obtain information about
+EPOW conditions present. Refer include/opal-api.h for description of
+all supported EPOW events. OPAL_SYSPOWER_CHNG, OPAL_SYSPOWER_FAIL and
+OPAL_SYSPOWER_INC events don't require system poweroff.
+
+Host OS should look for 'ibm,opal-v3-epow' string as compatible property
+for 'epow' node under OPAL device-tree to determine epow support.
+
 OPAL_MSG_SHUTDOWN
 -----------------
 
@@ -108,11 +119,10 @@ struct OpalHMIEvent {
 OPAL_MSG_DPO
 ------------
 
-Used for delayed power off, where OPAL can inform a host OS that it intends to
-perform a shutdown in the future.
-
-The host OS can use the separate API OPAL_GET_DPO_STATUS to query OPAL for the
-number of seconds before a forced shutdown will occur.
+Delayed poweroff where OPAL informs host OS that a poweroff has been
+requested and a forced shutdown will happen in future. Host OS can use
+OPAL_GET_DPO_STATUS API to query OPAL the number of seconds remaining
+before a forced poweroff will occur.
 
 OPAL_MSG_PRD
 ------------
diff --git a/hw/fsp/fsp-epow.c b/hw/fsp/fsp-epow.c
index 2a5aa85..79171c5 100644
--- a/hw/fsp/fsp-epow.c
+++ b/hw/fsp/fsp-epow.c
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-/* FSP Early Power Off Warning (EPOW) support */
+/* FSP Environmental and Power Warnings (EPOW) support */
 
 #define pr_fmt(fmt) "FSP-EPOW: " fmt
 
-- 
1.9.3