doc/opal-api/opal_nx_coproc_init-167.html - skiboot - Git at Google

 <!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_NX_COPROC_INIT &#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="POWER9 Changes to OPAL API" href="power9-changes.html" />
     <link rel="prev" title="OPAL_XSCOM_READ" href="opal-xscom-read-write-65-66.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="power9-changes.html" title="POWER9 Changes to OPAL API"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="opal-xscom-read-write-65-66.html" title="OPAL_XSCOM_READ"
              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_NX_COPROC_INIT</a></li>
       </ul>
     </div>

     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
           <div class="body" role="main">

   <section id="opal-nx-coproc-init">
 <span id="id1"></span><h1>OPAL_NX_COPROC_INIT<a class="headerlink" href="#opal-nx-coproc-init" title="Link to this heading">¶</a></h1>
 <p>This OPAL call resets read offset and queued entries in high and normal
 priority receive FIFO control registers. The kernel initializes read
 offset entry in RXFIFO that it maintains during initialization. So this
 register reset is needed for NX module reload or in kexec boot to make sure
 read offset value matches with kernel entries. Otherwise NX reads requests
 with wrong offset in RxFIFO which could cause NX request failures.</p>
 <p>The kernel initiates this call for each coprocessor type such as 842 and
 GZIP per NX instance.</p>
 <section id="arguments">
 <h2>Arguments<a class="headerlink" href="#arguments" title="Link to this heading">¶</a></h2>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>``uint32_t chip_id``
   Contains value of the chip number identified at boot time.

 ``uint32_t pid``
   Contains NX coprocessor type (pid from the device tree).
 </pre></div>
 </div>
 </section>
 <section id="returns">
 <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading">¶</a></h2>
 <dl class="simple">
 <dt>OPAL_SUCCESS</dt><dd><p>The call to reset readOffset and queued entries for high and normal
 FIFOs was successful.</p>
 </dd>
 <dt>OPAL_PARAMETER</dt><dd><p>Indicates invalid chip ID or NX coprocessor type.</p>
 </dd>
 <dt>OPAL_UNSUPPORTED</dt><dd><p>Not supported on P7 and P8.</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_NX_COPROC_INIT</a><ul>
 <li><a class="reference internal" href="#arguments">Arguments</a></li>
 <li><a class="reference internal" href="#returns">Returns</a></li>
 </ul>
 </li>
 </ul>

   </div>
   <div>
     <h4>Previous topic</h4>
     <p class="topless"><a href="opal-xscom-read-write-65-66.html"
                           title="previous chapter">OPAL_XSCOM_READ</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
     <p class="topless"><a href="power9-changes.html"
                           title="next chapter">POWER9 Changes to OPAL API</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_nx_coproc_init-167.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="power9-changes.html" title="POWER9 Changes to OPAL API"
              >next</a> |</li>
         <li class="right" >
           <a href="opal-xscom-read-write-65-66.html" title="OPAL_XSCOM_READ"
              >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_NX_COPROC_INIT</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>
	<!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_NX_COPROC_INIT — 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="POWER9 Changes to OPAL API" href="power9-changes.html" />
	<link rel="prev" title="OPAL_XSCOM_READ" href="opal-xscom-read-write-65-66.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="power9-changes.html" title="POWER9 Changes to OPAL API"
	accesskey="N">next</a> \|</li>
	<li class="right" >
	<a href="opal-xscom-read-write-65-66.html" title="OPAL_XSCOM_READ"
	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_NX_COPROC_INIT</a></li>
	</ul>
	</div>

	<div class="document">
	<div class="documentwrapper">
	<div class="bodywrapper">
	<div class="body" role="main">

	<section id="opal-nx-coproc-init">
	<span id="id1"></span><h1>OPAL_NX_COPROC_INIT<a class="headerlink" href="#opal-nx-coproc-init" title="Link to this heading">¶</a></h1>
	<p>This OPAL call resets read offset and queued entries in high and normal
	priority receive FIFO control registers. The kernel initializes read
	offset entry in RXFIFO that it maintains during initialization. So this
	register reset is needed for NX module reload or in kexec boot to make sure
	read offset value matches with kernel entries. Otherwise NX reads requests
	with wrong offset in RxFIFO which could cause NX request failures.</p>
	<p>The kernel initiates this call for each coprocessor type such as 842 and
	GZIP per NX instance.</p>
	<section id="arguments">
	<h2>Arguments<a class="headerlink" href="#arguments" title="Link to this heading">¶</a></h2>
	<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>``uint32_t chip_id``
	Contains value of the chip number identified at boot time.

	``uint32_t pid``
	Contains NX coprocessor type (pid from the device tree).
	</pre></div>
	</div>
	</section>
	<section id="returns">
	<h2>Returns<a class="headerlink" href="#returns" title="Link to this heading">¶</a></h2>
	<dl class="simple">
	<dt>OPAL_SUCCESS</dt><dd><p>The call to reset readOffset and queued entries for high and normal
	FIFOs was successful.</p>
	</dd>
	<dt>OPAL_PARAMETER</dt><dd><p>Indicates invalid chip ID or NX coprocessor type.</p>
	</dd>
	<dt>OPAL_UNSUPPORTED</dt><dd><p>Not supported on P7 and P8.</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_NX_COPROC_INIT</a><ul>
	<li><a class="reference internal" href="#arguments">Arguments</a></li>
	<li><a class="reference internal" href="#returns">Returns</a></li>
	</ul>
	</li>
	</ul>

	</div>
	<div>
	<h4>Previous topic</h4>
	<p class="topless"><a href="opal-xscom-read-write-65-66.html"
	title="previous chapter">OPAL_XSCOM_READ</a></p>
	</div>
	<div>
	<h4>Next topic</h4>
	<p class="topless"><a href="power9-changes.html"
	title="next chapter">POWER9 Changes to OPAL API</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_nx_coproc_init-167.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="power9-changes.html" title="POWER9 Changes to OPAL API"
	>next</a> \|</li>
	<li class="right" >
	<a href="opal-xscom-read-write-65-66.html" title="OPAL_XSCOM_READ"
	>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_NX_COPROC_INIT</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>