diff mbox series

[070/110] doc: prettify OPAL_PCI_PHB_MMIO_ENABLE

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

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-phb-mmio-enable-27.rst | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/doc/opal-api/opal-pci-phb-mmio-enable-27.rst b/doc/opal-api/opal-pci-phb-mmio-enable-27.rst
index 62b4ea3b1b8e..e3ca02f57773 100644
--- a/doc/opal-api/opal-pci-phb-mmio-enable-27.rst
+++ b/doc/opal-api/opal-pci-phb-mmio-enable-27.rst
@@ -1,11 +1,16 @@ 
+.. _OPAL_PCI_PHB_MMIO_ENABLE:
+
 OPAL_PCI_PHB_MMIO_ENABLE
 ========================
-::
+
+.. code-block:: c
 
    #define OPAL_PCI_PHB_MMIO_ENABLE		27
 
-   static int64_t opal_pci_phb_mmio_enable(uint64_t phb_id, uint16_t window_type,
-					uint16_t window_num, uint16_t enable)
+   int64_t opal_pci_phb_mmio_enable(uint64_t phb_id, uint16_t window_type,
+                                    uint16_t window_num, uint16_t enable);
+
+.. note:: Appears to be POWER7 p7ioc specific. Likely to be removed soon.
 
 **WARNING:** following documentation is from old sources, and is possibly
 not representative of OPALv3 as implemented by skiboot. This should be
@@ -20,14 +25,14 @@  PHB decode and forwarding for the address range defined in a particular MMIO
 window.
 
 Not all PHB hardware may support disabling some or all MMIO windows. OPAL
-returns OPAL_UNSUPPORTED if called to disable an MMIO window for which
+returns :ref:`OPAL_UNSUPPORTED` if called to disable an MMIO window for which
 hardware does not support disable. KVM may call this function for all MMIO
 windows and ignore the opal_unsuppsorted return code so long as KVM has
 disabled MMIO to all downstream PCI devices and assured that KVM and OS guest
 partitions cannot issue CI loads/stores to these address spaces from the
 processor (e.g.,via HPT).
 
-OPAL returns OPAL_SUCCESS for calls to OPAL to enable them for PHBs that do
+OPAL returns :ref:`OPAL_SUCCESS` for calls to OPAL to enable them for PHBs that do
 not support disable.
 
 ``phb_id``