diff mbox

[1/4] doc/opal-api: opal_read_nvram

Message ID 1470891700-31844-1-git-send-email-ppaidipe@linux.vnet.ibm.com
State Superseded
Headers show

Commit Message

ppaidipe Aug. 11, 2016, 5:01 a.m. UTC 
From: Pridhiviraj Paidipeddi <ppaidipe@linux.vnet.ibm.com>

This patch adds the documentation for opal call opal_read_nvram.

Signed-off-by: Pridhiviraj Paidipeddi <ppaidipe@linux.vnet.ibm.com>
---
 doc/opal-api/opal-read-nvram-7.rst | 40 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 doc/opal-api/opal-read-nvram-7.rst
diff mbox

Patch

diff --git a/doc/opal-api/opal-read-nvram-7.rst b/doc/opal-api/opal-read-nvram-7.rst
new file mode 100644
index 0000000..cccd52b
--- /dev/null
+++ b/doc/opal-api/opal-read-nvram-7.rst
@@ -0,0 +1,40 @@ 
+OPAL_READ_NVRAM
+===============
+::
+
+   #define OPAL_READ_NVRAM                         7
+
+   int64_t opal_read_nvram(uint64_t buffer, uint64_t size, uint64_t offset)
+
+Arguments
+---------
+::
+
+   uint64_t buffer
+   uint64_t size
+   uint64_t offset
+
+``buffer``
+   the data from nvram will be copied to ``buffer``
+
+``size``
+   the data of size ``size`` will be copied
+
+``offset``
+   the data will be copied from address equal to base ``nvram_image`` plus ``offset``
+
+``OPAL_READ_NVRAM`` call requests OPAL to read the data from system NVRAM
+memory into a memory buffer. The data at ``offset`` from nvram_image
+will be copied to memory ``buffer`` of size ``size``.
+
+Return Values
+-------------
+
+``OPAL_SUCCESS``
+  data from nvram to memory ``buffer`` copied successfully
+
+``OPAL_PARAMETER``
+  a parameter ``offset`` or ``size`` was incorrect
+
+``OPAL_HARDWARE``
+  either nvram is not initialized or permanent error related to nvram hardware.