654 lines
34 KiB
HTML
654 lines
34 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: KPP: KeyPad Port 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">MCUXpresso SDK API Reference Manual
|
|
 <span id="projectnumber">Rev 2.15.000</span>
|
|
</div>
|
|
<div id="projectbrief">NXP Semiconductors</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main 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('a00044.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="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">KPP: KeyPad Port Driver</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
|
|
<p>The MCUXpresso SDK provides a peripheral driver for the KeyPad Port block of MCUXpresso SDK devices.</p>
|
|
<h1>KPP: KeyPad Port Driver</h1>
|
|
<h2>KPP Initialization Operation</h2>
|
|
<p>The KPP Initialize is to initialize for common configure: gate the KPP clock, configure columns, and rows features. The KPP Deinitialize is to ungate the clock.</p>
|
|
<h2>KPP Basic Operation</h2>
|
|
<p>The KPP provide the function to enable/disable interrupts. The KPP provide key press scanning function KPP_keyPressScanning. This API should be called by the Interrupt handler in application. KPP still provides functions to get and clear status flags.</p>
|
|
<h1><a class="anchor" id="KPPTpyUC"></a>
|
|
Typical use case</h1>
|
|
<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:a00408"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a00408">_kpp_config</a></td></tr>
|
|
<tr class="memdesc:a00408"><td class="mdescLeft"> </td><td class="mdescRight">Lists of KPP status. <a href="a00044.html#a00408">More...</a><br/></td></tr>
|
|
<tr class="separator:a00408"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga750601427065c87c4daf8fc07091d039"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00044.html#ga8c6f14f0861416aab52182b088863d5b">_kpp_interrupt_enable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga750601427065c87c4daf8fc07091d039">kpp_interrupt_enable_t</a></td></tr>
|
|
<tr class="memdesc:ga750601427065c87c4daf8fc07091d039"><td class="mdescLeft"> </td><td class="mdescRight">List of interrupts supported by the peripheral. <a href="#ga750601427065c87c4daf8fc07091d039">More...</a><br/></td></tr>
|
|
<tr class="separator:ga750601427065c87c4daf8fc07091d039"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5c752eb676c0517a7cd9bfc52e4744aa"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="a00044.html#gafab0e664fb713522de61aa4907426ca3">_kpp_sync_operation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga5c752eb676c0517a7cd9bfc52e4744aa">kpp_sync_operation_t</a></td></tr>
|
|
<tr class="memdesc:ga5c752eb676c0517a7cd9bfc52e4744aa"><td class="mdescLeft"> </td><td class="mdescRight">Lists of KPP synchronize chain operation. <a href="#ga5c752eb676c0517a7cd9bfc52e4744aa">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5c752eb676c0517a7cd9bfc52e4744aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf36399349f3826313f180a4798ac3275"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00044.html#a00408">_kpp_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gaf36399349f3826313f180a4798ac3275">kpp_config_t</a></td></tr>
|
|
<tr class="memdesc:gaf36399349f3826313f180a4798ac3275"><td class="mdescLeft"> </td><td class="mdescRight">Lists of KPP status. <a href="#gaf36399349f3826313f180a4798ac3275">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf36399349f3826313f180a4798ac3275"><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:ga8c6f14f0861416aab52182b088863d5b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga8c6f14f0861416aab52182b088863d5b">_kpp_interrupt_enable</a> { <br/>
|
|
  <a class="el" href="a00044.html#gga8c6f14f0861416aab52182b088863d5bab4f673ab2f4dfc055981eed98465d8b2">kKPP_keyDepressInterrupt</a> = KPP_KPSR_KDIE_MASK,
|
|
<br/>
|
|
  <a class="el" href="a00044.html#gga8c6f14f0861416aab52182b088863d5ba760b827e5a10ba43afac4c5a5f4449df">kKPP_keyReleaseInterrupt</a> = KPP_KPSR_KRIE_MASK
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga8c6f14f0861416aab52182b088863d5b"><td class="mdescLeft"> </td><td class="mdescRight">List of interrupts supported by the peripheral. <a href="a00044.html#ga8c6f14f0861416aab52182b088863d5b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga8c6f14f0861416aab52182b088863d5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafab0e664fb713522de61aa4907426ca3"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gafab0e664fb713522de61aa4907426ca3">_kpp_sync_operation</a> { <br/>
|
|
  <a class="el" href="a00044.html#ggafab0e664fb713522de61aa4907426ca3a362de7775b6d24295feddbb8cc93550b">kKPP_ClearKeyDepressSyncChain</a> = KPP_KPSR_KDSC_MASK,
|
|
<br/>
|
|
  <a class="el" href="a00044.html#ggafab0e664fb713522de61aa4907426ca3a2938765c6adf7fcf5128895478876aa5">kKPP_SetKeyReleasesSyncChain</a> = KPP_KPSR_KRSS_MASK
|
|
<br/>
|
|
}</td></tr>
|
|
<tr class="memdesc:gafab0e664fb713522de61aa4907426ca3"><td class="mdescLeft"> </td><td class="mdescRight">Lists of KPP synchronize chain operation. <a href="a00044.html#gafab0e664fb713522de61aa4907426ca3">More...</a><br/></td></tr>
|
|
<tr class="separator:gafab0e664fb713522de61aa4907426ca3"><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:ga35c20878a9d0b578ca2bbf50d98666a8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga35c20878a9d0b578ca2bbf50d98666a8">FSL_KPP_DRIVER_VERSION</a>   (<a class="el" href="a00260.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 0, 0))</td></tr>
|
|
<tr class="memdesc:ga35c20878a9d0b578ca2bbf50d98666a8"><td class="mdescLeft"> </td><td class="mdescRight">KPP driver version 2.0.0. <a href="#ga35c20878a9d0b578ca2bbf50d98666a8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga35c20878a9d0b578ca2bbf50d98666a8"><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>
|
|
Initialization and De-initialization</h2></td></tr>
|
|
<tr class="memitem:ga773203cef9b50a6c5864f78c05cb0c83"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga773203cef9b50a6c5864f78c05cb0c83">KPP_Init</a> (KPP_Type *base, <a class="el" href="a00044.html#gaf36399349f3826313f180a4798ac3275">kpp_config_t</a> *configure)</td></tr>
|
|
<tr class="memdesc:ga773203cef9b50a6c5864f78c05cb0c83"><td class="mdescLeft"> </td><td class="mdescRight">KPP initialize. <a href="#ga773203cef9b50a6c5864f78c05cb0c83">More...</a><br/></td></tr>
|
|
<tr class="separator:ga773203cef9b50a6c5864f78c05cb0c83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga910f3aec15296a1d993f9b4963a152fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga910f3aec15296a1d993f9b4963a152fd">KPP_Deinit</a> (KPP_Type *base)</td></tr>
|
|
<tr class="memdesc:ga910f3aec15296a1d993f9b4963a152fd"><td class="mdescLeft"> </td><td class="mdescRight">Deinitializes the KPP module and gates the clock. <a href="#ga910f3aec15296a1d993f9b4963a152fd">More...</a><br/></td></tr>
|
|
<tr class="separator:ga910f3aec15296a1d993f9b4963a152fd"><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>
|
|
KPP Basic Operation</h2></td></tr>
|
|
<tr class="memitem:ga4d8bc3929af0678c182047884c50f7db"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga4d8bc3929af0678c182047884c50f7db">KPP_EnableInterrupts</a> (KPP_Type *base, uint16_t mask)</td></tr>
|
|
<tr class="memdesc:ga4d8bc3929af0678c182047884c50f7db"><td class="mdescLeft"> </td><td class="mdescRight">Enable the interrupt. <a href="#ga4d8bc3929af0678c182047884c50f7db">More...</a><br/></td></tr>
|
|
<tr class="separator:ga4d8bc3929af0678c182047884c50f7db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa7de1f02a42c4176605cf7053f78baab"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gaa7de1f02a42c4176605cf7053f78baab">KPP_DisableInterrupts</a> (KPP_Type *base, uint16_t mask)</td></tr>
|
|
<tr class="memdesc:gaa7de1f02a42c4176605cf7053f78baab"><td class="mdescLeft"> </td><td class="mdescRight">Disable the interrupt. <a href="#gaa7de1f02a42c4176605cf7053f78baab">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa7de1f02a42c4176605cf7053f78baab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7e0b699fd3ac19ce1bbb95418871ab3e"><td class="memItemLeft" align="right" valign="top">static uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga7e0b699fd3ac19ce1bbb95418871ab3e">KPP_GetStatusFlag</a> (KPP_Type *base)</td></tr>
|
|
<tr class="memdesc:ga7e0b699fd3ac19ce1bbb95418871ab3e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the KPP interrupt event status. <a href="#ga7e0b699fd3ac19ce1bbb95418871ab3e">More...</a><br/></td></tr>
|
|
<tr class="separator:ga7e0b699fd3ac19ce1bbb95418871ab3e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad5f48c3a6027700e16a3f9bf477fa7e6"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gad5f48c3a6027700e16a3f9bf477fa7e6">KPP_ClearStatusFlag</a> (KPP_Type *base, uint16_t mask)</td></tr>
|
|
<tr class="memdesc:gad5f48c3a6027700e16a3f9bf477fa7e6"><td class="mdescLeft"> </td><td class="mdescRight">Clears KPP status flag. <a href="#gad5f48c3a6027700e16a3f9bf477fa7e6">More...</a><br/></td></tr>
|
|
<tr class="separator:gad5f48c3a6027700e16a3f9bf477fa7e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7a240001a7a2b5fb84754a9a75afcb86"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga7a240001a7a2b5fb84754a9a75afcb86">KPP_SetSynchronizeChain</a> (KPP_Type *base, uint16_t mask)</td></tr>
|
|
<tr class="memdesc:ga7a240001a7a2b5fb84754a9a75afcb86"><td class="mdescLeft"> </td><td class="mdescRight">Set KPP synchronization chain. <a href="#ga7a240001a7a2b5fb84754a9a75afcb86">More...</a><br/></td></tr>
|
|
<tr class="separator:ga7a240001a7a2b5fb84754a9a75afcb86"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga636803e3b1c99ec6dc9756548d9ef7b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga636803e3b1c99ec6dc9756548d9ef7b9">KPP_keyPressScanning</a> (KPP_Type *base, uint8_t *data, uint32_t clockSrc_Hz)</td></tr>
|
|
<tr class="memdesc:ga636803e3b1c99ec6dc9756548d9ef7b9"><td class="mdescLeft"> </td><td class="mdescRight">Keypad press scanning. <a href="#ga636803e3b1c99ec6dc9756548d9ef7b9">More...</a><br/></td></tr>
|
|
<tr class="separator:ga636803e3b1c99ec6dc9756548d9ef7b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="a00408" id="a00408"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct _kpp_config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"></div><table class="memberdecls">
|
|
<tr><td colspan="2"><h3>Data Fields</h3></td></tr>
|
|
<tr class="memitem:a5c9fb5f79cfb2b03b884a47718ccd007"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a5c9fb5f79cfb2b03b884a47718ccd007">activeRow</a></td></tr>
|
|
<tr class="memdesc:a5c9fb5f79cfb2b03b884a47718ccd007"><td class="mdescLeft"> </td><td class="mdescRight">The row number: bit 7 ~ 0 represents the row 7 ~ 0. <a href="#a5c9fb5f79cfb2b03b884a47718ccd007">More...</a><br/></td></tr>
|
|
<tr class="separator:a5c9fb5f79cfb2b03b884a47718ccd007"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7ef5ba717a420f79db47bf54059c53f"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ae7ef5ba717a420f79db47bf54059c53f">activeColumn</a></td></tr>
|
|
<tr class="memdesc:ae7ef5ba717a420f79db47bf54059c53f"><td class="mdescLeft"> </td><td class="mdescRight">The column number: bit 7 ~ 0 represents the column 7 ~ 0. <a href="#ae7ef5ba717a420f79db47bf54059c53f">More...</a><br/></td></tr>
|
|
<tr class="separator:ae7ef5ba717a420f79db47bf54059c53f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad095a892349a9e98cb99b75a3cf82723"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ad095a892349a9e98cb99b75a3cf82723">interrupt</a></td></tr>
|
|
<tr class="memdesc:ad095a892349a9e98cb99b75a3cf82723"><td class="mdescLeft"> </td><td class="mdescRight">KPP interrupt source. <a href="#ad095a892349a9e98cb99b75a3cf82723">More...</a><br/></td></tr>
|
|
<tr class="separator:ad095a892349a9e98cb99b75a3cf82723"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h4 class="groupheader">Field Documentation</h4>
|
|
<a class="anchor" id="a5c9fb5f79cfb2b03b884a47718ccd007"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _kpp_config::activeRow</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae7ef5ba717a420f79db47bf54059c53f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t _kpp_config::activeColumn</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad095a892349a9e98cb99b75a3cf82723"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t _kpp_config::interrupt</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>A logical OR of "kpp_interrupt_enable_t". </p>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="ga35c20878a9d0b578ca2bbf50d98666a8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FSL_KPP_DRIVER_VERSION   (<a class="el" href="a00260.html#ga812138aa3315b0c6953c1a26130bcc37">MAKE_VERSION</a>(2, 0, 0))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a class="anchor" id="ga750601427065c87c4daf8fc07091d039"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00044.html#ga8c6f14f0861416aab52182b088863d5b">_kpp_interrupt_enable</a> <a class="el" href="a00044.html#ga750601427065c87c4daf8fc07091d039">kpp_interrupt_enable_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This enumeration uses one-bot encoding to allow a logical OR of multiple members. Members usually map to interrupt enable bits in one or more peripheral registers. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5c752eb676c0517a7cd9bfc52e4744aa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="a00044.html#gafab0e664fb713522de61aa4907426ca3">_kpp_sync_operation</a> <a class="el" href="a00044.html#ga5c752eb676c0517a7cd9bfc52e4744aa">kpp_sync_operation_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaf36399349f3826313f180a4798ac3275"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="a00044.html#a00408">_kpp_config</a> <a class="el" href="a00044.html#gaf36399349f3826313f180a4798ac3275">kpp_config_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="ga8c6f14f0861416aab52182b088863d5b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00044.html#ga8c6f14f0861416aab52182b088863d5b">_kpp_interrupt_enable</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This enumeration uses one-bot encoding to allow a logical OR of multiple members. Members usually map to interrupt enable bits in one or more peripheral registers. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga8c6f14f0861416aab52182b088863d5bab4f673ab2f4dfc055981eed98465d8b2"></a>kKPP_keyDepressInterrupt</em> </td><td class="fielddoc">
|
|
<p>Keypad depress interrupt source. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="gga8c6f14f0861416aab52182b088863d5ba760b827e5a10ba43afac4c5a5f4449df"></a>kKPP_keyReleaseInterrupt</em> </td><td class="fielddoc">
|
|
<p>Keypad release interrupt source. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gafab0e664fb713522de61aa4907426ca3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="a00044.html#gafab0e664fb713522de61aa4907426ca3">_kpp_sync_operation</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="ggafab0e664fb713522de61aa4907426ca3a362de7775b6d24295feddbb8cc93550b"></a>kKPP_ClearKeyDepressSyncChain</em> </td><td class="fielddoc">
|
|
<p>Keypad depress interrupt status. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><em><a class="anchor" id="ggafab0e664fb713522de61aa4907426ca3a2938765c6adf7fcf5128895478876aa5"></a>kKPP_SetKeyReleasesSyncChain</em> </td><td class="fielddoc">
|
|
<p>Keypad release interrupt status. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga773203cef9b50a6c5864f78c05cb0c83"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void KPP_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KPP_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00044.html#gaf36399349f3826313f180a4798ac3275">kpp_config_t</a> * </td>
|
|
<td class="paramname"><em>configure</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function ungates the KPP clock and initializes KPP. This function must be called before calling any other KPP driver functions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>KPP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">configure</td><td>The KPP configuration structure pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga910f3aec15296a1d993f9b4963a152fd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void KPP_Deinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KPP_Type * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function gates the KPP clock. As a result, the KPP module doesn't work after calling this function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>KPP peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga4d8bc3929af0678c182047884c50f7db"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void KPP_EnableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KPP_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>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">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>KPP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">mask</td><td>KPP interrupts to enable. This is a logical OR of the enumeration :: kpp_interrupt_enable_t. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa7de1f02a42c4176605cf7053f78baab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void KPP_DisableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KPP_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>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">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>KPP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">mask</td><td>KPP interrupts to disable. This is a logical OR of the enumeration :: kpp_interrupt_enable_t. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7e0b699fd3ac19ce1bbb95418871ab3e"></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 KPP_GetStatusFlag </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KPP_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">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>KPP peripheral base address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status of the KPP. Application can use the enum type in the "kpp_interrupt_enable_t" to get the right status of the related event. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad5f48c3a6027700e16a3f9bf477fa7e6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void KPP_ClearStatusFlag </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KPP_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>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">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>KPP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">mask</td><td>KPP mask to be cleared. This is a logical OR of the enumeration :: kpp_interrupt_enable_t. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7a240001a7a2b5fb84754a9a75afcb86"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void KPP_SetSynchronizeChain </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KPP_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>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">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>KPP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">mask</td><td>KPP mask to be cleared. This is a logical OR of the enumeration :: kpp_sync_operation_t. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga636803e3b1c99ec6dc9756548d9ef7b9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void KPP_keyPressScanning </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KPP_Type * </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>clockSrc_Hz</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function will scanning all columns and rows. so all scanning data will be stored in the data pointer.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>KPP peripheral base address. </td></tr>
|
|
<tr><td class="paramname">data</td><td>KPP key press scanning data. The data buffer should be prepared with length at least equal to KPP_KEYPAD_COLUMNNUM_MAX * KPP_KEYPAD_ROWNUM_MAX. the data pointer is recommended to be a array like uint8_t data[KPP_KEYPAD_COLUMNNUM_MAX]. for example the data[2] = 4, that means in column 1 row 2 has a key press event. </td></tr>
|
|
<tr><td class="paramname">clockSrc_Hz</td><td>Source clock. </td></tr>
|
|
</table>
|
|
</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>
|