[Skiboot] [PATCH 3/4] doc/opal-api: opal_ipmi_send

[Mukesh Ojha]

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 the opal call opal_ipmi_send.
>
> Signed-off-by: Pridhiviraj Paidipeddi <ppaidipe at linux.vnet.ibm.com>
> ---
>   doc/opal-api/opal-ipmi-send-107.rst | 55 +++++++++++++++++++++++++++++++++++++
>   1 file changed, 55 insertions(+)
>   create mode 100644 doc/opal-api/opal-ipmi-send-107.rst
>
> diff --git a/doc/opal-api/opal-ipmi-send-107.rst b/doc/opal-api/opal-ipmi-send-107.rst
> new file mode 100644
> index 0000000..da5be01
> --- /dev/null
> +++ b/doc/opal-api/opal-ipmi-send-107.rst
> @@ -0,0 +1,55 @@
> +OPAL_IPMI_SEND
> +==============
> +::
> +
> +   #define OPAL_IPMI_SEND                          107
> +
> +   int64_t opal_ipmi_send(uint64_t interface,
> +                              struct opal_ipmi_msg *opal_ipmi_msg, uint64_t msg_len)
> +
> +Arguments
> +---------

Ditto mentioned in other patch.

> +::
> +
> +   uint64_t interface
> +   struct opal_ipmi_msg *opal_ipmi_msg
> +   uint64_t msg_len
> +
> +``interface``
> +   ``interface`` parameter is the value from the ipmi interface node ``ibm,ipmi-interface-id``
> +
> +``opal_ipmi_msg``
> +   ``opal_ipmi_msg`` is the pointer to below structure ``opal_ipmi_msg``
> +   struct opal_ipmi_msg {
> +        uint8_t version;
> +        uint8_t netfn;
> +        uint8_t cmd;
> +        uint8_t data[];
> +   };
> +
> +``msg_len``
> +   ipmi message request size
> +
> +``OPAL_IPMI_SEND`` call converts host OS structure ``opal_ipmi_msg`` to an
> +ipmi message structure ``ipmi_msg`` and it will send the ``msg`` into
> +ipmi message list/queue which will be queued to service processor/management
> +controller to parse and execute those ipmi commands.
> +
> +Return Values
> +-------------
> +
> +``OPAL_SUCCESS``
> +  ``msg`` queued successfully
> +
> +``OPAL_PARAMETER``
> +  invalid ipmi message request length ``msg_len``
> +
> +``OPAL_HARDWARE``
> +  ipmi backend is not present or permenant error related
> +  to ipmi hardware(MC/SP).

s/permenant/permanent
better reframe it as
"backend support is not present as bt routines are not initialised which 
is used for communication"

> +
> +``OPAL_UNSUPPORTED``
> +  in-correct opal ipmi message format version ``opal_ipmi_msg->version``
> +
> +``OPAL_RESOURCE``
> +  insufficient resources to create ``ipmi_msg`` structure
Please compile all the doc/makefile and see the html page of it in
build whether it comes properly.