aboutsummaryrefslogtreecommitdiff
path: root/doc/opal-api
diff options
context:
space:
mode:
authorStewart Smith <stewart@linux.ibm.com>2019-05-31 16:13:24 +1000
committerStewart Smith <stewart@linux.ibm.com>2019-06-03 10:20:00 +1000
commite9bced00496e87d83527d29a2da370585c9f3af1 (patch)
tree962758e0648424a7de46cce70288788bc195e8c3 /doc/opal-api
parentf797854384a3852466d5070d5f6bce00c9215560 (diff)
downloadskiboot-e9bced00496e87d83527d29a2da370585c9f3af1.zip
skiboot-e9bced00496e87d83527d29a2da370585c9f3af1.tar.gz
skiboot-e9bced00496e87d83527d29a2da370585c9f3af1.tar.bz2
doc: prettify OPAL_PCI_MAP_PE_DMA_WINDOW[_REAL]
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
Diffstat (limited to 'doc/opal-api')
-rw-r--r--doc/opal-api/opal-pci-map-pe-dma-window-44.rst11
-rw-r--r--doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst14
2 files changed, 20 insertions, 5 deletions
diff --git a/doc/opal-api/opal-pci-map-pe-dma-window-44.rst b/doc/opal-api/opal-pci-map-pe-dma-window-44.rst
index bec8f08..9450629 100644
--- a/doc/opal-api/opal-pci-map-pe-dma-window-44.rst
+++ b/doc/opal-api/opal-pci-map-pe-dma-window-44.rst
@@ -1,6 +1,9 @@
+.. _OPAL_PCI_MAP_PE_DMA_WINDOW:
+
OPAL_PCI_MAP_PE_DMA_WINDOW
==========================
-::
+
+.. code-block:: c
#define OPAL_PCI_MAP_PE_DMA_WINDOW 44
@@ -10,7 +13,7 @@ OPAL_PCI_MAP_PE_DMA_WINDOW
uint16_t tce_levels,
uint64_t tce_table_addr,
uint64_t tce_table_size,
- uint64_t tce_page_size)
+ uint64_t tce_page_size);
**WARNING:** following documentation is from old sources, and is possibly
not representative of OPALv3 as implemented by skiboot. This should be
@@ -94,7 +97,9 @@ a win_size_32 = 256MB, only 16 DMA windows (and therefore no more than 16
distinct PEs) can map the 4GB of 32-bit PCI memory for DMA. OPAL does not
police this limitation.
-Return value: ::
+Return value:
+
+.. code-block:: c
if (!phb)
return OPAL_PARAMETER;
diff --git a/doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst b/doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst
index bc364dc..87395d1 100644
--- a/doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst
+++ b/doc/opal-api/opal-pci-map-pe-dma-window-real-45.rst
@@ -1,9 +1,19 @@
+.. _OPAL_PCI_MAP_PE_DMA_WINDOW_REAL:
+
OPAL_PCI_MAP_PE_DMA_WINDOW_REAL
===============================
-::
+
+.. code-block:: c
#define OPAL_PCI_MAP_PE_DMA_WINDOW_REAL 45
+ int64_t opal_pci_map_pe_dma_window_real(uint64_t phb_id,
+ uint64_t pe_number,
+ uint16_t window_id,
+ uint64_t pci_start_addr,
+ uint64_t pci_mem_size);
+
+
**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.
@@ -40,6 +50,6 @@ within the window set associated with the specified PE number.
``window_size``
is the size, in bytes, of the address range defined by this
- window. This value must be a multiple of 16MB; OPAL returns OPAL_PARAMETER
+ window. This value must be a multiple of 16MB; OPAL returns :ref:`OPAL_PARAMETER`
for any value that is not a multiple of 16MB. A value of '0' indicates to
disable this DMA window.