MCUXpresso_MIMXRT1052xxxxB/docs/MCUXpresso SDK API Referenc.../a00274.html

412 lines
21 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 AES non-blocking driver</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
&#160;<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>API&#160;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('a00274.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">DCP AES non-blocking driver<div class="ingroups"><a class="el" href="a00020.html">DCP: Data Co-Processor</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<p>This section describes the programming interface of the DCP AES non-blocking driver. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad1817bda1adfdc5d44ec8680d19bae72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#gad1817bda1adfdc5d44ec8680d19bae72">DCP_AES_EncryptEcbNonBlocking</a> (DCP_Type *base, <a class="el" href="a00020.html#ga3a72807e47a0e99f3827c8ca5b299484">dcp_handle_t</a> *handle, <a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a> *dcpPacket, const uint8_t *plaintext, uint8_t *ciphertext, size_t size)</td></tr>
<tr class="memdesc:gad1817bda1adfdc5d44ec8680d19bae72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encrypts AES using the ECB block mode. <a href="#gad1817bda1adfdc5d44ec8680d19bae72">More...</a><br/></td></tr>
<tr class="separator:gad1817bda1adfdc5d44ec8680d19bae72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga539f81acf96426e66daab1e4aebdc89a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#ga539f81acf96426e66daab1e4aebdc89a">DCP_AES_DecryptEcbNonBlocking</a> (DCP_Type *base, <a class="el" href="a00020.html#ga3a72807e47a0e99f3827c8ca5b299484">dcp_handle_t</a> *handle, <a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a> *dcpPacket, const uint8_t *ciphertext, uint8_t *plaintext, size_t size)</td></tr>
<tr class="memdesc:ga539f81acf96426e66daab1e4aebdc89a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrypts AES using ECB block mode. <a href="#ga539f81acf96426e66daab1e4aebdc89a">More...</a><br/></td></tr>
<tr class="separator:ga539f81acf96426e66daab1e4aebdc89a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c336091f696e34e93df272e5fef9f1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#ga4c336091f696e34e93df272e5fef9f1e">DCP_AES_EncryptCbcNonBlocking</a> (DCP_Type *base, <a class="el" href="a00020.html#ga3a72807e47a0e99f3827c8ca5b299484">dcp_handle_t</a> *handle, <a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a> *dcpPacket, const uint8_t *plaintext, uint8_t *ciphertext, size_t size, const uint8_t *iv)</td></tr>
<tr class="memdesc:ga4c336091f696e34e93df272e5fef9f1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encrypts AES using CBC block mode. <a href="#ga4c336091f696e34e93df272e5fef9f1e">More...</a><br/></td></tr>
<tr class="separator:ga4c336091f696e34e93df272e5fef9f1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26d7c8050e5a5a5fb3abcc8ced712187"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00274.html#ga26d7c8050e5a5a5fb3abcc8ced712187">DCP_AES_DecryptCbcNonBlocking</a> (DCP_Type *base, <a class="el" href="a00020.html#ga3a72807e47a0e99f3827c8ca5b299484">dcp_handle_t</a> *handle, <a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a> *dcpPacket, const uint8_t *ciphertext, uint8_t *plaintext, size_t size, const uint8_t *iv)</td></tr>
<tr class="memdesc:ga26d7c8050e5a5a5fb3abcc8ced712187"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrypts AES using CBC block mode. <a href="#ga26d7c8050e5a5a5fb3abcc8ced712187">More...</a><br/></td></tr>
<tr class="separator:ga26d7c8050e5a5a5fb3abcc8ced712187"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad1817bda1adfdc5d44ec8680d19bae72"></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_AES_EncryptEcbNonBlocking </td>
<td>(</td>
<td class="paramtype">DCP_Type *&#160;</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> *&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a> *&#160;</td>
<td class="paramname"><em>dcpPacket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>plaintext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Puts AES ECB encrypt work packet to DCP channel.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">base</td><td>DCP peripheral base address </td></tr>
<tr><td class="paramdir"></td><td class="paramname">handle</td><td>Handle used for this request. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dcpPacket</td><td>Memory for the DCP work packet. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">plaintext</td><td>Input plain text to encrypt. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ciphertext</td><td>Output cipher text </td></tr>
<tr><td class="paramdir"></td><td class="paramname">size</td><td>Size of input and output data in bytes. Must be multiple of 16 bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>kStatus_Success The work packet has been scheduled at DCP channel. </dd>
<dd>
kStatus_DCP_Again The DCP channel is busy processing previous request. </dd></dl>
</div>
</div>
<a class="anchor" id="ga539f81acf96426e66daab1e4aebdc89a"></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_AES_DecryptEcbNonBlocking </td>
<td>(</td>
<td class="paramtype">DCP_Type *&#160;</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> *&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a> *&#160;</td>
<td class="paramname"><em>dcpPacket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>plaintext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Puts AES ECB decrypt dcpPacket to DCP input job ring.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">base</td><td>DCP peripheral base address </td></tr>
<tr><td class="paramdir"></td><td class="paramname">handle</td><td>Handle used for this request. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dcpPacket</td><td>Memory for the DCP work packet. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">ciphertext</td><td>Input cipher text to decrypt </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">plaintext</td><td>Output plain text </td></tr>
<tr><td class="paramdir"></td><td class="paramname">size</td><td>Size of input and output data in bytes. Must be multiple of 16 bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>kStatus_Success The work packet has been scheduled at DCP channel. </dd>
<dd>
kStatus_DCP_Again The DCP channel is busy processing previous request. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4c336091f696e34e93df272e5fef9f1e"></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_AES_EncryptCbcNonBlocking </td>
<td>(</td>
<td class="paramtype">DCP_Type *&#160;</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> *&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a> *&#160;</td>
<td class="paramname"><em>dcpPacket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>plaintext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>iv</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Puts AES CBC encrypt dcpPacket to DCP input job ring.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">base</td><td>DCP peripheral base address </td></tr>
<tr><td class="paramdir"></td><td class="paramname">handle</td><td>Handle used for this request. Specifies jobRing. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dcpPacket</td><td>Memory for the DCP work packet. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">plaintext</td><td>Input plain text to encrypt </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ciphertext</td><td>Output cipher text </td></tr>
<tr><td class="paramdir"></td><td class="paramname">size</td><td>Size of input and output data in bytes. Must be multiple of 16 bytes. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">iv</td><td>Input initial vector to combine with the first input block. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>kStatus_Success The work packet has been scheduled at DCP channel. </dd>
<dd>
kStatus_DCP_Again The DCP channel is busy processing previous request. </dd></dl>
</div>
</div>
<a class="anchor" id="ga26d7c8050e5a5a5fb3abcc8ced712187"></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_AES_DecryptCbcNonBlocking </td>
<td>(</td>
<td class="paramtype">DCP_Type *&#160;</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> *&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00020.html#gae21a78fdbeddfb819e22fa7b7835b937">dcp_work_packet_t</a> *&#160;</td>
<td class="paramname"><em>dcpPacket</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>ciphertext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>plaintext</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>iv</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Puts AES CBC decrypt dcpPacket to DCP input job ring.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">base</td><td>DCP peripheral base address </td></tr>
<tr><td class="paramdir"></td><td class="paramname">handle</td><td>Handle used for this request. Specifies jobRing. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dcpPacket</td><td>Memory for the DCP work packet. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">ciphertext</td><td>Input cipher text to decrypt </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">plaintext</td><td>Output plain text </td></tr>
<tr><td class="paramdir"></td><td class="paramname">size</td><td>Size of input and output data in bytes. Must be multiple of 16 bytes. </td></tr>
<tr><td class="paramdir"></td><td class="paramname">iv</td><td>Input initial vector to combine with the first input block. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>kStatus_Success The work packet has been scheduled at DCP channel. </dd>
<dd>
kStatus_DCP_Again The DCP channel is busy processing previous request. </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">&copy; 2016 NXP Semiconductors. All rights reserved.
</li>
</ul>
</div>
</body>
</html>