您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

393 行
19KB

  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.8"/>
  7. <title>SdFat: SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt; Class Template Reference</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/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">SdFat
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.8 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="modules.html"><span>Modules</span></a></li>
  41. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  64. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  65. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. </div><!-- top -->
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#pub-methods">Public Member Functions</a> &#124;
  84. <a href="class_sd_spi_soft-members.html">List of all members</a> </div>
  85. <div class="headertitle">
  86. <div class="title">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt; Class Template Reference</div> </div>
  87. </div><!--header-->
  88. <div class="contents">
  89. <p>Software SPI class for access to SD and SDHC flash memory cards.
  90. <a href="class_sd_spi_soft.html#details">More...</a></p>
  91. <p><code>#include &lt;SdSpi.h&gt;</code></p>
  92. <div class="dynheader">
  93. Inheritance diagram for SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;:</div>
  94. <div class="dyncontent">
  95. <div class="center"><img src="class_sd_spi_soft__inherit__graph.png" border="0" usemap="#_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map" alt="Inheritance graph"/></div>
  96. <map name="_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map" id="_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map">
  97. <area shape="rect" id="node2" href="class_sd_spi_base.html" title="Virtual SPI class for access to SD and SDHC flash memory cards. " alt="" coords="33,5,119,32"/> </map>
  98. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  99. <div class="dynheader">
  100. Collaboration diagram for SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;:</div>
  101. <div class="dyncontent">
  102. <div class="center"><img src="class_sd_spi_soft__coll__graph.png" border="0" usemap="#_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map" alt="Collaboration graph"/></div>
  103. <map name="_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map" id="_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map">
  104. <area shape="rect" id="node2" href="class_sd_spi_base.html" title="Virtual SPI class for access to SD and SDHC flash memory cards. " alt="" coords="33,5,119,32"/> </map>
  105. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  106. <table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  108. Public Member Functions</h2></td></tr>
  109. <tr class="memitem:afb2de7342f5510ce8b7759cd8bb3810e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_soft.html#afb2de7342f5510ce8b7759cd8bb3810e">begin</a> ()</td></tr>
  110. <tr class="separator:afb2de7342f5510ce8b7759cd8bb3810e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a09805938ac313cf6a6b6ea4c93d7422e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_soft.html#a09805938ac313cf6a6b6ea4c93d7422e">init</a> (uint8_t divisor)</td></tr>
  112. <tr class="separator:a09805938ac313cf6a6b6ea4c93d7422e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a8a004fe608a81458a1aa3a6716a80d74"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_soft.html#a8a004fe608a81458a1aa3a6716a80d74">receive</a> ()</td></tr>
  114. <tr class="separator:a8a004fe608a81458a1aa3a6716a80d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a256f21aeaff4f15a7a5402cccbcc32f1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_soft.html#a256f21aeaff4f15a7a5402cccbcc32f1">receive</a> (uint8_t *buf, size_t n)</td></tr>
  116. <tr class="separator:a256f21aeaff4f15a7a5402cccbcc32f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a96224c2c89d9b6118a2979252d682c2a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_soft.html#a96224c2c89d9b6118a2979252d682c2a">send</a> (uint8_t data)</td></tr>
  118. <tr class="separator:a96224c2c89d9b6118a2979252d682c2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a7f4cada25994f77cb8ed51f71465e334"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_soft.html#a7f4cada25994f77cb8ed51f71465e334">send</a> (const uint8_t *buf, size_t n)</td></tr>
  120. <tr class="separator:a7f4cada25994f77cb8ed51f71465e334"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:aa269a343795b07845e6280db8b36dccb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_soft.html#aa269a343795b07845e6280db8b36dccb">useSpiTransactions</a> ()</td></tr>
  122. <tr class="separator:aa269a343795b07845e6280db8b36dccb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table>
  124. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  125. <div class="textblock"><h3>template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt;<br />
  126. class SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</h3>
  127. <p>Software SPI class for access to SD and SDHC flash memory cards. </p>
  128. </div><h2 class="groupheader">Member Function Documentation</h2>
  129. <a class="anchor" id="afb2de7342f5510ce8b7759cd8bb3810e"></a>
  130. <div class="memitem">
  131. <div class="memproto">
  132. <div class="memtemplate">
  133. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  134. <table class="mlabels">
  135. <tr>
  136. <td class="mlabels-left">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">void <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::begin </td>
  140. <td>(</td>
  141. <td class="paramname"></td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </td>
  146. <td class="mlabels-right">
  147. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>initialize SPI pins </p>
  152. <p>Implements <a class="el" href="class_sd_spi_base.html#a1412739cdbfc3674d707736e3d9a70eb">SdSpiBase</a>.</p>
  153. </div>
  154. </div>
  155. <a class="anchor" id="a09805938ac313cf6a6b6ea4c93d7422e"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <div class="memtemplate">
  159. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">void <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::init </td>
  166. <td>(</td>
  167. <td class="paramtype">uint8_t&#160;</td>
  168. <td class="paramname"><em>divisor</em></td><td>)</td>
  169. <td></td>
  170. </tr>
  171. </table>
  172. </td>
  173. <td class="mlabels-right">
  174. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p>Initialize hardware SPI - dummy for soft SPI </p><dl class="params"><dt>Parameters</dt><dd>
  179. <table class="params">
  180. <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SCK divisor - ignored. </td></tr>
  181. </table>
  182. </dd>
  183. </dl>
  184. <p>Reimplemented from <a class="el" href="class_sd_spi_base.html#abe0412d1728f3628f81caf05ce8fe93b">SdSpiBase</a>.</p>
  185. </div>
  186. </div>
  187. <a class="anchor" id="a8a004fe608a81458a1aa3a6716a80d74"></a>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <div class="memtemplate">
  191. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  192. <table class="mlabels">
  193. <tr>
  194. <td class="mlabels-left">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">uint8_t <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::receive </td>
  198. <td>(</td>
  199. <td class="paramname"></td><td>)</td>
  200. <td></td>
  201. </tr>
  202. </table>
  203. </td>
  204. <td class="mlabels-right">
  205. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <p>Receive a byte.</p>
  210. <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>
  211. <p>Implements <a class="el" href="class_sd_spi_base.html#a3488ab01ed4412f2c7143cfd10a7503c">SdSpiBase</a>.</p>
  212. </div>
  213. </div>
  214. <a class="anchor" id="a256f21aeaff4f15a7a5402cccbcc32f1"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <div class="memtemplate">
  218. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">uint8_t <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::receive </td>
  225. <td>(</td>
  226. <td class="paramtype">uint8_t *&#160;</td>
  227. <td class="paramname"><em>buf</em>, </td>
  228. </tr>
  229. <tr>
  230. <td class="paramkey"></td>
  231. <td></td>
  232. <td class="paramtype">size_t&#160;</td>
  233. <td class="paramname"><em>n</em>&#160;</td>
  234. </tr>
  235. <tr>
  236. <td></td>
  237. <td>)</td>
  238. <td></td><td></td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Receive multiple bytes.</p>
  248. <dl class="params"><dt>Parameters</dt><dd>
  249. <table class="params">
  250. <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the data. </td></tr>
  251. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to receive.</td></tr>
  252. </table>
  253. </dd>
  254. </dl>
  255. <dl class="section return"><dt>Returns</dt><dd>Zero for no error or nonzero error code. </dd></dl>
  256. <p>Implements <a class="el" href="class_sd_spi_base.html#af5810e79d39a9f6de6435f92401531be">SdSpiBase</a>.</p>
  257. </div>
  258. </div>
  259. <a class="anchor" id="a96224c2c89d9b6118a2979252d682c2a"></a>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <div class="memtemplate">
  263. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  264. <table class="mlabels">
  265. <tr>
  266. <td class="mlabels-left">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">void <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::send </td>
  270. <td>(</td>
  271. <td class="paramtype">uint8_t&#160;</td>
  272. <td class="paramname"><em>data</em></td><td>)</td>
  273. <td></td>
  274. </tr>
  275. </table>
  276. </td>
  277. <td class="mlabels-right">
  278. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>Send a byte.</p>
  283. <dl class="params"><dt>Parameters</dt><dd>
  284. <table class="params">
  285. <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>
  286. </table>
  287. </dd>
  288. </dl>
  289. <p>Implements <a class="el" href="class_sd_spi_base.html#a1f43194a47cb5403e82af651a370be00">SdSpiBase</a>.</p>
  290. </div>
  291. </div>
  292. <a class="anchor" id="a7f4cada25994f77cb8ed51f71465e334"></a>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <div class="memtemplate">
  296. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  297. <table class="mlabels">
  298. <tr>
  299. <td class="mlabels-left">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname">void <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::send </td>
  303. <td>(</td>
  304. <td class="paramtype">const uint8_t *&#160;</td>
  305. <td class="paramname"><em>buf</em>, </td>
  306. </tr>
  307. <tr>
  308. <td class="paramkey"></td>
  309. <td></td>
  310. <td class="paramtype">size_t&#160;</td>
  311. <td class="paramname"><em>n</em>&#160;</td>
  312. </tr>
  313. <tr>
  314. <td></td>
  315. <td>)</td>
  316. <td></td><td></td>
  317. </tr>
  318. </table>
  319. </td>
  320. <td class="mlabels-right">
  321. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  322. </tr>
  323. </table>
  324. </div><div class="memdoc">
  325. <p>Send multiple bytes.</p>
  326. <dl class="params"><dt>Parameters</dt><dd>
  327. <table class="params">
  328. <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for data to be sent. </td></tr>
  329. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to send. </td></tr>
  330. </table>
  331. </dd>
  332. </dl>
  333. <p>Implements <a class="el" href="class_sd_spi_base.html#a109f2f4213e7a763fb4e4dd3ec605c3b">SdSpiBase</a>.</p>
  334. </div>
  335. </div>
  336. <a class="anchor" id="aa269a343795b07845e6280db8b36dccb"></a>
  337. <div class="memitem">
  338. <div class="memproto">
  339. <div class="memtemplate">
  340. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>
  341. <table class="mlabels">
  342. <tr>
  343. <td class="mlabels-left">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">bool <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::useSpiTransactions </td>
  347. <td>(</td>
  348. <td class="paramname"></td><td>)</td>
  349. <td></td>
  350. </tr>
  351. </table>
  352. </td>
  353. <td class="mlabels-right">
  354. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <dl class="section return"><dt>Returns</dt><dd>false - no SPI transactions </dd></dl>
  359. <p>Implements <a class="el" href="class_sd_spi_base.html#a0a13df4c86ec6978878b63386ee65007">SdSpiBase</a>.</p>
  360. </div>
  361. </div>
  362. <hr/>The documentation for this class was generated from the following file:<ul>
  363. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_spi_8h.html">SdSpi.h</a></li>
  364. </ul>
  365. </div><!-- contents -->
  366. <!-- start footer part -->
  367. <hr class="footer"/><address class="footer"><small>
  368. Generated on Thu Dec 4 2014 08:53:21 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  369. <img class="footer" src="doxygen.png" alt="doxygen"/>
  370. </a> 1.8.8
  371. </small></address>
  372. </body>
  373. </html>