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.

187 lines
8.2KB

  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> &#124;
  79. <a href="#var-members">Variables</a> </div>
  80. <div class="headertitle">
  81. <div class="title">Software SPI</div> </div>
  82. </div><!--header-->
  83. <div class="contents">
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  86. Classes</h2></td></tr>
  87. <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>
  88. <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>
  89. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table><table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  92. Macros</h2></td></tr>
  93. <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>
  94. <tr class="separator:ga51158539d4d6022c9a445e78b0abfa94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table><table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  97. Variables</h2></td></tr>
  98. <tr class="memitem:ga5ed39ec843c7f42ec220a59c0b486718"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#ga5ed39ec843c7f42ec220a59c0b486718">MISO_LEVEL</a> = false</td></tr>
  99. <tr class="separator:ga5ed39ec843c7f42ec220a59c0b486718"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:gad7667379ccd35490d35bb159b1492ea2"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#gad7667379ccd35490d35bb159b1492ea2">MISO_MODE</a> = false</td></tr>
  101. <tr class="separator:gad7667379ccd35490d35bb159b1492ea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:gadfe834b166b0ff6be3271f17420e72ec"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#gadfe834b166b0ff6be3271f17420e72ec">MOSI_MODE</a> = true</td></tr>
  103. <tr class="separator:gadfe834b166b0ff6be3271f17420e72ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:gac89532527cf817a2f48730a107fe82ae"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__soft_s_p_i.html#gac89532527cf817a2f48730a107fe82ae">SCK_MODE</a> = true</td></tr>
  105. <tr class="separator:gac89532527cf817a2f48730a107fe82ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table>
  107. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  108. <p>Software SPI Template Class. </p>
  109. <h2 class="groupheader">Macro Definition Documentation</h2>
  110. <a class="anchor" id="ga51158539d4d6022c9a445e78b0abfa94"></a>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="memname">
  114. <tr>
  115. <td class="memname">#define nop&#160;&#160;&#160;asm volatile (&quot;nop\n\t&quot;)</td>
  116. </tr>
  117. </table>
  118. </div><div class="memdoc">
  119. <p>Nop for timing. </p>
  120. </div>
  121. </div>
  122. <h2 class="groupheader">Variable Documentation</h2>
  123. <a class="anchor" id="ga5ed39ec843c7f42ec220a59c0b486718"></a>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">const bool MISO_LEVEL = false</td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <p>Pullups disabled for MISO are disabled. </p>
  133. </div>
  134. </div>
  135. <a class="anchor" id="gad7667379ccd35490d35bb159b1492ea2"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">const bool MISO_MODE = false</td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Pin Mode for MISO is input. </p>
  145. </div>
  146. </div>
  147. <a class="anchor" id="gadfe834b166b0ff6be3271f17420e72ec"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">const bool MOSI_MODE = true</td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. <p>Pin Mode for MOSI is output. </p>
  157. </div>
  158. </div>
  159. <a class="anchor" id="gac89532527cf817a2f48730a107fe82ae"></a>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">const bool SCK_MODE = true</td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. <p>Pin Mode for SCK is output. </p>
  169. </div>
  170. </div>
  171. </div><!-- contents -->
  172. <!-- start footer part -->
  173. <hr class="footer"/><address class="footer"><small>
  174. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  175. <img class="footer" src="doxygen.png" alt="doxygen"/>
  176. </a> 1.8.10
  177. </small></address>
  178. </body>
  179. </html>