visus
/
teensy-sdfat
Bevaka 1
Stjärnmärk 0
Förgrening 0
Kod Ärenden 0 Pull-förfrågningar 0 Släpp 0 Wiki Aktiviteter
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
33 Incheckningar
1 Gren
Träd: 1c74e428dd
Grenar Taggar
${ item.name }
Skapa branchen ${ searchTerm }
från '1c74e428dd'
${ noResults }
teensy-sdfat/html/class_base_block_driver.html

353 lines
15KB
Rå Blame Historik 

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

  87.   <div class="headertitle">

  88. <div class="title">BaseBlockDriver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>

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

  90. <div class="contents">

  91. 

  92. <p>Base block driver.  

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

  94. 

  95. <p><code>#include &lt;BaseBlockDriver.h&gt;</code></p>

  96. <div class="dynheader">

  97. Inheritance diagram for BaseBlockDriver:</div>

  98. <div class="dyncontent">

  99. <div class="center"><img src="class_base_block_driver__inherit__graph.png" border="0" usemap="#_base_block_driver_inherit__map" alt="Inheritance graph"/></div>

  100. <map name="_base_block_driver_inherit__map" id="_base_block_driver_inherit__map">

  101. <area shape="rect" id="node2" href="class_sd_block_driver_e_x.html" title="Extended SD I/O block driver. " alt="" coords="5,80,124,107"/>

  102. </map>

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

  104. <table class="memberdecls">

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

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

  107. <tr class="memitem:a16bb3305f3130253dd7ab6e19aa1b524"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_base_block_driver.html#a16bb3305f3130253dd7ab6e19aa1b524">readBlock</a> (uint32_t block, uint8_t *dst)=0</td></tr>

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

  109. <tr class="memitem:a3a029a2d02fc7cbdd7c15c8d622565c4"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_base_block_driver.html#a3a029a2d02fc7cbdd7c15c8d622565c4">readBlocks</a> (uint32_t block, uint8_t *dst, size_t nb)=0</td></tr>

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

  111. <tr class="memitem:a5361ff2658d7654bf00b97c54c6aa2aa"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_base_block_driver.html#a5361ff2658d7654bf00b97c54c6aa2aa">syncBlocks</a> ()=0</td></tr>

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

  113. <tr class="memitem:a87df3db1b400286883661525441d39fa"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_base_block_driver.html#a87df3db1b400286883661525441d39fa">writeBlock</a> (uint32_t block, const uint8_t *src)=0</td></tr>

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

  115. <tr class="memitem:a3d6520b21252ebfb17b0cac0b87689b1"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_base_block_driver.html#a3d6520b21252ebfb17b0cac0b87689b1">writeBlocks</a> (uint32_t block, const uint8_t *src, size_t nb)=0</td></tr>

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

  117. </table>

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

  119. <div class="textblock"><p>Base block driver. </p>

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

  121. <a class="anchor" id="a16bb3305f3130253dd7ab6e19aa1b524"></a>

  122. <div class="memitem">

  123. <div class="memproto">

  124. <table class="mlabels">

  125.   <tr>

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

  127.       <table class="memname">

  128.         <tr>

  129.           <td class="memname">virtual bool BaseBlockDriver::readBlock </td>

  130.           <td>(</td>

  131.           <td class="paramtype">uint32_t&#160;</td>

  132.           <td class="paramname"><em>block</em>, </td>

  133.         </tr>

  134.         <tr>

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

  136.           <td></td>

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

  138.           <td class="paramname"><em>dst</em>&#160;</td>

  139.         </tr>

  140.         <tr>

  141.           <td></td>

  142.           <td>)</td>

  143.           <td></td><td></td>

  144.         </tr>

  145.       </table>

  146.   </td>

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

  148. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  149.   </tr>

  150. </table>

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

  152. <p>Read a 512 byte block from an SD card.</p>

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

  154.   <table class="params">

  155.     <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>Logical block to be read. </td></tr>

  156.     <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>

  157.   </table>

  158.   </dd>

  159. </dl>

  160. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  161. 

  162. <p>Implemented in <a class="el" href="class_sd_block_driver_e_x.html#a2820c15543b0e1950961b72945ade853">SdBlockDriverEX</a>.</p>

  163. 

  164. </div>

  165. </div>

  166. <a class="anchor" id="a3a029a2d02fc7cbdd7c15c8d622565c4"></a>

  167. <div class="memitem">

  168. <div class="memproto">

  169. <table class="mlabels">

  170.   <tr>

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

  172.       <table class="memname">

  173.         <tr>

  174.           <td class="memname">virtual bool BaseBlockDriver::readBlocks </td>

  175.           <td>(</td>

  176.           <td class="paramtype">uint32_t&#160;</td>

  177.           <td class="paramname"><em>block</em>, </td>

  178.         </tr>

  179.         <tr>

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

  181.           <td></td>

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

  183.           <td class="paramname"><em>dst</em>, </td>

  184.         </tr>

  185.         <tr>

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

  187.           <td></td>

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

  189.           <td class="paramname"><em>nb</em>&#160;</td>

  190.         </tr>

  191.         <tr>

  192.           <td></td>

  193.           <td>)</td>

  194.           <td></td><td></td>

  195.         </tr>

  196.       </table>

  197.   </td>

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

  199. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  200.   </tr>

  201. </table>

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

  203. <p>Read multiple 512 byte blocks from an SD card.</p>

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

  205.   <table class="params">

  206.     <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>Logical block to be read. </td></tr>

  207.     <tr><td class="paramdir">[in]</td><td class="paramname">nb</td><td>Number of blocks to be read. </td></tr>

  208.     <tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Pointer to the location that will receive the data. </td></tr>

  209.   </table>

  210.   </dd>

  211. </dl>

  212. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  213. 

  214. <p>Implemented in <a class="el" href="class_sd_block_driver_e_x.html#a39941dac40896a2c11e49e650d0e6057">SdBlockDriverEX</a>.</p>

  215. 

  216. </div>

  217. </div>

  218. <a class="anchor" id="a5361ff2658d7654bf00b97c54c6aa2aa"></a>

  219. <div class="memitem">

  220. <div class="memproto">

  221. <table class="mlabels">

  222.   <tr>

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

  224.       <table class="memname">

  225.         <tr>

  226.           <td class="memname">virtual bool BaseBlockDriver::syncBlocks </td>

  227.           <td>(</td>

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

  229.           <td></td>

  230.         </tr>

  231.       </table>

  232.   </td>

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

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

  235.   </tr>

  236. </table>

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

  238. <p>End multi-block transfer and go to idle state. </p><dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  239. 

  240. <p>Implemented in <a class="el" href="class_sd_block_driver_e_x.html#a5386776abfa49ac81d1706f9ac1149c8">SdBlockDriverEX</a>.</p>

  241. 

  242. </div>

  243. </div>

  244. <a class="anchor" id="a87df3db1b400286883661525441d39fa"></a>

  245. <div class="memitem">

  246. <div class="memproto">

  247. <table class="mlabels">

  248.   <tr>

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

  250.       <table class="memname">

  251.         <tr>

  252.           <td class="memname">virtual bool BaseBlockDriver::writeBlock </td>

  253.           <td>(</td>

  254.           <td class="paramtype">uint32_t&#160;</td>

  255.           <td class="paramname"><em>block</em>, </td>

  256.         </tr>

  257.         <tr>

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

  259.           <td></td>

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

  261.           <td class="paramname"><em>src</em>&#160;</td>

  262.         </tr>

  263.         <tr>

  264.           <td></td>

  265.           <td>)</td>

  266.           <td></td><td></td>

  267.         </tr>

  268.       </table>

  269.   </td>

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

  271. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  272.   </tr>

  273. </table>

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

  275. <p>Writes a 512 byte block to an SD card.</p>

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

  277.   <table class="params">

  278.     <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>Logical block to be written. </td></tr>

  279.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>

  280.   </table>

  281.   </dd>

  282. </dl>

  283. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  284. 

  285. <p>Implemented in <a class="el" href="class_sd_block_driver_e_x.html#a21411fd0ddb394d6093b284af739e46c">SdBlockDriverEX</a>.</p>

  286. 

  287. </div>

  288. </div>

  289. <a class="anchor" id="a3d6520b21252ebfb17b0cac0b87689b1"></a>

  290. <div class="memitem">

  291. <div class="memproto">

  292. <table class="mlabels">

  293.   <tr>

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

  295.       <table class="memname">

  296.         <tr>

  297.           <td class="memname">virtual bool BaseBlockDriver::writeBlocks </td>

  298.           <td>(</td>

  299.           <td class="paramtype">uint32_t&#160;</td>

  300.           <td class="paramname"><em>block</em>, </td>

  301.         </tr>

  302.         <tr>

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

  304.           <td></td>

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

  306.           <td class="paramname"><em>src</em>, </td>

  307.         </tr>

  308.         <tr>

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

  310.           <td></td>

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

  312.           <td class="paramname"><em>nb</em>&#160;</td>

  313.         </tr>

  314.         <tr>

  315.           <td></td>

  316.           <td>)</td>

  317.           <td></td><td></td>

  318.         </tr>

  319.       </table>

  320.   </td>

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

  322. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  323.   </tr>

  324. </table>

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

  326. <p>Write multiple 512 byte blocks to an SD card.</p>

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

  328.   <table class="params">

  329.     <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>Logical block to be written. </td></tr>

  330.     <tr><td class="paramdir">[in]</td><td class="paramname">nb</td><td>Number of blocks to be written. </td></tr>

  331.     <tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Pointer to the location of the data to be written. </td></tr>

  332.   </table>

  333.   </dd>

  334. </dl>

  335. <dl class="section return"><dt>Returns</dt><dd>The value true is returned for success and the value false is returned for failure. </dd></dl>

  336. 

  337. <p>Implemented in <a class="el" href="class_sd_block_driver_e_x.html#ac91f223488f7b76b11f4f52335ce9730">SdBlockDriverEX</a>.</p>

  338. 

  339. </div>

  340. </div>

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

  342. <li>Arduino/libraries/SdFat/src/FatLib/BaseBlockDriver.h</li>

  343. </ul>

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

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

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

  347. Generated on Fri Aug 19 2016 08:28:00 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  349. </a> 1.8.10

  350. </small></address>

  351. </body>

  352. </html>