867 lines
54 KiB
HTML
867 lines
54 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>MCUXpresso SDK API Reference Manual: DCP: Data Co-Processor</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="fs_logo.gif"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</div>
|
|
<div id="projectbrief">NXP Semiconductors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>API Reference</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('a00020.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#groups">Modules</a> |
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DCP: Data Co-Processor</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<p>The MCUXpresso SDK provides a peripheral driver for the Data Co-Processor (DCP) module. For security purposes, the Data Co-Processor (DCP) provides hardware acceleration for the cryptographic algorithms. The features of DCP are: Encryption Algorithms: AES-128 (ECB and CBC modes), Hashing Algorithms: SHA-1 and SHA-256, modified CRC-32, Key selection from the SNVS, DCP internal key storage, or general memory, Internal Memory for storing up to four AES-128 keys-when a key is written to a key slot it can be read only by the DCP AES-128 engine, IP slave interface, and DMA.</p>
|
|
<p>The driver comprises two sets of API functions.</p>
|
|
<p>In the first set, blocking APIs are provided, for selected subset of operations supported by DCP hardware. The DCP operations are complete (and results are made available for further usage) when a function returns. When called, these functions do not return until a DCP operation is complete. These functions use main CPU for simple polling loops to determine operation complete or error status.</p>
|
|
<p>The DCP work packets (descriptors) are placed on the system stack during the blocking API calls. The driver uses critical section (implemented as global interrupt enable/disable) for a short time whenever it needs to pass DCP work packets to DCP channel for processing. Therefore, the driver functions are designed to be re-entrant and as a consequence, one CPU thread can call one blocking API, such as AES Encrypt, while other CPU thread can call another blocking API, such as SHA-256 Update. The blocking functions provide typical interface to upper layer or application software.</p>
|
|
<p>In the second set, non-blocking variants of the first set APIs are provided. Internally, the blocking APIs are implemented as a non-blocking operation start, followed by a blocking wait (CPU polling DCP work packet's status word) for an operation completion. The non-blocking functions allow upper layer to inject an application specific operation after the DCP operation start and DCP channel complete events. RTOS event wait and RTOS event set can be an example of such an operation.</p>
|
|
<h1><a class="anchor" id="DCPInit"></a>
|
|
DCP Driver Initialization and Configuration</h1>
|
|
<p>Initialize DCP after Power On Reset or reset cycle Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/dcp</p>
|
|
<p>The DCP Driver is initialized by calling the <a class="el" href="a00020.html#ga933c854a72dc9dc4aa5c419acef247ba" title="Enables clock to and enables DCP. ">DCP_Init()</a> function. It enables the DCP module clock and configures DCP for operation.</p>
|
|
<h1>Key Management</h1>
|
|
<p>The DCP implements four different key storage mechanisms: OTP-key, OTP-Unique key, Payload key, and SRAM-based keys that can be used by the software to securely store keys on a semi-permanent basis (kDCP_KeySlot0 ~ kDCP_KeySlot3). Once the function <a class="el" href="a00273.html#ga15f23983b967199537cda25d70761d82" title="Set AES key to dcp_handle_t struct and optionally to DCP. ">DCP_AES_SetKey()</a> is called, it sets the AES key for encryption/decryption with the dcp_handle_t structure. In case the SRAM-based key is selected, the function copies and holds the key in memory. In case the OTP key is used, please make sure to set DCP related IOMUXC_GPRs before DCP initialization, since the software reset of DCP must be issued to take these setting in effect. Refer to the DCP_OTPKeySelect() function in BEE driver example.</p>
|
|
<h1><a class="anchor" id="DCPRtos"></a>
|
|
Comments about API usage in RTOS</h1>
|
|
<p>DCP transactional (encryption or hash) APIs can be called from multiple threads.</p>
|
|
<h1><a class="anchor" id="DCPisr"></a>
|
|
Comments about API usage in interrupt handler</h1>
|
|
<p>Assuming the host processor receiving interrupt has the ownership of the DCP module, it can request Encrypt/Decrypt/Hash/public_key operations in an interrupt routine. Additionally, as the DCP accesses system memory for it's operation with data (such as message, plaintext, ciphertext, or keys) all data should remain valid until the DCP operation completes.</p>
|
|
<h1><a class="anchor" id="DCPDcache"></a>
|
|
Comments about DCACHE</h1>
|
|
<p>Input and output buffers passed to DCP API should be in non-cached memory or handled properly (DCACHE Clean and Invalidate) while using DCACHE.</p>
|
|
<h1><a class="anchor" id="DCPEx"></a>
|
|
DCP Driver Examples</h1>
|
|
<h2><a class="anchor" id="DCPSimpleEx"></a>
|
|
Simple examples</h2>
|
|
<p>Encrypt plaintext by AES engine Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/DCP</p>
|
|
<p>Compute hash (CRC-32) The CRC-32 algorithm implements a 32-bit CRC algorithm similar to the one used by Ethernet and many other protocols. The CRC differs from the Unix cksum() function in these four ways: The CRC initial value is 0xFFFFFFFF instead of 0x00000000, final XOR value is 0x00000000 instead of 0xFFFFFFFF, the logic pads the zeros to a 32-bit boundary for the trailing bytes, and it does not post-pend the file length. Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/DCP</p>
|
|
<p>Compute hash (SHA-256) Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/DCP </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
|
|
Modules</h2></td></tr>
|
|
<tr class="memitem:a00273"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00273.html">DCP AES blocking driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00274"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html">DCP AES non-blocking driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00021"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00021.html">DCP HASH driver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:a00349"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a00349">_dcp_work_packet</a></td></tr>
|
|
<tr class="memdesc:a00349"><td class="mdescLeft"> </td><td class="mdescRight">DCP's work packet. <a href="a00020.html#a00349">More...</a><br/></td></tr>
|
|
<tr class="separator:a00349"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00347"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a00347">_dcp_handle</a></td></tr>
|
|
<tr class="memdesc:a00347"><td class="mdescLeft"> </td><td class="mdescRight">Specify DCP's key resource and DCP channel. <a href="a00020.html#a00347">More...</a><br/></td></tr>
|
|
<tr class="separator:a00347"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00346"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a00346">_dcp_context</a></td></tr>
|
|
<tr class="memdesc:a00346"><td class="mdescLeft"> </td><td class="mdescRight">DCP's context buffer, used by DCP for context switching between channels. <a href="a00020.html#a00346">More...</a><br/></td></tr>
|
|
<tr class="separator:a00346"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00345"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a00345">_dcp_config</a></td></tr>
|
|
<tr class="memdesc:a00345"><td class="mdescLeft"> </td><td class="mdescRight">DCP's configuration structure. <a href="a00020.html#a00345">More...</a><br/></td></tr>
|
|
<tr class="separator:a00345"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gafa91958c5d4d81bb4a6f2040a09ecaf9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafa91958c5d4d81bb4a6f2040a09ecaf9"></a>
|
|
typedef enum <a class="el" href="a00020.html#gaa16269a2a95571fc1bf3cd0f106ae649">_dcp_ch_enable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#gafa91958c5d4d81bb4a6f2040a09ecaf9">_dcp_ch_enable_t</a></td></tr>
|
|
<tr class="memdesc:gafa91958c5d4d81bb4a6f2040a09ecaf9"><td class="mdescLeft"> </td><td class="mdescRight">DCP channel enable. <br/></td></tr>
|
|
<tr class="separator:gafa91958c5d4d81bb4a6f2040a09ecaf9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4cfd64b4bebaa57ad4d673c257eb9d3e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4cfd64b4bebaa57ad4d673c257eb9d3e"></a>
|
|
typedef enum <a class="el" href="a00020.html#ga75ca9f48dee0a66ee29f62a635ae4e26">_dcp_ch_int_enable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga4cfd64b4bebaa57ad4d673c257eb9d3e">_dcp_ch_int_enable_t</a></td></tr>
|
|
<tr class="memdesc:ga4cfd64b4bebaa57ad4d673c257eb9d3e"><td class="mdescLeft"> </td><td class="mdescRight">DCP interrupt enable. <br/></td></tr>
|
|
<tr class="separator:ga4cfd64b4bebaa57ad4d673c257eb9d3e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga359af9dc75653f94e58c5d64c8ccd260"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga359af9dc75653f94e58c5d64c8ccd260"></a>
|
|
typedef enum <a class="el" href="a00020.html#ga0f31e1012dce441897948a9d17f91946">_dcp_channel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga359af9dc75653f94e58c5d64c8ccd260">dcp_channel_t</a></td></tr>
|
|
<tr class="memdesc:ga359af9dc75653f94e58c5d64c8ccd260"><td class="mdescLeft"> </td><td class="mdescRight">DCP channel selection. <br/></td></tr>
|
|
<tr class="separator:ga359af9dc75653f94e58c5d64c8ccd260"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga45eef85505932602601378c7ecedffe8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga45eef85505932602601378c7ecedffe8"></a>
|
|
typedef enum <a class="el" href="a00020.html#gaba3d6468c7724f242d8f33da1356f3f1">_dcp_key_slot</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga45eef85505932602601378c7ecedffe8">dcp_key_slot_t</a></td></tr>
|
|
<tr class="memdesc:ga45eef85505932602601378c7ecedffe8"><td class="mdescLeft"> </td><td class="mdescRight">DCP key slot selection. <br/></td></tr>
|
|
<tr class="separator:ga45eef85505932602601378c7ecedffe8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8a780fe30cb964df53105f6dad69dbc7"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00020.html#gadf6bc69cb326e60f1aefbf5b796d8482">_dcp_swap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga8a780fe30cb964df53105f6dad69dbc7">dcp_swap_t</a></td></tr>
|
|
<tr class="memdesc:ga8a780fe30cb964df53105f6dad69dbc7"><td class="mdescLeft"> </td><td class="mdescRight">DCP key, input & output swap options. <a href="#ga8a780fe30cb964df53105f6dad69dbc7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8a780fe30cb964df53105f6dad69dbc7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae21a78fdbeddfb819e22fa7b7835b937"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00020.html#a00349">_dcp_work_packet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a></td></tr>
|
|
<tr class="memdesc:gae21a78fdbeddfb819e22fa7b7835b937"><td class="mdescLeft"> </td><td class="mdescRight">DCP's work packet. <a href="#gae21a78fdbeddfb819e22fa7b7835b937">More...</a><br/></td></tr>
|
|
<tr class="separator:gae21a78fdbeddfb819e22fa7b7835b937"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3a72807e47a0e99f3827c8ca5b299484"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00020.html#a00347">_dcp_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga3a72807e47a0e99f3827c8ca5b299484">dcp_handle_t</a></td></tr>
|
|
<tr class="memdesc:ga3a72807e47a0e99f3827c8ca5b299484"><td class="mdescLeft"> </td><td class="mdescRight">Specify DCP's key resource and DCP channel. <a href="#ga3a72807e47a0e99f3827c8ca5b299484">More...</a><br/></td></tr>
|
|
<tr class="separator:ga3a72807e47a0e99f3827c8ca5b299484"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf93ca5767ab79f67e7ea831a1a448ec4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00020.html#a00346">_dcp_context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#gaf93ca5767ab79f67e7ea831a1a448ec4">dcp_context_t</a></td></tr>
|
|
<tr class="memdesc:gaf93ca5767ab79f67e7ea831a1a448ec4"><td class="mdescLeft"> </td><td class="mdescRight">DCP's context buffer, used by DCP for context switching between channels. <a href="#gaf93ca5767ab79f67e7ea831a1a448ec4">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf93ca5767ab79f67e7ea831a1a448ec4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf013f89d49a9c89f50bdbab2ac311659"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00020.html#a00345">_dcp_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#gaf013f89d49a9c89f50bdbab2ac311659">dcp_config_t</a></td></tr>
|
|
<tr class="memdesc:gaf013f89d49a9c89f50bdbab2ac311659"><td class="mdescLeft"> </td><td class="mdescRight">DCP's configuration structure. <a href="#gaf013f89d49a9c89f50bdbab2ac311659">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf013f89d49a9c89f50bdbab2ac311659"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga59389883fbb9191933ba51f3111cf01d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga59389883fbb9191933ba51f3111cf01d">_dcp_status</a> { <a class="el" href="a00020.html#gga59389883fbb9191933ba51f3111cf01da7c68d4a61e9323994193a7cb9a643746">kStatus_DCP_Again</a> = MAKE_STATUS(kStatusGroup_DCP, 0)
|
|
}</td></tr>
|
|
<tr class="memdesc:ga59389883fbb9191933ba51f3111cf01d"><td class="mdescLeft"> </td><td class="mdescRight">DCP status return codes. <a href="a00020.html#ga59389883fbb9191933ba51f3111cf01d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga59389883fbb9191933ba51f3111cf01d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa16269a2a95571fc1bf3cd0f106ae649"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#gaa16269a2a95571fc1bf3cd0f106ae649">_dcp_ch_enable</a> { <br/>
|
|
  <a class="el" href="a00020.html#ggaa16269a2a95571fc1bf3cd0f106ae649a0c83a7a742d76ca14c153fbc183d10ff">kDCP_chDisable</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaa16269a2a95571fc1bf3cd0f106ae649a1b1fc9b6c50a2d9629c98e90508bf272">kDCP_ch0Enable</a> = 1U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaa16269a2a95571fc1bf3cd0f106ae649aedbf328bba0357a17ab7f837b153d970">kDCP_ch1Enable</a> = 2U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaa16269a2a95571fc1bf3cd0f106ae649a640eb8bb142953fa34b0f134e30a231b">kDCP_ch2Enable</a> = 4U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaa16269a2a95571fc1bf3cd0f106ae649a2d4a490eb2303702d6657652c70f7292">kDCP_ch3Enable</a> = 8U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaa16269a2a95571fc1bf3cd0f106ae649a7004e39596effb975998db1d80532621">kDCP_chEnableAll</a> = 15U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gaa16269a2a95571fc1bf3cd0f106ae649"><td class="mdescLeft"> </td><td class="mdescRight">DCP channel enable. <a href="a00020.html#gaa16269a2a95571fc1bf3cd0f106ae649">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa16269a2a95571fc1bf3cd0f106ae649"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga75ca9f48dee0a66ee29f62a635ae4e26"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga75ca9f48dee0a66ee29f62a635ae4e26">_dcp_ch_int_enable</a> { <br/>
|
|
  <a class="el" href="a00020.html#gga75ca9f48dee0a66ee29f62a635ae4e26aead556c5f6954b959bcdd1e4d1d6bb10">kDCP_chIntDisable</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#gga75ca9f48dee0a66ee29f62a635ae4e26a81462f919e60b86ad4c3f162ba1695c7">kDCP_ch0IntEnable</a> = 1U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#gga75ca9f48dee0a66ee29f62a635ae4e26a3811ee00515751c0796430b3df2c0d6a">kDCP_ch1IntEnable</a> = 2U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#gga75ca9f48dee0a66ee29f62a635ae4e26a58ffdbf876d392e731235ca2eba407fb">kDCP_ch2IntEnable</a> = 4U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#gga75ca9f48dee0a66ee29f62a635ae4e26ac07c9d98ef9766353f794f4497a82452">kDCP_ch3IntEnable</a> = 8U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga75ca9f48dee0a66ee29f62a635ae4e26"><td class="mdescLeft"> </td><td class="mdescRight">DCP interrupt enable. <a href="a00020.html#ga75ca9f48dee0a66ee29f62a635ae4e26">More...</a><br/></td></tr>
|
|
<tr class="separator:ga75ca9f48dee0a66ee29f62a635ae4e26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0f31e1012dce441897948a9d17f91946"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga0f31e1012dce441897948a9d17f91946">_dcp_channel</a> { <br/>
|
|
  <a class="el" href="a00020.html#gga0f31e1012dce441897948a9d17f91946a9b7796c07ffcd4ae098abb20a20586c3">kDCP_Channel0</a> = (1u << 16),
|
|
<br/>
|
|
  <a class="el" href="a00020.html#gga0f31e1012dce441897948a9d17f91946ac3140cbeefb23e61213db30c926e9763">kDCP_Channel1</a> = (1u << 17),
|
|
<br/>
|
|
  <a class="el" href="a00020.html#gga0f31e1012dce441897948a9d17f91946a94768171706b0228cdc0246406e2ab95">kDCP_Channel2</a> = (1u << 18),
|
|
<br/>
|
|
  <a class="el" href="a00020.html#gga0f31e1012dce441897948a9d17f91946aab2d665d78d62fae879bde90b9203618">kDCP_Channel3</a> = (1u << 19)
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga0f31e1012dce441897948a9d17f91946"><td class="mdescLeft"> </td><td class="mdescRight">DCP channel selection. <a href="a00020.html#ga0f31e1012dce441897948a9d17f91946">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0f31e1012dce441897948a9d17f91946"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaba3d6468c7724f242d8f33da1356f3f1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#gaba3d6468c7724f242d8f33da1356f3f1">_dcp_key_slot</a> { <br/>
|
|
  <a class="el" href="a00020.html#ggaba3d6468c7724f242d8f33da1356f3f1a349ec618ee7086ea6e1bbccf855cccbe">kDCP_KeySlot0</a> = 0U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaba3d6468c7724f242d8f33da1356f3f1a48a43f854473e046eab93d3c074237cc">kDCP_KeySlot1</a> = 1U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaba3d6468c7724f242d8f33da1356f3f1af4919af09de44d8547abae866160f440">kDCP_KeySlot2</a> = 2U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaba3d6468c7724f242d8f33da1356f3f1aaeb39b1683029ec0990ff89456ab222f">kDCP_KeySlot3</a> = 3U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaba3d6468c7724f242d8f33da1356f3f1a6e18f3e76ac307e36d44ec9655cc5c5d">kDCP_OtpKey</a> = 4U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaba3d6468c7724f242d8f33da1356f3f1a10e0d8054b2fd3f886694a5fd8651f51">kDCP_OtpUniqueKey</a> = 5U,
|
|
<br/>
|
|
  <a class="el" href="a00020.html#ggaba3d6468c7724f242d8f33da1356f3f1a21976048a18fef6b68767b24dafa0f0b">kDCP_PayloadKey</a> = 6U
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gaba3d6468c7724f242d8f33da1356f3f1"><td class="mdescLeft"> </td><td class="mdescRight">DCP key slot selection. <a href="a00020.html#gaba3d6468c7724f242d8f33da1356f3f1">More...</a><br/></td></tr>
|
|
<tr class="separator:gaba3d6468c7724f242d8f33da1356f3f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadf6bc69cb326e60f1aefbf5b796d8482"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#gadf6bc69cb326e60f1aefbf5b796d8482">_dcp_swap</a> </td></tr>
|
|
<tr class="memdesc:gadf6bc69cb326e60f1aefbf5b796d8482"><td class="mdescLeft"> </td><td class="mdescRight">DCP key, input & output swap options. <a href="a00020.html#gadf6bc69cb326e60f1aefbf5b796d8482">More...</a><br/></td></tr>
|
|
<tr class="separator:gadf6bc69cb326e60f1aefbf5b796d8482"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga933c854a72dc9dc4aa5c419acef247ba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga933c854a72dc9dc4aa5c419acef247ba">DCP_Init</a> (DCP_Type *base, const <a class="el" href="a00020.html#gaf013f89d49a9c89f50bdbab2ac311659">dcp_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga933c854a72dc9dc4aa5c419acef247ba"><td class="mdescLeft"> </td><td class="mdescRight">Enables clock to and enables DCP. <a href="#ga933c854a72dc9dc4aa5c419acef247ba">More...</a><br/></td></tr>
|
|
<tr class="separator:ga933c854a72dc9dc4aa5c419acef247ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0b9618e77ddda7528fa176a262614b1d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga0b9618e77ddda7528fa176a262614b1d">DCP_Deinit</a> (DCP_Type *base)</td></tr>
|
|
<tr class="memdesc:ga0b9618e77ddda7528fa176a262614b1d"><td class="mdescLeft"> </td><td class="mdescRight">Disable DCP clock. <a href="#ga0b9618e77ddda7528fa176a262614b1d">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0b9618e77ddda7528fa176a262614b1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga29b04db9db907101539c12a3130525f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga29b04db9db907101539c12a3130525f8">DCP_GetDefaultConfig</a> (<a class="el" href="a00020.html#gaf013f89d49a9c89f50bdbab2ac311659">dcp_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga29b04db9db907101539c12a3130525f8"><td class="mdescLeft"> </td><td class="mdescRight">Gets the default configuration structure. <a href="#ga29b04db9db907101539c12a3130525f8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga29b04db9db907101539c12a3130525f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga132509d992e50d593f417de365408485"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga132509d992e50d593f417de365408485">DCP_WaitForChannelComplete</a> (DCP_Type *base, <a class="el" href="a00020.html#ga3a72807e47a0e99f3827c8ca5b299484">dcp_handle_t</a> *handle)</td></tr>
|
|
<tr class="memdesc:ga132509d992e50d593f417de365408485"><td class="mdescLeft"> </td><td class="mdescRight">Poll and wait on DCP channel. <a href="#ga132509d992e50d593f417de365408485">More...</a><br/></td></tr>
|
|
<tr class="separator:ga132509d992e50d593f417de365408485"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
|
|
Driver version</h2></td></tr>
|
|
<tr class="memitem:ga5e6e0628adf52111c3174a5f97b4aa99"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#ga5e6e0628adf52111c3174a5f97b4aa99">FSL_DCP_DRIVER_VERSION</a>   (<a class="el" href="a00272.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 7))</td></tr>
|
|
<tr class="memdesc:ga5e6e0628adf52111c3174a5f97b4aa99"><td class="mdescLeft"> </td><td class="mdescRight">DCP driver version. <a href="#ga5e6e0628adf52111c3174a5f97b4aa99">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5e6e0628adf52111c3174a5f97b4aa99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00349" id="a00349"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _dcp_work_packet</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div>
|
|
</div>
|
|
</div>
|
|
<a name="a00347" id="a00347"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _dcp_handle</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a84641a339e6de7d735f70f3c45bd0865"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00020.html#ga359af9dc75653f94e58c5d64c8ccd260">dcp_channel_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a84641a339e6de7d735f70f3c45bd0865">channel</a></td></tr>
|
|
<tr class="memdesc:a84641a339e6de7d735f70f3c45bd0865"><td class="mdescLeft"> </td><td class="mdescRight">Specify DCP channel. <a href="#a84641a339e6de7d735f70f3c45bd0865">More...</a><br/></td></tr>
|
|
<tr class="separator:a84641a339e6de7d735f70f3c45bd0865"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a44534809a63e3a4c786941b7e48798"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00020.html#ga45eef85505932602601378c7ecedffe8">dcp_key_slot_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a4a44534809a63e3a4c786941b7e48798">keySlot</a></td></tr>
|
|
<tr class="memdesc:a4a44534809a63e3a4c786941b7e48798"><td class="mdescLeft"> </td><td class="mdescRight">For operations with key (such as AES encryption/decryption), specify DCP key slot. <a href="#a4a44534809a63e3a4c786941b7e48798">More...</a><br/></td></tr>
|
|
<tr class="separator:a4a44534809a63e3a4c786941b7e48798"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa428e9eb1e312254337e4b1e1e8fbdbe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa428e9eb1e312254337e4b1e1e8fbdbe"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#aa428e9eb1e312254337e4b1e1e8fbdbe">swapConfig</a></td></tr>
|
|
<tr class="memdesc:aa428e9eb1e312254337e4b1e1e8fbdbe"><td class="mdescLeft"> </td><td class="mdescRight">For configuration of key, input, output byte/word swap options. <br/></td></tr>
|
|
<tr class="separator:aa428e9eb1e312254337e4b1e1e8fbdbe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a84641a339e6de7d735f70f3c45bd0865"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00020.html#ga359af9dc75653f94e58c5d64c8ccd260">dcp_channel_t</a> _dcp_handle::channel</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4a44534809a63e3a4c786941b7e48798"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00020.html#ga45eef85505932602601378c7ecedffe8">dcp_key_slot_t</a> _dcp_handle::keySlot</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="a00346" id="a00346"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _dcp_context</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div>
|
|
</div>
|
|
</div>
|
|
<a name="a00345" id="a00345"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _dcp_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a8a93033d15f84c61b7b1650f2eb0191a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a8a93033d15f84c61b7b1650f2eb0191a">gatherResidualWrites</a></td></tr>
|
|
<tr class="memdesc:a8a93033d15f84c61b7b1650f2eb0191a"><td class="mdescLeft"> </td><td class="mdescRight">Enable the ragged writes to the unaligned buffers. <a href="#a8a93033d15f84c61b7b1650f2eb0191a">More...</a><br/></td></tr>
|
|
<tr class="separator:a8a93033d15f84c61b7b1650f2eb0191a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb13486377bb62b315a7c5e726d5f814"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#aeb13486377bb62b315a7c5e726d5f814">enableContextCaching</a></td></tr>
|
|
<tr class="memdesc:aeb13486377bb62b315a7c5e726d5f814"><td class="mdescLeft"> </td><td class="mdescRight">Enable the caching of contexts between the operations. <a href="#aeb13486377bb62b315a7c5e726d5f814">More...</a><br/></td></tr>
|
|
<tr class="separator:aeb13486377bb62b315a7c5e726d5f814"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a296198fdc5c17dd771db8988f5d118a0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a296198fdc5c17dd771db8988f5d118a0">enableContextSwitching</a></td></tr>
|
|
<tr class="memdesc:a296198fdc5c17dd771db8988f5d118a0"><td class="mdescLeft"> </td><td class="mdescRight">Enable automatic context switching for the channels. <a href="#a296198fdc5c17dd771db8988f5d118a0">More...</a><br/></td></tr>
|
|
<tr class="separator:a296198fdc5c17dd771db8988f5d118a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30055f8704b0a4176be015d36d775814"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a30055f8704b0a4176be015d36d775814">enableChannel</a></td></tr>
|
|
<tr class="memdesc:a30055f8704b0a4176be015d36d775814"><td class="mdescLeft"> </td><td class="mdescRight">DCP channel enable. <a href="#a30055f8704b0a4176be015d36d775814">More...</a><br/></td></tr>
|
|
<tr class="separator:a30055f8704b0a4176be015d36d775814"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb6485946896d813f0081b9900f4a85e"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#aeb6485946896d813f0081b9900f4a85e">enableChannelInterrupt</a></td></tr>
|
|
<tr class="memdesc:aeb6485946896d813f0081b9900f4a85e"><td class="mdescLeft"> </td><td class="mdescRight">Per-channel interrupt enable. <a href="#aeb6485946896d813f0081b9900f4a85e">More...</a><br/></td></tr>
|
|
<tr class="separator:aeb6485946896d813f0081b9900f4a85e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a8a93033d15f84c61b7b1650f2eb0191a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool _dcp_config::gatherResidualWrites</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aeb13486377bb62b315a7c5e726d5f814"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool _dcp_config::enableContextCaching</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a296198fdc5c17dd771db8988f5d118a0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool _dcp_config::enableContextSwitching</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a30055f8704b0a4176be015d36d775814"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _dcp_config::enableChannel</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aeb6485946896d813f0081b9900f4a85e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _dcp_config::enableChannelInterrupt</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga5e6e0628adf52111c3174a5f97b4aa99"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_DCP_DRIVER_VERSION   (<a class="el" href="a00272.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 7))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Version 2.1.7.</p>
|
|
<p>Current version: 2.1.7</p>
|
|
<p>Change log:</p>
|
|
<ul>
|
|
<li>Version 2.1.7<ul>
|
|
<li>Bug Fix<ul>
|
|
<li>Reduce optimization level for critical functions working with SRF.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.6<ul>
|
|
<li>Bug Fix<ul>
|
|
<li>MISRA C-2012 issue fix.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.5<ul>
|
|
<li>Improvements<ul>
|
|
<li>Add support for DCACHE.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.4<ul>
|
|
<li>Bug Fix<ul>
|
|
<li>Fix CRC-32 computation issue on the code's block boundary size.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.3<ul>
|
|
<li>Bug Fix<ul>
|
|
<li>MISRA C-2012 issue fixed: rule 10.1, 10.3, 10.4, 11.9, 14.4, 16.4 and 17.7.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.2<ul>
|
|
<li>Fix sign-compare warning in dcp_reverse_and_copy.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.1<ul>
|
|
<li>Add DCP status clearing when channel operation is complete</li>
|
|
</ul>
|
|
</li>
|
|
<li>2.1.0<ul>
|
|
<li>Add byte/word swap feature for key, input and output data</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.0.0<ul>
|
|
<li>Initial version </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga8a780fe30cb964df53105f6dad69dbc7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00020.html#gadf6bc69cb326e60f1aefbf5b796d8482">_dcp_swap</a> <a class="el" href="a00020.html#ga8a780fe30cb964df53105f6dad69dbc7">dcp_swap_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae21a78fdbeddfb819e22fa7b7835b937"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00020.html#a00349">_dcp_work_packet</a> <a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga3a72807e47a0e99f3827c8ca5b299484"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00020.html#a00347">_dcp_handle</a> <a class="el" href="a00020.html#ga3a72807e47a0e99f3827c8ca5b299484">dcp_handle_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf93ca5767ab79f67e7ea831a1a448ec4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00020.html#a00346">_dcp_context</a> <a class="el" href="a00020.html#gaf93ca5767ab79f67e7ea831a1a448ec4">dcp_context_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf013f89d49a9c89f50bdbab2ac311659"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00020.html#a00345">_dcp_config</a> <a class="el" href="a00020.html#gaf013f89d49a9c89f50bdbab2ac311659">dcp_config_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga59389883fbb9191933ba51f3111cf01d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00020.html#ga59389883fbb9191933ba51f3111cf01d">_dcp_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga59389883fbb9191933ba51f3111cf01da7c68d4a61e9323994193a7cb9a643746"></a>kStatus_DCP_Again</em> </td><td class="fielddoc">
|
|
<p>Non-blocking function shall be called again. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa16269a2a95571fc1bf3cd0f106ae649"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00020.html#gaa16269a2a95571fc1bf3cd0f106ae649">_dcp_ch_enable</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggaa16269a2a95571fc1bf3cd0f106ae649a0c83a7a742d76ca14c153fbc183d10ff"></a>kDCP_chDisable</em> </td><td class="fielddoc">
|
|
<p>DCP channel disable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaa16269a2a95571fc1bf3cd0f106ae649a1b1fc9b6c50a2d9629c98e90508bf272"></a>kDCP_ch0Enable</em> </td><td class="fielddoc">
|
|
<p>DCP channel 0 enable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaa16269a2a95571fc1bf3cd0f106ae649aedbf328bba0357a17ab7f837b153d970"></a>kDCP_ch1Enable</em> </td><td class="fielddoc">
|
|
<p>DCP channel 1 enable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaa16269a2a95571fc1bf3cd0f106ae649a640eb8bb142953fa34b0f134e30a231b"></a>kDCP_ch2Enable</em> </td><td class="fielddoc">
|
|
<p>DCP channel 2 enable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaa16269a2a95571fc1bf3cd0f106ae649a2d4a490eb2303702d6657652c70f7292"></a>kDCP_ch3Enable</em> </td><td class="fielddoc">
|
|
<p>DCP channel 3 enable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaa16269a2a95571fc1bf3cd0f106ae649a7004e39596effb975998db1d80532621"></a>kDCP_chEnableAll</em> </td><td class="fielddoc">
|
|
<p>DCP channel enable all. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga75ca9f48dee0a66ee29f62a635ae4e26"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00020.html#ga75ca9f48dee0a66ee29f62a635ae4e26">_dcp_ch_int_enable</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga75ca9f48dee0a66ee29f62a635ae4e26aead556c5f6954b959bcdd1e4d1d6bb10"></a>kDCP_chIntDisable</em> </td><td class="fielddoc">
|
|
<p>DCP interrupts disable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga75ca9f48dee0a66ee29f62a635ae4e26a81462f919e60b86ad4c3f162ba1695c7"></a>kDCP_ch0IntEnable</em> </td><td class="fielddoc">
|
|
<p>DCP channel 0 interrupt enable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga75ca9f48dee0a66ee29f62a635ae4e26a3811ee00515751c0796430b3df2c0d6a"></a>kDCP_ch1IntEnable</em> </td><td class="fielddoc">
|
|
<p>DCP channel 1 interrupt enable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga75ca9f48dee0a66ee29f62a635ae4e26a58ffdbf876d392e731235ca2eba407fb"></a>kDCP_ch2IntEnable</em> </td><td class="fielddoc">
|
|
<p>DCP channel 2 interrupt enable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga75ca9f48dee0a66ee29f62a635ae4e26ac07c9d98ef9766353f794f4497a82452"></a>kDCP_ch3IntEnable</em> </td><td class="fielddoc">
|
|
<p>DCP channel 3 interrupt enable. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0f31e1012dce441897948a9d17f91946"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00020.html#ga0f31e1012dce441897948a9d17f91946">_dcp_channel</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga0f31e1012dce441897948a9d17f91946a9b7796c07ffcd4ae098abb20a20586c3"></a>kDCP_Channel0</em> </td><td class="fielddoc">
|
|
<p>DCP channel 0. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0f31e1012dce441897948a9d17f91946ac3140cbeefb23e61213db30c926e9763"></a>kDCP_Channel1</em> </td><td class="fielddoc">
|
|
<p>DCP channel 1. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0f31e1012dce441897948a9d17f91946a94768171706b0228cdc0246406e2ab95"></a>kDCP_Channel2</em> </td><td class="fielddoc">
|
|
<p>DCP channel 2. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0f31e1012dce441897948a9d17f91946aab2d665d78d62fae879bde90b9203618"></a>kDCP_Channel3</em> </td><td class="fielddoc">
|
|
<p>DCP channel 3. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaba3d6468c7724f242d8f33da1356f3f1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00020.html#gaba3d6468c7724f242d8f33da1356f3f1">_dcp_key_slot</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggaba3d6468c7724f242d8f33da1356f3f1a349ec618ee7086ea6e1bbccf855cccbe"></a>kDCP_KeySlot0</em> </td><td class="fielddoc">
|
|
<p>DCP key slot 0. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaba3d6468c7724f242d8f33da1356f3f1a48a43f854473e046eab93d3c074237cc"></a>kDCP_KeySlot1</em> </td><td class="fielddoc">
|
|
<p>DCP key slot 1. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaba3d6468c7724f242d8f33da1356f3f1af4919af09de44d8547abae866160f440"></a>kDCP_KeySlot2</em> </td><td class="fielddoc">
|
|
<p>DCP key slot 2. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaba3d6468c7724f242d8f33da1356f3f1aaeb39b1683029ec0990ff89456ab222f"></a>kDCP_KeySlot3</em> </td><td class="fielddoc">
|
|
<p>DCP key slot 3. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaba3d6468c7724f242d8f33da1356f3f1a6e18f3e76ac307e36d44ec9655cc5c5d"></a>kDCP_OtpKey</em> </td><td class="fielddoc">
|
|
<p>DCP OTP key. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaba3d6468c7724f242d8f33da1356f3f1a10e0d8054b2fd3f886694a5fd8651f51"></a>kDCP_OtpUniqueKey</em> </td><td class="fielddoc">
|
|
<p>DCP unique OTP key. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggaba3d6468c7724f242d8f33da1356f3f1a21976048a18fef6b68767b24dafa0f0b"></a>kDCP_PayloadKey</em> </td><td class="fielddoc">
|
|
<p>DCP payload key. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gadf6bc69cb326e60f1aefbf5b796d8482"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00020.html#gadf6bc69cb326e60f1aefbf5b796d8482">_dcp_swap</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga933c854a72dc9dc4aa5c419acef247ba"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DCP_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">DCP_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="a00020.html#gaf013f89d49a9c89f50bdbab2ac311659">dcp_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Enable DCP clock and configure DCP.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>DCP base address </td></tr>
|
|
<tr><td class="paramname">config</td><td>Pointer to configuration structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0b9618e77ddda7528fa176a262614b1d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DCP_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">DCP_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Reset DCP and Disable DCP clock.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>DCP base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga29b04db9db907101539c12a3130525f8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DCP_GetDefaultConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="a00020.html#gaf013f89d49a9c89f50bdbab2ac311659">dcp_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initializes the DCP configuration structure to a default value. The default values are as follows. dcpConfig->gatherResidualWrites = true; dcpConfig->enableContextCaching = true; dcpConfig->enableContextSwitching = true; dcpConfig->enableChannnel = kDCP_chEnableAll; dcpConfig->enableChannelInterrupt = kDCP_chIntDisable;</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">config</td><td>Pointer to configuration structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga132509d992e50d593f417de365408485"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> DCP_WaitForChannelComplete </td>
|
|
<td>(</td>
|
|
<td class="paramtype">DCP_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00020.html#ga3a72807e47a0e99f3827c8ca5b299484">dcp_handle_t</a> * </td>
|
|
<td class="paramname"><em>handle</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Polls the specified DCP channel until current it completes activity.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>DCP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">handle</td><td>Specifies DCP channel. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>kStatus_Success When data processing completes without error. </dd>
|
|
<dd>
|
|
kStatus_Fail When error occurs. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.5-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul class="foot">
|
|
<li class="footer">© 2016 NXP Semiconductors. All rights reserved.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|