diff options
| author | Vipin K Parashar <vipin@linux.vnet.ibm.com> | 2015-06-26 21:39:42 +0530 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2015-06-29 20:01:58 +1000 |
| commit | 055ccc36c585230f234d4a3a17e8acea090057b3 (patch) | |
| tree | 614d6e566ec805871590187341daf2c5a2f33576 /doc | |
| parent | 1edeebcb776166dd757f509393ea587b1970a664 (diff) | |
| download | skiboot-055ccc36c585230f234d4a3a17e8acea090057b3.zip skiboot-055ccc36c585230f234d4a3a17e8acea090057b3.tar.gz skiboot-055ccc36c585230f234d4a3a17e8acea090057b3.tar.bz2 | |
doc/opal-api: Add description of OPAL EPOW and DPO messages
Updated opal-messages.txt with description of OPAL EPOW and DPO messages
Signed-off-by: Vipin K Parashar <vipin@linux.vnet.ibm.com>
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/opal-api/opal-messages.txt | 20 |
1 files changed, 15 insertions, 5 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 ------------ |