rtic/2/api/rp2040_pac/pio0/ctrl/index.html
2024-12-06 13:35:18 +00:00

2 lines
No EOL
7.2 KiB
HTML
Raw Permalink 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="PIO control register"><title>rp2040_pac::pio0::ctrl - 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="rp2040_pac" 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="../../../rp2040_pac/index.html">rp2040_<wbr>pac</a><span class="version">0.6.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module ctrl</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In rp2040_<wbr>pac::<wbr>pio0</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">rp2040_pac</a>::<wbr><a href="../index.html">pio0</a></span><h1>Module <span>ctrl</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/rp2040_pac/pio0/ctrl.rs.html#1-113">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>PIO control register</p>
</div></details><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.CTRL_SPEC.html" title="struct rp2040_pac::pio0::ctrl::CTRL_SPEC">CTRL_<wbr>SPEC</a></div><div class="desc docblock-short">PIO control register</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.CLKDIV_RESTART_R.html" title="type rp2040_pac::pio0::ctrl::CLKDIV_RESTART_R">CLKDIV_<wbr>RESTART_<wbr>R</a></div><div class="desc docblock-short">Field <code>CLKDIV_RESTART</code> reader - Restart a state machines clock divider from an initial phase of 0. Clock dividers are free-running, so once started, their output (including fractional jitter) is completely determined by the integer/fractional divisor configured in SMx_CLKDIV. This means that, if multiple clock dividers with the same divisor are restarted simultaneously, by writing multiple 1 bits to this field, the execution clocks of those state machines will run in precise lockstep.</div></li><li><div class="item-name"><a class="type" href="type.CLKDIV_RESTART_W.html" title="type rp2040_pac::pio0::ctrl::CLKDIV_RESTART_W">CLKDIV_<wbr>RESTART_<wbr>W</a></div><div class="desc docblock-short">Field <code>CLKDIV_RESTART</code> writer - Restart a state machines clock divider from an initial phase of 0. Clock dividers are free-running, so once started, their output (including fractional jitter) is completely determined by the integer/fractional divisor configured in SMx_CLKDIV. This means that, if multiple clock dividers with the same divisor are restarted simultaneously, by writing multiple 1 bits to this field, the execution clocks of those state machines will run in precise lockstep.</div></li><li><div class="item-name"><a class="type" href="type.R.html" title="type rp2040_pac::pio0::ctrl::R">R</a></div><div class="desc docblock-short">Register <code>CTRL</code> reader</div></li><li><div class="item-name"><a class="type" href="type.SM_ENABLE_R.html" title="type rp2040_pac::pio0::ctrl::SM_ENABLE_R">SM_<wbr>ENABLE_<wbr>R</a></div><div class="desc docblock-short">Field <code>SM_ENABLE</code> reader - Enable/disable each of the four state machines by writing 1/0 to each of these four bits. When disabled, a state machine will cease executing instructions, except those written directly to SMx_INSTR by the system. Multiple bits can be set/cleared at once to run/halt multiple state machines simultaneously.</div></li><li><div class="item-name"><a class="type" href="type.SM_ENABLE_W.html" title="type rp2040_pac::pio0::ctrl::SM_ENABLE_W">SM_<wbr>ENABLE_<wbr>W</a></div><div class="desc docblock-short">Field <code>SM_ENABLE</code> writer - Enable/disable each of the four state machines by writing 1/0 to each of these four bits. When disabled, a state machine will cease executing instructions, except those written directly to SMx_INSTR by the system. Multiple bits can be set/cleared at once to run/halt multiple state machines simultaneously.</div></li><li><div class="item-name"><a class="type" href="type.SM_RESTART_R.html" title="type rp2040_pac::pio0::ctrl::SM_RESTART_R">SM_<wbr>RESTART_<wbr>R</a></div><div class="desc docblock-short">Field <code>SM_RESTART</code> reader - Write 1 to instantly clear internal SM state which may be otherwise difficult to access and will affect future execution.</div></li><li><div class="item-name"><a class="type" href="type.SM_RESTART_W.html" title="type rp2040_pac::pio0::ctrl::SM_RESTART_W">SM_<wbr>RESTART_<wbr>W</a></div><div class="desc docblock-short">Field <code>SM_RESTART</code> writer - Write 1 to instantly clear internal SM state which may be otherwise difficult to access and will affect future execution.</div></li><li><div class="item-name"><a class="type" href="type.W.html" title="type rp2040_pac::pio0::ctrl::W">W</a></div><div class="desc docblock-short">Register <code>CTRL</code> writer</div></li></ul></section></div></main></body></html>