aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.ibm.com>2019-05-31 16:13:37 +1000
committerStewart Smith <stewart@linux.ibm.com>2019-06-03 10:20:00 +1000
commitdc9ee7f37f0c200c56edf94c0da7b9ecc3466017 (patch)
tree5968da1729daef654c3d47c51b48bda19b54af2e
parent40bd86dd1ca953501949b3df4fcb462e4474e5cc (diff)
downloadskiboot-dc9ee7f37f0c200c56edf94c0da7b9ecc3466017.zip
skiboot-dc9ee7f37f0c200c56edf94c0da7b9ecc3466017.tar.gz
skiboot-dc9ee7f37f0c200c56edf94c0da7b9ecc3466017.tar.bz2
doc: Skeleton OPAL_PCI_POLL docs
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
-rw-r--r--doc/opal-api/opal-pci-poll-62.rst18
1 files changed, 18 insertions, 0 deletions
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 0000000..298aa6d
--- /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`.