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

7 lines
10 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="Inter-IC Sound"><title>nrf52840_pac::i2s - 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 i2s</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>i2s</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/i2s.rs.html#1-101">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Inter-IC Sound</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.CONFIG"><code>pub use config::<a class="struct" href="config/struct.CONFIG.html" title="struct nrf52840_pac::i2s::config::CONFIG">CONFIG</a>;</code></div></li><li><div class="item-name" id="reexport.RXD"><code>pub use rxd::<a class="struct" href="rxd/struct.RXD.html" title="struct nrf52840_pac::i2s::rxd::RXD">RXD</a>;</code></div></li><li><div class="item-name" id="reexport.TXD"><code>pub use txd::<a class="struct" href="txd/struct.TXD.html" title="struct nrf52840_pac::i2s::txd::TXD">TXD</a>;</code></div></li><li><div class="item-name" id="reexport.RXTXD"><code>pub use rxtxd::<a class="struct" href="rxtxd/struct.RXTXD.html" title="struct nrf52840_pac::i2s::rxtxd::RXTXD">RXTXD</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::i2s::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="config/index.html" title="mod nrf52840_pac::i2s::config">config</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::i2s::enable">enable</a></div><div class="desc docblock-short">Enable I2S module.</div></li><li><div class="item-name"><a class="mod" href="events_rxptrupd/index.html" title="mod nrf52840_pac::i2s::events_rxptrupd">events_<wbr>rxptrupd</a></div><div class="desc docblock-short">The RXD.PTR register has been copied to internal double-buffers. When the I2S module is started and RX is enabled, this event will be generated for every RXTXD.MAXCNT words that are received on the SDIN pin.</div></li><li><div class="item-name"><a class="mod" href="events_stopped/index.html" title="mod nrf52840_pac::i2s::events_stopped">events_<wbr>stopped</a></div><div class="desc docblock-short">I2S transfer stopped.</div></li><li><div class="item-name"><a class="mod" href="events_txptrupd/index.html" title="mod nrf52840_pac::i2s::events_txptrupd">events_<wbr>txptrupd</a></div><div class="desc docblock-short">The TDX.PTR register has been copied to internal double-buffers. When the I2S module is started and TX is enabled, this event will be generated for every RXTXD.MAXCNT words that are sent on the SDOUT pin.</div></li><li><div class="item-name"><a class="mod" href="inten/index.html" title="mod nrf52840_pac::i2s::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::i2s::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::i2s::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="psel/index.html" title="mod nrf52840_pac::i2s::psel">psel</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="rxd/index.html" title="mod nrf52840_pac::i2s::rxd">rxd</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="rxtxd/index.html" title="mod nrf52840_pac::i2s::rxtxd">rxtxd</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::i2s::tasks_start">tasks_<wbr>start</a></div><div class="desc docblock-short">Starts continuous I2S transfer. Also starts MCK generator when this is enabled.</div></li><li><div class="item-name"><a class="mod" href="tasks_stop/index.html" title="mod nrf52840_pac::i2s::tasks_stop">tasks_<wbr>stop</a></div><div class="desc docblock-short">Stops I2S transfer. Also stops MCK generator. Triggering this task will cause the {event:STOPPED} event to be generated.</div></li><li><div class="item-name"><a class="mod" href="txd/index.html" title="mod nrf52840_pac::i2s::txd">txd</a></div><div class="desc docblock-short">Cluster
Unspecified</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::i2s::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::i2s::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_RXPTRUPD.html" title="type nrf52840_pac::i2s::EVENTS_RXPTRUPD">EVENTS_<wbr>RXPTRUPD</a></div><div class="desc docblock-short">EVENTS_RXPTRUPD (rw) register accessor: an alias for <code>Reg&lt;EVENTS_RXPTRUPD_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_STOPPED.html" title="type nrf52840_pac::i2s::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.EVENTS_TXPTRUPD.html" title="type nrf52840_pac::i2s::EVENTS_TXPTRUPD">EVENTS_<wbr>TXPTRUPD</a></div><div class="desc docblock-short">EVENTS_TXPTRUPD (rw) register accessor: an alias for <code>Reg&lt;EVENTS_TXPTRUPD_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.INTEN.html" title="type nrf52840_pac::i2s::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::i2s::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::i2s::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.TASKS_START.html" title="type nrf52840_pac::i2s::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::i2s::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>