diff options
Diffstat (limited to 'doc/opal-api/opal-sensor-group-enable-clear-163-156.html')
| -rw-r--r-- | doc/opal-api/opal-sensor-group-enable-clear-163-156.html | 144 |
1 files changed, 72 insertions, 72 deletions
diff --git a/doc/opal-api/opal-sensor-group-enable-clear-163-156.html b/doc/opal-api/opal-sensor-group-enable-clear-163-156.html index 0d81a07..242db09 100644 --- a/doc/opal-api/opal-sensor-group-enable-clear-163-156.html +++ b/doc/opal-api/opal-sensor-group-enable-clear-163-156.html @@ -1,21 +1,20 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!DOCTYPE html> -<html xmlns="http://www.w3.org/1999/xhtml"> +<html> <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>OPAL Sensor Groups — skiboot d6d8386 + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>OPAL Sensor Groups — skiboot e6cda17 documentation</title> - <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../_static/classic.css" /> - <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/language_data.js"></script> + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -34,9 +33,10 @@ <li class="right" > <a href="opal-secvar.html" title="OPAL Secure Variable API" accesskey="P">previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">skiboot d6d8386 + <li class="nav-item nav-item-0"><a href="../index.html">skiboot e6cda17 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-1"><a href="index.html" accesskey="U">OPAL API Documentation</a> »</li> + <li class="nav-item nav-item-this"><a href="">OPAL Sensor Groups</a></li> </ul> </div> @@ -45,14 +45,14 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="opal-sensor-groups"> + <section id="opal-sensor-groups"> <span id="id1"></span><h1>OPAL Sensor Groups<a class="headerlink" href="#opal-sensor-groups" title="Permalink to this headline">¶</a></h1> -<p>See <a class="reference internal" href="../device-tree/ibm,opal/sensor-groups.html#device-tree-ibm-opal-sensor-groups"><span class="std std-ref">ibm,opal/sensor-groups</span></a> for device tree layout.</p> -<div class="section" id="opal-sensor-group-enable"> +<p>See <a class="reference internal" href="../device-tree/ibm%2Copal/sensor-groups.html#device-tree-ibm-opal-sensor-groups"><span class="std std-ref">ibm,opal/sensor-groups</span></a> for device tree layout.</p> +<section id="opal-sensor-group-enable"> <span id="id2"></span><h2>OPAL_SENSOR_GROUP_ENABLE<a class="headerlink" href="#opal-sensor-group-enable" title="Permalink to this headline">¶</a></h2> <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_SENSOR_GROUP_ENABLE 163</span> -<span class="kt">int</span> <span class="nf">opal_sensor_group_enable</span><span class="p">(</span><span class="n">u32</span> <span class="n">group_hndl</span><span class="p">,</span> <span class="kt">int</span> <span class="n">token</span><span class="p">,</span> <span class="kt">bool</span> <span class="n">enable</span><span class="p">);</span> +<span class="kt">int</span><span class="w"> </span><span class="nf">opal_sensor_group_enable</span><span class="p">(</span><span class="n">u32</span><span class="w"> </span><span class="n">group_hndl</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">token</span><span class="p">,</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">enable</span><span class="p">);</span><span class="w"></span> </pre></div> </div> <p>OPAL call to enable/disable the sensor group using a handle to identify @@ -61,32 +61,32 @@ the type of sensor group provided in the device tree.</p> group by OCC to main memory.</p> <p>The call can be asynchronus, where the token parameter is used to wait for the completion.</p> -<div class="section" id="returns"> +<section id="returns"> <h3>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">¶</a></h3> -<dl class="docutils"> -<dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt> -<dd>Success</dd> -<dt><a class="reference internal" href="return-codes.html#opal-unsupported"><span class="std std-ref">OPAL_UNSUPPORTED</span></a></dt> -<dd>No support to enable/disable the sensor group</dd> -<dt><a class="reference internal" href="return-codes.html#opal-hardware"><span class="std std-ref">OPAL_HARDWARE</span></a></dt> -<dd>Unable to procced due to the current hardware state</dd> -<dt><a class="reference internal" href="return-codes.html#opal-permission"><span class="std std-ref">OPAL_PERMISSION</span></a></dt> -<dd>Hardware cannot take the request</dd> -<dt><a class="reference internal" href="return-codes.html#opal-async-completion"><span class="std std-ref">OPAL_ASYNC_COMPLETION</span></a></dt> -<dd>Request was sent and an async completion message will be sent with -token and status of the request.</dd> -<dt><a class="reference internal" href="return-codes.html#opal-busy"><span class="std std-ref">OPAL_BUSY</span></a></dt> -<dd>Previous request in progress</dd> -<dt><a class="reference internal" href="return-codes.html#opal-internal-error"><span class="std std-ref">OPAL_INTERNAL_ERROR</span></a></dt> -<dd>Error in request response</dd> -<dt><a class="reference internal" href="return-codes.html#opal-timeout"><span class="std std-ref">OPAL_TIMEOUT</span></a></dt> -<dd>Timeout in request completion</dd> +<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>Success</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>No support to enable/disable the sensor group</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>Unable to procced due to the current hardware state</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-permission"><span class="std std-ref">OPAL_PERMISSION</span></a></dt><dd><p>Hardware cannot take the request</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-async-completion"><span class="std std-ref">OPAL_ASYNC_COMPLETION</span></a></dt><dd><p>Request was sent and an async completion message will be sent with +token and status of the request.</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-busy"><span class="std std-ref">OPAL_BUSY</span></a></dt><dd><p>Previous request in progress</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-internal-error"><span class="std std-ref">OPAL_INTERNAL_ERROR</span></a></dt><dd><p>Error in request response</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-timeout"><span class="std std-ref">OPAL_TIMEOUT</span></a></dt><dd><p>Timeout in request completion</p> +</dd> </dl> -</div> -</div> -<div class="section" id="opal-sensor-group-clear"> +</section> +</section> +<section id="opal-sensor-group-clear"> <span id="id3"></span><h2>OPAL_SENSOR_GROUP_CLEAR<a class="headerlink" href="#opal-sensor-group-clear" title="Permalink to this headline">¶</a></h2> -<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span> <span class="nf">opal_sensor_group_clear</span><span class="p">(</span><span class="n">u32</span> <span class="n">group_hndl</span><span class="p">,</span> <span class="kt">int</span> <span class="n">token</span><span class="p">);</span> +<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span><span class="w"> </span><span class="nf">opal_sensor_group_clear</span><span class="p">(</span><span class="n">u32</span><span class="w"> </span><span class="n">group_hndl</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">token</span><span class="p">);</span><span class="w"></span> <span class="cp">#define OPAL_SENSOR_GROUP_CLEAR 156</span> </pre></div> @@ -95,32 +95,33 @@ token and status of the request.</dd> the type of sensor group which is exported via DT.</p> <p>The call can be asynchronus, where the token parameter is used to wait for the completion.</p> -<div class="section" id="id4"> +<section id="id4"> <h3>Returns<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> -<dl class="docutils"> -<dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt> -<dd>Success</dd> -<dt><a class="reference internal" href="return-codes.html#opal-unsupported"><span class="std std-ref">OPAL_UNSUPPORTED</span></a></dt> -<dd>No support for clearing the sensor group</dd> -<dt><a class="reference internal" href="return-codes.html#opal-hardware"><span class="std std-ref">OPAL_HARDWARE</span></a></dt> -<dd>Unable to procced due to the current hardware state</dd> -<dt><a class="reference internal" href="return-codes.html#opal-permission"><span class="std std-ref">OPAL_PERMISSION</span></a></dt> -<dd>Hardware cannot take the request</dd> -<dt><a class="reference internal" href="return-codes.html#opal-async-completion"><span class="std std-ref">OPAL_ASYNC_COMPLETION</span></a></dt> -<dd>Request was sent and an async completion message will be sent with -token and status of the request.</dd> -<dt><a class="reference internal" href="return-codes.html#opal-busy"><span class="std std-ref">OPAL_BUSY</span></a></dt> -<dd>Previous request in progress</dd> -<dt><a class="reference internal" href="return-codes.html#opal-internal-error"><span class="std std-ref">OPAL_INTERNAL_ERROR</span></a></dt> -<dd>Error in request response</dd> -<dt><a class="reference internal" href="return-codes.html#opal-timeout"><span class="std std-ref">OPAL_TIMEOUT</span></a></dt> -<dd>Timeout in request completion</dd> +<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>Success</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>No support for clearing the sensor group</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>Unable to procced due to the current hardware state</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-permission"><span class="std std-ref">OPAL_PERMISSION</span></a></dt><dd><p>Hardware cannot take the request</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-async-completion"><span class="std std-ref">OPAL_ASYNC_COMPLETION</span></a></dt><dd><p>Request was sent and an async completion message will be sent with +token and status of the request.</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-busy"><span class="std std-ref">OPAL_BUSY</span></a></dt><dd><p>Previous request in progress</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-internal-error"><span class="std std-ref">OPAL_INTERNAL_ERROR</span></a></dt><dd><p>Error in request response</p> +</dd> +<dt><a class="reference internal" href="return-codes.html#opal-timeout"><span class="std std-ref">OPAL_TIMEOUT</span></a></dt><dd><p>Timeout in request completion</p> +</dd> </dl> -</div> -</div> -</div> +</section> +</section> +</section> + <div class="clearer"></div> </div> </div> </div> @@ -155,17 +156,15 @@ token and status of the request.</dd> </ul> </div> <div id="searchbox" style="display: none" role="search"> - <h3>Quick search</h3> + <h3 id="searchlabel">Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> - <input type="text" name="q" /> + <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> <input type="submit" value="Go" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> </form> </div> </div> -<script type="text/javascript">$('#searchbox').show(0);</script> +<script>$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> @@ -182,14 +181,15 @@ token and status of the request.</dd> <li class="right" > <a href="opal-secvar.html" title="OPAL Secure Variable API" >previous</a> |</li> - <li class="nav-item nav-item-0"><a href="../index.html">skiboot d6d8386 + <li class="nav-item nav-item-0"><a href="../index.html">skiboot e6cda17 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-1"><a href="index.html" >OPAL API Documentation</a> »</li> + <li class="nav-item nav-item-this"><a href="">OPAL Sensor Groups</a></li> </ul> </div> <div class="footer" role="contentinfo"> © Copyright 2016-2017, IBM, others. - Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5. + Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2. </div> </body> </html>
\ No newline at end of file |