visus
/
teensy-sdfat
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
32 Commits
1 Branch
Tree: 9c407b3e9f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '9c407b3e9f'
${ noResults }
teensy-sdfat/html/class_sd_spi_alt_driver.html

402 lines
16KB
Raw Blame History 

  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: SdSpiAltDriver 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 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. </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_alt_driver-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

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

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

  90. <div class="contents">

  91. 

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

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

  94. 

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

  96. <table class="memberdecls">

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

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

  99. <tr class="memitem:a53cb88d35df119828ec3702a39552e93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_alt_driver.html#a53cb88d35df119828ec3702a39552e93">activate</a> ()</td></tr>

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

  101. <tr class="memitem:ae7fc7ae005002e9a1de3e0b7440e971e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_alt_driver.html#ae7fc7ae005002e9a1de3e0b7440e971e">begin</a> (uint8_t csPin)</td></tr>

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

  103. <tr class="memitem:ae6ce25d124e31a8762375ae548a92818"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_alt_driver.html#ae6ce25d124e31a8762375ae548a92818">deactivate</a> ()</td></tr>

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

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

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

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

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

  109. <tr class="memitem:a1e52a39ab018b5c07089befbec21ada5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_alt_driver.html#a1e52a39ab018b5c07089befbec21ada5">select</a> ()</td></tr>

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

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

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

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

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

  115. <tr class="memitem:a334ecbbe8809b38c0b724eeeb3ef1e14"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_alt_driver.html#a334ecbbe8809b38c0b724eeeb3ef1e14">setPort</a> (uint8_t portNumber)</td></tr>

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

  117. <tr class="memitem:a91d7ef40a801ae73d0e0b5f440ab0eef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_alt_driver.html#a91d7ef40a801ae73d0e0b5f440ab0eef">setSpiSettings</a> (SPISettings spiSettings)</td></tr>

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

  119. <tr class="memitem:a731497cc1efc4bd0875d61b0d84979ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_alt_driver.html#a731497cc1efc4bd0875d61b0d84979ff">unselect</a> ()</td></tr>

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

  121. </table>

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

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

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

  125. <a class="anchor" id="a53cb88d35df119828ec3702a39552e93"></a>

  126. <div class="memitem">

  127. <div class="memproto">

  128.       <table class="memname">

  129.         <tr>

  130.           <td class="memname">void SdSpiAltDriver::activate </td>

  131.           <td>(</td>

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

  133.           <td></td>

  134.         </tr>

  135.       </table>

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

  137. <p>Activate SPI hardware. </p>

  138. 

  139. </div>

  140. </div>

  141. <a class="anchor" id="ae7fc7ae005002e9a1de3e0b7440e971e"></a>

  142. <div class="memitem">

  143. <div class="memproto">

  144.       <table class="memname">

  145.         <tr>

  146.           <td class="memname">void SdSpiAltDriver::begin </td>

  147.           <td>(</td>

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

  149.           <td class="paramname"><em>csPin</em></td><td>)</td>

  150.           <td></td>

  151.         </tr>

  152.       </table>

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

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

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

  156.   <table class="params">

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

  158.   </table>

  159.   </dd>

  160. </dl>

  161. 

  162. </div>

  163. </div>

  164. <a class="anchor" id="ae6ce25d124e31a8762375ae548a92818"></a>

  165. <div class="memitem">

  166. <div class="memproto">

  167.       <table class="memname">

  168.         <tr>

  169.           <td class="memname">void SdSpiAltDriver::deactivate </td>

  170.           <td>(</td>

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

  172.           <td></td>

  173.         </tr>

  174.       </table>

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

  176. <p>Deactivate SPI hardware. </p>

  177. 

  178. </div>

  179. </div>

  180. <a class="anchor" id="a639cae65cc4f66e70a39c5b3fc00aa76"></a>

  181. <div class="memitem">

  182. <div class="memproto">

  183.       <table class="memname">

  184.         <tr>

  185.           <td class="memname">uint8_t SdSpiAltDriver::receive </td>

  186.           <td>(</td>

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

  188.           <td></td>

  189.         </tr>

  190.       </table>

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

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

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

  194. 

  195. </div>

  196. </div>

  197. <a class="anchor" id="accca10152516408100e890e9abb2bc64"></a>

  198. <div class="memitem">

  199. <div class="memproto">

  200.       <table class="memname">

  201.         <tr>

  202.           <td class="memname">uint8_t SdSpiAltDriver::receive </td>

  203.           <td>(</td>

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

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

  206.         </tr>

  207.         <tr>

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

  209.           <td></td>

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

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

  212.         </tr>

  213.         <tr>

  214.           <td></td>

  215.           <td>)</td>

  216.           <td></td><td></td>

  217.         </tr>

  218.       </table>

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

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

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

  222.   <table class="params">

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

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

  225.   </table>

  226.   </dd>

  227. </dl>

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

  229. 

  230. </div>

  231. </div>

  232. <a class="anchor" id="a1e52a39ab018b5c07089befbec21ada5"></a>

  233. <div class="memitem">

  234. <div class="memproto">

  235. <table class="mlabels">

  236.   <tr>

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

  238.       <table class="memname">

  239.         <tr>

  240.           <td class="memname">void SdSpiAltDriver::select </td>

  241.           <td>(</td>

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

  243.           <td></td>

  244.         </tr>

  245.       </table>

  246.   </td>

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

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

  249.   </tr>

  250. </table>

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

  252. <p>Set CS low. </p>

  253. 

  254. </div>

  255. </div>

  256. <a class="anchor" id="a872ec7667a758f2fbcb8bf987ea825c4"></a>

  257. <div class="memitem">

  258. <div class="memproto">

  259.       <table class="memname">

  260.         <tr>

  261.           <td class="memname">void SdSpiAltDriver::send </td>

  262.           <td>(</td>

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

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

  265.           <td></td>

  266.         </tr>

  267.       </table>

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

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

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

  271.   <table class="params">

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

  273.   </table>

  274.   </dd>

  275. </dl>

  276. 

  277. </div>

  278. </div>

  279. <a class="anchor" id="a9399a2957507a822f3b1b2630b81c510"></a>

  280. <div class="memitem">

  281. <div class="memproto">

  282.       <table class="memname">

  283.         <tr>

  284.           <td class="memname">void SdSpiAltDriver::send </td>

  285.           <td>(</td>

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

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

  288.         </tr>

  289.         <tr>

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

  291.           <td></td>

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

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

  294.         </tr>

  295.         <tr>

  296.           <td></td>

  297.           <td>)</td>

  298.           <td></td><td></td>

  299.         </tr>

  300.       </table>

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

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

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

  304.   <table class="params">

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

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

  307.   </table>

  308.   </dd>

  309. </dl>

  310. 

  311. </div>

  312. </div>

  313. <a class="anchor" id="a334ecbbe8809b38c0b724eeeb3ef1e14"></a>

  314. <div class="memitem">

  315. <div class="memproto">

  316.       <table class="memname">

  317.         <tr>

  318.           <td class="memname">void SdSpiAltDriver::setPort </td>

  319.           <td>(</td>

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

  321.           <td class="paramname"><em>portNumber</em></td><td>)</td>

  322.           <td></td>

  323.         </tr>

  324.       </table>

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

  326. <p>Set SPI port number. </p><dl class="params"><dt>Parameters</dt><dd>

  327.   <table class="params">

  328.     <tr><td class="paramdir">[in]</td><td class="paramname">portNumber</td><td>Hardware SPI port number. </td></tr>

  329.   </table>

  330.   </dd>

  331. </dl>

  332. 

  333. </div>

  334. </div>

  335. <a class="anchor" id="a91d7ef40a801ae73d0e0b5f440ab0eef"></a>

  336. <div class="memitem">

  337. <div class="memproto">

  338. <table class="mlabels">

  339.   <tr>

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

  341.       <table class="memname">

  342.         <tr>

  343.           <td class="memname">void SdSpiAltDriver::setSpiSettings </td>

  344.           <td>(</td>

  345.           <td class="paramtype">SPISettings&#160;</td>

  346.           <td class="paramname"><em>spiSettings</em></td><td>)</td>

  347.           <td></td>

  348.         </tr>

  349.       </table>

  350.   </td>

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

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

  353.   </tr>

  354. </table>

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

  356. <p>Save SPISettings.</p>

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

  358.   <table class="params">

  359.     <tr><td class="paramdir">[in]</td><td class="paramname">spiSettings</td><td>SPI speed, mode, and byte order. </td></tr>

  360.   </table>

  361.   </dd>

  362. </dl>

  363. 

  364. </div>

  365. </div>

  366. <a class="anchor" id="a731497cc1efc4bd0875d61b0d84979ff"></a>

  367. <div class="memitem">

  368. <div class="memproto">

  369. <table class="mlabels">

  370.   <tr>

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

  372.       <table class="memname">

  373.         <tr>

  374.           <td class="memname">void SdSpiAltDriver::unselect </td>

  375.           <td>(</td>

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

  377.           <td></td>

  378.         </tr>

  379.       </table>

  380.   </td>

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

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

  383.   </tr>

  384. </table>

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

  386. <p>Set CS high. </p>

  387. 

  388. </div>

  389. </div>

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

  391. <li>Arduino/libraries/SdFat/src/<a class="el" href="_sd_spi_driver_8h.html">SdSpiDriver.h</a></li>

  392. </ul>

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

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

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

  396. Generated on Fri Aug 19 2016 08:28:00 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  398. </a> 1.8.10

  399. </small></address>

  400. </body>

  401. </html>