Inicio Explorar Axuda
Iniciar sesión
sweproj.com
/
SdFat
2
0
Fork 0
Ficheiros Incidencias 0 Pull Requests 0 Wiki
Árbore: 7417ee943c
Ramas Etiquetas
SdFat
/
extras
/
html
/
class_fat_cache.html

class_fat_cache.html 23 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.14"/>
    7. 

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

  8. <title>SdFat: FatCache Class Reference</title>
    9. 

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

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

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

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

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

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

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

  16. </head>
    17. 

  17. <body>
    18. 

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

  19. <div id="titlearea">
    20. 

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

  21.  <tbody>
    22. 

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

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

  24.    <div id="projectname">SdFat
    25. 

  25.    </div>
    26. 

  26.   </td>
    27. 

  27.  </tr>
    28. 

  28.  </tbody>
    29. 

  29. </table>
    30. 

  30. </div>
    31. 

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

  32. <!-- Generated by Doxygen 1.8.14 -->
    33. 

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

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

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

  36. /* @license-end */
    37. 

  37. </script>
    38. 

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

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

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

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

  42. $(function() {
    43. 

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

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

  45. });
    46. 

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

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

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

  49. <div id="MSearchSelectWindow"
    50. 

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

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

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

  53. </div>
    54. 

  54. 

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

  56. <div id="MSearchResultsWindow">
    57. 

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

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

  59. </iframe>
    60. 

  60. </div>
    61. 

  61. 

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

  63. <div class="header">
    64. 

  64.   <div class="summary">
    65. 

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

  66. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
    67. 

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

  68.   <div class="headertitle">
    69. 

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

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

  71. <div class="contents">
    72. 

  72. 

  73. <p>Block cache.  
    74. 

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

  75. 

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

  77. <table class="memberdecls">
    78. 

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

  79. Public Member Functions</h2></td></tr>
    80. 

  80. <tr class="memitem:ab3d9c4f94af61065b6d6d0892827fd8a"><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_cache.html#ab3d9c4f94af61065b6d6d0892827fd8a">block</a> ()</td></tr>
    81. 

  81. <tr class="separator:ab3d9c4f94af61065b6d6d0892827fd8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. <tr class="memitem:ab4d3b0c16bb6a116c7d01afff2dcb307"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#ab4d3b0c16bb6a116c7d01afff2dcb307">dirty</a> ()</td></tr>
    83. 

  83. <tr class="separator:ab4d3b0c16bb6a116c7d01afff2dcb307"><td class="memSeparator" colspan="2">&#160;</td></tr>
    84. 

  84. <tr class="memitem:ae1d8a2da1493b5ffca0520184daaddf1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#ae1d8a2da1493b5ffca0520184daaddf1">init</a> (<a class="el" href="class_fat_volume.html">FatVolume</a> *vol)</td></tr>
    85. 

  85. <tr class="separator:ae1d8a2da1493b5ffca0520184daaddf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    86. 

  86. <tr class="memitem:a70071a128d647b49b523dbb2f5f944a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#a70071a128d647b49b523dbb2f5f944a5">invalidate</a> ()</td></tr>
    87. 

  87. <tr class="separator:a70071a128d647b49b523dbb2f5f944a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
    88. 

  88. <tr class="memitem:ae50287d95bd78558db1e4aa97d7b2c06"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#ae50287d95bd78558db1e4aa97d7b2c06">isDirty</a> ()</td></tr>
    89. 

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

  90. <tr class="memitem:a9f981b53e212f79937e5f6381b169374"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#a9f981b53e212f79937e5f6381b169374">lbn</a> ()</td></tr>
    91. 

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

  92. <tr class="memitem:ac2bb0b8f2ce3ab5cd86cf30b4a663cea"><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_cache.html#ac2bb0b8f2ce3ab5cd86cf30b4a663cea">read</a> (uint32_t <a class="el" href="class_fat_cache.html#a9f981b53e212f79937e5f6381b169374">lbn</a>, uint8_t option)</td></tr>
    93. 

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

  94. <tr class="memitem:a4d76d4f46ce5994f6fc4678a7b4f8cf1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#a4d76d4f46ce5994f6fc4678a7b4f8cf1">sync</a> ()</td></tr>
    95. 

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

  96. </table><table class="memberdecls">
    97. 

  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
    98. 

  98. Static Public Attributes</h2></td></tr>
    99. 

  99. <tr class="memitem:ab4b446515ff9a0cebc747630ddd10c93"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#ab4b446515ff9a0cebc747630ddd10c93">CACHE_FOR_READ</a> = 0</td></tr>
    100. 

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

  101. <tr class="memitem:a81cb572f33443bd6aee9aa33ec395d0f"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#a81cb572f33443bd6aee9aa33ec395d0f">CACHE_FOR_WRITE</a> = <a class="el" href="class_fat_cache.html#aac8c38e5c545d0f80b13d816117f626e">CACHE_STATUS_DIRTY</a></td></tr>
    102. 

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

  103. <tr class="memitem:adf974f55e53ee0aaa85abb0d7d67181c"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#adf974f55e53ee0aaa85abb0d7d67181c">CACHE_OPTION_NO_READ</a> = 4</td></tr>
    104. 

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

  105. <tr class="memitem:a49d2896ff525ab77852f76df5c2a09c2"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#a49d2896ff525ab77852f76df5c2a09c2">CACHE_RESERVE_FOR_WRITE</a> = <a class="el" href="class_fat_cache.html#aac8c38e5c545d0f80b13d816117f626e">CACHE_STATUS_DIRTY</a> | <a class="el" href="class_fat_cache.html#adf974f55e53ee0aaa85abb0d7d67181c">CACHE_OPTION_NO_READ</a></td></tr>
    106. 

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

  107. <tr class="memitem:aac8c38e5c545d0f80b13d816117f626e"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#aac8c38e5c545d0f80b13d816117f626e">CACHE_STATUS_DIRTY</a> = 1</td></tr>
    108. 

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

  109. <tr class="memitem:ab70dc4a2e387f0e9bf392044c702ae32"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#ab70dc4a2e387f0e9bf392044c702ae32">CACHE_STATUS_MASK</a> = <a class="el" href="class_fat_cache.html#aac8c38e5c545d0f80b13d816117f626e">CACHE_STATUS_DIRTY</a> | <a class="el" href="class_fat_cache.html#a45236e1c0a2a098f08d3add0e4b1467a">CACHE_STATUS_MIRROR_FAT</a></td></tr>
    110. 

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

  111. <tr class="memitem:a45236e1c0a2a098f08d3add0e4b1467a"><td class="memItemLeft" align="right" valign="top">static const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fat_cache.html#a45236e1c0a2a098f08d3add0e4b1467a">CACHE_STATUS_MIRROR_FAT</a> = 2</td></tr>
    112. 

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

  113. </table>
    114. 

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

  115. <div class="textblock"><p>Block cache. </p>
    116. 

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

  117. <a id="ab3d9c4f94af61065b6d6d0892827fd8a"></a>
    118. 

  118. <h2 class="memtitle"><span class="permalink"><a href="#ab3d9c4f94af61065b6d6d0892827fd8a">&#9670;&nbsp;</a></span>block()</h2>
    119. 

  119. 

  120. <div class="memitem">
    121. 

  121. <div class="memproto">
    122. 

  122. <table class="mlabels">
    123. 

  123.   <tr>
    124. 

  124.   <td class="mlabels-left">
    125. 

  125.       <table class="memname">
    126. 

  126.         <tr>
    127. 

  127.           <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a>* FatCache::block </td>
    128. 

  128.           <td>(</td>
    129. 

  129.           <td class="paramname"></td><td>)</td>
    130. 

  130.           <td></td>
    131. 

  131.         </tr>
    132. 

  132.       </table>
    133. 

  133.   </td>
    134. 

  134.   <td class="mlabels-right">
    135. 

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

  136.   </tr>
    137. 

  137. </table>
    138. 

  138. </div><div class="memdoc">
    139. 

  139. <dl class="section return"><dt>Returns</dt><dd>Cache block address. </dd></dl>
    140. 

  140. 

  141. </div>
    142. 

  142. </div>
    143. 

  143. <a id="ab4d3b0c16bb6a116c7d01afff2dcb307"></a>
    144. 

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

  145. 

  146. <div class="memitem">
    147. 

  147. <div class="memproto">
    148. 

  148. <table class="mlabels">
    149. 

  149.   <tr>
    150. 

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

  151.       <table class="memname">
    152. 

  152.         <tr>
    153. 

  153.           <td class="memname">void FatCache::dirty </td>
    154. 

  154.           <td>(</td>
    155. 

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

  156.           <td></td>
    157. 

  157.         </tr>
    158. 

  158.       </table>
    159. 

  159.   </td>
    160. 

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

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

  162.   </tr>
    163. 

  163. </table>
    164. 

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

  165. <p>Set current block dirty. </p>
    166. 

  166. 

  167. </div>
    168. 

  168. </div>
    169. 

  169. <a id="ae1d8a2da1493b5ffca0520184daaddf1"></a>
    170. 

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

  171. 

  172. <div class="memitem">
    173. 

  173. <div class="memproto">
    174. 

  174. <table class="mlabels">
    175. 

  175.   <tr>
    176. 

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

  177.       <table class="memname">
    178. 

  178.         <tr>
    179. 

  179.           <td class="memname">void FatCache::init </td>
    180. 

  180.           <td>(</td>
    181. 

  181.           <td class="paramtype"><a class="el" href="class_fat_volume.html">FatVolume</a> *&#160;</td>
    182. 

  182.           <td class="paramname"><em>vol</em></td><td>)</td>
    183. 

  183.           <td></td>
    184. 

  184.         </tr>
    185. 

  185.       </table>
    186. 

  186.   </td>
    187. 

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

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

  189.   </tr>
    190. 

  190. </table>
    191. 

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

  192. <p>Initialize the cache. </p><dl class="params"><dt>Parameters</dt><dd>
    193. 

  193.   <table class="params">
    194. 

  194.     <tr><td class="paramdir">[in]</td><td class="paramname">vol</td><td><a class="el" href="class_fat_volume.html" title="Access FAT16 and FAT32 volumes on raw file devices. ">FatVolume</a> that owns this <a class="el" href="class_fat_cache.html" title="Block cache. ">FatCache</a>. </td></tr>
    195. 

  195.   </table>
    196. 

  196.   </dd>
    197. 

  197. </dl>
    198. 

  198. 

  199. </div>
    200. 

  200. </div>
    201. 

  201. <a id="a70071a128d647b49b523dbb2f5f944a5"></a>
    202. 

  202. <h2 class="memtitle"><span class="permalink"><a href="#a70071a128d647b49b523dbb2f5f944a5">&#9670;&nbsp;</a></span>invalidate()</h2>
    203. 

  203. 

  204. <div class="memitem">
    205. 

  205. <div class="memproto">
    206. 

  206. <table class="mlabels">
    207. 

  207.   <tr>
    208. 

  208.   <td class="mlabels-left">
    209. 

  209.       <table class="memname">
    210. 

  210.         <tr>
    211. 

  211.           <td class="memname">void FatCache::invalidate </td>
    212. 

  212.           <td>(</td>
    213. 

  213.           <td class="paramname"></td><td>)</td>
    214. 

  214.           <td></td>
    215. 

  215.         </tr>
    216. 

  216.       </table>
    217. 

  217.   </td>
    218. 

  218.   <td class="mlabels-right">
    219. 

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

  220.   </tr>
    221. 

  221. </table>
    222. 

  222. </div><div class="memdoc">
    223. 

  223. <p>Invalidate current cache block. </p>
    224. 

  224. 

  225. </div>
    226. 

  226. </div>
    227. 

  227. <a id="ae50287d95bd78558db1e4aa97d7b2c06"></a>
    228. 

  228. <h2 class="memtitle"><span class="permalink"><a href="#ae50287d95bd78558db1e4aa97d7b2c06">&#9670;&nbsp;</a></span>isDirty()</h2>
    229. 

  229. 

  230. <div class="memitem">
    231. 

  231. <div class="memproto">
    232. 

  232. <table class="mlabels">
    233. 

  233.   <tr>
    234. 

  234.   <td class="mlabels-left">
    235. 

  235.       <table class="memname">
    236. 

  236.         <tr>
    237. 

  237.           <td class="memname">bool FatCache::isDirty </td>
    238. 

  238.           <td>(</td>
    239. 

  239.           <td class="paramname"></td><td>)</td>
    240. 

  240.           <td></td>
    241. 

  241.         </tr>
    242. 

  242.       </table>
    243. 

  243.   </td>
    244. 

  244.   <td class="mlabels-right">
    245. 

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

  246.   </tr>
    247. 

  247. </table>
    248. 

  248. </div><div class="memdoc">
    249. 

  249. <dl class="section return"><dt>Returns</dt><dd>dirty status </dd></dl>
    250. 

  250. 

  251. </div>
    252. 

  252. </div>
    253. 

  253. <a id="a9f981b53e212f79937e5f6381b169374"></a>
    254. 

  254. <h2 class="memtitle"><span class="permalink"><a href="#a9f981b53e212f79937e5f6381b169374">&#9670;&nbsp;</a></span>lbn()</h2>
    255. 

  255. 

  256. <div class="memitem">
    257. 

  257. <div class="memproto">
    258. 

  258. <table class="mlabels">
    259. 

  259.   <tr>
    260. 

  260.   <td class="mlabels-left">
    261. 

  261.       <table class="memname">
    262. 

  262.         <tr>
    263. 

  263.           <td class="memname">uint32_t FatCache::lbn </td>
    264. 

  264.           <td>(</td>
    265. 

  265.           <td class="paramname"></td><td>)</td>
    266. 

  266.           <td></td>
    267. 

  267.         </tr>
    268. 

  268.       </table>
    269. 

  269.   </td>
    270. 

  270.   <td class="mlabels-right">
    271. 

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

  272.   </tr>
    273. 

  273. </table>
    274. 

  274. </div><div class="memdoc">
    275. 

  275. <dl class="section return"><dt>Returns</dt><dd>Logical block number for cached block. </dd></dl>
    276. 

  276. 

  277. </div>
    278. 

  278. </div>
    279. 

  279. <a id="ac2bb0b8f2ce3ab5cd86cf30b4a663cea"></a>
    280. 

  280. <h2 class="memtitle"><span class="permalink"><a href="#ac2bb0b8f2ce3ab5cd86cf30b4a663cea">&#9670;&nbsp;</a></span>read()</h2>
    281. 

  281. 

  282. <div class="memitem">
    283. 

  283. <div class="memproto">
    284. 

  284.       <table class="memname">
    285. 

  285.         <tr>
    286. 

  286.           <td class="memname"><a class="el" href="unioncache__t.html">cache_t</a> * FatCache::read </td>
    287. 

  287.           <td>(</td>
    288. 

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

  289.           <td class="paramname"><em>lbn</em>, </td>
    290. 

  290.         </tr>
    291. 

  291.         <tr>
    292. 

  292.           <td class="paramkey"></td>
    293. 

  293.           <td></td>
    294. 

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

  295.           <td class="paramname"><em>option</em>&#160;</td>
    296. 

  296.         </tr>
    297. 

  297.         <tr>
    298. 

  298.           <td></td>
    299. 

  299.           <td>)</td>
    300. 

  300.           <td></td><td></td>
    301. 

  301.         </tr>
    302. 

  302.       </table>
    303. 

  303. </div><div class="memdoc">
    304. 

  304. <p>Read a block into the cache. </p><dl class="params"><dt>Parameters</dt><dd>
    305. 

  305.   <table class="params">
    306. 

  306.     <tr><td class="paramdir">[in]</td><td class="paramname">lbn</td><td>Block to read. </td></tr>
    307. 

  307.     <tr><td class="paramdir">[in]</td><td class="paramname">option</td><td>mode for cached block. </td></tr>
    308. 

  308.   </table>
    309. 

  309.   </dd>
    310. 

  310. </dl>
    311. 

  311. <dl class="section return"><dt>Returns</dt><dd>Address of cached block.</dd></dl>
    312. 

  312. <p>Copyright (c) 2011-2018 Bill Greiman This file is part of the <a class="el" href="class_sd_fat.html" title="Main file system class for SdFat library. ">SdFat</a> library for SD memory cards.</p>
    313. 

  313. <p>MIT License</p>
    314. 

  314. <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
    315. 

  315. <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
    316. 

  316. <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
    317. 

  317. 

  318. </div>
    319. 

  319. </div>
    320. 

  320. <a id="a4d76d4f46ce5994f6fc4678a7b4f8cf1"></a>
    321. 

  321. <h2 class="memtitle"><span class="permalink"><a href="#a4d76d4f46ce5994f6fc4678a7b4f8cf1">&#9670;&nbsp;</a></span>sync()</h2>
    322. 

  322. 

  323. <div class="memitem">
    324. 

  324. <div class="memproto">
    325. 

  325.       <table class="memname">
    326. 

  326.         <tr>
    327. 

  327.           <td class="memname">bool FatCache::sync </td>
    328. 

  328.           <td>(</td>
    329. 

  329.           <td class="paramname"></td><td>)</td>
    330. 

  330.           <td></td>
    331. 

  331.         </tr>
    332. 

  332.       </table>
    333. 

  333. </div><div class="memdoc">
    334. 

  334. <p>Write current block if dirty. </p><dl class="section return"><dt>Returns</dt><dd>true for success else false. </dd></dl>
    335. 

  335. 

  336. </div>
    337. 

  337. </div>
    338. 

  338. <h2 class="groupheader">Member Data Documentation</h2>
    339. 

  339. <a id="ab4b446515ff9a0cebc747630ddd10c93"></a>
    340. 

  340. <h2 class="memtitle"><span class="permalink"><a href="#ab4b446515ff9a0cebc747630ddd10c93">&#9670;&nbsp;</a></span>CACHE_FOR_READ</h2>
    341. 

  341. 

  342. <div class="memitem">
    343. 

  343. <div class="memproto">
    344. 

  344. <table class="mlabels">
    345. 

  345.   <tr>
    346. 

  346.   <td class="mlabels-left">
    347. 

  347.       <table class="memname">
    348. 

  348.         <tr>
    349. 

  349.           <td class="memname">const uint8_t FatCache::CACHE_FOR_READ = 0</td>
    350. 

  350.         </tr>
    351. 

  351.       </table>
    352. 

  352.   </td>
    353. 

  353.   <td class="mlabels-right">
    354. 

  354. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    355. 

  355.   </tr>
    356. 

  356. </table>
    357. 

  357. </div><div class="memdoc">
    358. 

  358. <p>Cache block for read. </p>
    359. 

  359. 

  360. </div>
    361. 

  361. </div>
    362. 

  362. <a id="a81cb572f33443bd6aee9aa33ec395d0f"></a>
    363. 

  363. <h2 class="memtitle"><span class="permalink"><a href="#a81cb572f33443bd6aee9aa33ec395d0f">&#9670;&nbsp;</a></span>CACHE_FOR_WRITE</h2>
    364. 

  364. 

  365. <div class="memitem">
    366. 

  366. <div class="memproto">
    367. 

  367. <table class="mlabels">
    368. 

  368.   <tr>
    369. 

  369.   <td class="mlabels-left">
    370. 

  370.       <table class="memname">
    371. 

  371.         <tr>
    372. 

  372.           <td class="memname">const uint8_t FatCache::CACHE_FOR_WRITE = <a class="el" href="class_fat_cache.html#aac8c38e5c545d0f80b13d816117f626e">CACHE_STATUS_DIRTY</a></td>
    373. 

  373.         </tr>
    374. 

  374.       </table>
    375. 

  375.   </td>
    376. 

  376.   <td class="mlabels-right">
    377. 

  377. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    378. 

  378.   </tr>
    379. 

  379. </table>
    380. 

  380. </div><div class="memdoc">
    381. 

  381. <p>Cache block for write. </p>
    382. 

  382. 

  383. </div>
    384. 

  384. </div>
    385. 

  385. <a id="adf974f55e53ee0aaa85abb0d7d67181c"></a>
    386. 

  386. <h2 class="memtitle"><span class="permalink"><a href="#adf974f55e53ee0aaa85abb0d7d67181c">&#9670;&nbsp;</a></span>CACHE_OPTION_NO_READ</h2>
    387. 

  387. 

  388. <div class="memitem">
    389. 

  389. <div class="memproto">
    390. 

  390. <table class="mlabels">
    391. 

  391.   <tr>
    392. 

  392.   <td class="mlabels-left">
    393. 

  393.       <table class="memname">
    394. 

  394.         <tr>
    395. 

  395.           <td class="memname">const uint8_t FatCache::CACHE_OPTION_NO_READ = 4</td>
    396. 

  396.         </tr>
    397. 

  397.       </table>
    398. 

  398.   </td>
    399. 

  399.   <td class="mlabels-right">
    400. 

  400. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    401. 

  401.   </tr>
    402. 

  402. </table>
    403. 

  403. </div><div class="memdoc">
    404. 

  404. <p>Sync existing block but do not read new block. </p>
    405. 

  405. 

  406. </div>
    407. 

  407. </div>
    408. 

  408. <a id="a49d2896ff525ab77852f76df5c2a09c2"></a>
    409. 

  409. <h2 class="memtitle"><span class="permalink"><a href="#a49d2896ff525ab77852f76df5c2a09c2">&#9670;&nbsp;</a></span>CACHE_RESERVE_FOR_WRITE</h2>
    410. 

  410. 

  411. <div class="memitem">
    412. 

  412. <div class="memproto">
    413. 

  413. <table class="mlabels">
    414. 

  414.   <tr>
    415. 

  415.   <td class="mlabels-left">
    416. 

  416.       <table class="memname">
    417. 

  417.         <tr>
    418. 

  418.           <td class="memname">const uint8_t FatCache::CACHE_RESERVE_FOR_WRITE = <a class="el" href="class_fat_cache.html#aac8c38e5c545d0f80b13d816117f626e">CACHE_STATUS_DIRTY</a> | <a class="el" href="class_fat_cache.html#adf974f55e53ee0aaa85abb0d7d67181c">CACHE_OPTION_NO_READ</a></td>
    419. 

  419.         </tr>
    420. 

  420.       </table>
    421. 

  421.   </td>
    422. 

  422.   <td class="mlabels-right">
    423. 

  423. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    424. 

  424.   </tr>
    425. 

  425. </table>
    426. 

  426. </div><div class="memdoc">
    427. 

  427. <p>Reserve cache block for write - do not read from block device. </p>
    428. 

  428. 

  429. </div>
    430. 

  430. </div>
    431. 

  431. <a id="aac8c38e5c545d0f80b13d816117f626e"></a>
    432. 

  432. <h2 class="memtitle"><span class="permalink"><a href="#aac8c38e5c545d0f80b13d816117f626e">&#9670;&nbsp;</a></span>CACHE_STATUS_DIRTY</h2>
    433. 

  433. 

  434. <div class="memitem">
    435. 

  435. <div class="memproto">
    436. 

  436. <table class="mlabels">
    437. 

  437.   <tr>
    438. 

  438.   <td class="mlabels-left">
    439. 

  439.       <table class="memname">
    440. 

  440.         <tr>
    441. 

  441.           <td class="memname">const uint8_t FatCache::CACHE_STATUS_DIRTY = 1</td>
    442. 

  442.         </tr>
    443. 

  443.       </table>
    444. 

  444.   </td>
    445. 

  445.   <td class="mlabels-right">
    446. 

  446. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    447. 

  447.   </tr>
    448. 

  448. </table>
    449. 

  449. </div><div class="memdoc">
    450. 

  450. <p>Cached block is dirty </p>
    451. 

  451. 

  452. </div>
    453. 

  453. </div>
    454. 

  454. <a id="ab70dc4a2e387f0e9bf392044c702ae32"></a>
    455. 

  455. <h2 class="memtitle"><span class="permalink"><a href="#ab70dc4a2e387f0e9bf392044c702ae32">&#9670;&nbsp;</a></span>CACHE_STATUS_MASK</h2>
    456. 

  456. 

  457. <div class="memitem">
    458. 

  458. <div class="memproto">
    459. 

  459. <table class="mlabels">
    460. 

  460.   <tr>
    461. 

  461.   <td class="mlabels-left">
    462. 

  462.       <table class="memname">
    463. 

  463.         <tr>
    464. 

  464.           <td class="memname">const uint8_t FatCache::CACHE_STATUS_MASK = <a class="el" href="class_fat_cache.html#aac8c38e5c545d0f80b13d816117f626e">CACHE_STATUS_DIRTY</a> | <a class="el" href="class_fat_cache.html#a45236e1c0a2a098f08d3add0e4b1467a">CACHE_STATUS_MIRROR_FAT</a></td>
    465. 

  465.         </tr>
    466. 

  466.       </table>
    467. 

  467.   </td>
    468. 

  468.   <td class="mlabels-right">
    469. 

  469. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    470. 

  470.   </tr>
    471. 

  471. </table>
    472. 

  472. </div><div class="memdoc">
    473. 

  473. <p>Cache block status bits </p>
    474. 

  474. 

  475. </div>
    476. 

  476. </div>
    477. 

  477. <a id="a45236e1c0a2a098f08d3add0e4b1467a"></a>
    478. 

  478. <h2 class="memtitle"><span class="permalink"><a href="#a45236e1c0a2a098f08d3add0e4b1467a">&#9670;&nbsp;</a></span>CACHE_STATUS_MIRROR_FAT</h2>
    479. 

  479. 

  480. <div class="memitem">
    481. 

  481. <div class="memproto">
    482. 

  482. <table class="mlabels">
    483. 

  483.   <tr>
    484. 

  484.   <td class="mlabels-left">
    485. 

  485.       <table class="memname">
    486. 

  486.         <tr>
    487. 

  487.           <td class="memname">const uint8_t FatCache::CACHE_STATUS_MIRROR_FAT = 2</td>
    488. 

  488.         </tr>
    489. 

  489.       </table>
    490. 

  490.   </td>
    491. 

  491.   <td class="mlabels-right">
    492. 

  492. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    493. 

  493.   </tr>
    494. 

  494. </table>
    495. 

  495. </div><div class="memdoc">
    496. 

  496. <p>Cashed block is FAT entry and must be mirrored in second FAT. </p>
    497. 

  497. 

  498. </div>
    499. 

  499. </div>
    500. 

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

  501. <li>Arduino/libraries/SdFat/src/FatLib/<a class="el" href="_fat_volume_8h.html">FatVolume.h</a></li>
    502. 

  502. <li>Arduino/libraries/SdFat/src/FatLib/FatVolume.cpp</li>
    503. 

  503. </ul>
    504. 

  504. </div><!-- contents -->
    505. 

  505. <!-- start footer part -->
    506. 

  506. <hr class="footer"/><address class="footer"><small>
    507. 

  507. Generated on Fri Dec 28 2018 06:38:31 for SdFat by &#160;<a href="http://www.doxygen.org/index.html">
    508. 

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

  509. </a> 1.8.14
    510. 

  510. </small></address>
    511. 

  511. </body>
    512. 

  512. </html>
    513.