359 lines
17 KiB
HTML
359 lines
17 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: Hashcrypt common functions</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('a00256.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="#define-members">Macros</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">Hashcrypt common functions<div class="ingroups"><a class="el" href="a00254.html">Hashcrypt: The Cryptographic Accelerator</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga859c70de1a97b05f61723b64e6f06227"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga859c70de1a97b05f61723b64e6f06227"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00256.html#ga859c70de1a97b05f61723b64e6f06227">HASHCRYPT_MODE_SHA1</a>   0x1</td></tr>
|
|
<tr class="memdesc:ga859c70de1a97b05f61723b64e6f06227"><td class="mdescLeft"> </td><td class="mdescRight">Algorithm definitions correspond with the values for Mode field in Control register ! <br/></td></tr>
|
|
<tr class="separator:ga859c70de1a97b05f61723b64e6f06227"><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:gafccc8d49b73cba6bb99024890615c07e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafccc8d49b73cba6bb99024890615c07e"></a>
|
|
typedef enum <a class="el" href="a00256.html#ga0c0641fe4726c8047123fe99b1f79a71">_hashcrypt_algo_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00256.html#gafccc8d49b73cba6bb99024890615c07e">hashcrypt_algo_t</a></td></tr>
|
|
<tr class="memdesc:gafccc8d49b73cba6bb99024890615c07e"><td class="mdescLeft"> </td><td class="mdescRight">Algorithm used for Hashcrypt operation. <br/></td></tr>
|
|
<tr class="separator:gafccc8d49b73cba6bb99024890615c07e"><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:ga0c0641fe4726c8047123fe99b1f79a71"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00256.html#ga0c0641fe4726c8047123fe99b1f79a71">_hashcrypt_algo_t</a> { <br/>
|
|
  <a class="el" href="a00256.html#gga0c0641fe4726c8047123fe99b1f79a71a521a8aebc98248da4565bbf8fd69ff57">kHASHCRYPT_Sha1</a> = HASHCRYPT_MODE_SHA1,
|
|
<br/>
|
|
  <a class="el" href="a00256.html#gga0c0641fe4726c8047123fe99b1f79a71ae14b2fbb186eb7ecb1bfc007a509b3d3">kHASHCRYPT_Sha256</a> = HASHCRYPT_MODE_SHA256,
|
|
<br/>
|
|
  <a class="el" href="a00256.html#gga0c0641fe4726c8047123fe99b1f79a71a142430d685b31911c77af2ce8194a51b">kHASHCRYPT_Aes</a> = HASHCRYPT_MODE_AES
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga0c0641fe4726c8047123fe99b1f79a71"><td class="mdescLeft"> </td><td class="mdescRight">Algorithm used for Hashcrypt operation. <a href="a00256.html#ga0c0641fe4726c8047123fe99b1f79a71">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0c0641fe4726c8047123fe99b1f79a71"><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:ga02f8a8a22a0ac96e7ac823da4cacd585"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00256.html#ga02f8a8a22a0ac96e7ac823da4cacd585">HASHCRYPT_Init</a> (HASHCRYPT_Type *base)</td></tr>
|
|
<tr class="memdesc:ga02f8a8a22a0ac96e7ac823da4cacd585"><td class="mdescLeft"> </td><td class="mdescRight">Enables clock and disables reset for HASHCRYPT peripheral. <a href="#ga02f8a8a22a0ac96e7ac823da4cacd585">More...</a><br/></td></tr>
|
|
<tr class="separator:ga02f8a8a22a0ac96e7ac823da4cacd585"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2561c8bc17a4b2143a0cc7c46de64fbe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00256.html#ga2561c8bc17a4b2143a0cc7c46de64fbe">HASHCRYPT_Deinit</a> (HASHCRYPT_Type *base)</td></tr>
|
|
<tr class="memdesc:ga2561c8bc17a4b2143a0cc7c46de64fbe"><td class="mdescLeft"> </td><td class="mdescRight">Disables clock for HASHCRYPT peripheral. <a href="#ga2561c8bc17a4b2143a0cc7c46de64fbe">More...</a><br/></td></tr>
|
|
<tr class="separator:ga2561c8bc17a4b2143a0cc7c46de64fbe"><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:ga6de3a130dd77ff83fba428d53188e661"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00256.html#ga6de3a130dd77ff83fba428d53188e661">FSL_HASHCRYPT_DRIVER_VERSION</a>   (<a class="el" href="a00242.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 2, 14))</td></tr>
|
|
<tr class="memdesc:ga6de3a130dd77ff83fba428d53188e661"><td class="mdescLeft"> </td><td class="mdescRight">HASHCRYPT driver version. <a href="#ga6de3a130dd77ff83fba428d53188e661">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6de3a130dd77ff83fba428d53188e661"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga6de3a130dd77ff83fba428d53188e661"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_HASHCRYPT_DRIVER_VERSION   (<a class="el" href="a00242.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 2, 14))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Version 2.2.14.</p>
|
|
<p>Current version: 2.2.14</p>
|
|
<p>Change log:</p>
|
|
<ul>
|
|
<li>Version 2.0.0<ul>
|
|
<li>Initial version</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.0.1<ul>
|
|
<li>Support loading AES key from unaligned address</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.0.2<ul>
|
|
<li>Support loading AES key from unaligned address for different compiler and core variants</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.0.3<ul>
|
|
<li>Remove SHA512 and AES ICB algorithm definitions</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.0.4<ul>
|
|
<li>Add SHA context switch support</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.0<ul>
|
|
<li>Update the register name and macro to align with new header.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.1<ul>
|
|
<li>Fix MISRA C-2012.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.2<ul>
|
|
<li>Support loading AES input data from unaligned address.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.3<ul>
|
|
<li>Fix MISRA C-2012.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.4<ul>
|
|
<li>Fix context switch cannot work when switching from AES.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.1.5<ul>
|
|
<li>Add data synchronization barrier inside hashcrypt_sha_ldm_stm_16_words() to prevent possible optimization issue.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.0<ul>
|
|
<li>Add AES-OFB and AES-CFB mixed IP/SW modes.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.1<ul>
|
|
<li>Add data synchronization barrier inside hashcrypt_sha_ldm_stm_16_words() prevent compiler from reordering memory write when -O2 or higher is used.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.2<ul>
|
|
<li>Add data synchronization barrier inside hashcrypt_sha_ldm_stm_16_words() to fix optimization issue</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.3<ul>
|
|
<li>Added check for size in hashcrypt_aes_one_block to prevent overflowing COUNT field in MEMCTRL register, if its bigger than COUNT field do a multiple runs.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.4<ul>
|
|
<li>In all HASHCRYPT_AES_xx functions have been added setting CTRL_MODE bitfield to 0 after processing data, which decreases power consumption.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.5<ul>
|
|
<li>Add data synchronization barrier and instruction synchronization barrier inside hashcrypt_sha_process_message_data() to fix optimization issue</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.6<ul>
|
|
<li>Add data synchronization barrier inside <a class="el" href="a00027.html#ga73e2339a36879daa7aa54491387ba103" title="Add data to current HASH. ">HASHCRYPT_SHA_Update()</a> and hashcrypt_get_data() function to fix optimization issue on MDK and ARMGCC release targets</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.7<ul>
|
|
<li>Add data synchronization barrier inside <a class="el" href="a00027.html#ga73e2339a36879daa7aa54491387ba103" title="Add data to current HASH. ">HASHCRYPT_SHA_Update()</a> to fix optimization issue on MCUX IDE release target</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.8<ul>
|
|
<li>Unify hashcrypt hashing behavior between aligned and unaligned input data</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.9<ul>
|
|
<li>Add handling of set ERROR bit in the STATUS register</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.10<ul>
|
|
<li>Fix missing error statement in hashcrypt_save_running_hash()</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.11<ul>
|
|
<li>Fix incorrect SHA-256 calculation for long messages with reload</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.12<ul>
|
|
<li>Fix hardfault issue on the Keil compiler due to unaligned memcpy() input on some optimization levels</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.13<ul>
|
|
<li>Added function hashcrypt_seed_prng() which loading random number into PRNG_SEED register before AES operation for SCA protection</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.2.14<ul>
|
|
<li>Modify function hashcrypt_get_data() to prevent issue with unaligned access </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga0c0641fe4726c8047123fe99b1f79a71"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00256.html#ga0c0641fe4726c8047123fe99b1f79a71">_hashcrypt_algo_t</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="gga0c0641fe4726c8047123fe99b1f79a71a521a8aebc98248da4565bbf8fd69ff57"></a>kHASHCRYPT_Sha1</em> </td><td class="fielddoc">
|
|
<p>SHA_1. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0c0641fe4726c8047123fe99b1f79a71ae14b2fbb186eb7ecb1bfc007a509b3d3"></a>kHASHCRYPT_Sha256</em> </td><td class="fielddoc">
|
|
<p>SHA_256. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga0c0641fe4726c8047123fe99b1f79a71a142430d685b31911c77af2ce8194a51b"></a>kHASHCRYPT_Aes</em> </td><td class="fielddoc">
|
|
<p>AES. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga02f8a8a22a0ac96e7ac823da4cacd585"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void HASHCRYPT_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">HASHCRYPT_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Enable clock and disable reset for HASHCRYPT.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>HASHCRYPT base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2561c8bc17a4b2143a0cc7c46de64fbe"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void HASHCRYPT_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">HASHCRYPT_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Disable clock and enable reset.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>HASHCRYPT base address </td></tr>
|
|
</table>
|
|
</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>
|