Google Git
Sign in
qemu / skiboot / refs/heads/gh-pages / . / doc / opal-api / opal-xscom-read-write-65-66.html
blob: 31c09ae00fdb9b344d71fcbb26630e51747c6240 [file] [log] [blame]
<!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_XSCOM_READ &#8212; 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="OPAL_NX_COPROC_INIT" href="opal_nx_coproc_init-167.html" />
<link rel="prev" title="OPAL_WRITE_OPPANEL_ASYNC" href="opal-write-oppanel-async-95.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_nx_coproc_init-167.html" title="OPAL_NX_COPROC_INIT"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="opal-write-oppanel-async-95.html" title="OPAL_WRITE_OPPANEL_ASYNC"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">skiboot d365a01
documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">OPAL API Documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">OPAL_XSCOM_READ</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="opal-xscom-read">
<span id="id1"></span><h1>OPAL_XSCOM_READ<a class="headerlink" href="#opal-xscom-read" title="Link to this heading"></a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_XSCOM_READ 65</span>
<span class="kt">int</span><span class="w"> </span><span class="nf">xscom_read</span><span class="p">(</span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">partid</span><span class="p">,</span><span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">pcb_addr</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">val</span><span class="p">);</span>
</pre></div>
</div>
<p>This low level call will read XSCOM values directly.</p>
<p>They should only be used by low level manufacturing/debug tools.
“Normal” host OS kernel code should not know about XSCOM.</p>
<p>This is also needed by HBRT/<cite>opal-prd</cite>.</p>
<section id="returns">
<h2>Returns<a class="headerlink" href="#returns" 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>Success!</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>if operation failed</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-wrong-state"><span class="std std-ref">OPAL_WRONG_STATE</span></a></dt><dd><p>if CPU is asleep</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-busy"><span class="std std-ref">OPAL_XSCOM_BUSY</span></a></dt><dd><p>Alias for <a class="reference internal" href="return-codes.html#opal-busy"><span class="std std-ref">OPAL_BUSY</span></a>.</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-chiplet-off"><span class="std std-ref">OPAL_XSCOM_CHIPLET_OFF</span></a></dt><dd><p>Alias for <a class="reference internal" href="return-codes.html#opal-wrong-state"><span class="std std-ref">OPAL_WRONG_STATE</span></a></p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-partial-good"><span class="std std-ref">OPAL_XSCOM_PARTIAL_GOOD</span></a></dt><dd><p>XSCOM Partial Good</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-addr-error"><span class="std std-ref">OPAL_XSCOM_ADDR_ERROR</span></a></dt><dd><p>XSCOM Address Error</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-clock-error"><span class="std std-ref">OPAL_XSCOM_CLOCK_ERROR</span></a></dt><dd><p>XSCOM Clock Error</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-parity-error"><span class="std std-ref">OPAL_XSCOM_PARITY_ERROR</span></a></dt><dd><p>XSCOM Parity Error</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-timeout"><span class="std std-ref">OPAL_XSCOM_TIMEOUT</span></a></dt><dd><p>XSCOM Timeout</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-ctr-offlined"><span class="std std-ref">OPAL_XSCOM_CTR_OFFLINED</span></a></dt><dd><p>XSCOM Controller Offlined due to too many errors.</p>
</dd>
</dl>
</section>
</section>
<section id="opal-xscom-write">
<span id="id2"></span><h1>OPAL_XSCOM_WRITE<a class="headerlink" href="#opal-xscom-write" title="Link to this heading"></a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_XSCOM_WRITE 66</span>
<span class="kt">int</span><span class="w"> </span><span class="nf">xscom_write</span><span class="p">(</span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">partid</span><span class="p">,</span><span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">pcb_addr</span><span class="p">,</span><span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">val</span><span class="p">);</span>
</pre></div>
</div>
<p>This low level call will write an XSCOM value directly.</p>
<p>They should only be used by low level manufacturing/debug tools.
“Normal” host OS kernel code should not know about XSCOM.</p>
<p>This is also needed by HBRT/<cite>opal-prd</cite>.</p>
<section id="id3">
<h2>Returns<a class="headerlink" href="#id3" 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>Success!</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>if operation failed</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-wrong-state"><span class="std std-ref">OPAL_WRONG_STATE</span></a></dt><dd><p>if CPU is asleep</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-busy"><span class="std std-ref">OPAL_XSCOM_BUSY</span></a></dt><dd><p>Alias for <a class="reference internal" href="return-codes.html#opal-busy"><span class="std std-ref">OPAL_BUSY</span></a>.</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-chiplet-off"><span class="std std-ref">OPAL_XSCOM_CHIPLET_OFF</span></a></dt><dd><p>Alias for <a class="reference internal" href="return-codes.html#opal-wrong-state"><span class="std std-ref">OPAL_WRONG_STATE</span></a></p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-partial-good"><span class="std std-ref">OPAL_XSCOM_PARTIAL_GOOD</span></a></dt><dd><p>XSCOM Partial Good</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-addr-error"><span class="std std-ref">OPAL_XSCOM_ADDR_ERROR</span></a></dt><dd><p>XSCOM Address Error</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-clock-error"><span class="std std-ref">OPAL_XSCOM_CLOCK_ERROR</span></a></dt><dd><p>XSCOM Clock Error</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-parity-error"><span class="std std-ref">OPAL_XSCOM_PARITY_ERROR</span></a></dt><dd><p>XSCOM Parity Error</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-timeout"><span class="std std-ref">OPAL_XSCOM_TIMEOUT</span></a></dt><dd><p>XSCOM Timeout</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-xscom-ctr-offlined"><span class="std std-ref">OPAL_XSCOM_CTR_OFFLINED</span></a></dt><dd><p>XSCOM Controller Offlined due to too many errors.</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_XSCOM_READ</a><ul>
<li><a class="reference internal" href="#returns">Returns</a></li>
</ul>
</li>
<li><a class="reference internal" href="#opal-xscom-write">OPAL_XSCOM_WRITE</a><ul>
<li><a class="reference internal" href="#id3">Returns</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="opal-write-oppanel-async-95.html"
title="previous chapter">OPAL_WRITE_OPPANEL_ASYNC</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="opal_nx_coproc_init-167.html"
title="next chapter">OPAL_NX_COPROC_INIT</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-xscom-read-write-65-66.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_nx_coproc_init-167.html" title="OPAL_NX_COPROC_INIT"
>next</a> |</li>
<li class="right" >
<a href="opal-write-oppanel-async-95.html" title="OPAL_WRITE_OPPANEL_ASYNC"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">skiboot d365a01
documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" >OPAL API Documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">OPAL_XSCOM_READ</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2016-2017, IBM, others.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>