hoo2
/
utl

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uTL: include/utl/com/spi.h File Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</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">uTL
   </div>
   <div id="projectbrief">micro Template library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('spi_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">spi.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>An Abstract base class interface for the spi bus.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="impl_8h_source.html">utl/core/impl.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="crtp_8h_source.html">utl/core/crtp.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="meta_8h_source.html">utl/meta/meta.h</a>&gt;</code><br />
</div>
<p><a href="spi_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<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>
<tr class="memdesc:namespaceutl"><td class="mdescLeft">&#160;</td><td class="mdescRight">STL's core language concepts. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:namespaceutl_1_1spi"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for spi bus. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ae1a4fad6acf8faccc5e85ee9b710c109"><td class="memTemplParams" colspan="2">template&lt;class _Tp &gt; </td></tr>
<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>
<tr class="separator:ae1a4fad6acf8faccc5e85ee9b710c109"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2f4800aa77af82767a3ac55b9b242a6"><td class="memTemplParams" colspan="2">template&lt;class _Tp &gt; </td></tr>
<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>
<tr class="separator:af2f4800aa77af82767a3ac55b9b242a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a755d8f10cfde3f5c3b9900eb11c858bd"><td class="memTemplParams" colspan="2">template&lt;class _Tp &gt; </td></tr>
<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>
<tr class="separator:a755d8f10cfde3f5c3b9900eb11c858bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dcf3c71fddf790e45a3be2c19906c97"><td class="memTemplParams" colspan="2">template&lt;class _Tp &gt; </td></tr>
<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>
<tr class="separator:a4dcf3c71fddf790e45a3be2c19906c97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<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, 
<a class="el" href="namespaceutl_1_1spi.html#aed6b713381c193c598572ebac0b284cca47bde70fdcc82c8363d16c7137641b79">utl::spi::bitOrder::MSB_First</a> =0x80
 }</td></tr>
<tr class="separator:aed6b713381c193c598572ebac0b284cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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, 
<a class="el" href="namespaceutl_1_1spi.html#a89e3e1af5df0b6c37239f7e336969f8aab89de3b4b81c4facfac906edf29aec8c">utl::spi::cpol::HIGH</a>
 }</td></tr>
<tr class="separator:a89e3e1af5df0b6c37239f7e336969f8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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, 
<a class="el" href="namespaceutl_1_1spi.html#aa49fe33d495226891cef0a870cba59dfab89de3b4b81c4facfac906edf29aec8c">utl::spi::cpha::HIGH</a>
 }</td></tr>
<tr class="separator:aa49fe33d495226891cef0a870cba59df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An Abstract base class interface for the spi bus. </p>
<p>Copyright (C) 2018 Christos Choutouridis</p>
<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>
<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>
<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>

<p class="definition">Definition in file <a class="el" href="spi_8h_source.html">spi.h</a>.</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <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>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
  </ul>
</div>
</body>
</html>