1009 lines
52 KiB
HTML
1009 lines
52 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: WDOG32 Peripheral driver</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__wdog32__driver.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> </div>
|
|
<div class="headertitle">
|
|
<div class="title">WDOG32 Peripheral driver<div class="ingroups"><a class="el" href="group__wdog32.html">Watchdog Timer (WDOG32)</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for WDOG32 Peripheral driver:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<center><table><tr><td><div class="center"><iframe scrolling="no" frameborder="0" src="group__wdog32__driver.svg" width="419" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
</td></tr></table></center>
|
|
</div>
|
|
<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:structwdog32__work__mode__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#structwdog32__work__mode__t">wdog32_work_mode_t</a></td></tr>
|
|
<tr class="memdesc:structwdog32__work__mode__t"><td class="mdescLeft"> </td><td class="mdescRight">Defines WDOG32 work mode. <a href="group__wdog32__driver.html#structwdog32__work__mode__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structwdog32__work__mode__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:structwdog32__config__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#structwdog32__config__t">wdog32_config_t</a></td></tr>
|
|
<tr class="memdesc:structwdog32__config__t"><td class="mdescLeft"> </td><td class="mdescRight">Describes WDOG32 configuration structure. <a href="group__wdog32__driver.html#structwdog32__config__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structwdog32__config__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:gaf2723218d3b5f72fe2078c79ae89e22b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#gaf2723218d3b5f72fe2078c79ae89e22b">wdog32_clock_source_t</a> { <br />
|
|
  <a class="el" href="group__wdog32__driver.html#ggaf2723218d3b5f72fe2078c79ae89e22ba29116f214e8508c4b2bb4ba7bcb5fac0">kWDOG32_ClockSource0</a> = 0U,
|
|
<br />
|
|
  <a class="el" href="group__wdog32__driver.html#ggaf2723218d3b5f72fe2078c79ae89e22bae9745d6cb2fb57147140688d9e5d1857">kWDOG32_ClockSource1</a> = 1U,
|
|
<br />
|
|
  <a class="el" href="group__wdog32__driver.html#ggaf2723218d3b5f72fe2078c79ae89e22ba3d49c034db28ff04c7f3bf00d7b61eb2">kWDOG32_ClockSource2</a> = 2U,
|
|
<br />
|
|
  <a class="el" href="group__wdog32__driver.html#ggaf2723218d3b5f72fe2078c79ae89e22ba1bd8755307385dc989ed7eac9d07239b">kWDOG32_ClockSource3</a> = 3U
|
|
<br />
|
|
}<tr class="memdesc:gaf2723218d3b5f72fe2078c79ae89e22b"><td class="mdescLeft"> </td><td class="mdescRight">Describes WDOG32 clock source. <a href="group__wdog32__driver.html#gaf2723218d3b5f72fe2078c79ae89e22b">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gaf2723218d3b5f72fe2078c79ae89e22b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga647d4707383f8a5c5b94531e04f9cfeb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga647d4707383f8a5c5b94531e04f9cfeb">wdog32_clock_prescaler_t</a> { <br />
|
|
  <a class="el" href="group__wdog32__driver.html#gga647d4707383f8a5c5b94531e04f9cfebaddc9f46aa2fe0154abb987f98151de1f">kWDOG32_ClockPrescalerDivide1</a> = 0x0U,
|
|
<br />
|
|
  <a class="el" href="group__wdog32__driver.html#gga647d4707383f8a5c5b94531e04f9cfeba138c782b99d7a3f6fc43d46833e4c451">kWDOG32_ClockPrescalerDivide256</a> = 0x1U
