blob: 58bae94b9bb8f6215eb21e868dcbc079ac4e854d [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_PCI_EEH_FREEZE_STATUS &#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_PCI_ERR_INJECT" href="opal-pci-err-inject-96.html" />
<link rel="prev" title="OPAL_PCI_EEH_FREEZE_SET" href="opal-pci-eeh-freeze-set-97.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-pci-err-inject-96.html" title="OPAL_PCI_ERR_INJECT"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="opal-pci-eeh-freeze-set-97.html" title="OPAL_PCI_EEH_FREEZE_SET"
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_PCI_EEH_FREEZE_STATUS</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="opal-pci-eeh-freeze-status">
<span id="id1"></span><h1>OPAL_PCI_EEH_FREEZE_STATUS<a class="headerlink" href="#opal-pci-eeh-freeze-status" title="Link to this heading"></a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_PCI_EEH_FREEZE_STATUS 23</span>
<span class="k">enum</span><span class="w"> </span><span class="n">OpalFreezeState</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">OPAL_EEH_STOPPED_NOT_FROZEN</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_STOPPED_MMIO_FREEZE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_STOPPED_DMA_FREEZE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_STOPPED_MMIO_DMA_FREEZE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_STOPPED_RESET</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_STOPPED_TEMP_UNAVAIL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_STOPPED_PERM_UNAVAIL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">6</span>
<span class="p">};</span>
<span class="k">enum</span><span class="w"> </span><span class="n">OpalPciStatusToken</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">OPAL_EEH_NO_ERROR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_IOC_ERROR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_PHB_ERROR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_PE_ERROR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_PE_MMIO_ERROR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
<span class="w"> </span><span class="n">OPAL_EEH_PE_DMA_ERROR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span>
<span class="p">};</span>
<span class="kt">int64_t</span><span class="w"> </span><span class="nf">opal_pci_eeh_freeze_status</span><span class="p">(</span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">phb_id</span><span class="p">,</span><span class="w"> </span><span class="kt">uint64_t</span><span class="w"> </span><span class="n">pe_number</span><span class="p">,</span>
<span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">freeze_state</span><span class="p">,</span>
<span class="w"> </span><span class="kt">uint16_t</span><span class="w"> </span><span class="o">*</span><span class="n">pci_error_type</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">phb_status</span><span class="p">);</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code class="docutils literal notranslate"><span class="pre">phb_status</span></code> parameter is deprecated as
of <a class="reference internal" href="../release-notes/skiboot-6.3-rc1.html#skiboot-6-3-rc1"><span class="std std-ref">skiboot-6.3-rc1</span></a>. Linux only ever passed in NULL,
and this was safe. Supplying a pointer was previously <em>unsafe</em>.
Always pass NULL.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>There once was a <a class="reference internal" href="#opal-pci-eeh-freeze-status2"><span class="std std-ref">OPAL_PCI_EEH_FREEZE_STATUS2</span></a> call, but it
was introduced in firmware and never used by any OS, so it has since
been removed from OPAL.</p>
</div>
<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-parameter"><span class="std std-ref">OPAL_PARAMETER</span></a></dt><dd><p>Invalid address or PHB.</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>PHB does not support this operation.</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>Hardware prohibited getting status, OPAL maybe marked it as broken.</p>
</dd>
<dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt><dd><p>Retreived status.</p>
</dd>
</dl>
</section>
</section>
<section id="opal-pci-eeh-freeze-status2">
<span id="id2"></span><h1>OPAL_PCI_EEH_FREEZE_STATUS2<a class="headerlink" href="#opal-pci-eeh-freeze-status2" title="Link to this heading"></a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_PCI_EEH_FREEZE_STATUS2 61</span>
</pre></div>
</div>
<p>Use <a class="reference internal" href="#opal-pci-eeh-freeze-status"><span class="std std-ref">OPAL_PCI_EEH_FREEZE_STATUS</span></a> instead of this (removed) call.</p>
<p>While you’d think that a call introduced in the first public OPAL release would
have been used somewhere, it seems that all existing code has only ever used
<a class="reference internal" href="#opal-pci-eeh-freeze-status"><span class="std std-ref">OPAL_PCI_EEH_FREEZE_STATUS</span></a> over <a class="reference internal" href="#opal-pci-eeh-freeze-status2"><span class="std std-ref">OPAL_PCI_EEH_FREEZE_STATUS2</span></a>.</p>
<p>This call has been removed as of <a class="reference internal" href="../release-notes/skiboot-6.4.html#skiboot-6-4"><span class="std std-ref">skiboot-6.4</span></a> as it has literally never
been used.</p>
</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_PCI_EEH_FREEZE_STATUS</a><ul>
<li><a class="reference internal" href="#returns">Returns</a></li>
</ul>
</li>
<li><a class="reference internal" href="#opal-pci-eeh-freeze-status2">OPAL_PCI_EEH_FREEZE_STATUS2</a></li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="opal-pci-eeh-freeze-set-97.html"
title="previous chapter">OPAL_PCI_EEH_FREEZE_SET</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="opal-pci-err-inject-96.html"
title="next chapter">OPAL_PCI_ERR_INJECT</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-pci-eeh-freeze-status-23.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-pci-err-inject-96.html" title="OPAL_PCI_ERR_INJECT"
>next</a> |</li>
<li class="right" >
<a href="opal-pci-eeh-freeze-set-97.html" title="OPAL_PCI_EEH_FREEZE_SET"
>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_PCI_EEH_FREEZE_STATUS</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>