diff mbox series

[099/110] doc: Add skeleton OPAL_RESYNC_TIMEBASE docs

Message ID 20190531061351.22973-100-stewart@linux.ibm.com
State Accepted
Headers show
Series Big documentation cleanup/expansion | expand

Checks

Context Check Description
snowpatch_ozlabs/apply_patch success Successfully applied on branch master (76f7316bc8fc8a18fdbfcbc0e1fe1bb992d2a7d7)
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot fail Test snowpatch/job/snowpatch-skiboot on branch master
snowpatch_ozlabs/snowpatch_job_snowpatch-skiboot-dco success Signed-off-by present

Commit Message

Stewart Smith May 31, 2019, 6:13 a.m. UTC 
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
---
 doc/opal-api/opal-resync-timebase-79.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 doc/opal-api/opal-resync-timebase-79.rst
diff mbox series

Patch

diff --git a/doc/opal-api/opal-resync-timebase-79.rst b/doc/opal-api/opal-resync-timebase-79.rst
new file mode 100644
index 000000000000..b4df452e37aa
--- /dev/null
+++ b/doc/opal-api/opal-resync-timebase-79.rst
@@ -0,0 +1,21 @@ 
+.. _OPAL_RESYNC_TIMEBASE:
+
+OPAL_RESYNC_TIMEBASE
+====================
+
+.. code-block:: c
+
+   #define OPAL_RESYNC_TIMEBASE			79
+
+   int64_t opal_resync_timebase(void);
+
+Resynchronises the timebase for all threads in a core to the timebase from
+chiptod.
+
+Returns
+-------
+
+:ref:`OPAL_SUCCESS`
+     Successfully resynced timebases (or it's a no-op on this platform).
+:ref:`OPAL_HARDWARE`
+     Failed to resync timebase.