aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.ibm.com>2019-05-31 16:13:13 +1000
committerStewart Smith <stewart@linux.ibm.com>2019-06-03 10:20:00 +1000
commit897d8c8a41d900a2a30cf90efe2abd4610ef7b4b (patch)
tree8f78531b07c37ecf806761782eccd824d63337a6
parent8ab9f9d33f0c68839add6c8af750e1a47abfcb92 (diff)
downloadskiboot-897d8c8a41d900a2a30cf90efe2abd4610ef7b4b.zip
skiboot-897d8c8a41d900a2a30cf90efe2abd4610ef7b4b.tar.gz
skiboot-897d8c8a41d900a2a30cf90efe2abd4610ef7b4b.tar.bz2
doc: prettify OPAL_PCI_MAP_PE_MMIO_WINDOW
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
-rw-r--r--doc/opal-api/opal-pci-map-pe-mmio-window-29.rst21
1 files 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 aaa1d9e..a84da18 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;