<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: hal/architecture/Linux/drivers/BCM/BCM.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="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">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_52c912f73dac9c4c0e442232e1b2bd80.html">hal</a></li><li class="navelem"><a class="el" href="dir_f2b50fdf5983ac8db5dbb1f1d585f6a3.html">architecture</a></li><li class="navelem"><a class="el" href="dir_14e8f5cb68fb87a2830d32ad3850b550.html">Linux</a></li><li class="navelem"><a class="el" href="dir_68a77b0bc8673001e7a269f14784e305.html">drivers</a></li><li class="navelem"><a class="el" href="dir_7f0298914e0455d3243b335abcc43797.html">BCM</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">BCM.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * The MySensors Arduino library handles the wireless radio link and protocol</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * between your home built sensors/actuators and HA controller of choice.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The sensors forms a self healing radio network with optional repeaters. Each</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * repeater and gateway builds a routing tables in EEPROM which keeps track of the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * network topology allowing messages to be routed to nodes.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Created by Henrik Ekblad <henrik.ekblad@mysensors.org></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Copyright (C) 2013-2019 Sensnology AB</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Full contributor list: https://github.com/mysensors/MySensors/graphs/contributors</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Documentation: http://www.mysensors.org</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Support Forum: http://forum.mysensors.org</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * This program is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * modify it under the terms of the GNU General Public License</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * version 2 as published by the Free Software Foundation.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef BCM_h</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define BCM_h</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <stdint.h></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "bcm2835.h"</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define INPUT BCM2835_GPIO_FSEL_INPT</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define OUTPUT BCM2835_GPIO_FSEL_OUTP</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="class_b_c_m_class.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="class_b_c_m_class.html">BCMClass</a></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="class_b_c_m_class.html#a13582437ecbd477010aeba9ec5c6b5aa">~BCMClass</a>();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  uint8_t <a class="code" href="class_b_c_m_class.html#a70f46aecc9a55ad7df5563ec7fc46a08">init</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> <a class="code" href="class_b_c_m_class.html#a1e7388b4fa96052dd4fceacb77405cec">pinMode</a>(uint8_t gpio, uint8_t mode);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> <a class="code" href="class_b_c_m_class.html#a7d846c4017846dc7163e654172c9f8a3">digitalWrite</a>(uint8_t gpio, uint8_t value);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  uint8_t <a class="code" href="class_b_c_m_class.html#ad5781d1bc2ca4b15df0cfdcbd20cd649">digitalRead</a>(uint8_t gpio);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">inline</span> uint8_t <a class="code" href="class_b_c_m_class.html#af15127531aed799936ed325eb16fd47a">digitalPinToInterrupt</a>(uint8_t gpio);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  uint8_t <a class="code" href="class_b_c_m_class.html#a640fad2307ad9725d7a1c9405ea731f9">isInitialized</a>();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">static</span> uint8_t initialized; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> };</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="class_b_c_m_class.html#af15127531aed799936ed325eb16fd47a"> 85</a></span> uint8_t <a class="code" href="class_b_c_m_class.html#af15127531aed799936ed325eb16fd47a">BCMClass::digitalPinToInterrupt</a>(uint8_t gpio)</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">return</span> gpio;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> }</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">extern</span> <a class="code" href="class_b_c_m_class.html">BCMClass</a> BCM;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_b_c_m_class_html_a640fad2307ad9725d7a1c9405ea731f9"><div class="ttname"><a href="class_b_c_m_class.html#a640fad2307ad9725d7a1c9405ea731f9">BCMClass::isInitialized</a></div><div class="ttdeci">uint8_t isInitialized()</div><div class="ttdoc">Checks if SPI was initialized.</div><div class="ttdef"><b>Definition:</b> BCM.cpp:77</div></div>
<div class="ttc" id="aclass_b_c_m_class_html"><div class="ttname"><a href="class_b_c_m_class.html">BCMClass</a></div><div class="ttdoc">BCM class.</div><div class="ttdef"><b>Definition:</b> BCM.h:32</div></div>
<div class="ttc" id="aclass_b_c_m_class_html_a1e7388b4fa96052dd4fceacb77405cec"><div class="ttname"><a href="class_b_c_m_class.html#a1e7388b4fa96052dd4fceacb77405cec">BCMClass::pinMode</a></div><div class="ttdeci">void pinMode(uint8_t gpio, uint8_t mode)</div><div class="ttdoc">Configures the specified pin to behave either as an input or an output.</div><div class="ttdef"><b>Definition:</b> BCM.cpp:48</div></div>
<div class="ttc" id="aclass_b_c_m_class_html_a70f46aecc9a55ad7df5563ec7fc46a08"><div class="ttname"><a href="class_b_c_m_class.html#a70f46aecc9a55ad7df5563ec7fc46a08">BCMClass::init</a></div><div class="ttdeci">uint8_t init()</div><div class="ttdoc">Initializes BCM.</div><div class="ttdef"><b>Definition:</b> BCM.cpp:37</div></div>
<div class="ttc" id="aclass_b_c_m_class_html_af15127531aed799936ed325eb16fd47a"><div class="ttname"><a href="class_b_c_m_class.html#af15127531aed799936ed325eb16fd47a">BCMClass::digitalPinToInterrupt</a></div><div class="ttdeci">uint8_t digitalPinToInterrupt(uint8_t gpio)</div><div class="ttdoc">Returns the same GPIO, no conversion is required.</div><div class="ttdef"><b>Definition:</b> BCM.h:85</div></div>
<div class="ttc" id="aclass_b_c_m_class_html_ad5781d1bc2ca4b15df0cfdcbd20cd649"><div class="ttname"><a href="class_b_c_m_class.html#ad5781d1bc2ca4b15df0cfdcbd20cd649">BCMClass::digitalRead</a></div><div class="ttdeci">uint8_t digitalRead(uint8_t gpio)</div><div class="ttdoc">Reads the value from a specified pin.</div><div class="ttdef"><b>Definition:</b> BCM.cpp:68</div></div>
<div class="ttc" id="aclass_b_c_m_class_html_a13582437ecbd477010aeba9ec5c6b5aa"><div class="ttname"><a href="class_b_c_m_class.html#a13582437ecbd477010aeba9ec5c6b5aa">BCMClass::~BCMClass</a></div><div class="ttdeci">~BCMClass()</div><div class="ttdoc">BCMClass destructor.</div><div class="ttdef"><b>Definition:</b> BCM.cpp:29</div></div>
<div class="ttc" id="aclass_b_c_m_class_html_a7d846c4017846dc7163e654172c9f8a3"><div class="ttname"><a href="class_b_c_m_class.html#a7d846c4017846dc7163e654172c9f8a3">BCMClass::digitalWrite</a></div><div class="ttdeci">void digitalWrite(uint8_t gpio, uint8_t value)</div><div class="ttdoc">Write a high or a low value for the given pin.</div><div class="ttdef"><b>Definition:</b> BCM.cpp:57</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>