Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

370 rindas
18KB

  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: SdSpiBase Class 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_base-members.html">List of all members</a> </div>
  85. <div class="headertitle">
  86. <div class="title">SdSpiBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  87. </div><!--header-->
  88. <div class="contents">
  89. <p>Virtual SPI class for access to SD and SDHC flash memory cards.
  90. <a href="class_sd_spi_base.html#details">More...</a></p>
  91. <p><code>#include &lt;SdSpi.h&gt;</code></p>
  92. <div class="dynheader">
  93. Inheritance diagram for SdSpiBase:</div>
  94. <div class="dyncontent">
  95. <div class="center"><img src="class_sd_spi_base__inherit__graph.png" border="0" usemap="#_sd_spi_base_inherit__map" alt="Inheritance graph"/></div>
  96. <map name="_sd_spi_base_inherit__map" id="_sd_spi_base_inherit__map">
  97. <area shape="rect" id="node3" href="class_sd_spi.html" title="SPI class for access to SD and SDHC flash memory cards. " alt="" coords="5,88,61,115"/> <area shape="rect" id="node5" href="class_sd_spi_lib.html" title="Arduino SPI library class for access to SD and SDHC flash memory cards. " alt="" coords="87,88,161,115"/> <area shape="rect" id="node7" href="class_sd_spi_soft.html" title="Software SPI class for access to SD and SDHC flash memory cards. " alt="" coords="186,81,328,122"/> </map>
  98. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  99. <table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  101. Public Member Functions</h2></td></tr>
  102. <tr class="memitem:a1412739cdbfc3674d707736e3d9a70eb"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base.html#a1412739cdbfc3674d707736e3d9a70eb">begin</a> ()=0</td></tr>
  103. <tr class="separator:a1412739cdbfc3674d707736e3d9a70eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:abe0412d1728f3628f81caf05ce8fe93b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base.html#abe0412d1728f3628f81caf05ce8fe93b">init</a> (uint8_t divisor)</td></tr>
  105. <tr class="separator:abe0412d1728f3628f81caf05ce8fe93b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a3488ab01ed4412f2c7143cfd10a7503c"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base.html#a3488ab01ed4412f2c7143cfd10a7503c">receive</a> ()=0</td></tr>
  107. <tr class="separator:a3488ab01ed4412f2c7143cfd10a7503c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:af5810e79d39a9f6de6435f92401531be"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base.html#af5810e79d39a9f6de6435f92401531be">receive</a> (uint8_t *buf, size_t n)=0</td></tr>
  109. <tr class="separator:af5810e79d39a9f6de6435f92401531be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a1f43194a47cb5403e82af651a370be00"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base.html#a1f43194a47cb5403e82af651a370be00">send</a> (uint8_t data)=0</td></tr>
  111. <tr class="separator:a1f43194a47cb5403e82af651a370be00"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a109f2f4213e7a763fb4e4dd3ec605c3b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base.html#a109f2f4213e7a763fb4e4dd3ec605c3b">send</a> (const uint8_t *buf, size_t n)=0</td></tr>
  113. <tr class="separator:a109f2f4213e7a763fb4e4dd3ec605c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a0a13df4c86ec6978878b63386ee65007"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base.html#a0a13df4c86ec6978878b63386ee65007">useSpiTransactions</a> ()=0</td></tr>
  115. <tr class="separator:a0a13df4c86ec6978878b63386ee65007"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table>
  117. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  118. <div class="textblock"><p>Virtual SPI class for access to SD and SDHC flash memory cards. </p>
  119. </div><h2 class="groupheader">Member Function Documentation</h2>
  120. <a class="anchor" id="a1412739cdbfc3674d707736e3d9a70eb"></a>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="mlabels">
  124. <tr>
  125. <td class="mlabels-left">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">virtual void SdSpiBase::begin </td>
  129. <td>(</td>
  130. <td class="paramname"></td><td>)</td>
  131. <td></td>
  132. </tr>
  133. </table>
  134. </td>
  135. <td class="mlabels-right">
  136. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>Initialize the SPI bus </p>
  141. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#afb2de7342f5510ce8b7759cd8bb3810e">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>, <a class="el" href="class_sd_spi_lib.html#a34be8cc85dbded6ef4364a52d668c16a">SdSpiLib</a>, and <a class="el" href="class_sd_spi.html#a607aa7e4655f29bb16ed75b66ffc2c20">SdSpi</a>.</p>
  142. </div>
  143. </div>
  144. <a class="anchor" id="abe0412d1728f3628f81caf05ce8fe93b"></a>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="mlabels">
  148. <tr>
  149. <td class="mlabels-left">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">virtual void SdSpiBase::init </td>
  153. <td>(</td>
  154. <td class="paramtype">uint8_t&#160;</td>
  155. <td class="paramname"><em>divisor</em></td><td>)</td>
  156. <td></td>
  157. </tr>
  158. </table>
  159. </td>
  160. <td class="mlabels-right">
  161. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Set SPI options for access to SD/SDHC cards.</p>
  166. <dl class="params"><dt>Parameters</dt><dd>
  167. <table class="params">
  168. <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SCK clock divider relative to the system clock. </td></tr>
  169. </table>
  170. </dd>
  171. </dl>
  172. <p>Reimplemented in <a class="el" href="class_sd_spi_soft.html#a09805938ac313cf6a6b6ea4c93d7422e">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>, <a class="el" href="class_sd_spi_lib.html#ae9b100feacd89f0f224704d2bfb02cb3">SdSpiLib</a>, and <a class="el" href="class_sd_spi.html#a1ec1b9408b99ae60e4c62c0ba8d038c2">SdSpi</a>.</p>
  173. </div>
  174. </div>
  175. <a class="anchor" id="a3488ab01ed4412f2c7143cfd10a7503c"></a>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="mlabels">
  179. <tr>
  180. <td class="mlabels-left">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">virtual uint8_t SdSpiBase::receive </td>
  184. <td>(</td>
  185. <td class="paramname"></td><td>)</td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </td>
  190. <td class="mlabels-right">
  191. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>Receive a byte.</p>
  196. <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>
  197. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a8a004fe608a81458a1aa3a6716a80d74">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>, <a class="el" href="class_sd_spi_lib.html#ac3c8027243a2fef5894809cbb7bed837">SdSpiLib</a>, and <a class="el" href="class_sd_spi.html#aa017fd1d2bd196d1cbc4b845f6a72a40">SdSpi</a>.</p>
  198. </div>
  199. </div>
  200. <a class="anchor" id="af5810e79d39a9f6de6435f92401531be"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="mlabels">
  204. <tr>
  205. <td class="mlabels-left">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">virtual uint8_t SdSpiBase::receive </td>
  209. <td>(</td>
  210. <td class="paramtype">uint8_t *&#160;</td>
  211. <td class="paramname"><em>buf</em>, </td>
  212. </tr>
  213. <tr>
  214. <td class="paramkey"></td>
  215. <td></td>
  216. <td class="paramtype">size_t&#160;</td>
  217. <td class="paramname"><em>n</em>&#160;</td>
  218. </tr>
  219. <tr>
  220. <td></td>
  221. <td>)</td>
  222. <td></td><td></td>
  223. </tr>
  224. </table>
  225. </td>
  226. <td class="mlabels-right">
  227. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Receive multiple bytes.</p>
  232. <dl class="params"><dt>Parameters</dt><dd>
  233. <table class="params">
  234. <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the data. </td></tr>
  235. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to receive.</td></tr>
  236. </table>
  237. </dd>
  238. </dl>
  239. <dl class="section return"><dt>Returns</dt><dd>Zero for no error or nonzero error code. </dd></dl>
  240. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a256f21aeaff4f15a7a5402cccbcc32f1">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>, <a class="el" href="class_sd_spi_lib.html#ad835adf6990e6368ec577f00edf365b0">SdSpiLib</a>, and <a class="el" href="class_sd_spi.html#a223c3b67496b7a05035060d68e8b7e0e">SdSpi</a>.</p>
  241. </div>
  242. </div>
  243. <a class="anchor" id="a1f43194a47cb5403e82af651a370be00"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">virtual void SdSpiBase::send </td>
  252. <td>(</td>
  253. <td class="paramtype">uint8_t&#160;</td>
  254. <td class="paramname"><em>data</em></td><td>)</td>
  255. <td></td>
  256. </tr>
  257. </table>
  258. </td>
  259. <td class="mlabels-right">
  260. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Send a byte.</p>
  265. <dl class="params"><dt>Parameters</dt><dd>
  266. <table class="params">
  267. <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>
  268. </table>
  269. </dd>
  270. </dl>
  271. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a96224c2c89d9b6118a2979252d682c2a">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>, <a class="el" href="class_sd_spi_lib.html#a070de2435f58f4f98c224c4b1b4be888">SdSpiLib</a>, and <a class="el" href="class_sd_spi.html#a3c6369cd5cc2e1631bcc24e9194eb09a">SdSpi</a>.</p>
  272. </div>
  273. </div>
  274. <a class="anchor" id="a109f2f4213e7a763fb4e4dd3ec605c3b"></a>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="mlabels">
  278. <tr>
  279. <td class="mlabels-left">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">virtual void SdSpiBase::send </td>
  283. <td>(</td>
  284. <td class="paramtype">const uint8_t *&#160;</td>
  285. <td class="paramname"><em>buf</em>, </td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey"></td>
  289. <td></td>
  290. <td class="paramtype">size_t&#160;</td>
  291. <td class="paramname"><em>n</em>&#160;</td>
  292. </tr>
  293. <tr>
  294. <td></td>
  295. <td>)</td>
  296. <td></td><td></td>
  297. </tr>
  298. </table>
  299. </td>
  300. <td class="mlabels-right">
  301. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Send multiple bytes.</p>
  306. <dl class="params"><dt>Parameters</dt><dd>
  307. <table class="params">
  308. <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for data to be sent. </td></tr>
  309. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to send. </td></tr>
  310. </table>
  311. </dd>
  312. </dl>
  313. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a7f4cada25994f77cb8ed51f71465e334">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>, <a class="el" href="class_sd_spi_lib.html#a58af4700449aadc2b418fac59fda6e1b">SdSpiLib</a>, and <a class="el" href="class_sd_spi.html#a97ef912cdc43e0800e0184160581f89e">SdSpi</a>.</p>
  314. </div>
  315. </div>
  316. <a class="anchor" id="a0a13df4c86ec6978878b63386ee65007"></a>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="mlabels">
  320. <tr>
  321. <td class="mlabels-left">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">virtual bool SdSpiBase::useSpiTransactions </td>
  325. <td>(</td>
  326. <td class="paramname"></td><td>)</td>
  327. <td></td>
  328. </tr>
  329. </table>
  330. </td>
  331. <td class="mlabels-right">
  332. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <dl class="section return"><dt>Returns</dt><dd>true if hardware SPI else false </dd></dl>
  337. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#aa269a343795b07845e6280db8b36dccb">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>, <a class="el" href="class_sd_spi_lib.html#ad1b8c659d1a7e90b3a43c4e87835245b">SdSpiLib</a>, and <a class="el" href="class_sd_spi.html#a048d54bb93f2f2f86d9a499605dd1427">SdSpi</a>.</p>
  338. </div>
  339. </div>
  340. <hr/>The documentation for this class was generated from the following file:<ul>
  341. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_spi_8h.html">SdSpi.h</a></li>
  342. </ul>
  343. </div><!-- contents -->
  344. <!-- start footer part -->
  345. <hr class="footer"/><address class="footer"><small>
  346. Generated on Thu Dec 4 2014 08:53:21 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  347. <img class="footer" src="doxygen.png" alt="doxygen"/>
  348. </a> 1.8.8
  349. </small></address>
  350. </body>
  351. </html>