doc/opal-api/opal-pci-get-presence-state-119.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_PCI_GET_PRESENCE_STATE &#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_GET_PBCQ_TUNNEL_BAR" href="opal-pci-get-set-pbcq-tunnel-bar-164-165.html" />
     <link rel="prev" title="OPAL_PCI_GET_POWER_STATE" href="opal-pci-get-power-state-120.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-get-set-pbcq-tunnel-bar-164-165.html" title="OPAL_PCI_GET_PBCQ_TUNNEL_BAR"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="opal-pci-get-power-state-120.html" title="OPAL_PCI_GET_POWER_STATE"
              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_GET_PRESENCE_STATE</a></li>
       </ul>
     </div>

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

   <section id="opal-pci-get-presence-state">
 <span id="id1"></span><h1>OPAL_PCI_GET_PRESENCE_STATE<a class="headerlink" href="#opal-pci-get-presence-state" title="Link to this heading">¶</a></h1>
 <p>Get PCI slot presence state</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">uint64_t</span> <span class="pre">id</span></code></dt><dd><p>PCI slot ID</p>
 </dd>
 <dt><code class="docutils literal notranslate"><span class="pre">uint64_t</span> <span class="pre">data</span></code></dt><dd><p>memory buffer pointer for presence state</p>
 </dd>
 </dl>
 </section>
 <section id="calling">
 <h2>Calling<a class="headerlink" href="#calling" title="Link to this heading">¶</a></h2>
 <p>Retrieve PCI slot’s presence state. The detected presence means there are
 adapters inserted to the PCI slot. Otherwise, the PCI slot is regarded as
 an empty one. The typical use is to ensure there are adapters existing
 before probing the PCI slot in PCI hot add path. The retrieved presence
 state is stored in buffer pointed by &#64;data.</p>
 </section>
 <section id="return-codes">
 <h2>Return Codes<a class="headerlink" href="#return-codes" 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>PCI slot’s presence state is retrieved 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>The indicated PCI slot isn’t found</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>Presence retrieval not supported on the PCI slot</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_PCI_GET_PRESENCE_STATE</a><ul>
 <li><a class="reference internal" href="#parameters">Parameters</a></li>
 <li><a class="reference internal" href="#calling">Calling</a></li>
 <li><a class="reference internal" href="#return-codes">Return Codes</a></li>
 </ul>
 </li>
 </ul>

   </div>
   <div>
     <h4>Previous topic</h4>
     <p class="topless"><a href="opal-pci-get-power-state-120.html"
                           title="previous chapter">OPAL_PCI_GET_POWER_STATE</a></p>
   </div>
   <div>
     <h4>Next topic</h4>
     <p class="topless"><a href="opal-pci-get-set-pbcq-tunnel-bar-164-165.html"
                           title="next chapter">OPAL_PCI_GET_PBCQ_TUNNEL_BAR</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-get-presence-state-119.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-get-set-pbcq-tunnel-bar-164-165.html" title="OPAL_PCI_GET_PBCQ_TUNNEL_BAR"
              >next</a> |</li>
         <li class="right" >
           <a href="opal-pci-get-power-state-120.html" title="OPAL_PCI_GET_POWER_STATE"
              >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_GET_PRESENCE_STATE</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_PCI_GET_PRESENCE_STATE — 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_GET_PBCQ_TUNNEL_BAR" href="opal-pci-get-set-pbcq-tunnel-bar-164-165.html" />
	<link rel="prev" title="OPAL_PCI_GET_POWER_STATE" href="opal-pci-get-power-state-120.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-get-set-pbcq-tunnel-bar-164-165.html" title="OPAL_PCI_GET_PBCQ_TUNNEL_BAR"
	accesskey="N">next</a> \|</li>
	<li class="right" >
	<a href="opal-pci-get-power-state-120.html" title="OPAL_PCI_GET_POWER_STATE"
	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_PCI_GET_PRESENCE_STATE</a></li>
	</ul>
	</div>

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

	<section id="opal-pci-get-presence-state">
	<span id="id1"></span><h1>OPAL_PCI_GET_PRESENCE_STATE<a class="headerlink" href="#opal-pci-get-presence-state" title="Link to this heading">¶</a></h1>
	<p>Get PCI slot presence state</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">uint64_t</span> <span class="pre">id</span></code></dt><dd><p>PCI slot ID</p>
	</dd>
	<dt><code class="docutils literal notranslate"><span class="pre">uint64_t</span> <span class="pre">data</span></code></dt><dd><p>memory buffer pointer for presence state</p>
	</dd>
	</dl>
	</section>
	<section id="calling">
	<h2>Calling<a class="headerlink" href="#calling" title="Link to this heading">¶</a></h2>
	<p>Retrieve PCI slot’s presence state. The detected presence means there are
	adapters inserted to the PCI slot. Otherwise, the PCI slot is regarded as
	an empty one. The typical use is to ensure there are adapters existing
	before probing the PCI slot in PCI hot add path. The retrieved presence
	state is stored in buffer pointed by @data.</p>
	</section>
	<section id="return-codes">
	<h2>Return Codes<a class="headerlink" href="#return-codes" 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>PCI slot’s presence state is retrieved 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>The indicated PCI slot isn’t found</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>Presence retrieval not supported on the PCI slot</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_PCI_GET_PRESENCE_STATE</a><ul>
	<li><a class="reference internal" href="#parameters">Parameters</a></li>
	<li><a class="reference internal" href="#calling">Calling</a></li>
	<li><a class="reference internal" href="#return-codes">Return Codes</a></li>
	</ul>
	</li>
	</ul>

	</div>
	<div>
	<h4>Previous topic</h4>
	<p class="topless"><a href="opal-pci-get-power-state-120.html"
	title="previous chapter">OPAL_PCI_GET_POWER_STATE</a></p>
	</div>
	<div>
	<h4>Next topic</h4>
	<p class="topless"><a href="opal-pci-get-set-pbcq-tunnel-bar-164-165.html"
	title="next chapter">OPAL_PCI_GET_PBCQ_TUNNEL_BAR</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-get-presence-state-119.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-get-set-pbcq-tunnel-bar-164-165.html" title="OPAL_PCI_GET_PBCQ_TUNNEL_BAR"
	>next</a> \|</li>
	<li class="right" >
	<a href="opal-pci-get-power-state-120.html" title="OPAL_PCI_GET_POWER_STATE"
	>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_PCI_GET_PRESENCE_STATE</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>