[Skiboot] [PATCH] doc: add OPAL_SYNC_HOST_REBOOT documentation

[Stewart Smith]

Signed-off-by: Stewart Smith <stewart at linux.vnet.ibm.com>
---
 doc/opal-api/opal-sync-host-reboot-87.txt | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 doc/opal-api/opal-sync-host-reboot-87.txt

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 000000000000..52d3776e043f
--- /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
-- 
2.1.4