|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.10"/>
- <title>SdFat: SdSpiBaseDriver 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>
- <script type="text/javascript">
- $(document).ready(function() { init_search(); });
- </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.10 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </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> |
- <a href="class_sd_spi_base_driver-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">SdSpiBaseDriver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
- </div><!--header-->
- <div class="contents">
-
- <p>SPI base driver.
- <a href="class_sd_spi_base_driver.html#details">More...</a></p>
-
- <p><code>#include <SdSpiBaseDriver.h></code></p>
- <div class="dynheader">
- Inheritance diagram for SdSpiBaseDriver:</div>
- <div class="dyncontent">
- <div class="center"><img src="class_sd_spi_base_driver__inherit__graph.png" border="0" usemap="#_sd_spi_base_driver_inherit__map" alt="Inheritance graph"/></div>
- <map name="_sd_spi_base_driver_inherit__map" id="_sd_spi_base_driver_inherit__map">
- <area shape="rect" id="node2" href="class_sd_spi_soft_driver.html" title="Software SPI class for access to SD and SDHC flash memory cards. " alt="" coords="5,80,180,121"/>
- </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:ab7e6974c19d1b1543e242c8a717cfd8f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#ab7e6974c19d1b1543e242c8a717cfd8f">activate</a> ()=0</td></tr>
- <tr class="separator:ab7e6974c19d1b1543e242c8a717cfd8f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a287ec377c2a214bdb964f59a25ad7dd4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#a287ec377c2a214bdb964f59a25ad7dd4">begin</a> (uint8_t chipSelectPin)=0</td></tr>
- <tr class="separator:a287ec377c2a214bdb964f59a25ad7dd4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1768309c7ba4f8d78c2ba62383462de2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#a1768309c7ba4f8d78c2ba62383462de2">deactivate</a> ()=0</td></tr>
- <tr class="separator:a1768309c7ba4f8d78c2ba62383462de2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5f020c62122d020e4603c0ee2c906668"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#a5f020c62122d020e4603c0ee2c906668">receive</a> ()=0</td></tr>
- <tr class="separator:a5f020c62122d020e4603c0ee2c906668"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a556cc7d8afb70a7f50c64f212df60f06"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#a556cc7d8afb70a7f50c64f212df60f06">receive</a> (uint8_t *buf, size_t n)=0</td></tr>
- <tr class="separator:a556cc7d8afb70a7f50c64f212df60f06"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3dd831b876fc59747b17a3037085da00"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#a3dd831b876fc59747b17a3037085da00">select</a> ()=0</td></tr>
- <tr class="separator:a3dd831b876fc59747b17a3037085da00"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa36ce5b4e227ee505ae4eb3e89e7a4e4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#aa36ce5b4e227ee505ae4eb3e89e7a4e4">send</a> (uint8_t data)=0</td></tr>
- <tr class="separator:aa36ce5b4e227ee505ae4eb3e89e7a4e4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af7731e0ab36b5f75d917cbdaa8c8cb17"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#af7731e0ab36b5f75d917cbdaa8c8cb17">send</a> (const uint8_t *buf, size_t n)=0</td></tr>
- <tr class="separator:af7731e0ab36b5f75d917cbdaa8c8cb17"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae8bc46d4585ad76587bafa4a49bfd248"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#ae8bc46d4585ad76587bafa4a49bfd248">setSpiSettings</a> (SPISettings spiSettings)=0</td></tr>
- <tr class="separator:ae8bc46d4585ad76587bafa4a49bfd248"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5210d976ca6b1ef50619cb29054eae71"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_spi_base_driver.html#a5210d976ca6b1ef50619cb29054eae71">unselect</a> ()=0</td></tr>
- <tr class="separator:a5210d976ca6b1ef50619cb29054eae71"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>SPI base driver. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="ab7e6974c19d1b1543e242c8a717cfd8f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SdSpiBaseDriver::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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set SPI options for access to SD/SDHC cards. </p>
-
- <p>Implemented in <a class="el" href="class_sd_spi_soft_driver.html#a10c2eb17cb8b467067bc767a1e59859f">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="a287ec377c2a214bdb964f59a25ad7dd4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SdSpiBaseDriver::begin </td>
- <td>(</td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>chipSelectPin</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>Initialize the SPI bus.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">chipSelectPin</td><td>SD card chip select pin. </td></tr>
- </table>
- </dd>
- </dl>
-
- <p>Implemented in <a class="el" href="class_sd_spi_soft_driver.html#a0c016f86abca805d8716052bab181660">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="a1768309c7ba4f8d78c2ba62383462de2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SdSpiBaseDriver::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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>End SPI transaction. </p>
-
- <p>Implemented in <a class="el" href="class_sd_spi_soft_driver.html#a03b5da2d9d0196212f17afbbc9bf784a">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="a5f020c62122d020e4603c0ee2c906668"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint8_t SdSpiBaseDriver::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_sd_spi_soft_driver.html#a814d39a4eee44bd679801228595893b9">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="a556cc7d8afb70a7f50c64f212df60f06"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual uint8_t SdSpiBaseDriver::receive </td>
- <td>(</td>
- <td class="paramtype">uint8_t * </td>
- <td class="paramname"><em>buf</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>n</em> </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">n</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_sd_spi_soft_driver.html#ab068f18eeb629fe8a8fbeded9f7da760">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="a3dd831b876fc59747b17a3037085da00"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SdSpiBaseDriver::select </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>Set CS low. </p>
-
- <p>Implemented in <a class="el" href="class_sd_spi_soft_driver.html#a9fc0ff9c851ef7d8cd3cea54827a901c">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="aa36ce5b4e227ee505ae4eb3e89e7a4e4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SdSpiBaseDriver::send </td>
- <td>(</td>
- <td class="paramtype">uint8_t </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_sd_spi_soft_driver.html#a661b50258ff50405b49c75bca89dfd2d">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="af7731e0ab36b5f75d917cbdaa8c8cb17"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SdSpiBaseDriver::send </td>
- <td>(</td>
- <td class="paramtype">const uint8_t * </td>
- <td class="paramname"><em>buf</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size_t </td>
- <td class="paramname"><em>n</em> </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">n</td><td>Number of bytes to send. </td></tr>
- </table>
- </dd>
- </dl>
-
- <p>Implemented in <a class="el" href="class_sd_spi_soft_driver.html#ad0d391da39fb784a211d7607b2ea1480">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="ae8bc46d4585ad76587bafa4a49bfd248"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SdSpiBaseDriver::setSpiSettings </td>
- <td>(</td>
- <td class="paramtype">SPISettings </td>
- <td class="paramname"><em>spiSettings</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>Save SPI settings. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">spiSettings</td><td>SPI speed, mode, and bit order. </td></tr>
- </table>
- </dd>
- </dl>
-
- <p>Implemented in <a class="el" href="class_sd_spi_soft_driver.html#a8ea0646dcb016fa23bc192157255da26">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <a class="anchor" id="a5210d976ca6b1ef50619cb29054eae71"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void SdSpiBaseDriver::unselect </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>Set CS high. </p>
-
- <p>Implemented in <a class="el" href="class_sd_spi_soft_driver.html#ab2eaea746989c3762e64bb3ef4faeee9">SdSpiSoftDriver< MisoPin, MosiPin, SckPin ></a>.</p>
-
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>Arduino/libraries/SdFat/src/SdSpiCard/SdSpiBaseDriver.h</li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Fri Aug 19 2016 08:28:00 for SdFat by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.10
- </small></address>
- </body>
- </html>
|