visus
/
teensy-sdfat
Suivre 1
Ajouter aux favoris 0
Bifurcation 0
Code Tickets 0 Demandes d'ajout 0 Versions 0 Wiki Activité
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
33 Révisions
1 Branche
Aborescence: 1c74e428dd
Branches Tags
${ item.name }
Créer la branche ${ searchTerm }
de '1c74e428dd'
${ noResults }
teensy-sdfat/html/class_sd_spi_lib_driver.html

434 lines
17KB
Brut Annotations Historique 

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

  87.   <div class="headertitle">

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

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

  90. <div class="contents">

  91. 

  92. <p><a class="el" href="class_sd_spi_lib_driver.html" title="SdSpiLibDriver - use standard SPI library. ">SdSpiLibDriver</a> - use standard SPI library.  

  93.  <a href="class_sd_spi_lib_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:aeb8263fb0eaca724af90830e90ddd044"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_lib_driver.html#aeb8263fb0eaca724af90830e90ddd044">activate</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  119. </table>

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

  121. <div class="textblock"><p><a class="el" href="class_sd_spi_lib_driver.html" title="SdSpiLibDriver - use standard SPI library. ">SdSpiLibDriver</a> - use standard SPI library. </p>

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

  123. <a class="anchor" id="aeb8263fb0eaca724af90830e90ddd044"></a>

  124. <div class="memitem">

  125. <div class="memproto">

  126. <table class="mlabels">

  127.   <tr>

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

  129.       <table class="memname">

  130.         <tr>

  131.           <td class="memname">void SdSpiLibDriver::activate </td>

  132.           <td>(</td>

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

  134.           <td></td>

  135.         </tr>

  136.       </table>

  137.   </td>

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

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

  140.   </tr>

  141. </table>

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

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

  144. 

  145. </div>

  146. </div>

  147. <a class="anchor" id="a5863b84f8f277b7a926e915cdc378957"></a>

  148. <div class="memitem">

  149. <div class="memproto">

  150. <table class="mlabels">

  151.   <tr>

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

  153.       <table class="memname">

  154.         <tr>

  155.           <td class="memname">void SdSpiLibDriver::begin </td>

  156.           <td>(</td>

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

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

  159.           <td></td>

  160.         </tr>

  161.       </table>

  162.   </td>

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

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

  165.   </tr>

  166. </table>

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

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

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

  170.   <table class="params">

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

  172.   </table>

  173.   </dd>

  174. </dl>

  175. 

  176. </div>

  177. </div>

  178. <a class="anchor" id="a120d6b78f9dad6837d10b45b76d32c82"></a>

  179. <div class="memitem">

  180. <div class="memproto">

  181. <table class="mlabels">

  182.   <tr>

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

  184.       <table class="memname">

  185.         <tr>

  186.           <td class="memname">void SdSpiLibDriver::deactivate </td>

  187.           <td>(</td>

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

  189.           <td></td>

  190.         </tr>

  191.       </table>

  192.   </td>

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

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

  195.   </tr>

  196. </table>

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

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

  199. 

  200. </div>

  201. </div>

  202. <a class="anchor" id="acab44a1709ed382264e0844a544526d7"></a>

  203. <div class="memitem">

  204. <div class="memproto">

  205. <table class="mlabels">

  206.   <tr>

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

  208.       <table class="memname">

  209.         <tr>

  210.           <td class="memname">uint8_t SdSpiLibDriver::receive </td>

  211.           <td>(</td>

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

  213.           <td></td>

  214.         </tr>

  215.       </table>

  216.   </td>

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

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

  219.   </tr>

  220. </table>

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

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

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

  224. 

  225. </div>

  226. </div>

  227. <a class="anchor" id="a961697c166b9965ab495e22b12f01ae9"></a>

  228. <div class="memitem">

  229. <div class="memproto">

  230. <table class="mlabels">

  231.   <tr>

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

  233.       <table class="memname">

  234.         <tr>

  235.           <td class="memname">uint8_t SdSpiLibDriver::receive </td>

  236.           <td>(</td>

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

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

  239.         </tr>

  240.         <tr>

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

  242.           <td></td>

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

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

  245.         </tr>

  246.         <tr>

  247.           <td></td>

  248.           <td>)</td>

  249.           <td></td><td></td>

  250.         </tr>

  251.       </table>

  252.   </td>

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

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

  255.   </tr>

  256. </table>

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

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

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

  260.   <table class="params">

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

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

  263.   </table>

  264.   </dd>

  265. </dl>

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

  267. 

  268. </div>

  269. </div>

  270. <a class="anchor" id="af24e0b0555b068d059b895314a77785d"></a>

  271. <div class="memitem">

  272. <div class="memproto">

  273. <table class="mlabels">

  274.   <tr>

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

  276.       <table class="memname">

  277.         <tr>

  278.           <td class="memname">void SdSpiLibDriver::select </td>

  279.           <td>(</td>

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

  281.           <td></td>

  282.         </tr>

  283.       </table>

  284.   </td>

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

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

  287.   </tr>

  288. </table>

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

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

  291. 

  292. </div>

  293. </div>

  294. <a class="anchor" id="aed31a7a2cc1b07200f6b295659b39a26"></a>

  295. <div class="memitem">

  296. <div class="memproto">

  297. <table class="mlabels">

  298.   <tr>

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

  300.       <table class="memname">

  301.         <tr>

  302.           <td class="memname">void SdSpiLibDriver::send </td>

  303.           <td>(</td>

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

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

  306.           <td></td>

  307.         </tr>

  308.       </table>

  309.   </td>

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

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

  312.   </tr>

  313. </table>

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

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

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

  317.   <table class="params">

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

  319.   </table>

  320.   </dd>

  321. </dl>

  322. 

  323. </div>

  324. </div>

  325. <a class="anchor" id="a2dc6c188ff9be18aa46234c4bdc4e536"></a>

  326. <div class="memitem">

  327. <div class="memproto">

  328. <table class="mlabels">

  329.   <tr>

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

  331.       <table class="memname">

  332.         <tr>

  333.           <td class="memname">void SdSpiLibDriver::send </td>

  334.           <td>(</td>

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

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

  337.         </tr>

  338.         <tr>

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

  340.           <td></td>

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

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

  343.         </tr>

  344.         <tr>

  345.           <td></td>

  346.           <td>)</td>

  347.           <td></td><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>Send multiple bytes.</p>

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

  358.   <table class="params">

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

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

  361.   </table>

  362.   </dd>

  363. </dl>

  364. 

  365. </div>

  366. </div>

  367. <a class="anchor" id="a99fb51a9a567923fa7f87374e0aa124f"></a>

  368. <div class="memitem">

  369. <div class="memproto">

  370. <table class="mlabels">

  371.   <tr>

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

  373.       <table class="memname">

  374.         <tr>

  375.           <td class="memname">void SdSpiLibDriver::setSpiSettings </td>

  376.           <td>(</td>

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

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

  379.           <td></td>

  380.         </tr>

  381.       </table>

  382.   </td>

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

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

  385.   </tr>

  386. </table>

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

  388. <p>Save SPISettings.</p>

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

  390.   <table class="params">

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

  392.   </table>

  393.   </dd>

  394. </dl>

  395. 

  396. </div>

  397. </div>

  398. <a class="anchor" id="a593b443dca85fe4de76ab06547233429"></a>

  399. <div class="memitem">

  400. <div class="memproto">

  401. <table class="mlabels">

  402.   <tr>

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

  404.       <table class="memname">

  405.         <tr>

  406.           <td class="memname">void SdSpiLibDriver::unselect </td>

  407.           <td>(</td>

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

  409.           <td></td>

  410.         </tr>

  411.       </table>

  412.   </td>

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

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

  415.   </tr>

  416. </table>

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

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

  419. 

  420. </div>

  421. </div>

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

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

  424. </ul>

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

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

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

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

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

  430. </a> 1.8.10

  431. </small></address>

  432. </body>

  433. </html>