hoo2
/
utl
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Micro template library A library for building device drivers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 Commits
3 Branches
5.6 MiB
 
 
 
 
Tree: bebb193278
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'bebb193278'
${ noResults }
utl/doc/html/classutl_1_1spi__i.html

660 lines
33 KiB
Raw Blame History 

  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.14"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>uTL: utl::spi_i&lt; impl_t &gt; Class Template Reference</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="resize.js"></script>

  14. <script type="text/javascript" src="navtreedata.js"></script>

  15. <script type="text/javascript" src="navtree.js"></script>

  16. <script type="text/javascript">

  17. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  18.   $(document).ready(initResizable);

  19. /* @license-end */</script>

  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  21. <script type="text/javascript" src="search/searchdata.js"></script>

  22. <script type="text/javascript" src="search/search.js"></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="projectalign" style="padding-left: 0.5em;">

  32.    <div id="projectname">uTL

  33.    </div>

  34.    <div id="projectbrief">micro Template library</div>

  35.   </td>

  36.  </tr>

  37.  </tbody>

  38. </table>

  39. </div>

  40. <!-- end header part -->

  41. <!-- Generated by Doxygen 1.8.14 -->

  42. <script type="text/javascript">

  43. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  44. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  45. /* @license-end */

  46. </script>

  47. <script type="text/javascript" src="menudata.js"></script>

  48. <script type="text/javascript" src="menu.js"></script>

  49. <script type="text/javascript">

  50. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  51. $(function() {

  52.   initMenu('',true,false,'search.php','Search');

  53.   $(document).ready(function() { init_search(); });

  54. });

  55. /* @license-end */</script>

  56. <div id="main-nav"></div>

  57. </div><!-- top -->

  58. <div id="side-nav" class="ui-resizable side-nav-resizable">

  59.   <div id="nav-tree">

  60.     <div id="nav-tree-contents">

  61.       <div id="nav-sync" class="sync"></div>

  62.     </div>

  63.   </div>

  64.   <div id="splitbar" style="-moz-user-select:none;" 

  65.        class="ui-resizable-handle">

  66.   </div>

  67. </div>

  68. <script type="text/javascript">

  69. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  70. $(document).ready(function(){initNavTree('classutl_1_1spi__i.html','');});

  71. /* @license-end */

  72. </script>

  73. <div id="doc-content">

  74. <!-- window showing the filter options -->

  75. <div id="MSearchSelectWindow"

  76.      onmouseover="return searchBox.OnSearchSelectShow()"

  77.      onmouseout="return searchBox.OnSearchSelectHide()"

  78.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  79. </div>

  80. 

  81. <!-- iframe showing the search results (closed by default) -->

  82. <div id="MSearchResultsWindow">

  83. <iframe src="javascript:void(0)" frameborder="0" 

  84.         name="MSearchResults" id="MSearchResults">

  85. </iframe>

  86. </div>

  87. 

  88. <div class="header">

  89.   <div class="summary">

  90. <a href="#pub-types">Public Types</a> &#124;

  91. <a href="#pri-methods">Private Member Functions</a> &#124;

  92. <a href="classutl_1_1spi__i-members.html">List of all members</a>  </div>

  93.   <div class="headertitle">

  94. <div class="title">utl::spi_i&lt; impl_t &gt; Class Template Reference</div>  </div>

  95. </div><!--header-->

  96. <div class="contents">

  97. 

  98. <p><code>#include &lt;<a class="el" href="spi_8h_source.html">spi.h</a>&gt;</code></p>

  99. <table class="memberdecls">

  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>

  101. Public Types</h2></td></tr>

  102. <tr class="memitem:aff8ee0a2160cddbb52fce46611a6108f"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> = <a class="el" href="classutl_1_1spi__i.html">spi_i</a>&lt; impl_t &gt;</td></tr>

  103. <tr class="memdesc:aff8ee0a2160cddbb52fce46611a6108f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export type as identity meta-function.  <a href="#aff8ee0a2160cddbb52fce46611a6108f">More...</a><br /></td></tr>

  104. <tr class="separator:aff8ee0a2160cddbb52fce46611a6108f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  105. </table><table class="memberdecls">

  106. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  107. Public Member Functions</h2></td></tr>

  108. <tr><td colspan="2"><div class="groupHeader">Get/Set functions provided by the interface</div></td></tr>

  109. <tr class="memitem:a24cdd0c5ce4ed45a6c1b88ea43328634"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#a24cdd0c5ce4ed45a6c1b88ea43328634">clock</a> () const</td></tr>

  110. <tr class="separator:a24cdd0c5ce4ed45a6c1b88ea43328634"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. <tr class="memitem:a0ebb46a523ace45fd69950f90f9b3af4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#a0ebb46a523ace45fd69950f90f9b3af4">clock</a> (uint32_t c)</td></tr>

  112. <tr class="memdesc:a0ebb46a523ace45fd69950f90f9b3af4"><td class="mdescLeft">&#160;</td><td class="mdescRight">set clock frequency of the bus  <a href="#a0ebb46a523ace45fd69950f90f9b3af4">More...</a><br /></td></tr>

  113. <tr class="separator:a0ebb46a523ace45fd69950f90f9b3af4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  114. <tr><td colspan="2"><div class="groupHeader">I/O functions provided by the interface</div></td></tr>

  115. <tr class="memitem:ac8376d88480a992ac47699637e1a29a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#ac8376d88480a992ac47699637e1a29a5">tx_data</a> (<a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> out)</td></tr>

  116. <tr class="separator:ac8376d88480a992ac47699637e1a29a5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  117. <tr class="memitem:af3e303c2982202261700044d31596248"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#af3e303c2982202261700044d31596248">tx_data</a> (const <a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *out, <a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *in, <a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a> n)</td></tr>

  118. <tr class="memdesc:af3e303c2982202261700044d31596248"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit a number of bytes to the spi bus and read the response.  <a href="#af3e303c2982202261700044d31596248">More...</a><br /></td></tr>

  119. <tr class="separator:af3e303c2982202261700044d31596248"><td class="memSeparator" colspan="2">&#160;</td></tr>

  120. <tr class="memitem:a846dead32b91efcb48eed614daf68e8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#a846dead32b91efcb48eed614daf68e8f">rx_data</a> ()</td></tr>

  121. <tr class="separator:a846dead32b91efcb48eed614daf68e8f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  122. <tr class="memitem:a2053009da5364ead720aebd7cc537c21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#a2053009da5364ead720aebd7cc537c21">rx_data</a> (<a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *in, <a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a> n)</td></tr>

  123. <tr class="memdesc:a2053009da5364ead720aebd7cc537c21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive a number of bytes from the spi bus while transmitting 0xFFs.  <a href="#a2053009da5364ead720aebd7cc537c21">More...</a><br /></td></tr>

  124. <tr class="separator:a2053009da5364ead720aebd7cc537c21"><td class="memSeparator" colspan="2">&#160;</td></tr>

  125. </table><table class="memberdecls">

  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>

  127. Protected Member Functions</h2></td></tr>

  128. <tr><td colspan="2"><div class="groupHeader">Object lifetime</div></td></tr>

  129. <tr class="memitem:ad66605cdf90f6d24cad3dc5ecda94b77"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#ad66605cdf90f6d24cad3dc5ecda94b77">spi_i</a> ()=default</td></tr>

  130. <tr class="memdesc:ad66605cdf90f6d24cad3dc5ecda94b77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow constructor from derived only.  <a href="#ad66605cdf90f6d24cad3dc5ecda94b77">More...</a><br /></td></tr>

  131. <tr class="separator:ad66605cdf90f6d24cad3dc5ecda94b77"><td class="memSeparator" colspan="2">&#160;</td></tr>

  132. <tr class="memitem:ae77cb8be7d648a62a1ad252d829eccfb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#ae77cb8be7d648a62a1ad252d829eccfb">~spi_i</a> ()=default</td></tr>

  133. <tr class="memdesc:ae77cb8be7d648a62a1ad252d829eccfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow destructor from derived only.  <a href="#ae77cb8be7d648a62a1ad252d829eccfb">More...</a><br /></td></tr>

  134. <tr class="separator:ae77cb8be7d648a62a1ad252d829eccfb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  135. <tr class="memitem:a1d6facb9b9adf91a6589fe029325bd55"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#a1d6facb9b9adf91a6589fe029325bd55">spi_i</a> (const <a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> &amp;)=delete</td></tr>

  136. <tr class="memdesc:a1d6facb9b9adf91a6589fe029325bd55"><td class="mdescLeft">&#160;</td><td class="mdescRight">No copies.  <a href="#a1d6facb9b9adf91a6589fe029325bd55">More...</a><br /></td></tr>

  137. <tr class="separator:a1d6facb9b9adf91a6589fe029325bd55"><td class="memSeparator" colspan="2">&#160;</td></tr>

  138. <tr class="memitem:aa5cf05ce005cb23e6317b3eef70bf4b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#aa5cf05ce005cb23e6317b3eef70bf4b0">operator=</a> (const <a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> &amp;)=delete</td></tr>

  139. <tr class="separator:aa5cf05ce005cb23e6317b3eef70bf4b0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  140. </table><table class="memberdecls">

  141. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>

  142. Private Member Functions</h2></td></tr>

  143. <tr class="memitem:adfab771b0e399b9f482e42aaa5e9db11"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#adfab771b0e399b9f482e42aaa5e9db11">_CRTP_IMPL</a> (impl_t)</td></tr>

  144. <tr class="separator:adfab771b0e399b9f482e42aaa5e9db11"><td class="memSeparator" colspan="2">&#160;</td></tr>

  145. <tr><td colspan="2"><div class="groupHeader">Implementation requirements</div></td></tr>

  146. <tr><td colspan="2"><div class="groupText"><dl class="section note"><dt>Note</dt><dd>In order for the implementation to have the following as private members it also need to declare this class as friend </dd></dl>

  147. </div></td></tr>

  148. <tr class="memitem:a68a21ac9727eed3802ce7d1181ac4f8c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#a68a21ac9727eed3802ce7d1181ac4f8c">_clock</a> () const</td></tr>

  149. <tr class="memdesc:a68a21ac9727eed3802ce7d1181ac4f8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">clock frequency of the bus [Hz]  <a href="#a68a21ac9727eed3802ce7d1181ac4f8c">More...</a><br /></td></tr>

  150. <tr class="separator:a68a21ac9727eed3802ce7d1181ac4f8c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  151. <tr class="memitem:af0a9bfc5d02ccd2bfbe8044132884578"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#af0a9bfc5d02ccd2bfbe8044132884578">_clock</a> (uint32_t c)</td></tr>

  152. <tr class="memdesc:af0a9bfc5d02ccd2bfbe8044132884578"><td class="mdescLeft">&#160;</td><td class="mdescRight">set clock frequency of the bus [Hz]  <a href="#af0a9bfc5d02ccd2bfbe8044132884578">More...</a><br /></td></tr>

  153. <tr class="separator:af0a9bfc5d02ccd2bfbe8044132884578"><td class="memSeparator" colspan="2">&#160;</td></tr>

  154. <tr class="memitem:acf3ffd9c79d4cdeac100cf3273120689"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i.html#acf3ffd9c79d4cdeac100cf3273120689">_tx_data</a> (<a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> b)</td></tr>

  155. <tr class="separator:acf3ffd9c79d4cdeac100cf3273120689"><td class="memSeparator" colspan="2">&#160;</td></tr>

  156. </table>

  157. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  158. <div class="textblock"><h3>template&lt;typename impl_t&gt;<br />

  159. class utl::spi_i&lt; impl_t &gt;</h3>

  160. 

  161. <p>Template base class for SPI communication interface using CRTP This class force a common interface for SPI communication protocol implementations. </p><dl class="params"><dt>Parameters</dt><dd>

  162.   <table class="params">

  163.     <tr><td class="paramname">impl_t</td><td>The CRTP type (the derived/implementation class typename). </td></tr>

  164.   </table>

  165.   </dd>

  166. </dl>

  167. 

  168. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00067">67</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  169. </div><h2 class="groupheader">Member Typedef Documentation</h2>

  170. <a id="aff8ee0a2160cddbb52fce46611a6108f"></a>

  171. <h2 class="memtitle"><span class="permalink"><a href="#aff8ee0a2160cddbb52fce46611a6108f">&#9670;&nbsp;</a></span>type</h2>

  172. 

  173. <div class="memitem">

  174. <div class="memproto">

  175. <div class="memtemplate">

  176. template&lt;typename impl_t&gt; </div>

  177.       <table class="memname">

  178.         <tr>

  179.           <td class="memname">using <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> =  <a class="el" href="classutl_1_1spi__i.html">spi_i</a>&lt;impl_t&gt;</td>

  180.         </tr>

  181.       </table>

  182. </div><div class="memdoc">

  183. 

  184. <p>Export type as identity meta-function. </p>

  185. 

  186. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00071">71</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  187. 

  188. </div>

  189. </div>

  190. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  191. <a id="ad66605cdf90f6d24cad3dc5ecda94b77"></a>

  192. <h2 class="memtitle"><span class="permalink"><a href="#ad66605cdf90f6d24cad3dc5ecda94b77">&#9670;&nbsp;</a></span>spi_i() <span class="overload">[1/2]</span></h2>

  193. 

  194. <div class="memitem">

  195. <div class="memproto">

  196. <div class="memtemplate">

  197. template&lt;typename impl_t&gt; </div>

  198. <table class="mlabels">

  199.   <tr>

  200.   <td class="mlabels-left">

  201.       <table class="memname">

  202.         <tr>

  203.           <td class="memname"><a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1spi__i.html">spi_i</a> </td>

  204.           <td>(</td>

  205.           <td class="paramname"></td><td>)</td>

  206.           <td></td>

  207.         </tr>

  208.       </table>

  209.   </td>

  210.   <td class="mlabels-right">

  211. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span>  </td>

  212.   </tr>

  213. </table>

  214. </div><div class="memdoc">

  215. 

  216. <p>Allow constructor from derived only. </p>

  217. 

  218. </div>

  219. </div>

  220. <a id="ae77cb8be7d648a62a1ad252d829eccfb"></a>

  221. <h2 class="memtitle"><span class="permalink"><a href="#ae77cb8be7d648a62a1ad252d829eccfb">&#9670;&nbsp;</a></span>~spi_i()</h2>

  222. 

  223. <div class="memitem">

  224. <div class="memproto">

  225. <div class="memtemplate">

  226. template&lt;typename impl_t&gt; </div>

  227. <table class="mlabels">

  228.   <tr>

  229.   <td class="mlabels-left">

  230.       <table class="memname">

  231.         <tr>

  232.           <td class="memname"><a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::~<a class="el" href="classutl_1_1spi__i.html">spi_i</a> </td>

  233.           <td>(</td>

  234.           <td class="paramname"></td><td>)</td>

  235.           <td></td>

  236.         </tr>

  237.       </table>

  238.   </td>

  239.   <td class="mlabels-right">

  240. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span>  </td>

  241.   </tr>

  242. </table>

  243. </div><div class="memdoc">

  244. 

  245. <p>Allow destructor from derived only. </p>

  246. 

  247. </div>

  248. </div>

  249. <a id="a1d6facb9b9adf91a6589fe029325bd55"></a>

  250. <h2 class="memtitle"><span class="permalink"><a href="#a1d6facb9b9adf91a6589fe029325bd55">&#9670;&nbsp;</a></span>spi_i() <span class="overload">[2/2]</span></h2>

  251. 

  252. <div class="memitem">

  253. <div class="memproto">

  254. <div class="memtemplate">

  255. template&lt;typename impl_t&gt; </div>

  256. <table class="mlabels">

  257.   <tr>

  258.   <td class="mlabels-left">

  259.       <table class="memname">

  260.         <tr>

  261.           <td class="memname"><a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::<a class="el" href="classutl_1_1spi__i.html">spi_i</a> </td>

  262.           <td>(</td>

  263.           <td class="paramtype">const <a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> &amp;&#160;</td>

  264.           <td class="paramname"></td><td>)</td>

  265.           <td></td>

  266.         </tr>

  267.       </table>

  268.   </td>

  269.   <td class="mlabels-right">

  270. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">delete</span></span>  </td>

  271.   </tr>

  272. </table>

  273. </div><div class="memdoc">

  274. 

  275. <p>No copies. </p>

  276. 

  277. </div>

  278. </div>

  279. <h2 class="groupheader">Member Function Documentation</h2>

  280. <a id="a68a21ac9727eed3802ce7d1181ac4f8c"></a>

  281. <h2 class="memtitle"><span class="permalink"><a href="#a68a21ac9727eed3802ce7d1181ac4f8c">&#9670;&nbsp;</a></span>_clock() <span class="overload">[1/2]</span></h2>

  282. 

  283. <div class="memitem">

  284. <div class="memproto">

  285. <div class="memtemplate">

  286. template&lt;typename impl_t&gt; </div>

  287. <table class="mlabels">

  288.   <tr>

  289.   <td class="mlabels-left">

  290.       <table class="memname">

  291.         <tr>

  292.           <td class="memname">uint32_t <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::_clock </td>

  293.           <td>(</td>

  294.           <td class="paramname"></td><td>)</td>

  295.           <td> const</td>

  296.         </tr>

  297.       </table>

  298.   </td>

  299.   <td class="mlabels-right">

  300. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  301.   </tr>

  302. </table>

  303. </div><div class="memdoc">

  304. 

  305. <p>clock frequency of the bus [Hz] </p>

  306. 

  307. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00092">92</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  308. 

  309. </div>

  310. </div>

  311. <a id="af0a9bfc5d02ccd2bfbe8044132884578"></a>

  312. <h2 class="memtitle"><span class="permalink"><a href="#af0a9bfc5d02ccd2bfbe8044132884578">&#9670;&nbsp;</a></span>_clock() <span class="overload">[2/2]</span></h2>

  313. 

  314. <div class="memitem">

  315. <div class="memproto">

  316. <div class="memtemplate">

  317. template&lt;typename impl_t&gt; </div>

  318. <table class="mlabels">

  319.   <tr>

  320.   <td class="mlabels-left">

  321.       <table class="memname">

  322.         <tr>

  323.           <td class="memname">void <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::_clock </td>

  324.           <td>(</td>

  325.           <td class="paramtype">uint32_t&#160;</td>

  326.           <td class="paramname"><em>c</em></td><td>)</td>

  327.           <td></td>

  328.         </tr>

  329.       </table>

  330.   </td>

  331.   <td class="mlabels-right">

  332. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  333.   </tr>

  334. </table>

  335. </div><div class="memdoc">

  336. 

  337. <p>set clock frequency of the bus [Hz] </p>

  338. 

  339. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00093">93</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  340. 

  341. </div>

  342. </div>

  343. <a id="adfab771b0e399b9f482e42aaa5e9db11"></a>

  344. <h2 class="memtitle"><span class="permalink"><a href="#adfab771b0e399b9f482e42aaa5e9db11">&#9670;&nbsp;</a></span>_CRTP_IMPL()</h2>

  345. 

  346. <div class="memitem">

  347. <div class="memproto">

  348. <div class="memtemplate">

  349. template&lt;typename impl_t&gt; </div>

  350. <table class="mlabels">

  351.   <tr>

  352.   <td class="mlabels-left">

  353.       <table class="memname">

  354.         <tr>

  355.           <td class="memname"><a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::_CRTP_IMPL </td>

  356.           <td>(</td>

  357.           <td class="paramtype">impl_t&#160;</td>

  358.           <td class="paramname"></td><td>)</td>

  359.           <td></td>

  360.         </tr>

  361.       </table>

  362.   </td>

  363.   <td class="mlabels-right">

  364. <span class="mlabels"><span class="mlabel">private</span></span>  </td>

  365.   </tr>

  366. </table>

  367. </div><div class="memdoc">

  368. 

  369. </div>

  370. </div>

  371. <a id="acf3ffd9c79d4cdeac100cf3273120689"></a>

  372. <h2 class="memtitle"><span class="permalink"><a href="#acf3ffd9c79d4cdeac100cf3273120689">&#9670;&nbsp;</a></span>_tx_data()</h2>

  373. 

  374. <div class="memitem">

  375. <div class="memproto">

  376. <div class="memtemplate">

  377. template&lt;typename impl_t&gt; </div>

  378. <table class="mlabels">

  379.   <tr>

  380.   <td class="mlabels-left">

  381.       <table class="memname">

  382.         <tr>

  383.           <td class="memname"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::_tx_data </td>

  384.           <td>(</td>

  385.           <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td>

  386.           <td class="paramname"><em>b</em></td><td>)</td>

  387.           <td></td>

  388.         </tr>

  389.       </table>

  390.   </td>

  391.   <td class="mlabels-right">

  392. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>

  393.   </tr>

  394. </table>

  395. </div><div class="memdoc">

  396. <p>Transmit a byte on the bus and return the response </p>

  397. 

  398. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00094">94</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  399. 

  400. </div>

  401. </div>

  402. <a id="a24cdd0c5ce4ed45a6c1b88ea43328634"></a>

  403. <h2 class="memtitle"><span class="permalink"><a href="#a24cdd0c5ce4ed45a6c1b88ea43328634">&#9670;&nbsp;</a></span>clock() <span class="overload">[1/2]</span></h2>

  404. 

  405. <div class="memitem">

  406. <div class="memproto">

  407. <div class="memtemplate">

  408. template&lt;typename impl_t&gt; </div>

  409. <table class="mlabels">

  410.   <tr>

  411.   <td class="mlabels-left">

  412.       <table class="memname">

  413.         <tr>

  414.           <td class="memname">uint32_t <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::clock </td>

  415.           <td>(</td>

  416.           <td class="paramname"></td><td>)</td>

  417.           <td> const</td>

  418.         </tr>

  419.       </table>

  420.   </td>

  421.   <td class="mlabels-right">

  422. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  423.   </tr>

  424. </table>

  425. </div><div class="memdoc">

  426. <dl class="section return"><dt>Returns</dt><dd>clock frequency of the bus </dd></dl>

  427. 

  428. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00102">102</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  429. 

  430. </div>

  431. </div>

  432. <a id="a0ebb46a523ace45fd69950f90f9b3af4"></a>

  433. <h2 class="memtitle"><span class="permalink"><a href="#a0ebb46a523ace45fd69950f90f9b3af4">&#9670;&nbsp;</a></span>clock() <span class="overload">[2/2]</span></h2>

  434. 

  435. <div class="memitem">

  436. <div class="memproto">

  437. <div class="memtemplate">

  438. template&lt;typename impl_t&gt; </div>

  439. <table class="mlabels">

  440.   <tr>

  441.   <td class="mlabels-left">

  442.       <table class="memname">

  443.         <tr>

  444.           <td class="memname">void <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::clock </td>

  445.           <td>(</td>

  446.           <td class="paramtype">uint32_t&#160;</td>

  447.           <td class="paramname"><em>c</em></td><td>)</td>

  448.           <td></td>

  449.         </tr>

  450.       </table>

  451.   </td>

  452.   <td class="mlabels-right">

  453. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  454.   </tr>

  455. </table>

  456. </div><div class="memdoc">

  457. 

  458. <p>set clock frequency of the bus </p>

  459. 

  460. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00103">103</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  461. 

  462. </div>

  463. </div>

  464. <a id="aa5cf05ce005cb23e6317b3eef70bf4b0"></a>

  465. <h2 class="memtitle"><span class="permalink"><a href="#aa5cf05ce005cb23e6317b3eef70bf4b0">&#9670;&nbsp;</a></span>operator=()</h2>

  466. 

  467. <div class="memitem">

  468. <div class="memproto">

  469. <div class="memtemplate">

  470. template&lt;typename impl_t&gt; </div>

  471. <table class="mlabels">

  472.   <tr>

  473.   <td class="mlabels-left">

  474.       <table class="memname">

  475.         <tr>

  476.           <td class="memname"><a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a>&amp; <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::operator= </td>

  477.           <td>(</td>

  478.           <td class="paramtype">const <a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> &amp;&#160;</td>

  479.           <td class="paramname"></td><td>)</td>

  480.           <td></td>

  481.         </tr>

  482.       </table>

  483.   </td>

  484.   <td class="mlabels-right">

  485. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">delete</span></span>  </td>

  486.   </tr>

  487. </table>

  488. </div><div class="memdoc">

  489. 

  490. </div>

  491. </div>

  492. <a id="a846dead32b91efcb48eed614daf68e8f"></a>

  493. <h2 class="memtitle"><span class="permalink"><a href="#a846dead32b91efcb48eed614daf68e8f">&#9670;&nbsp;</a></span>rx_data() <span class="overload">[1/2]</span></h2>

  494. 

  495. <div class="memitem">

  496. <div class="memproto">

  497. <div class="memtemplate">

  498. template&lt;typename impl_t&gt; </div>

  499. <table class="mlabels">

  500.   <tr>

  501.   <td class="mlabels-left">

  502.       <table class="memname">

  503.         <tr>

  504.           <td class="memname"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::rx_data </td>

  505.           <td>(</td>

  506.           <td class="paramname"></td><td>)</td>

  507.           <td></td>

  508.         </tr>

  509.       </table>

  510.   </td>

  511.   <td class="mlabels-right">

  512. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  513.   </tr>

  514. </table>

  515. </div><div class="memdoc">

  516. <p>Receive a byte from spi bus while transmitting 0xFF </p>

  517. 

  518. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00129">129</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  519. 

  520. </div>

  521. </div>

  522. <a id="a2053009da5364ead720aebd7cc537c21"></a>

  523. <h2 class="memtitle"><span class="permalink"><a href="#a2053009da5364ead720aebd7cc537c21">&#9670;&nbsp;</a></span>rx_data() <span class="overload">[2/2]</span></h2>

  524. 

  525. <div class="memitem">

  526. <div class="memproto">

  527. <div class="memtemplate">

  528. template&lt;typename _I &gt; </div>

  529.       <table class="memname">

  530.         <tr>

  531.           <td class="memname"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a> <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; _I &gt;::rx_data </td>

  532.           <td>(</td>

  533.           <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *&#160;</td>

  534.           <td class="paramname"><em>in</em>, </td>

  535.         </tr>

  536.         <tr>

  537.           <td class="paramkey"></td>

  538.           <td></td>

  539.           <td class="paramtype"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a>&#160;</td>

  540.           <td class="paramname"><em>n</em>&#160;</td>

  541.         </tr>

  542.         <tr>

  543.           <td></td>

  544.           <td>)</td>

  545.           <td></td><td></td>

  546.         </tr>

  547.       </table>

  548. </div><div class="memdoc">

  549. 

  550. <p>Receive a number of bytes from the spi bus while transmitting 0xFFs. </p>

  551. <dl class="params"><dt>Parameters</dt><dd>

  552.   <table class="params">

  553.     <tr><td class="paramname">in</td><td>Pointer to buffer to store the data </td></tr>

  554.     <tr><td class="paramname">n</td><td>The number of bytes to read </td></tr>

  555.   </table>

  556.   </dd>

  557. </dl>

  558. <dl class="section return"><dt>Returns</dt><dd>The number of received bytes. </dd></dl>

  559. 

  560. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00165">165</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  561. 

  562. </div>

  563. </div>

  564. <a id="ac8376d88480a992ac47699637e1a29a5"></a>

  565. <h2 class="memtitle"><span class="permalink"><a href="#ac8376d88480a992ac47699637e1a29a5">&#9670;&nbsp;</a></span>tx_data() <span class="overload">[1/2]</span></h2>

  566. 

  567. <div class="memitem">

  568. <div class="memproto">

  569. <div class="memtemplate">

  570. template&lt;typename impl_t&gt; </div>

  571. <table class="mlabels">

  572.   <tr>

  573.   <td class="mlabels-left">

  574.       <table class="memname">

  575.         <tr>

  576.           <td class="memname"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::tx_data </td>

  577.           <td>(</td>

  578.           <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td>

  579.           <td class="paramname"><em>out</em></td><td>)</td>

  580.           <td></td>

  581.         </tr>

  582.       </table>

  583.   </td>

  584.   <td class="mlabels-right">

  585. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  586.   </tr>

  587. </table>

  588. </div><div class="memdoc">

  589. <p>Transmit a byte to spi bus and return the response </p>

  590. 

  591. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00114">114</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  592. 

  593. </div>

  594. </div>

  595. <a id="af3e303c2982202261700044d31596248"></a>

  596. <h2 class="memtitle"><span class="permalink"><a href="#af3e303c2982202261700044d31596248">&#9670;&nbsp;</a></span>tx_data() <span class="overload">[2/2]</span></h2>

  597. 

  598. <div class="memitem">

  599. <div class="memproto">

  600. <div class="memtemplate">

  601. template&lt;typename _I &gt; </div>

  602.       <table class="memname">

  603.         <tr>

  604.           <td class="memname"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a> <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; _I &gt;::tx_data </td>

  605.           <td>(</td>

  606.           <td class="paramtype">const <a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *&#160;</td>

  607.           <td class="paramname"><em>out</em>, </td>

  608.         </tr>

  609.         <tr>

  610.           <td class="paramkey"></td>

  611.           <td></td>

  612.           <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *&#160;</td>

  613.           <td class="paramname"><em>in</em>, </td>

  614.         </tr>

  615.         <tr>

  616.           <td class="paramkey"></td>

  617.           <td></td>

  618.           <td class="paramtype"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a>&#160;</td>

  619.           <td class="paramname"><em>n</em>&#160;</td>

  620.         </tr>

  621.         <tr>

  622.           <td></td>

  623.           <td>)</td>

  624.           <td></td><td></td>

  625.         </tr>

  626.       </table>

  627. </div><div class="memdoc">

  628. 

  629. <p>Transmit a number of bytes to the spi bus and read the response. </p>

  630. <dl class="params"><dt>Parameters</dt><dd>

  631.   <table class="params">

  632.     <tr><td class="paramname">out</td><td>Pointer to data to send to the bus </td></tr>

  633.     <tr><td class="paramname">in</td><td>Pointer to buffer to store the data from the bus </td></tr>

  634.     <tr><td class="paramname">n</td><td>The number of bytes to transmit/receive </td></tr>

  635.   </table>

  636.   </dd>

  637. </dl>

  638. <dl class="section return"><dt>Returns</dt><dd>The number of bytes. </dd></dl>

  639. 

  640. <p class="definition">Definition at line <a class="el" href="spi_8h_source.html#l00152">152</a> of file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

  641. 

  642. </div>

  643. </div>

  644. <hr/>The documentation for this class was generated from the following file:<ul>

  645. <li>include/utl/com/<a class="el" href="spi_8h_source.html">spi.h</a></li>

  646. </ul>

  647. </div><!-- contents -->

  648. </div><!-- doc-content -->

  649. <!-- start footer part -->

  650. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

  651.   <ul>

  652.     <li class="navelem"><a class="el" href="namespaceutl.html">utl</a></li><li class="navelem"><a class="el" href="classutl_1_1spi__i.html">spi_i</a></li>

  653.     <li class="footer">Generated by

  654.     <a href="http://www.doxygen.org/index.html">

  655.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>

  656.   </ul>

  657. </div>

  658. </body>

  659. </html>