git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RISC-V_RV32_SiFive_HiFive1_GCC/freedom-metal/doc/html/apiref/memory.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>Memory Enumeration &#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="PMPs" href="pmp.html" />
  19     <link rel="prev" title="Locks" href="lock.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="memory-enumeration">
  37 <h1>Memory Enumeration<a class="headerlink" href="#memory-enumeration" title="Permalink to this headline">¶</a></h1>
  38 <p>API for enumerating memory blocks. </p>
  39 <div class="breathe-sectiondef docutils container">
  40 <p class="breathe-sectiondef-title rubric">Functions</p>
  41 <dl class="function">
  42 <dt id="_CPPv329metal_get_memory_from_addressK9uintptr_t">
  43 <span id="_CPPv229metal_get_memory_from_addressK9uintptr_t"></span><span id="metal_get_memory_from_address__uintptr_tC"></span><span class="target" id="memory_8h_1ad491f569f50de727a0093a835c56df35"></span><em class="property">struct</em> <a class="reference internal" href="#_CPPv312metal_memory" title="metal_memory">metal_memory</a> *<code class="descname">metal_get_memory_from_address</code><span class="sig-paren">(</span><em class="property">const</em> uintptr_t <em>address</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv329metal_get_memory_from_addressK9uintptr_t" title="Permalink to this definition">¶</a><br /></dt>
  44 <dd><p>Get the memory block which services the given address. </p>
  45 <p>Given a physical memory address, get a handle for the memory block to which that address is mapped.</p>
  46 <p><dl class="docutils">
  47 <dt><strong>Return</strong></dt>
  48 <dd>The memory block handle, or NULL if the address is not mapped to a memory block </dd>
  49 <dt><strong>Parameters</strong></dt>
  50 <dd><ul class="breatheparameterlist first last simple">
  51 <li><code class="docutils literal notranslate"><span class="pre">address</span></code>: The address to query </li>
  52 </ul>
  53 </dd>
  54 </dl>
  55 </p>
  56 </dd></dl>
  57
  58 <dl class="function">
  59 <dt id="_CPPv329metal_memory_get_base_addressPK12metal_memory">
  60 <span id="_CPPv229metal_memory_get_base_addressPK12metal_memory"></span><span id="metal_memory_get_base_address__metal_memoryCP"></span><span class="target" id="memory_8h_1a7843783cc7e8077104bdc299d4b430a2"></span>uintptr_t <code class="descname">metal_memory_get_base_address</code><span class="sig-paren">(</span><em class="property">const</em> <em class="property">struct</em> <a class="reference internal" href="#_CPPv312metal_memory" title="metal_memory">metal_memory</a> *<em>memory</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv329metal_memory_get_base_addressPK12metal_memory" title="Permalink to this definition">¶</a><br /></dt>
  61 <dd><p>Get the base address for a memory block. </p>
  62 <p><dl class="docutils">
  63 <dt><strong>Return</strong></dt>
  64 <dd>The base address of the memory block </dd>
  65 <dt><strong>Parameters</strong></dt>
  66 <dd><ul class="breatheparameterlist first last simple">
  67 <li><code class="docutils literal notranslate"><span class="pre">memory</span></code>: The handle for the memory block </li>
  68 </ul>
  69 </dd>
  70 </dl>
  71 </p>
  72 </dd></dl>
  73
  74 <dl class="function">
  75 <dt id="_CPPv321metal_memory_get_sizePK12metal_memory">
  76 <span id="_CPPv221metal_memory_get_sizePK12metal_memory"></span><span id="metal_memory_get_size__metal_memoryCP"></span><span class="target" id="memory_8h_1a737f5bd1821cd23e76a97c36b46e05bc"></span>size_t <code class="descname">metal_memory_get_size</code><span class="sig-paren">(</span><em class="property">const</em> <em class="property">struct</em> <a class="reference internal" href="#_CPPv312metal_memory" title="metal_memory">metal_memory</a> *<em>memory</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv321metal_memory_get_sizePK12metal_memory" title="Permalink to this definition">¶</a><br /></dt>
  77 <dd><p>Get the size of a memory block. </p>
  78 <p><dl class="docutils">
  79 <dt><strong>Return</strong></dt>
  80 <dd>The size of the memory block </dd>
  81 <dt><strong>Parameters</strong></dt>
  82 <dd><ul class="breatheparameterlist first last simple">
  83 <li><code class="docutils literal notranslate"><span class="pre">memory</span></code>: The handle for the memory block </li>
  84 </ul>
  85 </dd>
  86 </dl>
  87 </p>
  88 </dd></dl>
  89
  90 <dl class="function">
  91 <dt id="_CPPv329metal_memory_supports_atomicsPK12metal_memory">
  92 <span id="_CPPv229metal_memory_supports_atomicsPK12metal_memory"></span><span id="metal_memory_supports_atomics__metal_memoryCP"></span><span class="target" id="memory_8h_1a021b73d7b895d82d7028e71a8d35a762"></span>int <code class="descname">metal_memory_supports_atomics</code><span class="sig-paren">(</span><em class="property">const</em> <em class="property">struct</em> <a class="reference internal" href="#_CPPv312metal_memory" title="metal_memory">metal_memory</a> *<em>memory</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv329metal_memory_supports_atomicsPK12metal_memory" title="Permalink to this definition">¶</a><br /></dt>
  93 <dd><p>Query if a memory block supports atomic operations. </p>
  94 <p><dl class="docutils">
  95 <dt><strong>Return</strong></dt>
  96 <dd>nonzero if the memory block supports atomic operations </dd>
  97 <dt><strong>Parameters</strong></dt>
  98 <dd><ul class="breatheparameterlist first last simple">
  99 <li><code class="docutils literal notranslate"><span class="pre">memory</span></code>: The handle for the memory block </li>
 100 </ul>
 101 </dd>
 102 </dl>
 103 </p>
 104 </dd></dl>
 105
 106 <dl class="function">
 107 <dt id="_CPPv324metal_memory_is_cachablePK12metal_memory">
 108 <span id="_CPPv224metal_memory_is_cachablePK12metal_memory"></span><span id="metal_memory_is_cachable__metal_memoryCP"></span><span class="target" id="memory_8h_1a115334c01896b5e4594ce31a84c882c0"></span>int <code class="descname">metal_memory_is_cachable</code><span class="sig-paren">(</span><em class="property">const</em> <em class="property">struct</em> <a class="reference internal" href="#_CPPv312metal_memory" title="metal_memory">metal_memory</a> *<em>memory</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv324metal_memory_is_cachablePK12metal_memory" title="Permalink to this definition">¶</a><br /></dt>
 109 <dd><p>Query if a memory block is cacheable. </p>
 110 <p><dl class="docutils">
 111 <dt><strong>Return</strong></dt>
 112 <dd>nonzero if the memory block is cachable </dd>
 113 <dt><strong>Parameters</strong></dt>
 114 <dd><ul class="breatheparameterlist first last simple">
 115 <li><code class="docutils literal notranslate"><span class="pre">memory</span></code>: The handle for the memory block </li>
 116 </ul>
 117 </dd>
 118 </dl>
 119 </p>
 120 </dd></dl>
 121
 122 </div>
 123 <dl class="class">
 124 <dt id="_CPPv312metal_memory">
 125 <span id="_CPPv212metal_memory"></span><span id="metal_memory"></span><span class="target" id="structmetal__memory"></span><em class="property">struct </em><code class="descname">metal_memory</code><a class="headerlink" href="#_CPPv312metal_memory" title="Permalink to this definition">¶</a><br /></dt>
 126 <dd><em>#include &lt;memory.h&gt;</em><p>A handle for a memory block. </p>
 127 </dd></dl>
 128
 129 </div>
 130
 131
 132           </div>
 133
 134         </div>
 135       </div>
 136       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 137         <div class="sphinxsidebarwrapper">
 138 <h1 class="logo"><a href="../index.html">Freedom Metal</a></h1>
 139
 140
 141
 142
 143
 144
 145
 146
 147 <h3>Navigation</h3>
 148 <ul class="current">
 149 <li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction to Freedom Metal</a></li>
 150 <li class="toctree-l1"><a class="reference internal" href="../devguide.html">Developer Guide</a></li>
 151 <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
 152 <li class="toctree-l2"><a class="reference internal" href="button.html">Buttons</a></li>
 153 <li class="toctree-l2"><a class="reference internal" href="cache.html">Caches</a></li>
 154 <li class="toctree-l2"><a class="reference internal" href="clock.html">Clocks</a></li>
 155 <li class="toctree-l2"><a class="reference internal" href="cpu.html">CPU</a></li>
 156 <li class="toctree-l2"><a class="reference internal" href="gpio.html">GPIO</a></li>
 157 <li class="toctree-l2"><a class="reference internal" href="interrupt.html">Interrupts</a></li>
 158 <li class="toctree-l2"><a class="reference internal" href="itim.html">ITIM</a></li>
 159 <li class="toctree-l2"><a class="reference internal" href="led.html">LEDs</a></li>
 160 <li class="toctree-l2"><a class="reference internal" href="lock.html">Locks</a></li>
 161 <li class="toctree-l2 current"><a class="current reference internal" href="#">Memory Enumeration</a></li>
 162 <li class="toctree-l2"><a class="reference internal" href="pmp.html">PMPs</a></li>
 163 <li class="toctree-l2"><a class="reference internal" href="shutdown.html">Shutdown</a></li>
 164 <li class="toctree-l2"><a class="reference internal" href="spi.html">SPIs</a></li>
 165 <li class="toctree-l2"><a class="reference internal" href="switch.html">Switches</a></li>
 166 <li class="toctree-l2"><a class="reference internal" href="timer.html">Timer API</a></li>
 167 <li class="toctree-l2"><a class="reference internal" href="tty.html">TTY</a></li>
 168 <li class="toctree-l2"><a class="reference internal" href="uart.html">UARTs</a></li>
 169 </ul>
 170 </li>
 171 </ul>
 172
 173 <div class="relations">
 174 <h3>Related Topics</h3>
 175 <ul>
 176   <li><a href="../index.html">Documentation overview</a><ul>
 177   <li><a href="../api.html">API Reference</a><ul>
 178       <li>Previous: <a href="lock.html" title="previous chapter">Locks</a></li>
 179       <li>Next: <a href="pmp.html" title="next chapter">PMPs</a></li>
 180   </ul></li>
 181   </ul></li>
 182 </ul>
 183 </div>
 184 <div id="searchbox" style="display: none" role="search">
 185   <h3>Quick search</h3>
 186     <div class="searchformwrapper">
 187     <form class="search" action="../search.html" method="get">
 188       <input type="text" name="q" />
 189       <input type="submit" value="Go" />
 190       <input type="hidden" name="check_keywords" value="yes" />
 191       <input type="hidden" name="area" value="default" />
 192     </form>
 193     </div>
 194 </div>
 195 <script type="text/javascript">$('#searchbox').show(0);</script>
 196         </div>
 197       </div>
 198       <div class="clearer"></div>
 199     </div>
 200     <div class="footer">
 201       &copy;2019, SiFive Inc..
 202
 203       |
 204       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.5</a>
 205       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
 206
 207       |
 208       <a href="../_sources/apiref/memory.rst.txt"
 209           rel="nofollow">Page source</a>
 210     </div>
 211
 212
 213
 214
 215   </body>
 216 </html>