<!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/MyHwLinuxGeneric.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">MyHwLinuxGeneric.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 MyHwLinuxGeneric_h</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define MyHwLinuxGeneric_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 <cstdlib></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <pthread.h></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "SerialPort.h"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "StdInOutStream.h"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <SPI.h></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <errno.h></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <stdarg.h></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <stdio.h></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <stdlib.h></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <syscall.h></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <unistd.h></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "SoftEeprom.h"</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "log.h"</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "config.h"</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define CRYPTO_LITTLE_ENDIAN</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#ifdef MY_LINUX_SERIAL_PORT</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#ifdef MY_LINUX_SERIAL_IS_PTY</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <a class="code" href="class_serial_port.html">SerialPort</a> Serial = <a class="code" href="class_serial_port.html">SerialPort</a>(MY_LINUX_SERIAL_PORT, <span class="keyword">true</span>);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <a class="code" href="class_serial_port.html">SerialPort</a> Serial = <a class="code" href="class_serial_port.html">SerialPort</a>(MY_LINUX_SERIAL_PORT, <span class="keyword">false</span>);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <a class="code" href="class_std_in_out_stream.html">StdInOutStream</a> Serial = <a class="code" href="class_std_in_out_stream.html">StdInOutStream</a>();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#ifndef MY_SERIALDEVICE</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define MY_SERIALDEVICE Serial</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// Define these as macros (do nothing)</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define hwWatchdogReset()</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define hwReboot()</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define hwGetSleepRemaining() (0ul)</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> hwDigitalWrite(uint8_t, uint8_t);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> hwDigitalRead(uint8_t);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> hwPinMode(uint8_t, uint8_t);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">bool</span> hwInit(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> hwReadConfigBlock(<span class="keywordtype">void</span> *buf, <span class="keywordtype">void</span> *addr, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> hwWriteConfigBlock(<span class="keywordtype">void</span> *buf, <span class="keywordtype">void</span> *addr, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">inline</span> uint8_t hwReadConfig(<span class="keyword">const</span> <span class="keywordtype">int</span> addr);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> hwWriteConfig(<span class="keyword">const</span> <span class="keywordtype">int</span> addr, uint8_t value);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> hwRandomNumberInit(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> ssize_t hwGetentropy(<span class="keywordtype">void</span> *__buffer, <span class="keywordtype">size_t</span> __length);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#define MY_HW_HAS_GETENTROPY</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">inline</span> uint32_t hwMillis(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// SOFTSPI</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#ifdef MY_SOFTSPI</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#error Soft SPI is not available on this architecture!</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#define hwSPI SPI </span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"></span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#ifdef MY_RF24_IRQ_PIN</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">static</span> pthread_mutex_t hw_mutex = PTHREAD_MUTEX_INITIALIZER;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">static</span> __inline__ <span class="keywordtype">void</span> __hwUnlock(<span class="keyword">const</span> uint8_t *__s)</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>  pthread_mutex_unlock(&hw_mutex);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  (void)__s;</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>  </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">static</span> __inline__ <span class="keywordtype">void</span> __hwLock()</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>  pthread_mutex_lock(&hw_mutex);</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 class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor">#if defined(DOXYGEN)</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#define ATOMIC_BLOCK_CLEANUP</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#elif defined(MY_RF24_IRQ_PIN)</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#define ATOMIC_BLOCK_CLEANUP uint8_t __atomic_loop \</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor"> __attribute__((__cleanup__( __hwUnlock ))) = 1</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#define ATOMIC_BLOCK_CLEANUP</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif </span><span class="comment">/* DOXYGEN */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#if defined(DOXYGEN)</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#define ATOMIC_BLOCK</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#elif defined(MY_RF24_IRQ_PIN)</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#define ATOMIC_BLOCK for ( ATOMIC_BLOCK_CLEANUP, __hwLock(); \</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"> __atomic_loop ; __atomic_loop = 0 )</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#define ATOMIC_BLOCK</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif </span><span class="comment">/* DOXYGEN */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#ifndef DOXYGEN</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#define MY_CRITICAL_SECTION ATOMIC_BLOCK</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#endif </span><span class="comment">/* DOXYGEN */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_std_in_out_stream_html"><div class="ttname"><a href="class_std_in_out_stream.html">StdInOutStream</a></div><div class="ttdoc">A class that prints to stdout and reads from stdin.</div><div class="ttdef"><b>Definition:</b> StdInOutStream.h:31</div></div>
<div class="ttc" id="aclass_serial_port_html"><div class="ttname"><a href="class_serial_port.html">SerialPort</a></div><div class="ttdef"><b>Definition:</b> SerialPort.h:31</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>