diff mbox series

[096/110] doc: Skeleton OPAL_PCI_POLL docs

Message ID 20190531061351.22973-97-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-pci-poll-62.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 doc/opal-api/opal-pci-poll-62.rst
diff mbox series

Patch

diff --git a/doc/opal-api/opal-pci-poll-62.rst b/doc/opal-api/opal-pci-poll-62.rst
new file mode 100644
index 000000000000..298aa6d3685d
--- /dev/null
+++ b/doc/opal-api/opal-pci-poll-62.rst
@@ -0,0 +1,18 @@ 
+.. _OPAL_PCI_POLL:
+
+OPAL_PCI_POLL
+=============
+
+.. code-block:: c
+
+   #define OPAL_PCI_POLL				62
+
+   int64_t opal_pci_poll(uint64_t id);
+
+Crank the state machine for the PHB id. Returns how many milliseconds for
+the caller to sleep.
+
+Returns
+-------
+
+Milliseconds for the caller to sleep for, error code, or :ref:`OPAL_SUCCESS`.