group__soft_s_p_i.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  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.10"/>
  7. <title>SdFat: Software SPI</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">SdFat
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#nested-classes">Classes</a> &#124;
  78. <a href="#define-members">Macros</a> </div>
  79. <div class="headertitle">
  80. <div class="title">Software SPI</div> </div>
  81. </div><!--header-->
  82. <div class="contents">
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  85. Classes</h2></td></tr>
  86. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_soft_s_p_i.html">SoftSPI&lt; MisoPin, MosiPin, SckPin, Mode &gt;</a></td></tr>
  87. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast software SPI. <a href="class_soft_s_p_i.html#details">More...</a><br /></td></tr>
  88. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. </table><table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  91. Macros</h2></td></tr>
  92. <tr class="memitem:gad26f209553f49afaa7cc789af2446ea6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#gad26f209553f49afaa7cc789af2446ea6">MISO_LEVEL</a>&#160;&#160;&#160;false</td></tr>
  93. <tr class="separator:gad26f209553f49afaa7cc789af2446ea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ga4f2c19a684a848b1e3b08cf475cded11"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#ga4f2c19a684a848b1e3b08cf475cded11">MISO_MODE</a>&#160;&#160;&#160;INPUT</td></tr>
  95. <tr class="separator:ga4f2c19a684a848b1e3b08cf475cded11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:gaee641e839770c70643f380501c3e3986"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#gaee641e839770c70643f380501c3e3986">MOSI_MODE</a>&#160;&#160;&#160;OUTPUT</td></tr>
  97. <tr class="separator:gaee641e839770c70643f380501c3e3986"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ga51158539d4d6022c9a445e78b0abfa94"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#ga51158539d4d6022c9a445e78b0abfa94">nop</a>&#160;&#160;&#160;asm volatile (&quot;nop\n\t&quot;)</td></tr>
  99. <tr class="separator:ga51158539d4d6022c9a445e78b0abfa94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:gac9d2cd28bbc5b023abb24fc1ab56d34e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#gac9d2cd28bbc5b023abb24fc1ab56d34e">SCK_MODE</a>&#160;&#160;&#160;OUTPUT</td></tr>
  101. <tr class="separator:gac9d2cd28bbc5b023abb24fc1ab56d34e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table>
  103. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  104. <p>Software SPI Template Class. </p>
  105. <h2 class="groupheader">Macro Definition Documentation</h2>
  106. <a class="anchor" id="gad26f209553f49afaa7cc789af2446ea6"></a>
  107. <div class="memitem">
  108. <div class="memproto">
  109. <table class="memname">
  110. <tr>
  111. <td class="memname">#define MISO_LEVEL&#160;&#160;&#160;false</td>
  112. </tr>
  113. </table>
  114. </div><div class="memdoc">
  115. <p>Pullups disabled for MISO are disabled. </p>
  116. </div>
  117. </div>
  118. <a class="anchor" id="ga4f2c19a684a848b1e3b08cf475cded11"></a>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname">#define MISO_MODE&#160;&#160;&#160;INPUT</td>
  124. </tr>
  125. </table>
  126. </div><div class="memdoc">
  127. <p>Pin Mode for MISO is input. </p>
  128. </div>
  129. </div>
  130. <a class="anchor" id="gaee641e839770c70643f380501c3e3986"></a>
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">#define MOSI_MODE&#160;&#160;&#160;OUTPUT</td>
  136. </tr>
  137. </table>
  138. </div><div class="memdoc">
  139. <p>Pin Mode for MOSI is output. </p>
  140. </div>
  141. </div>
  142. <a class="anchor" id="ga51158539d4d6022c9a445e78b0abfa94"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">#define nop&#160;&#160;&#160;asm volatile (&quot;nop\n\t&quot;)</td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>Nop for timing. </p>
  152. </div>
  153. </div>
  154. <a class="anchor" id="gac9d2cd28bbc5b023abb24fc1ab56d34e"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">#define SCK_MODE&#160;&#160;&#160;OUTPUT</td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>Pin Mode for SCK is output. </p>
  164. </div>
  165. </div>
  166. </div><!-- contents -->
  167. <!-- start footer part -->
  168. <hr class="footer"/><address class="footer"><small>
  169. Generated on Tue Jul 19 2016 06:31:51 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  170. <img class="footer" src="doxygen.png" alt="doxygen"/>
  171. </a> 1.8.10
  172. </small></address>
  173. </body>
  174. </html>