| [14] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|---|
| 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
|---|
| 3 | <head> |
|---|
| 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|---|
| 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
|---|
| [23] | 6 | <meta name="generator" content="Doxygen 1.8.9.1"/> |
|---|
| [14] | 7 | <title>Flair: I2cPort.h Source File</title> |
|---|
| 8 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
|---|
| 9 | <script type="text/javascript" src="jquery.js"></script> |
|---|
| 10 | <script type="text/javascript" src="dynsections.js"></script> |
|---|
| 11 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
|---|
| 12 | <script type="text/javascript" src="resize.js"></script> |
|---|
| [23] | 13 | <script type="text/javascript" src="navtreedata.js"></script> |
|---|
| [14] | 14 | <script type="text/javascript" src="navtree.js"></script> |
|---|
| 15 | <script type="text/javascript"> |
|---|
| 16 | $(document).ready(initResizable); |
|---|
| 17 | $(window).load(resizeHeight); |
|---|
| 18 | </script> |
|---|
| 19 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
|---|
| [23] | 20 | <script type="text/javascript" src="search/searchdata.js"></script> |
|---|
| [14] | 21 | <script type="text/javascript" src="search/search.js"></script> |
|---|
| 22 | <script type="text/javascript"> |
|---|
| [23] | 23 | $(document).ready(function() { init_search(); }); |
|---|
| [14] | 24 | </script> |
|---|
| 25 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
|---|
| 26 | </head> |
|---|
| 27 | <body> |
|---|
| 28 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
|---|
| 29 | <div id="titlearea"> |
|---|
| 30 | <table cellspacing="0" cellpadding="0"> |
|---|
| 31 | <tbody> |
|---|
| 32 | <tr style="height: 56px;"> |
|---|
| 33 | <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td> |
|---|
| 34 | <td style="padding-left: 0.5em;"> |
|---|
| 35 | <div id="projectname">Flair |
|---|
| 36 | </div> |
|---|
| 37 | <div id="projectbrief">Framework Libre Air</div> |
|---|
| 38 | </td> |
|---|
| 39 | </tr> |
|---|
| 40 | </tbody> |
|---|
| 41 | </table> |
|---|
| 42 | </div> |
|---|
| 43 | <!-- end header part --> |
|---|
| [23] | 44 | <!-- Generated by Doxygen 1.8.9.1 --> |
|---|
| [14] | 45 | <script type="text/javascript"> |
|---|
| 46 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
|---|
| 47 | </script> |
|---|
| 48 | <div id="navrow1" class="tabs"> |
|---|
| 49 | <ul class="tablist"> |
|---|
| 50 | <li><a href="index.html"><span>Main Page</span></a></li> |
|---|
| 51 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
|---|
| 52 | <li><a href="annotated.html"><span>Classes</span></a></li> |
|---|
| 53 | <li class="current"><a href="files.html"><span>Files</span></a></li> |
|---|
| 54 | <li> |
|---|
| 55 | <div id="MSearchBox" class="MSearchBoxInactive"> |
|---|
| 56 | <span class="left"> |
|---|
| 57 | <img id="MSearchSelect" src="search/mag_sel.png" |
|---|
| 58 | onmouseover="return searchBox.OnSearchSelectShow()" |
|---|
| 59 | onmouseout="return searchBox.OnSearchSelectHide()" |
|---|
| 60 | alt=""/> |
|---|
| 61 | <input type="text" id="MSearchField" value="Search" accesskey="S" |
|---|
| 62 | onfocus="searchBox.OnSearchFieldFocus(true)" |
|---|
| 63 | onblur="searchBox.OnSearchFieldFocus(false)" |
|---|
| 64 | onkeyup="searchBox.OnSearchFieldChange(event)"/> |
|---|
| 65 | </span><span class="right"> |
|---|
| 66 | <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
|---|
| 67 | </span> |
|---|
| 68 | </div> |
|---|
| 69 | </li> |
|---|
| 70 | </ul> |
|---|
| 71 | </div> |
|---|
| 72 | <div id="navrow2" class="tabs2"> |
|---|
| 73 | <ul class="tablist"> |
|---|
| 74 | <li><a href="files.html"><span>File List</span></a></li> |
|---|
| 75 | </ul> |
|---|
| 76 | </div> |
|---|
| 77 | </div><!-- top --> |
|---|
| 78 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
|---|
| 79 | <div id="nav-tree"> |
|---|
| 80 | <div id="nav-tree-contents"> |
|---|
| 81 | <div id="nav-sync" class="sync"></div> |
|---|
| 82 | </div> |
|---|
| 83 | </div> |
|---|
| 84 | <div id="splitbar" style="-moz-user-select:none;" |
|---|
| 85 | class="ui-resizable-handle"> |
|---|
| 86 | </div> |
|---|
| 87 | </div> |
|---|
| 88 | <script type="text/javascript"> |
|---|
| 89 | $(document).ready(function(){initNavTree('_i2c_port_8h_source.html','');}); |
|---|
| 90 | </script> |
|---|
| 91 | <div id="doc-content"> |
|---|
| 92 | <!-- window showing the filter options --> |
|---|
| 93 | <div id="MSearchSelectWindow" |
|---|
| 94 | onmouseover="return searchBox.OnSearchSelectShow()" |
|---|
| 95 | onmouseout="return searchBox.OnSearchSelectHide()" |
|---|
| 96 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
|---|
| [23] | 97 | </div> |
|---|
| [14] | 98 | |
|---|
| 99 | <!-- iframe showing the search results (closed by default) --> |
|---|
| 100 | <div id="MSearchResultsWindow"> |
|---|
| 101 | <iframe src="javascript:void(0)" frameborder="0" |
|---|
| 102 | name="MSearchResults" id="MSearchResults"> |
|---|
| 103 | </iframe> |
|---|
| 104 | </div> |
|---|
| 105 | |
|---|
| 106 | <div class="header"> |
|---|
| 107 | <div class="headertitle"> |
|---|
| 108 | <div class="title">I2cPort.h</div> </div> |
|---|
| 109 | </div><!--header--> |
|---|
| 110 | <div class="contents"> |
|---|
| 111 | <a href="_i2c_port_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> <span class="comment">// %flair:license{</span></div> |
|---|
| 112 | <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// This file is part of the Flair framework distributed under the</span></div> |
|---|
| 113 | <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// CECILL-C License, Version 1.0.</span></div> |
|---|
| 114 | <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// %flair:license}</span></div> |
|---|
| 115 | <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span><span class="preprocessor">#ifndef I2CPORT_H</span></div> |
|---|
| 116 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define I2CPORT_H</span></div> |
|---|
| 117 | <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> |
|---|
| 118 | <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <<a class="code" href="_mutex_8h.html">Mutex.h</a>></span></div> |
|---|
| 119 | <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <stdint.h></span></div> |
|---|
| 120 | <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> |
|---|
| [23] | 121 | <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div> |
|---|
| [14] | 122 | <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>core {</div> |
|---|
| 123 | <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_i2c_port.html"> 31</a></span> <span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_i2c_port.html">I2cPort</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_mutex.html">Mutex</a> {</div> |
|---|
| 124 | <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span>:</div> |
|---|
| 125 | <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_i2c_port.html#ae12b6920d11f939272b08d36409406ce"> 41</a></span>  <a class="code" href="classflair_1_1core_1_1_i2c_port.html#ae12b6920d11f939272b08d36409406ce">I2cPort</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name) : <a class="code" href="classflair_1_1core_1_1_mutex.html">Mutex</a>(parent, name) {}</div> |
|---|
| 126 | <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> |
|---|
| 127 | <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_i2c_port.html#ad48445514c3b9e02a1eda6a6595ba686"> 47</a></span>  <a class="code" href="classflair_1_1core_1_1_i2c_port.html#ad48445514c3b9e02a1eda6a6595ba686">~I2cPort</a>(){};</div> |
|---|
| 128 | <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> |
|---|
| 129 | <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classflair_1_1core_1_1_i2c_port.html#aed344676d32a7876b4514e8079fcfb39">SetSlave</a>(uint16_t address) = 0;</div> |
|---|
| 130 | <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> |
|---|
| 131 | <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> ssize_t <a class="code" href="classflair_1_1core_1_1_i2c_port.html#a851fc14390e08ba50d312a8f5395d28f">Write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> nbyte) = 0;</div> |
|---|
| 132 | <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> |
|---|
| 133 | <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> ssize_t <a class="code" href="classflair_1_1core_1_1_i2c_port.html#a1d817db571abf2eb5de697fc476ae143">Read</a>(<span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> nbyte) = 0;</div> |
|---|
| 134 | <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> |
|---|
| 135 | <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i2c_port.html#a70a00b4119f76bbd3525a5e7a800e774">SetRxTimeout</a>(<a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns) = 0;</div> |
|---|
| 136 | <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> |
|---|
| 137 | <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i2c_port.html#ab6fd9827c2301602e5aab8b141800da1">SetTxTimeout</a>(<a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns) = 0;</div> |
|---|
| 138 | <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> };</div> |
|---|
| 139 | <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> } <span class="comment">// end namespace core</span></div> |
|---|
| [50] | 140 | <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">// end namespace flair</span></div> |
|---|
| [14] | 141 | <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div> |
|---|
| 142 | <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif // I2CPORT_H</span></div> |
|---|
| [98] | 143 | <div class="ttc" id="classflair_1_1core_1_1_object_html"><div class="ttname"><a href="classflair_1_1core_1_1_object.html">flair::core::Object</a></div><div class="ttdoc">Base class for all Framework's classes. </div><div class="ttdef"><b>Definition:</b> Object.h:83</div></div> |
|---|
| [23] | 144 | <div class="ttc" id="namespaceflair_html"><div class="ttname"><a href="namespaceflair.html">flair</a></div><div class="ttdoc">namespace of the flair Framework </div><div class="ttdef"><b>Definition:</b> Ahrs.h:19</div></div> |
|---|
| [14] | 145 | <div class="ttc" id="classflair_1_1core_1_1_mutex_html"><div class="ttname"><a href="classflair_1_1core_1_1_mutex.html">flair::core::Mutex</a></div><div class="ttdoc">Class defining a mutex. </div><div class="ttdef"><b>Definition:</b> Mutex.h:29</div></div> |
|---|
| 146 | <div class="ttc" id="classflair_1_1core_1_1_i2c_port_html_ad48445514c3b9e02a1eda6a6595ba686"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html#ad48445514c3b9e02a1eda6a6595ba686">flair::core::I2cPort::~I2cPort</a></div><div class="ttdeci">~I2cPort()</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> I2cPort.h:47</div></div> |
|---|
| [98] | 147 | <div class="ttc" id="namespaceflair_1_1core_html_acc0fa041e08ecf73b2d1d723c339a736"><div class="ttname"><a href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">flair::core::Time</a></div><div class="ttdeci">unsigned long long Time</div><div class="ttdoc">Time definition, in ns. </div><div class="ttdef"><b>Definition:</b> Object.h:55</div></div> |
|---|
| [14] | 148 | <div class="ttc" id="classflair_1_1core_1_1_i2c_port_html_a70a00b4119f76bbd3525a5e7a800e774"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html#a70a00b4119f76bbd3525a5e7a800e774">flair::core::I2cPort::SetRxTimeout</a></div><div class="ttdeci">virtual void SetRxTimeout(Time timeout_ns)=0</div><div class="ttdoc">Set RX timeout. </div></div> |
|---|
| 149 | <div class="ttc" id="classflair_1_1core_1_1_i2c_port_html_aed344676d32a7876b4514e8079fcfb39"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html#aed344676d32a7876b4514e8079fcfb39">flair::core::I2cPort::SetSlave</a></div><div class="ttdeci">virtual int SetSlave(uint16_t address)=0</div><div class="ttdoc">Set slave's address. </div></div> |
|---|
| 150 | <div class="ttc" id="classflair_1_1core_1_1_i2c_port_html_ab6fd9827c2301602e5aab8b141800da1"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html#ab6fd9827c2301602e5aab8b141800da1">flair::core::I2cPort::SetTxTimeout</a></div><div class="ttdeci">virtual void SetTxTimeout(Time timeout_ns)=0</div><div class="ttdoc">Set TX timeout. </div></div> |
|---|
| 151 | <div class="ttc" id="_mutex_8h_html"><div class="ttname"><a href="_mutex_8h.html">Mutex.h</a></div><div class="ttdoc">Class defining a mutex. </div></div> |
|---|
| 152 | <div class="ttc" id="classflair_1_1core_1_1_i2c_port_html"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html">flair::core::I2cPort</a></div><div class="ttdoc">Base class for i2c port. </div><div class="ttdef"><b>Definition:</b> I2cPort.h:31</div></div> |
|---|
| 153 | <div class="ttc" id="classflair_1_1core_1_1_i2c_port_html_a1d817db571abf2eb5de697fc476ae143"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html#a1d817db571abf2eb5de697fc476ae143">flair::core::I2cPort::Read</a></div><div class="ttdeci">virtual ssize_t Read(void *buf, size_t nbyte)=0</div><div class="ttdoc">Read datas. </div></div> |
|---|
| 154 | <div class="ttc" id="classflair_1_1core_1_1_i2c_port_html_a851fc14390e08ba50d312a8f5395d28f"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html#a851fc14390e08ba50d312a8f5395d28f">flair::core::I2cPort::Write</a></div><div class="ttdeci">virtual ssize_t Write(const void *buf, size_t nbyte)=0</div><div class="ttdoc">Write datas. </div></div> |
|---|
| 155 | <div class="ttc" id="classflair_1_1core_1_1_i2c_port_html_ae12b6920d11f939272b08d36409406ce"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html#ae12b6920d11f939272b08d36409406ce">flair::core::I2cPort::I2cPort</a></div><div class="ttdeci">I2cPort(const Object *parent, std::string name)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> I2cPort.h:41</div></div> |
|---|
| 156 | </div><!-- fragment --></div><!-- contents --> |
|---|
| 157 | </div><!-- doc-content --> |
|---|
| 158 | <!-- start footer part --> |
|---|
| 159 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
|---|
| 160 | <ul> |
|---|
| [26] | 161 | <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_97265977dbbd48c696782ccac102bad5.html">FlairCore</a></li><li class="navelem"><a class="el" href="dir_6c198461db290ac9abcdd44184573216.html">src</a></li><li class="navelem"><a class="el" href="_i2c_port_8h.html">I2cPort.h</a></li> |
|---|
| [100] | 162 | <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by |
|---|
| [14] | 163 | <a href="http://www.doxygen.org/index.html"> |
|---|
| [23] | 164 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li> |
|---|
| [14] | 165 | </ul> |
|---|
| 166 | </div> |
|---|
| 167 | </body> |
|---|
| 168 | </html> |
|---|
