MCUXpresso_LPC55S69/docs/MCUXpresso SDK API Referenc.../a00258.html

297 lines
19 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: skboot_authenticate</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('a00258.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="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">skboot_authenticate<div class="ingroups"><a class="el" href="a00018.html">IAP: In Application Programming Driver</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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gadce343aecc3bcb85e396d05009df5e8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadce343aecc3bcb85e396d05009df5e8b"></a>
typedef enum <a class="el" href="a00258.html#ga6bfd6dd9281cf1736444d3d68194fe89">_skboot_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00258.html#gadce343aecc3bcb85e396d05009df5e8b">skboot_status_t</a></td></tr>
<tr class="memdesc:gadce343aecc3bcb85e396d05009df5e8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">SKBOOT return status. <br/></td></tr>
<tr class="separator:gadce343aecc3bcb85e396d05009df5e8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f4c9d3b6f3a135c023af31b8accfade"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7f4c9d3b6f3a135c023af31b8accfade"></a>
typedef enum <a class="el" href="a00258.html#ga8024cd1ee84b0c45ac510441f2f6d188">_secure_bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00258.html#ga7f4c9d3b6f3a135c023af31b8accfade">secure_bool_t</a></td></tr>
<tr class="memdesc:ga7f4c9d3b6f3a135c023af31b8accfade"><td class="mdescLeft">&#160;</td><td class="mdescRight">Secure bool flag. <br/></td></tr>
<tr class="separator:ga7f4c9d3b6f3a135c023af31b8accfade"><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:ga6bfd6dd9281cf1736444d3d68194fe89"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00258.html#ga6bfd6dd9281cf1736444d3d68194fe89">_skboot_status</a> { <br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89a9f0ca718735dd60c0f6e2e103615f9bc">kStatus_SKBOOT_Success</a> = 0x5ac3c35au,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89a905a486e12679a5223f9824de2fa272d">kStatus_SKBOOT_Fail</a> = 0xc35ac35au,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89ab7b21bcc121baaaf6a76bfe7f090912c">kStatus_SKBOOT_InvalidArgument</a> = 0xc35a5ac3u,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89a7ca4bc728877b1f6c23e7dcbfa3ccf91">kStatus_SKBOOT_KeyStoreMarkerInvalid</a> = 0xc3c35a5au,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89ab100a53cab34959974f0d3c042e005d7">kStatus_SKBOOT_HashcryptFinishedWithStatusSuccess</a>,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89a6b11be0c36b45ecfb11fe44b35ec78d6">kStatus_SKBOOT_HashcryptFinishedWithStatusFail</a>,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89a9f0ca718735dd60c0f6e2e103615f9bc">kStatus_SKBOOT_Success</a> = 0x5ac3c35au,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89a905a486e12679a5223f9824de2fa272d">kStatus_SKBOOT_Fail</a> = 0xc35ac35au,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89ab7b21bcc121baaaf6a76bfe7f090912c">kStatus_SKBOOT_InvalidArgument</a> = 0xc35a5ac3u,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga6bfd6dd9281cf1736444d3d68194fe89a7ca4bc728877b1f6c23e7dcbfa3ccf91">kStatus_SKBOOT_KeyStoreMarkerInvalid</a> = 0xc3c35a5au
<br/>
}</td></tr>
<tr class="memdesc:ga6bfd6dd9281cf1736444d3d68194fe89"><td class="mdescLeft">&#160;</td><td class="mdescRight">SKBOOT return status. <a href="a00258.html#ga6bfd6dd9281cf1736444d3d68194fe89">More...</a><br/></td></tr>
<tr class="separator:ga6bfd6dd9281cf1736444d3d68194fe89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8024cd1ee84b0c45ac510441f2f6d188"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00258.html#ga8024cd1ee84b0c45ac510441f2f6d188">_secure_bool</a> { <br/>
&#160;&#160;<a class="el" href="a00263.html#gga8024cd1ee84b0c45ac510441f2f6d188ad932c3b671bfe67c51f03e11c721baea">kSECURE_TRUE</a> = 0xc33cc33cU,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga8024cd1ee84b0c45ac510441f2f6d188aea4739fe46439345f5ed79f9474de365">kSECURE_FALSE</a> = 0x5aa55aa5U,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga8024cd1ee84b0c45ac510441f2f6d188a7e7eede8a248707a5dfc155eccd0933e">kSECURE_CALLPROTECT_SECURITY_FLAGS</a> = 0xc33c5aa5U,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga8024cd1ee84b0c45ac510441f2f6d188a8056add926dd6c6d8627382268749c7f">kSECURE_CALLPROTECT_IS_APP_READY</a> = 0x5aa5c33cU,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga8024cd1ee84b0c45ac510441f2f6d188aae494aba45c6e0f724cea838d36b7df1">kSECURE_TRACKER_VERIFIED</a> = 0x55aacc33U,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga8024cd1ee84b0c45ac510441f2f6d188ad932c3b671bfe67c51f03e11c721baea">kSECURE_TRUE</a> = 0xc33cc33cU,
<br/>
&#160;&#160;<a class="el" href="a00263.html#gga8024cd1ee84b0c45ac510441f2f6d188aea4739fe46439345f5ed79f9474de365">kSECURE_FALSE</a> = 0x5aa55aa5U
<br/>
}</td></tr>
<tr class="memdesc:ga8024cd1ee84b0c45ac510441f2f6d188"><td class="mdescLeft">&#160;</td><td class="mdescRight">Secure bool flag. <a href="a00258.html#ga8024cd1ee84b0c45ac510441f2f6d188">More...</a><br/></td></tr>
<tr class="separator:ga8024cd1ee84b0c45ac510441f2f6d188"><td class="memSeparator" colspan="2">&#160;</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:gae7e46a34133ec6104f755f4988f0a3dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00258.html#gadce343aecc3bcb85e396d05009df5e8b">skboot_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00258.html#gae7e46a34133ec6104f755f4988f0a3dd">skboot_authenticate</a> (const uint8_t *imageStartAddr, <a class="el" href="a00258.html#ga7f4c9d3b6f3a135c023af31b8accfade">secure_bool_t</a> *isSignVerified)</td></tr>
<tr class="memdesc:gae7e46a34133ec6104f755f4988f0a3dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Authenticate entry function with ARENA allocator init. <a href="#gae7e46a34133ec6104f755f4988f0a3dd">More...</a><br/></td></tr>
<tr class="separator:gae7e46a34133ec6104f755f4988f0a3dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef149942461581de64f7739062643a8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaef149942461581de64f7739062643a8e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00258.html#gaef149942461581de64f7739062643a8e">HASH_IRQHandler</a> (void)</td></tr>
<tr class="memdesc:gaef149942461581de64f7739062643a8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface for image authentication API. <br/></td></tr>
<tr class="separator:gaef149942461581de64f7739062643a8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga6bfd6dd9281cf1736444d3d68194fe89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00258.html#ga6bfd6dd9281cf1736444d3d68194fe89">_skboot_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="gga6bfd6dd9281cf1736444d3d68194fe89a9f0ca718735dd60c0f6e2e103615f9bc"></a>kStatus_SKBOOT_Success</em>&nbsp;</td><td class="fielddoc">
<p>SKBOOT return success status. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89a905a486e12679a5223f9824de2fa272d"></a>kStatus_SKBOOT_Fail</em>&nbsp;</td><td class="fielddoc">
<p>SKBOOT return fail status. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89ab7b21bcc121baaaf6a76bfe7f090912c"></a>kStatus_SKBOOT_InvalidArgument</em>&nbsp;</td><td class="fielddoc">
<p>SKBOOT return invalid argument status. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89a7ca4bc728877b1f6c23e7dcbfa3ccf91"></a>kStatus_SKBOOT_KeyStoreMarkerInvalid</em>&nbsp;</td><td class="fielddoc">
<p>SKBOOT return Keystore invalid Marker status. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89ab100a53cab34959974f0d3c042e005d7"></a>kStatus_SKBOOT_HashcryptFinishedWithStatusSuccess</em>&nbsp;</td><td class="fielddoc">
<p>SKBOOT return Hashcrypt finished with the success status. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89a6b11be0c36b45ecfb11fe44b35ec78d6"></a>kStatus_SKBOOT_HashcryptFinishedWithStatusFail</em>&nbsp;</td><td class="fielddoc">
<p>SKBOOT return Hashcrypt finished with the fail status. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89a9f0ca718735dd60c0f6e2e103615f9bc"></a>kStatus_SKBOOT_Success</em>&nbsp;</td><td class="fielddoc">
<p>PRINCE Success. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89a905a486e12679a5223f9824de2fa272d"></a>kStatus_SKBOOT_Fail</em>&nbsp;</td><td class="fielddoc">
<p>PRINCE Fail. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89ab7b21bcc121baaaf6a76bfe7f090912c"></a>kStatus_SKBOOT_InvalidArgument</em>&nbsp;</td><td class="fielddoc">
<p>PRINCE Invalid argument. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6bfd6dd9281cf1736444d3d68194fe89a7ca4bc728877b1f6c23e7dcbfa3ccf91"></a>kStatus_SKBOOT_KeyStoreMarkerInvalid</em>&nbsp;</td><td class="fielddoc">
<p>PRINCE Invalid marker. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga8024cd1ee84b0c45ac510441f2f6d188"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00258.html#ga8024cd1ee84b0c45ac510441f2f6d188">_secure_bool</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="gga8024cd1ee84b0c45ac510441f2f6d188ad932c3b671bfe67c51f03e11c721baea"></a>kSECURE_TRUE</em>&nbsp;</td><td class="fielddoc">
<p>Secure true flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8024cd1ee84b0c45ac510441f2f6d188aea4739fe46439345f5ed79f9474de365"></a>kSECURE_FALSE</em>&nbsp;</td><td class="fielddoc">
<p>Secure false flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8024cd1ee84b0c45ac510441f2f6d188a7e7eede8a248707a5dfc155eccd0933e"></a>kSECURE_CALLPROTECT_SECURITY_FLAGS</em>&nbsp;</td><td class="fielddoc">
<p>Secure call protect the security flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8024cd1ee84b0c45ac510441f2f6d188a8056add926dd6c6d8627382268749c7f"></a>kSECURE_CALLPROTECT_IS_APP_READY</em>&nbsp;</td><td class="fielddoc">
<p>Secure call protect the app is ready flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8024cd1ee84b0c45ac510441f2f6d188aae494aba45c6e0f724cea838d36b7df1"></a>kSECURE_TRACKER_VERIFIED</em>&nbsp;</td><td class="fielddoc">
<p>Secure tracker verified flag. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8024cd1ee84b0c45ac510441f2f6d188ad932c3b671bfe67c51f03e11c721baea"></a>kSECURE_TRUE</em>&nbsp;</td><td class="fielddoc">
<p>PRINCE true. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8024cd1ee84b0c45ac510441f2f6d188aea4739fe46439345f5ed79f9474de365"></a>kSECURE_FALSE</em>&nbsp;</td><td class="fielddoc">
<p>PRINCE false. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gae7e46a34133ec6104f755f4988f0a3dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00258.html#gadce343aecc3bcb85e396d05009df5e8b">skboot_status_t</a> skboot_authenticate </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>imageStartAddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00258.html#ga7f4c9d3b6f3a135c023af31b8accfade">secure_bool_t</a> *&#160;</td>
<td class="paramname"><em>isSignVerified</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This is called by ROM boot or by ROM API g_skbootAuthenticateInterface </p>
</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>