95 lines
8.7 KiB
HTML
95 lines
8.7 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `cortex_m` crate."><meta name="keywords" content="rust, rustlang, rust-lang, cortex_m"><title>cortex_m - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Crate cortex_m</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'cortex_m', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/cortex_m/lib.rs.html#1-52' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>cortex_m</a></span></h1><div class='docblock'><p>Low level access to Cortex-M processors</p>
|
||
<p>This crate provides:</p>
|
||
<ul>
|
||
<li>Access to core peripherals like NVIC, SCB and SysTick.</li>
|
||
<li>Access to core registers like CONTROL, MSP and PSR.</li>
|
||
<li>Interrupt manipulation mechanisms</li>
|
||
<li>Safe wrappers around Cortex-M specific instructions like <code>bkpt</code></li>
|
||
</ul>
|
||
<h1 id="optional-features" class="section-header"><a href="#optional-features">Optional features</a></h1><h2 id="inline-asm" class="section-header"><a href="#inline-asm"><code>inline-asm</code></a></h2>
|
||
<p>When this feature is enabled the implementation of all the functions inside the <code>asm</code> and
|
||
<code>register</code> modules use inline assembly (<code>asm!</code>) instead of external assembly (FFI into separate
|
||
assembly files pre-compiled using <code>arm-none-eabi-gcc</code>). The advantages of enabling <code>inline-asm</code>
|
||
are:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Reduced overhead. FFI eliminates the possibility of inlining so all operations include a
|
||
function call overhead when <code>inline-asm</code> is not enabled.</p>
|
||
</li>
|
||
<li>
|
||
<p>Some of the <code>register</code> API only becomes available only when <code>inline-asm</code> is enabled. Check the
|
||
API docs for details.</p>
|
||
</li>
|
||
</ul>
|
||
<p>The disadvantage is that <code>inline-asm</code> requires a nightly toolchain.</p>
|
||
<h2 id="const-fn" class="section-header"><a href="#const-fn"><code>const-fn</code></a></h2>
|
||
<p>Enabling this feature turns the <code>Mutex.new</code> constructor into a <code>const fn</code>.</p>
|
||
<p>This feature requires a nightly toolchain.</p>
|
||
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
||
<table><tr><td><code>pub use peripheral::<a class="struct" href="../cortex_m/peripheral/struct.Peripherals.html" title="struct cortex_m::peripheral::Peripherals">Peripherals</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="asm/index.html"
|
||
title='mod cortex_m::asm'>asm</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Miscellaneous assembly instructions</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="interrupt/index.html"
|
||
title='mod cortex_m::interrupt'>interrupt</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Interrupts</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="itm/index.html"
|
||
title='mod cortex_m::itm'>itm</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Instrumentation Trace Macrocell</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="peripheral/index.html"
|
||
title='mod cortex_m::peripheral'>peripheral</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Core peripherals</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="register/index.html"
|
||
title='mod cortex_m::register'>register</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Processor core registers</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.iprint.html"
|
||
title='macro cortex_m::iprint'>iprint</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Macro for sending a formatted string through an ITM channel</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.iprintln.html"
|
||
title='macro cortex_m::iprintln'>iprintln</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Macro for sending a formatted string through an ITM channel, with a newline.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.singleton.html"
|
||
title='macro cortex_m::singleton'>singleton</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Macro to create a mutable reference to a statically allocated value</p>
|
||
|
||
</td>
|
||
</tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "cortex_m";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |