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

4 lines
No EOL
11 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="Pulse Density Modulation (Digital Microphone) Interface"><title>nrf52840_pac::pdm - 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 pdm</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>pdm</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/pdm.rs.html#1-108">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Pulse Density Modulation (Digital Microphone) Interface</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.PSEL"><code>pub use psel::<a class="struct" href="psel/struct.PSEL.html" title="struct nrf52840_pac::pdm::psel::PSEL">PSEL</a>;</code></div></li><li><div class="item-name" id="reexport.SAMPLE"><code>pub use sample::<a class="struct" href="sample/struct.SAMPLE.html" title="struct nrf52840_pac::pdm::sample::SAMPLE">SAMPLE</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="enable/index.html" title="mod nrf52840_pac::pdm::enable">enable</a></div><div class="desc docblock-short">PDM module enable register</div></li><li><div class="item-name"><a class="mod" href="events_end/index.html" title="mod nrf52840_pac::pdm::events_end">events_<wbr>end</a></div><div class="desc docblock-short">The PDM has written the last sample specified by SAMPLE.MAXCNT (or the last sample after a STOP task has been received) to Data RAM</div></li><li><div class="item-name"><a class="mod" href="events_started/index.html" title="mod nrf52840_pac::pdm::events_started">events_<wbr>started</a></div><div class="desc docblock-short">PDM transfer has started</div></li><li><div class="item-name"><a class="mod" href="events_stopped/index.html" title="mod nrf52840_pac::pdm::events_stopped">events_<wbr>stopped</a></div><div class="desc docblock-short">PDM transfer has finished</div></li><li><div class="item-name"><a class="mod" href="gainl/index.html" title="mod nrf52840_pac::pdm::gainl">gainl</a></div><div class="desc docblock-short">Left output gain adjustment</div></li><li><div class="item-name"><a class="mod" href="gainr/index.html" title="mod nrf52840_pac::pdm::gainr">gainr</a></div><div class="desc docblock-short">Right output gain adjustment</div></li><li><div class="item-name"><a class="mod" href="inten/index.html" title="mod nrf52840_pac::pdm::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::pdm::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::pdm::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="mode/index.html" title="mod nrf52840_pac::pdm::mode">mode</a></div><div class="desc docblock-short">Defines the routing of the connected PDM microphones signals</div></li><li><div class="item-name"><a class="mod" href="pdmclkctrl/index.html" title="mod nrf52840_pac::pdm::pdmclkctrl">pdmclkctrl</a></div><div class="desc docblock-short">PDM clock generator control</div></li><li><div class="item-name"><a class="mod" href="psel/index.html" title="mod nrf52840_pac::pdm::psel">psel</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="ratio/index.html" title="mod nrf52840_pac::pdm::ratio">ratio</a></div><div class="desc docblock-short">Selects the ratio between PDM_CLK and output sample rate. Change PDMCLKCTRL accordingly.</div></li><li><div class="item-name"><a class="mod" href="sample/index.html" title="mod nrf52840_pac::pdm::sample">sample</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="tasks_start/index.html" title="mod nrf52840_pac::pdm::tasks_start">tasks_<wbr>start</a></div><div class="desc docblock-short">Starts continuous PDM transfer</div></li><li><div class="item-name"><a class="mod" href="tasks_stop/index.html" title="mod nrf52840_pac::pdm::tasks_stop">tasks_<wbr>stop</a></div><div class="desc docblock-short">Stops PDM transfer</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::pdm::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::pdm::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_END.html" title="type nrf52840_pac::pdm::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_STARTED.html" title="type nrf52840_pac::pdm::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::pdm::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.GAINL.html" title="type nrf52840_pac::pdm::GAINL">GAINL</a></div><div class="desc docblock-short">GAINL (rw) register accessor: an alias for <code>Reg&lt;GAINL_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.GAINR.html" title="type nrf52840_pac::pdm::GAINR">GAINR</a></div><div class="desc docblock-short">GAINR (rw) register accessor: an alias for <code>Reg&lt;GAINR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.INTEN.html" title="type nrf52840_pac::pdm::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-name"><a class="type" href="type.INTENCLR.html" title="type nrf52840_pac::pdm::INTENCLR">INTENCLR</a></div><div class="desc docblock-short">INTENCLR (rw) register accessor: an alias for <code>Reg&lt;INTENCLR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.INTENSET.html" title="type nrf52840_pac::pdm::INTENSET">INTENSET</a></div><div class="desc docblock-short">INTENSET (rw) register accessor: an alias for <code>Reg&lt;INTENSET_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.MODE.html" title="type nrf52840_pac::pdm::MODE">MODE</a></div><div class="desc docblock-short">MODE (rw) register accessor: an alias for <code>Reg&lt;MODE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.PDMCLKCTRL.html" title="type nrf52840_pac::pdm::PDMCLKCTRL">PDMCLKCTRL</a></div><div class="desc docblock-short">PDMCLKCTRL (rw) register accessor: an alias for <code>Reg&lt;PDMCLKCTRL_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.RATIO.html" title="type nrf52840_pac::pdm::RATIO">RATIO</a></div><div class="desc docblock-short">RATIO (rw) register accessor: an alias for <code>Reg&lt;RATIO_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_START.html" title="type nrf52840_pac::pdm::TASKS_START">TASKS_<wbr>START</a></div><div class="desc docblock-short">TASKS_START (w) register accessor: an alias for <code>Reg&lt;TASKS_START_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_STOP.html" title="type nrf52840_pac::pdm::TASKS_STOP">TASKS_<wbr>STOP</a></div><div class="desc docblock-short">TASKS_STOP (w) register accessor: an alias for <code>Reg&lt;TASKS_STOP_SPEC&gt;</code></div></li></ul></section></div></main></body></html>