rtic/stable/api/nrf52840_pac/saadc/index.html

5 lines
14 KiB
HTML
Raw Permalink Normal View History

<!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="Successive approximation register (SAR) analog-to-digital converter"><title>nrf52840_pac::saadc - 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="nrf52840_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="../../nrf52840_pac/index.html">nrf52840_<wbr>pac</a><span class="version">0.12.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module saadc</a></h2><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><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate nrf52840_<wbr>pac</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">nrf52840_pac</a></span><h1>Module <span>saadc</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/nrf52840_pac/saadc.rs.html#1-140">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Successive approximation register (SAR) analog-to-digital converter</p>
</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.EVENTS_CH"><code>pub use events_ch::<a class="struct" href="events_ch/struct.EVENTS_CH.html" title="struct nrf52840_pac::saadc::events_ch::EVENTS_CH">EVENTS_CH</a>;</code></div></li><li><div class="item-name" id="reexport.CH"><code>pub use ch::<a class="struct" href="ch/struct.CH.html" title="struct nrf52840_pac::saadc::ch::CH">CH</a>;</code></div></li><li><div class="item-name" id="reexport.RESULT"><code>pub use result::<a class="struct" href="result/struct.RESULT.html" title="struct nrf52840_pac::saadc::result::RESULT">RESULT</a>;</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="ch/index.html" title="mod nrf52840_pac::saadc::ch">ch</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="enable/index.html" title="mod nrf52840_pac::saadc::enable">enable</a></div><div class="desc docblock-short">Enable or disable SAADC</div></li><li><div class="item-name"><a class="mod" href="events_calibratedone/index.html" title="mod nrf52840_pac::saadc::events_calibratedone">events_<wbr>calibratedone</a></div><div class="desc docblock-short">Calibration is complete</div></li><li><div class="item-name"><a class="mod" href="events_ch/index.html" title="mod nrf52840_pac::saadc::events_ch">events_<wbr>ch</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="events_done/index.html" title="mod nrf52840_pac::saadc::events_done">events_<wbr>done</a></div><div class="desc docblock-short">A conversion task has been completed. Depending on the configuration, multiple conversions might be needed for a result to be transferred to RAM.</div></li><li><div class="item-name"><a class="mod" href="events_end/index.html" title="mod nrf52840_pac::saadc::events_end">events_<wbr>end</a></div><div class="desc docblock-short">The SAADC has filled up the result buffer</div></li><li><div class="item-name"><a class="mod" href="events_resultdone/index.html" title="mod nrf52840_pac::saadc::events_resultdone">events_<wbr>resultdone</a></div><div class="desc docblock-short">Result ready for transfer to RAM</div></li><li><div class="item-name"><a class="mod" href="events_started/index.html" title="mod nrf52840_pac::saadc::events_started">events_<wbr>started</a></div><div class="desc docblock-short">The SAADC has started</div></li><li><div class="item-name"><a class="mod" href="events_stopped/index.html" title="mod nrf52840_pac::saadc::events_stopped">events_<wbr>stopped</a></div><div class="desc docblock-short">The SAADC has stopped</div></li><li><div class="item-name"><a class="mod" href="inten/index.html" title="mod nrf52840_pac::saadc::inten">inten</a></div><div class="desc docblock-short">Enable or disable interrupt</div></li><li><div class="item-name"><a class="mod" href="intenclr/index.html" title="mod nrf52840_pac::saadc::intenclr">intenclr</a></div><div class="desc docblock-short">Disable interrupt</div></li><li><div class="item-name"><a class="mod" href="intenset/index.html" title="mod nrf52840_pac::saadc::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="oversample/index.html" title="mod nrf52840_pac::saadc::oversample">oversample</a></div><div class="desc docblock-short">Oversampling configuration. The RESOLUTION is applied before averaging, thus for high OVERSAMPLE a higher RESOLUTION should be used.</div></li><li><div class="item-name"><a class="mod" href="resolution/index.html" title="mod nrf52840_pac::saadc::resolution">resolution</a></div><div class="desc docblock-short">Resolution configuration</div></li><li><div class="item-name"><a class="mod" href="result/index.html" title="mod nrf52840_pac::saadc::result">result</a></div><div class="desc docblock-short">Cluster
RESULT EasyDMA channel</div></li><li><div class="item-name"><a class="mod" href="samplerate/index.html" title="mod nrf52840_pac::saadc::samplerate">samplerate</a></div><div class="desc docblock-short">Controls normal or continuous sample rate</div></li><li><div class="item-name"><a class="mod" href="status/index.html" title="mod nrf52840_pac::saadc::status">status</a></div><div class="desc docblock-short">Status</div></li><li><div class="item-name"><a class="mod" href="tasks_calibrateoffset/index.html" title="mod nrf52840_pac::saadc::tasks_calibrateoffset">tasks_<wbr>calibrateoffset</a></div><div class="desc docblock-short">Starts offset auto-calibration</div></li><li><div class="item-name"><a class="mod" href="tasks_sample/index.html" title="mod nrf52840_pac::saadc::tasks_sample">tasks_<wbr>sample</a></div><div class="desc docblock-short">Takes one SAADC sample</div></li><li><div class="item-name"><a class="mod" href="tasks_start/index.html" title="mod nrf52840_pac::saadc::tasks_start">tasks_<wbr>start</a></div><div class="desc docblock-short">Starts the SAADC and prepares the result buffer in RAM</div></li><li><div class="item-name"><a class="mod" href="tasks_stop/index.html" title="mod nrf52840_pac::saadc::tasks_stop">tasks_<wbr>stop</a></div><div class="desc docblock-short">Stops the SAADC and terminates all on-going conversions</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.RegisterBlock.html" title="struct nrf52840_pac::saadc::RegisterBlock">Register<wbr>Block</a></div><div class="desc docblock-short">Register block</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.ENABLE.html" title="type nrf52840_pac::saadc::ENABLE">ENABLE</a></div><div class="desc docblock-short">ENABLE (rw) register accessor: an alias for <code>Reg&lt;ENABLE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_CALIBRATEDONE.html" title="type nrf52840_pac::saadc::EVENTS_CALIBRATEDONE">EVENTS_<wbr>CALIBRATEDONE</a></div><div class="desc docblock-short">EVENTS_CALIBRATEDONE (rw) register accessor: an alias for <code>Reg&lt;EVENTS_CALIBRATEDONE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_DONE.html" title="type nrf52840_pac::saadc::EVENTS_DONE">EVENTS_<wbr>DONE</a></div><div class="desc docblock-short">EVENTS_DONE (rw) register accessor: an alias for <code>Reg&lt;EVENTS_DONE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_END.html" title="type nrf52840_pac::saadc::EVENTS_END">EVENTS_<wbr>END</a></div><div class="desc docblock-short">EVENTS_END (rw) register accessor: an alias for <code>Reg&lt;EVENTS_END_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_RESULTDONE.html" title="type nrf52840_pac::saadc::EVENTS_RESULTDONE">EVENTS_<wbr>RESULTDONE</a></div><div class="desc docblock-short">EVENTS_RESULTDONE (rw) register accessor: an alias for <code>Reg&lt;EVENTS_RESULTDONE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_STARTED.html" title="type nrf52840_pac::saadc::EVENTS_STARTED">EVENTS_<wbr>STARTED</a></div><div class="desc docblock-short">EVENTS_STARTED (rw) register accessor: an alias for <code>Reg&lt;EVENTS_STARTED_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_STOPPED.html" title="type nrf52840_pac::saadc::EVENTS_STOPPED">EVENTS_<wbr>STOPPED</a></div><div class="desc docblock-short">EVENTS_STOPPED (rw) register accessor: an alias for <code>Reg&lt;EVENTS_STOPPED_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.INTEN.html" title="type nrf52840_pac::saadc::INTEN">INTEN</a></div><div class="desc docblock-short">INTEN (rw) register accessor: an alias for <code>Reg&lt;INTEN_SPEC&gt;</code></div></li><li><div class="item-nam