rtic/stable/api/rp2040_pac/adc/cs/index.html
2024-10-24 05:57:30 +00:00

11 lines
No EOL
9.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="ADC Control and Status"><title>rp2040_pac::adc::cs - 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="rp2040_pac" 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="../../../rp2040_pac/index.html">rp2040_<wbr>pac</a><span class="version">0.6.0</span></h2></div><h2 class="location"><a href="#">Module cs</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In rp2040_<wbr>pac::<wbr>adc</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">rp2040_pac</a>::<wbr><a href="../index.html">adc</a>::<wbr><a class="mod" href="#">cs</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/rp2040_pac/adc/cs.rs.html#1-173">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>ADC Control and Status</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.CS_SPEC.html" title="struct rp2040_pac::adc::cs::CS_SPEC">CS_SPEC</a></div><div class="desc docblock-short">ADC Control and Status</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.AINSEL_R.html" title="type rp2040_pac::adc::cs::AINSEL_R">AINSE<wbr>L_<wbr>R</a></div><div class="desc docblock-short">Field <code>AINSEL</code> reader - Select analog mux input. Updated automatically in round-robin mode.</div></li><li><div class="item-name"><a class="type" href="type.AINSEL_W.html" title="type rp2040_pac::adc::cs::AINSEL_W">AINSE<wbr>L_<wbr>W</a></div><div class="desc docblock-short">Field <code>AINSEL</code> writer - Select analog mux input. Updated automatically in round-robin mode.</div></li><li><div class="item-name"><a class="type" href="type.EN_R.html" title="type rp2040_pac::adc::cs::EN_R">EN_R</a></div><div class="desc docblock-short">Field <code>EN</code> reader - Power on ADC and enable its clock.<br />
1 - enabled. 0 - disabled.</div></li><li><div class="item-name"><a class="type" href="type.EN_W.html" title="type rp2040_pac::adc::cs::EN_W">EN_W</a></div><div class="desc docblock-short">Field <code>EN</code> writer - Power on ADC and enable its clock.<br />
1 - enabled. 0 - disabled.</div></li><li><div class="item-name"><a class="type" href="type.ERR_R.html" title="type rp2040_pac::adc::cs::ERR_R">ERR_R</a></div><div class="desc docblock-short">Field <code>ERR</code> reader - The most recent ADC conversion encountered an error; result is undefined or noisy.</div></li><li><div class="item-name"><a class="type" href="type.ERR_STICKY_R.html" title="type rp2040_pac::adc::cs::ERR_STICKY_R">ERR_<wbr>STICK<wbr>Y_<wbr>R</a></div><div class="desc docblock-short">Field <code>ERR_STICKY</code> reader - Some past ADC conversion encountered an error. Write 1 to clear.</div></li><li><div class="item-name"><a class="type" href="type.ERR_STICKY_W.html" title="type rp2040_pac::adc::cs::ERR_STICKY_W">ERR_<wbr>STICK<wbr>Y_<wbr>W</a></div><div class="desc docblock-short">Field <code>ERR_STICKY</code> writer - Some past ADC conversion encountered an error. Write 1 to clear.</div></li><li><div class="item-name"><a class="type" href="type.R.html" title="type rp2040_pac::adc::cs::R">R</a></div><div class="desc docblock-short">Register <code>CS</code> reader</div></li><li><div class="item-name"><a class="type" href="type.READY_R.html" title="type rp2040_pac::adc::cs::READY_R">READY_R</a></div><div class="desc docblock-short">Field <code>READY</code> reader - 1 if the ADC is ready to start a new conversion. Implies any previous conversion has completed.<br />
0 whilst conversion in progress.</div></li><li><div class="item-name"><a class="type" href="type.RROBIN_R.html" title="type rp2040_pac::adc::cs::RROBIN_R">RROBI<wbr>N_<wbr>R</a></div><div class="desc docblock-short">Field <code>RROBIN</code> reader - Round-robin sampling. 1 bit per channel. Set all bits to 0 to disable.<br />
Otherwise, the ADC will cycle through each enabled channel in a round-robin fashion.<br />
The first channel to be sampled will be the one currently indicated by AINSEL.<br />
AINSEL will be updated after each conversion with the newly-selected channel.</div></li><li><div class="item-name"><a class="type" href="type.RROBIN_W.html" title="type rp2040_pac::adc::cs::RROBIN_W">RROBI<wbr>N_<wbr>W</a></div><div class="desc docblock-short">Field <code>RROBIN</code> writer - Round-robin sampling. 1 bit per channel. Set all bits to 0 to disable.<br />
Otherwise, the ADC will cycle through each enabled channel in a round-robin fashion.<br />
The first channel to be sampled will be the one currently indicated by AINSEL.<br />
AINSEL will be updated after each conversion with the newly-selected channel.</div></li><li><div class="item-name"><a class="type" href="type.START_MANY_R.html" title="type rp2040_pac::adc::cs::START_MANY_R">STAR<wbr>T_<wbr>MANY_<wbr>R</a></div><div class="desc docblock-short">Field <code>START_MANY</code> reader - Continuously perform conversions whilst this bit is 1. A new conversion will start immediately after the previous finishes.</div></li><li><div class="item-name"><a class="type" href="type.START_MANY_W.html" title="type rp2040_pac::adc::cs::START_MANY_W">STAR<wbr>T_<wbr>MANY_<wbr>W</a></div><div class="desc docblock-short">Field <code>START_MANY</code> writer - Continuously perform conversions whilst this bit is 1. A new conversion will start immediately after the previous finishes.</div></li><li><div class="item-name"><a class="type" href="type.START_ONCE_R.html" title="type rp2040_pac::adc::cs::START_ONCE_R">STAR<wbr>T_<wbr>ONCE_<wbr>R</a></div><div class="desc docblock-short">Field <code>START_ONCE</code> reader - Start a single conversion. Self-clearing. Ignored if start_many is asserted.</div></li><li><div class="item-name"><a class="type" href="type.START_ONCE_W.html" title="type rp2040_pac::adc::cs::START_ONCE_W">STAR<wbr>T_<wbr>ONCE_<wbr>W</a></div><div class="desc docblock-short">Field <code>START_ONCE</code> writer - Start a single conversion. Self-clearing. Ignored if start_many is asserted.</div></li><li><div class="item-name"><a class="type" href="type.TS_EN_R.html" title="type rp2040_pac::adc::cs::TS_EN_R">TS_EN_R</a></div><div class="desc docblock-short">Field <code>TS_EN</code> reader - Power on temperature sensor. 1 - enabled. 0 - disabled.</div></li><li><div class="item-name"><a class="type" href="type.TS_EN_W.html" title="type rp2040_pac::adc::cs::TS_EN_W">TS_EN_W</a></div><div class="desc docblock-short">Field <code>TS_EN</code> writer - Power on temperature sensor. 1 - enabled. 0 - disabled.</div></li><li><div class="item-name"><a class="type" href="type.W.html" title="type rp2040_pac::adc::cs::W">W</a></div><div class="desc docblock-short">Register <code>CS</code> writer</div></li></ul></section></div></main></body></html>