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.

773 satır
33KB

  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. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#friends">Friends</a> &#124;
  65. <a href="class_fat_partition-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">FatPartition Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Access FAT16 and FAT32 partitions on raw file devices.
  71. <a href="class_fat_partition.html#details">More...</a></p>
  72. <p><code>#include &lt;FatPartition.h&gt;</code></p>
  73. <div class="dynheader">
  74. Inheritance diagram for FatPartition:</div>
  75. <div class="dyncontent">
  76. <div class="center"><img src="class_fat_partition__inherit__graph.png" border="0" usemap="#_fat_partition_inherit__map" alt="Inheritance graph"/></div>
  77. <map name="_fat_partition_inherit__map" id="_fat_partition_inherit__map">
  78. <area shape="rect" id="node2" href="class_fat_volume.html" title="Integration class for the FatLib library. " alt="" coords="40,80,125,107"/>
  79. <area shape="rect" id="node3" href="class_sd_base.html" title="SdBase\&lt; FatVolume \&gt;" alt="" coords="5,155,160,181"/>
  80. <area shape="rect" id="node4" href="class_sd_fat32.html" title="SD file system class for FAT volumes. " alt="" coords="47,229,118,256"/>
  81. </map>
  82. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  85. Public Member Functions</h2></td></tr>
  86. <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>
  87. <tr class="separator:a1c3ab374b425c27bb6b6ddd55752c056"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <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>
  89. <tr class="separator:aaf43a09e71689c257f4b189ee307db4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <tr class="separator:a1eba03c763bab44263735488435731f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <tr class="separator:a4e513ab3fcfb95583092793116aa4df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <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>
  95. <tr class="separator:abf74c1e3c714b396e6271aee304c2448"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <tr class="separator:aba35645c23735c4833c07bc2b3adcd1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:a7e89ec91780f7dfa060b261c605bf2e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:a0af1e91a311180119b4a2c85d7e6e87e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="separator:a56b37c3230818b9ae8e0a25c01a370a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <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>
  105. <tr class="separator:a2c94db084d89355da7695d82ee612f72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <tr class="separator:a6a1ce7d707cf15bea08b63216413e055"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <tr class="separator:ad45c276232d7093b82f1075e8c488bac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:ac9689f1e11f59acc5f1b21ed9bb71174"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <tr class="separator:ab827224f30eec57255d21cae589911ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="separator:a6ba99b9711269b5ab6ca091b88e81288"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <tr class="separator:a5d005e0f6fd4b84da8a5ebdea03aaf85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="separator:a6b970fa2e06de1a826b09e251dc3119b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <tr class="separator:a836546c368e6ffe117e6ab8775d23eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <tr class="separator:a593a27482ff8d993542d6f82bd92e26c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:a1f5c7599333dbe152a3cdd60623ce6d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:a916ba7d67711bb62daf12ecd47ca4b8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table><table class="memberdecls">
  129. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  130. Friends</h2></td></tr>
  131. <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>
  132. <tr class="separator:a1e97a7aed860b898c403cb29455b3fe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:a18fb15a715ea85037ab802286853103e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table>
  136. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  137. <div class="textblock"><p>Access FAT16 and FAT32 partitions on raw file devices. </p>
  138. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  139. <a id="a2c94db084d89355da7695d82ee612f72"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#a2c94db084d89355da7695d82ee612f72">&#9670;&nbsp;</a></span>FatPartition()</h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="mlabels">
  144. <tr>
  145. <td class="mlabels-left">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">FatPartition::FatPartition </td>
  149. <td>(</td>
  150. <td class="paramname"></td><td>)</td>
  151. <td></td>
  152. </tr>
  153. </table>
  154. </td>
  155. <td class="mlabels-right">
  156. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. <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>
  161. </div>
  162. </div>
  163. <h2 class="groupheader">Member Function Documentation</h2>
  164. <a id="a1c3ab374b425c27bb6b6ddd55752c056"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#a1c3ab374b425c27bb6b6ddd55752c056">&#9670;&nbsp;</a></span>bytesPerCluster()</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="mlabels">
  169. <tr>
  170. <td class="mlabels-left">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">uint16_t FatPartition::bytesPerCluster </td>
  174. <td>(</td>
  175. <td class="paramname"></td><td>)</td>
  176. <td></td>
  177. </tr>
  178. </table>
  179. </td>
  180. <td class="mlabels-right">
  181. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <dl class="section return"><dt>Returns</dt><dd>Number of bytes in a cluster. </dd></dl>
  186. </div>
  187. </div>
  188. <a id="aaf43a09e71689c257f4b189ee307db4f"></a>
  189. <h2 class="memtitle"><span class="permalink"><a href="#aaf43a09e71689c257f4b189ee307db4f">&#9670;&nbsp;</a></span>bytesPerClusterShift()</h2>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="mlabels">
  193. <tr>
  194. <td class="mlabels-left">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">uint8_t FatPartition::bytesPerClusterShift </td>
  198. <td>(</td>
  199. <td class="paramname"></td><td>)</td>
  200. <td></td>
  201. </tr>
  202. </table>
  203. </td>
  204. <td class="mlabels-right">
  205. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>
  210. </div>
  211. </div>
  212. <a id="a1eba03c763bab44263735488435731f8"></a>
  213. <h2 class="memtitle"><span class="permalink"><a href="#a1eba03c763bab44263735488435731f8">&#9670;&nbsp;</a></span>bytesPerSector()</h2>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="mlabels">
  217. <tr>
  218. <td class="mlabels-left">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">uint16_t FatPartition::bytesPerSector </td>
  222. <td>(</td>
  223. <td class="paramname"></td><td>)</td>
  224. <td></td>
  225. </tr>
  226. </table>
  227. </td>
  228. <td class="mlabels-right">
  229. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <dl class="section return"><dt>Returns</dt><dd>Number of bytes per sector. </dd></dl>
  234. </div>
  235. </div>
  236. <a id="a4e513ab3fcfb95583092793116aa4df5"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#a4e513ab3fcfb95583092793116aa4df5">&#9670;&nbsp;</a></span>bytesPerSectorShift()</h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="mlabels">
  241. <tr>
  242. <td class="mlabels-left">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">uint8_t FatPartition::bytesPerSectorShift </td>
  246. <td>(</td>
  247. <td class="paramname"></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by bytesPerCluster. </dd></dl>
  258. </div>
  259. </div>
  260. <a id="abf74c1e3c714b396e6271aee304c2448"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#abf74c1e3c714b396e6271aee304c2448">&#9670;&nbsp;</a></span>cacheClear()</h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="mlabels">
  265. <tr>
  266. <td class="mlabels-left">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatPartition::cacheClear </td>
  270. <td>(</td>
  271. <td class="paramname"></td><td>)</td>
  272. <td></td>
  273. </tr>
  274. </table>
  275. </td>
  276. <td class="mlabels-right">
  277. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <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>
  282. </div>
  283. </div>
  284. <a id="aba35645c23735c4833c07bc2b3adcd1f"></a>
  285. <h2 class="memtitle"><span class="permalink"><a href="#aba35645c23735c4833c07bc2b3adcd1f">&#9670;&nbsp;</a></span>clusterCount()</h2>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="mlabels">
  289. <tr>
  290. <td class="mlabels-left">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">uint32_t FatPartition::clusterCount </td>
  294. <td>(</td>
  295. <td class="paramname"></td><td>)</td>
  296. <td> const</td>
  297. </tr>
  298. </table>
  299. </td>
  300. <td class="mlabels-right">
  301. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  306. </div>
  307. </div>
  308. <a id="a7e89ec91780f7dfa060b261c605bf2e5"></a>
  309. <h2 class="memtitle"><span class="permalink"><a href="#a7e89ec91780f7dfa060b261c605bf2e5">&#9670;&nbsp;</a></span>dataStartSector()</h2>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="mlabels">
  313. <tr>
  314. <td class="mlabels-left">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">uint32_t FatPartition::dataStartSector </td>
  318. <td>(</td>
  319. <td class="paramname"></td><td>)</td>
  320. <td> const</td>
  321. </tr>
  322. </table>
  323. </td>
  324. <td class="mlabels-right">
  325. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. <dl class="section return"><dt>Returns</dt><dd>The logical sector number for the start of file data. </dd></dl>
  330. </div>
  331. </div>
  332. <a id="a0af1e91a311180119b4a2c85d7e6e87e"></a>
  333. <h2 class="memtitle"><span class="permalink"><a href="#a0af1e91a311180119b4a2c85d7e6e87e">&#9670;&nbsp;</a></span>dbgFat()</h2>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="mlabels">
  337. <tr>
  338. <td class="mlabels-left">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname">int8_t FatPartition::dbgFat </td>
  342. <td>(</td>
  343. <td class="paramtype">uint32_t&#160;</td>
  344. <td class="paramname"><em>n</em>, </td>
  345. </tr>
  346. <tr>
  347. <td class="paramkey"></td>
  348. <td></td>
  349. <td class="paramtype">uint32_t *&#160;</td>
  350. <td class="paramname"><em>v</em>&#160;</td>
  351. </tr>
  352. <tr>
  353. <td></td>
  354. <td>)</td>
  355. <td></td><td></td>
  356. </tr>
  357. </table>
  358. </td>
  359. <td class="mlabels-right">
  360. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  361. </tr>
  362. </table>
  363. </div><div class="memdoc">
  364. <p>Debug access to FAT table</p>
  365. <dl class="params"><dt>Parameters</dt><dd>
  366. <table class="params">
  367. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  368. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  369. </table>
  370. </dd>
  371. </dl>
  372. <dl class="section return"><dt>Returns</dt><dd>-1 error, 0 EOC, else 1. </dd></dl>
  373. </div>
  374. </div>
  375. <a id="a56b37c3230818b9ae8e0a25c01a370a3"></a>
  376. <h2 class="memtitle"><span class="permalink"><a href="#a56b37c3230818b9ae8e0a25c01a370a3">&#9670;&nbsp;</a></span>fatCount()</h2>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="mlabels">
  380. <tr>
  381. <td class="mlabels-left">
  382. <table class="memname">
  383. <tr>
  384. <td class="memname">uint8_t FatPartition::fatCount </td>
  385. <td>(</td>
  386. <td class="paramname"></td><td>)</td>
  387. <td></td>
  388. </tr>
  389. </table>
  390. </td>
  391. <td class="mlabels-right">
  392. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <dl class="section return"><dt>Returns</dt><dd>The number of File Allocation Tables. </dd></dl>
  397. </div>
  398. </div>
  399. <a id="a6a1ce7d707cf15bea08b63216413e055"></a>
  400. <h2 class="memtitle"><span class="permalink"><a href="#a6a1ce7d707cf15bea08b63216413e055">&#9670;&nbsp;</a></span>fatStartSector()</h2>
  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">uint32_t FatPartition::fatStartSector </td>
  409. <td>(</td>
  410. <td class="paramname"></td><td>)</td>
  411. <td> const</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 logical sector number for the start of the first FAT. </dd></dl>
  421. </div>
  422. </div>
  423. <a id="ad45c276232d7093b82f1075e8c488bac"></a>
  424. <h2 class="memtitle"><span class="permalink"><a href="#ad45c276232d7093b82f1075e8c488bac">&#9670;&nbsp;</a></span>fatType()</h2>
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="mlabels">
  428. <tr>
  429. <td class="mlabels-left">
  430. <table class="memname">
  431. <tr>
  432. <td class="memname">uint8_t FatPartition::fatType </td>
  433. <td>(</td>
  434. <td class="paramname"></td><td>)</td>
  435. <td> const</td>
  436. </tr>
  437. </table>
  438. </td>
  439. <td class="mlabels-right">
  440. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  441. </tr>
  442. </table>
  443. </div><div class="memdoc">
  444. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  445. </div>
  446. </div>
  447. <a id="ac9689f1e11f59acc5f1b21ed9bb71174"></a>
  448. <h2 class="memtitle"><span class="permalink"><a href="#ac9689f1e11f59acc5f1b21ed9bb71174">&#9670;&nbsp;</a></span>freeClusterCount()</h2>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">int32_t FatPartition::freeClusterCount </td>
  454. <td>(</td>
  455. <td class="paramname"></td><td>)</td>
  456. <td></td>
  457. </tr>
  458. </table>
  459. </div><div class="memdoc">
  460. <p>Volume free space in clusters.</p>
  461. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  462. </div>
  463. </div>
  464. <a id="ab827224f30eec57255d21cae589911ef"></a>
  465. <h2 class="memtitle"><span class="permalink"><a href="#ab827224f30eec57255d21cae589911ef">&#9670;&nbsp;</a></span>init()</h2>
  466. <div class="memitem">
  467. <div class="memproto">
  468. <table class="memname">
  469. <tr>
  470. <td class="memname">bool FatPartition::init </td>
  471. <td>(</td>
  472. <td class="paramtype"><a class="el" href="class_sd_spi_card.html">BlockDevice</a> *&#160;</td>
  473. <td class="paramname"><em>dev</em>, </td>
  474. </tr>
  475. <tr>
  476. <td class="paramkey"></td>
  477. <td></td>
  478. <td class="paramtype">uint8_t&#160;</td>
  479. <td class="paramname"><em>part</em> = <code>1</code>&#160;</td>
  480. </tr>
  481. <tr>
  482. <td></td>
  483. <td>)</td>
  484. <td></td><td></td>
  485. </tr>
  486. </table>
  487. </div><div class="memdoc">
  488. <p>Initialize a FAT partition.</p>
  489. <dl class="params"><dt>Parameters</dt><dd>
  490. <table class="params">
  491. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>BlockDevice for this partition. </td></tr>
  492. <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>
  493. </table>
  494. </dd>
  495. </dl>
  496. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure. </dd></dl>
  497. </div>
  498. </div>
  499. <a id="a6ba99b9711269b5ab6ca091b88e81288"></a>
  500. <h2 class="memtitle"><span class="permalink"><a href="#a6ba99b9711269b5ab6ca091b88e81288">&#9670;&nbsp;</a></span>rootDirEntryCount()</h2>
  501. <div class="memitem">
  502. <div class="memproto">
  503. <table class="mlabels">
  504. <tr>
  505. <td class="mlabels-left">
  506. <table class="memname">
  507. <tr>
  508. <td class="memname">uint16_t FatPartition::rootDirEntryCount </td>
  509. <td>(</td>
  510. <td class="paramname"></td><td>)</td>
  511. <td> const</td>
  512. </tr>
  513. </table>
  514. </td>
  515. <td class="mlabels-right">
  516. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  517. </tr>
  518. </table>
  519. </div><div class="memdoc">
  520. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  521. </div>
  522. </div>
  523. <a id="a5d005e0f6fd4b84da8a5ebdea03aaf85"></a>
  524. <h2 class="memtitle"><span class="permalink"><a href="#a5d005e0f6fd4b84da8a5ebdea03aaf85">&#9670;&nbsp;</a></span>rootDirStart()</h2>
  525. <div class="memitem">
  526. <div class="memproto">
  527. <table class="mlabels">
  528. <tr>
  529. <td class="mlabels-left">
  530. <table class="memname">
  531. <tr>
  532. <td class="memname">uint32_t FatPartition::rootDirStart </td>
  533. <td>(</td>
  534. <td class="paramname"></td><td>)</td>
  535. <td> const</td>
  536. </tr>
  537. </table>
  538. </td>
  539. <td class="mlabels-right">
  540. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  541. </tr>
  542. </table>
  543. </div><div class="memdoc">
  544. <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>
  545. </div>
  546. </div>
  547. <a id="a6b970fa2e06de1a826b09e251dc3119b"></a>
  548. <h2 class="memtitle"><span class="permalink"><a href="#a6b970fa2e06de1a826b09e251dc3119b">&#9670;&nbsp;</a></span>sectorMask()</h2>
  549. <div class="memitem">
  550. <div class="memproto">
  551. <table class="mlabels">
  552. <tr>
  553. <td class="mlabels-left">
  554. <table class="memname">
  555. <tr>
  556. <td class="memname">uint16_t FatPartition::sectorMask </td>
  557. <td>(</td>
  558. <td class="paramname"></td><td>)</td>
  559. <td></td>
  560. </tr>
  561. </table>
  562. </td>
  563. <td class="mlabels-right">
  564. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  565. </tr>
  566. </table>
  567. </div><div class="memdoc">
  568. <dl class="section return"><dt>Returns</dt><dd>Mask for sector offset. </dd></dl>
  569. </div>
  570. </div>
  571. <a id="a836546c368e6ffe117e6ab8775d23eba"></a>
  572. <h2 class="memtitle"><span class="permalink"><a href="#a836546c368e6ffe117e6ab8775d23eba">&#9670;&nbsp;</a></span>sectorsPerCluster()</h2>
  573. <div class="memitem">
  574. <div class="memproto">
  575. <table class="mlabels">
  576. <tr>
  577. <td class="mlabels-left">
  578. <table class="memname">
  579. <tr>
  580. <td class="memname">uint8_t FatPartition::sectorsPerCluster </td>
  581. <td>(</td>
  582. <td class="paramname"></td><td>)</td>
  583. <td> const</td>
  584. </tr>
  585. </table>
  586. </td>
  587. <td class="mlabels-right">
  588. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  589. </tr>
  590. </table>
  591. </div><div class="memdoc">
  592. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in sectors. </dd></dl>
  593. </div>
  594. </div>
  595. <a id="a593a27482ff8d993542d6f82bd92e26c"></a>
  596. <h2 class="memtitle"><span class="permalink"><a href="#a593a27482ff8d993542d6f82bd92e26c">&#9670;&nbsp;</a></span>sectorsPerClusterShift()</h2>
  597. <div class="memitem">
  598. <div class="memproto">
  599. <table class="mlabels">
  600. <tr>
  601. <td class="mlabels-left">
  602. <table class="memname">
  603. <tr>
  604. <td class="memname">uint8_t FatPartition::sectorsPerClusterShift </td>
  605. <td>(</td>
  606. <td class="paramname"></td><td>)</td>
  607. <td> const</td>
  608. </tr>
  609. </table>
  610. </td>
  611. <td class="mlabels-right">
  612. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  613. </tr>
  614. </table>
  615. </div><div class="memdoc">
  616. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by sectorsPerCluster. </dd></dl>
  617. </div>
  618. </div>
  619. <a id="a1f5c7599333dbe152a3cdd60623ce6d1"></a>
  620. <h2 class="memtitle"><span class="permalink"><a href="#a1f5c7599333dbe152a3cdd60623ce6d1">&#9670;&nbsp;</a></span>sectorsPerFat()</h2>
  621. <div class="memitem">
  622. <div class="memproto">
  623. <table class="mlabels">
  624. <tr>
  625. <td class="mlabels-left">
  626. <table class="memname">
  627. <tr>
  628. <td class="memname">uint32_t FatPartition::sectorsPerFat </td>
  629. <td>(</td>
  630. <td class="paramname"></td><td>)</td>
  631. <td> const</td>
  632. </tr>
  633. </table>
  634. </td>
  635. <td class="mlabels-right">
  636. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  637. </tr>
  638. </table>
  639. </div><div class="memdoc">
  640. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in one FAT. </dd></dl>
  641. </div>
  642. </div>
  643. <a id="a916ba7d67711bb62daf12ecd47ca4b8e"></a>
  644. <h2 class="memtitle"><span class="permalink"><a href="#a916ba7d67711bb62daf12ecd47ca4b8e">&#9670;&nbsp;</a></span>volumeSectorCount()</h2>
  645. <div class="memitem">
  646. <div class="memproto">
  647. <table class="mlabels">
  648. <tr>
  649. <td class="mlabels-left">
  650. <table class="memname">
  651. <tr>
  652. <td class="memname">uint32_t FatPartition::volumeSectorCount </td>
  653. <td>(</td>
  654. <td class="paramname"></td><td>)</td>
  655. <td> const</td>
  656. </tr>
  657. </table>
  658. </td>
  659. <td class="mlabels-right">
  660. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  661. </tr>
  662. </table>
  663. </div><div class="memdoc">
  664. <dl class="section return"><dt>Returns</dt><dd>The number of sectors in the volume </dd></dl>
  665. </div>
  666. </div>
  667. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  668. <a id="a1e97a7aed860b898c403cb29455b3fe7"></a>
  669. <h2 class="memtitle"><span class="permalink"><a href="#a1e97a7aed860b898c403cb29455b3fe7">&#9670;&nbsp;</a></span>FatCache</h2>
  670. <div class="memitem">
  671. <div class="memproto">
  672. <table class="mlabels">
  673. <tr>
  674. <td class="mlabels-left">
  675. <table class="memname">
  676. <tr>
  677. <td class="memname">friend class <a class="el" href="class_fat_cache.html">FatCache</a></td>
  678. </tr>
  679. </table>
  680. </td>
  681. <td class="mlabels-right">
  682. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  683. </tr>
  684. </table>
  685. </div><div class="memdoc">
  686. <p><a class="el" href="class_fat_cache.html" title="Sector cache. ">FatCache</a> allowed access to private members. </p>
  687. </div>
  688. </div>
  689. <a id="a18fb15a715ea85037ab802286853103e"></a>
  690. <h2 class="memtitle"><span class="permalink"><a href="#a18fb15a715ea85037ab802286853103e">&#9670;&nbsp;</a></span>FatFile</h2>
  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">friend class <a class="el" href="class_fat_file.html">FatFile</a></td>
  699. </tr>
  700. </table>
  701. </td>
  702. <td class="mlabels-right">
  703. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  704. </tr>
  705. </table>
  706. </div><div class="memdoc">
  707. <p><a class="el" href="class_fat_file.html" title="Basic file class. ">FatFile</a> allowed access to private members. </p>
  708. </div>
  709. </div>
  710. <hr/>The documentation for this class was generated from the following files:<ul>
  711. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/<a class="el" href="_fat_partition_8h.html">FatPartition.h</a></li>
  712. <li>ArduinoSdFat/libraries/SdFat/src/FatLib/FatPartition.cpp</li>
  713. </ul>
  714. </div><!-- contents -->
  715. <!-- start footer part -->
  716. <hr class="footer"/><address class="footer"><small>
  717. Generated on Thu May 9 2019 06:51:28 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  718. <img class="footer" src="doxygen.png" alt="doxygen"/>
  719. </a> 1.8.14
  720. </small></address>
  721. </body>
  722. </html>