Add some OPAL API docs for PCI_XIVE calls

Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>

2 files changed, 47 insertions, 0 deletions

diff --git a/doc/opal-api/opal-pci-get-set-xive-reissue-35-36.txt b/doc/opal-api/opal-pci-get-set-xive-reissue-35-36.txt
new file mode 100644
index 0000000..897bc37
--- /dev/null
+++ b/doc/opal-api/opal-pci-get-set-xive-reissue-35-36.txt
@@ -0,0 +1,17 @@
+OPAL_PCI_GET_XIVE_REISSUE and OPAL_PCI_SET_XIVE_REISSUE
+-------------------------------------------------------
+
+static int64_t opal_pci_get_xive_reissue(uint64_t phb_id __unused,
+					 uint32_t xive_number __unused,
+					 uint8_t *p_bit __unused,
+					 uint8_t *q_bit __unused)
+
+static int64_t opal_pci_set_xive_reissue(uint64_t phb_id __unused,
+					 uint32_t xive_number __unused,
+					 uint8_t p_bit __unused,
+					 uint8_t q_bit __unused)
+
+
+Both of these calls are remnants from previous OPAL versions, calling either
+of them shall return OPAL_UNSUPPORTED.
+
diff --git a/doc/opal-api/opal-pci-set-xive-pe-37.txt b/doc/opal-api/opal-pci-set-xive-pe-37.txt
new file mode 100644
index 0000000..e37d65c
--- /dev/null
+++ b/doc/opal-api/opal-pci-set-xive-pe-37.txt
@@ -0,0 +1,30 @@
+OPAL_PCI_SET_XIVE_PE
+--------------------
+
+static int64_t opal_pci_set_xive_pe(uint64_t phb_id, uint32_t pe_number,
+				    uint32_t xive_num)
+
+WARNING: following documentation is from old sources, and is possibly
+not representative of OPALv3 as implemented by skiboot. This should be
+used as a starting point for full documentation.
+
+The host calls this function to bind a PE to an XIVE. Only that PE may then
+signal an MSI that selects this XIVE.
+
+    The phb_id parameter is the value from the PHB node ibm,opal-phbid
+    property.
+
+    the pe_number is the index of a PE, from 0 to ibm,opal-num-pes minus 1.
+
+    The xive_number is the index, from 0 to ibm,opal,ibm-num-msis minus
+    (num_lsis+1)
+
+    This call maps the XIVR indexed by xive_num to the PE specified by
+    pe_number. For ibm,opal-ioda HW, the pe_number must match the pe_number
+    set in the MVE.
+
+Return value:
+	if (!phb)
+		return OPAL_PARAMETER;
+	if (!phb->ops->set_xive_pe)
+		return OPAL_UNSUPPORTED;