[Skiboot] [PATCH 2/4] doc/opal-api: opal_write_nvram

[Mukesh Ojha]

Better to use  'opal_read_nvram' and  'opal_write_nvram' into a single 
file as 'doc/opal-api/opal-nvram-read-write-7-8.rst' .

Same apply for 'opal_ipmi_send' and 'opal_ipmi_recv' .

Regards,
Mukesh

  


On Thursday 11 August 2016 10:31 AM, ppaidipe at linux.vnet.ibm.com wrote:
> From: Pridhiviraj Paidipeddi <ppaidipe at linux.vnet.ibm.com>
>
> This patch adds documentation for opal call opal_write_nvram
>
> Signed-off-by: Pridhiviraj Paidipeddi <ppaidipe at linux.vnet.ibm.com>
> ---
>   doc/opal-api/opal-write-nvram-8.rst | 40 +++++++++++++++++++++++++++++++++++++
>   1 file changed, 40 insertions(+)
>   create mode 100644 doc/opal-api/opal-write-nvram-8.rst
>
> diff --git a/doc/opal-api/opal-write-nvram-8.rst b/doc/opal-api/opal-write-nvram-8.rst
> new file mode 100644
> index 0000000..bd3171c
> --- /dev/null
> +++ b/doc/opal-api/opal-write-nvram-8.rst
> @@ -0,0 +1,40 @@
> +OPAL_WRITE_NVRAM
> +================
> +::
> +
> +   #define OPAL_WRITE_NVRAM                        8
> +
> +   int64_t opal_write_nvram(uint64_t buffer, uint64_t size, uint64_t offset)
> +
> +Arguments
> +---------
> +::
> +
> +   uint64_t buffer
> +   uint64_t size
> +   uint64_t offset
> +
> +``buffer``
> +   data from ``buffer`` will be copied to nvram
> +
> +``size``
> +   the data of size ``size`` will be copied
> +
> +``offset``
> +   the data will be copied to address which is equal to base ``nvram_image`` plus ``offset``
> +
> +``OPAL_WRITE_NVRAM`` call requests OPAL to write the data to actual system NVRAM memory
> + from memory ``buffer`` at ``offset``, of size ``size``
> +
> +Return Values
> +-------------
> +
> +``OPAL_SUCCESS``
> +  data from memory ``buffer`` to actual nvram_image 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.
> +