MCB1700_Welcome/Doxygen/html/_app_board2_buttons_8h_sour...

154 lines
15 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Labor04: AppBoard2Buttons.h Source File</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>
<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>
<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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Labor04
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_app_board2_buttons_8h_source.html',''); initResizable(); });
/* @license-end */
</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="headertitle">
<div class="title">AppBoard2Buttons.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_app_board2_buttons_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#ifndef _APPBOARD2BUTTONS_H</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define _APPBOARD2BUTTONS_H</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">//Import necessary board packages</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;GPIO_LPC17xx.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;PIN_LPC17xx.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;LPC17xx.h&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">//Number of push buttons of application board 2</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#a1d54a1a9dab19a3f18d6610bfe529c2c"> 21</a></span>&#160;<span class="preprocessor">#define APPBOARD2_NUMBER_BUTTONS (8U)</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#a426d4ddecb7b1a182500019df7ccb854"> 23</a></span>&#160;<span class="preprocessor">#define BUTTON_T0 (1U&lt;&lt;0)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#abba529cebd73b2efa6e4c02b099fb5e2"> 24</a></span>&#160;<span class="preprocessor">#define BUTTON_T1 (1U&lt;&lt;1)</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#a7fd8c2d5b26bcda8f9c613668bca9c9f"> 25</a></span>&#160;<span class="preprocessor">#define BUTTON_T2 (1U&lt;&lt;2)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#a12e1aaac7834f96cfaa89db256e07a0f"> 26</a></span>&#160;<span class="preprocessor">#define BUTTON_T3 (1U&lt;&lt;3)</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#af9081305bda7fff38a848815876b175d"> 27</a></span>&#160;<span class="preprocessor">#define BUTTON_T4 (1U&lt;&lt;4)</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#a3006b6a93c5206f1b83d2f45bc2babf9"> 28</a></span>&#160;<span class="preprocessor">#define BUTTON_T5 (1U&lt;&lt;5)</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#aa6437d6d77fb2ef436f6dd33561974cc"> 29</a></span>&#160;<span class="preprocessor">#define BUTTON_T6 (1U&lt;&lt;6)</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#a65c0e8f96abf1884f4c55dae4e7663df"> 30</a></span>&#160;<span class="preprocessor">#define BUTTON_T7 (1U&lt;&lt;7)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#a5a0d0c29de29163df0af7980fca6bd65"> 33</a></span>&#160;<span class="preprocessor">#define APPBOARD2_MASK_BUTTONS (0x000000FFU)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">//macro port number -&gt; GPIO start address</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="_app_board2_buttons_8h.html#a72d4c11c7df1dba1ed1c0d46fa135d87"> 36</a></span>&#160;<span class="preprocessor">#define LPC_GPIO_PORT(n) ((LPC_GPIO_TypeDef*)(LPC_GPIO0_BASE + (0x00000020*(n))))</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">//function declarations</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keywordtype">void</span> <a class="code" href="_app_board2_buttons_8h.html#a8d4bb8cc3a9b02919eeabd4e7efb691e">vAppboard2ButtonsInitialize</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keywordtype">void</span> <a class="code" href="_app_board2_buttons_8h.html#a47a3f0dd34a93947609f44bee6810eaf">vAppboard2ButtonsUninitialize</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;uint32_t <a class="code" href="_app_board2_buttons_8h.html#acbd982e9017fcc7828f6ada51d02bcbe">u32AppBoard2ButtonsGetState</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="a_app_board2_buttons_8c_html_a47a3f0dd34a93947609f44bee6810eaf"><div class="ttname"><a href="_app_board2_buttons_8c.html#a47a3f0dd34a93947609f44bee6810eaf">vAppboard2ButtonsUninitialize</a></div><div class="ttdeci">void vAppboard2ButtonsUninitialize(void)</div><div class="ttdoc">Uninitialization of all buttons of Application Board 2.</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.c:59</div></div>
<div class="ttc" id="a_app_board2_buttons_8h_html"><div class="ttname"><a href="_app_board2_buttons_8h.html">AppBoard2Buttons.h</a></div><div class="ttdoc">Read state of buttons.</div></div>
<div class="ttc" id="a_app_board2_buttons_8h_html_a47a3f0dd34a93947609f44bee6810eaf"><div class="ttname"><a href="_app_board2_buttons_8h.html#a47a3f0dd34a93947609f44bee6810eaf">vAppboard2ButtonsUninitialize</a></div><div class="ttdeci">void vAppboard2ButtonsUninitialize(void)</div><div class="ttdoc">Uninitialization of all buttons of Application Board 2.</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.c:59</div></div>
<div class="ttc" id="a_app_board2_buttons_8h_html_a8d4bb8cc3a9b02919eeabd4e7efb691e"><div class="ttname"><a href="_app_board2_buttons_8h.html#a8d4bb8cc3a9b02919eeabd4e7efb691e">vAppboard2ButtonsInitialize</a></div><div class="ttdeci">void vAppboard2ButtonsInitialize(void)</div><div class="ttdoc">Initialization of all buttons of Application Board 2.</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.c:35</div></div>
<div class="ttc" id="a_app_board2_buttons_8c_html_a07d36e2e97b2bf6abeee32863ea7222e"><div class="ttname"><a href="_app_board2_buttons_8c.html#a07d36e2e97b2bf6abeee32863ea7222e">axAppBoard2Buttons</a></div><div class="ttdeci">GPIO_ID axAppBoard2Buttons[APPBOARD2_NUMBER_BUTTONS]</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.c:17</div></div>
<div class="ttc" id="a_app_board2_buttons_8c_html_a8d4bb8cc3a9b02919eeabd4e7efb691e"><div class="ttname"><a href="_app_board2_buttons_8c.html#a8d4bb8cc3a9b02919eeabd4e7efb691e">vAppboard2ButtonsInitialize</a></div><div class="ttdeci">void vAppboard2ButtonsInitialize(void)</div><div class="ttdoc">Initialization of all buttons of Application Board 2.</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.c:35</div></div>
<div class="ttc" id="a_app_board2_buttons_8c_html_aab5827442758f8170c4aa7190629e321"><div class="ttname"><a href="_app_board2_buttons_8c.html#aab5827442758f8170c4aa7190629e321">u32AppBoard2ButtonsDebounce</a></div><div class="ttdeci">static bool u32AppBoard2ButtonsDebounce(uint32_t u32Value)</div><div class="ttdoc">Returns true if buttons are debounced.</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.c:130</div></div>
<div class="ttc" id="a_app_board2_buttons_8h_html_a72d4c11c7df1dba1ed1c0d46fa135d87"><div class="ttname"><a href="_app_board2_buttons_8h.html#a72d4c11c7df1dba1ed1c0d46fa135d87">LPC_GPIO_PORT</a></div><div class="ttdeci">#define LPC_GPIO_PORT(n)</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.h:36</div></div>
<div class="ttc" id="a_app_board2_buttons_8c_html_acbd982e9017fcc7828f6ada51d02bcbe"><div class="ttname"><a href="_app_board2_buttons_8c.html#acbd982e9017fcc7828f6ada51d02bcbe">u32AppBoard2ButtonsGetState</a></div><div class="ttdeci">uint32_t u32AppBoard2ButtonsGetState(void)</div><div class="ttdoc">Returns the pressed Buttons (bit coded see AppBoard2Buttons.h)</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.c:85</div></div>
<div class="ttc" id="a_app_board2_buttons_8h_html_a1d54a1a9dab19a3f18d6610bfe529c2c"><div class="ttname"><a href="_app_board2_buttons_8h.html#a1d54a1a9dab19a3f18d6610bfe529c2c">APPBOARD2_NUMBER_BUTTONS</a></div><div class="ttdeci">#define APPBOARD2_NUMBER_BUTTONS</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.h:21</div></div>
<div class="ttc" id="a_app_board2_buttons_8h_html_acbd982e9017fcc7828f6ada51d02bcbe"><div class="ttname"><a href="_app_board2_buttons_8h.html#acbd982e9017fcc7828f6ada51d02bcbe">u32AppBoard2ButtonsGetState</a></div><div class="ttdeci">uint32_t u32AppBoard2ButtonsGetState(void)</div><div class="ttdoc">Returns the pressed Buttons (bit coded see AppBoard2Buttons.h)</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.c:85</div></div>
<div class="ttc" id="a_app_board2_buttons_8h_html_a5a0d0c29de29163df0af7980fca6bd65"><div class="ttname"><a href="_app_board2_buttons_8h.html#a5a0d0c29de29163df0af7980fca6bd65">APPBOARD2_MASK_BUTTONS</a></div><div class="ttdeci">#define APPBOARD2_MASK_BUTTONS</div><div class="ttdef"><b>Definition:</b> AppBoard2Buttons.h:33</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="_app_board2_buttons_8h.html">AppBoard2Buttons.h</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>