visus
/
teensy-sdfat
Прати 1
Волим 0
Креирај огранак 0
Код Дискусије 0 Захтеви за спајање 0 Издања 0 Вики 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.
11 Комити
1 Грана
Дрво: 8408432732
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from '8408432732'
${ noResults }
teensy-sdfat/html/class_sd_spi_soft.html

365 lines
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: SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt; Class Template 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_soft-members.html">List of all members</a>  </div>

  87.   <div class="headertitle">

  88. <div class="title">SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt; Class Template Reference</div>  </div>

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

  90. <div class="contents">

  91. 

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

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

  94. 

  95. <p><code>#include &lt;SdSpi.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:afb2de7342f5510ce8b7759cd8bb3810e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_soft.html#afb2de7342f5510ce8b7759cd8bb3810e">begin</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

  113. </table>

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

  115. <div class="textblock"><h3>template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt;<br />

  116. class SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;</h3>

  117. 

  118. <p>Software SPI class for access to SD and SDHC flash memory cards. </p>

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

  120. <a class="anchor" id="afb2de7342f5510ce8b7759cd8bb3810e"></a>

  121. <div class="memitem">

  122. <div class="memproto">

  123. <div class="memtemplate">

  124. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>

  125. <table class="mlabels">

  126.   <tr>

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

  128.       <table class="memname">

  129.         <tr>

  130.           <td class="memname">void <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::begin </td>

  131.           <td>(</td>

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

  133.           <td></td>

  134.         </tr>

  135.       </table>

  136.   </td>

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

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

  139.   </tr>

  140. </table>

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

  142. <p>initialize SPI pins </p>

  143. 

  144. </div>

  145. </div>

  146. <a class="anchor" id="a09805938ac313cf6a6b6ea4c93d7422e"></a>

  147. <div class="memitem">

  148. <div class="memproto">

  149. <div class="memtemplate">

  150. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>

  151. <table class="mlabels">

  152.   <tr>

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

  154.       <table class="memname">

  155.         <tr>

  156.           <td class="memname">void <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::init </td>

  157.           <td>(</td>

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

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

  160.           <td></td>

  161.         </tr>

  162.       </table>

  163.   </td>

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

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

  166.   </tr>

  167. </table>

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

  169. <p>Initialize hardware SPI - dummy for soft SPI </p><dl class="params"><dt>Parameters</dt><dd>

  170.   <table class="params">

  171.     <tr><td class="paramdir">[in]</td><td class="paramname">divisor</td><td>SCK divisor - ignored. </td></tr>

  172.   </table>

  173.   </dd>

  174. </dl>

  175. 

  176. </div>

  177. </div>

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

  179. <div class="memitem">

  180. <div class="memproto">

  181. <div class="memtemplate">

  182. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>

  183. <table class="mlabels">

  184.   <tr>

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

  186.       <table class="memname">

  187.         <tr>

  188.           <td class="memname">uint8_t <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::receive </td>

  189.           <td>(</td>

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

  191.           <td></td>

  192.         </tr>

  193.       </table>

  194.   </td>

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

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

  197.   </tr>

  198. </table>

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

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

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

  202. 

  203. </div>

  204. </div>

  205. <a class="anchor" id="a256f21aeaff4f15a7a5402cccbcc32f1"></a>

  206. <div class="memitem">

  207. <div class="memproto">

  208. <div class="memtemplate">

  209. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>

  210. <table class="mlabels">

  211.   <tr>

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

  213.       <table class="memname">

  214.         <tr>

  215.           <td class="memname">uint8_t <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::receive </td>

  216.           <td>(</td>

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

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

  219.         </tr>

  220.         <tr>

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

  222.           <td></td>

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

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

  225.         </tr>

  226.         <tr>

  227.           <td></td>

  228.           <td>)</td>

  229.           <td></td><td></td>

  230.         </tr>

  231.       </table>

  232.   </td>

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

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

  235.   </tr>

  236. </table>

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

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

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

  240.   <table class="params">

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

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

  243.   </table>

  244.   </dd>

  245. </dl>

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

  247. 

  248. </div>

  249. </div>

  250. <a class="anchor" id="a96224c2c89d9b6118a2979252d682c2a"></a>

  251. <div class="memitem">

  252. <div class="memproto">

  253. <div class="memtemplate">

  254. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>

  255. <table class="mlabels">

  256.   <tr>

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

  258.       <table class="memname">

  259.         <tr>

  260.           <td class="memname">void <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::send </td>

  261.           <td>(</td>

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

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

  264.           <td></td>

  265.         </tr>

  266.       </table>

  267.   </td>

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

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

  270.   </tr>

  271. </table>

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

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

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

  275.   <table class="params">

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

  277.   </table>

  278.   </dd>

  279. </dl>

  280. 

  281. </div>

  282. </div>

  283. <a class="anchor" id="a7f4cada25994f77cb8ed51f71465e334"></a>

  284. <div class="memitem">

  285. <div class="memproto">

  286. <div class="memtemplate">

  287. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>

  288. <table class="mlabels">

  289.   <tr>

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

  291.       <table class="memname">

  292.         <tr>

  293.           <td class="memname">void <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::send </td>

  294.           <td>(</td>

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

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

  297.         </tr>

  298.         <tr>

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

  300.           <td></td>

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

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

  303.         </tr>

  304.         <tr>

  305.           <td></td>

  306.           <td>)</td>

  307.           <td></td><td></td>

  308.         </tr>

  309.       </table>

  310.   </td>

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

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

  313.   </tr>

  314. </table>

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

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

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

  318.   <table class="params">

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

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

  321.   </table>

  322.   </dd>

  323. </dl>

  324. 

  325. </div>

  326. </div>

  327. <a class="anchor" id="aa269a343795b07845e6280db8b36dccb"></a>

  328. <div class="memitem">

  329. <div class="memproto">

  330. <div class="memtemplate">

  331. template&lt;uint8_t MisoPin, uint8_t MosiPin, uint8_t SckPin&gt; </div>

  332. <table class="mlabels">

  333.   <tr>

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

  335.       <table class="memname">

  336.         <tr>

  337.           <td class="memname">bool <a class="el" href="class_sd_spi_soft.html">SdSpiSoft</a>&lt; MisoPin, MosiPin, SckPin &gt;::useSpiTransactions </td>

  338.           <td>(</td>

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

  340.           <td></td>

  341.         </tr>

  342.       </table>

  343.   </td>

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

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

  346.   </tr>

  347. </table>

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

  349. <dl class="section return"><dt>Returns</dt><dd>false - no SPI transactions </dd></dl>

  350. 

  351. </div>

  352. </div>

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

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

  355. </ul>

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

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

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

  359. Generated on Sat Nov 15 2014 10:05:36 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  361. </a> 1.8.8

  362. </small></address>

  363. </body>

  364. </html>