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.
26 Commits
1 Branch
Tree: 6ac05353a6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '6ac05353a6'
${ noResults }
teensy-sdfat/html/class_sd_spi_soft.html

403 lines
17KB
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: 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/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_soft-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

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

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

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;:</div>

  99. <div class="dyncontent">

  100. <div class="center"><img src="class_sd_spi_soft__inherit__graph.png" border="0" usemap="#_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map" alt="Inheritance graph"/></div>

  101. <map name="_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map" id="_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_inherit__map">

  102. <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="33,5,120,32"/>

  103. </map>

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

  105. <div class="dynheader">

  106. Collaboration diagram for SdSpiSoft&lt; MisoPin, MosiPin, SckPin &gt;:</div>

  107. <div class="dyncontent">

  108. <div class="center"><img src="class_sd_spi_soft__coll__graph.png" border="0" usemap="#_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map" alt="Collaboration graph"/></div>

  109. <map name="_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map" id="_sd_spi_soft_3_01_miso_pin_00_01_mosi_pin_00_01_sck_pin_01_4_coll__map">

  110. <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="33,5,120,32"/>

  111. </map>

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

  113. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  130. </table>

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

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

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

  134. 

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

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

  137. <a class="anchor" id="a957355dae46e184bf7c12cd8306ac2fd"></a>

  138. <div class="memitem">

  139. <div class="memproto">

  140. <div class="memtemplate">

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

  142. <table class="mlabels">

  143.   <tr>

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

  145.       <table class="memname">

  146.         <tr>

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

  148.           <td>(</td>

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

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

  151.           <td></td>

  152.         </tr>

  153.       </table>

  154.   </td>

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

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

  157.   </tr>

  158. </table>

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

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

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

  162.   <table class="params">

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

  164.   </table>

  165.   </dd>

  166. </dl>

  167. 

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

  169. 

  170. </div>

  171. </div>

  172. <a class="anchor" id="afe6909bd40f444c4680da3140b81de36"></a>

  173. <div class="memitem">

  174. <div class="memproto">

  175. <div class="memtemplate">

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

  177. <table class="mlabels">

  178.   <tr>

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

  180.       <table class="memname">

  181.         <tr>

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

  183.           <td>(</td>

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

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

  186.           <td></td>

  187.         </tr>

  188.       </table>

  189.   </td>

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

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

  192.   </tr>

  193. </table>

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

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

  196.   <table class="params">

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

  198.   </table>

  199.   </dd>

  200. </dl>

  201. 

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

  203. 

  204. </div>

  205. </div>

  206. <a class="anchor" id="a9efd9900dfc03582e433ff8939e96dff"></a>

  207. <div class="memitem">

  208. <div class="memproto">

  209. <div class="memtemplate">

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

  211. <table class="mlabels">

  212.   <tr>

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

  214.       <table class="memname">

  215.         <tr>

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

  217.           <td>(</td>

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

  219.           <td></td>

  220.         </tr>

  221.       </table>

  222.   </td>

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

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

  225.   </tr>

  226. </table>

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

  228. <p>End SPI transaction - dummy for soft SPI </p>

  229. 

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

  231. 

  232. </div>

  233. </div>

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

  235. <div class="memitem">

  236. <div class="memproto">

  237. <div class="memtemplate">

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

  239. <table class="mlabels">

  240.   <tr>

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

  242.       <table class="memname">

  243.         <tr>

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

  245.           <td>(</td>

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

  247.           <td></td>

  248.         </tr>

  249.       </table>

  250.   </td>

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

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

  253.   </tr>

  254. </table>

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

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

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

  258. 

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

  260. 

  261. </div>

  262. </div>

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

  264. <div class="memitem">

  265. <div class="memproto">

  266. <div class="memtemplate">

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

  268. <table class="mlabels">

  269.   <tr>

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

  271.       <table class="memname">

  272.         <tr>

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

  274.           <td>(</td>

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

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

  277.         </tr>

  278.         <tr>

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

  280.           <td></td>

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

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

  283.         </tr>

  284.         <tr>

  285.           <td></td>

  286.           <td>)</td>

  287.           <td></td><td></td>

  288.         </tr>

  289.       </table>

  290.   </td>

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

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

  293.   </tr>

  294. </table>

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

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

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

  298.   <table class="params">

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

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

  301.   </table>

  302.   </dd>

  303. </dl>

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

  305. 

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

  307. 

  308. </div>

  309. </div>

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

  311. <div class="memitem">

  312. <div class="memproto">

  313. <div class="memtemplate">

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

  315. <table class="mlabels">

  316.   <tr>

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

  318.       <table class="memname">

  319.         <tr>

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

  321.           <td>(</td>

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

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

  324.           <td></td>

  325.         </tr>

  326.       </table>

  327.   </td>

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

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

  330.   </tr>

  331. </table>

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

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

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

  335.   <table class="params">

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

  337.   </table>

  338.   </dd>

  339. </dl>

  340. 

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

  342. 

  343. </div>

  344. </div>

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

  346. <div class="memitem">

  347. <div class="memproto">

  348. <div class="memtemplate">

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

  350. <table class="mlabels">

  351.   <tr>

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

  353.       <table class="memname">

  354.         <tr>

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

  356.           <td>(</td>

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

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

  359.         </tr>

  360.         <tr>

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

  362.           <td></td>

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

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

  365.         </tr>

  366.         <tr>

  367.           <td></td>

  368.           <td>)</td>

  369.           <td></td><td></td>

  370.         </tr>

  371.       </table>

  372.   </td>

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

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

  375.   </tr>

  376. </table>

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

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

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

  380.   <table class="params">

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

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

  383.   </table>

  384.   </dd>

  385. </dl>

  386. 

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

  388. 

  389. </div>

  390. </div>

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

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

  393. </ul>

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

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

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

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

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

  399. </a> 1.8.10

  400. </small></address>

  401. </body>

  402. </html>