Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

class_sd_volume.html 25KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580
  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.6"/>
  7. <title>SdFat: SdVolume Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">SdFat
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.6 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  33. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  40. <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  41. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  42. </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="summary">
  47. <a href="#pub-methods">Public Member Functions</a> &#124;
  48. <a href="#friends">Friends</a> &#124;
  49. <a href="class_sd_volume-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">SdVolume Class Reference</div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>Access FAT16 and FAT32 volumes on SD and SDHC cards.
  55. <a href="class_sd_volume.html#details">More...</a></p>
  56. <p><code>#include &lt;SdVolume.h&gt;</code></p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:affab4c57c98e41ee55b21c87f814804b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#affab4c57c98e41ee55b21c87f814804b">blocksPerCluster</a> () const </td></tr>
  61. <tr class="separator:affab4c57c98e41ee55b21c87f814804b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a87ed6542db9642ffa106def897a368c6"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a87ed6542db9642ffa106def897a368c6">blocksPerFat</a> () const </td></tr>
  63. <tr class="separator:a87ed6542db9642ffa106def897a368c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:adaecef65fdf94d323597a461eb641f5e"><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_sd_volume.html#adaecef65fdf94d323597a461eb641f5e">cacheClear</a> ()</td></tr>
  65. <tr class="separator:adaecef65fdf94d323597a461eb641f5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a323adfb5ac395b769f30c31ce2618f22"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a323adfb5ac395b769f30c31ce2618f22">clusterCount</a> () const </td></tr>
  67. <tr class="separator:a323adfb5ac395b769f30c31ce2618f22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a50c8e198feb63b0ca26737f91bd3e139"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a50c8e198feb63b0ca26737f91bd3e139">clusterSizeShift</a> () const </td></tr>
  69. <tr class="separator:a50c8e198feb63b0ca26737f91bd3e139"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a99ca71035785948c42ade0863f91c9ab"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a99ca71035785948c42ade0863f91c9ab">dataStartBlock</a> () const </td></tr>
  71. <tr class="separator:a99ca71035785948c42ade0863f91c9ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a4dbcb7b34a83468b1c6f8c4556393526"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a4dbcb7b34a83468b1c6f8c4556393526">dbgFat</a> (uint32_t n, uint32_t *v)</td></tr>
  73. <tr class="separator:a4dbcb7b34a83468b1c6f8c4556393526"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a5d4307584ef14e4a2fef85b4954b1aa2"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a5d4307584ef14e4a2fef85b4954b1aa2">fatCount</a> () const </td></tr>
  75. <tr class="separator:a5d4307584ef14e4a2fef85b4954b1aa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a9032ec5d3323ee67477c6bbf39821415"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a9032ec5d3323ee67477c6bbf39821415">fatStartBlock</a> () const </td></tr>
  77. <tr class="separator:a9032ec5d3323ee67477c6bbf39821415"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a3f7b12db1e9ec4b847cd41fbe46b7baf"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a3f7b12db1e9ec4b847cd41fbe46b7baf">fatType</a> () const </td></tr>
  79. <tr class="separator:a3f7b12db1e9ec4b847cd41fbe46b7baf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a162efe707ab46847202300cb38739629"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a162efe707ab46847202300cb38739629">freeClusterCount</a> ()</td></tr>
  81. <tr class="separator:a162efe707ab46847202300cb38739629"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a0ac221eda119ddccae8ac6bc20a4b12d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a0ac221eda119ddccae8ac6bc20a4b12d">init</a> (<a class="el" href="class_sd2_card.html">Sd2Card</a> *dev)</td></tr>
  83. <tr class="separator:a0ac221eda119ddccae8ac6bc20a4b12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ae820ee8d9ea7ed01ce72ae3508a63cbf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#ae820ee8d9ea7ed01ce72ae3508a63cbf">init</a> (<a class="el" href="class_sd2_card.html">Sd2Card</a> *dev, uint8_t part)</td></tr>
  85. <tr class="separator:ae820ee8d9ea7ed01ce72ae3508a63cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a8573884a8056ab7c4c0d6e442f676cc4"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a8573884a8056ab7c4c0d6e442f676cc4">rootDirEntryCount</a> () const </td></tr>
  87. <tr class="separator:a8573884a8056ab7c4c0d6e442f676cc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:aa1479f90c53bc9eac379664c5233d399"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#aa1479f90c53bc9eac379664c5233d399">rootDirStart</a> () const </td></tr>
  89. <tr class="separator:aa1479f90c53bc9eac379664c5233d399"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:afe76a9f7c181458995518dc8530a1fad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#afe76a9f7c181458995518dc8530a1fad">sdCard</a> ()</td></tr>
  91. <tr class="separator:afe76a9f7c181458995518dc8530a1fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a30d4489087fbdce20b8fe1a624dbe658"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a30d4489087fbdce20b8fe1a624dbe658">SdVolume</a> ()</td></tr>
  93. <tr class="separator:a30d4489087fbdce20b8fe1a624dbe658"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table><table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  96. Friends</h2></td></tr>
  97. <tr class="memitem:a05e466c179d34fec11c4406677fe0533"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sd_volume.html#a05e466c179d34fec11c4406677fe0533">SdBaseFile</a></td></tr>
  98. <tr class="separator:a05e466c179d34fec11c4406677fe0533"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <div class="textblock"><p>Access FAT16 and FAT32 volumes on SD and SDHC cards. </p>
  102. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  103. <a class="anchor" id="a30d4489087fbdce20b8fe1a624dbe658"></a>
  104. <div class="memitem">
  105. <div class="memproto">
  106. <table class="mlabels">
  107. <tr>
  108. <td class="mlabels-left">
  109. <table class="memname">
  110. <tr>
  111. <td class="memname">SdVolume::SdVolume </td>
  112. <td>(</td>
  113. <td class="paramname"></td><td>)</td>
  114. <td></td>
  115. </tr>
  116. </table>
  117. </td>
  118. <td class="mlabels-right">
  119. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>Create an instance of <a class="el" href="class_sd_volume.html" title="Access FAT16 and FAT32 volumes on SD and SDHC cards. ">SdVolume</a> </p>
  124. </div>
  125. </div>
  126. <h2 class="groupheader">Member Function Documentation</h2>
  127. <a class="anchor" id="affab4c57c98e41ee55b21c87f814804b"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="mlabels">
  131. <tr>
  132. <td class="mlabels-left">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">uint8_t SdVolume::blocksPerCluster </td>
  136. <td>(</td>
  137. <td class="paramname"></td><td>)</td>
  138. <td> const</td>
  139. </tr>
  140. </table>
  141. </td>
  142. <td class="mlabels-right">
  143. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <dl class="section return"><dt>Returns</dt><dd>The volume's cluster size in blocks. </dd></dl>
  148. </div>
  149. </div>
  150. <a class="anchor" id="a87ed6542db9642ffa106def897a368c6"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="mlabels">
  154. <tr>
  155. <td class="mlabels-left">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">uint32_t SdVolume::blocksPerFat </td>
  159. <td>(</td>
  160. <td class="paramname"></td><td>)</td>
  161. <td> const</td>
  162. </tr>
  163. </table>
  164. </td>
  165. <td class="mlabels-right">
  166. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <dl class="section return"><dt>Returns</dt><dd>The number of blocks in one FAT. </dd></dl>
  171. </div>
  172. </div>
  173. <a class="anchor" id="adaecef65fdf94d323597a461eb641f5e"></a>
  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"><a class="el" href="unioncache__t.html">cache_t</a>* SdVolume::cacheClear </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. <p>Clear the cache and returns a pointer to the cache. Used by the WaveRP recorder to do raw write to the SD card. Not for normal apps. </p>
  194. <dl class="section return"><dt>Returns</dt><dd>A pointer to the cache buffer or zero if an error occurs. </dd></dl>
  195. </div>
  196. </div>
  197. <a class="anchor" id="a323adfb5ac395b769f30c31ce2618f22"></a>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="mlabels">
  201. <tr>
  202. <td class="mlabels-left">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">uint32_t SdVolume::clusterCount </td>
  206. <td>(</td>
  207. <td class="paramname"></td><td>)</td>
  208. <td> const</td>
  209. </tr>
  210. </table>
  211. </td>
  212. <td class="mlabels-right">
  213. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <dl class="section return"><dt>Returns</dt><dd>The total number of clusters in the volume. </dd></dl>
  218. </div>
  219. </div>
  220. <a class="anchor" id="a50c8e198feb63b0ca26737f91bd3e139"></a>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">uint8_t SdVolume::clusterSizeShift </td>
  229. <td>(</td>
  230. <td class="paramname"></td><td>)</td>
  231. <td> const</td>
  232. </tr>
  233. </table>
  234. </td>
  235. <td class="mlabels-right">
  236. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <dl class="section return"><dt>Returns</dt><dd>The shift count required to multiply by blocksPerCluster. </dd></dl>
  241. </div>
  242. </div>
  243. <a class="anchor" id="a99ca71035785948c42ade0863f91c9ab"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="mlabels">
  247. <tr>
  248. <td class="mlabels-left">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">uint32_t SdVolume::dataStartBlock </td>
  252. <td>(</td>
  253. <td class="paramname"></td><td>)</td>
  254. <td> const</td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of file data. </dd></dl>
  264. </div>
  265. </div>
  266. <a class="anchor" id="a4dbcb7b34a83468b1c6f8c4556393526"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <table class="mlabels">
  270. <tr>
  271. <td class="mlabels-left">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">bool SdVolume::dbgFat </td>
  275. <td>(</td>
  276. <td class="paramtype">uint32_t&#160;</td>
  277. <td class="paramname"><em>n</em>, </td>
  278. </tr>
  279. <tr>
  280. <td class="paramkey"></td>
  281. <td></td>
  282. <td class="paramtype">uint32_t *&#160;</td>
  283. <td class="paramname"><em>v</em>&#160;</td>
  284. </tr>
  285. <tr>
  286. <td></td>
  287. <td>)</td>
  288. <td></td><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>Debug access to FAT table</p>
  298. <dl class="params"><dt>Parameters</dt><dd>
  299. <table class="params">
  300. <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>cluster number. </td></tr>
  301. <tr><td class="paramdir">[out]</td><td class="paramname">v</td><td>value of entry </td></tr>
  302. </table>
  303. </dd>
  304. </dl>
  305. <dl class="section return"><dt>Returns</dt><dd>true for success or false for failure </dd></dl>
  306. </div>
  307. </div>
  308. <a class="anchor" id="a5d4307584ef14e4a2fef85b4954b1aa2"></a>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="mlabels">
  312. <tr>
  313. <td class="mlabels-left">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">uint8_t SdVolume::fatCount </td>
  317. <td>(</td>
  318. <td class="paramname"></td><td>)</td>
  319. <td> const</td>
  320. </tr>
  321. </table>
  322. </td>
  323. <td class="mlabels-right">
  324. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <dl class="section return"><dt>Returns</dt><dd>The number of FAT structures on the volume. </dd></dl>
  329. </div>
  330. </div>
  331. <a class="anchor" id="a9032ec5d3323ee67477c6bbf39821415"></a>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="mlabels">
  335. <tr>
  336. <td class="mlabels-left">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">uint32_t SdVolume::fatStartBlock </td>
  340. <td>(</td>
  341. <td class="paramname"></td><td>)</td>
  342. <td> const</td>
  343. </tr>
  344. </table>
  345. </td>
  346. <td class="mlabels-right">
  347. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the first FAT. </dd></dl>
  352. </div>
  353. </div>
  354. <a class="anchor" id="a3f7b12db1e9ec4b847cd41fbe46b7baf"></a>
  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">uint8_t SdVolume::fatType </td>
  363. <td>(</td>
  364. <td class="paramname"></td><td>)</td>
  365. <td> const</td>
  366. </tr>
  367. </table>
  368. </td>
  369. <td class="mlabels-right">
  370. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. <dl class="section return"><dt>Returns</dt><dd>The FAT type of the volume. Values are 12, 16 or 32. </dd></dl>
  375. </div>
  376. </div>
  377. <a class="anchor" id="a162efe707ab46847202300cb38739629"></a>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">int32_t SdVolume::freeClusterCount </td>
  383. <td>(</td>
  384. <td class="paramname"></td><td>)</td>
  385. <td></td>
  386. </tr>
  387. </table>
  388. </div><div class="memdoc">
  389. <p>Volume free space in clusters.</p>
  390. <dl class="section return"><dt>Returns</dt><dd>Count of free clusters for success or -1 if an error occurs. </dd></dl>
  391. </div>
  392. </div>
  393. <a class="anchor" id="a0ac221eda119ddccae8ac6bc20a4b12d"></a>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="mlabels">
  397. <tr>
  398. <td class="mlabels-left">
  399. <table class="memname">
  400. <tr>
  401. <td class="memname">bool SdVolume::init </td>
  402. <td>(</td>
  403. <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>
  404. <td class="paramname"><em>dev</em></td><td>)</td>
  405. <td></td>
  406. </tr>
  407. </table>
  408. </td>
  409. <td class="mlabels-right">
  410. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. <p>Initialize a FAT volume. Try partition one first then try super floppy format.</p>
  415. <dl class="params"><dt>Parameters</dt><dd>
  416. <table class="params">
  417. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The <a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC flash memory cards. ">Sd2Card</a> where the volume is located.</td></tr>
  418. </table>
  419. </dd>
  420. </dl>
  421. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include not finding a valid partition, not finding a valid FAT file system or an I/O error. </dd></dl>
  422. </div>
  423. </div>
  424. <a class="anchor" id="ae820ee8d9ea7ed01ce72ae3508a63cbf"></a>
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">bool SdVolume::init </td>
  430. <td>(</td>
  431. <td class="paramtype"><a class="el" href="class_sd2_card.html">Sd2Card</a> *&#160;</td>
  432. <td class="paramname"><em>dev</em>, </td>
  433. </tr>
  434. <tr>
  435. <td class="paramkey"></td>
  436. <td></td>
  437. <td class="paramtype">uint8_t&#160;</td>
  438. <td class="paramname"><em>part</em>&#160;</td>
  439. </tr>
  440. <tr>
  441. <td></td>
  442. <td>)</td>
  443. <td></td><td></td>
  444. </tr>
  445. </table>
  446. </div><div class="memdoc">
  447. <p>Initialize a FAT volume.</p>
  448. <dl class="params"><dt>Parameters</dt><dd>
  449. <table class="params">
  450. <tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>The SD card where the volume is located.</td></tr>
  451. <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 block zero.</td></tr>
  452. </table>
  453. </dd>
  454. </dl>
  455. <dl class="section return"><dt>Returns</dt><dd>The value one, true, is returned for success and the value zero, false, is returned for failure. Reasons for failure include not finding a valid partition, not finding a valid FAT file system in the specified partition or an I/O error. </dd></dl>
  456. </div>
  457. </div>
  458. <a class="anchor" id="a8573884a8056ab7c4c0d6e442f676cc4"></a>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="mlabels">
  462. <tr>
  463. <td class="mlabels-left">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname">uint32_t SdVolume::rootDirEntryCount </td>
  467. <td>(</td>
  468. <td class="paramname"></td><td>)</td>
  469. <td> const</td>
  470. </tr>
  471. </table>
  472. </td>
  473. <td class="mlabels-right">
  474. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  475. </tr>
  476. </table>
  477. </div><div class="memdoc">
  478. <dl class="section return"><dt>Returns</dt><dd>The number of entries in the root directory for FAT16 volumes. </dd></dl>
  479. </div>
  480. </div>
  481. <a class="anchor" id="aa1479f90c53bc9eac379664c5233d399"></a>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="mlabels">
  485. <tr>
  486. <td class="mlabels-left">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">uint32_t SdVolume::rootDirStart </td>
  490. <td>(</td>
  491. <td class="paramname"></td><td>)</td>
  492. <td> const</td>
  493. </tr>
  494. </table>
  495. </td>
  496. <td class="mlabels-right">
  497. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  498. </tr>
  499. </table>
  500. </div><div class="memdoc">
  501. <dl class="section return"><dt>Returns</dt><dd>The logical block number for the start of the root directory on FAT16 volumes or the first cluster number on FAT32 volumes. </dd></dl>
  502. </div>
  503. </div>
  504. <a class="anchor" id="afe76a9f7c181458995518dc8530a1fad"></a>
  505. <div class="memitem">
  506. <div class="memproto">
  507. <table class="mlabels">
  508. <tr>
  509. <td class="mlabels-left">
  510. <table class="memname">
  511. <tr>
  512. <td class="memname"><a class="el" href="class_sd2_card.html">Sd2Card</a>* SdVolume::sdCard </td>
  513. <td>(</td>
  514. <td class="paramname"></td><td>)</td>
  515. <td></td>
  516. </tr>
  517. </table>
  518. </td>
  519. <td class="mlabels-right">
  520. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  521. </tr>
  522. </table>
  523. </div><div class="memdoc">
  524. <p><a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC flash memory cards. ">Sd2Card</a> object for this volume </p>
  525. <dl class="section return"><dt>Returns</dt><dd>pointer to <a class="el" href="class_sd2_card.html" title="Raw access to SD and SDHC flash memory cards. ">Sd2Card</a> object. </dd></dl>
  526. </div>
  527. </div>
  528. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  529. <a class="anchor" id="a05e466c179d34fec11c4406677fe0533"></a>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <table class="mlabels">
  533. <tr>
  534. <td class="mlabels-left">
  535. <table class="memname">
  536. <tr>
  537. <td class="memname">friend class <a class="el" href="class_sd_base_file.html">SdBaseFile</a></td>
  538. </tr>
  539. </table>
  540. </td>
  541. <td class="mlabels-right">
  542. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  543. </tr>
  544. </table>
  545. </div><div class="memdoc">
  546. </div>
  547. </div>
  548. <hr/>The documentation for this class was generated from the following files:<ul>
  549. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_volume_8h.html">SdVolume.h</a></li>
  550. <li>Arduino/libraries/SdFat/<a class="el" href="_sd_volume_8cpp.html">SdVolume.cpp</a></li>
  551. </ul>
  552. </div><!-- contents -->
  553. <!-- start footer part -->
  554. <hr class="footer"/><address class="footer"><small>
  555. Generated on Fri Sep 5 2014 13:07:46 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
  556. <img class="footer" src="doxygen.png" alt="doxygen"/>
  557. </a> 1.8.6
  558. </small></address>
  559. </body>
  560. </html>