|
- <!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: test_spi::SPI Class 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&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&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&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&dn=gpl-2.0.txt GPL-v2 */
- $(document).ready(function(){initNavTree('classtest__spi_1_1_s_p_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-methods">Public Member Functions</a> |
- <a href="classtest__spi_1_1_s_p_i-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">test_spi::SPI Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <div class="dynheader">
- Inheritance diagram for test_spi::SPI:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="classtest__spi_1_1_s_p_i.png" usemap="#test_5Fspi::SPI_map" alt=""/>
- <map id="test_5Fspi::SPI_map" name="test_5Fspi::SPI_map">
- <area href="classutl_1_1spi__bb__i.html" alt="utl::spi_bb_i< SPI, spi::cpol::LOW, spi::cpha::LOW >" shape="rect" coords="0,56,401,80"/>
- <area href="classutl_1_1spi__i.html" alt="utl::spi_i< spi_bb_i< SPI, CPOL, CPHA, spi::bitOrder::MSB_First > >" shape="rect" coords="0,0,401,24"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a588741b66c9890b0d47d84a09f8a19ce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtest__spi_1_1_s_p_i.html#a588741b66c9890b0d47d84a09f8a19ce">SPI</a> (uint32_t clk=100000) noexcept</td></tr>
- <tr class="separator:a588741b66c9890b0d47d84a09f8a19ce"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classutl_1_1spi__i"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classutl_1_1spi__i')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classutl_1_1spi__i.html">utl::spi_i< spi_bb_i< SPI, CPOL, CPHA, spi::bitOrder::MSB_First > ></a></td></tr>
- <tr class="memitem:a24cdd0c5ce4ed45a6c1b88ea43328634 inherit pub_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top">uint32_t </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 inherit pub_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0ebb46a523ace45fd69950f90f9b3af4 inherit pub_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top">void </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 inherit pub_methods_classutl_1_1spi__i"><td class="mdescLeft"> </td><td class="mdescRight">set clock frequency of the bus <a href="classutl_1_1spi__i.html#a0ebb46a523ace45fd69950f90f9b3af4">More...</a><br /></td></tr>
- <tr class="separator:a0ebb46a523ace45fd69950f90f9b3af4 inherit pub_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac8376d88480a992ac47699637e1a29a5 inherit pub_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> </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 inherit pub_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af3e303c2982202261700044d31596248 inherit pub_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a> </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 inherit pub_methods_classutl_1_1spi__i"><td class="mdescLeft"> </td><td class="mdescRight">Transmit a number of bytes to the spi bus and read the response. <a href="classutl_1_1spi__i.html#af3e303c2982202261700044d31596248">More...</a><br /></td></tr>
- <tr class="separator:af3e303c2982202261700044d31596248 inherit pub_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a846dead32b91efcb48eed614daf68e8f inherit pub_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a1427cb5a2b13313147a902173b91e3c1">byte_t</a> </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 inherit pub_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2053009da5364ead720aebd7cc537c21 inherit pub_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceutl.html#a22cbecb50ee5c1032de66133e96cbac6">size_t</a> </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 inherit pub_methods_classutl_1_1spi__i"><td class="mdescLeft"> </td><td class="mdescRight">Receive a number of bytes from the spi bus while transmitting 0xFFs. <a href="classutl_1_1spi__i.html#a2053009da5364ead720aebd7cc537c21">More...</a><br /></td></tr>
- <tr class="separator:a2053009da5364ead720aebd7cc537c21 inherit pub_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header pub_types_classutl_1_1spi__bb__i"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classutl_1_1spi__bb__i')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classutl_1_1spi__bb__i.html">utl::spi_bb_i< SPI, spi::cpol::LOW, spi::cpha::LOW ></a></td></tr>
- <tr class="memitem:a86ccf004bf5ccc8b7c73bd0f9e8dbaa7 inherit pub_types_classutl_1_1spi__bb__i"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__bb__i.html#a86ccf004bf5ccc8b7c73bd0f9e8dbaa7">type</a> = <a class="el" href="classutl_1_1spi__bb__i.html">spi_bb_i</a>< SPI, CPOL, CPHA, spi::bitOrder::MSB_First ></td></tr>
- <tr class="memdesc:a86ccf004bf5ccc8b7c73bd0f9e8dbaa7 inherit pub_types_classutl_1_1spi__bb__i"><td class="mdescLeft"> </td><td class="mdescRight">Export type as identity meta-function. <a href="classutl_1_1spi__bb__i.html#a86ccf004bf5ccc8b7c73bd0f9e8dbaa7">More...</a><br /></td></tr>
- <tr class="separator:a86ccf004bf5ccc8b7c73bd0f9e8dbaa7 inherit pub_types_classutl_1_1spi__bb__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_types_classutl_1_1spi__i"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classutl_1_1spi__i')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classutl_1_1spi__i.html">utl::spi_i< spi_bb_i< SPI, CPOL, CPHA, spi::bitOrder::MSB_First > ></a></td></tr>
- <tr class="memitem:aff8ee0a2160cddbb52fce46611a6108f inherit pub_types_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top">using </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>< <a class="el" href="classutl_1_1spi__bb__i.html">spi_bb_i</a>< SPI, CPOL, CPHA, spi::bitOrder::MSB_First > ></td></tr>
- <tr class="memdesc:aff8ee0a2160cddbb52fce46611a6108f inherit pub_types_classutl_1_1spi__i"><td class="mdescLeft"> </td><td class="mdescRight">Export type as identity meta-function. <a href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">More...</a><br /></td></tr>
- <tr class="separator:aff8ee0a2160cddbb52fce46611a6108f inherit pub_types_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_classutl_1_1spi__bb__i"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classutl_1_1spi__bb__i')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classutl_1_1spi__bb__i.html">utl::spi_bb_i< SPI, spi::cpol::LOW, spi::cpha::LOW ></a></td></tr>
- <tr class="memitem:aeac57567cb7db5ebb73bdd8e1f00cb82 inherit pro_methods_classutl_1_1spi__bb__i"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__bb__i.html#aeac57567cb7db5ebb73bdd8e1f00cb82">~spi_bb_i</a> ()=default</td></tr>
- <tr class="separator:aeac57567cb7db5ebb73bdd8e1f00cb82 inherit pro_methods_classutl_1_1spi__bb__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a49a61ba9a8e140e45d73e1f634061c6a inherit pro_methods_classutl_1_1spi__bb__i"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classutl_1_1spi__bb__i.html#a49a61ba9a8e140e45d73e1f634061c6a">spi_bb_i</a> (uint32_t clk) noexcept</td></tr>
- <tr class="memdesc:a49a61ba9a8e140e45d73e1f634061c6a inherit pro_methods_classutl_1_1spi__bb__i"><td class="mdescLeft"> </td><td class="mdescRight">A default constructor. <a href="classutl_1_1spi__bb__i.html#a49a61ba9a8e140e45d73e1f634061c6a">More...</a><br /></td></tr>
- <tr class="separator:a49a61ba9a8e140e45d73e1f634061c6a inherit pro_methods_classutl_1_1spi__bb__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_classutl_1_1spi__i"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classutl_1_1spi__i')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classutl_1_1spi__i.html">utl::spi_i< spi_bb_i< SPI, CPOL, CPHA, spi::bitOrder::MSB_First > ></a></td></tr>
- <tr class="memitem:ad66605cdf90f6d24cad3dc5ecda94b77 inherit pro_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top"> </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 inherit pro_methods_classutl_1_1spi__i"><td class="mdescLeft"> </td><td class="mdescRight">Allow constructor from derived only. <a href="classutl_1_1spi__i.html#ad66605cdf90f6d24cad3dc5ecda94b77">More...</a><br /></td></tr>
- <tr class="separator:ad66605cdf90f6d24cad3dc5ecda94b77 inherit pro_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1d6facb9b9adf91a6589fe029325bd55 inherit pro_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top"> </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> &)=delete</td></tr>
- <tr class="memdesc:a1d6facb9b9adf91a6589fe029325bd55 inherit pro_methods_classutl_1_1spi__i"><td class="mdescLeft"> </td><td class="mdescRight">No copies. <a href="classutl_1_1spi__i.html#a1d6facb9b9adf91a6589fe029325bd55">More...</a><br /></td></tr>
- <tr class="separator:a1d6facb9b9adf91a6589fe029325bd55 inherit pro_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae77cb8be7d648a62a1ad252d829eccfb inherit pro_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top"> </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 inherit pro_methods_classutl_1_1spi__i"><td class="mdescLeft"> </td><td class="mdescRight">Allow destructor from derived only. <a href="classutl_1_1spi__i.html#ae77cb8be7d648a62a1ad252d829eccfb">More...</a><br /></td></tr>
- <tr class="separator:ae77cb8be7d648a62a1ad252d829eccfb inherit pro_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa5cf05ce005cb23e6317b3eef70bf4b0 inherit pro_methods_classutl_1_1spi__i"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classutl_1_1spi__i.html#aff8ee0a2160cddbb52fce46611a6108f">type</a> & </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> &)=delete</td></tr>
- <tr class="separator:aa5cf05ce005cb23e6317b3eef70bf4b0 inherit pro_methods_classutl_1_1spi__i"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock">
- <p class="definition">Definition at line <a class="el" href="test__spi__impl_8cpp_source.html#l00034">34</a> of file <a class="el" href="test__spi__impl_8cpp_source.html">test_spi_impl.cpp</a>.</p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a588741b66c9890b0d47d84a09f8a19ce"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a588741b66c9890b0d47d84a09f8a19ce">◆ </a></span>SPI()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">test_spi::SPI::SPI </td>
- <td>(</td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>clk</em> = <code>100000</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p class="definition">Definition at line <a class="el" href="test__spi__impl_8cpp_source.html#l00042">42</a> of file <a class="el" href="test__spi__impl_8cpp_source.html">test_spi_impl.cpp</a>.</p>
-
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>test/tests/<a class="el" href="test__spi__impl_8cpp_source.html">test_spi_impl.cpp</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="namespacetest__spi.html">test_spi</a></li><li class="navelem"><a class="el" href="classtest__spi_1_1_s_p_i.html">SPI</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>
|