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: utl::spi_i&lt; impl_t &gt; Class Template 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('classutl_1_1spi__i.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="#pub-types">Public Types</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="classutl_1_1spi__i-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">utl::spi_i&lt; impl_t &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="spi_8h_source.html">spi.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<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>
<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>
<tr class="separator:aff8ee0a2160cddbb52fce46611a6108f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Get/Set functions provided by the interface</div></td></tr>
<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>
<tr class="separator:a24cdd0c5ce4ed45a6c1b88ea43328634"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a0ebb46a523ace45fd69950f90f9b3af4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">I/O functions provided by the interface</div></td></tr>
<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>
<tr class="separator:ac8376d88480a992ac47699637e1a29a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:af3e303c2982202261700044d31596248"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a846dead32b91efcb48eed614daf68e8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a2053009da5364ead720aebd7cc537c21"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Object lifetime</div></td></tr>
<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>
<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>
<tr class="separator:ad66605cdf90f6d24cad3dc5ecda94b77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ae77cb8be7d648a62a1ad252d829eccfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:a1d6facb9b9adf91a6589fe029325bd55"><td class="mdescLeft">&#160;</td><td class="mdescRight">No copies.  <a href="#a1d6facb9b9adf91a6589fe029325bd55">More...</a><br /></td></tr>
<tr class="separator:a1d6facb9b9adf91a6589fe029325bd55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aa5cf05ce005cb23e6317b3eef70bf4b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<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>
<tr class="separator:adfab771b0e399b9f482e42aaa5e9db11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Implementation requirements</div></td></tr>
<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>
</div></td></tr>
<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>
<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>
<tr class="separator:a68a21ac9727eed3802ce7d1181ac4f8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:af0a9bfc5d02ccd2bfbe8044132884578"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:acf3ffd9c79d4cdeac100cf3273120689"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename impl_t&gt;<br />
class utl::spi_i&lt; impl_t &gt;</h3>

<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>
  <table class="params">
    <tr><td class="paramname">impl_t</td><td>The CRTP type (the derived/implementation class typename). </td></tr>
  </table>
  </dd>
</dl>

<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>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="aff8ee0a2160cddbb52fce46611a6108f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff8ee0a2160cddbb52fce46611a6108f">&#9670;&nbsp;</a></span>type</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
      <table class="memname">
        <tr>
          <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>
        </tr>
      </table>
</div><div class="memdoc">

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

<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>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad66605cdf90f6d24cad3dc5ecda94b77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad66605cdf90f6d24cad3dc5ecda94b77">&#9670;&nbsp;</a></span>spi_i() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>No copies. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a68a21ac9727eed3802ce7d1181ac4f8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68a21ac9727eed3802ce7d1181ac4f8c">&#9670;&nbsp;</a></span>_clock() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::_clock </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<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>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::_clock </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>c</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<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>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::_CRTP_IMPL </td>
          <td>(</td>
          <td class="paramtype">impl_t&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td>
          <td class="paramname"><em>b</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Transmit a byte on the bus and return the response </p>

<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>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::clock </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>clock frequency of the bus </dd></dl>

<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>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classutl_1_1spi__i.html">utl::spi_i</a>&lt; impl_t &gt;::clock </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>c</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<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>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Receive a byte from spi bus while transmitting 0xFF </p>

<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>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename _I &gt; </div>
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *&#160;</td>
          <td class="paramname"><em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a>&#160;</td>
          <td class="paramname"><em>n</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Receive a number of bytes from the spi bus while transmitting 0xFFs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">in</td><td>Pointer to buffer to store the data </td></tr>
    <tr><td class="paramname">n</td><td>The number of bytes to read </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of received bytes. </dd></dl>

<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>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename impl_t&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a>&#160;</td>
          <td class="paramname"><em>out</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Transmit a byte to spi bus and return the response </p>

<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>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename _I &gt; </div>
      <table class="memname">
        <tr>
          <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>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *&#160;</td>
          <td class="paramname"><em>out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> *&#160;</td>
          <td class="paramname"><em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a>&#160;</td>
          <td class="paramname"><em>n</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Transmit a number of bytes to the spi bus and read the response. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">out</td><td>Pointer to data to send to the bus </td></tr>
    <tr><td class="paramname">in</td><td>Pointer to buffer to store the data from the bus </td></tr>
    <tr><td class="paramname">n</td><td>The number of bytes to transmit/receive </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes. </dd></dl>

<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>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/utl/com/<a class="el" href="spi_8h_source.html">spi.h</a></li>
</ul>
</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="namespaceutl.html">utl</a></li><li class="navelem"><a class="el" href="classutl_1_1spi__i.html">spi_i</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>