rtic/stable/api/rtic_monotonics/imxrt/index.html
2024-12-06 13:35:18 +00:00

24 lines
No EOL
6.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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` implementations for i.MX RTs GPT peripherals."><title>rtic_monotonics::imxrt - 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-b0742ba02757f159.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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.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><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module imxrt</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate rtic_<wbr>monotonics</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">rtic_monotonics</a></span><h1>Module <span>imxrt</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rtic_monotonics/imxrt.rs.html#1-267">source</a> </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> implementations for i.MX RTs GPT peripherals.</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::imxrt::prelude::<span class="kw-2">*</span>;
<span class="macro">imxrt_gpt1_monotonic!</span>(Mono, <span class="number">1_000_000</span>);
<span class="kw">fn </span>init() {
<span class="comment">// Obtain ownership of the timer register block.
</span><span class="kw">let </span>gpt1 = <span class="kw">unsafe </span>{ imxrt_ral::gpt::GPT1::instance() };
<span class="comment">// Configure the timer tick rate as specified earlier
</span><span class="macro">todo!</span>(<span class="string">"Configure the gpt1 peripheral to a tick rate of 1_000_000"</span>);
<span class="comment">// Start the monotonic
</span>Mono::start(gpt1);
}
<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="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.ral"><code>pub use <a class="mod" href="../../imxrt_ral/index.html" title="mod imxrt_ral">imxrt_ral</a> as ral;</code></div></li></ul><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::imxrt::prelude">prelude</a></div><div class="desc docblock-short">Common definitions and traits for using the i.MX RT monotonics</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.Gpt1Backend.html" title="struct rtic_monotonics::imxrt::Gpt1Backend">Gpt1<wbr>Backend</a></div><div class="desc docblock-short">GPT based <a href="../trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend"><code>TimerQueueBackend</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Gpt2Backend.html" title="struct rtic_monotonics::imxrt::Gpt2Backend">Gpt2<wbr>Backend</a></div><div class="desc docblock-short">GPT based <a href="../trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend"><code>TimerQueueBackend</code></a>.</div></li></ul></section></div></main></body></html>