mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-02 00:14:33 +01:00
29 lines
No EOL
5.9 KiB
HTML
29 lines
No EOL
5.9 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="`Monotonic` implementation for RP2040’s Timer peripheral."><title>rtic_monotonics::rp2040 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rtic_monotonics" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-3b12f09e550e0385.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rtic_monotonics/index.html">rtic_<wbr>monotonics</a><span class="version">2.0.3</span></h2></div><h2 class="location"><a href="#">Module rp2040</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate rtic_<wbr>monotonics</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">rtic_monotonics</a>::<wbr><a class="mod" href="#">rp2040</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/rtic_monotonics/rp2040.rs.html#1-168">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="../trait.Monotonic.html" title="trait rtic_monotonics::Monotonic"><code>Monotonic</code></a> implementation for RP2040’s Timer peripheral.</p>
|
||
<p>Always runs at a fixed rate of 1 MHz.</p>
|
||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rtic_monotonics::rp2040::prelude::<span class="kw-2">*</span>;
|
||
|
||
<span class="macro">rp2040_timer_monotonic!</span>(Mono);
|
||
|
||
<span class="kw">fn </span>init() {
|
||
<span class="comment">// Start the monotonic
|
||
</span>Mono::start(timer, <span class="kw-2">&mut </span>resets);
|
||
}
|
||
|
||
<span class="kw">async fn </span>usage() {
|
||
<span class="kw">loop </span>{
|
||
<span class="comment">// Use the monotonic
|
||
</span><span class="kw">let </span>timestamp = Mono::now();
|
||
Mono::delay(<span class="number">100</span>.millis()).<span class="kw">await</span>;
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="prelude/index.html" title="mod rtic_monotonics::rp2040::prelude">prelude</a></div><div class="desc docblock-short">Common definitions and traits for using the RP2040 timer monotonic</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.RESETS.html" title="struct rtic_monotonics::rp2040::RESETS">RESETS</a></div><div class="desc docblock-short">RESETS</div></li><li><div class="item-name"><a class="struct" href="struct.TIMER.html" title="struct rtic_monotonics::rp2040::TIMER">TIMER</a></div><div class="desc docblock-short">Controls time and alarms<br />
|
||
time is a 64 bit value indicating the time in usec since power-on<br />
|
||
timeh is the top 32 bits of time & timel is the bottom 32 bits<br />
|
||
to change time write to timelw before timehw<br />
|
||
to read time read from timelr before timehr<br />
|
||
An alarm is set by setting alarm_enable and writing to the corresponding alarm register<br />
|
||
When an alarm is pending, the corresponding alarm_running signal will be high<br />
|
||
An alarm can be cancelled before it has finished by clearing the alarm_enable<br />
|
||
When an alarm fires, the corresponding alarm_irq is set and alarm_running is cleared<br />
|
||
To clear the interrupt write a 1 to the corresponding alarm_irq</div></li><li><div class="item-name"><a class="struct" href="struct.TimerBackend.html" title="struct rtic_monotonics::rp2040::TimerBackend">Timer<wbr>Backend</a></div><div class="desc docblock-short">Timer implementing <a href="../trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend"><code>TimerQueueBackend</code></a>.</div></li></ul></section></div></main></body></html> |