visus
/
teensy-sdfat

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SdFat: SdSpiBaseClass Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SdFat
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_sd_spi_base_class-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SdSpiBaseClass Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Base class for external SPI drivers.  
 <a href="class_sd_spi_base_class.html#details">More...</a></p>

<p><code>#include &lt;SdSpiBaseClass.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SdSpiBaseClass:</div>
<div class="dyncontent">
<div class="center"><img src="class_sd_spi_base_class__inherit__graph.png" border="0" usemap="#_sd_spi_base_class_inherit__map" alt="Inheritance graph"/></div>
<map name="_sd_spi_base_class_inherit__map" id="_sd_spi_base_class_inherit__map">
<area shape="rect" title="Base class for external SPI drivers." alt="" coords="5,5,125,32"/>
<area shape="rect" href="class_my_spi_class.html" title="Sample external SPI class." alt="" coords="19,80,111,107"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ace7d46253efcaaab8b6be50cc17233e4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#ace7d46253efcaaab8b6be50cc17233e4">activate</a> ()</td></tr>
<tr class="separator:ace7d46253efcaaab8b6be50cc17233e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae186fa647e8e332a9e87d765f92047a5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#ae186fa647e8e332a9e87d765f92047a5">begin</a> ()=0</td></tr>
<tr class="separator:ae186fa647e8e332a9e87d765f92047a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3a5ede781e390263382fcf7765d665d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#ae3a5ede781e390263382fcf7765d665d">deactivate</a> ()</td></tr>
<tr class="separator:ae3a5ede781e390263382fcf7765d665d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a537c71fb2cdb8a825215c0faeb6f7dbd"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#a537c71fb2cdb8a825215c0faeb6f7dbd">receive</a> ()=0</td></tr>
<tr class="separator:a537c71fb2cdb8a825215c0faeb6f7dbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45693c18a8bb44ec9e5b9b1dee39b393"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#a45693c18a8bb44ec9e5b9b1dee39b393">receive</a> (uint8_t *buf, size_t count)=0</td></tr>
<tr class="separator:a45693c18a8bb44ec9e5b9b1dee39b393"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51923b03f35af4bac7c3bb7c8d13303d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#a51923b03f35af4bac7c3bb7c8d13303d">send</a> (const uint8_t *buf, size_t count)=0</td></tr>
<tr class="separator:a51923b03f35af4bac7c3bb7c8d13303d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28001200e3d464f5c6e910837924c577"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#a28001200e3d464f5c6e910837924c577">send</a> (uint8_t data)=0</td></tr>
<tr class="separator:a28001200e3d464f5c6e910837924c577"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a937215f1dc238285bd140c11ab82bbc9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_class.html#a937215f1dc238285bd140c11ab82bbc9">setSckSpeed</a> (uint32_t maxSck)</td></tr>
<tr class="separator:a937215f1dc238285bd140c11ab82bbc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for external SPI drivers. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ace7d46253efcaaab8b6be50cc17233e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace7d46253efcaaab8b6be50cc17233e4">&#9670;&nbsp;</a></span>activate()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void SdSpiBaseClass::activate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Activate SPI hardware. </p>

<p>Reimplemented in <a class="el" href="class_my_spi_class.html#a906649904dde5b504bdc12d5b125cdce">MySpiClass</a>.</p>

</div>
</div>
<a id="ae186fa647e8e332a9e87d765f92047a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae186fa647e8e332a9e87d765f92047a5">&#9670;&nbsp;</a></span>begin()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void SdSpiBaseClass::begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Initialize the SPI bus. </p>

<p>Implemented in <a class="el" href="class_my_spi_class.html#a62201e250cb0a71d71c9bd00bfaabe4d">MySpiClass</a>.</p>

</div>
</div>
<a id="ae3a5ede781e390263382fcf7765d665d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3a5ede781e390263382fcf7765d665d">&#9670;&nbsp;</a></span>deactivate()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void SdSpiBaseClass::deactivate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Deactivate SPI hardware. </p>

<p>Reimplemented in <a class="el" href="class_my_spi_class.html#a35e19b66e25678ba3928e047270e45c4">MySpiClass</a>.</p>

</div>
</div>
<a id="a537c71fb2cdb8a825215c0faeb6f7dbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a537c71fb2cdb8a825215c0faeb6f7dbd">&#9670;&nbsp;</a></span>receive() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual uint8_t SdSpiBaseClass::receive </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Receive a byte.</p>
<dl class="section return"><dt>Returns</dt><dd>The byte. </dd></dl>

<p>Implemented in <a class="el" href="class_my_spi_class.html#ab7a11bf55dba84c8437e29940ee72276">MySpiClass</a>.</p>

</div>
</div>
<a id="a45693c18a8bb44ec9e5b9b1dee39b393"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45693c18a8bb44ec9e5b9b1dee39b393">&#9670;&nbsp;</a></span>receive() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual uint8_t SdSpiBaseClass::receive </td>
          <td>(</td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Receive multiple bytes.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer to receive the data. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to receive.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero for no error or nonzero error code. </dd></dl>

<p>Implemented in <a class="el" href="class_my_spi_class.html#a14913993cfaf4a48805cdddbdf883e4f">MySpiClass</a>.</p>

</div>
</div>
<a id="a51923b03f35af4bac7c3bb7c8d13303d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51923b03f35af4bac7c3bb7c8d13303d">&#9670;&nbsp;</a></span>send() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void SdSpiBaseClass::send </td>
          <td>(</td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Send multiple bytes.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for data to be sent. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of bytes to send. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="class_my_spi_class.html#a27a8048d69b6715afdbe8c58d8a08bb6">MySpiClass</a>.</p>

</div>
</div>
<a id="a28001200e3d464f5c6e910837924c577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28001200e3d464f5c6e910837924c577">&#9670;&nbsp;</a></span>send() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void SdSpiBaseClass::send </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Send a byte.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Byte to send </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="class_my_spi_class.html#a7f7369452d8a82f0dc24be00bba9c962">MySpiClass</a>.</p>

</div>
</div>
<a id="a937215f1dc238285bd140c11ab82bbc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a937215f1dc238285bd140c11ab82bbc9">&#9670;&nbsp;</a></span>setSckSpeed()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void SdSpiBaseClass::setSckSpeed </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>maxSck</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Save high speed SPISettings after SD initialization.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">maxSck</td><td>Maximum SCK frequency. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="class_my_spi_class.html#a82e307da53a6d5d1003426c1ac30a915">MySpiClass</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ArduinoSdFat/libraries/SdFat/src/SpiDriver/<a class="el" href="_sd_spi_base_class_8h.html">SdSpiBaseClass.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>