git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RISC-V_RV32_SiFive_HiFive1_GCC/freedom-metal/doc/html/apiref/shutdown.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>Shutdown &#8212; Freedom Metal v201905 documentation</title>
  10     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="../_static/jquery.js"></script>
  14     <script type="text/javascript" src="../_static/underscore.js"></script>
  15     <script type="text/javascript" src="../_static/doctools.js"></script>
  16     <link rel="index" title="Index" href="../genindex.html" />
  17     <link rel="search" title="Search" href="../search.html" />
  18     <link rel="next" title="SPIs" href="spi.html" />
  19     <link rel="prev" title="PMPs" href="pmp.html" />
  20
  21   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  22
  23
  24   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  25
  26   </head><body>
  27
  28
  29     <div class="document">
  30       <div class="documentwrapper">
  31         <div class="bodywrapper">
  32
  33
  34           <div class="body" role="main">
  35
  36   <div class="section" id="shutdown">
  37 <h1>Shutdown<a class="headerlink" href="#shutdown" title="Permalink to this headline">¶</a></h1>
  38 <p>API for shutting down a machine. </p>
  39 <div class="breathe-sectiondef docutils container">
  40 <p class="breathe-sectiondef-title rubric">Functions</p>
  41 <dl class="function">
  42 <dt id="_CPPv314metal_shutdowni">
  43 <span id="_CPPv214metal_shutdowni"></span><span id="metal_shutdown__i"></span><span class="target" id="shutdown_8h_1a74aef1a3586fadbfb031b655308fcf12"></span>void <code class="descname">metal_shutdown</code><span class="sig-paren">(</span>int <em>code</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv314metal_shutdowni" title="Permalink to this definition">¶</a><br /></dt>
  44 <dd><p>The public METAL shutdown interface. </p>
  45 <p>Shuts down the machine, if the machine enables an interface for shutting down. When no interface is provided, will cause the machine to spin indefinitely.</p>
  46 <p><dl class="docutils">
  47 <dt><strong>Parameters</strong></dt>
  48 <dd><ul class="breatheparameterlist first last simple">
  49 <li><code class="docutils literal notranslate"><span class="pre">code</span></code>: The return code to set. 0 indicates program success. </li>
  50 </ul>
  51 </dd>
  52 </dl>
  53 </p>
  54 </dd></dl>
  55
  56 </div>
  57 </div>
  58
  59
  60           </div>
  61
  62         </div>
  63       </div>
  64       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  65         <div class="sphinxsidebarwrapper">
  66 <h1 class="logo"><a href="../index.html">Freedom Metal</a></h1>
  67
  68
  69
  70
  71
  72
  73
  74
  75 <h3>Navigation</h3>
  76 <ul class="current">
  77 <li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction to Freedom Metal</a></li>
  78 <li class="toctree-l1"><a class="reference internal" href="../devguide.html">Developer Guide</a></li>
  79 <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
  80 <li class="toctree-l2"><a class="reference internal" href="button.html">Buttons</a></li>
  81 <li class="toctree-l2"><a class="reference internal" href="cache.html">Caches</a></li>
  82 <li class="toctree-l2"><a class="reference internal" href="clock.html">Clocks</a></li>
  83 <li class="toctree-l2"><a class="reference internal" href="cpu.html">CPU</a></li>
  84 <li class="toctree-l2"><a class="reference internal" href="gpio.html">GPIO</a></li>
  85 <li class="toctree-l2"><a class="reference internal" href="interrupt.html">Interrupts</a></li>
  86 <li class="toctree-l2"><a class="reference internal" href="itim.html">ITIM</a></li>
  87 <li class="toctree-l2"><a class="reference internal" href="led.html">LEDs</a></li>
  88 <li class="toctree-l2"><a class="reference internal" href="lock.html">Locks</a></li>
  89 <li class="toctree-l2"><a class="reference internal" href="memory.html">Memory Enumeration</a></li>
  90 <li class="toctree-l2"><a class="reference internal" href="pmp.html">PMPs</a></li>
  91 <li class="toctree-l2 current"><a class="current reference internal" href="#">Shutdown</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="spi.html">SPIs</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="switch.html">Switches</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="timer.html">Timer API</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="tty.html">TTY</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="uart.html">UARTs</a></li>
  97 </ul>
  98 </li>
  99 </ul>
 100
 101 <div class="relations">
 102 <h3>Related Topics</h3>
 103 <ul>
 104   <li><a href="../index.html">Documentation overview</a><ul>
 105   <li><a href="../api.html">API Reference</a><ul>
 106       <li>Previous: <a href="pmp.html" title="previous chapter">PMPs</a></li>
 107       <li>Next: <a href="spi.html" title="next chapter">SPIs</a></li>
 108   </ul></li>
 109   </ul></li>
 110 </ul>
 111 </div>
 112 <div id="searchbox" style="display: none" role="search">
 113   <h3>Quick search</h3>
 114     <div class="searchformwrapper">
 115     <form class="search" action="../search.html" method="get">
 116       <input type="text" name="q" />
 117       <input type="submit" value="Go" />
 118       <input type="hidden" name="check_keywords" value="yes" />
 119       <input type="hidden" name="area" value="default" />
 120     </form>
 121     </div>
 122 </div>
 123 <script type="text/javascript">$('#searchbox').show(0);</script>
 124         </div>
 125       </div>
 126       <div class="clearer"></div>
 127     </div>
 128     <div class="footer">
 129       &copy;2019, SiFive Inc..
 130
 131       |
 132       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
 133       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
 134
 135       |
 136       <a href="../_sources/apiref/shutdown.rst.txt"
 137           rel="nofollow">Page source</a>
 138     </div>
 139
 140
 141
 142
 143   </body>
 144 </html>