diff mbox series

[089/110] doc: Add skeleton for OPAL_PCI_REINIT

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

Patch

diff --git a/doc/opal-api/opal-pci-reinit-53.rst b/doc/opal-api/opal-pci-reinit-53.rst
new file mode 100644
index 000000000000..677bd2343c9f
--- /dev/null
+++ b/doc/opal-api/opal-pci-reinit-53.rst
@@ -0,0 +1,31 @@ 
+.. _OPAL_PCI_REINIT:
+
+OPAL_PCI_REINIT
+===============
+
+.. code-block:: c
+
+   #define OPAL_PCI_REINIT				53
+
+   enum OpalPciReinitScope {
+	/*
+	 * Note: we chose values that do not overlap
+	 * OpalPciResetScope as OPAL v2 used the same
+	 * enum for both
+	 */
+	OPAL_REINIT_PCI_DEV = 1000
+   };
+
+   int64_t opal_pci_reinit(uint64_t phb_id, uint64_t reinit_scope, uint64_t data);
+
+.. note:: Much glory awaits the one who fills in this documentation.
+
+Returns
+-------
+
+:ref:`OPAL_PARAMETER`
+     Invalid PHB, scope, or device.
+:ref:`OPAL_UNSUPPORTED`
+     Operation unsupported
+:ref:`OPAL_HARDWARE`
+     Some hardware issue prevented the reinit.