[Skiboot] [PATCH 071/110] doc: prettify OPAL_PCI_SET_PHB_MEM_WINDOW

Stewart Smith stewart at linux.ibm.com
Fri May 31 16:13:12 AEST 2019


Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
 .../opal-pci-set-phb-mem-window-28.rst        | 23 ++++++++++++-------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/doc/opal-api/opal-pci-set-phb-mem-window-28.rst b/doc/opal-api/opal-pci-set-phb-mem-window-28.rst
index 0dc6b7036d5f..e23d841c1c9f 100644
--- a/doc/opal-api/opal-pci-set-phb-mem-window-28.rst
+++ b/doc/opal-api/opal-pci-set-phb-mem-window-28.rst
@@ -1,15 +1,20 @@
+.. _OPAL_PCI_SET_PHB_MEM_WINDOW:
+
 OPAL_PCI_SET_PHB_MEM_WINDOW
 ===========================
-::
+
+.. code-block:: c
 
    #define OPAL_PCI_SET_PHB_MEM_WINDOW             28
 
-   static int64_t opal_pci_set_phb_mem_window(uint64_t phb_id,
-					   uint16_t window_type,
-					   uint16_t window_num,
-					   uint64_t addr,
-					   uint64_t pci_addr,
-					   uint64_t size)
+   int64_t opal_pci_set_phb_mem_window(uint64_t phb_id,
+                                       uint16_t window_type,
+                                       uint16_t window_num,
+                                       uint64_t addr,
+                                       uint64_t pci_addr,
+                                       uint64_t size);
+
+.. 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
@@ -71,7 +76,9 @@ segment_size times the number of segments within this MMIO window.
 The host must set PHB memory windows to be within the system real address
 ranges indicated in the PHB parent HDT hub node ibm,opal-mmio-real property.
 
-Return value: ::
+Return value:
+
+.. code-block:: c
 
 	if (!phb)
 		return OPAL_PARAMETER;
-- 
2.21.0



More information about the Skiboot mailing list