doc/opal-api/opal-query-cpu-status-42.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>OPAL_QUERY_CPU_STATUS &#8212; skiboot 5133e1e
 documentation</title>
    <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/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>
    
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="OPAL_QUIESCE" href="opal-quiesce-158.html" />
    <link rel="prev" title="OPAL_PRD_MSG" href="opal-prd-msg-113.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-quiesce-158.html" title="OPAL_QUIESCE"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="opal-prd-msg-113.html" title="OPAL_PRD_MSG"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">skiboot 5133e1e
 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">OPAL API Documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="opal-query-cpu-status">
<span id="id1"></span><h1>OPAL_QUERY_CPU_STATUS<a class="headerlink" href="#opal-query-cpu-status" title="Permalink to this headline">¶</a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_QUERY_CPU_STATUS                        42</span>

<span class="k">enum</span> <span class="n">OpalThreadStatus</span> <span class="p">{</span>
     <span class="n">OPAL_THREAD_INACTIVE</span> <span class="o">=</span> <span class="mh">0x0</span><span class="p">,</span>
     <span class="n">OPAL_THREAD_STARTED</span> <span class="o">=</span> <span class="mh">0x1</span><span class="p">,</span>
     <span class="n">OPAL_THREAD_UNAVAILABLE</span> <span class="o">=</span> <span class="mh">0x2</span> <span class="cm">/* opal-v3 */</span>
<span class="p">};</span>

<span class="kt">int64_t</span> <span class="nf">opal_query_cpu_status</span><span class="p">(</span><span class="kt">uint64_t</span> <span class="n">server_no</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="o">*</span><span class="n">thread_status</span><span class="p">);</span>
</pre></div>
</div>
<p>Sets <cite>thread_status</cite> to be the state of the <cite>server_no</cite> CPU thread. CPU threads
can be owned by OPAL or the OS. Ownership changes based on <a class="reference internal" href="opal-start-return-cpu-41-69.html#opal-start-cpu"><span class="std std-ref">OPAL_START_CPU</span></a>
and <a class="reference internal" href="opal-start-return-cpu-41-69.html#opal-return-cpu"><span class="std std-ref">OPAL_RETURN_CPU</span></a>.</p>
<dl class="docutils">
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_THREAD_INACTIVE</span></code></dt>
<dd>Active in skiboot, not in OS. Skiboot owns the CPU thread.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_THREAD_STARTED</span></code></dt>
<dd>CPU has been started by OS, not owned by OPAL.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">OPAL_THREAD_UNAVAILABLE</span></code></dt>
<dd>CPU is unavailable. e.g. is guarded out.</dd>
</dl>
<div class="section" id="returns">
<h2>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><a class="reference internal" href="return-codes.html#opal-parameter"><span class="std std-ref">OPAL_PARAMETER</span></a></dt>
<dd>Invalid address for <cite>thread_status</cite>, invalid CPU, or CPU not in OPAL or OS.</dd>
<dt><a class="reference internal" href="return-codes.html#opal-success"><span class="std std-ref">OPAL_SUCCESS</span></a></dt>
<dd>Successfully retreived status.</dd>
</dl>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">OPAL_QUERY_CPU_STATUS</a><ul>
<li><a class="reference internal" href="#returns">Returns</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="opal-prd-msg-113.html"
                        title="previous chapter">OPAL_PRD_MSG</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="opal-quiesce-158.html"
                        title="next chapter">OPAL_QUIESCE</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/opal-api/opal-query-cpu-status-42.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <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>
        </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-quiesce-158.html" title="OPAL_QUIESCE"
             >next</a> |</li>
        <li class="right" >
          <a href="opal-prd-msg-113.html" title="OPAL_PRD_MSG"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">skiboot 5133e1e
 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >OPAL API Documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2016-2017, IBM, others.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    </div>
  </body>
</html>