| <!DOCTYPE html> |
| |
| <html lang="en" data-content_root="../"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <title>OPAL_IPMI_SEND — skiboot d365a01 |
| documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" /> |
| <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=514cf933" /> |
| |
| <script src="../_static/documentation_options.js?v=e1fecbe9"></script> |
| <script src="../_static/doctools.js?v=888ff710"></script> |
| <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> |
| |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Service Indicators (LEDS)" href="opal-led-get-set-114-115.html" /> |
| <link rel="prev" title="OPAL_INVALID_CALL" href="opal-invalid-call--1.html" /> |
| </head><body> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="../genindex.html" title="General Index" |
| accesskey="I">index</a></li> |
| <li class="right" > |
| <a href="opal-led-get-set-114-115.html" title="Service Indicators (LEDS)" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="opal-invalid-call--1.html" title="OPAL_INVALID_CALL" |
| accesskey="P">previous</a> |</li> |
| <li class="nav-item nav-item-0"><a href="../index.html">skiboot d365a01 |
| documentation</a> »</li> |
| <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">OPAL API Documentation</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">OPAL_IPMI_SEND</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <section id="opal-ipmi-send"> |
| <span id="id1"></span><h1>OPAL_IPMI_SEND<a class="headerlink" href="#opal-ipmi-send" title="Link to this heading">¶</a></h1> |
| <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_IPMI_SEND 107</span> |
| |
| <span class="k">enum</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">OPAL_IPMI_MSG_FORMAT_VERSION_1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> |
| <span class="p">};</span> |
| |
| <span class="k">struct</span><span class="w"> </span><span class="nc">opal_ipmi_msg</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">version</span><span class="p">;</span> |
| <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">netfn</span><span class="p">;</span> |
| <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">cmd</span><span class="p">;</span> |
| <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">data</span><span class="p">[];</span> |
| <span class="p">};</span> |
| |
| <span class="kt">int64_t</span><span class="w"> </span><span class="nf">opal_ipmi_send</span><span class="p">(</span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">interface</span><span class="p">,</span> |
| <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">opal_ipmi_msg</span><span class="w"> </span><span class="o">*</span><span class="n">opal_ipmi_msg</span><span class="p">,</span><span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">msg_len</span><span class="p">);</span> |
| </pre></div> |
| </div> |
| <p><a class="reference internal" href="#opal-ipmi-send"><span class="std std-ref">OPAL_IPMI_SEND</span></a> call will send an IPMI message to the service processor.</p> |
| <section id="parameters"> |
| <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this heading">¶</a></h2> |
| <dl class="simple"> |
| <dt><code class="docutils literal notranslate"><span class="pre">interface</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">interface</span></code> parameter is the value from the ipmi interface node <code class="docutils literal notranslate"><span class="pre">ibm,ipmi-interface-id</span></code></p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">opal_ipmi_msg</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">opal_ipmi_msg</span></code> is the pointer to a <code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">opal_ipmi_msg</span></code> (see above)</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">msg_len</span></code></dt><dd><p>ipmi message request size</p> |
| </dd> |
| </dl> |
| </section> |
| <section id="return-values"> |
| <h2>Return Values<a class="headerlink" href="#return-values" title="Link to this heading">¶</a></h2> |
| <dl class="simple"> |
| <dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt><dd><p><code class="docutils literal notranslate"><span class="pre">msg</span></code> queued successfully</p> |
| </dd> |
| <dt><a class="reference internal" href="return-codes.html#opal-parameter"><span class="std std-ref">OPAL_PARAMETER</span></a></dt><dd><p>invalid ipmi message request length <code class="docutils literal notranslate"><span class="pre">msg_len</span></code></p> |
| </dd> |
| <dt><a class="reference internal" href="return-codes.html#opal-hardware"><span class="std std-ref">OPAL_HARDWARE</span></a></dt><dd><p>backend support is not present as block transfer/service processor ipmi routines are not |
| initialized which are used for communication</p> |
| </dd> |
| <dt><a class="reference internal" href="return-codes.html#opal-unsupported"><span class="std std-ref">OPAL_UNSUPPORTED</span></a></dt><dd><p>in-correct opal ipmi message format version <code class="docutils literal notranslate"><span class="pre">opal_ipmi_msg->version</span></code></p> |
| </dd> |
| <dt><a class="reference internal" href="return-codes.html#opal-resource"><span class="std std-ref">OPAL_RESOURCE</span></a></dt><dd><p>insufficient resources to create <code class="docutils literal notranslate"><span class="pre">ipmi_msg</span></code> structure</p> |
| </dd> |
| </dl> |
| </section> |
| </section> |
| <section id="opal-ipmi-recv"> |
| <span id="id2"></span><h1>OPAL_IPMI_RECV<a class="headerlink" href="#opal-ipmi-recv" title="Link to this heading">¶</a></h1> |
| <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_IPMI_RECV 108</span> |
| |
| <span class="k">enum</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="n">OPAL_IPMI_MSG_FORMAT_VERSION_1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span> |
| <span class="p">};</span> |
| |
| <span class="k">struct</span><span class="w"> </span><span class="nc">opal_ipmi_msg</span><span class="w"> </span><span class="p">{</span> |
| <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">version</span><span class="p">;</span> |
| <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">netfn</span><span class="p">;</span> |
| <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">cmd</span><span class="p">;</span> |
| <span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">data</span><span class="p">[];</span> |
| <span class="p">};</span> |
| |
| <span class="kt">int64_t</span><span class="w"> </span><span class="n">opal_ipmi_recv</span><span class="p">(</span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">interface</span><span class="p">,</span> |
| <span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">opal_ipmi_msg</span><span class="w"> </span><span class="o">*</span><span class="n">opal_ipmi_msg</span><span class="p">,</span><span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="o">*</span><span class="n">msg_len</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p><code class="docutils literal notranslate"><span class="pre">OPAL_IPMI_RECV</span></code> call reads an ipmi message of type <code class="docutils literal notranslate"><span class="pre">ipmi_msg</span></code> from ipmi message |
| queue <code class="docutils literal notranslate"><span class="pre">msgq</span></code> into host OS structure <code class="docutils literal notranslate"><span class="pre">opal_ipmi_msg</span></code>.</p> |
| <section id="id3"> |
| <h2>Parameters<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h2> |
| <dl class="simple"> |
| <dt><code class="docutils literal notranslate"><span class="pre">interface</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">interface</span></code> parameter is the value from the ipmi interface node <code class="docutils literal notranslate"><span class="pre">ibm,ipmi-interface-id</span></code></p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">opal_ipmi_msg</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">opal_ipmi_msg</span></code> is the pointer to a <code class="docutils literal notranslate"><span class="pre">struct</span> <span class="pre">opal_ipmi_msg</span></code> (see above)</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">msg_len</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">msg_len</span></code> is the pointer to ipmi message response size</p> |
| </dd> |
| </dl> |
| </section> |
| <section id="id4"> |
| <h2>Return Values<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h2> |
| <dl class="simple"> |
| <dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt><dd><p>ipmi message dequeued from <code class="docutils literal notranslate"><span class="pre">msgq</span></code> queue and memory taken by it got released successfully</p> |
| </dd> |
| <dt><a class="reference internal" href="return-codes.html#opal-empty"><span class="std std-ref">OPAL_EMPTY</span></a></dt><dd><p><code class="docutils literal notranslate"><span class="pre">msgq</span></code> list is empty</p> |
| </dd> |
| <dt>ref:<cite>OPAL_PARAMETER</cite></dt><dd><p>invalid ipmi <code class="docutils literal notranslate"><span class="pre">interface</span></code> value</p> |
| </dd> |
| <dt><a class="reference internal" href="return-codes.html#opal-unsupported"><span class="std std-ref">OPAL_UNSUPPORTED</span></a></dt><dd><p>incorrect opal ipmi message format version <code class="docutils literal notranslate"><span class="pre">opal_ipmi_msg->version</span></code></p> |
| </dd> |
| </dl> |
| </section> |
| </section> |
| |
| |
| <div class="clearer"></div> |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <div> |
| <h3><a href="../index.html">Table of Contents</a></h3> |
| <ul> |
| <li><a class="reference internal" href="#">OPAL_IPMI_SEND</a><ul> |
| <li><a class="reference internal" href="#parameters">Parameters</a></li> |
| <li><a class="reference internal" href="#return-values">Return Values</a></li> |
| </ul> |
| </li> |
| <li><a class="reference internal" href="#opal-ipmi-recv">OPAL_IPMI_RECV</a><ul> |
| <li><a class="reference internal" href="#id3">Parameters</a></li> |
| <li><a class="reference internal" href="#id4">Return Values</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| <div> |
| <h4>Previous topic</h4> |
| <p class="topless"><a href="opal-invalid-call--1.html" |
| title="previous chapter">OPAL_INVALID_CALL</a></p> |
| </div> |
| <div> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="opal-led-get-set-114-115.html" |
| title="next chapter">Service Indicators (LEDS)</a></p> |
| </div> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/opal-api/opal-ipmi-send-recv-107-108.rst.txt" |
| rel="nofollow">Show Source</a></li> |
| </ul> |
| </div> |
| <div id="searchbox" style="display: none" role="search"> |
| <h3 id="searchlabel">Quick search</h3> |
| <div class="searchformwrapper"> |
| <form class="search" action="../search.html" method="get"> |
| <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> |
| <input type="submit" value="Go" /> |
| </form> |
| </div> |
| </div> |
| <script>document.getElementById('searchbox').style.display = "block"</script> |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="../genindex.html" title="General Index" |
| >index</a></li> |
| <li class="right" > |
| <a href="opal-led-get-set-114-115.html" title="Service Indicators (LEDS)" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="opal-invalid-call--1.html" title="OPAL_INVALID_CALL" |
| >previous</a> |</li> |
| <li class="nav-item nav-item-0"><a href="../index.html">skiboot d365a01 |
| documentation</a> »</li> |
| <li class="nav-item nav-item-1"><a href="index.html" >OPAL API Documentation</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">OPAL_IPMI_SEND</a></li> |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2016-2017, IBM, others. |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6. |
| </div> |
| </body> |
| </html> |
