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

5 lines
No EOL
15 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="I2C compatible Two-Wire Slave Interface with EasyDMA 0"><title>nrf52840_pac::twis0 - 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 twis0</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>twis0</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/twis0.rs.html#1-168">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>I2C compatible Two-Wire Slave Interface with EasyDMA 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.PSEL"><code>pub use psel::<a class="struct" href="psel/struct.PSEL.html" title="struct nrf52840_pac::twis0::psel::PSEL">PSEL</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::twis0::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::twis0::txd::TXD">TXD</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="address/index.html" title="mod nrf52840_pac::twis0::address">address</a></div><div class="desc docblock-short">Description collection[n]: TWI slave address n</div></li><li><div class="item-name"><a class="mod" href="config/index.html" title="mod nrf52840_pac::twis0::config">config</a></div><div class="desc docblock-short">Configuration register for the address match mechanism</div></li><li><div class="item-name"><a class="mod" href="enable/index.html" title="mod nrf52840_pac::twis0::enable">enable</a></div><div class="desc docblock-short">Enable TWIS</div></li><li><div class="item-name"><a class="mod" href="errorsrc/index.html" title="mod nrf52840_pac::twis0::errorsrc">errorsrc</a></div><div class="desc docblock-short">Error source</div></li><li><div class="item-name"><a class="mod" href="events_error/index.html" title="mod nrf52840_pac::twis0::events_error">events_<wbr>error</a></div><div class="desc docblock-short">TWI error</div></li><li><div class="item-name"><a class="mod" href="events_read/index.html" title="mod nrf52840_pac::twis0::events_read">events_<wbr>read</a></div><div class="desc docblock-short">Read command received</div></li><li><div class="item-name"><a class="mod" href="events_rxstarted/index.html" title="mod nrf52840_pac::twis0::events_rxstarted">events_<wbr>rxstarted</a></div><div class="desc docblock-short">Receive sequence started</div></li><li><div class="item-name"><a class="mod" href="events_stopped/index.html" title="mod nrf52840_pac::twis0::events_stopped">events_<wbr>stopped</a></div><div class="desc docblock-short">TWI stopped</div></li><li><div class="item-name"><a class="mod" href="events_txstarted/index.html" title="mod nrf52840_pac::twis0::events_txstarted">events_<wbr>txstarted</a></div><div class="desc docblock-short">Transmit sequence started</div></li><li><div class="item-name"><a class="mod" href="events_write/index.html" title="mod nrf52840_pac::twis0::events_write">events_<wbr>write</a></div><div class="desc docblock-short">Write command received</div></li><li><div class="item-name"><a class="mod" href="inten/index.html" title="mod nrf52840_pac::twis0::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::twis0::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::twis0::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="match_/index.html" title="mod nrf52840_pac::twis0::match_">match_</a></div><div class="desc docblock-short">Status register indicating which address had a match</div></li><li><div class="item-name"><a class="mod" href="orc/index.html" title="mod nrf52840_pac::twis0::orc">orc</a></div><div class="desc docblock-short">Over-read character. Character sent out in case of an over-read of the transmit buffer.</div></li><li><div class="item-name"><a class="mod" href="psel/index.html" title="mod nrf52840_pac::twis0::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::twis0::rxd">rxd</a></div><div class="desc docblock-short">Cluster
RXD EasyDMA channel</div></li><li><div class="item-name"><a class="mod" href="shorts/index.html" title="mod nrf52840_pac::twis0::shorts">shorts</a></div><div class="desc docblock-short">Shortcut register</div></li><li><div class="item-name"><a class="mod" href="tasks_preparerx/index.html" title="mod nrf52840_pac::twis0::tasks_preparerx">tasks_<wbr>preparerx</a></div><div class="desc docblock-short">Prepare the TWI slave to respond to a write command</div></li><li><div class="item-name"><a class="mod" href="tasks_preparetx/index.html" title="mod nrf52840_pac::twis0::tasks_preparetx">tasks_<wbr>preparetx</a></div><div class="desc docblock-short">Prepare the TWI slave to respond to a read command</div></li><li><div class="item-name"><a class="mod" href="tasks_resume/index.html" title="mod nrf52840_pac::twis0::tasks_resume">tasks_<wbr>resume</a></div><div class="desc docblock-short">Resume TWI transaction</div></li><li><div class="item-name"><a class="mod" href="tasks_stop/index.html" title="mod nrf52840_pac::twis0::tasks_stop">tasks_<wbr>stop</a></div><div class="desc docblock-short">Stop TWI transaction</div></li><li><div class="item-name"><a class="mod" href="tasks_suspend/index.html" title="mod nrf52840_pac::twis0::tasks_suspend">tasks_<wbr>suspend</a></div><div class="desc docblock-short">Suspend TWI transaction</div></li><li><div class="item-name"><a class="mod" href="txd/index.html" title="mod nrf52840_pac::twis0::txd">txd</a></div><div class="desc docblock-short">Cluster
TXD EasyDMA channel</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::twis0::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.ADDRESS.html" title="type nrf52840_pac::twis0::ADDRESS">ADDRESS</a></div><div class="desc docblock-short">ADDRESS (rw) register accessor: an alias for <code>Reg&lt;ADDRESS_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.CONFIG.html" title="type nrf52840_pac::twis0::CONFIG">CONFIG</a></div><div class="desc docblock-short">CONFIG (rw) register accessor: an alias for <code>Reg&lt;CONFIG_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ENABLE.html" title="type nrf52840_pac::twis0::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.ERRORSRC.html" title="type nrf52840_pac::twis0::ERRORSRC">ERRORSRC</a></div><div class="desc docblock-short">ERRORSRC (rw) register accessor: an alias for <code>Reg&lt;ERRORSRC_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_ERROR.html" title="type nrf52840_pac::twis0::EVENTS_ERROR">EVENTS_<wbr>ERROR</a></div><div class="desc docblock-short">EVENTS_ERROR (rw) register accessor: an alias for <code>Reg&lt;EVENTS_ERROR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_READ.html" title="type nrf52840_pac::twis0::EVENTS_READ">EVENTS_<wbr>READ</a></div><div class="desc docblock-short">EVENTS_READ (rw) register accessor: an alias for <code>Reg&lt;EVENTS_READ_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_RXSTARTED.html" title="type nrf52840_pac::twis0::EVENTS_RXSTARTED">EVENTS_<wbr>RXSTARTED</a></div><div class="desc docblock-short">EVENTS_RXSTARTED (rw) register accessor: an alias for <code>Reg&lt;EVENTS_RXSTARTED_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_STOPPED.html" title="type nrf52840_pac::twis0::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_TXSTARTED.html" title="type nrf52840_pac::twis0::EVENTS_TXSTARTED">EVENTS_<wbr>TXSTARTED</a></div><div class="desc docblock-short">EVENTS_TXSTARTED (rw) register accessor: an alias for <code>Reg&lt;EVENTS_TXSTARTED_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_WRITE.html" title="type nrf52840_pac::twis0::EVENTS_WRITE">EVENTS_<wbr>WRITE</a></div><div class="desc docblock-short">EVENTS_WRITE (rw) register accessor: an alias for <code>Reg&lt;EVENTS_WRITE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.INTEN.html" title="type nrf52840_pac::twis0::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::twis0::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::twis0::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.MATCH.html" title="type nrf52840_pac::twis0::MATCH">MATCH</a></div><div class="desc docblock-short">MATCH (r) register accessor: an alias for <code>Reg&lt;MATCH_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ORC.html" title="type nrf52840_pac::twis0::ORC">ORC</a></div><div class="desc docblock-short">ORC (rw) register accessor: an alias for <code>Reg&lt;ORC_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.SHORTS.html" title="type nrf52840_pac::twis0::SHORTS">SHORTS</a></div><div class="desc docblock-short">SHORTS (rw) register accessor: an alias for <code>Reg&lt;SHORTS_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_PREPARERX.html" title="type nrf52840_pac::twis0::TASKS_PREPARERX">TASKS_<wbr>PREPARERX</a></div><div class="desc docblock-short">TASKS_PREPARERX (w) register accessor: an alias for <code>Reg&lt;TASKS_PREPARERX_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_PREPARETX.html" title="type nrf52840_pac::twis0::TASKS_PREPARETX">TASKS_<wbr>PREPARETX</a></div><div class="desc docblock-short">TASKS_PREPARETX (w) register accessor: an alias for <code>Reg&lt;TASKS_PREPARETX_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_RESUME.html" title="type nrf52840_pac::twis0::TASKS_RESUME">TASKS_<wbr>RESUME</a></div><div class="desc docblock-short">TASKS_RESUME (w) register accessor: an alias for <code>Reg&lt;TASKS_RESUME_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_STOP.html" title="type nrf52840_pac::twis0::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><li><div class="item-name"><a class="type" href="type.TASKS_SUSPEND.html" title="type nrf52840_pac::twis0::TASKS_SUSPEND">TASKS_<wbr>SUSPEND</a></div><div class="desc docblock-short">TASKS_SUSPEND (w) register accessor: an alias for <code>Reg&lt;TASKS_SUSPEND_SPEC&gt;</code></div></li></ul></section></div></main></body></html>