713 lines
33 KiB
HTML
713 lines
33 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: CDOG</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.11.0</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('a00212.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="#files">Files</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">CDOG</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="files"></a>
|
|
Files</h2></td></tr>
|
|
<tr class="memitem:a00093"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00093.html">fsl_cdog.h</a></td></tr>
|
|
<tr class="separator:"><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:ga6177d00be246704f21b511833adc3c62"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#ga6177d00be246704f21b511833adc3c62">FSL_CDOG_DRIVER_VERSION</a>   (<a class="el" href="a00017.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 0))</td></tr>
|
|
<tr class="memdesc:ga6177d00be246704f21b511833adc3c62"><td class="mdescLeft"> </td><td class="mdescRight">Defines CDOG driver version 2.1.0. <a href="#ga6177d00be246704f21b511833adc3c62">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6177d00be246704f21b511833adc3c62"><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>
|
|
CDOG Functional Operation</h2></td></tr>
|
|
<tr class="memitem:gad3ac1272485f8a213c8f5d86f490fbd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00178.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gad3ac1272485f8a213c8f5d86f490fbd1">CDOG_Init</a> (CDOG_Type *base, cdog_config_t *conf)</td></tr>
|
|
<tr class="memdesc:gad3ac1272485f8a213c8f5d86f490fbd1"><td class="mdescLeft"> </td><td class="mdescRight">Initialize CDOG. <a href="#gad3ac1272485f8a213c8f5d86f490fbd1">More...</a><br/></td></tr>
|
|
<tr class="separator:gad3ac1272485f8a213c8f5d86f490fbd1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga23a9da6cedfbc35917a53bfd572d8cc8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#ga23a9da6cedfbc35917a53bfd572d8cc8">CDOG_Deinit</a> (CDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:ga23a9da6cedfbc35917a53bfd572d8cc8"><td class="mdescLeft"> </td><td class="mdescRight">Deinitialize CDOG. <a href="#ga23a9da6cedfbc35917a53bfd572d8cc8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga23a9da6cedfbc35917a53bfd572d8cc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga65997f42e3cecb1e42f3f2277a17b2a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#ga65997f42e3cecb1e42f3f2277a17b2a1">CDOG_GetDefaultConfig</a> (cdog_config_t *conf)</td></tr>
|
|
<tr class="memdesc:ga65997f42e3cecb1e42f3f2277a17b2a1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the default configuration of CDOG. <a href="#ga65997f42e3cecb1e42f3f2277a17b2a1">More...</a><br/></td></tr>
|
|
<tr class="separator:ga65997f42e3cecb1e42f3f2277a17b2a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaafb31433cf79df6e9c9d8b162f81f43"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gaaafb31433cf79df6e9c9d8b162f81f43">CDOG_Stop</a> (CDOG_Type *base, uint32_t stop)</td></tr>
|
|
<tr class="memdesc:gaaafb31433cf79df6e9c9d8b162f81f43"><td class="mdescLeft"> </td><td class="mdescRight">Stops secure counter and instruction timer. <a href="#gaaafb31433cf79df6e9c9d8b162f81f43">More...</a><br/></td></tr>
|
|
<tr class="separator:gaaafb31433cf79df6e9c9d8b162f81f43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa28a2bc263bc676bd8738d820ad5261c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gaa28a2bc263bc676bd8738d820ad5261c">CDOG_Start</a> (CDOG_Type *base, uint32_t reload, uint32_t start)</td></tr>
|
|
<tr class="memdesc:gaa28a2bc263bc676bd8738d820ad5261c"><td class="mdescLeft"> </td><td class="mdescRight">Sets secure counter and instruction timer values. <a href="#gaa28a2bc263bc676bd8738d820ad5261c">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa28a2bc263bc676bd8738d820ad5261c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga494819d0aecc6caef10d321563e53d96"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#ga494819d0aecc6caef10d321563e53d96">CDOG_Check</a> (CDOG_Type *base, uint32_t check)</td></tr>
|
|
<tr class="memdesc:ga494819d0aecc6caef10d321563e53d96"><td class="mdescLeft"> </td><td class="mdescRight">Checks secure counter. <a href="#ga494819d0aecc6caef10d321563e53d96">More...</a><br/></td></tr>
|
|
<tr class="separator:ga494819d0aecc6caef10d321563e53d96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0d7b74edaf54b436965a9e25fbba367b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#ga0d7b74edaf54b436965a9e25fbba367b">CDOG_Set</a> (CDOG_Type *base, uint32_t stop, uint32_t reload, uint32_t start)</td></tr>
|
|
<tr class="memdesc:ga0d7b74edaf54b436965a9e25fbba367b"><td class="mdescLeft"> </td><td class="mdescRight">Sets secure counter and instruction timer values. <a href="#ga0d7b74edaf54b436965a9e25fbba367b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga0d7b74edaf54b436965a9e25fbba367b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf3dc568c4e9c5e5afa34627bb9d4d861"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gaf3dc568c4e9c5e5afa34627bb9d4d861">CDOG_Add</a> (CDOG_Type *base, uint32_t add)</td></tr>
|
|
<tr class="memdesc:gaf3dc568c4e9c5e5afa34627bb9d4d861"><td class="mdescLeft"> </td><td class="mdescRight">Add value to secure counter. <a href="#gaf3dc568c4e9c5e5afa34627bb9d4d861">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf3dc568c4e9c5e5afa34627bb9d4d861"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1025b0056d78f8fb7eb4ef727689a7a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#ga1025b0056d78f8fb7eb4ef727689a7a8">CDOG_Add1</a> (CDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:ga1025b0056d78f8fb7eb4ef727689a7a8"><td class="mdescLeft"> </td><td class="mdescRight">Add 1 to secure counter. <a href="#ga1025b0056d78f8fb7eb4ef727689a7a8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga1025b0056d78f8fb7eb4ef727689a7a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga94095b09120ff9fcacec54fa55a3c0c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#ga94095b09120ff9fcacec54fa55a3c0c7">CDOG_Add16</a> (CDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:ga94095b09120ff9fcacec54fa55a3c0c7"><td class="mdescLeft"> </td><td class="mdescRight">Add 16 to secure counter. <a href="#ga94095b09120ff9fcacec54fa55a3c0c7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga94095b09120ff9fcacec54fa55a3c0c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac186ecfa0ef19f7de831f75848b9d00d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gac186ecfa0ef19f7de831f75848b9d00d">CDOG_Add256</a> (CDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:gac186ecfa0ef19f7de831f75848b9d00d"><td class="mdescLeft"> </td><td class="mdescRight">Add 256 to secure counter. <a href="#gac186ecfa0ef19f7de831f75848b9d00d">More...</a><br/></td></tr>
|
|
<tr class="separator:gac186ecfa0ef19f7de831f75848b9d00d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf3d6d6d5670269994c1d780985688157"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gaf3d6d6d5670269994c1d780985688157">CDOG_Sub</a> (CDOG_Type *base, uint32_t sub)</td></tr>
|
|
<tr class="memdesc:gaf3d6d6d5670269994c1d780985688157"><td class="mdescLeft"> </td><td class="mdescRight">brief Substract value to secure counter <a href="#gaf3d6d6d5670269994c1d780985688157">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf3d6d6d5670269994c1d780985688157"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga221219026b7aa75e62fdae5f0817e060"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#ga221219026b7aa75e62fdae5f0817e060">CDOG_Sub1</a> (CDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:ga221219026b7aa75e62fdae5f0817e060"><td class="mdescLeft"> </td><td class="mdescRight">Substract 1 from secure counter. <a href="#ga221219026b7aa75e62fdae5f0817e060">More...</a><br/></td></tr>
|
|
<tr class="separator:ga221219026b7aa75e62fdae5f0817e060"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadeaa25e4a710c3b8a399893e4475ea3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gadeaa25e4a710c3b8a399893e4475ea3d">CDOG_Sub16</a> (CDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:gadeaa25e4a710c3b8a399893e4475ea3d"><td class="mdescLeft"> </td><td class="mdescRight">Substract 16 from secure counter. <a href="#gadeaa25e4a710c3b8a399893e4475ea3d">More...</a><br/></td></tr>
|
|
<tr class="separator:gadeaa25e4a710c3b8a399893e4475ea3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabc9b653f49f180236b0cae7b81214d45"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gabc9b653f49f180236b0cae7b81214d45">CDOG_Sub256</a> (CDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:gabc9b653f49f180236b0cae7b81214d45"><td class="mdescLeft"> </td><td class="mdescRight">Substract 256 from secure counter. <a href="#gabc9b653f49f180236b0cae7b81214d45">More...</a><br/></td></tr>
|
|
<tr class="separator:gabc9b653f49f180236b0cae7b81214d45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaadce7ce383df224fdac0402f9b762704"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gaadce7ce383df224fdac0402f9b762704">CDOG_WritePersistent</a> (CDOG_Type *base, uint32_t value)</td></tr>
|
|
<tr class="memdesc:gaadce7ce383df224fdac0402f9b762704"><td class="mdescLeft"> </td><td class="mdescRight">Set the CDOG persistent word. <a href="#gaadce7ce383df224fdac0402f9b762704">More...</a><br/></td></tr>
|
|
<tr class="separator:gaadce7ce383df224fdac0402f9b762704"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac586d4be2c90c82c143908606f140720"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00212.html#gac586d4be2c90c82c143908606f140720">CDOG_ReadPersistent</a> (CDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:gac586d4be2c90c82c143908606f140720"><td class="mdescLeft"> </td><td class="mdescRight">Get the CDOG persistent word. <a href="#gac586d4be2c90c82c143908606f140720">More...</a><br/></td></tr>
|
|
<tr class="separator:gac586d4be2c90c82c143908606f140720"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga6177d00be246704f21b511833adc3c62"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_CDOG_DRIVER_VERSION   (<a class="el" href="a00017.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 1, 0))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Change log:</p>
|
|
<ul>
|
|
<li>Version 2.1.0<ul>
|
|
<li>Rename CWT to CDOG</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.0.2<ul>
|
|
<li>Fix MISRA-2012 issues</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.0.1<ul>
|
|
<li>Fix doxygen issues</li>
|
|
</ul>
|
|
</li>
|
|
<li>Version 2.0.0<ul>
|
|
<li>initial version </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gad3ac1272485f8a213c8f5d86f490fbd1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="a00178.html#gaaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> CDOG_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">cdog_config_t * </td>
|
|
<td class="paramname"><em>conf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initializes CDOG block and setting.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address </td></tr>
|
|
<tr><td class="paramname">conf</td><td>CDOG configuration structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Status of the init operation </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga23a9da6cedfbc35917a53bfd572d8cc8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function deinitializes CDOG secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga65997f42e3cecb1e42f3f2277a17b2a1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_GetDefaultConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">cdog_config_t * </td>
|
|
<td class="paramname"><em>conf</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function initialize CDOG config structure to default values.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">conf</td><td>CDOG configuration structure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaaafb31433cf79df6e9c9d8b162f81f43"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Stop </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>stop</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function stops instruction timer and secure counter. This also change state od CDOG to IDLE.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address </td></tr>
|
|
<tr><td class="paramname">stop</td><td>expected value which will be compared with value of secure counter </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa28a2bc263bc676bd8738d820ad5261c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Start </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>reload</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function sets value in RELOAD and START registers for instruction timer and secure counter</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address </td></tr>
|
|
<tr><td class="paramname">reload</td><td>reload value </td></tr>
|
|
<tr><td class="paramname">start</td><td>start value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga494819d0aecc6caef10d321563e53d96"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Check </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>check</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function compares stop value in handler with secure counter value by writting to RELOAD refister.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address </td></tr>
|
|
<tr><td class="paramname">check</td><td>expected (stop) value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga0d7b74edaf54b436965a9e25fbba367b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Set </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>stop</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>reload</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>start</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function sets value in STOP, RELOAD and START registers for instruction timer and secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address </td></tr>
|
|
<tr><td class="paramname">stop</td><td>expected value which will be compared with value of secure counter </td></tr>
|
|
<tr><td class="paramname">reload</td><td>reload value for instruction timer </td></tr>
|
|
<tr><td class="paramname">start</td><td>start value for secure timer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf3dc568c4e9c5e5afa34627bb9d4d861"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Add </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>add</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function add specified value to secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
<tr><td class="paramname">add</td><td>Value to be added. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1025b0056d78f8fb7eb4ef727689a7a8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Add1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function add 1 to secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga94095b09120ff9fcacec54fa55a3c0c7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Add16 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function add 16 to secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac186ecfa0ef19f7de831f75848b9d00d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Add256 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function add 256 to secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf3d6d6d5670269994c1d780985688157"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Sub </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>sub</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function substract specified value to secure counter.</p>
|
|
<p>param base CDOG peripheral base address. param sub Value to be substracted. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga221219026b7aa75e62fdae5f0817e060"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Sub1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function substract specified 1 from secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gadeaa25e4a710c3b8a399893e4475ea3d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Sub16 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function substract specified 16 from secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabc9b653f49f180236b0cae7b81214d45"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_Sub256 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function substract specified 256 from secure counter.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaadce7ce383df224fdac0402f9b762704"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void CDOG_WritePersistent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
<tr><td class="paramname">value</td><td>The value to be written. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac586d4be2c90c82c143908606f140720"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t CDOG_ReadPersistent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">CDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>CDOG peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The persistent word. </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>
|