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/spi_8h.html

183 lines
14 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: include/utl/com/spi.h File 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('spi_8h.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="#nested-classes">Classes</a> &#124;

  91. <a href="#namespaces">Namespaces</a> &#124;

  92. <a href="#typedef-members">Typedefs</a> &#124;

  93. <a href="#enum-members">Enumerations</a>  </div>

  94.   <div class="headertitle">

  95. <div class="title">spi.h File Reference</div>  </div>

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

  97. <div class="contents">

  98. 

  99. <p>An Abstract base class interface for the spi bus.  

  100. <a href="#details">More...</a></p>

  101. <div class="textblock"><code>#include &lt;<a class="el" href="impl_8h_source.html">utl/core/impl.h</a>&gt;</code><br />

  102. <code>#include &lt;<a class="el" href="crtp_8h_source.html">utl/core/crtp.h</a>&gt;</code><br />

  103. <code>#include &lt;<a class="el" href="meta_8h_source.html">utl/meta/meta.h</a>&gt;</code><br />

  104. </div>

  105. <p><a href="spi_8h_source.html">Go to the source code of this file.</a></p>

  106. <table class="memberdecls">

  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>

  108. Classes</h2></td></tr>

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

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

  111. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__i_3_01virtual__tag_01_4.html">utl::spi_i&lt; virtual_tag &gt;</a></td></tr>

  112. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A virtual base class implementation.  <a href="classutl_1_1spi__i_3_01virtual__tag_01_4.html#details">More...</a><br /></td></tr>

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

  114. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structutl_1_1spi__i__details_1_1is__spi__.html">utl::spi_i_details::is_spi_&lt; _Tp, typename &gt;</a></td></tr>

  115. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Primary template to catch any non SPI interface types.  <a href="structutl_1_1spi__i__details_1_1is__spi__.html#details">More...</a><br /></td></tr>

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

  117. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structutl_1_1spi__i__details_1_1is__spi___3_01___tp_00_01meta_1_1void__t_3_01meta_1_1use__if__sa2db29f6d65d34ecf5e49ec30b6600d78.html">utl::spi_i_details::is_spi_&lt; _Tp, meta::void_t&lt; meta::use_if_same_t&lt; try_cclock_t&lt; _Tp &gt;, uint32_t &gt;, meta::use_if_same_t&lt; try_clock_t&lt; _Tp &gt;, void &gt;, meta::use_if_same_t&lt; try_tx_t&lt; _Tp &gt;, byte_t &gt;, meta::use_if_same_t&lt; try_rx_t&lt; _Tp &gt;, byte_t &gt; &gt; &gt;</a></td></tr>

  118. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">template to catch a proper SPI interface type  <a href="structutl_1_1spi__i__details_1_1is__spi___3_01___tp_00_01meta_1_1void__t_3_01meta_1_1use__if__sa2db29f6d65d34ecf5e49ec30b6600d78.html#details">More...</a><br /></td></tr>

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

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

  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>

  122. Namespaces</h2></td></tr>

  123. <tr class="memitem:namespaceutl"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl.html">utl</a></td></tr>

  124. <tr class="memdesc:namespaceutl"><td class="mdescLeft">&#160;</td><td class="mdescRight">STL's core language concepts. <br /></td></tr>

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

  126. <tr class="memitem:namespaceutl_1_1spi"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi.html">utl::spi</a></td></tr>

  127. <tr class="memdesc:namespaceutl_1_1spi"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for spi bus. <br /></td></tr>

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

  129. <tr class="memitem:namespaceutl_1_1spi__i__details"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi__i__details.html">utl::spi_i_details</a></td></tr>

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

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

  132. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>

  133. Typedefs</h2></td></tr>

  134. <tr class="memitem:ae1a4fad6acf8faccc5e85ee9b710c109"><td class="memTemplParams" colspan="2">template&lt;class _Tp &gt; </td></tr>

  135. <tr class="memitem:ae1a4fad6acf8faccc5e85ee9b710c109"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi__i__details.html#ae1a4fad6acf8faccc5e85ee9b710c109">utl::spi_i_details::try_cclock_t</a> = decltype(declval&lt; const _Tp &gt;().clock())</td></tr>

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

  137. <tr class="memitem:af2f4800aa77af82767a3ac55b9b242a6"><td class="memTemplParams" colspan="2">template&lt;class _Tp &gt; </td></tr>

  138. <tr class="memitem:af2f4800aa77af82767a3ac55b9b242a6"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi__i__details.html#af2f4800aa77af82767a3ac55b9b242a6">utl::spi_i_details::try_clock_t</a> = decltype(declval&lt; _Tp &gt;().clock(declval&lt; uint32_t &gt;()))</td></tr>

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

  140. <tr class="memitem:a755d8f10cfde3f5c3b9900eb11c858bd"><td class="memTemplParams" colspan="2">template&lt;class _Tp &gt; </td></tr>

  141. <tr class="memitem:a755d8f10cfde3f5c3b9900eb11c858bd"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi__i__details.html#a755d8f10cfde3f5c3b9900eb11c858bd">utl::spi_i_details::try_tx_t</a> = decltype(declval&lt; _Tp &gt;().tx_data(declval&lt; byte_t &gt;()))</td></tr>

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

  143. <tr class="memitem:a4dcf3c71fddf790e45a3be2c19906c97"><td class="memTemplParams" colspan="2">template&lt;class _Tp &gt; </td></tr>

  144. <tr class="memitem:a4dcf3c71fddf790e45a3be2c19906c97"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi__i__details.html#a4dcf3c71fddf790e45a3be2c19906c97">utl::spi_i_details::try_rx_t</a> = decltype(declval&lt; _Tp &gt;().rx_data())</td></tr>

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

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

  147. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>

  148. Enumerations</h2></td></tr>

  149. <tr class="memitem:aed6b713381c193c598572ebac0b284cc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi.html#aed6b713381c193c598572ebac0b284cc">utl::spi::bitOrder</a> { <a class="el" href="namespaceutl_1_1spi.html#aed6b713381c193c598572ebac0b284cca6db67adee32c3bd4ff03acf3244e1b4b">utl::spi::bitOrder::LSB_First</a> =0x01, 

  150. <a class="el" href="namespaceutl_1_1spi.html#aed6b713381c193c598572ebac0b284cca47bde70fdcc82c8363d16c7137641b79">utl::spi::bitOrder::MSB_First</a> =0x80

  151.  }</td></tr>

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

  153. <tr class="memitem:a89e3e1af5df0b6c37239f7e336969f8a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi.html#a89e3e1af5df0b6c37239f7e336969f8a">utl::spi::cpol</a> { <a class="el" href="namespaceutl_1_1spi.html#a89e3e1af5df0b6c37239f7e336969f8aa41bc94cbd8eebea13ce0491b2ac11b88">utl::spi::cpol::LOW</a> =0, 

  154. <a class="el" href="namespaceutl_1_1spi.html#a89e3e1af5df0b6c37239f7e336969f8aab89de3b4b81c4facfac906edf29aec8c">utl::spi::cpol::HIGH</a>

  155.  }</td></tr>

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

  157. <tr class="memitem:aa49fe33d495226891cef0a870cba59df"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceutl_1_1spi.html#aa49fe33d495226891cef0a870cba59df">utl::spi::cpha</a> { <a class="el" href="namespaceutl_1_1spi.html#aa49fe33d495226891cef0a870cba59dfa41bc94cbd8eebea13ce0491b2ac11b88">utl::spi::cpha::LOW</a> =0, 

  158. <a class="el" href="namespaceutl_1_1spi.html#aa49fe33d495226891cef0a870cba59dfab89de3b4b81c4facfac906edf29aec8c">utl::spi::cpha::HIGH</a>

  159.  }</td></tr>

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

  161. </table>

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

  163. <div class="textblock"><p>An Abstract base class interface for the spi bus. </p>

  164. <p>Copyright (C) 2018 Christos Choutouridis</p>

  165. <p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>

  166. <p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</p>

  167. <p>You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>. </p>

  168. 

  169. <p class="definition">Definition in file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>

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

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

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

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

  174.   <ul>

  175.     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_82754f54d9380477ef02477185c1f103.html">utl</a></li><li class="navelem"><a class="el" href="dir_b2ad3c1a6521a4924fa9194d98c323e2.html">com</a></li><li class="navelem"><a class="el" href="spi_8h.html">spi.h</a></li>

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

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

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

  179.   </ul>

  180. </div>

  181. </body>

  182. </html>