diff options
author | Pridhiviraj Paidipeddi <ppaidipe@linux.vnet.ibm.com> | 2016-08-11 16:30:04 +0530 |
---|---|---|
committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-08-30 14:30:12 +1000 |
commit | 9ffc4ee8bb7c2dfd6457bb13d3487c322285b50e (patch) | |
tree | d4138c53f777cc2a72d40bceb636969374a82aff /doc/opal-api | |
parent | 365e06721121b4a6b2602164c910354cb464b4a7 (diff) | |
download | skiboot-9ffc4ee8bb7c2dfd6457bb13d3487c322285b50e.zip skiboot-9ffc4ee8bb7c2dfd6457bb13d3487c322285b50e.tar.gz skiboot-9ffc4ee8bb7c2dfd6457bb13d3487c322285b50e.tar.bz2 |
doc/opal-api: Documentation for opal-ipmi-send-recv
This patch adds documentation for OPAL_IPMI_SEND and OPAL_IPMI_RECV
Signed-off-by: Pridhiviraj Paidipeddi <ppaidipe@linux.vnet.ibm.com>
Reviewed-by: Mukesh Ojha <mukesh02@linux.vnet.ibm.com>
[stewart@linux.vnet.ibm.com: slight reword]
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc/opal-api')
-rw-r--r-- | doc/opal-api/opal-ipmi-send-recv-107-108.rst | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/doc/opal-api/opal-ipmi-send-recv-107-108.rst b/doc/opal-api/opal-ipmi-send-recv-107-108.rst new file mode 100644 index 0000000..581f106 --- /dev/null +++ b/doc/opal-api/opal-ipmi-send-recv-107-108.rst @@ -0,0 +1,102 @@ +OPAL_IPMI_SEND +============== +:: + + #define OPAL_IPMI_SEND 107 + +``OPAL_IPMI_SEND`` call will send an IPMI message to the service processor. + +Parameters +---------- +:: + + 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 + +Return Values +------------- + +``OPAL_SUCCESS`` + ``msg`` queued successfully + +``OPAL_PARAMETER`` + invalid ipmi message request length ``msg_len`` + +``OPAL_HARDWARE`` + backend support is not present as block transfer/service processor ipmi routines are not + initialized which are 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 + +OPAL_IPMI_RECV +============== +:: + + #define OPAL_IPMI_RECV 108 + +``OPAL_IPMI_RECV`` call reads an ipmi message of type ``ipmi_msg`` from ipmi message +queue ``msgq`` into host OS structure ``opal_ipmi_msg``. + +Parameters +---------- +:: + + 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`` + ``msg_len`` is the pointer to ipmi message response size + +Return Values +------------- + +``OPAL_SUCCESS`` + ipmi message dequeued from ``msgq`` queue and memory taken by it got released successfully + +``OPAL_EMPTY`` + ``msgq`` list is empty + +``OPAL_PARAMETER`` + invalid ipmi ``interface`` value + +``OPAL_UNSUPPORTED`` + in-correct opal ipmi message format version ``opal_ipmi_msg->version`` |