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_fat_partition.html

774 lines
33KB
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: FatPartition 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="#friends">Friends</a> &#124;

  67. <a href="class_fat_partition-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

  69. <div class="title">FatPartition Class Reference</div>  </div>

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

  71. <div class="contents">

  72. 

  73. <p>Access FAT16 and FAT32 partitions on raw file devices.  

  74.  <a href="class_fat_partition.html#details">More...</a></p>

  75. 

  76. <p><code>#include &lt;FatPartition.h&gt;</code></p>

  77. <div class="dynheader">

  78. Inheritance diagram for FatPartition:</div>

  79. <div class="dyncontent">

  80. <div class="center"><img src="class_fat_partition__inherit__graph.png" border="0" usemap="#_fat_partition_inherit__map" alt="Inheritance graph"/></div>

  81. <map name="_fat_partition_inherit__map" id="_fat_partition_inherit__map">

  82. <area shape="rect" title="Access FAT16 and FAT32 partitions on raw file devices." alt="" coords="38,5,127,32"/>

  83. <area shape="rect" href="class_fat_volume.html" title="Integration class for the FatLib library." alt="" coords="40,80,125,107"/>

  84. <area shape="rect" href="class_sd_base.html" title=" " alt="" coords="5,155,160,181"/>

  85. <area shape="rect" href="class_sd_fat32.html" title="SD file system class for FAT volumes." alt="" coords="47,229,118,256"/>

  86. </map>

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

  88. <table class="memberdecls">

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

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

  91. <tr class="memitem:a1c3ab374b425c27bb6b6ddd55752c056"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1c3ab374b425c27bb6b6ddd55752c056">bytesPerCluster</a> ()</td></tr>

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

  93. <tr class="memitem:aaf43a09e71689c257f4b189ee307db4f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#aaf43a09e71689c257f4b189ee307db4f">bytesPerClusterShift</a> ()</td></tr>

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

  95. <tr class="memitem:a1eba03c763bab44263735488435731f8"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1eba03c763bab44263735488435731f8">bytesPerSector</a> ()</td></tr>

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

  97. <tr class="memitem:a4e513ab3fcfb95583092793116aa4df5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a4e513ab3fcfb95583092793116aa4df5">bytesPerSectorShift</a> ()</td></tr>

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

  99. <tr class="memitem:abf74c1e3c714b396e6271aee304c2448"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unioncache__t.html">cache_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#abf74c1e3c714b396e6271aee304c2448">cacheClear</a> ()</td></tr>

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

  101. <tr class="memitem:aba35645c23735c4833c07bc2b3adcd1f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#aba35645c23735c4833c07bc2b3adcd1f">clusterCount</a> () const</td></tr>

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

  103. <tr class="memitem:a7e89ec91780f7dfa060b261c605bf2e5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a7e89ec91780f7dfa060b261c605bf2e5">dataStartSector</a> () const</td></tr>

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

  105. <tr class="memitem:a0af1e91a311180119b4a2c85d7e6e87e"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a0af1e91a311180119b4a2c85d7e6e87e">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>

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

  107. <tr class="memitem:a56b37c3230818b9ae8e0a25c01a370a3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a56b37c3230818b9ae8e0a25c01a370a3">fatCount</a> ()</td></tr>

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

  109. <tr class="memitem:a2c94db084d89355da7695d82ee612f72"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a2c94db084d89355da7695d82ee612f72">FatPartition</a> ()</td></tr>

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

  111. <tr class="memitem:a6a1ce7d707cf15bea08b63216413e055"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6a1ce7d707cf15bea08b63216413e055">fatStartSector</a> () const</td></tr>

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

  113. <tr class="memitem:ad45c276232d7093b82f1075e8c488bac"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ad45c276232d7093b82f1075e8c488bac">fatType</a> () const</td></tr>

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

  115. <tr class="memitem:ac9689f1e11f59acc5f1b21ed9bb71174"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ac9689f1e11f59acc5f1b21ed9bb71174">freeClusterCount</a> ()</td></tr>

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

  117. <tr class="memitem:ab827224f30eec57255d21cae589911ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#ab827224f30eec57255d21cae589911ef">init</a> (<a class="el" href="class_sd_spi_card.html">BlockDevice</a> *dev, uint8_t part=1)</td></tr>

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

  119. <tr class="memitem:a6ba99b9711269b5ab6ca091b88e81288"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6ba99b9711269b5ab6ca091b88e81288">rootDirEntryCount</a> () const</td></tr>

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

  121. <tr class="memitem:a5d005e0f6fd4b84da8a5ebdea03aaf85"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a5d005e0f6fd4b84da8a5ebdea03aaf85">rootDirStart</a> () const</td></tr>

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

  123. <tr class="memitem:a6b970fa2e06de1a826b09e251dc3119b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a6b970fa2e06de1a826b09e251dc3119b">sectorMask</a> ()</td></tr>

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

  125. <tr class="memitem:a836546c368e6ffe117e6ab8775d23eba"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a836546c368e6ffe117e6ab8775d23eba">sectorsPerCluster</a> () const</td></tr>

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

  127. <tr class="memitem:a593a27482ff8d993542d6f82bd92e26c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a593a27482ff8d993542d6f82bd92e26c">sectorsPerClusterShift</a> () const</td></tr>

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

  129. <tr class="memitem:a1f5c7599333dbe152a3cdd60623ce6d1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1f5c7599333dbe152a3cdd60623ce6d1">sectorsPerFat</a> () const</td></tr>

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

  131. <tr class="memitem:a916ba7d67711bb62daf12ecd47ca4b8e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a916ba7d67711bb62daf12ecd47ca4b8e">volumeSectorCount</a> () const</td></tr>

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

  133. </table><table class="memberdecls">

  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  135. Friends</h2></td></tr>

  136. <tr class="memitem:a1e97a7aed860b898c403cb29455b3fe7"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a1e97a7aed860b898c403cb29455b3fe7">FatCache</a></td></tr>

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

  138. <tr class="memitem:a18fb15a715ea85037ab802286853103e"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_partition.html#a18fb15a715ea85037ab802286853103e">FatFile</a></td></tr>

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

  140. </table>

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

  142. <div class="textblock"><p>Access FAT16 and FAT32 partitions on raw file devices. </p>

  143. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  144. <a id="a2c94db084d89355da7695d82ee612f72"></a>

  145. <h2 class="memtitle"><span class="permalink"><a href="#a2c94db084d89355da7695d82ee612f72">&#9670;&nbsp;</a></span>FatPartition()</h2>

  146. 

  147. <div class="memitem">

  148. <div class="memproto">

  149. <table class="mlabels">

  150.   <tr>

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

  152.       <table class="memname">

  153.         <tr>

  154.           <td class="memname">FatPartition::FatPartition </td>

  155.           <td>(</td>

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

  157.           <td></td>

  158.         </tr>

  159.       </table>

  160.   </td>

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

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

  163.   </tr>

  164. </table>

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

  166. <p>Create an instance of <a class="el" href="class_fat_partition.html" title="Access FAT16 and FAT32 partitions on raw file devices.">FatPartition</a> </p>

  167. 

  168. </div>

  169. </div>

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

  171. <a id="a1c3ab374b425c27bb6b6ddd55752c056"></a>

  172. <h2 class="memtitle"><span class="permalink"><a href="#a1c3ab374b425c27bb6b6ddd55752c056">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>

  173. 

  174. <div class="memitem">

  175. <div class="memproto">

  176. <table class="mlabels">

  177.   <tr>

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

  179.       <table class="memname">

  180.         <tr>

  181.           <td class="memname">uint16_t FatPartition::bytesPerCluster </td>

  182.           <td>(</td>

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

  184.           <td></td>

  185.         </tr>

  186.       </table>

  187.   </td>

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

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

  190.   </tr>

  191. </table>

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

  193. <dl class="section return"><dt>Returns</dt><dd>Number of bytes in a cluster. </dd></dl>

  194. 

  195. </div>

  196. </div>

  197. <a id="aaf43a09e71689c257f4b189ee307db4f"></a>

  198. <h2 class="memtitle"><span class="permalink"><a href="#aaf43a09e71689c257f4b189ee307db4f">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>

  199. 

  200. <div class="memitem">

  201. <div class="memproto">

  202. <table class="mlabels">

  203.   <tr>

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

  205.       <table class="memname">

  206.         <tr>

  207.           <td class="memname">uint8_t FatPartition::bytesPerClusterShift </td>

  208.           <td>(</td>

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

  210.           <td></td>

  211.         </tr>

  212.       </table>

  213.   </td>

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

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

  216.   </tr>

  217. </table>

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

  219. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>

  220. 

  221. </div>

  222. </div>

  223. <a id="a1eba03c763bab44263735488435731f8"></a>

  224. <h2 class="memtitle"><span class="permalink"><a href="#a1eba03c763bab44263735488435731f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>

  225. 

  226. <div class="memitem">

  227. <div class="memproto">

  228. <table class="mlabels">

  229.   <tr>

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

  231.       <table class="memname">

  232.         <tr>

  233.           <td class="memname">uint16_t FatPartition::bytesPerSector </td>

  234.           <td>(</td>

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

  236.           <td></td>

  237.         </tr>

  238.       </table>

  239.   </td>

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

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

  242.   </tr>

  243. </table>

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

  245. <dl class="section return"><dt>Returns</dt><dd>Number of bytes per sector. </dd></dl>

  246. 

  247. </div>

  248. </div>

  249. <a id="a4e513ab3fcfb95583092793116aa4df5"></a>

  250. <h2 class="memtitle"><span class="permalink"><a href="#a4e513ab3fcfb95583092793116aa4df5">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>

  251. 

  252. <div class="memitem">

  253. <div class="memproto">

  254. <table class="mlabels">

  255.   <tr>

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

  257.       <table class="memname">

  258.         <tr>

  259.           <td class="memname">uint8_t FatPartition::bytesPerSectorShift </td>

  260.           <td>(</td>

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

  262.           <td></td>

  263.         </tr>

  264.       </table>

  265.   </td>

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

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

  268.   </tr>

  269. </table>

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

  271. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>

  272. 

  273. </div>

  274. </div>

  275. <a id="abf74c1e3c714b396e6271aee304c2448"></a>

  276. <h2 class="memtitle"><span class="permalink"><a href="#abf74c1e3c714b396e6271aee304c2448">&#9670;&nbsp;</a></span>cacheClear()</h2>

  277. 

  278. <div class="memitem">

  279. <div class="memproto">

  280. <table class="mlabels">

  281.   <tr>

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

  283.       <table class="memname">

  284.         <tr>

  285.           <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatPartition::cacheClear </td>

  286.           <td>(</td>

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

  288.           <td></td>

  289.         </tr>

  290.       </table>

  291.   </td>

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

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

  294.   </tr>

  295. </table>

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

  297. <p>Clear the cache and returns a pointer to the cache. Not for normal apps. </p><dl class="section return"><dt>Returns</dt><dd>A pointer to the cache buffer or zero if an error occurs. </dd></dl>

  298. 

  299. </div>

  300. </div>

  301. <a id="aba35645c23735c4833c07bc2b3adcd1f"></a>

  302. <h2 class="memtitle"><span class="permalink"><a href="#aba35645c23735c4833c07bc2b3adcd1f">&#9670;&nbsp;</a></span>clusterCount()</h2>

  303. 

  304. <div class="memitem">

  305. <div class="memproto">

  306. <table class="mlabels">

  307.   <tr>

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

  309.       <table class="memname">

  310.         <tr>

  311.           <td class="memname">uint32_t FatPartition::clusterCount </td>

  312.           <td>(</td>

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

  314.           <td> const</td>

  315.         </tr>

  316.       </table>

  317.   </td>

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

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

  320.   </tr>

  321. </table>

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

  323. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>

  324. 

  325. </div>

  326. </div>

  327. <a id="a7e89ec91780f7dfa060b261c605bf2e5"></a>

  328. <h2 class="memtitle"><span class="permalink"><a href="#a7e89ec91780f7dfa060b261c605bf2e5">&#9670;&nbsp;</a></span>dataStartSector()</h2>

  329. 

  330. <div class="memitem">

  331. <div class="memproto">

  332. <table class="mlabels">

  333.   <tr>

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

  335.       <table class="memname">

  336.         <tr>

  337.           <td class="memname">uint32_t FatPartition::dataStartSector </td>

  338.           <td>(</td>

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

  340.           <td> const</td>

  341.         </tr>

  342.       </table>

  343.   </td>

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

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

  346.   </tr>

  347. </table>

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

  349. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>

  350. 

  351. </div>

  352. </div>

  353. <a id="a0af1e91a311180119b4a2c85d7e6e87e"></a>

  354. <h2 class="memtitle"><span class="permalink"><a href="#a0af1e91a311180119b4a2c85d7e6e87e">&#9670;&nbsp;</a></span>dbgFat()</h2>

  355. 

  356. <div class="memitem">

  357. <div class="memproto">

  358. <table class="mlabels">

  359.   <tr>

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

  361.       <table class="memname">

  362.         <tr>

  363.           <td class="memname">int8_t FatPartition::dbgFat </td>

  364.           <td>(</td>

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

  366.           <td class="paramname"><em>n</em>, </td>

  367.         </tr>

  368.         <tr>

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

  370.           <td></td>

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

  372.           <td class="paramname"><em>v</em>&#160;</td>

  373.         </tr>

  374.         <tr>

  375.           <td></td>

  376.           <td>)</td>

  377.           <td></td><td></td>

  378.         </tr>

  379.       </table>

  380.   </td>

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

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

  383.   </tr>

  384. </table>

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

  386. <p>Debug access to FAT table</p>

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

  388.   <table class="params">

  389.     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>

  390.     <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>

  391.   </table>

  392.   </dd>

  393. </dl>

  394. <dl class="section return"><dt>Returns</dt><dd>-1 error, 0 EOC, else 1. </dd></dl>

  395. 

  396. </div>

  397. </div>

  398. <a id="a56b37c3230818b9ae8e0a25c01a370a3"></a>

  399. <h2 class="memtitle"><span class="permalink"><a href="#a56b37c3230818b9ae8e0a25c01a370a3">&#9670;&nbsp;</a></span>fatCount()</h2>

  400. 

  401. <div class="memitem">

  402. <div class="memproto">

  403. <table class="mlabels">

  404.   <tr>

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

  406.       <table class="memname">

  407.         <tr>

  408.           <td class="memname">uint8_t FatPartition::fatCount </td>

  409.           <td>(</td>

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

  411.           <td></td>

  412.         </tr>

  413.       </table>

  414.   </td>

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

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

  417.   </tr>

  418. </table>

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

  420. <dl class="section return"><dt>Returns</dt><dd>The number of File Allocation Tables. </dd></dl>

  421. 

  422. </div>

  423. </div>

  424. <a id="a6a1ce7d707cf15bea08b63216413e055"></a>

  425. <h2 class="memtitle"><span class="permalink"><a href="#a6a1ce7d707cf15bea08b63216413e055">&#9670;&nbsp;</a></span>fatStartSector()</h2>

  426. 

  427. <div class="memitem">

  428. <div class="memproto">

  429. <table class="mlabels">

  430.   <tr>

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

  432.       <table class="memname">

  433.         <tr>

  434.           <td class="memname">uint32_t FatPartition::fatStartSector </td>

  435.           <td>(</td>

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

  437.           <td> const</td>

  438.         </tr>

  439.       </table>

  440.   </td>

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

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

  443.   </tr>

  444. </table>

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

  446. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the first FAT. </dd></dl>

  447. 

  448. </div>

  449. </div>

  450. <a id="ad45c276232d7093b82f1075e8c488bac"></a>

  451. <h2 class="memtitle"><span class="permalink"><a href="#ad45c276232d7093b82f1075e8c488bac">&#9670;&nbsp;</a></span>fatType()</h2>

  452. 

  453. <div class="memitem">

  454. <div class="memproto">

  455. <table class="mlabels">

  456.   <tr>

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

  458.       <table class="memname">

  459.         <tr>

  460.           <td class="memname">uint8_t FatPartition::fatType </td>

  461.           <td>(</td>

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

  463.           <td> const</td>

  464.         </tr>

  465.       </table>

  466.   </td>

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

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

  469.   </tr>

  470. </table>

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

  472. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>

  473. 

  474. </div>

  475. </div>

  476. <a id="ac9689f1e11f59acc5f1b21ed9bb71174"></a>

  477. <h2 class="memtitle"><span class="permalink"><a href="#ac9689f1e11f59acc5f1b21ed9bb71174">&#9670;&nbsp;</a></span>freeClusterCount()</h2>

  478. 

  479. <div class="memitem">

  480. <div class="memproto">

  481.       <table class="memname">

  482.         <tr>

  483.           <td class="memname">int32_t FatPartition::freeClusterCount </td>

  484.           <td>(</td>

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

  486.           <td></td>

  487.         </tr>

  488.       </table>

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

  490. <p>Volume free space in clusters.</p>

  491. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>

  492. 

  493. </div>

  494. </div>

  495. <a id="ab827224f30eec57255d21cae589911ef"></a>

  496. <h2 class="memtitle"><span class="permalink"><a href="#ab827224f30eec57255d21cae589911ef">&#9670;&nbsp;</a></span>init()</h2>

  497. 

  498. <div class="memitem">

  499. <div class="memproto">

  500.       <table class="memname">

  501.         <tr>

  502.           <td class="memname">bool FatPartition::init </td>

  503.           <td>(</td>

  504.           <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>

  505.           <td class="paramname"><em>dev</em>, </td>

  506.         </tr>

  507.         <tr>

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

  509.           <td></td>

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

  511.           <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>

  512.         </tr>

  513.         <tr>

  514.           <td></td>

  515.           <td>)</td>

  516.           <td></td><td></td>

  517.         </tr>

  518.       </table>

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

  520. <p>Initialize a FAT partition.</p>

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

  522.   <table class="params">

  523.     <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>BlockDevice for this partition. </td></tr>

  524.     <tr><td class="paramdir">[in]</td><td class="paramname">part</td><td>The partition to be used. Legal values for <em>part</em> are 1-4 to use the corresponding partition on a device formatted with a MBR, Master Boot Record, or zero if the device is formatted as a super floppy with the FAT boot sector in sector zero.</td></tr>

  525.   </table>

  526.   </dd>

  527. </dl>

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

  529. 

  530. </div>

  531. </div>

  532. <a id="a6ba99b9711269b5ab6ca091b88e81288"></a>

  533. <h2 class="memtitle"><span class="permalink"><a href="#a6ba99b9711269b5ab6ca091b88e81288">&#9670;&nbsp;</a></span>rootDirEntryCount()</h2>

  534. 

  535. <div class="memitem">

  536. <div class="memproto">

  537. <table class="mlabels">

  538.   <tr>

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

  540.       <table class="memname">

  541.         <tr>

  542.           <td class="memname">uint16_t FatPartition::rootDirEntryCount </td>

  543.           <td>(</td>

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

  545.           <td> const</td>

  546.         </tr>

  547.       </table>

  548.   </td>

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

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

  551.   </tr>

  552. </table>

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

  554. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>

  555. 

  556. </div>

  557. </div>

  558. <a id="a5d005e0f6fd4b84da8a5ebdea03aaf85"></a>

  559. <h2 class="memtitle"><span class="permalink"><a href="#a5d005e0f6fd4b84da8a5ebdea03aaf85">&#9670;&nbsp;</a></span>rootDirStart()</h2>

  560. 

  561. <div class="memitem">

  562. <div class="memproto">

  563. <table class="mlabels">

  564.   <tr>

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

  566.       <table class="memname">

  567.         <tr>

  568.           <td class="memname">uint32_t FatPartition::rootDirStart </td>

  569.           <td>(</td>

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

  571.           <td> const</td>

  572.         </tr>

  573.       </table>

  574.   </td>

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

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

  577.   </tr>

  578. </table>

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

  580. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>

  581. 

  582. </div>

  583. </div>

  584. <a id="a6b970fa2e06de1a826b09e251dc3119b"></a>

  585. <h2 class="memtitle"><span class="permalink"><a href="#a6b970fa2e06de1a826b09e251dc3119b">&#9670;&nbsp;</a></span>sectorMask()</h2>

  586. 

  587. <div class="memitem">

  588. <div class="memproto">

  589. <table class="mlabels">

  590.   <tr>

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

  592.       <table class="memname">

  593.         <tr>

  594.           <td class="memname">uint16_t FatPartition::sectorMask </td>

  595.           <td>(</td>

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

  597.           <td></td>

  598.         </tr>

  599.       </table>

  600.   </td>

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

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

  603.   </tr>

  604. </table>

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

  606. <dl class="section return"><dt>Returns</dt><dd>Mask for sector offset. </dd></dl>

  607. 

  608. </div>

  609. </div>

  610. <a id="a836546c368e6ffe117e6ab8775d23eba"></a>

  611. <h2 class="memtitle"><span class="permalink"><a href="#a836546c368e6ffe117e6ab8775d23eba">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>

  612. 

  613. <div class="memitem">

  614. <div class="memproto">

  615. <table class="mlabels">

  616.   <tr>

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

  618.       <table class="memname">

  619.         <tr>

  620.           <td class="memname">uint8_t FatPartition::sectorsPerCluster </td>

  621.           <td>(</td>

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

  623.           <td> const</td>

  624.         </tr>

  625.       </table>

  626.   </td>

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

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

  629.   </tr>

  630. </table>

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

  632. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>

  633. 

  634. </div>

  635. </div>

  636. <a id="a593a27482ff8d993542d6f82bd92e26c"></a>

  637. <h2 class="memtitle"><span class="permalink"><a href="#a593a27482ff8d993542d6f82bd92e26c">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>

  638. 

  639. <div class="memitem">

  640. <div class="memproto">

  641. <table class="mlabels">

  642.   <tr>

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

  644.       <table class="memname">

  645.         <tr>

  646.           <td class="memname">uint8_t FatPartition::sectorsPerClusterShift </td>

  647.           <td>(</td>

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

  649.           <td> const</td>

  650.         </tr>

  651.       </table>

  652.   </td>

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

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

  655.   </tr>

  656. </table>

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

  658. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by sectorsPerCluster. </dd></dl>

  659. 

  660. </div>

  661. </div>

  662. <a id="a1f5c7599333dbe152a3cdd60623ce6d1"></a>

  663. <h2 class="memtitle"><span class="permalink"><a href="#a1f5c7599333dbe152a3cdd60623ce6d1">&#9670;&nbsp;</a></span>sectorsPerFat()</h2>

  664. 

  665. <div class="memitem">

  666. <div class="memproto">

  667. <table class="mlabels">

  668.   <tr>

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

  670.       <table class="memname">

  671.         <tr>

  672.           <td class="memname">uint32_t FatPartition::sectorsPerFat </td>

  673.           <td>(</td>

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

  675.           <td> const</td>

  676.         </tr>

  677.       </table>

  678.   </td>

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

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

  681.   </tr>

  682. </table>

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

  684. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in one FAT. </dd></dl>

  685. 

  686. </div>

  687. </div>

  688. <a id="a916ba7d67711bb62daf12ecd47ca4b8e"></a>

  689. <h2 class="memtitle"><span class="permalink"><a href="#a916ba7d67711bb62daf12ecd47ca4b8e">&#9670;&nbsp;</a></span>volumeSectorCount()</h2>

  690. 

  691. <div class="memitem">

  692. <div class="memproto">

  693. <table class="mlabels">

  694.   <tr>

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

  696.       <table class="memname">

  697.         <tr>

  698.           <td class="memname">uint32_t FatPartition::volumeSectorCount </td>

  699.           <td>(</td>

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

  701.           <td> const</td>

  702.         </tr>

  703.       </table>

  704.   </td>

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

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

  707.   </tr>

  708. </table>

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

  710. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in the volume </dd></dl>

  711. 

  712. </div>

  713. </div>

  714. <h2 class="groupheader">Friends And Related Function Documentation</h2>

  715. <a id="a1e97a7aed860b898c403cb29455b3fe7"></a>

  716. <h2 class="memtitle"><span class="permalink"><a href="#a1e97a7aed860b898c403cb29455b3fe7">&#9670;&nbsp;</a></span>FatCache</h2>

  717. 

  718. <div class="memitem">

  719. <div class="memproto">

  720. <table class="mlabels">

  721.   <tr>

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

  723.       <table class="memname">

  724.         <tr>

  725.           <td class="memname">friend class <a class="el" href="class_fat_cache.html">FatCache</a></td>

  726.         </tr>

  727.       </table>

  728.   </td>

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

  730. <span class="mlabels"><span class="mlabel">friend</span></span>  </td>

  731.   </tr>

  732. </table>

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

  734. <p><a class="el" href="class_fat_cache.html" title="Sector cache.">FatCache</a> allowed access to private members. </p>

  735. 

  736. </div>

  737. </div>

  738. <a id="a18fb15a715ea85037ab802286853103e"></a>

  739. <h2 class="memtitle"><span class="permalink"><a href="#a18fb15a715ea85037ab802286853103e">&#9670;&nbsp;</a></span>FatFile</h2>

  740. 

  741. <div class="memitem">

  742. <div class="memproto">

  743. <table class="mlabels">

  744.   <tr>

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

  746.       <table class="memname">

  747.         <tr>

  748.           <td class="memname">friend class <a class="el" href="class_fat_file.html">FatFile</a></td>

  749.         </tr>

  750.       </table>

  751.   </td>

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

  753. <span class="mlabels"><span class="mlabel">friend</span></span>  </td>

  754.   </tr>

  755. </table>

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

  757. <p><a class="el" href="class_fat_file.html" title="Basic file class.">FatFile</a> allowed access to private members. </p>

  758. 

  759. </div>

  760. </div>

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

  762. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_partition_8h.html">FatPartition.h</a></li>

  763. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatPartition.cpp</li>

  764. </ul>

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

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

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

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

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

  770. </a> 1.8.16

  771. </small></address>

  772. </body>

  773. </html>