514 lines
25 KiB
HTML
514 lines
25 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: Otfad_hal</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
|
|
 <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 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__otfad__hal.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> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Otfad_hal</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:structotfad__context__info__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#structotfad__context__info__t">otfad_context_info_t</a></td></tr>
|
|
<tr class="memdesc:structotfad__context__info__t"><td class="mdescLeft"> </td><td class="mdescRight">Format of context info. <a href="group__otfad__hal.html#structotfad__context__info__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structotfad__context__info__t"><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:ga1fa8ec8c788704449817224afc320402"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga1fa8ec8c788704449817224afc320402">_hal_constants</a> { <br />
|
|
  <a class="el" href="group__otfad__hal.html#gga1fa8ec8c788704449817224afc320402a0f15f5bbc276a89b6842168d0c624bb8">kOtfadNumKeyWords</a> = 4,
|
|
<br />
|
|
  <a class="el" href="group__otfad__hal.html#gga1fa8ec8c788704449817224afc320402aa2072b64d4c944303258d897c6052998">kOtfadNumCtrWords</a> = 2,
|
|
<br />
|
|
  <a class="el" href="group__otfad__hal.html#gga1fa8ec8c788704449817224afc320402ab5a7ebab587511426451cb517aad31f8">kOtfadNumRgnWords</a> = 2
|
|
<br />
|
|
}<tr class="memdesc:ga1fa8ec8c788704449817224afc320402"><td class="mdescLeft"> </td><td class="mdescRight">Constants. <a href="group__otfad__hal.html#ga1fa8ec8c788704449817224afc320402">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga1fa8ec8c788704449817224afc320402"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1322236c7be01bfe4d4493857533e4b1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga1322236c7be01bfe4d4493857533e4b1">_otfad_modes</a> { <br />
|
|
  <a class="el" href="group__otfad__hal.html#gga1322236c7be01bfe4d4493857533e4b1af8e504f0e5e11f3b0046215b07b8a573">kOtfadMode_Normal</a> = 0x00,
|
|
<br />
|
|
  <a class="el" href="group__otfad__hal.html#gga1322236c7be01bfe4d4493857533e4b1a4d14c337dfa6a836bb5b99d9e6728c19">kOtfadMode_SecurityViolation</a> = 0x02,
|
|
<br />
|
|
  <a class="el" href="group__otfad__hal.html#gga1322236c7be01bfe4d4493857533e4b1abdc5c55fda6ff218d4e0553a5efa0fc8">kOtfadMode_LogiallyDisabled</a> = 0x03
|
|
<br />
|
|
}<tr class="memdesc:ga1322236c7be01bfe4d4493857533e4b1"><td class="mdescLeft"> </td><td class="mdescRight">Operational modes. <a href="group__otfad__hal.html#ga1322236c7be01bfe4d4493857533e4b1">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga1322236c7be01bfe4d4493857533e4b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga559577c6682640e99f1b7857face9ed2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga559577c6682640e99f1b7857face9ed2">_otfad_enables</a> { <br />
|
|
  <a class="el" href="group__otfad__hal.html#gga559577c6682640e99f1b7857face9ed2a874cc5cc313a29999e3a5a82c2843f7b">kOtfadDisable</a> = 0x00,
|
|
<br />
|
|
  <a class="el" href="group__otfad__hal.html#gga559577c6682640e99f1b7857face9ed2a4bf7b8e7c80b0702fd7b4cf4fbc024bd">kOtfadEnable</a> = 0x01
