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

4 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="Pulse width modulation unit 0"><title>nrf52840_pac::pwm0 - 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 pwm0</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>pwm0</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/pwm0.rs.html#1-136">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Pulse width modulation unit 0</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.SEQ"><code>pub use seq::<a class="struct" href="seq/struct.SEQ.html" title="struct nrf52840_pac::pwm0::seq::SEQ">SEQ</a>;</code></div></li><li><div class="item-name" id="reexport.PSEL"><code>pub use psel::<a class="struct" href="psel/struct.PSEL.html" title="struct nrf52840_pac::pwm0::psel::PSEL">PSEL</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="countertop/index.html" title="mod nrf52840_pac::pwm0::countertop">countertop</a></div><div class="desc docblock-short">Value up to which the pulse generator counter counts</div></li><li><div class="item-name"><a class="mod" href="decoder/index.html" title="mod nrf52840_pac::pwm0::decoder">decoder</a></div><div class="desc docblock-short">Configuration of the decoder</div></li><li><div class="item-name"><a class="mod" href="enable/index.html" title="mod nrf52840_pac::pwm0::enable">enable</a></div><div class="desc docblock-short">PWM module enable register</div></li><li><div class="item-name"><a class="mod" href="events_loopsdone/index.html" title="mod nrf52840_pac::pwm0::events_loopsdone">events_<wbr>loopsdone</a></div><div class="desc docblock-short">Concatenated sequences have been played the amount of times defined in LOOP.CNT</div></li><li><div class="item-name"><a class="mod" href="events_pwmperiodend/index.html" title="mod nrf52840_pac::pwm0::events_pwmperiodend">events_<wbr>pwmperiodend</a></div><div class="desc docblock-short">Emitted at the end of each PWM period</div></li><li><div class="item-name"><a class="mod" href="events_seqend/index.html" title="mod nrf52840_pac::pwm0::events_seqend">events_<wbr>seqend</a></div><div class="desc docblock-short">Description collection[n]: Emitted at end of every sequence n, when last value from RAM has been applied to wave counter</div></li><li><div class="item-name"><a class="mod" href="events_seqstarted/index.html" title="mod nrf52840_pac::pwm0::events_seqstarted">events_<wbr>seqstarted</a></div><div class="desc docblock-short">Description collection[n]: First PWM period started on sequence n</div></li><li><div class="item-name"><a class="mod" href="events_stopped/index.html" title="mod nrf52840_pac::pwm0::events_stopped">events_<wbr>stopped</a></div><div class="desc docblock-short">Response to STOP task, emitted when PWM pulses are no longer generated</div></li><li><div class="item-name"><a class="mod" href="inten/index.html" title="mod nrf52840_pac::pwm0::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::pwm0::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::pwm0::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="loop_/index.html" title="mod nrf52840_pac::pwm0::loop_">loop_</a></div><div class="desc docblock-short">Number of playbacks of a loop</div></li><li><div class="item-name"><a class="mod" href="mode/index.html" title="mod nrf52840_pac::pwm0::mode">mode</a></div><div class="desc docblock-short">Selects operating mode of the wave counter</div></li><li><div class="item-name"><a class="mod" href="prescaler/index.html" title="mod nrf52840_pac::pwm0::prescaler">prescaler</a></div><div class="desc docblock-short">Configuration for PWM_CLK</div></li><li><div class="item-name"><a class="mod" href="psel/index.html" title="mod nrf52840_pac::pwm0::psel">psel</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="seq/index.html" title="mod nrf52840_pac::pwm0::seq">seq</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="shorts/index.html" title="mod nrf52840_pac::pwm0::shorts">shorts</a></div><div class="desc docblock-short">Shortcut register</div></li><li><div class="item-name"><a class="mod" href="tasks_nextstep/index.html" title="mod nrf52840_pac::pwm0::tasks_nextstep">tasks_<wbr>nextstep</a></div><div class="desc docblock-short">Steps by one value in the current sequence on all enabled channels if DECODER.MODE=NextStep. Does not cause PWM generation to start if not running.</div></li><li><div class="item-name"><a class="mod" href="tasks_seqstart/index.html" title="mod nrf52840_pac::pwm0::tasks_seqstart">tasks_<wbr>seqstart</a></div><div class="desc docblock-short">Description collection[n]: Loads the first PWM value on all enabled channels from sequence n, and starts playing that sequence at the rate defined in SEQ[n]REFRESH and/or DECODER.MODE. Causes PWM generation to start if not running.</div></li><li><div class="item-name"><a class="mod" href="tasks_stop/index.html" title="mod nrf52840_pac::pwm0::tasks_stop">tasks_<wbr>stop</a></div><div class="desc docblock-short">Stops PWM pulse generation on all channels at the end of current PWM period, and stops sequence playback</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::pwm0::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.COUNTERTOP.html" title="type nrf52840_pac::pwm0::COUNTERTOP">COUNTERTOP</a></div><div class="desc docblock-short">COUNTERTOP (rw) register accessor: an alias for <code>Reg&lt;COUNTERTOP_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.DECODER.html" title="type nrf52840_pac::pwm0::DECODER">DECODER</a></div><div class="desc docblock-short">DECODER (rw) register accessor: an alias for <code>Reg&lt;DECODER_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ENABLE.html" title="type nrf52840_pac::pwm0::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_LOOPSDONE.html" title="type nrf52840_pac::pwm0::EVENTS_LOOPSDONE">EVENTS_<wbr>LOOPSDONE</a></div><div class="desc docblock-short">EVENTS_LOOPSDONE (rw) register accessor: an alias for <code>Reg&lt;EVENTS_LOOPSDONE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_PWMPERIODEND.html" title="type nrf52840_pac::pwm0::EVENTS_PWMPERIODEND">EVENTS_<wbr>PWMPERIODEND</a></div><div class="desc docblock-short">EVENTS_PWMPERIODEND (rw) register accessor: an alias for <code>Reg&lt;EVENTS_PWMPERIODEND_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_SEQEND.html" title="type nrf52840_pac::pwm0::EVENTS_SEQEND">EVENTS_<wbr>SEQEND</a></div><div class="desc docblock-short">EVENTS_SEQEND (rw) register accessor: an alias for <code>Reg&lt;EVENTS_SEQEND_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_SEQSTARTED.html" title="type nrf52840_pac::pwm0::EVENTS_SEQSTARTED">EVENTS_<wbr>SEQSTARTED</a></div><div class="desc docblock-short">EVENTS_SEQSTARTED (rw) register accessor: an alias for <code>Reg&lt;EVENTS_SEQSTARTED_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_STOPPED.html" title="type nrf52840_pac::pwm0::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::pwm0::INTEN">INTEN</a></di