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

5 lines
26 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="NFC-A compatible radio"><title>nrf52840_pac::nfct - 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 nfct</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>nfct</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/nfct.rs.html#1-286">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>NFC-A compatible radio</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.FRAMESTATUS"><code>pub use framestatus::<a class="struct" href="framestatus/struct.FRAMESTATUS.html" title="struct nrf52840_pac::nfct::framestatus::FRAMESTATUS">FRAMESTATUS</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::nfct::txd::TXD">TXD</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::nfct::rxd::RXD">RXD</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="autocolresconfig/index.html" title="mod nrf52840_pac::nfct::autocolresconfig">autocolresconfig</a></div><div class="desc docblock-short">Controls the auto collision resolution function. This setting must be done before the NFCT peripheral is enabled.</div></li><li><div class="item-name"><a class="mod" href="errorstatus/index.html" title="mod nrf52840_pac::nfct::errorstatus">errorstatus</a></div><div class="desc docblock-short">NFC Error Status register</div></li><li><div class="item-name"><a class="mod" href="events_autocolresstarted/index.html" title="mod nrf52840_pac::nfct::events_autocolresstarted">events_<wbr>autocolresstarted</a></div><div class="desc docblock-short">Auto collision resolution process has started</div></li><li><div class="item-name"><a class="mod" href="events_collision/index.html" title="mod nrf52840_pac::nfct::events_collision">events_<wbr>collision</a></div><div class="desc docblock-short">NFC auto collision resolution error reported.</div></li><li><div class="item-name"><a class="mod" href="events_endrx/index.html" title="mod nrf52840_pac::nfct::events_endrx">events_<wbr>endrx</a></div><div class="desc docblock-short">RX buffer (as defined by PACKETPTR and MAXLEN) in Data RAM full.</div></li><li><div class="item-name"><a class="mod" href="events_endtx/index.html" title="mod nrf52840_pac::nfct::events_endtx">events_<wbr>endtx</a></div><div class="desc docblock-short">Transmission of data in RAM has ended, and EasyDMA has ended accessing the TX buffer</div></li><li><div class="item-name"><a class="mod" href="events_error/index.html" title="mod nrf52840_pac::nfct::events_error">events_<wbr>error</a></div><div class="desc docblock-short">NFC error reported. The ERRORSTATUS register contains details on the source of the error.</div></li><li><div class="item-name"><a class="mod" href="events_fielddetected/index.html" title="mod nrf52840_pac::nfct::events_fielddetected">events_<wbr>fielddetected</a></div><div class="desc docblock-short">Remote NFC field detected</div></li><li><div class="item-name"><a class="mod" href="events_fieldlost/index.html" title="mod nrf52840_pac::nfct::events_fieldlost">events_<wbr>fieldlost</a></div><div class="desc docblock-short">Remote NFC field lost</div></li><li><div class="item-name"><a class="mod" href="events_ready/index.html" title="mod nrf52840_pac::nfct::events_ready">events_<wbr>ready</a></div><div class="desc docblock-short">The NFCT peripheral is ready to receive and send frames</div></li><li><div class="item-name"><a class="mod" href="events_rxerror/index.html" title="mod nrf52840_pac::nfct::events_rxerror">events_<wbr>rxerror</a></div><div class="desc docblock-short">NFC RX frame error reported. The FRAMESTATUS.RX register contains details on the source of the error.</div></li><li><div class="item-name"><a class="mod" href="events_rxframeend/index.html" title="mod nrf52840_pac::nfct::events_rxframeend">events_<wbr>rxframeend</a></div><div class="desc docblock-short">Received data has been checked (CRC, parity) and transferred to RAM, and EasyDMA has ended accessing the RX buffer</div></li><li><div class="item-name"><a class="mod" href="events_rxframestart/index.html" title="mod
Unspecified</div></li><li><div class="item-name"><a class="mod" href="inten/index.html" title="mod nrf52840_pac::nfct::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::nfct::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::nfct::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="maxlen/index.html" title="mod nrf52840_pac::nfct::maxlen">maxlen</a></div><div class="desc docblock-short">Size of the RAM buffer allocated to TXD and RXD data storage each</div></li><li><div class="item-name"><a class="mod" href="nfcid1_2nd_last/index.html" title="mod nrf52840_pac::nfct::nfcid1_2nd_last">nfcid1_<wbr>2nd_<wbr>last</a></div><div class="desc docblock-short">Second last NFCID1 part (7 or 10 bytes ID)</div></li><li><div class="item-name"><a class="mod" href="nfcid1_3rd_last/index.html" title="mod nrf52840_pac::nfct::nfcid1_3rd_last">nfcid1_<wbr>3rd_<wbr>last</a></div><div class="desc docblock-short">Third last NFCID1 part (10 bytes ID)</div></li><li><div class="item-name"><a class="mod" href="nfcid1_last/index.html" title="mod nrf52840_pac::nfct::nfcid1_last">nfcid1_<wbr>last</a></div><div class="desc docblock-short">Last NFCID1 part (4, 7 or 10 bytes ID)</div></li><li><div class="item-name"><a class="mod" href="nfctagstate/index.html" title="mod nrf52840_pac::nfct::nfctagstate">nfctagstate</a></div><div class="desc docblock-short">NfcTag state register</div></li><li><div class="item-name"><a class="mod" href="packetptr/index.html" title="mod nrf52840_pac::nfct::packetptr">packetptr</a></div><div class="desc docblock-short">Packet pointer for TXD and RXD data storage in Data RAM</div></li><li><div class="item-name"><a class="mod" href="rxd/index.html" title="mod nrf52840_pac::nfct::rxd">rxd</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="selres/index.html" title="mod nrf52840_pac::nfct::selres">selres</a></div><div class="desc docblock-short">NFC-A SEL_RES auto-response settings</div></li><li><div class="item-name"><a class="mod" href="sensres/index.html" title="mod nrf52840_pac::nfct::sensres">sensres</a></div><div class="desc docblock-short">NFC-A SENS_RES auto-response settings</div></li><li><div class="item-name"><a class="mod" href="shorts/index.html" title="mod nrf52840_pac::nfct::shorts">shorts</a></div><div class="desc docblock-short">Shortcut register</div></li><li><div class="item-name"><a class="mod" href="sleepstate/index.html" title="mod nrf52840_pac::nfct::sleepstate">sleepstate</a></div><div class="desc docblock-short">Sleep state during automatic collision resolution</div></li><li><div class="item-name"><a class="mod" href="tasks_activate/index.html" title="mod nrf52840_pac::nfct::tasks_activate">tasks_<wbr>activate</a></div><div class="desc docblock-short">Activate NFCT peripheral for incoming and outgoing frames, change state to activated</div></li><li><div class="item-name"><a class="mod" href="tasks_disable/index.html" title="mod nrf52840_pac::nfct::tasks_disable">tasks_<wbr>disable</a></div><div class="desc docblock-short">Disable NFCT peripheral</div></li><li><div class="item-name"><a class="mod" href="tasks_enablerxdata/index.html" title="mod nrf52840_pac::nfct::tasks_enablerxdata">tasks_<wbr>enablerxdata</a></div><div class="desc docblock-short">Initializes the EasyDMA for receive.</div></li><li><div class="item-name"><a class="mod" href="tasks_goidle/index.html" title="mod nrf52840_pac::nfct::tasks_goidle">tasks_<wbr>goidle</a></div><div class="desc docblock-short">Force state machine to IDLE state</div></li><li><div class="item-name"><a class="mod" href="tasks_gosleep/index.html" title="mod nrf52840_pac::nfct::tasks_gosleep">tasks_<wbr>gosleep</a></div><div class="desc docblock-short">Force state machine to SLEEP_A state</div></li><li><div class="item-name"><a class="mod" href="tasks_sense/index.html" title="mod nrf52840_pac::nfct::tasks_sense">tasks_<wbr>sense</a></div><div class="desc docblock-short">Enable NFC sense field mode, change state to sense mode</div></li><li><div class="item-name"><a class="mod" href="tasks_starttx/index.html" title="mod nrf52840_pac::nfct::tasks_starttx">tasks_<wbr>starttx</a></div><div class="desc docblock-short">Start transmission of an outgoing frame, change state to transmit</div></li><li><div class="item-name"><a class="mod" href="txd/index.html" title="mod nrf52840_pac::nfct::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::nfct::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.AUTOCOLRESCONFIG.html" title="type nrf52840_pac::nfct::AUTOCOLRESCONFIG">AUTOCOLRESCONFIG</a></div><div class="desc docblock-short">AUTOCOLRESCONFIG (rw) register accessor: an alias for <code>Reg&lt;AUTOCOLRESCONFIG_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ERRORSTATUS.html" title="type nrf52840_pac::nfct::ERRORSTATUS">ERRORSTATUS</a></div><div class="desc docblock-short">ERRORSTATUS (rw) register accessor: an alias for <code>Reg&lt;ERRORSTATUS_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_AUTOCOLRESSTARTED.html" title="type nrf52840_pac::nfct::EVENTS_AUTOCOLRESSTARTED">EVENTS_<wbr>AUTOCOLRESSTARTED</a></div><div class="desc docblock-short">EVENTS_AUTOCOLRESSTARTED (rw) register accessor: an alias for <code>Reg&lt;EVENTS_AUTOCOLRESSTARTED_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_COLLISION.html" title="type nrf52840_pac::nfct::EVENTS_COLLISION">EVENTS_<wbr>COLLISION</a></div><div class="desc docblock-short">EVENTS_COLLISION (rw) register accessor: an alias for <code>Reg&lt;EVENTS_COLLISION_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_ENDRX.html" title="type nrf52840_pac::nfct::EVENTS_ENDRX">EVENTS_<wbr>ENDRX</a></div><div class="desc docblock-short">EVENTS_ENDRX (rw) register accessor: an alias for <code>Reg&lt;EVENTS_ENDRX_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_ENDTX.html" title="type nrf52840_pac::nfct::EVENTS_ENDTX">EVENTS_<wbr>ENDTX</a></div><div class="desc docblock-short">EVENTS_ENDTX (rw) register accessor: an alias for <code>Reg&lt;EVENTS_ENDTX_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_ERROR.html" title="type nrf52840_pac::nfct::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_FIELDDETECTED.html" title="type nrf52840_pac::nfct::EVENTS_FIELDDETECTED">EVENTS_<wbr>FIELDDETECTED</a></div><div class="desc docblock-short">EVENTS_FIELDDETECTED (rw) register accessor: an alias for <code>Reg&lt;EVENTS_FIELDDETECTED_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_FIELDLOST.html" title="type nrf52840_pac::nfct::EVENTS_FIELDLOST">EVENTS_<wbr>FIELDLOST</a></div><div class="desc docblock-short">EVENTS_FIELDLOST (rw) register accessor: an alias for <code>Reg&lt;EVENTS_FIELDLOST_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_READY.html" title="type nrf52840_pac::nfct::EVENTS_READY">EVENTS_<wbr>READY</a></div><div class="desc docblock-short">EVENTS_READY (rw) register accessor: an alias for <code>Reg&lt;EVENTS_READY_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_RXERROR.html" title="type nrf52840_pac::nfct::EVENTS_RXERROR">EVENTS_<wbr>RXERROR</a></div><div class="desc docblock-short">EVENTS_RXERROR (rw) register accessor: an alias for <code>Reg&lt;EVENTS_RXERROR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_RXFRAMEEND.html" title="type nrf52840_pac::nfct::EVENTS_RXFRAMEEND">EVENTS_<wbr>RXFRAMEEND</a></div><div class="desc docblock-short">EVENTS_RXFRAMEEND (rw) register accessor: an alias for <code>Reg&lt;EVENTS_RXFRAMEEND_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_RXFRAM