rtic/dev/api/imxrt_ral/dcp/PACKET1/index.html
2024-12-06 13:35:18 +00:00

2 lines
No EOL
10 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="DCP work packet 1 status register"><title>imxrt_ral::dcp::PACKET1 - 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="imxrt_ral" 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="../../../imxrt_ral/index.html">imxrt_<wbr>ral</a><span class="version">0.5.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module PACKET1</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In imxrt_<wbr>ral::<wbr>dcp</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">imxrt_ral</a>::<wbr><a href="../index.html">dcp</a></span><h1>Module <span>PACKET1</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/imxrt_ral/blocks/imxrt1011/dcp.rs.html#1026">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>DCP work packet 1 status register</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="CHAIN/index.html" title="mod imxrt_ral::dcp::PACKET1::CHAIN">CHAIN</a></div><div class="desc docblock-short">Reflects whether the next command pointer register must be loaded into the channels current descriptor pointer</div></li><li><div class="item-name"><a class="mod" href="CHAIN_CONTIGUOUS/index.html" title="mod imxrt_ral::dcp::PACKET1::CHAIN_CONTIGUOUS">CHAIN_<wbr>CONTIGUOUS</a></div><div class="desc docblock-short">Reflects whether the next packets address is located following this packets payload.</div></li><li><div class="item-name"><a class="mod" href="CHECK_HASH/index.html" title="mod imxrt_ral::dcp::PACKET1::CHECK_HASH">CHECK_<wbr>HASH</a></div><div class="desc docblock-short">Reflects whether the calculated hash value must be compared to the hash provided in the payload.</div></li><li><div class="item-name"><a class="mod" href="CIPHER_ENCRYPT/index.html" title="mod imxrt_ral::dcp::PACKET1::CIPHER_ENCRYPT">CIPHER_<wbr>ENCRYPT</a></div><div class="desc docblock-short">When the cipher block is enabled, this bit indicates whether the operation is encryption or decryption</div></li><li><div class="item-name"><a class="mod" href="CIPHER_INIT/index.html" title="mod imxrt_ral::dcp::PACKET1::CIPHER_INIT">CIPHER_<wbr>INIT</a></div><div class="desc docblock-short">Reflects whether the cipher block must load the initialization vector from the payload for this operation</div></li><li><div class="item-name"><a class="mod" href="CONSTANT_FILL/index.html" title="mod imxrt_ral::dcp::PACKET1::CONSTANT_FILL">CONSTANT_<wbr>FILL</a></div><div class="desc docblock-short">When this bit is set (MEMCOPY and BLIT modes only), the DCP simply fills the destination buffer with the value found in the source address field</div></li><li><div class="item-name"><a class="mod" href="DECR_SEMAPHORE/index.html" title="mod imxrt_ral::dcp::PACKET1::DECR_SEMAPHORE">DECR_<wbr>SEMAPHORE</a></div><div class="desc docblock-short">Reflects whether the channels semaphore must be decremented at the end of the current operation</div></li><li><div class="item-name"><a class="mod" href="ENABLE_BLIT/index.html" title="mod imxrt_ral::dcp::PACKET1::ENABLE_BLIT">ENABLE_<wbr>BLIT</a></div><div class="desc docblock-short">Reflects whether the DCP must perform a blit operation</div></li><li><div class="item-name"><a class="mod" href="ENABLE_CIPHER/index.html" title="mod imxrt_ral::dcp::PACKET1::ENABLE_CIPHER">ENABLE_<wbr>CIPHER</a></div><div class="desc docblock-short">Reflects whether the selected cipher function must be enabled for this operation.</div></li><li><div class="item-name"><a class="mod" href="ENABLE_HASH/index.html" title="mod imxrt_ral::dcp::PACKET1::ENABLE_HASH">ENABLE_<wbr>HASH</a></div><div class="desc docblock-short">Reflects whether the selected hashing function must be enabled for this operation.</div></li><li><div class="item-name"><a class="mod" href="ENABLE_MEMCOPY/index.html" title="mod imxrt_ral::dcp::PACKET1::ENABLE_MEMCOPY">ENABLE_<wbr>MEMCOPY</a></div><div class="desc docblock-short">Reflects whether the selected hashing function should be enabled for this operation.</div></li><li><div class="item-name"><a class="mod" href="HASH_INIT/index.html" title="mod imxrt_ral::dcp::PACKET1::HASH_INIT">HASH_<wbr>INIT</a></div><div class="desc docblock-short">Reflects whether the current hashing block is the initial block in the hashing operation, so the hash registers must be initialized before the operation</div></li><li><div class="item-name"><a class="mod" href="HASH_OUTPUT/index.html" title="mod imxrt_ral::dcp::PACKET1::HASH_OUTPUT">HASH_<wbr>OUTPUT</a></div><div class="desc docblock-short">When the hashing is enabled, this bit controls whether the input or output data is hashed.</div></li><li><div class="item-name"><a class="mod" href="HASH_TERM/index.html" title="mod imxrt_ral::dcp::PACKET1::HASH_TERM">HASH_<wbr>TERM</a></div><div class="desc docblock-short">Reflects whether the current hashing block is the final block in the hashing operation, so the hash padding must be applied by the hardware</div></li><li><div class="item-name"><a class="mod" href="INPUT_BYTESWAP/index.html" title="mod imxrt_ral::dcp::PACKET1::INPUT_BYTESWAP">INPUT_<wbr>BYTESWAP</a></div><div class="desc docblock-short">Reflects whether the DCP engine byteswaps the input data (big-endian data).</div></li><li><div class="item-name"><a class="mod" href="INPUT_WORDSWAP/index.html" title="mod imxrt_ral::dcp::PACKET1::INPUT_WORDSWAP">INPUT_<wbr>WORDSWAP</a></div><div class="desc docblock-short">Reflects whether the DCP engine wordswaps the input data (big-endian data).</div></li><li><div class="item-name"><a class="mod" href="INTERRUPT/index.html" title="mod imxrt_ral::dcp::PACKET1::INTERRUPT">INTERRUPT</a></div><div class="desc docblock-short">Reflects whether the channel must issue an interrupt upon the completion of the packet.</div></li><li><div class="item-name"><a class="mod" href="KEY_BYTESWAP/index.html" title="mod imxrt_ral::dcp::PACKET1::KEY_BYTESWAP">KEY_<wbr>BYTESWAP</a></div><div class="desc docblock-short">Reflects whether the DCP engine swaps the key bytes (big-endian key).</div></li><li><div class="item-name"><a class="mod" href="KEY_WORDSWAP/index.html" title="mod imxrt_ral::dcp::PACKET1::KEY_WORDSWAP">KEY_<wbr>WORDSWAP</a></div><div class="desc docblock-short">Reflects whether the DCP engine swaps the key words (big-endian key).</div></li><li><div class="item-name"><a class="mod" href="OTP_KEY/index.html" title="mod imxrt_ral::dcp::PACKET1::OTP_KEY">OTP_KEY</a></div><div class="desc docblock-short">Reflects whether a hardware-based key must be used</div></li><li><div class="item-name"><a class="mod" href="OUTPUT_BYTESWAP/index.html" title="mod imxrt_ral::dcp::PACKET1::OUTPUT_BYTESWAP">OUTPUT_<wbr>BYTESWAP</a></div><div class="desc docblock-short">Reflects whether the DCP engine byteswaps the output data (big-endian data).</div></li><li><div class="item-name"><a class="mod" href="OUTPUT_WORDSWAP/index.html" title="mod imxrt_ral::dcp::PACKET1::OUTPUT_WORDSWAP">OUTPUT_<wbr>WORDSWAP</a></div><div class="desc docblock-short">Reflects whether the DCP engine wordswaps the output data (big-endian data).</div></li><li><div class="item-name"><a class="mod" href="PAYLOAD_KEY/index.html" title="mod imxrt_ral::dcp::PACKET1::PAYLOAD_KEY">PAYLOAD_<wbr>KEY</a></div><div class="desc docblock-short">When set, it indicates the payload contains the key</div></li><li><div class="item-name"><a class="mod" href="TAG/index.html" title="mod imxrt_ral::dcp::PACKET1::TAG">TAG</a></div><div class="desc docblock-short">Packet Tag</div></li><li><div class="item-name"><a class="mod" href="TEST_SEMA_IRQ/index.html" title="mod imxrt_ral::dcp::PACKET1::TEST_SEMA_IRQ">TEST_<wbr>SEMA_<wbr>IRQ</a></div><div class="desc docblock-short">This bit is used to test the channel semaphore transition to 0. FOR TEST USE ONLY!</div></li></ul></section></div></main></body></html>