aboutsummaryrefslogtreecommitdiff
path: root/doc/opal-api/opal-check-token-80.html
blob: f53fb48db0a2a09caac1237d6775af254acb206c (plain)
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

<!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_CHECK_TOKEN &#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="Code Update on FSP based machine" href="opal-code-update-76-77-78.html" />
    <link rel="prev" title="OPAL_CHECK_ASYNC_COMPLETION" href="opal-check-async-completion-86.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-code-update-76-77-78.html" title="Code Update on FSP based machine"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="opal-check-async-completion-86.html" title="OPAL_CHECK_ASYNC_COMPLETION"
             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-check-token">
<span id="id1"></span><h1>OPAL_CHECK_TOKEN<a class="headerlink" href="#opal-check-token" title="Permalink to this headline">ΒΆ</a></h1>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#define OPAL_CHECK_TOKEN                     80</span>

<span class="kt">int64_t</span> <span class="nf">opal_check_token</span><span class="p">(</span><span class="kt">uint64_t</span> <span class="n">token</span><span class="p">);</span>
</pre></div>
</div>
<p>This OPAL call allows the host OS to determine if a particular OPAL call is present
on a system. This allows for simple compatibility between OPAL versions and different
OPAL implementations/platforms.</p>
<p>One parameter is accepted: the OPAL token number.</p>
<p><code class="docutils literal notranslate"><span class="pre">OPAL_CHECK_TOKEN</span></code> will return:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">enum</span> <span class="n">OpalCheckTokenStatus</span> <span class="p">{</span>
  <span class="n">OPAL_TOKEN_ABSENT</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
  <span class="n">OPAL_TOKEN_PRESENT</span> <span class="o">=</span> <span class="mi">1</span>
<span class="p">};</span>
</pre></div>
</div>
<p>indicating the presence/absence of the particular OPAL_CALL.</p>
<p><code class="docutils literal notranslate"><span class="pre">OPAL_CHECK_TOKEN</span></code> is REQUIRED to be implemented by a conformant OPAL implementation.</p>
<p>For skiboot, only positively ancient internal-to-IBM versions were missing
OPAL_CHECK_TOKEN. In this case, OPAL_PARAMETER would be returned. There is no
reason for a host OS to support this behaviour.</p>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="opal-check-async-completion-86.html"
                        title="previous chapter">OPAL_CHECK_ASYNC_COMPLETION</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="opal-code-update-76-77-78.html"
                        title="next chapter">Code Update on FSP based machine</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-check-token-80.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-code-update-76-77-78.html" title="Code Update on FSP based machine"
             >next</a> |</li>
        <li class="right" >
          <a href="opal-check-async-completion-86.html" title="OPAL_CHECK_ASYNC_COMPLETION"
             >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>