visus
/
teensy-sdfat
Obserwuj 1
Polub 0
Forkuj 0
Kod Zgłoszenia 0 Oczekujące zmiany 0 Wydania 0 Wiki Aktywność
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
30 Commity
1 Gałąź
Drzewo: fdb739093c
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z 'fdb739093c'
${ noResults }
teensy-sdfat/html/class_sd_spi_base.html

379 lines
15KB
Czysty Wina Historia 

  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: 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/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 class="current"><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 id="navrow2" class="tabs2">

  63.     <ul class="tablist">

  64.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  65.       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. </div>

  75. 

  76. <!-- iframe showing the search results (closed by default) -->

  77. <div id="MSearchResultsWindow">

  78. <iframe src="javascript:void(0)" frameborder="0" 

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

  83. </div><!-- top -->

  84. <div class="header">

  85.   <div class="summary">

  86. <a href="#pub-methods">Public Member Functions</a> &#124;

  87. <a href="class_sd_spi_base-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

  89. <div class="title">SdSpiBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>

  90. </div><!--header-->

  91. <div class="contents">

  92. 

  93. <p>Virtual SPI class for access to SD and SDHC flash memory cards.  

  94.  <a href="class_sd_spi_base.html#details">More...</a></p>

  95. 

  96. <p><code>#include &lt;SdSpi.h&gt;</code></p>

  97. <div class="dynheader">

  98. Inheritance diagram for SdSpiBase:</div>

  99. <div class="dyncontent">

  100. <div class="center"><img src="class_sd_spi_base__inherit__graph.png" border="0" usemap="#_sd_spi_base_inherit__map" alt="Inheritance graph"/></div>

  101. <map name="_sd_spi_base_inherit__map" id="_sd_spi_base_inherit__map">

  102. <area shape="rect" id="node2" href="class_sd_spi_soft.html" title="Software SPI class for access to SD and SDHC flash memory cards. " alt="" coords="5,80,148,121"/>

  103. </map>

  104. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

  105. <table class="memberdecls">

  106. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  107. Public Member Functions</h2></td></tr>

  108. <tr class="memitem:a4a5455a0024e3e432430cd04953908d1"><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#a4a5455a0024e3e432430cd04953908d1">begin</a> (uint8_t chipSelectPin)=0</td></tr>

  109. <tr class="separator:a4a5455a0024e3e432430cd04953908d1"><td class="memSeparator" colspan="2">&#160;</td></tr>

  110. <tr class="memitem:a31d53d87f8735b3c76876fb150a20378"><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#a31d53d87f8735b3c76876fb150a20378">beginTransaction</a> (uint8_t divisor)</td></tr>

  111. <tr class="separator:a31d53d87f8735b3c76876fb150a20378"><td class="memSeparator" colspan="2">&#160;</td></tr>

  112. <tr class="memitem:aceef8d93a30e4fccb4fd81d4e3c26b55"><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#aceef8d93a30e4fccb4fd81d4e3c26b55">endTransaction</a> ()</td></tr>

  113. <tr class="separator:aceef8d93a30e4fccb4fd81d4e3c26b55"><td class="memSeparator" colspan="2">&#160;</td></tr>

  114. <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>

  115. <tr class="separator:a3488ab01ed4412f2c7143cfd10a7503c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  116. <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>

  117. <tr class="separator:af5810e79d39a9f6de6435f92401531be"><td class="memSeparator" colspan="2">&#160;</td></tr>

  118. <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>

  119. <tr class="separator:a1f43194a47cb5403e82af651a370be00"><td class="memSeparator" colspan="2">&#160;</td></tr>

  120. <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>

  121. <tr class="separator:a109f2f4213e7a763fb4e4dd3ec605c3b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  122. </table>

  123. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  124. <div class="textblock"><p>Virtual SPI class for access to SD and SDHC flash memory cards. </p>

  125. </div><h2 class="groupheader">Member Function Documentation</h2>

  126. <a class="anchor" id="a4a5455a0024e3e432430cd04953908d1"></a>

  127. <div class="memitem">

  128. <div class="memproto">

  129. <table class="mlabels">

  130.   <tr>

  131.   <td class="mlabels-left">

  132.       <table class="memname">

  133.         <tr>

  134.           <td class="memname">virtual void SdSpiBase::begin </td>

  135.           <td>(</td>

  136.           <td class="paramtype">uint8_t&#160;</td>

  137.           <td class="paramname"><em>chipSelectPin</em></td><td>)</td>

  138.           <td></td>

  139.         </tr>

  140.       </table>

  141.   </td>

  142.   <td class="mlabels-right">

  143. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  144.   </tr>

  145. </table>

  146. </div><div class="memdoc">

  147. <p>Initialize the SPI bus.</p>

  148. <dl class="params"><dt>Parameters</dt><dd>

  149.   <table class="params">

  150.     <tr><td class="paramdir">[in]</td><td class="paramname">chipSelectPin</td><td>SD card chip select pin. </td></tr>

  151.   </table>

  152.   </dd>

  153. </dl>

  154. 

  155. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a957355dae46e184bf7c12cd8306ac2fd">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>

  156. 

  157. </div>

  158. </div>

  159. <a class="anchor" id="a31d53d87f8735b3c76876fb150a20378"></a>

  160. <div class="memitem">

  161. <div class="memproto">

  162. <table class="mlabels">

  163.   <tr>

  164.   <td class="mlabels-left">

  165.       <table class="memname">

  166.         <tr>

  167.           <td class="memname">virtual void SdSpiBase::beginTransaction </td>

  168.           <td>(</td>

  169.           <td class="paramtype">uint8_t&#160;</td>

  170.           <td class="paramname"><em>divisor</em></td><td>)</td>

  171.           <td></td>

  172.         </tr>

  173.       </table>

  174.   </td>

  175.   <td class="mlabels-right">

  176. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>

  177.   </tr>

  178. </table>

  179. </div><div class="memdoc">

  180. <p>Set SPI options for access to SD/SDHC cards.</p>

  181. <dl class="params"><dt>Parameters</dt><dd>

  182.   <table class="params">

  183.     <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SCK clock divider relative to the system clock. </td></tr>

  184.   </table>

  185.   </dd>

  186. </dl>

  187. 

  188. <p>Reimplemented in <a class="el" href="class_sd_spi_soft.html#afe6909bd40f444c4680da3140b81de36">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>

  189. 

  190. </div>

  191. </div>

  192. <a class="anchor" id="aceef8d93a30e4fccb4fd81d4e3c26b55"></a>

  193. <div class="memitem">

  194. <div class="memproto">

  195. <table class="mlabels">

  196.   <tr>

  197.   <td class="mlabels-left">

  198.       <table class="memname">

  199.         <tr>

  200.           <td class="memname">virtual void SdSpiBase::endTransaction </td>

  201.           <td>(</td>

  202.           <td class="paramname"></td><td>)</td>

  203.           <td></td>

  204.         </tr>

  205.       </table>

  206.   </td>

  207.   <td class="mlabels-right">

  208. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>

  209.   </tr>

  210. </table>

  211. </div><div class="memdoc">

  212. <p>End SPI transaction. </p>

  213. 

  214. <p>Reimplemented in <a class="el" href="class_sd_spi_soft.html#a9efd9900dfc03582e433ff8939e96dff">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>

  215. 

  216. </div>

  217. </div>

  218. <a class="anchor" id="a3488ab01ed4412f2c7143cfd10a7503c"></a>

  219. <div class="memitem">

  220. <div class="memproto">

  221. <table class="mlabels">

  222.   <tr>

  223.   <td class="mlabels-left">

  224.       <table class="memname">

  225.         <tr>

  226.           <td class="memname">virtual uint8_t SdSpiBase::receive </td>

  227.           <td>(</td>

  228.           <td class="paramname"></td><td>)</td>

  229.           <td></td>

  230.         </tr>

  231.       </table>

  232.   </td>

  233.   <td class="mlabels-right">

  234. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  235.   </tr>

  236. </table>

  237. </div><div class="memdoc">

  238. <p>Receive a byte.</p>

  239. <dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>

  240. 

  241. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a8a004fe608a81458a1aa3a6716a80d74">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>

  242. 

  243. </div>

  244. </div>

  245. <a class="anchor" id="af5810e79d39a9f6de6435f92401531be"></a>

  246. <div class="memitem">

  247. <div class="memproto">

  248. <table class="mlabels">

  249.   <tr>

  250.   <td class="mlabels-left">

  251.       <table class="memname">

  252.         <tr>

  253.           <td class="memname">virtual uint8_t SdSpiBase::receive </td>

  254.           <td>(</td>

  255.           <td class="paramtype">uint8_t *&#160;</td>

  256.           <td class="paramname"><em>buf</em>, </td>

  257.         </tr>

  258.         <tr>

  259.           <td class="paramkey"></td>

  260.           <td></td>

  261.           <td class="paramtype">size_t&#160;</td>

  262.           <td class="paramname"><em>n</em>&#160;</td>

  263.         </tr>

  264.         <tr>

  265.           <td></td>

  266.           <td>)</td>

  267.           <td></td><td></td>

  268.         </tr>

  269.       </table>

  270.   </td>

  271.   <td class="mlabels-right">

  272. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  273.   </tr>

  274. </table>

  275. </div><div class="memdoc">

  276. <p>Receive multiple bytes.</p>

  277. <dl class="params"><dt>Parameters</dt><dd>

  278.   <table class="params">

  279.     <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the data. </td></tr>

  280.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to receive.</td></tr>

  281.   </table>

  282.   </dd>

  283. </dl>

  284. <dl class="section return"><dt>Returns</dt><dd>Zero for no error or nonzero error code. </dd></dl>

  285. 

  286. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a256f21aeaff4f15a7a5402cccbcc32f1">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>

  287. 

  288. </div>

  289. </div>

  290. <a class="anchor" id="a1f43194a47cb5403e82af651a370be00"></a>

  291. <div class="memitem">

  292. <div class="memproto">

  293. <table class="mlabels">

  294.   <tr>

  295.   <td class="mlabels-left">

  296.       <table class="memname">

  297.         <tr>

  298.           <td class="memname">virtual void SdSpiBase::send </td>

  299.           <td>(</td>

  300.           <td class="paramtype">uint8_t&#160;</td>

  301.           <td class="paramname"><em>data</em></td><td>)</td>

  302.           <td></td>

  303.         </tr>

  304.       </table>

  305.   </td>

  306.   <td class="mlabels-right">

  307. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  308.   </tr>

  309. </table>

  310. </div><div class="memdoc">

  311. <p>Send a byte.</p>

  312. <dl class="params"><dt>Parameters</dt><dd>

  313.   <table class="params">

  314.     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>

  315.   </table>

  316.   </dd>

  317. </dl>

  318. 

  319. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a96224c2c89d9b6118a2979252d682c2a">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>

  320. 

  321. </div>

  322. </div>

  323. <a class="anchor" id="a109f2f4213e7a763fb4e4dd3ec605c3b"></a>

  324. <div class="memitem">

  325. <div class="memproto">

  326. <table class="mlabels">

  327.   <tr>

  328.   <td class="mlabels-left">

  329.       <table class="memname">

  330.         <tr>

  331.           <td class="memname">virtual void SdSpiBase::send </td>

  332.           <td>(</td>

  333.           <td class="paramtype">const uint8_t *&#160;</td>

  334.           <td class="paramname"><em>buf</em>, </td>

  335.         </tr>

  336.         <tr>

  337.           <td class="paramkey"></td>

  338.           <td></td>

  339.           <td class="paramtype">size_t&#160;</td>

  340.           <td class="paramname"><em>n</em>&#160;</td>

  341.         </tr>

  342.         <tr>

  343.           <td></td>

  344.           <td>)</td>

  345.           <td></td><td></td>

  346.         </tr>

  347.       </table>

  348.   </td>

  349.   <td class="mlabels-right">

  350. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  351.   </tr>

  352. </table>

  353. </div><div class="memdoc">

  354. <p>Send multiple bytes.</p>

  355. <dl class="params"><dt>Parameters</dt><dd>

  356.   <table class="params">

  357.     <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for data to be sent. </td></tr>

  358.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Number of bytes to send. </td></tr>

  359.   </table>

  360.   </dd>

  361. </dl>

  362. 

  363. <p>Implemented in <a class="el" href="class_sd_spi_soft.html#a7f4cada25994f77cb8ed51f71465e334">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</a>.</p>

  364. 

  365. </div>

  366. </div>

  367. <hr/>The documentation for this class was generated from the following file:<ul>

  368. <li>Arduino/libraries/SdFat/src/SdSpiCard/<a class="el" href="_sd_spi_8h.html">SdSpi.h</a></li>

  369. </ul>

  370. </div><!-- contents -->

  371. <!-- start footer part -->

  372. <hr class="footer"/><address class="footer"><small>

  373. Generated on Fri Feb 12 2016 13:43:49 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

  374. <img class="footer" src="doxygen.png" alt="doxygen"/>

  375. </a> 1.8.10

  376. </small></address>

  377. </body>

  378. </html>