Files
KSDK_2.0_MK22FN512xxx12/docs/Kinetis SDK v.2.0 API Reference Manual/group__llwu.html
2016-08-09 18:06:35 +02:00

236 lines
14 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.6"/>
<title>Kinetis SDK v.2.0 API Reference Manual: LLWU: Low-Leakage Wakeup Unit 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="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">Kinetis SDK v.2.0 API Reference Manual
&#160;<span id="projectnumber">Rev. 0</span>
</div>
<div id="projectbrief">Freescale Semiconductor, Inc.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>API&#160;Reference</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__llwu.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#files">Files</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">LLWU: Low-Leakage Wakeup Unit Driver</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<p>The KSDK provides a Peripheral driver for the Low-Leakage Wakeup Unit (LLWU) module of Kinetis devices. The LLWU module allows the user to select external pin sources and internal modules as a wake-up source from low-leakage power modes.</p>
<h1><a class="anchor" id="LLWUExWkPin"></a>
External wakeup pins configurations</h1>
<p>Configures the external wakeup pins' working modes, gets and clears the wake pin flags. External wakeup pins are accessed by <code>pinIndex</code> which is started from 1. Numbers of external pins depend on the SoC configuration.</p>
<h1><a class="anchor" id="LLWUInWkMdl"></a>
Internal wakeup modules configurations</h1>
<p>Enables/disables the internal wakeup modules, and gets the modules flags. Internal modules are accessed by <code>moduleIndex</code> which is started from 1. Numbers of external pins depend the on SoC configuration.</p>
<h1><a class="anchor" id="LLWUPinFlt"></a>
Digital pin filter for external wakeup pin configurations</h1>
<p>Configures the digital pin filter of the external wakeup pins' working modes, gets and clears the pin filter flags. Digital pins filters are accessed by <code>filterIndex</code> which is started from 1. Numbers of external pins depends on the SoC configuration. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:fsl__llwu_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsl__llwu_8h.html">fsl_llwu.h</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaef7b7f596eb66ea9d825bfd7a05278ea"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__llwu.html#gaef7b7f596eb66ea9d825bfd7a05278ea">llwu_external_pin_mode_t</a> { <br/>
&#160;&#160;<a class="el" href="group__llwu.html#ggaef7b7f596eb66ea9d825bfd7a05278eaa918f72033c61b0e9f5e83585ae76feea">kLLWU_ExternalPinDisable</a> = 0U,
<br/>
&#160;&#160;<a class="el" href="group__llwu.html#ggaef7b7f596eb66ea9d825bfd7a05278eaa3d0358ae5f5e4e420efe998fce1c8b6c">kLLWU_ExternalPinRisingEdge</a> = 1U,
<br/>
&#160;&#160;<a class="el" href="group__llwu.html#ggaef7b7f596eb66ea9d825bfd7a05278eaa2cc310ae58735aeaefe6f8822f2d4e0c">kLLWU_ExternalPinFallingEdge</a> = 2U,
<br/>
&#160;&#160;<a class="el" href="group__llwu.html#ggaef7b7f596eb66ea9d825bfd7a05278eaa576c426077b7cc720ca746f5f1c27fa2">kLLWU_ExternalPinAnyEdge</a> = 3U
<br/>
}</td></tr>
<tr class="memdesc:gaef7b7f596eb66ea9d825bfd7a05278ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">External input pin control modes. <a href="group__llwu.html#gaef7b7f596eb66ea9d825bfd7a05278ea">More...</a><br/></td></tr>
<tr class="separator:gaef7b7f596eb66ea9d825bfd7a05278ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2719c17c108a42ecdf3e8d97d8312d8a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__llwu.html#ga2719c17c108a42ecdf3e8d97d8312d8a">llwu_pin_filter_mode_t</a> { <br/>
&#160;&#160;<a class="el" href="group__llwu.html#gga2719c17c108a42ecdf3e8d97d8312d8aab1efbba59f0416cdb5f11563cbc86f8d">kLLWU_PinFilterDisable</a> = 0U,
<br/>
&#160;&#160;<a class="el" href="group__llwu.html#gga2719c17c108a42ecdf3e8d97d8312d8aa4247bc305c7b3b8c51c9fa54e6f3ab52">kLLWU_PinFilterRisingEdge</a> = 1U,
<br/>
&#160;&#160;<a class="el" href="group__llwu.html#gga2719c17c108a42ecdf3e8d97d8312d8aaf429cb4dfc4343a66429baf2b8971279">kLLWU_PinFilterFallingEdge</a> = 2U,
<br/>
&#160;&#160;<a class="el" href="group__llwu.html#gga2719c17c108a42ecdf3e8d97d8312d8aa9ae5329e7b3fad4d4cdc447ca64c9ad2">kLLWU_PinFilterAnyEdge</a> = 3U
<br/>
}</td></tr>
<tr class="memdesc:ga2719c17c108a42ecdf3e8d97d8312d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Digital filter control modes. <a href="group__llwu.html#ga2719c17c108a42ecdf3e8d97d8312d8a">More...</a><br/></td></tr>
<tr class="separator:ga2719c17c108a42ecdf3e8d97d8312d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Driver version</h2></td></tr>
<tr class="memitem:ga89a3dc773d6a05997c01e407561830b9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__llwu.html#ga89a3dc773d6a05997c01e407561830b9">FSL_LLWU_DRIVER_VERSION</a>&#160;&#160;&#160;(<a class="el" href="group__flash__driver.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 0, 1))</td></tr>
<tr class="memdesc:ga89a3dc773d6a05997c01e407561830b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">LLWU driver version 2.0.1. <a href="#ga89a3dc773d6a05997c01e407561830b9">More...</a><br/></td></tr>
<tr class="separator:ga89a3dc773d6a05997c01e407561830b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga89a3dc773d6a05997c01e407561830b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FSL_LLWU_DRIVER_VERSION&#160;&#160;&#160;(<a class="el" href="group__flash__driver.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 0, 1))</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gaef7b7f596eb66ea9d825bfd7a05278ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__llwu.html#gaef7b7f596eb66ea9d825bfd7a05278ea">llwu_external_pin_mode_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggaef7b7f596eb66ea9d825bfd7a05278eaa918f72033c61b0e9f5e83585ae76feea"></a>kLLWU_ExternalPinDisable</em>&#160;</td><td class="fielddoc">
<p>Pin disabled as wakeup input. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaef7b7f596eb66ea9d825bfd7a05278eaa3d0358ae5f5e4e420efe998fce1c8b6c"></a>kLLWU_ExternalPinRisingEdge</em>&#160;</td><td class="fielddoc">
<p>Pin enabled with rising edge detection. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaef7b7f596eb66ea9d825bfd7a05278eaa2cc310ae58735aeaefe6f8822f2d4e0c"></a>kLLWU_ExternalPinFallingEdge</em>&#160;</td><td class="fielddoc">
<p>Pin enabled with falling edge detection. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggaef7b7f596eb66ea9d825bfd7a05278eaa576c426077b7cc720ca746f5f1c27fa2"></a>kLLWU_ExternalPinAnyEdge</em>&#160;</td><td class="fielddoc">
<p>Pin enabled with any change detection. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga2719c17c108a42ecdf3e8d97d8312d8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__llwu.html#ga2719c17c108a42ecdf3e8d97d8312d8a">llwu_pin_filter_mode_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga2719c17c108a42ecdf3e8d97d8312d8aab1efbba59f0416cdb5f11563cbc86f8d"></a>kLLWU_PinFilterDisable</em>&#160;</td><td class="fielddoc">
<p>Filter disabled. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga2719c17c108a42ecdf3e8d97d8312d8aa4247bc305c7b3b8c51c9fa54e6f3ab52"></a>kLLWU_PinFilterRisingEdge</em>&#160;</td><td class="fielddoc">
<p>Filter positive edge detection. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga2719c17c108a42ecdf3e8d97d8312d8aaf429cb4dfc4343a66429baf2b8971279"></a>kLLWU_PinFilterFallingEdge</em>&#160;</td><td class="fielddoc">
<p>Filter negative edge detection. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga2719c17c108a42ecdf3e8d97d8312d8aa9ae5329e7b3fad4d4cdc447ca64c9ad2"></a>kLLWU_PinFilterAnyEdge</em>&#160;</td><td class="fielddoc">
<p>Filter any edge detection. </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul class="foot">
<li class="footer">&copy; 2016 NXP Semiconductors. All rights reserved.
</li>
</ul>
</div>
</body>
</html>