+++ /dev/null
-
-<!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>Shutdown — Freedom Metal v201905 documentation</title>
- <link rel="stylesheet" href="../_static/alabaster.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>
- <link rel="index" title="Index" href="../genindex.html" />
- <link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="SPIs" href="spi.html" />
- <link rel="prev" title="PMPs" href="pmp.html" />
-
- <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
-
-
- <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
-
- </head><body>
-
-
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
-
-
- <div class="body" role="main">
-
- <div class="section" id="shutdown">
-<h1>Shutdown<a class="headerlink" href="#shutdown" title="Permalink to this headline">¶</a></h1>
-<p>API for shutting down a machine. </p>
-<div class="breathe-sectiondef docutils container">
-<p class="breathe-sectiondef-title rubric">Functions</p>
-<dl class="function">
-<dt id="_CPPv314metal_shutdowni">
-<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>
-<dd><p>The public METAL shutdown interface. </p>
-<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>
-<p><dl class="docutils">
-<dt><strong>Parameters</strong></dt>
-<dd><ul class="breatheparameterlist first last simple">
-<li><code class="docutils literal notranslate"><span class="pre">code</span></code>: The return code to set. 0 indicates program success. </li>
-</ul>
-</dd>
-</dl>
-</p>
-</dd></dl>
-
-</div>
-</div>
-
-
- </div>
-
- </div>
- </div>
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="../index.html">Freedom Metal</a></h1>
-
-
-
-
-
-
-
-
-<h3>Navigation</h3>
-<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction to Freedom Metal</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../devguide.html">Developer Guide</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="button.html">Buttons</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cache.html">Caches</a></li>
-<li class="toctree-l2"><a class="reference internal" href="clock.html">Clocks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpu.html">CPU</a></li>
-<li class="toctree-l2"><a class="reference internal" href="gpio.html">GPIO</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interrupt.html">Interrupts</a></li>
-<li class="toctree-l2"><a class="reference internal" href="itim.html">ITIM</a></li>
-<li class="toctree-l2"><a class="reference internal" href="led.html">LEDs</a></li>
-<li class="toctree-l2"><a class="reference internal" href="lock.html">Locks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memory.html">Memory Enumeration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="pmp.html">PMPs</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Shutdown</a></li>
-<li class="toctree-l2"><a class="reference internal" href="spi.html">SPIs</a></li>
-<li class="toctree-l2"><a class="reference internal" href="switch.html">Switches</a></li>
-<li class="toctree-l2"><a class="reference internal" href="timer.html">Timer API</a></li>
-<li class="toctree-l2"><a class="reference internal" href="tty.html">TTY</a></li>
-<li class="toctree-l2"><a class="reference internal" href="uart.html">UARTs</a></li>
-</ul>
-</li>
-</ul>
-
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
- <li><a href="../index.html">Documentation overview</a><ul>
- <li><a href="../api.html">API Reference</a><ul>
- <li>Previous: <a href="pmp.html" title="previous chapter">PMPs</a></li>
- <li>Next: <a href="spi.html" title="next chapter">SPIs</a></li>
- </ul></li>
- </ul></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="footer">
- ©2019, SiFive Inc..
-
- |
- Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
- & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
-
- |
- <a href="../_sources/apiref/shutdown.rst.txt"
- rel="nofollow">Page source</a>
- </div>
-
-
-
-
- </body>
-</html>
\ No newline at end of file
projects / freertos / blobdiff