visus
/
teensy-sdfat
关注 1
点赞 0
派生 0
代码 工单 0 合并请求 0 版本发布 0 百科 动态
您最多选择25个主题 主题必须以字母或数字开头，可以包含连字符 (-)，并且长度不得超过35个字符
12 提交
1 分支
目录树: d60a3ab342
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 'd60a3ab342'
${ noResults }
teensy-sdfat/html/class_sd_spi.html

377 行
16KB
原始文件 Blame 文件历史 

  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: SdSpi 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. 

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

  76. <div id="MSearchResultsWindow">

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

  78.         name="MSearchResults" id="MSearchResults">

  79. </iframe>

  80. </div>

  81. 

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

  83. <div class="header">

  84.   <div class="summary">

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

  86. <a href="class_sd_spi-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

  88. <div class="title">SdSpi Class Reference</div>  </div>

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

  90. <div class="contents">

  91. 

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

  93.  <a href="class_sd_spi.html#details">More...</a></p>

  94. 

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

  96. <div class="dynheader">

  97. Inheritance diagram for SdSpi:</div>

  98. <div class="dyncontent">

  99. <div class="center"><img src="class_sd_spi__inherit__graph.png" border="0" usemap="#_sd_spi_inherit__map" alt="Inheritance graph"/></div>

  100. <map name="_sd_spi_inherit__map" id="_sd_spi_inherit__map">

  101. <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="5,5,91,32"/>
</map>

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

  103. <div class="dynheader">

  104. Collaboration diagram for SdSpi:</div>

  105. <div class="dyncontent">

  106. <div class="center"><img src="class_sd_spi__coll__graph.png" border="0" usemap="#_sd_spi_coll__map" alt="Collaboration graph"/></div>

  107. <map name="_sd_spi_coll__map" id="_sd_spi_coll__map">

  108. <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="5,5,91,32"/>
