<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS: fs/fat/fat_cache.c Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">UbixOS
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('da/d57/fat__cache_8c_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">fat_cache.c</div> </div>
</div><!--header-->
<div class="contents">
<a href="../../da/d57/fat__cache_8c.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// FAT16/32 File IO Library</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// V2.6</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// Ultra-Embedded.com</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// Copyright 2003 - 2012</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Email: admin@ultra-embedded.com</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// License: GPL</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// If you would like a version with a more permissive license for use in</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// closed source commercial applications please contact me for details.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">//</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// This file is part of FAT File IO Library.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">//</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// FAT File IO Library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// the Free Software Foundation; either version 2 of the License, or</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// (at your option) any later version.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">//</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// FAT File IO Library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// GNU General Public License for more details.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">//</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// along with FAT File IO Library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <<a class="code" href="../../da/d66/string_8h.html">string.h</a>></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="../../de/de6/fat__cache_8h.html">fat_cache.h</a>"</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Per file cluster chain caching used to improve performance.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// This does not have to be enabled for architectures with low</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// memory space.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// fatfs_cache_init:</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="../../de/de6/fat__cache_8h.html#a205d74e989d0e076b031ea2990370c4d"> 42</a></span> <span class="keywordtype">int</span> <a class="code" href="../../da/d57/fat__cache_8c.html#a205d74e989d0e076b031ea2990370c4d">fatfs_cache_init</a>(<span class="keyword">struct</span> <a class="code" href="../../dd/d1f/structfatfs.html">fatfs</a> *<a class="code" href="../../de/d1a/structfs.html">fs</a>, <a class="code" href="../../d9/d8d/structsFL__FILE.html">FL_FILE</a> *<a class="code" href="../../d7/d3a/structfile.html">file</a>)</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#ifdef FAT_CLUSTER_CACHE_ENTRIES</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">int</span> i;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">for</span> (i=0;i<FAT_CLUSTER_CACHE_ENTRIES;i++)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="../../d7/d3a/structfile.html">file</a>->cluster_cache_idx[i] = 0xFFFFFFFF; <span class="comment">// Not used</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="../../d7/d3a/structfile.html">file</a>->cluster_cache_data[i] = 0;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> 1;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// fatfs_cache_get_next_cluster:</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="../../de/de6/fat__cache_8h.html#afe54582a1aa9848bd2cb4724e1baf6bc"> 59</a></span> <span class="keywordtype">int</span> <a class="code" href="../../da/d57/fat__cache_8c.html#afe54582a1aa9848bd2cb4724e1baf6bc">fatfs_cache_get_next_cluster</a>(<span class="keyword">struct</span> <a class="code" href="../../dd/d1f/structfatfs.html">fatfs</a> *<a class="code" href="../../de/d1a/structfs.html">fs</a>, <a class="code" href="../../d9/d8d/structsFL__FILE.html">FL_FILE</a> *<a class="code" href="../../d7/d3a/structfile.html">file</a>, <a class="code" href="../../de/d31/fat__types_8h.html#a4b435a49c74bb91f284f075e63416cb6">uint32</a> clusterIdx, <a class="code" href="../../de/d31/fat__types_8h.html#a4b435a49c74bb91f284f075e63416cb6">uint32</a> *pNextCluster)</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#ifdef FAT_CLUSTER_CACHE_ENTRIES</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="../../de/d31/fat__types_8h.html#a4b435a49c74bb91f284f075e63416cb6">uint32</a> slot = clusterIdx % FAT_CLUSTER_CACHE_ENTRIES;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">if</span> (<a class="code" href="../../d7/d3a/structfile.html">file</a>->cluster_cache_idx[slot] == clusterIdx)</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  *pNextCluster = <a class="code" href="../../d7/d3a/structfile.html">file</a>->cluster_cache_data[slot];</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> 1;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> }</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// fatfs_cache_set_next_cluster:</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">//-----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="../../de/de6/fat__cache_8h.html#ac21308cd551be1d3bafd1dc9e3690e5a"> 76</a></span> <span class="keywordtype">int</span> <a class="code" href="../../da/d57/fat__cache_8c.html#ac21308cd551be1d3bafd1dc9e3690e5a">fatfs_cache_set_next_cluster</a>(<span class="keyword">struct</span> <a class="code" href="../../dd/d1f/structfatfs.html">fatfs</a> *<a class="code" href="../../de/d1a/structfs.html">fs</a>, <a class="code" href="../../d9/d8d/structsFL__FILE.html">FL_FILE</a> *<a class="code" href="../../d7/d3a/structfile.html">file</a>, <a class="code" href="../../de/d31/fat__types_8h.html#a4b435a49c74bb91f284f075e63416cb6">uint32</a> clusterIdx, <a class="code" href="../../de/d31/fat__types_8h.html#a4b435a49c74bb91f284f075e63416cb6">uint32</a> nextCluster)</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#ifdef FAT_CLUSTER_CACHE_ENTRIES</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="../../de/d31/fat__types_8h.html#a4b435a49c74bb91f284f075e63416cb6">uint32</a> slot = clusterIdx % FAT_CLUSTER_CACHE_ENTRIES;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">if</span> (<a class="code" href="../../d7/d3a/structfile.html">file</a>->cluster_cache_idx[slot] == clusterIdx)</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="../../d7/d3a/structfile.html">file</a>->cluster_cache_data[slot] = nextCluster;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">else</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="../../d7/d3a/structfile.html">file</a>->cluster_cache_idx[slot] = clusterIdx;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="../../d7/d3a/structfile.html">file</a>->cluster_cache_data[slot] = nextCluster;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> 1;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> }</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="afat__cache_8c_html_ac21308cd551be1d3bafd1dc9e3690e5a"><div class="ttname"><a href="../../da/d57/fat__cache_8c.html#ac21308cd551be1d3bafd1dc9e3690e5a">fatfs_cache_set_next_cluster</a></div><div class="ttdeci">int fatfs_cache_set_next_cluster(struct fatfs *fs, FL_FILE *file, uint32 clusterIdx, uint32 nextCluster)</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d57/fat__cache_8c_source.html#l00076">fat_cache.c:76</a></div></div>
<div class="ttc" id="afat__cache_8h_html"><div class="ttname"><a href="../../de/de6/fat__cache_8h.html">fat_cache.h</a></div></div>
<div class="ttc" id="astring_8h_html"><div class="ttname"><a href="../../da/d66/string_8h.html">string.h</a></div></div>
<div class="ttc" id="astructfile_html"><div class="ttname"><a href="../../d7/d3a/structfile.html">file</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/df4/descrip_8h_source.html#l00067">descrip.h:67</a></div></div>
<div class="ttc" id="astructfs_html"><div class="ttname"><a href="../../de/d1a/structfs.html">fs</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d5b/ufs_2ffs_2fs_8h_source.html#l00260">fs.h:260</a></div></div>
<div class="ttc" id="afat__cache_8c_html_a205d74e989d0e076b031ea2990370c4d"><div class="ttname"><a href="../../da/d57/fat__cache_8c.html#a205d74e989d0e076b031ea2990370c4d">fatfs_cache_init</a></div><div class="ttdeci">int fatfs_cache_init(struct fatfs *fs, FL_FILE *file)</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d57/fat__cache_8c_source.html#l00042">fat_cache.c:42</a></div></div>
<div class="ttc" id="astructsFL__FILE_html"><div class="ttname"><a href="../../d9/d8d/structsFL__FILE.html">sFL_FILE</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d6/df3/fat__filelib_8h_source.html#l00038">fat_filelib.h:38</a></div></div>
<div class="ttc" id="afat__types_8h_html_a4b435a49c74bb91f284f075e63416cb6"><div class="ttname"><a href="../../de/d31/fat__types_8h.html#a4b435a49c74bb91f284f075e63416cb6">uint32</a></div><div class="ttdeci">unsigned long uint32</div><div class="ttdef"><b>Definition:</b> <a href="../../de/d31/fat__types_8h_source.html#l00023">fat_types.h:23</a></div></div>
<div class="ttc" id="afat__cache_8c_html_afe54582a1aa9848bd2cb4724e1baf6bc"><div class="ttname"><a href="../../da/d57/fat__cache_8c.html#afe54582a1aa9848bd2cb4724e1baf6bc">fatfs_cache_get_next_cluster</a></div><div class="ttdeci">int fatfs_cache_get_next_cluster(struct fatfs *fs, FL_FILE *file, uint32 clusterIdx, uint32 *pNextCluster)</div><div class="ttdef"><b>Definition:</b> <a href="../../da/d57/fat__cache_8c_source.html#l00059">fat_cache.c:59</a></div></div>
<div class="ttc" id="astructfatfs_html"><div class="ttname"><a href="../../dd/d1f/structfatfs.html">fatfs</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d9/dca/fat__access_8h_source.html#l00057">fat_access.h:57</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_97b3d2b63ac216821c2d7a22ee0ab2b0.html">fs</a></li><li class="navelem"><a class="el" href="../../dir_1df5146ffaa3c1b28ef7040087228944.html">fat</a></li><li class="navelem"><a class="el" href="../../da/d57/fat__cache_8c.html">fat_cache.c</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>
