diff options
author | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-07-18 15:39:18 +1000 |
---|---|---|
committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-07-18 17:08:38 +1000 |
commit | a4c386acaa150a7e89254f41de82dcc492ad480c (patch) | |
tree | 41a26d0a836c44b30b47e52f09809af422f7d197 | |
parent | 281f7993dffcd8dcb0609182d5263ba62db52edf (diff) | |
download | skiboot-a4c386acaa150a7e89254f41de82dcc492ad480c.zip skiboot-a4c386acaa150a7e89254f41de82dcc492ad480c.tar.gz skiboot-a4c386acaa150a7e89254f41de82dcc492ad480c.tar.bz2 |
doc: add OPAL_SYNC_HOST_REBOOT documentation
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
-rw-r--r-- | doc/opal-api/opal-sync-host-reboot-87.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/opal-api/opal-sync-host-reboot-87.txt b/doc/opal-api/opal-sync-host-reboot-87.txt new file mode 100644 index 0000000..52d3776 --- /dev/null +++ b/doc/opal-api/opal-sync-host-reboot-87.txt @@ -0,0 +1,15 @@ +OPAL_SYNC_HOST_REBOOT +===================== + +static int64_t opal_sync_host_reboot(void) + +This OPAL call halts asynchronous operations in preparation for something +like kexec. It will halt DMA as well notification of some events (such +as a new error log being available for retreival). + +It's meant to be called in a loop until OPAL_SUCCESS is returned. + +Returns: +- OPAL_SUCCESS: Success! +- OPAL_BUSY_EVENT: not yet complete, call opal_sync_host_reboot() again, possibly with a short delay. +- OPAL_BUSY: Call opal_poll_events() and then retry opal_sync_host_reboot |