|
|
<br />
|
|
}<tr class="memdesc:ga559577c6682640e99f1b7857face9ed2"><td class="mdescLeft"> </td><td class="mdescRight">Enable flags. <a href="group__otfad__hal.html#ga559577c6682640e99f1b7857face9ed2">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga559577c6682640e99f1b7857face9ed2"><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:ga8c93f8f0838348b41412cfbdb9e56938"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga8c93f8f0838348b41412cfbdb9e56938">otfad_hal_get_mode</a> (OTFAD_Type *baseAddr)</td></tr>
|
|
<tr class="memdesc:ga8c93f8f0838348b41412cfbdb9e56938"><td class="mdescLeft"> </td><td class="mdescRight">Get the current mode. <a href="#ga8c93f8f0838348b41412cfbdb9e56938">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8c93f8f0838348b41412cfbdb9e56938"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9bf479ec81837d79ca2a23536311a86e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga9bf479ec81837d79ca2a23536311a86e">otfad_hal_global_enable</a> (OTFAD_Type *baseAddr)</td></tr>
|
|
<tr class="memdesc:ga9bf479ec81837d79ca2a23536311a86e"><td class="mdescLeft"> </td><td class="mdescRight">Enable the module. <a href="#ga9bf479ec81837d79ca2a23536311a86e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9bf479ec81837d79ca2a23536311a86e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga609c341d7482607d8cf0079fef19ca45"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga609c341d7482607d8cf0079fef19ca45">otfad_hal_is_enabled</a> (OTFAD_Type *baseAddr)</td></tr>
|
|
<tr class="memdesc:ga609c341d7482607d8cf0079fef19ca45"><td class="mdescLeft"> </td><td class="mdescRight">Get enabled state. <a href="#ga609c341d7482607d8cf0079fef19ca45">More...</a><br /></td></tr>
|
|
<tr class="separator:ga609c341d7482607d8cf0079fef19ca45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6e650cc3f0948069ca679f786c183aa3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga6e650cc3f0948069ca679f786c183aa3">otfad_hal_restricted_register_access_enable</a> (OTFAD_Type *baseAddr)</td></tr>
|
|
<tr class="memdesc:ga6e650cc3f0948069ca679f786c183aa3"><td class="mdescLeft"> </td><td class="mdescRight">Enable restricted register status. <a href="#ga6e650cc3f0948069ca679f786c183aa3">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6e650cc3f0948069ca679f786c183aa3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8e65ce4d93f5378852717919fbcf80d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga8e65ce4d93f5378852717919fbcf80d7">otfad_hal_is_register_access_restricted</a> (OTFAD_Type *baseAddr)</td></tr>
|
|
<tr class="memdesc:ga8e65ce4d93f5378852717919fbcf80d7"><td class="mdescLeft"> </td><td class="mdescRight">Get restricted register access state. <a href="#ga8e65ce4d93f5378852717919fbcf80d7">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8e65ce4d93f5378852717919fbcf80d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3e665e943212ef9b04f97c2801b728f6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga3e665e943212ef9b04f97c2801b728f6">otfad_hal_get_hardware_revision_level</a> (OTFAD_Type *baseAddr)</td></tr>
|
|
<tr class="memdesc:ga3e665e943212ef9b04f97c2801b728f6"><td class="mdescLeft"> </td><td class="mdescRight">Get hardware revision level. <a href="#ga3e665e943212ef9b04f97c2801b728f6">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3e665e943212ef9b04f97c2801b728f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaee77aba2afe4cefe45d83a593b57eb75"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#gaee77aba2afe4cefe45d83a593b57eb75">otfad_hal_get_number_of_contexts</a> (OTFAD_Type *baseAddr)</td></tr>
|
|
<tr class="memdesc:gaee77aba2afe4cefe45d83a593b57eb75"><td class="mdescLeft"> </td><td class="mdescRight">Get number of contexts. <a href="#gaee77aba2afe4cefe45d83a593b57eb75">More...</a><br /></td></tr>
|
|
<tr class="separator:gaee77aba2afe4cefe45d83a593b57eb75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga482b5e797ef89eb145b52865d3cd12cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__otfad__hal.html#ga482b5e797ef89eb145b52865d3cd12cf">otfad_hal_set_context</a> (OTFAD_Type *baseAddr, uint32_t contextNum, const <a class="el" href="group__otfad__hal.html#structotfad__context__info__t">otfad_context_info_t</a> *contextInfo)</td></tr>
|
|
<tr class="memdesc:ga482b5e797ef89eb145b52865d3cd12cf"><td class="mdescLeft"> </td><td class="mdescRight">Set context info. <a href="#ga482b5e797ef89eb145b52865d3cd12cf">More...</a><br /></td></tr>
|
|
<tr class="separator:ga482b5e797ef89eb145b52865d3cd12cf"><td class="memSeparator" colspan="2"> </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="structotfad__context__info__t" id="structotfad__context__info__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct otfad_context_info_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Format of context info. </p>
|
|
</div><table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a78f30f2e0f78546c0b74d12f191f3e89"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
ctrInfo[<a class="el" href="group__otfad__hal.html#gga1fa8ec8c788704449817224afc320402aa2072b64d4c944303258d897c6052998">kOtfadNumCtrWords</a>]</td>
|
|
<td class="fielddoc">
|
|
Counter words. </td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="aa5d9055b4dbc380f42f5a9bacb01d770"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
keyInfo[<a class="el" href="group__otfad__hal.html#gga1fa8ec8c788704449817224afc320402a0f15f5bbc276a89b6842168d0c624bb8">kOtfadNumKeyWords</a>]</td>
|
|
<td class="fielddoc">
|
|
Key words. </td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a9216ef7496e83f8399f5c2cca3ea610b"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
regionInfo[<a class="el" href="group__otfad__hal.html#gga1fa8ec8c788704449817224afc320402ab5a7ebab587511426451cb517aad31f8">kOtfadNumRgnWords</a>]</td>
|
|
<td class="fielddoc">
|
|
Region words. </td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga1fa8ec8c788704449817224afc320402"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__otfad__hal.html#ga1fa8ec8c788704449817224afc320402">_hal_constants</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constants. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga1fa8ec8c788704449817224afc320402a0f15f5bbc276a89b6842168d0c624bb8"></a>kOtfadNumKeyWords </td><td class="fielddoc">
|
|
<p>Number of key words. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga1fa8ec8c788704449817224afc320402aa2072b64d4c944303258d897c6052998"></a>kOtfadNumCtrWords </td><td class="fielddoc">
|
|
<p>Number of counter words. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga1fa8ec8c788704449817224afc320402ab5a7ebab587511426451cb517aad31f8"></a>kOtfadNumRgnWords </td><td class="fielddoc">
|
|
<p>Number of region words. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga559577c6682640e99f1b7857face9ed2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__otfad__hal.html#ga559577c6682640e99f1b7857face9ed2">_otfad_enables</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable flags. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga559577c6682640e99f1b7857face9ed2a874cc5cc313a29999e3a5a82c2843f7b"></a>kOtfadDisable </td><td class="fielddoc">
|
|
<p>Disable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga559577c6682640e99f1b7857face9ed2a4bf7b8e7c80b0702fd7b4cf4fbc024bd"></a>kOtfadEnable </td><td class="fielddoc">
|
|
<p>Enable. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1322236c7be01bfe4d4493857533e4b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__otfad__hal.html#ga1322236c7be01bfe4d4493857533e4b1">_otfad_modes</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Operational modes. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga1322236c7be01bfe4d4493857533e4b1af8e504f0e5e11f3b0046215b07b8a573"></a>kOtfadMode_Normal </td><td class="fielddoc">
|
|
<p>Normal mode (NRM) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga1322236c7be01bfe4d4493857533e4b1a4d14c337dfa6a836bb5b99d9e6728c19"></a>kOtfadMode_SecurityViolation </td><td class="fielddoc">
|
|
<p>Security Violation Mode (SVM) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga1322236c7be01bfe4d4493857533e4b1abdc5c55fda6ff218d4e0553a5efa0fc8"></a>kOtfadMode_LogiallyDisabled </td><td class="fielddoc">
|
|
<p>Logically Disabled Mode (LDM) </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga3e665e943212ef9b04f97c2801b728f6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t otfad_hal_get_hardware_revision_level </td>
|
|
<td>(</td>
|
|
<td class="paramtype">OTFAD_Type * </td>
|
|
<td class="paramname"><em>baseAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get hardware revision level. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">baseAddr</td><td>Module base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Hardware revision level from status register </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8c93f8f0838348b41412cfbdb9e56938"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t otfad_hal_get_mode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">OTFAD_Type * </td>
|
|
<td class="paramname"><em>baseAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the current mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">baseAddr</td><td>Module base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current mode in status register </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaee77aba2afe4cefe45d83a593b57eb75"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t otfad_hal_get_number_of_contexts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">OTFAD_Type * </td>
|
|
<td class="paramname"><em>baseAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get number of contexts. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">baseAddr</td><td>Module base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of contexts from status register </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga9bf479ec81837d79ca2a23536311a86e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void otfad_hal_global_enable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">OTFAD_Type * </td>
|
|
<td class="paramname"><em>baseAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable the module. </p>
|
|
<p>Set the global enable flag in the control register to '1'. A power-on reset is required to clear this flag.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">baseAddr</td><td>Module base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga609c341d7482607d8cf0079fef19ca45"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool otfad_hal_is_enabled </td>
|
|
<td>(</td>
|
|
<td class="paramtype">OTFAD_Type * </td>
|
|
<td class="paramname"><em>baseAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get enabled state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">baseAddr</td><td>Module base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Global enabled flag in status register </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8e65ce4d93f5378852717919fbcf80d7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool otfad_hal_is_register_access_restricted </td>
|
|
<td>(</td>
|
|
<td class="paramtype">OTFAD_Type * </td>
|
|
<td class="paramname"><em>baseAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get restricted register access state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">baseAddr</td><td>Module base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Restricted register access flag in status register </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6e650cc3f0948069ca679f786c183aa3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void otfad_hal_restricted_register_access_enable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">OTFAD_Type * </td>
|
|
<td class="paramname"><em>baseAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable restricted register status. </p>
|
|
<p>Set the restricted register access enable flag in the control register to '1'. A power-on reset is required to clear this flag.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">baseAddr</td><td>Module base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga482b5e797ef89eb145b52865d3cd12cf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void otfad_hal_set_context </td>
|
|
<td>(</td>
|
|
<td class="paramtype">OTFAD_Type * </td>
|
|
<td class="paramname"><em>baseAddr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>contextNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="group__otfad__hal.html#structotfad__context__info__t">otfad_context_info_t</a> * </td>
|
|
<td class="paramname"><em>contextInfo</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set context info. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">baseAddr</td><td>Module base address </td></tr>
|
|
<tr><td class="paramname">contextNum</td><td>Context number </td></tr>
|
|
<tr><td class="paramname">contextInfo</td><td>Ponter to context info struct </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</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>
|