[Skiboot] [PATCH 072/110] doc: prettify OPAL_PCI_MAP_PE_MMIO_WINDOW

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


Signed-off-by: Stewart Smith <stewart at linux.ibm.com>
---
 .../opal-pci-map-pe-mmio-window-29.rst        | 21 ++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/doc/opal-api/opal-pci-map-pe-mmio-window-29.rst b/doc/opal-api/opal-pci-map-pe-mmio-window-29.rst
index aaa1d9e98af2..a84da18ddc44 100644
--- a/doc/opal-api/opal-pci-map-pe-mmio-window-29.rst
+++ b/doc/opal-api/opal-pci-map-pe-mmio-window-29.rst
@@ -1,14 +1,19 @@
+.. _OPAL_PCI_MAP_PE_MMIO_WINDOW:
+
 OPAL_PCI_MAP_PE_MMIO_WINDOW
 ===========================
-::
+
+.. code-block:: c
 
    #define OPAL_PCI_MAP_PE_MMIO_WINDOW		29
 
-   static int64_t opal_pci_map_pe_mmio_window(uint64_t phb_id,
-					      uint64_t pe_number,
-					      uint16_t window_type,
-					      uint16_t window_num,
-					      uint16_t segment_num)
+   int64_t opal_pci_map_pe_mmio_window(uint64_t phb_id,
+                                       uint64_t pe_number,
+                                       uint16_t window_type,
+                                       uint16_t window_num,
+                                       uint16_t segment_num);
+
+.. 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
@@ -38,7 +43,9 @@ The host calls this function to map a segment of MMIO address space to a PE.
   window.
 
 
-Return value: ::
+Return value:
+
+.. code-block:: c
 
 	if (!phb)
 		return OPAL_PARAMETER;
-- 
2.21.0



More information about the Skiboot mailing list