source: flair-dev/trunk/doc/Flair/_i2c_port_8h_source.html @ 15

Last change on this file since 15 was 15, checked in by Sanahuja Guillaume, 5 years ago

m

File size: 15.8 KB
Line 
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"/>
6<meta name="generator" content="Doxygen 1.8.7"/>
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>
13<script type="text/javascript" src="navtree.js"></script>
14<script type="text/javascript">
15  $(document).ready(initResizable);
16  $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21  $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32  <td style="padding-left: 0.5em;">
33   <div id="projectname">Flair
34   </div>
35   <div id="projectbrief">Framework Libre Air</div>
36  </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46  <div id="navrow1" class="tabs">
47    <ul class="tablist">
48      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50      <li><a href="annotated.html"><span>Classes</span></a></li>
51      <li class="current"><a href="files.html"><span>Files</span></a></li>
52      <li>
53        <div id="MSearchBox" class="MSearchBoxInactive">
54        <span class="left">
55          <img id="MSearchSelect" src="search/mag_sel.png"
56               onmouseover="return searchBox.OnSearchSelectShow()"
57               onmouseout="return searchBox.OnSearchSelectHide()"
58               alt=""/>
59          <input type="text" id="MSearchField" value="Search" accesskey="S"
60               onfocus="searchBox.OnSearchFieldFocus(true)" 
61               onblur="searchBox.OnSearchFieldFocus(false)" 
62               onkeyup="searchBox.OnSearchFieldChange(event)"/>
63          </span><span class="right">
64            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65          </span>
66        </div>
67      </li>
68    </ul>
69  </div>
70  <div id="navrow2" class="tabs2">
71    <ul class="tablist">
72      <li><a href="files.html"><span>File&#160;List</span></a></li>
73    </ul>
74  </div>
75</div><!-- top -->
76<div id="side-nav" class="ui-resizable side-nav-resizable">
77  <div id="nav-tree">
78    <div id="nav-tree-contents">
79      <div id="nav-sync" class="sync"></div>
80    </div>
81  </div>
82  <div id="splitbar" style="-moz-user-select:none;" 
83       class="ui-resizable-handle">
84  </div>
85</div>
86<script type="text/javascript">
87$(document).ready(function(){initNavTree('_i2c_port_8h_source.html','');});
88</script>
89<div id="doc-content">
90<!-- window showing the filter options -->
91<div id="MSearchSelectWindow"
92     onmouseover="return searchBox.OnSearchSelectShow()"
93     onmouseout="return searchBox.OnSearchSelectHide()"
94     onkeydown="return searchBox.OnSearchSelectKey(event)">
95<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
96
97<!-- iframe showing the search results (closed by default) -->
98<div id="MSearchResultsWindow">
99<iframe src="javascript:void(0)" frameborder="0" 
100        name="MSearchResults" id="MSearchResults">
101</iframe>
102</div>
103
104<div class="header">
105  <div class="headertitle">
106<div class="title">I2cPort.h</div>  </div>
107</div><!--header-->
108<div class="contents">
109<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>&#160;<span class="comment">// %flair:license{</span></div>
110<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// This file is part of the Flair framework distributed under the</span></div>
111<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// CECILL-C License, Version 1.0.</span></div>
112<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// %flair:license}</span></div>
113<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"></span><span class="preprocessor">#ifndef I2CPORT_H</span></div>
114<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#define I2CPORT_H</span></div>
115<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
116<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_mutex_8h.html">Mutex.h</a>&gt;</span></div>
117<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
118<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
119<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">namespace </span>flair {</div>
120<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">namespace </span>core {</div>
121<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>&#160;<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>
122<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">public</span>:</div>
123<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>&#160;  <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>
124<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div>
125<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>&#160;  <a class="code" href="classflair_1_1core_1_1_i2c_port.html#ad48445514c3b9e02a1eda6a6595ba686">~I2cPort</a>(){};</div>
126<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div>
127<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  <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>
128<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div>
129<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  <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>
130<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
131<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  <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>
132<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
133<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  <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>
134<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
135<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;  <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>
136<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;};</div>
137<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;} <span class="comment">// end namespace core</span></div>
138<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;} <span class="comment">// end namespace framework</span></div>
139<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div>
140<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="preprocessor">#endif // I2CPORT_H</span></div>
141<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&#39;s classes. </div><div class="ttdef"><b>Definition:</b> Object.h:77</div></div>
142<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>
143<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>
144<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:49</div></div>
145<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>
146<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&#39;s address. </div></div>
147<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>
148<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>
149<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>
150<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>
151<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>
152<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>
153</div><!-- fragment --></div><!-- contents -->
154</div><!-- doc-content -->
155<!-- start footer part -->
156<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
157  <ul>
158    <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>
159    <li class="footer">Generated on Wed Apr 20 2016 16:16:00 for Flair by
160    <a href="http://www.doxygen.org/index.html">
161    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
162  </ul>
163</div>
164</body>
165</html>
Note: See TracBrowser for help on using the repository browser.