rtic/dev/api/nrf52840_pac/ccm/index.html
github-merge-queue[bot] 5b32b958a3 deploy: f17915842f
2024-11-27 19:34:22 +00:00

2 lines
No EOL
13 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="AES CCM Mode Encryption"><title>nrf52840_pac::ccm - 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-492a78a4a87dcc01.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.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-3b12f09e550e0385.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><h2 class="location"><a href="#">Module ccm</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate nrf52840_<wbr>pac</a></h2></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"><h1>Module <a href="../index.html">nrf52840_pac</a>::<wbr><a class="mod" href="#">ccm</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/nrf52840_pac/ccm.rs.html#1-123">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>AES CCM Mode Encryption</p>
</div></details><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="cnfptr/index.html" title="mod nrf52840_pac::ccm::cnfptr">cnfptr</a></div><div class="desc docblock-short">Pointer to data structure holding AES key and NONCE vector</div></li><li><div class="item-name"><a class="mod" href="enable/index.html" title="mod nrf52840_pac::ccm::enable">enable</a></div><div class="desc docblock-short">Enable</div></li><li><div class="item-name"><a class="mod" href="events_endcrypt/index.html" title="mod nrf52840_pac::ccm::events_endcrypt">events_<wbr>endcrypt</a></div><div class="desc docblock-short">Encrypt/decrypt complete</div></li><li><div class="item-name"><a class="mod" href="events_endksgen/index.html" title="mod nrf52840_pac::ccm::events_endksgen">events_<wbr>endksgen</a></div><div class="desc docblock-short">Key-stream generation complete</div></li><li><div class="item-name"><a class="mod" href="events_error/index.html" title="mod nrf52840_pac::ccm::events_error">events_<wbr>error</a></div><div class="desc docblock-short">Deprecated register - CCM error event</div></li><li><div class="item-name"><a class="mod" href="inptr/index.html" title="mod nrf52840_pac::ccm::inptr">inptr</a></div><div class="desc docblock-short">Input pointer</div></li><li><div class="item-name"><a class="mod" href="intenclr/index.html" title="mod nrf52840_pac::ccm::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::ccm::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="maxpacketsize/index.html" title="mod nrf52840_pac::ccm::maxpacketsize">maxpacketsize</a></div><div class="desc docblock-short">Length of key-stream generated when MODE.LENGTH = Extended.</div></li><li><div class="item-name"><a class="mod" href="micstatus/index.html" title="mod nrf52840_pac::ccm::micstatus">micstatus</a></div><div class="desc docblock-short">MIC check result</div></li><li><div class="item-name"><a class="mod" href="mode/index.html" title="mod nrf52840_pac::ccm::mode">mode</a></div><div class="desc docblock-short">Operation mode</div></li><li><div class="item-name"><a class="mod" href="outptr/index.html" title="mod nrf52840_pac::ccm::outptr">outptr</a></div><div class="desc docblock-short">Output pointer</div></li><li><div class="item-name"><a class="mod" href="rateoverride/index.html" title="mod nrf52840_pac::ccm::rateoverride">rateoverride</a></div><div class="desc docblock-short">Data rate override setting.</div></li><li><div class="item-name"><a class="mod" href="scratchptr/index.html" title="mod nrf52840_pac::ccm::scratchptr">scratchptr</a></div><div class="desc docblock-short">Pointer to data area used for temporary storage</div></li><li><div class="item-name"><a class="mod" href="shorts/index.html" title="mod nrf52840_pac::ccm::shorts">shorts</a></div><div class="desc docblock-short">Shortcut register</div></li><li><div class="item-name"><a class="mod" href="tasks_crypt/index.html" title="mod nrf52840_pac::ccm::tasks_crypt">tasks_<wbr>crypt</a></div><div class="desc docblock-short">Start encryption/decryption. This operation will stop by itself when completed.</div></li><li><div class="item-name"><a class="mod" href="tasks_ksgen/index.html" title="mod nrf52840_pac::ccm::tasks_ksgen">tasks_<wbr>ksgen</a></div><div class="desc docblock-short">Start generation of key-stream. This operation will stop by itself when completed.</div></li><li><div class="item-name"><a class="mod" href="tasks_rateoverride/index.html" title="mod nrf52840_pac::ccm::tasks_rateoverride">tasks_<wbr>rateoverride</a></div><div class="desc docblock-short">Override DATARATE setting in MODE register with the contents of the RATEOVERRIDE register for any ongoing encryption/decryption</div></li><li><div class="item-name"><a class="mod" href="tasks_stop/index.html" title="mod nrf52840_pac::ccm::tasks_stop">tasks_<wbr>stop</a></div><div class="desc docblock-short">Stop encryption/decryption</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::ccm::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.CNFPTR.html" title="type nrf52840_pac::ccm::CNFPTR">CNFPTR</a></div><div class="desc docblock-short">CNFPTR (rw) register accessor: an alias for <code>Reg&lt;CNFPTR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ENABLE.html" title="type nrf52840_pac::ccm::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_ENDCRYPT.html" title="type nrf52840_pac::ccm::EVENTS_ENDCRYPT">EVENT<wbr>S_<wbr>ENDCRYPT</a></div><div class="desc docblock-short">EVENTS_ENDCRYPT (rw) register accessor: an alias for <code>Reg&lt;EVENTS_ENDCRYPT_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_ENDKSGEN.html" title="type nrf52840_pac::ccm::EVENTS_ENDKSGEN">EVENT<wbr>S_<wbr>ENDKSGEN</a></div><div class="desc docblock-short">EVENTS_ENDKSGEN (rw) register accessor: an alias for <code>Reg&lt;EVENTS_ENDKSGEN_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_ERROR.html" title="type nrf52840_pac::ccm::EVENTS_ERROR">EVENT<wbr>S_<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.INPTR.html" title="type nrf52840_pac::ccm::INPTR">INPTR</a></div><div class="desc docblock-short">INPTR (rw) register accessor: an alias for <code>Reg&lt;INPTR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.INTENCLR.html" title="type nrf52840_pac::ccm::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::ccm::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.MAXPACKETSIZE.html" title="type nrf52840_pac::ccm::MAXPACKETSIZE">MAXPACKETSIZE</a></div><div class="desc docblock-short">MAXPACKETSIZE (rw) register accessor: an alias for <code>Reg&lt;MAXPACKETSIZE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.MICSTATUS.html" title="type nrf52840_pac::ccm::MICSTATUS">MICSTATUS</a></div><div class="desc docblock-short">MICSTATUS (r) register accessor: an alias for <code>Reg&lt;MICSTATUS_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.MODE.html" title="type nrf52840_pac::ccm::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.OUTPTR.html" title="type nrf52840_pac::ccm::OUTPTR">OUTPTR</a></div><div class="desc docblock-short">OUTPTR (rw) register accessor: an alias for <code>Reg&lt;OUTPTR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.RATEOVERRIDE.html" title="type nrf52840_pac::ccm::RATEOVERRIDE">RATEOVERRIDE</a></div><div class="desc docblock-short">RATEOVERRIDE (rw) register accessor: an alias for <code>Reg&lt;RATEOVERRIDE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.SCRATCHPTR.html" title="type nrf52840_pac::ccm::SCRATCHPTR">SCRATCHPTR</a></div><div class="desc docblock-short">SCRATCHPTR (rw) register accessor: an alias for <code>Reg&lt;SCRATCHPTR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.SHORTS.html" title="type nrf52840_pac::ccm::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_CRYPT.html" title="type nrf52840_pac::ccm::TASKS_CRYPT">TASK<wbr>S_<wbr>CRYPT</a></div><div class="desc docblock-short">TASKS_CRYPT (w) register accessor: an alias for <code>Reg&lt;TASKS_CRYPT_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_KSGEN.html" title="type nrf52840_pac::ccm::TASKS_KSGEN">TASK<wbr>S_<wbr>KSGEN</a></div><div class="desc docblock-short">TASKS_KSGEN (w) register accessor: an alias for <code>Reg&lt;TASKS_KSGEN_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_RATEOVERRIDE.html" title="type nrf52840_pac::ccm::TASKS_RATEOVERRIDE">TASK<wbr>S_<wbr>RATEOVERRIDE</a></div><div class="desc docblock-short">TASKS_RATEOVERRIDE (w) register accessor: an alias for <code>Reg&lt;TASKS_RATEOVERRIDE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_STOP.html" title="type nrf52840_pac::ccm::TASKS_STOP">TASK<wbr>S_<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>