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.
60 Commits
1 Branch
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
teensy-sdfat/extras/html/class_block_device_interfac...

375 lines
16KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>SdFat: BlockDeviceInterface Class Reference</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">SdFat

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.8.16 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. <!-- window showing the filter options -->

  49. <div id="MSearchSelectWindow"

  50.      onmouseover="return searchBox.OnSearchSelectShow()"

  51.      onmouseout="return searchBox.OnSearchSelectHide()"

  52.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  53. </div>

  54. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. </div><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="class_block_device_interface-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

  68. <div class="title">BlockDeviceInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>

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

  70. <div class="contents">

  71. 

  72. <p><a class="el" href="class_block_device_interface.html" title="BlockDeviceInterface class.">BlockDeviceInterface</a> class.  

  73.  <a href="class_block_device_interface.html#details">More...</a></p>

  74. 

  75. <p><code>#include &lt;BlockDeviceInterface.h&gt;</code></p>

  76. <div class="dynheader">

  77. Inheritance diagram for BlockDeviceInterface:</div>

  78. <div class="dyncontent">

  79. <div class="center"><img src="class_block_device_interface__inherit__graph.png" border="0" usemap="#_block_device_interface_inherit__map" alt="Inheritance graph"/></div>

  80. <map name="_block_device_interface_inherit__map" id="_block_device_interface_inherit__map">

  81. <area shape="rect" title="BlockDeviceInterface class." alt="" coords="5,5,148,32"/>

  82. <area shape="rect" href="class_sd_card_interface.html" title="Abstract interface for an SD card." alt="" coords="19,80,134,107"/>

  83. <area shape="rect" href="class_sdio_card.html" title="Raw SDIO access to SD and SDHC flash memory cards." alt="" coords="39,155,114,181"/>

  84. </map>

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

  86. <table class="memberdecls">

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

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

  89. <tr class="memitem:a537ffdf8645666ee60d9bee0d7e3d17e"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_device_interface.html#a537ffdf8645666ee60d9bee0d7e3d17e">readSector</a> (uint32_t sector, uint8_t *dst)=0</td></tr>

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

  91. <tr class="memitem:aeee2944296d4aaabd00ee7be90596c5c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_device_interface.html#aeee2944296d4aaabd00ee7be90596c5c">readSectors</a> (uint32_t sector, uint8_t *dst, size_t ns)=0</td></tr>

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

  93. <tr class="memitem:a1531ba16d499510ae60be288112faae1"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_device_interface.html#a1531ba16d499510ae60be288112faae1">sectorCount</a> ()=0</td></tr>

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

  95. <tr class="memitem:a23e30999f1cc03da99e285cf180dbbb7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_device_interface.html#a23e30999f1cc03da99e285cf180dbbb7">syncDevice</a> ()=0</td></tr>

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

  97. <tr class="memitem:a8a4be0a85c3771c705617fad98303e49"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_device_interface.html#a8a4be0a85c3771c705617fad98303e49">writeSector</a> (uint32_t sector, const uint8_t *src)=0</td></tr>

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

  99. <tr class="memitem:a5cb063692a65f092ccdfd14f8700b58a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_device_interface.html#a5cb063692a65f092ccdfd14f8700b58a">writeSectors</a> (uint32_t sector, const uint8_t *src, size_t ns)=0</td></tr>

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

  101. </table>

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

  103. <div class="textblock"><p><a class="el" href="class_block_device_interface.html" title="BlockDeviceInterface class.">BlockDeviceInterface</a> class. </p>

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

  105. <a id="a537ffdf8645666ee60d9bee0d7e3d17e"></a>

  106. <h2 class="memtitle"><span class="permalink"><a href="#a537ffdf8645666ee60d9bee0d7e3d17e">&#9670;&nbsp;</a></span>readSector()</h2>

  107. 

  108. <div class="memitem">

  109. <div class="memproto">

  110. <table class="mlabels">

  111.   <tr>

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

  113.       <table class="memname">

  114.         <tr>

  115.           <td class="memname">virtual bool BlockDeviceInterface::readSector </td>

  116.           <td>(</td>

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

  118.           <td class="paramname"><em>sector</em>, </td>

  119.         </tr>

  120.         <tr>

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

  122.           <td></td>

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

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

  125.         </tr>

  126.         <tr>

  127.           <td></td>

  128.           <td>)</td>

  129.           <td></td><td></td>

  130.         </tr>

  131.       </table>

  132.   </td>

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

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

  135.   </tr>

  136. </table>

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

  138. <p>Read a 512 byte sector.</p>

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

  140.   <table class="params">

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

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

  143.   </table>

  144.   </dd>

  145. </dl>

  146. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  147. 

  148. <p>Implemented in <a class="el" href="class_sdio_card.html#a77ae4fbe24bb04b74af5d388d4139dde">SdioCard</a>.</p>

  149. 

  150. </div>

  151. </div>

  152. <a id="aeee2944296d4aaabd00ee7be90596c5c"></a>

  153. <h2 class="memtitle"><span class="permalink"><a href="#aeee2944296d4aaabd00ee7be90596c5c">&#9670;&nbsp;</a></span>readSectors()</h2>

  154. 

  155. <div class="memitem">

  156. <div class="memproto">

  157. <table class="mlabels">

  158.   <tr>

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

  160.       <table class="memname">

  161.         <tr>

  162.           <td class="memname">virtual bool BlockDeviceInterface::readSectors </td>

  163.           <td>(</td>

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

  165.           <td class="paramname"><em>sector</em>, </td>

  166.         </tr>

  167.         <tr>

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

  169.           <td></td>

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

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

  172.         </tr>

  173.         <tr>

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

  175.           <td></td>

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

  177.           <td class="paramname"><em>ns</em>&#160;</td>

  178.         </tr>

  179.         <tr>

  180.           <td></td>

  181.           <td>)</td>

  182.           <td></td><td></td>

  183.         </tr>

  184.       </table>

  185.   </td>

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

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

  188.   </tr>

  189. </table>

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

  191. <p>Read multiple 512 byte sectors.</p>

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

  193.   <table class="params">

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

  195.     <tr><td class="paramdir">[in]</td><td class="paramname">ns</td><td>Number of sectors to be read. </td></tr>

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

  197.   </table>

  198.   </dd>

  199. </dl>

  200. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  201. 

  202. <p>Implemented in <a class="el" href="class_sdio_card.html#a1ed4229446a5a2fe815d460b027243b9">SdioCard</a>.</p>

  203. 

  204. </div>

  205. </div>

  206. <a id="a1531ba16d499510ae60be288112faae1"></a>

  207. <h2 class="memtitle"><span class="permalink"><a href="#a1531ba16d499510ae60be288112faae1">&#9670;&nbsp;</a></span>sectorCount()</h2>

  208. 

  209. <div class="memitem">

  210. <div class="memproto">

  211. <table class="mlabels">

  212.   <tr>

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

  214.       <table class="memname">

  215.         <tr>

  216.           <td class="memname">virtual uint32_t BlockDeviceInterface::sectorCount </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">pure virtual</span></span>  </td>

  225.   </tr>

  226. </table>

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

  228. <dl class="section return"><dt>Returns</dt><dd>device size in sectors. </dd></dl>

  229. 

  230. <p>Implemented in <a class="el" href="class_sd_card_interface.html#a1a8c37709b578bffc556240f6f03a8da">SdCardInterface</a>, and <a class="el" href="class_sdio_card.html#a49a502cf7b59dc559a6c75a3285e6c1a">SdioCard</a>.</p>

  231. 

  232. </div>

  233. </div>

  234. <a id="a23e30999f1cc03da99e285cf180dbbb7"></a>

  235. <h2 class="memtitle"><span class="permalink"><a href="#a23e30999f1cc03da99e285cf180dbbb7">&#9670;&nbsp;</a></span>syncDevice()</h2>

  236. 

  237. <div class="memitem">

  238. <div class="memproto">

  239. <table class="mlabels">

  240.   <tr>

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

  242.       <table class="memname">

  243.         <tr>

  244.           <td class="memname">virtual bool BlockDeviceInterface::syncDevice </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">pure virtual</span></span>  </td>

  253.   </tr>

  254. </table>

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

  256. <p>End multi-sector transfer and go to idle state. </p><dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  257. 

  258. <p>Implemented in <a class="el" href="class_sdio_card.html#a1201ec7a6fa91b73a1daa584a1b055f7">SdioCard</a>.</p>

  259. 

  260. </div>

  261. </div>

  262. <a id="a8a4be0a85c3771c705617fad98303e49"></a>

  263. <h2 class="memtitle"><span class="permalink"><a href="#a8a4be0a85c3771c705617fad98303e49">&#9670;&nbsp;</a></span>writeSector()</h2>

  264. 

  265. <div class="memitem">

  266. <div class="memproto">

  267. <table class="mlabels">

  268.   <tr>

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

  270.       <table class="memname">

  271.         <tr>

  272.           <td class="memname">virtual bool BlockDeviceInterface::writeSector </td>

  273.           <td>(</td>

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

  275.           <td class="paramname"><em>sector</em>, </td>

  276.         </tr>

  277.         <tr>

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

  279.           <td></td>

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

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

  282.         </tr>

  283.         <tr>

  284.           <td></td>

  285.           <td>)</td>

  286.           <td></td><td></td>

  287.         </tr>

  288.       </table>

  289.   </td>

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

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

  292.   </tr>

  293. </table>

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

  295. <p>Writes a 512 byte sector.</p>

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

  297.   <table class="params">

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

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

  300.   </table>

  301.   </dd>

  302. </dl>

  303. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  304. 

  305. <p>Implemented in <a class="el" href="class_sdio_card.html#a74919a168bac68028ce62222500cf238">SdioCard</a>.</p>

  306. 

  307. </div>

  308. </div>

  309. <a id="a5cb063692a65f092ccdfd14f8700b58a"></a>

  310. <h2 class="memtitle"><span class="permalink"><a href="#a5cb063692a65f092ccdfd14f8700b58a">&#9670;&nbsp;</a></span>writeSectors()</h2>

  311. 

  312. <div class="memitem">

  313. <div class="memproto">

  314. <table class="mlabels">

  315.   <tr>

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

  317.       <table class="memname">

  318.         <tr>

  319.           <td class="memname">virtual bool BlockDeviceInterface::writeSectors </td>

  320.           <td>(</td>

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

  322.           <td class="paramname"><em>sector</em>, </td>

  323.         </tr>

  324.         <tr>

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

  326.           <td></td>

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

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

  329.         </tr>

  330.         <tr>

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

  332.           <td></td>

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

  334.           <td class="paramname"><em>ns</em>&#160;</td>

  335.         </tr>

  336.         <tr>

  337.           <td></td>

  338.           <td>)</td>

  339.           <td></td><td></td>

  340.         </tr>

  341.       </table>

  342.   </td>

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

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

  345.   </tr>

  346. </table>

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

  348. <p>Write multiple 512 byte sectors.</p>

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

  350.   <table class="params">

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

  352.     <tr><td class="paramdir">[in]</td><td class="paramname">ns</td><td>Number of sectors to be written. </td></tr>

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

  354.   </table>

  355.   </dd>

  356. </dl>

  357. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>

  358. 

  359. <p>Implemented in <a class="el" href="class_sdio_card.html#a55e2fc82ef9ecf7272a94b565c50303b">SdioCard</a>.</p>

  360. 

  361. </div>

  362. </div>

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

  364. <li>ArduinoSdFat/libraries/SdFat/src/common/<a class="el" href="_block_device_interface_8h.html">BlockDeviceInterface.h</a></li>

  365. </ul>

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

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

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

  369. Generated on Fri Dec 6 2019 09:45:12 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  371. </a> 1.8.16

  372. </small></address>

  373. </body>

  374. </html>