|
|
<br />
|
|
}<tr class="memdesc:ga647d4707383f8a5c5b94531e04f9cfeb"><td class="mdescLeft"> </td><td class="mdescRight">Describes the selection of the clock prescaler. <a href="group__wdog32__driver.html#ga647d4707383f8a5c5b94531e04f9cfeb">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga647d4707383f8a5c5b94531e04f9cfeb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga963073f1cb4719d64f4d491bebdde9d9"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga963073f1cb4719d64f4d491bebdde9d9">wdog32_test_mode_t</a> { <br />
|
|
  <a class="el" href="group__wdog32__driver.html#gga963073f1cb4719d64f4d491bebdde9d9a10dd0cd97f64cdcbb846ac489ec5bc99">kWDOG32_TestModeDisabled</a> = 0U,
|
|
<br />
|
|
  <a class="el" href="group__wdog32__driver.html#gga963073f1cb4719d64f4d491bebdde9d9a9e08cae085e373ad7a215ec8ee7b2bc3">kWDOG32_UserModeEnabled</a> = 1U,
|
|
<br />
|
|
  <a class="el" href="group__wdog32__driver.html#gga963073f1cb4719d64f4d491bebdde9d9a48ae5f6b0527dbcf54c460e2cbc4f260">kWDOG32_LowByteTest</a> = 2U,
|
|
<br />
|
|
  <a class="el" href="group__wdog32__driver.html#gga963073f1cb4719d64f4d491bebdde9d9a7a27a5128ac2a2bb1a1af3a8afadc3fa">kWDOG32_HighByteTest</a> = 3U
|
|
<br />
|
|
}<tr class="memdesc:ga963073f1cb4719d64f4d491bebdde9d9"><td class="mdescLeft"> </td><td class="mdescRight">Describes WDOG32 test mode. <a href="group__wdog32__driver.html#ga963073f1cb4719d64f4d491bebdde9d9">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga963073f1cb4719d64f4d491bebdde9d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabf259a6d842f0d6f4a5a24618e6b6ed4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#gabf259a6d842f0d6f4a5a24618e6b6ed4">_wdog32_interrupt_enable_t</a> { <a class="el" href="group__wdog32__driver.html#ggabf259a6d842f0d6f4a5a24618e6b6ed4ae2a2e7d4a8c554ecad8fbcab0b787c1d">kWDOG32_InterruptEnable</a> = WDOG_CS_INT_MASK
|
|
}<tr class="memdesc:gabf259a6d842f0d6f4a5a24618e6b6ed4"><td class="mdescLeft"> </td><td class="mdescRight">WDOG32 interrupt configuration structure. <a href="group__wdog32__driver.html#gabf259a6d842f0d6f4a5a24618e6b6ed4">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gabf259a6d842f0d6f4a5a24618e6b6ed4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa02da70d359406657bcf92b4040eeeda"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#gaa02da70d359406657bcf92b4040eeeda">_wdog32_status_flags_t</a> { <br />
|
|
  <a class="el" href="group__wdog32__driver.html#ggaa02da70d359406657bcf92b4040eeedaac711f02ae4bc6b2421e4f1b46b171585">kWDOG32_RunningFlag</a> = WDOG_CS_EN_MASK,
|
|
<br />
|
|
  <a class="el" href="group__wdog32__driver.html#ggaa02da70d359406657bcf92b4040eeedaae0eb7ffaae9ae933dc700fd78d556d32">kWDOG32_InterruptFlag</a> = WDOG_CS_FLG_MASK
|
|
<br />
|
|
}<tr class="memdesc:gaa02da70d359406657bcf92b4040eeeda"><td class="mdescLeft"> </td><td class="mdescRight">WDOG32 status flags. <a href="group__wdog32__driver.html#gaa02da70d359406657bcf92b4040eeeda">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:gaa02da70d359406657bcf92b4040eeeda"><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>
|
|
WDOG32 Initialization and De-initialization</h2></td></tr>
|
|
<tr class="memitem:ga2a600d8293c406750156e0555e9f977f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga2a600d8293c406750156e0555e9f977f">WDOG32_GetDefaultConfig</a> (<a class="el" href="group__wdog32__driver.html#structwdog32__config__t">wdog32_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga2a600d8293c406750156e0555e9f977f"><td class="mdescLeft"> </td><td class="mdescRight">Initializes WDOG32 configure sturcture. <a href="#ga2a600d8293c406750156e0555e9f977f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga2a600d8293c406750156e0555e9f977f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga837e5f59db9b58e0f66a947193b30545"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga837e5f59db9b58e0f66a947193b30545">WDOG32_Init</a> (WDOG_Type *base, const <a class="el" href="group__wdog32__driver.html#structwdog32__config__t">wdog32_config_t</a> *config)</td></tr>
|
|
<tr class="memdesc:ga837e5f59db9b58e0f66a947193b30545"><td class="mdescLeft"> </td><td class="mdescRight">Initializes WDOG32 module. <a href="#ga837e5f59db9b58e0f66a947193b30545">More...</a><br /></td></tr>
|
|
<tr class="separator:ga837e5f59db9b58e0f66a947193b30545"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga711412b5690c1af272b7f2268c195bcf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga711412b5690c1af272b7f2268c195bcf">WDOG32_Deinit</a> (WDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:ga711412b5690c1af272b7f2268c195bcf"><td class="mdescLeft"> </td><td class="mdescRight">De-initializes WDOG32 module. <a href="#ga711412b5690c1af272b7f2268c195bcf">More...</a><br /></td></tr>
|
|
<tr class="separator:ga711412b5690c1af272b7f2268c195bcf"><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>
|
|
WDOG32 functional Operation</h2></td></tr>
|
|
<tr class="memitem:gac18738c9218bd388b17e7a06a18bfe76"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#gac18738c9218bd388b17e7a06a18bfe76">WDOG32_Enable</a> (WDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:gac18738c9218bd388b17e7a06a18bfe76"><td class="mdescLeft"> </td><td class="mdescRight">Enables WDOG32 module. <a href="#gac18738c9218bd388b17e7a06a18bfe76">More...</a><br /></td></tr>
|
|
<tr class="separator:gac18738c9218bd388b17e7a06a18bfe76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7d75f999c264684f1e9fae505b46a1bb"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga7d75f999c264684f1e9fae505b46a1bb">WDOG32_Disable</a> (WDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:ga7d75f999c264684f1e9fae505b46a1bb"><td class="mdescLeft"> </td><td class="mdescRight">Disables WDOG32 module. <a href="#ga7d75f999c264684f1e9fae505b46a1bb">More...</a><br /></td></tr>
|
|
<tr class="separator:ga7d75f999c264684f1e9fae505b46a1bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga26b948af4b2cd355a84f6be5eef28bfb"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga26b948af4b2cd355a84f6be5eef28bfb">WDOG32_EnableInterrupts</a> (WDOG_Type *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:ga26b948af4b2cd355a84f6be5eef28bfb"><td class="mdescLeft"> </td><td class="mdescRight">Enable WDOG32 interrupt. <a href="#ga26b948af4b2cd355a84f6be5eef28bfb">More...</a><br /></td></tr>
|
|
<tr class="separator:ga26b948af4b2cd355a84f6be5eef28bfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1286eefacd910a3969467009cf17898a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga1286eefacd910a3969467009cf17898a">WDOG32_DisableInterrupts</a> (WDOG_Type *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:ga1286eefacd910a3969467009cf17898a"><td class="mdescLeft"> </td><td class="mdescRight">Disable WDOG32 interrupt. <a href="#ga1286eefacd910a3969467009cf17898a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1286eefacd910a3969467009cf17898a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab07fbef1aa1e270d91a8901838a97874"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#gab07fbef1aa1e270d91a8901838a97874">WDOG32_GetStatusFlags</a> (WDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:gab07fbef1aa1e270d91a8901838a97874"><td class="mdescLeft"> </td><td class="mdescRight">Gets WDOG32 all status flags. <a href="#gab07fbef1aa1e270d91a8901838a97874">More...</a><br /></td></tr>
|
|
<tr class="separator:gab07fbef1aa1e270d91a8901838a97874"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga03293e4e343c1575b0fc268495826df0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga03293e4e343c1575b0fc268495826df0">WDOG32_ClearStatusFlags</a> (WDOG_Type *base, uint32_t mask)</td></tr>
|
|
<tr class="memdesc:ga03293e4e343c1575b0fc268495826df0"><td class="mdescLeft"> </td><td class="mdescRight">Clear WDOG32 flag. <a href="#ga03293e4e343c1575b0fc268495826df0">More...</a><br /></td></tr>
|
|
<tr class="separator:ga03293e4e343c1575b0fc268495826df0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1ef0b008ebaa73c970c59ab137dd1a90"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga1ef0b008ebaa73c970c59ab137dd1a90">WDOG32_SetTimeoutValue</a> (WDOG_Type *base, uint16_t timeoutCount)</td></tr>
|
|
<tr class="memdesc:ga1ef0b008ebaa73c970c59ab137dd1a90"><td class="mdescLeft"> </td><td class="mdescRight">Set the WDOG32 timeout value. <a href="#ga1ef0b008ebaa73c970c59ab137dd1a90">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1ef0b008ebaa73c970c59ab137dd1a90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad8c157a7b65816812c4495900c2fac3a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#gad8c157a7b65816812c4495900c2fac3a">WDOG32_SetWindowValue</a> (WDOG_Type *base, uint16_t windowValue)</td></tr>
|
|
<tr class="memdesc:gad8c157a7b65816812c4495900c2fac3a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the WDOG32 window value. <a href="#gad8c157a7b65816812c4495900c2fac3a">More...</a><br /></td></tr>
|
|
<tr class="separator:gad8c157a7b65816812c4495900c2fac3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafd05cb0371d88492e0c9ce285e002385"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#gafd05cb0371d88492e0c9ce285e002385">WDOG32_Unlock</a> (WDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:gafd05cb0371d88492e0c9ce285e002385"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the WDOG32 register written. <a href="#gafd05cb0371d88492e0c9ce285e002385">More...</a><br /></td></tr>
|
|
<tr class="separator:gafd05cb0371d88492e0c9ce285e002385"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8cd48b61083e47080be856ae46a27374"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#ga8cd48b61083e47080be856ae46a27374">WDOG32_Refresh</a> (WDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:ga8cd48b61083e47080be856ae46a27374"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes the WDOG32 timer. <a href="#ga8cd48b61083e47080be856ae46a27374">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8cd48b61083e47080be856ae46a27374"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac51b0779cc8980812f1e81d993135c1a"><td class="memItemLeft" align="right" valign="top">static uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wdog32__driver.html#gac51b0779cc8980812f1e81d993135c1a">WDOG32_GetCounterValue</a> (WDOG_Type *base)</td></tr>
|
|
<tr class="memdesc:gac51b0779cc8980812f1e81d993135c1a"><td class="mdescLeft"> </td><td class="mdescRight">Gets WDOG32 counter value. <a href="#gac51b0779cc8980812f1e81d993135c1a">More...</a><br /></td></tr>
|
|
<tr class="separator:gac51b0779cc8980812f1e81d993135c1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Usage Information</h2>
|
|
<p>This section describes the programming interface of the WDOG32 Peripheral driver. The WDOG32 driver configures the WDOG32 module.</p>
|
|
<h1>Function groups</h1>
|
|
<p>This function group initializes and de-initializes the WDOG32 module.</p>
|
|
<p>This function group implements the WDOG32 functional API.</p>
|
|
<h1>Typical use case</h1>
|
|
<div class="fragment"><div class="line"><a class="code" href="group__wdog32__driver.html#structwdog32__config__t">wdog32_config_t</a> config;</div><div class="line"><a class="code" href="group__wdog32__driver.html#ga2a600d8293c406750156e0555e9f977f">WDOG32_GetDefaultConfig</a>(&config);</div><div class="line">config.<a class="code" href="group__wdog32__driver.html#a22c4a358f4203279c96cf2c97f80b161">timeoutValue</a> = 0x7ffU;</div><div class="line">config.<a class="code" href="group__wdog32__driver.html#a3b75cbf0dcb6c04d40da0d274327d6b3">enableWindowMode</a> = <span class="keyword">true</span>;</div><div class="line">config.<a class="code" href="group__wdog32__driver.html#a1588a4e50daabbf2fd051f9b0a53c940">windowValue</a> = 0x1ffU;</div><div class="line"><a class="code" href="group__wdog32__driver.html#ga837e5f59db9b58e0f66a947193b30545">WDOG32_Init</a>(wdog_base,&config);</div></div><!-- fragment --> <hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="structwdog32__work__mode__t" id="structwdog32__work__mode__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct wdog32_work_mode_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Defines WDOG32 work mode. </p>
|
|
</div><table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a781add6fc841d6a087b5059e76e90397"></a>bool</td>
|
|
<td class="fieldname">
|
|
enableDebug</td>
|
|
<td class="fielddoc">
|
|
<p>Enables or disables WDOG32 in debug mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a6d01cabee46c0fbcd4a0a211d64c94e6"></a>bool</td>
|
|
<td class="fieldname">
|
|
enableStop</td>
|
|
<td class="fielddoc">
|
|
<p>Enables or disables WDOG32 in stop mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="abffdbc6a5a6568ec8e1920e6db344f0b"></a>bool</td>
|
|
<td class="fieldname">
|
|
enableWait</td>
|
|
<td class="fielddoc">
|
|
<p>Enables or disables WDOG32 in wait mode </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a name="structwdog32__config__t" id="structwdog32__config__t"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct wdog32_config_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p>Describes WDOG32 configuration structure. </p>
|
|
</div><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for wdog32_config_t:</div>
|
|
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="structwdog32__config__t__coll__graph.svg" width="162" height="127"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a41e8fbc56ba3b38e33cff9ebcdfbd2ec"></a><a class="el" href="group__wdog32__driver.html#gaf2723218d3b5f72fe2078c79ae89e22b">wdog32_clock_source_t</a></td>
|
|
<td class="fieldname">
|
|
clockSource</td>
|
|
<td class="fielddoc">
|
|
<p>Clock source select </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a8e62a017edb6e38406cfb90bd212102f"></a>bool</td>
|
|
<td class="fieldname">
|
|
enableInterrupt</td>
|
|
<td class="fielddoc">
|
|
<p>Enables or disables WDOG32 interrupt </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a9a572a3a75273d14f43a8764fcf1d46b"></a>bool</td>
|
|
<td class="fieldname">
|
|
enableUpdate</td>
|
|
<td class="fielddoc">
|
|
<p>Update write-once register enable </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="ade7ed0afaba7606227956a790ed84b0d"></a>bool</td>
|
|
<td class="fieldname">
|
|
enableWdog32</td>
|
|
<td class="fielddoc">
|
|
<p>Enables or disables WDOG32 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a3b75cbf0dcb6c04d40da0d274327d6b3"></a>bool</td>
|
|
<td class="fieldname">
|
|
enableWindowMode</td>
|
|
<td class="fielddoc">
|
|
<p>Enables or disables WDOG32 window mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a7c23a2418f0c7c3010552416dc3beede"></a><a class="el" href="group__wdog32__driver.html#ga647d4707383f8a5c5b94531e04f9cfeb">wdog32_clock_prescaler_t</a></td>
|
|
<td class="fieldname">
|
|
prescaler</td>
|
|
<td class="fielddoc">
|
|
<p>Clock prescaler value </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="aa39901e12cb69bd552089a38ed0a70e1"></a><a class="el" href="group__wdog32__driver.html#ga963073f1cb4719d64f4d491bebdde9d9">wdog32_test_mode_t</a></td>
|
|
<td class="fieldname">
|
|
testMode</td>
|
|
<td class="fielddoc">
|
|
<p>Configures WDOG32 test mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a22c4a358f4203279c96cf2c97f80b161"></a>uint16_t</td>
|
|
<td class="fieldname">
|
|
timeoutValue</td>
|
|
<td class="fielddoc">
|
|
<p>Timeout value </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="a1588a4e50daabbf2fd051f9b0a53c940"></a>uint16_t</td>
|
|
<td class="fieldname">
|
|
windowValue</td>
|
|
<td class="fielddoc">
|
|
<p>Window value </p>
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a class="anchor" id="abffa8883b729b2728e12e212e4687943"></a><a class="el" href="group__wdog32__driver.html#structwdog32__work__mode__t">wdog32_work_mode_t</a></td>
|
|
<td class="fieldname">
|
|
workMode</td>
|
|
<td class="fielddoc">
|
|
<p>Configures WDOG32 work mode in debug stop and wait mode </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="gabf259a6d842f0d6f4a5a24618e6b6ed4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__wdog32__driver.html#gabf259a6d842f0d6f4a5a24618e6b6ed4">_wdog32_interrupt_enable_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>WDOG32 interrupt configuration structure. </p>
|
|
<p>This structure contains the settings for all of the WDOG32 interrupt configurations. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggabf259a6d842f0d6f4a5a24618e6b6ed4ae2a2e7d4a8c554ecad8fbcab0b787c1d"></a>kWDOG32_InterruptEnable </td><td class="fielddoc">
|
|
<p>Interrupt will be generated before forcing a reset </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa02da70d359406657bcf92b4040eeeda"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__wdog32__driver.html#gaa02da70d359406657bcf92b4040eeeda">_wdog32_status_flags_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>WDOG32 status flags. </p>
|
|
<p>This structure contains the WDOG32 status flags for use in the WDOG32 functions. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaa02da70d359406657bcf92b4040eeedaac711f02ae4bc6b2421e4f1b46b171585"></a>kWDOG32_RunningFlag </td><td class="fielddoc">
|
|
<p>Running flag, set when WDOG32 is enabled </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaa02da70d359406657bcf92b4040eeedaae0eb7ffaae9ae933dc700fd78d556d32"></a>kWDOG32_InterruptFlag </td><td class="fielddoc">
|
|
<p>Interrupt flag, set when interrupt occurs </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga647d4707383f8a5c5b94531e04f9cfeb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__wdog32__driver.html#ga647d4707383f8a5c5b94531e04f9cfeb">wdog32_clock_prescaler_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes the selection of the clock prescaler. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga647d4707383f8a5c5b94531e04f9cfebaddc9f46aa2fe0154abb987f98151de1f"></a>kWDOG32_ClockPrescalerDivide1 </td><td class="fielddoc">
|
|
<p>Divided by 1 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga647d4707383f8a5c5b94531e04f9cfeba138c782b99d7a3f6fc43d46833e4c451"></a>kWDOG32_ClockPrescalerDivide256 </td><td class="fielddoc">
|
|
<p>Divided by 256 </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf2723218d3b5f72fe2078c79ae89e22b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__wdog32__driver.html#gaf2723218d3b5f72fe2078c79ae89e22b">wdog32_clock_source_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes WDOG32 clock source. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaf2723218d3b5f72fe2078c79ae89e22ba29116f214e8508c4b2bb4ba7bcb5fac0"></a>kWDOG32_ClockSource0 </td><td class="fielddoc">
|
|
<p>Clock source 0 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaf2723218d3b5f72fe2078c79ae89e22bae9745d6cb2fb57147140688d9e5d1857"></a>kWDOG32_ClockSource1 </td><td class="fielddoc">
|
|
<p>Clock source 1 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaf2723218d3b5f72fe2078c79ae89e22ba3d49c034db28ff04c7f3bf00d7b61eb2"></a>kWDOG32_ClockSource2 </td><td class="fielddoc">
|
|
<p>Clock source 2 </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="ggaf2723218d3b5f72fe2078c79ae89e22ba1bd8755307385dc989ed7eac9d07239b"></a>kWDOG32_ClockSource3 </td><td class="fielddoc">
|
|
<p>Clock source 3 </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga963073f1cb4719d64f4d491bebdde9d9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__wdog32__driver.html#ga963073f1cb4719d64f4d491bebdde9d9">wdog32_test_mode_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Describes WDOG32 test mode. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga963073f1cb4719d64f4d491bebdde9d9a10dd0cd97f64cdcbb846ac489ec5bc99"></a>kWDOG32_TestModeDisabled </td><td class="fielddoc">
|
|
<p>Test Mode diabled </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga963073f1cb4719d64f4d491bebdde9d9a9e08cae085e373ad7a215ec8ee7b2bc3"></a>kWDOG32_UserModeEnabled </td><td class="fielddoc">
|
|
<p>User Mode enabled </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga963073f1cb4719d64f4d491bebdde9d9a48ae5f6b0527dbcf54c460e2cbc4f260"></a>kWDOG32_LowByteTest </td><td class="fielddoc">
|
|
<p>Test Mode enabled, only low byte is used </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a class="anchor" id="gga963073f1cb4719d64f4d491bebdde9d9a7a27a5128ac2a2bb1a1af3a8afadc3fa"></a>kWDOG32_HighByteTest </td><td class="fielddoc">
|
|
<p>Test Mode enabled, only high byte is used </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga03293e4e343c1575b0fc268495826df0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void WDOG32_ClearStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_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>mask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear WDOG32 flag. </p>
|
|
<p>This function clears WDOG32 status flag.</p>
|
|
<p>Example for clearing interrupt flag: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> WDOG32_ClearStatusFlags(wdog_base,kWDOG32_InterruptFlag);</div></div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
<tr><td class="paramname">mask</td><td>The status flags to clear. The parameter could be any combination of the following values: <ul>
|
|
<li>kWDOG32_InterruptFlag </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga711412b5690c1af272b7f2268c195bcf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void WDOG32_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>De-initializes WDOG32 module. </p>
|
|
<p>This function shuts down the WDOG32. Make sure that the WDOG_CS.UPDATE is 1 which means that the register update is enabled.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7d75f999c264684f1e9fae505b46a1bb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void WDOG32_Disable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables WDOG32 module. </p>
|
|
<p>This function write value into WDOG_CS register to disable WDOG32. WDOG_CS register is a write-once register, make sure the WCT window is still open and this register has not been written in this WCT while this function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1286eefacd910a3969467009cf17898a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void WDOG32_DisableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_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>mask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disable WDOG32 interrupt. </p>
|
|
<p>This function write value into WDOG_CS register to disable the WDOG32 interrupt. WDOG_CS register is a write-once register, make sure the WCT window is still open and this register has not been written in this WCT while this function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
<tr><td class="paramname">mask</td><td>The interrupts to disable The parameter can be combination of the following source if defined: <ul>
|
|
<li>kWDOG32_InterruptEnable </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac18738c9218bd388b17e7a06a18bfe76"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void WDOG32_Enable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables WDOG32 module. </p>
|
|
<p>This function write value into WDOG_CS register to enable WDOG32. WDOG_CS register is a write-once register, make sure the WCT window is still open and this register has not been written in this WCT while this function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga26b948af4b2cd355a84f6be5eef28bfb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void WDOG32_EnableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_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>mask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable WDOG32 interrupt. </p>
|
|
<p>This function write value into WDOG_CS register to enable the WDOG32 interrupt. WDOG_CS register is a write-once register, make sure the WCT window is still open and this register has not been written in this WCT while this function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
<tr><td class="paramname">mask</td><td>The interrupts to enable The parameter can be combination of the following source if defined: <ul>
|
|
<li>kWDOG32_InterruptEnable </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac51b0779cc8980812f1e81d993135c1a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static uint16_t WDOG32_GetCounterValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets WDOG32 counter value. </p>
|
|
<p>This function gets the WDOG32 counter value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current WDOG32 counter value </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2a600d8293c406750156e0555e9f977f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void WDOG32_GetDefaultConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__wdog32__driver.html#structwdog32__config__t">wdog32_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes WDOG32 configure sturcture. </p>
|
|
<p>This function initializes the WDOG32 configure structure to default value. The default value are: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> wdog32Config->enableWdog32 = true;</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> wdog32Config->clockSource = kWDOG32_ClockSource1;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> wdog32Config->prescaler = kWDOG32_ClockPrescalerDivide1;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> wdog32Config->workMode.enableWait = true;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> wdog32Config->workMode.enableStop = false;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> wdog32Config->workMode.enableDebug = false;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> wdog32Config->testMode = kWDOG32_TestModeDisabled;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> wdog32Config->enableUpdate = true;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> wdog32Config->enableInterrupt = false;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> wdog32Config->enableWindowMode = false;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> wdog32Config->windowValue = 0U;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> wdog32Config->timeoutValue = 0xFFFFU;</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Pointer to WDOG32 config structure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__wdog32__driver.html#structwdog32__config__t" title="Describes WDOG32 configuration structure. ">wdog32_config_t</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gab07fbef1aa1e270d91a8901838a97874"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t WDOG32_GetStatusFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets WDOG32 all status flags. </p>
|
|
<p>This function gets all status flags.</p>
|
|
<p>Example for getting Running Flag: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> uint32_t status;</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> status = WDOG32_GetStatusFlags(wdog_base) & kWDOG32_RunningFlag;</div></div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>State of the status flag: asserted (true) or not-asserted (false).</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__wdog32__driver.html#gaa02da70d359406657bcf92b4040eeeda" title="WDOG32 status flags. ">_wdog32_status_flags_t</a><ul>
|
|
<li>true: related status flag has been set.</li>
|
|
<li>false: related status flag is not set. </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga837e5f59db9b58e0f66a947193b30545"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void WDOG32_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="group__wdog32__driver.html#structwdog32__config__t">wdog32_config_t</a> * </td>
|
|
<td class="paramname"><em>config</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes WDOG32 module. </p>
|
|
<p>This function is used to initializes WDOG32. If user wants to reconfigure WDOG32 without forcing a reset first, enableUpdate must be set to true in configuration.</p>
|
|
<p>Example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> wdog32_config_t config;</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> WDOG32_GetDefaultConfig(&config);</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> config.timeoutValue = 0x7ffU;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> config.enableUpdate = true;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> WDOG32_Init(wdog_base,&config);</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
<tr><td class="paramname">config</td><td>The configuration of WDOG32 </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga8cd48b61083e47080be856ae46a27374"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void WDOG32_Refresh </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Refreshes the WDOG32 timer. </p>
|
|
<p>This function feeds the WDOG32. This function should be called before watchdog timer is in timeout. Otherwise, a reset is asserted.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga1ef0b008ebaa73c970c59ab137dd1a90"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void WDOG32_SetTimeoutValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>timeoutCount</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the WDOG32 timeout value. </p>
|
|
<p>This function write timeout value into WDOG_TOVAL register. WDOG_TOVAL register is a write-once register, make sure the WCT window is still open and this register has not been written in this WCT while this function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
<tr><td class="paramname">timeoutCount</td><td>WDOG32 timeout value, count of WDOG32 clock tick. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad8c157a7b65816812c4495900c2fac3a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void WDOG32_SetWindowValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>windowValue</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the WDOG32 window value. </p>
|
|
<p>This function write window value into WDOG_WIN register. WDOG_WIN register is a write-once register, make sure the WCT window is still open and this register has not been written in this WCT while this function is called.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </td></tr>
|
|
<tr><td class="paramname">windowValue</td><td>WDOG32 window value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafd05cb0371d88492e0c9ce285e002385"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void WDOG32_Unlock </td>
|
|
<td>(</td>
|
|
<td class="paramtype">WDOG_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unlocks the WDOG32 register written. </p>
|
|
<p>This function unlocks the WDOG32 register written.</p>
|
|
<p>Before starting the unlock sequence and following congfiguration, disable the global interrupts. Otherwise, an interrupt could effectively invalidate the unlock sequence and the WCT may expire, After the configuration finishes, re-enable the global interrupts.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>WDOG32 peripheral base address </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:23 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>
|