Skip to content

Commit

Permalink
doc: prettify OPAL_SYNC_HOST_REBOOT
Browse files Browse the repository at this point in the history
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
  • Loading branch information
stewartsmith committed Jun 3, 2019
1 parent d64431c commit 9d3a003
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions doc/opal-api/opal-sync-host-reboot-87.rst
@@ -1,22 +1,25 @@
.. _OPAL_SYNC_HOST_REBOOT:

OPAL_SYNC_HOST_REBOOT
=====================
::

static int64_t opal_sync_host_reboot(void)
.. code-block:: c
#define OPAL_SYNC_HOST_REBOOT 87
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.
It's meant to be called in a loop until :ref:`OPAL_SUCCESS` is returned.

Returns
-------
OPAL_SUCCESS
:ref:`OPAL_SUCCESS`
Success!

OPAL_BUSY_EVENT
:ref:`OPAL_BUSY_EVENT`
not yet complete, call opal_sync_host_reboot() again, possibly with a short delay.

OPAL_BUSY
:ref:`OPAL_BUSY`
Call opal_poll_events() and then retry opal_sync_host_reboot

0 comments on commit 9d3a003

Please sign in to comment.