git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RISC-V_RV32_SiFive_HiFive1_GCC/freedom-metal/doc/html/api.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>API Reference &#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="Buttons" href="apiref/button.html" />
  19     <link rel="prev" title="Standard I/O" href="devguide/tty.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="api-reference">
  37 <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
  38 <p>The API documentation aims to provide a complete reference to the
  39 Freedom Metal API.</p>
  40 <p>The API documentation is split into sections corresponding to each feature:</p>
  41 <div class="toctree-wrapper compound">
  42 <ul>
  43 <li class="toctree-l1"><a class="reference internal" href="apiref/button.html">Buttons</a></li>
  44 <li class="toctree-l1"><a class="reference internal" href="apiref/cache.html">Caches</a></li>
  45 <li class="toctree-l1"><a class="reference internal" href="apiref/clock.html">Clocks</a></li>
  46 <li class="toctree-l1"><a class="reference internal" href="apiref/cpu.html">CPU</a></li>
  47 <li class="toctree-l1"><a class="reference internal" href="apiref/gpio.html">GPIO</a></li>
  48 <li class="toctree-l1"><a class="reference internal" href="apiref/interrupt.html">Interrupts</a></li>
  49 <li class="toctree-l1"><a class="reference internal" href="apiref/itim.html">ITIM</a></li>
  50 <li class="toctree-l1"><a class="reference internal" href="apiref/led.html">LEDs</a></li>
  51 <li class="toctree-l1"><a class="reference internal" href="apiref/lock.html">Locks</a></li>
  52 <li class="toctree-l1"><a class="reference internal" href="apiref/memory.html">Memory Enumeration</a></li>
  53 <li class="toctree-l1"><a class="reference internal" href="apiref/pmp.html">PMPs</a></li>
  54 <li class="toctree-l1"><a class="reference internal" href="apiref/shutdown.html">Shutdown</a></li>
  55 <li class="toctree-l1"><a class="reference internal" href="apiref/spi.html">SPIs</a></li>
  56 <li class="toctree-l1"><a class="reference internal" href="apiref/switch.html">Switches</a></li>
  57 <li class="toctree-l1"><a class="reference internal" href="apiref/timer.html">Timer API</a></li>
  58 <li class="toctree-l1"><a class="reference internal" href="apiref/tty.html">TTY</a></li>
  59 <li class="toctree-l1"><a class="reference internal" href="apiref/uart.html">UARTs</a></li>
  60 </ul>
  61 </div>
  62 </div>
  63
  64
  65           </div>
  66
  67         </div>
  68       </div>
  69       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  70         <div class="sphinxsidebarwrapper">
  71 <h1 class="logo"><a href="index.html">Freedom Metal</a></h1>
  72
  73
  74
  75
  76
  77
  78
  79
  80 <h3>Navigation</h3>
  81 <ul class="current">
  82 <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to Freedom Metal</a></li>
  83 <li class="toctree-l1"><a class="reference internal" href="devguide.html">Developer Guide</a></li>
  84 <li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
  85 <li class="toctree-l2"><a class="reference internal" href="apiref/button.html">Buttons</a></li>
  86 <li class="toctree-l2"><a class="reference internal" href="apiref/cache.html">Caches</a></li>
  87 <li class="toctree-l2"><a class="reference internal" href="apiref/clock.html">Clocks</a></li>
  88 <li class="toctree-l2"><a class="reference internal" href="apiref/cpu.html">CPU</a></li>
  89 <li class="toctree-l2"><a class="reference internal" href="apiref/gpio.html">GPIO</a></li>
  90 <li class="toctree-l2"><a class="reference internal" href="apiref/interrupt.html">Interrupts</a></li>
  91 <li class="toctree-l2"><a class="reference internal" href="apiref/itim.html">ITIM</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="apiref/led.html">LEDs</a></li>
  93 <li class="toctree-l2"><a class="reference internal" href="apiref/lock.html">Locks</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="apiref/memory.html">Memory Enumeration</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="apiref/pmp.html">PMPs</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="apiref/shutdown.html">Shutdown</a></li>
  97 <li class="toctree-l2"><a class="reference internal" href="apiref/spi.html">SPIs</a></li>
  98 <li class="toctree-l2"><a class="reference internal" href="apiref/switch.html">Switches</a></li>
  99 <li class="toctree-l2"><a class="reference internal" href="apiref/timer.html">Timer API</a></li>
 100 <li class="toctree-l2"><a class="reference internal" href="apiref/tty.html">TTY</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="apiref/uart.html">UARTs</a></li>
 102 </ul>
 103 </li>
 104 </ul>
 105
 106 <div class="relations">
 107 <h3>Related Topics</h3>
 108 <ul>
 109   <li><a href="index.html">Documentation overview</a><ul>
 110       <li>Previous: <a href="devguide/tty.html" title="previous chapter">Standard I/O</a></li>
 111       <li>Next: <a href="apiref/button.html" title="next chapter">Buttons</a></li>
 112   </ul></li>
 113 </ul>
 114 </div>
 115 <div id="searchbox" style="display: none" role="search">
 116   <h3>Quick search</h3>
 117     <div class="searchformwrapper">
 118     <form class="search" action="search.html" method="get">
 119       <input type="text" name="q" />
 120       <input type="submit" value="Go" />
 121       <input type="hidden" name="check_keywords" value="yes" />
 122       <input type="hidden" name="area" value="default" />
 123     </form>
 124     </div>
 125 </div>
 126 <script type="text/javascript">$('#searchbox').show(0);</script>
 127         </div>
 128       </div>
 129       <div class="clearer"></div>
 130     </div>
 131     <div class="footer">
 132       &copy;2019, SiFive Inc..
 133
 134       |
 135       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
 136       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
 137
 138       |
 139       <a href="_sources/api.rst.txt"
 140           rel="nofollow">Page source</a>
 141     </div>
 142
 143
 144
 145
 146   </body>
 147 </html>