diff options
| author | Stewart Smith <stewart@linux.ibm.com> | 2019-05-31 16:13:43 +1000 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.ibm.com> | 2019-06-03 10:20:00 +1000 |
| commit | 9d3a0036ed414877fcbeab4bcc2a10628d2079a7 (patch) | |
| tree | 31887a3ba640e600df6c19facfbc48f0cc4173e6 | |
| parent | d64431cca54bb8e376d0a5adba9cd156cfffc72b (diff) | |
| download | skiboot-9d3a0036ed414877fcbeab4bcc2a10628d2079a7.zip skiboot-9d3a0036ed414877fcbeab4bcc2a10628d2079a7.tar.gz skiboot-9d3a0036ed414877fcbeab4bcc2a10628d2079a7.tar.bz2 | |
doc: prettify OPAL_SYNC_HOST_REBOOT
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
| -rw-r--r-- | doc/opal-api/opal-sync-host-reboot-87.rst | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/opal-api/opal-sync-host-reboot-87.rst b/doc/opal-api/opal-sync-host-reboot-87.rst index 466e673..bc5605d 100644 --- a/doc/opal-api/opal-sync-host-reboot-87.rst +++ b/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 |