visus
/
teensy-sdfat
Seguir 1
Destacar 0
Fork 0
Código Incidencias 0 Pull Requests 0 Lanzamientos 0 Wiki Actividad
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
31 Commits
1 Rama
Árbol: 080e24c4d1
Ramas Etiquetas
${ item.name }
Crear rama ${ searchTerm }
desde '080e24c4d1'
${ noResults }
teensy-sdfat/html/class_sd_spi.html

301 líneas
12KB
Original Blame Histórico 

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

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

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

  95. 

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

  97. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  114. </table>

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

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

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

  118. <a class="anchor" id="a8e37212befa9b36f4e9a67f8a173b2d3"></a>

  119. <div class="memitem">

  120. <div class="memproto">

  121.       <table class="memname">

  122.         <tr>

  123.           <td class="memname">void SdSpi::begin </td>

  124.           <td>(</td>

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

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

  127.           <td></td>

  128.         </tr>

  129.       </table>

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

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

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

  133.   <table class="params">

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

  135.   </table>

  136.   </dd>

  137. </dl>

  138. 

  139. </div>

  140. </div>

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

  142. <div class="memitem">

  143. <div class="memproto">

  144.       <table class="memname">

  145.         <tr>

  146.           <td class="memname">void SdSpi::beginTransaction </td>

  147.           <td>(</td>

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

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

  150.           <td></td>

  151.         </tr>

  152.       </table>

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

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

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

  156.   <table class="params">

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

  158.   </table>

  159.   </dd>

  160. </dl>

  161. 

  162. </div>

  163. </div>

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

  165. <div class="memitem">

  166. <div class="memproto">

  167.       <table class="memname">

  168.         <tr>

  169.           <td class="memname">void SdSpi::endTransaction </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>End SPI transaction </p>

  177. 

  178. </div>

  179. </div>

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

  181. <div class="memitem">

  182. <div class="memproto">

  183.       <table class="memname">

  184.         <tr>

  185.           <td class="memname">uint8_t SdSpi::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="a223c3b67496b7a05035060d68e8b7e0e"></a>

  198. <div class="memitem">

  199. <div class="memproto">

  200.       <table class="memname">

  201.         <tr>

  202.           <td class="memname">uint8_t SdSpi::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="a3c6369cd5cc2e1631bcc24e9194eb09a"></a>

  233. <div class="memitem">

  234. <div class="memproto">

  235.       <table class="memname">

  236.         <tr>

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

  238.           <td>(</td>

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

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

  241.           <td></td>

  242.         </tr>

  243.       </table>

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

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

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

  247.   <table class="params">

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

  249.   </table>

  250.   </dd>

  251. </dl>

  252. 

  253. </div>

  254. </div>

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

  256. <div class="memitem">

  257. <div class="memproto">

  258.       <table class="memname">

  259.         <tr>

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

  261.           <td>(</td>

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

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

  264.         </tr>

  265.         <tr>

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

  267.           <td></td>

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

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

  270.         </tr>

  271.         <tr>

  272.           <td></td>

  273.           <td>)</td>

  274.           <td></td><td></td>

  275.         </tr>

  276.       </table>

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

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

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

  280.   <table class="params">

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

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

  283.   </table>

  284.   </dd>

  285. </dl>

  286. 

  287. </div>

  288. </div>

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

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

  291. </ul>

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

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

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

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

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

  297. </a> 1.8.10

  298. </small></address>

  299. </body>

  300. </html>