Files
bootloader/doc/core_html/group__aes__security.html
László Monda e6c1fce5b4 Add KBOOT.
2016-08-10 01:45:15 +02:00

248 lines
11 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.11"/>
<title>Kinetis Bootloader: Aes_security</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="navtreedata.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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.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="nxp_logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kinetis Bootloader
&#160;<span id="projectnumber">2.0.0</span>
</div>
<div id="projectbrief">Common bootloader for Kinetis devices</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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>Introduction</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</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('group__aes__security.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)">
</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="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Aes_security</div> </div>
</div><!--header-->
<div class="contents">
<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:structmmcau__function__info__t"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__aes__security.html#structmmcau__function__info__t">mmcau_function_info_t</a></td></tr>
<tr class="separator:structmmcau__function__info__t"><td class="memSeparator" colspan="2">&#160;</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:gab2e3656fc390bb0cb6e145675dcc7188"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__aes__security.html#gab2e3656fc390bb0cb6e145675dcc7188">_mmcau_info_tag</a> { <a class="el" href="group__aes__security.html#ggab2e3656fc390bb0cb6e145675dcc7188ac41f1cc4102dc6656158d48c405a573b">kMmcauInfoTag</a> = FOUR_CHAR_CODE('k', 'c', 'a', 'u')
}</td></tr>
<tr class="separator:gab2e3656fc390bb0cb6e145675dcc7188"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
aes_security</h2></td></tr>
<tr class="memitem:ga126d11611a246e256a919226e9f543cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga126d11611a246e256a919226e9f543cc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__aes__security.html#ga126d11611a246e256a919226e9f543cc">aes_init</a> (uint32_t *key)</td></tr>
<tr class="memdesc:ga126d11611a246e256a919226e9f543cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">An initialization function for the decryption peripheral Warning: The key must be word aligned. <br /></td></tr>
<tr class="separator:ga126d11611a246e256a919226e9f543cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7cc0d7eb12cfe64c6712381753c9c677"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7cc0d7eb12cfe64c6712381753c9c677"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__aes__security.html#ga7cc0d7eb12cfe64c6712381753c9c677">aes_encrypt</a> (uint32_t *in, uint32_t *key, uint32_t *out)</td></tr>
<tr class="memdesc:ga7cc0d7eb12cfe64c6712381753c9c677"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encrypts a 16 byte block of data in and out may use the same address so encrypting in place is supported Warning: All parameters must be word aligned. <br /></td></tr>
<tr class="separator:ga7cc0d7eb12cfe64c6712381753c9c677"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf25d367b958671d9bee4e16cc87386cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__aes__security.html#gaf25d367b958671d9bee4e16cc87386cb">aes_decrypt</a> (uint32_t *in, uint32_t *key, uint32_t *out)</td></tr>
<tr class="memdesc:gaf25d367b958671d9bee4e16cc87386cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrypts a 16 byte block of data in and out may use the same address so decrypting in place is supported Warning: All parameters must be word aligned. <a href="#gaf25d367b958671d9bee4e16cc87386cb">More...</a><br /></td></tr>
<tr class="separator:gaf25d367b958671d9bee4e16cc87386cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Usage Information</h2>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structmmcau__function__info__t" id="structmmcau__function__info__t"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct mmcau_function_info_t</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"></div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae3367d32c48beb89d72cabd0c4a19c52"></a>uint32_t</td>
<td class="fieldname">
aes_decrypt_start</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3785b08d8586656ec8d55939cdb5a7f7"></a>uint32_t</td>
<td class="fieldname">
aes_encrypt_start</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a25fc16bbbbaad953ef63b3038b7626d3"></a>uint32_t</td>
<td class="fieldname">
aes_init_start</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aebb70c2aab3407a9f05334c47131a43b"></a>uint32_t</td>
<td class="fieldname">
length</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1c50fcd1195659821729f52af8f3bb7d"></a>uint32_t</td>
<td class="fieldname">
tag</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gab2e3656fc390bb0cb6e145675dcc7188"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__aes__security.html#gab2e3656fc390bb0cb6e145675dcc7188">_mmcau_info_tag</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggab2e3656fc390bb0cb6e145675dcc7188ac41f1cc4102dc6656158d48c405a573b"></a>kMmcauInfoTag&#160;</td><td class="fielddoc">
<p>Tag value used to validate the bootloader configuration data. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf25d367b958671d9bee4e16cc87386cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aes_decrypt </td>
<td>(</td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decrypts a 16 byte block of data in and out may use the same address so decrypting in place is supported Warning: All parameters must be word aligned. </p>
<p>Decrypts a 16 byte block of data in and out may use the same address so decrypting in place is supported Warning: All parameters must be word aligned. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Mon Mar 7 2016 16:48:24 for Kinetis Bootloader by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>