</map>

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

  110. <table class="memberdecls">

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

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

  113. <tr class="memitem:a607aa7e4655f29bb16ed75b66ffc2c20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a607aa7e4655f29bb16ed75b66ffc2c20">begin</a> ()</td></tr>

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

  115. <tr class="memitem:a1ec1b9408b99ae60e4c62c0ba8d038c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a1ec1b9408b99ae60e4c62c0ba8d038c2">init</a> (uint8_t divisor)</td></tr>

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

  117. <tr class="memitem:aa017fd1d2bd196d1cbc4b845f6a72a40"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#aa017fd1d2bd196d1cbc4b845f6a72a40">receive</a> ()</td></tr>

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

  119. <tr class="memitem:a223c3b67496b7a05035060d68e8b7e0e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a223c3b67496b7a05035060d68e8b7e0e">receive</a> (uint8_t *buf, size_t n)</td></tr>

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

  121. <tr class="memitem:a3c6369cd5cc2e1631bcc24e9194eb09a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a3c6369cd5cc2e1631bcc24e9194eb09a">send</a> (uint8_t data)</td></tr>

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

  123. <tr class="memitem:a97ef912cdc43e0800e0184160581f89e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a97ef912cdc43e0800e0184160581f89e">send</a> (const uint8_t *buf, size_t n)</td></tr>

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

  125. <tr class="memitem:a048d54bb93f2f2f86d9a499605dd1427"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi.html#a048d54bb93f2f2f86d9a499605dd1427">useSpiTransactions</a> ()</td></tr>

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

  127. </table>

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

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

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

  131. <a class="anchor" id="a607aa7e4655f29bb16ed75b66ffc2c20"></a>

  132. <div class="memitem">

  133. <div class="memproto">

  134. <table class="mlabels">

  135.   <tr>

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

  137.       <table class="memname">

  138.         <tr>

  139.           <td class="memname">void SdSpi::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">virtual</span></span>  </td>

  148.   </tr>

  149. </table>

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

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

  152. 

  153. <p>Implements <a class="el" href="class_sd_spi_base.html#a1412739cdbfc3674d707736e3d9a70eb">SdSpiBase</a>.</p>

  154. 

  155. </div>

  156. </div>

  157. <a class="anchor" id="a1ec1b9408b99ae60e4c62c0ba8d038c2"></a>

  158. <div class="memitem">

  159. <div class="memproto">

  160. <table class="mlabels">

  161.   <tr>

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

  163.       <table class="memname">

  164.         <tr>

  165.           <td class="memname">void SdSpi::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">virtual</span></span>  </td>

  175.   </tr>

  176. </table>

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

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

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

  180.   <table class="params">

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

  182.   </table>

  183.   </dd>

  184. </dl>

  185. 

  186. <p>Reimplemented from <a class="el" href="class_sd_spi_base.html#abe0412d1728f3628f81caf05ce8fe93b">SdSpiBase</a>.</p>

  187. 

  188. </div>

  189. </div>

  190. <a class="anchor" id="aa017fd1d2bd196d1cbc4b845f6a72a40"></a>

  191. <div class="memitem">

  192. <div class="memproto">

  193. <table class="mlabels">

  194.   <tr>

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

  196.       <table class="memname">

  197.         <tr>

  198.           <td class="memname">uint8_t SdSpi::receive </td>

  199.           <td>(</td>

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

  201.           <td></td>

  202.         </tr>

  203.       </table>

  204.   </td>

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

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

  207.   </tr>

  208. </table>

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

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

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

  212. 

  213. <p>Implements <a class="el" href="class_sd_spi_base.html#a3488ab01ed4412f2c7143cfd10a7503c">SdSpiBase</a>.</p>

  214. 

  215. </div>

  216. </div>

  217. <a class="anchor" id="a223c3b67496b7a05035060d68e8b7e0e"></a>

  218. <div class="memitem">

  219. <div class="memproto">

  220. <table class="mlabels">

  221.   <tr>

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

  223.       <table class="memname">

  224.         <tr>

  225.           <td class="memname">uint8_t SdSpi::receive </td>

  226.           <td>(</td>

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

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

  229.         </tr>

  230.         <tr>

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

  232.           <td></td>

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

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

  235.         </tr>

  236.         <tr>

  237.           <td></td>

  238.           <td>)</td>

  239.           <td></td><td></td>

  240.         </tr>

  241.       </table>

  242.   </td>

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

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

  245.   </tr>

  246. </table>

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

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

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

  250.   <table class="params">

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

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

  253.   </table>

  254.   </dd>

  255. </dl>

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

  257. 

  258. <p>Implements <a class="el" href="class_sd_spi_base.html#af5810e79d39a9f6de6435f92401531be">SdSpiBase</a>.</p>

  259. 

  260. </div>

  261. </div>

  262. <a class="anchor" id="a3c6369cd5cc2e1631bcc24e9194eb09a"></a>

  263. <div class="memitem">

  264. <div class="memproto">

  265. <table class="mlabels">

  266.   <tr>

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

  268.       <table class="memname">

  269.         <tr>

  270.           <td class="memname">void SdSpi::send </td>

  271.           <td>(</td>

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

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

  274.           <td></td>

  275.         </tr>

  276.       </table>

  277.   </td>

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

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

  280.   </tr>

  281. </table>

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

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

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

  285.   <table class="params">

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

  287.   </table>

  288.   </dd>

  289. </dl>

  290. 

  291. <p>Implements <a class="el" href="class_sd_spi_base.html#a1f43194a47cb5403e82af651a370be00">SdSpiBase</a>.</p>

  292. 

  293. </div>

  294. </div>

  295. <a class="anchor" id="a97ef912cdc43e0800e0184160581f89e"></a>

  296. <div class="memitem">

  297. <div class="memproto">

  298. <table class="mlabels">

  299.   <tr>

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

  301.       <table class="memname">

  302.         <tr>

  303.           <td class="memname">void SdSpi::send </td>

  304.           <td>(</td>

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

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

  307.         </tr>

  308.         <tr>

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

  310.           <td></td>

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

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

  313.         </tr>

  314.         <tr>

  315.           <td></td>

  316.           <td>)</td>

  317.           <td></td><td></td>

  318.         </tr>

  319.       </table>

  320.   </td>

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

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

  323.   </tr>

  324. </table>

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

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

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

  328.   <table class="params">

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

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

  331.   </table>

  332.   </dd>

  333. </dl>

  334. 

  335. <p>Implements <a class="el" href="class_sd_spi_base.html#a109f2f4213e7a763fb4e4dd3ec605c3b">SdSpiBase</a>.</p>

  336. 

  337. </div>

  338. </div>

  339. <a class="anchor" id="a048d54bb93f2f2f86d9a499605dd1427"></a>

  340. <div class="memitem">

  341. <div class="memproto">

  342. <table class="mlabels">

  343.   <tr>

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

  345.       <table class="memname">

  346.         <tr>

  347.           <td class="memname">bool SdSpi::useSpiTransactions </td>

  348.           <td>(</td>

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

  350.           <td></td>

  351.         </tr>

  352.       </table>

  353.   </td>

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

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

  356.   </tr>

  357. </table>

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

  359. <dl class="section return"><dt>Returns</dt><dd>true - uses SPI transactions </dd></dl>

  360. 

  361. <p>Implements <a class="el" href="class_sd_spi_base.html#a0a13df4c86ec6978878b63386ee65007">SdSpiBase</a>.</p>

  362. 

  363. </div>

  364. </div>

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

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

  367. </ul>

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

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

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

  371. Generated on Thu Dec 4 2014 08:53:21 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  373. </a> 1.8.8

  374. </small></address>

  375. </body>

  376. </html>