mirror of
https://github.com/rtic-rs/rtic.git
synced 2025-12-21 07:15:32 +01:00
27 lines
No EOL
6.1 KiB
HTML
27 lines
No EOL
6.1 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` implementations for i.MX RT’s GPT peripherals."><title>rtic_monotonics::imxrt - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.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.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Module imxrt</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rtic_monotonics/index.html">rtic_<wbr>monotonics</a><span class="version">2.1.0</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" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">rtic_monotonics</a></div><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-271">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 RT’s 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="comment">// Create the type `Mono`. It will manage the GPT1 timer, and
|
||
// run with a resolution of 1 µs (1,000,000 ticks per second).
|
||
</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">// You can use the monotonic to get the time...
|
||
</span><span class="kw">let </span>timestamp = Mono::now();
|
||
<span class="comment">// ...and you can use it to add a delay to this async function
|
||
</span>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><dl class="item-table reexports"><dt id="reexport.ral"><code>pub use <a class="mod" href="../../imxrt_ral/index.html" title="mod imxrt_ral">imxrt_ral</a> as ral;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="prelude/index.html" title="mod rtic_monotonics::imxrt::prelude">prelude</a></dt><dd>Common definitions and traits for using the i.MX RT monotonics</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Gpt1Backend.html" title="struct rtic_monotonics::imxrt::Gpt1Backend">Gpt1<wbr>Backend</a></dt><dd>GPT based <a href="../trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend"><code>TimerQueueBackend</code></a>.</dd><dt><a class="struct" href="struct.Gpt2Backend.html" title="struct rtic_monotonics::imxrt::Gpt2Backend">Gpt2<wbr>Backend</a></dt><dd>GPT based <a href="../trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend"><code>TimerQueueBackend</code></a>.</dd></dl></section></div></main></body></html> |