diff mbox series

[016/110] doc: prettify OPAL_[GET|SET]_PBCQ_TUNNEL_BAR

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

Commit Message

Stewart Smith May 31, 2019, 6:12 a.m. UTC 
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
---
 ...al-pci-get-set-pbcq-tunnel-bar-164-165.rst | 42 ++++++++-----------
 1 file changed, 18 insertions(+), 24 deletions(-)
diff mbox series

Patch

diff --git a/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst b/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst
index 95ee32431ab3..87a2c7decdf1 100644
--- a/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst
+++ b/doc/opal-api/opal-pci-get-set-pbcq-tunnel-bar-164-165.rst
@@ -1,20 +1,19 @@ 
+.. _OPAL_PCI_GET_PBCQ_TUNNEL_BAR:
+
 OPAL_PCI_GET_PBCQ_TUNNEL_BAR
 ============================
-::
+
+.. code-block:: c
 
    #define OPAL_PCI_GET_PBCQ_TUNNEL_BAR 164
 
-   int64_t opal_pci_get_pbcq_tunnel_bar(uint64_t phb_id, uint64_t *addr)
+   int64_t opal_pci_get_pbcq_tunnel_bar(uint64_t phb_id, uint64_t *addr);
 
 The host calls this function to read the address out of the PBCQ Tunnel
 Bar register.
 
 Parameters
 ----------
-::
-
-   uint64_t phb_id
-   uint64_t *addr
 
 ``phb_id``
   The value from the PHB node ibm,opal-phbid property for the device.
@@ -26,36 +25,33 @@  Parameters
 Return Values
 -------------
 
-``OPAL_SUCCESS``
+:ref:`OPAL_SUCCESS`
   Operation was successful
-
-``OPAL_PARAMETER``
+:ref:`OPAL_PARAMETER`
   Invalid PHB or addr parameter
-
-``OPAL_UNSUPPORTED``
+:ref:`OPAL_UNSUPPORTED`
   Not supported by hardware
 
+.. _OPAL_PCI_SET_PBCQ_TUNNEL_BAR:
+
 OPAL_PCI_SET_PBCQ_TUNNEL_BAR
 ============================
-::
+
+.. code-block:: c
 
    #define OPAL_PCI_SET_PBCQ_TUNNEL_BAR 165
 
-   int64_t opal_pci_set_pbcq_tunnel_bar(uint64_t phb_id, uint64_t addr)
+   int64_t opal_pci_set_pbcq_tunnel_bar(uint64_t phb_id, uint64_t addr);
 
 The host calls this function to set the PBCQ Tunnel Bar register.
 
 Parameters
 ----------
-::
-
-   uint64_t phb_id
-   uint64_t addr
 
-``phb_id``
+:ref:``phb_id`
   The value from the PHB node ibm,opal-phbid property for the device.
 
-``addr``
+:ref:`addr`
   The value of the address chosen for the PBCQ Tunnel Bar register.
   If the address is 0, then the PBCQ Tunnel Bar register will be reset.
   It the address is non-zero, then the PBCQ Tunnel Bar register will be
@@ -66,11 +62,9 @@  Parameters
 Return Values
 -------------
 
-``OPAL_SUCCESS``
+:ref:`OPAL_SUCCESS`
   Operation was successful
-
-``OPAL_PARAMETER``
+:ref:`OPAL_PARAMETER`
   Invalid PHB or addr parameter
-
-``OPAL_UNSUPPORTED``
+:ref:`OPAL_UNSUPPORTED`
   Not supported by hardware