diff mbox series

[017/110] doc: prettify and RSTify OPAL_NMMU_SET_PTCR

Message ID 20190531061351.22973-18-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>
---
 ...tcr-127.txt => opal-nmmu-set-ptcr-127.rst} | 25 ++++++++++++-------
 1 file changed, 16 insertions(+), 9 deletions(-)
 rename doc/opal-api/{opal-nmmu-set-ptcr-127.txt => opal-nmmu-set-ptcr-127.rst} (53%)
diff mbox series

Patch

diff --git a/doc/opal-api/opal-nmmu-set-ptcr-127.txt b/doc/opal-api/opal-nmmu-set-ptcr-127.rst
similarity index 53%
rename from doc/opal-api/opal-nmmu-set-ptcr-127.txt
rename to doc/opal-api/opal-nmmu-set-ptcr-127.rst
index eac13f32c09c..0e5181cf4ff1 100644
--- a/doc/opal-api/opal-nmmu-set-ptcr-127.txt
+++ b/doc/opal-api/opal-nmmu-set-ptcr-127.rst
@@ -1,22 +1,29 @@ 
+.. _OPAL_NMMU_SET_PTCR:
+
 OPAL_NMMU_SET_PTCR
--------------------
+------------------
+
+.. code-block:: c
 
-#define OPAL_NMMU_SET_PTCR			127
+   #define OPAL_NMMU_SET_PTCR			127
 
-int64 opal_nmmu_set_ptcr(uint64 chip_id, uint64_t ptcr)
+   int64 opal_nmmu_set_ptcr(uint64 chip_id, uint64_t ptcr);
 
-Arguments:
 
-  uint64 chip_id
+``uint64 chip_id``
     either the chip id containing the nest mmu who's ptcr should be set
     or alternatively -1ULL to indicate all nest mmu ptcr's should be set to
     the same value.
-  uint64 ptcr
+``uint64 ptcr``
     ptcr value pointing to either the radix tables or hash tables.
 
 This OPAL call sets up the Nest MMU by pointing it at the radix page
 table base or the hash page table base (HTABORG).
 
-Return Values:
-OPAL_SUCCESS: the power down was updated successful
-OPAL_PARAMETER: a parameter was incorrect
+Return Values
+^^^^^^^^^^^^^
+
+:ref:`OPAL_SUCCESS`
+   the PTCR was updated successful
+:ref:`OPAL_PARAMETER`
+   a parameter was incorrect