visus
/
teensy-sdfat
Obserwuj 1
Polub 0
Forkuj 0
Kod Zgłoszenia 0 Oczekujące zmiany 0 Wydania 0 Wiki Aktywność
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
50 Commity
1 Gałąź
Drzewo: 407591b05b
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z '407591b05b'
${ noResults }
teensy-sdfat/extras/html/class_fat_partition.html

773 lines
33KB
Czysty Wina Historia 

  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.14"/>

  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.14 -->

  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" id="node2" href="class_fat_volume.html" title="Integration class for the FatLib library. " alt="" coords="40,80,125,107"/>

  83. <area shape="rect" id="node3" href="class_sd_base.html" title="SdBase\&lt; FatVolume \&gt;" alt="" coords="5,155,160,181"/>

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

  85. </map>

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

  87. <table class="memberdecls">

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

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

  90. <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>

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

  92. <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>

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

  94. <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>

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

  96. <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>

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

  98. <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>

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

  100. <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>

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

  102. <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>

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

  104. <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>

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

  106. <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>

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

  108. <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>

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

  110. <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>

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

  112. <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>

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

  114. <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>

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

  116. <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>

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

  118. <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>

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

  120. <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>

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

  122. <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>

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

  124. <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>

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

  126. <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>

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

  128. <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>

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

  130. <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>

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

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

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

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

  135. <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>

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

  137. <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>

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

  139. </table>

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

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

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

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

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

  145. 

  146. <div class="memitem">

  147. <div class="memproto">

  148. <table class="mlabels">

  149.   <tr>

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

  151.       <table class="memname">

  152.         <tr>

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

  154.           <td>(</td>

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

  156.           <td></td>

  157.         </tr>

  158.       </table>

  159.   </td>

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

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

  162.   </tr>

  163. </table>

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

  165. <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>

  166. 

  167. </div>

  168. </div>

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

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

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

  172. 

  173. <div class="memitem">

  174. <div class="memproto">

  175. <table class="mlabels">

  176.   <tr>

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

  178.       <table class="memname">

  179.         <tr>

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

  181.           <td>(</td>

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

  183.           <td></td>

  184.         </tr>

  185.       </table>

  186.   </td>

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

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

  189.   </tr>

  190. </table>

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

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

  193. 

  194. </div>

  195. </div>

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

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

  198. 

  199. <div class="memitem">

  200. <div class="memproto">

  201. <table class="mlabels">

  202.   <tr>

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

  204.       <table class="memname">

  205.         <tr>

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

  207.           <td>(</td>

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

  209.           <td></td>

  210.         </tr>

  211.       </table>

  212.   </td>

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

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

  215.   </tr>

  216. </table>

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

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

  219. 

  220. </div>

  221. </div>

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

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

  224. 

  225. <div class="memitem">

  226. <div class="memproto">

  227. <table class="mlabels">

  228.   <tr>

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

  230.       <table class="memname">

  231.         <tr>

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

  233.           <td>(</td>

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

  235.           <td></td>

  236.         </tr>

  237.       </table>

  238.   </td>

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

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

  241.   </tr>

  242. </table>

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

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

  245. 

  246. </div>

  247. </div>

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

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

  250. 

  251. <div class="memitem">

  252. <div class="memproto">

  253. <table class="mlabels">

  254.   <tr>

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

  256.       <table class="memname">

  257.         <tr>

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

  259.           <td>(</td>

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

  261.           <td></td>

  262.         </tr>

  263.       </table>

  264.   </td>

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

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

  267.   </tr>

  268. </table>

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

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

  271. 

  272. </div>

  273. </div>

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

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

  276. 

  277. <div class="memitem">

  278. <div class="memproto">

  279. <table class="mlabels">

  280.   <tr>

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

  282.       <table class="memname">

  283.         <tr>

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

  285.           <td>(</td>

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

  287.           <td></td>

  288.         </tr>

  289.       </table>

  290.   </td>

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

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

  293.   </tr>

  294. </table>

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

  296. <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>

  297. 

  298. </div>

  299. </div>

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

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

  302. 

  303. <div class="memitem">

  304. <div class="memproto">

  305. <table class="mlabels">

  306.   <tr>

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

  308.       <table class="memname">

  309.         <tr>

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

  311.           <td>(</td>

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

  313.           <td> const</td>

  314.         </tr>

  315.       </table>

  316.   </td>

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

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

  319.   </tr>

  320. </table>

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

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

  323. 

  324. </div>

  325. </div>

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

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

  328. 

  329. <div class="memitem">

  330. <div class="memproto">

  331. <table class="mlabels">

  332.   <tr>

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

  334.       <table class="memname">

  335.         <tr>

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

  337.           <td>(</td>

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

  339.           <td> const</td>

  340.         </tr>

  341.       </table>

  342.   </td>

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

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

  345.   </tr>

  346. </table>

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

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

  349. 

  350. </div>

  351. </div>

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

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

  354. 

  355. <div class="memitem">

  356. <div class="memproto">

  357. <table class="mlabels">

  358.   <tr>

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

  360.       <table class="memname">

  361.         <tr>

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

  363.           <td>(</td>

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

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

  366.         </tr>

  367.         <tr>

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

  369.           <td></td>

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

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

  372.         </tr>

  373.         <tr>

  374.           <td></td>

  375.           <td>)</td>

  376.           <td></td><td></td>

  377.         </tr>

  378.       </table>

  379.   </td>

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

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

  382.   </tr>

  383. </table>

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

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

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

  387.   <table class="params">

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

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

  390.   </table>

  391.   </dd>

  392. </dl>

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

  394. 

  395. </div>

  396. </div>

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

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

  399. 

  400. <div class="memitem">

  401. <div class="memproto">

  402. <table class="mlabels">

  403.   <tr>

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

  405.       <table class="memname">

  406.         <tr>

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

  408.           <td>(</td>

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

  410.           <td></td>

  411.         </tr>

  412.       </table>

  413.   </td>

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

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

  416.   </tr>

  417. </table>

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

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

  420. 

  421. </div>

  422. </div>

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

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

  425. 

  426. <div class="memitem">

  427. <div class="memproto">

  428. <table class="mlabels">

  429.   <tr>

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

  431.       <table class="memname">

  432.         <tr>

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

  434.           <td>(</td>

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

  436.           <td> const</td>

  437.         </tr>

  438.       </table>

  439.   </td>

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

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

  442.   </tr>

  443. </table>

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

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

  446. 

  447. </div>

  448. </div>

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

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

  451. 

  452. <div class="memitem">

  453. <div class="memproto">

  454. <table class="mlabels">

  455.   <tr>

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

  457.       <table class="memname">

  458.         <tr>

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

  460.           <td>(</td>

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

  462.           <td> const</td>

  463.         </tr>

  464.       </table>

  465.   </td>

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

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

  468.   </tr>

  469. </table>

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

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

  472. 

  473. </div>

  474. </div>

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

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

  477. 

  478. <div class="memitem">

  479. <div class="memproto">

  480.       <table class="memname">

  481.         <tr>

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

  483.           <td>(</td>

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

  485.           <td></td>

  486.         </tr>

  487.       </table>

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

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

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

  491. 

  492. </div>

  493. </div>

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

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

  496. 

  497. <div class="memitem">

  498. <div class="memproto">

  499.       <table class="memname">

  500.         <tr>

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

  502.           <td>(</td>

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

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

  505.         </tr>

  506.         <tr>

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

  508.           <td></td>

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

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

  511.         </tr>

  512.         <tr>

  513.           <td></td>

  514.           <td>)</td>

  515.           <td></td><td></td>

  516.         </tr>

  517.       </table>

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

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

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

  521.   <table class="params">

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

  523.     <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>

  524.   </table>

  525.   </dd>

  526. </dl>

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

  528. 

  529. </div>

  530. </div>

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

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

  533. 

  534. <div class="memitem">

  535. <div class="memproto">

  536. <table class="mlabels">

  537.   <tr>

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

  539.       <table class="memname">

  540.         <tr>

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

  542.           <td>(</td>

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

  544.           <td> const</td>

  545.         </tr>

  546.       </table>

  547.   </td>

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

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

  550.   </tr>

  551. </table>

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

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

  554. 

  555. </div>

  556. </div>

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

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

  559. 

  560. <div class="memitem">

  561. <div class="memproto">

  562. <table class="mlabels">

  563.   <tr>

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

  565.       <table class="memname">

  566.         <tr>

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

  568.           <td>(</td>

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

  570.           <td> const</td>

  571.         </tr>

  572.       </table>

  573.   </td>

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

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

  576.   </tr>

  577. </table>

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

  579. <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>

  580. 

  581. </div>

  582. </div>

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

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

  585. 

  586. <div class="memitem">

  587. <div class="memproto">

  588. <table class="mlabels">

  589.   <tr>

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

  591.       <table class="memname">

  592.         <tr>

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

  594.           <td>(</td>

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

  596.           <td></td>

  597.         </tr>

  598.       </table>

  599.   </td>

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

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

  602.   </tr>

  603. </table>

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

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

  606. 

  607. </div>

  608. </div>

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

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

  611. 

  612. <div class="memitem">

  613. <div class="memproto">

  614. <table class="mlabels">

  615.   <tr>

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

  617.       <table class="memname">

  618.         <tr>

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

  620.           <td>(</td>

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

  622.           <td> const</td>

  623.         </tr>

  624.       </table>

  625.   </td>

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

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

  628.   </tr>

  629. </table>

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

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

  632. 

  633. </div>

  634. </div>

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

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

  637. 

  638. <div class="memitem">

  639. <div class="memproto">

  640. <table class="mlabels">

  641.   <tr>

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

  643.       <table class="memname">

  644.         <tr>

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

  646.           <td>(</td>

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

  648.           <td> const</td>

  649.         </tr>

  650.       </table>

  651.   </td>

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

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

  654.   </tr>

  655. </table>

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

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

  658. 

  659. </div>

  660. </div>

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

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

  663. 

  664. <div class="memitem">

  665. <div class="memproto">

  666. <table class="mlabels">

  667.   <tr>

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

  669.       <table class="memname">

  670.         <tr>

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

  672.           <td>(</td>

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

  674.           <td> const</td>

  675.         </tr>

  676.       </table>

  677.   </td>

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

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

  680.   </tr>

  681. </table>

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

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

  684. 

  685. </div>

  686. </div>

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

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

  689. 

  690. <div class="memitem">

  691. <div class="memproto">

  692. <table class="mlabels">

  693.   <tr>

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

  695.       <table class="memname">

  696.         <tr>

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

  698.           <td>(</td>

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

  700.           <td> const</td>

  701.         </tr>

  702.       </table>

  703.   </td>

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

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

  706.   </tr>

  707. </table>

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

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

  710. 

  711. </div>

  712. </div>

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

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

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

  716. 

  717. <div class="memitem">

  718. <div class="memproto">

  719. <table class="mlabels">

  720.   <tr>

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

  722.       <table class="memname">

  723.         <tr>

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

  725.         </tr>

  726.       </table>

  727.   </td>

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

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

  730.   </tr>

  731. </table>

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

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

  734. 

  735. </div>

  736. </div>

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

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

  739. 

  740. <div class="memitem">

  741. <div class="memproto">

  742. <table class="mlabels">

  743.   <tr>

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

  745.       <table class="memname">

  746.         <tr>

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

  748.         </tr>

  749.       </table>

  750.   </td>

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

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

  753.   </tr>

  754. </table>

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

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

  757. 

  758. </div>

  759. </div>

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

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

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

  763. </ul>

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

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

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

  767. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">

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

  769. </a> 1.8.14

  770. </small></address>

  771. </body>

  772. </html>