Github/fatfs
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

FatFs R0.16, released July 22, 2025

Browse Source
This commit is contained in:
Christopher Williams
2025-07-21 16:32:22 -07:00
parent 79eff96e0b
commit 5f85a520a9
65 changed files with 1199 additions and 828 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documents/doc/appnote.html
+5 -5
View File
@@ -90,7 +90,7 @@ The FatFs module is a middleware written in ANSI C (C89). There is no platform d
<ul>
<li>Filesystem type: FAT, FAT32(rev0.0) and exFAT(rev1.0).</li>
<li>Number of open files: Unlimited. (depends on available memory)</li>
<li>Number of volumes: Up to 10.</li>
<li>Number of mounted volumes: Up to 10.</li>
<li>Sector size: 512, 1024, 2048 and 4096 bytes.</li>
<li>Minimum volume size: 128 sectors.</li>
<li>Maximum volume size: 2<sup>32</sup> - 1 sectors in 32-bit LBA, virtually unlimited in 64-bit LBA with exFAT.</li>
@@ -116,11 +116,11 @@ The FatFs module is a middleware written in ANSI C (C89). There is no platform d
</table>
<p>These are the memory usage of FatFs module without lower layer on some target systems in following condition. <em>V</em> denotes number of mounted volumes and <em>F</em> denotes number of open files. Every samples here are optimezed in code size.</p>
<pre>
FatFs R0.15b options:
FatFs R0.16 options:
FF_FS_READONLY 0 (R/W, read/write) or 1 (R/O, read only)
FF_FS_MINIMIZE 0 (Def, with all basic functions) or 3 (Min, with fully minimized)
FF_FS_TINY 0 (Default) or 1 (Tiny file object)
And any other options are left unchanged from original setting.
Any other option is left unchanged from original settings.
</pre>
</div>
@@ -202,7 +202,7 @@ And any other options are left unchanged from original setting.
<div class="para doc" id="lba64">
<h3>64-bit LBA</h3>
<p>LBA (Logical Block Addressing) is an addressing method to specify the location of data block, called <em>sector</em>, on the storage media. It is a simple linear address beginning from 0 as the first sector, 1 as the second sector and so on. The host system does not need to consider how the data block is located and managed in the storage device. FatFs supports only LBA for the media access. 32-bit LBA is a common size in the most LBA scheme. It can address up to 2<sup>32</sup> sectors, 2 TB in 512 bytes/sector. When a storage device larger than 2 TB is used, larger sector size or 64-bit LBA will be needed to address the entire sectors of the storage device.</p>
<p>By default, FatFs works in 32-bit LBA for media access. FatFs can also switch it to 64-bit LBA by a configuration option <tt><a href="config.html#fs_lba64">FF_LBA64</a></tt>. It also enables GPT (GUID Partition Table) for partition management on the storage device. For further information about GPT, refer to <tt><a href="mkfs.html">f_mkfs</a></tt> and <tt><a href="fdisk.html">f_fdisk</a></tt> function.</p>
<p>By default, FatFs works in 32-bit LBA for media access. By configuration option <a href="config.html#fs_lba64"><tt>FF_LBA64</tt></a>, it can be switched to 64-bit LBA and also GPT (GUID Partition Table) is enabled for partition management on the storage device. For further information about GPT, refer to <tt><a href="mkfs.html">f_mkfs</a></tt> and <tt><a href="fdisk.html">f_fdisk</a></tt> function.</p>
</div>
<div class="para doc" id="reentrant">
@@ -333,6 +333,6 @@ Figure 5. Minimized critical section<br>
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/chdir.html
+7 -7
View File
@@ -48,8 +48,8 @@ FRESULT f_chdir (
<div class="para desc">
<h4>Description</h4>
<p>The <tt>f_chdir</tt> function changes the current directory of the logical drive. Also the current drive will be changed when in Unix style drive prefix, <tt><a href="config.html#str_volume_id">FF_STR_VOLUME_ID</a> == 2</tt>. The current directory of each logical drive is initialized to the root directory on mount.</p>
<p>Note that the current directory is retained in the each file system object and the current drive is retained in a static variable, so that it also affects other tasks that use the file functions.</p>
<p>The <tt>f_chdir</tt> function changes the current directory of the logical drive. Also the current drive will be changed when FatFs is configured <tt><a href="config.html#str_volume_id">FF_STR_VOLUME_ID</a> == 2</tt> and an full path is specified. The current directory of each logical drive is set root directory on mount.</p>
<p>Note that the current directory is retained in the each filesystem object and the current drive is retained in a static variable, so that they also affect other tasks that use the file functions.</p>
</div>
@@ -62,16 +62,16 @@ FRESULT f_chdir (
<div class="para use">
<h4>Example</h4>
<pre>
<span class="c">/* Change current direcoty of the current drive ("dir1" under root directory) */</span>
<span class="c">/* Set current direcoty of the current drive ("dir1" in the root directory) */</span>
<em>f_chdir</em>("/dir1");
<span class="c">/* Change current direcoty of current drive (parent directory of drive 2) */</span>
<span class="c">/* Set current direcoty of drive 2 (parent directory of current directory) */</span>
<em>f_chdir</em>("2:..");
<span class="c">/* Change current direcoty of the drive "sdcard" (at DOS/Windows style volume ID) */</span>
<span class="c">/* Set current direcoty of drive "sdcard" (<tt>FF_STR_VOLUME_ID == 1</tt>) */</span>
<em>f_chdir</em>("sdcard:/dir1");
<span class="c">/* Change current direcoty of the drive "flash" and set it as current drive (at Unix style volume ID) */</span>
<span class="c">/* Set current direcoty of drive "flash" and set this drive current drive (<tt>FF_STR_VOLUME_ID == 2</tt>) */</span>
<em>f_chdir</em>("/flash/dir1");
</pre>
</div>
@@ -82,6 +82,6 @@ FRESULT f_chdir (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/chdrive.html
+1 -1
View File
@@ -64,6 +64,6 @@ FRESULT f_chdrive (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/chmod.html
+1 -1
View File
@@ -83,6 +83,6 @@ FRESULT f_chmod (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/close.html
+1 -1
View File
@@ -59,6 +59,6 @@ FRESULT f_close (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/closedir.html
+1 -1
View File
@@ -58,6 +58,6 @@ FRESULT f_closedir (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/config.html
+22 -17
View File
@@ -35,7 +35,8 @@
<li><a href="#max_lfn">FF_MAX_LFN</a></li>
<li><a href="#lfn_unicode">FF_LFN_UNICODE</a></li>
<li><a href="#lfn_buf">FF_LFN_BUF, FF_SFN_BUF</a></li>
<li><a href="#fs_rpath">FF_FS_RPATH</a></li>
<li><a href="#fs_rpath">FF_RPATH</a></li>
<li><a href="#fs_depth">FF_PATH_DEPTH</a></li>
</ul>
</li>
<li>Volume/Drive Configurations
@@ -56,7 +57,7 @@
<li><a href="#fs_exfat">FF_FS_EXFAT</a></li>
<li><a href="#fs_nortc">FF_FS_NORTC</a></li>
<li><a href="#nortc_time">FF_NORTC_MON, FF_NORTC_MDAY, FF_NORTC_YEAR</a></li>
<li><a href="#fs_ctime">FF_FS_CTIME</a></li>
<li><a href="#fs_ctime">FF_FS_CRTIME</a></li>
<li><a href="#fs_nofsinfo">FF_FS_NOFSINFO</a></li>
<li><a href="#fs_lock">FF_FS_LOCK</a></li>
<li><a href="#fs_reentrant">FF_FS_REENTRANT</a></li>
@@ -170,7 +171,7 @@
</table>
<h4 id="use_lfn">FF_USE_LFN</h4>
<p>This option switches the support for long file name (LFN). When enable the LFN, Unicode support module <tt>ffunicode.c</tt> need to be added to the project. When use stack for the working buffer, take care on stack overflow. When use heap memory for the working buffer, memory management functions (<tt>ff_memalloc</tt> and <tt>ff_memfree</tt>) need to be added to the project.</p>
<p>This option switches the long file name (LFN) extension and which memory to be allocated for the working buffer. When enable the LFN, Unicode support module <tt>ffunicode.c</tt> need to be added to the project. When use stack for the working buffer, take care on stack usage. When use heap memory for the working buffer, memory management functions (<tt>ff_memalloc</tt> and <tt>ff_memfree</tt>) need to be added to the project.</p>
<table class="lst1">
<tr><th>Value</th><th>Description</th></tr>
<tr><td>0</td><td>Disable LFN. Path name in only 8.3 format can be used.</td></tr>
@@ -180,7 +181,7 @@
</table>
<h4 id="max_lfn">FF_MAX_LFN</h4>
<p>LFN function requiers certain internal working buffer for the file name. This option defines size of the buffer and the value can be in range of 12 to 255 characters (actually in UTF-16 code units) of the LFN. The buffer occupies <tt>(FF_MAX_LFN + 1) * 2</tt> bytes and additional <tt>(FF_MAX_LFN + 44) / 15 * 32</tt> bytes when exFAT is enabled. It is recommended to be set 255 to fully support the LFN specification. This option has no effect when LFN is not enabled.</p>
<p>LFN extension requiers a certain internal working buffer for the file name. This option defines size of the buffer and the value can be in range of 12 to 255 characters (actually in UTF-16 code unit) of the LFN. The working buffer occupies <tt>(FF_MAX_LFN + 1) * 2</tt> bytes and additional <tt>(FF_MAX_LFN + 44) / 15 * 32</tt> bytes when exFAT is enabled. It is recommended to be set 255 to fully satisfy the LFN specification. This option has no effect when LFN is not enabled.</p>
<h4 id="lfn_unicode">FF_LFN_UNICODE</h4>
<p>This option switches character encoding for the file name on the API. FatFs supports the code point up to U+10FFFF. This option also affects behavior of string I/O functions (see <tt>FF_STRF_ENCODE</tt>).</p>
@@ -191,7 +192,7 @@
<tr><td>2</td><td>Unicode in UTF-8</td><td>char</td></tr>
<tr><td>3</td><td>Unicode in UTF-32</td><td>DWORD</td></tr>
</table>
<p>When Unicode is selected, <tt>FF_CODE_PAGE</tt> has actually no meaning except for compatibility with legacy systems, such as MS-DOS and any system without support for LFN.</p>
<p>When Unicode is selected, <tt>FF_CODE_PAGE</tt> has actually no meaning except for compatibility with legacy systems, such as MS-DOS and the systems without support for LFN.</p>
<p>When LFN is not enabled, this option has no effect and FatFs works in ANSI/OEM code on the API. For more information, read <a href="filename.html#uni">here</a>.</p>
<h4 id="lfn_buf">FF_LFN_BUF, FF_SFN_BUF</h4>
@@ -203,17 +204,21 @@
<tr><td>Unicode in UTF-16/32</td><td>255 items</td><td>12 items</td></tr>
<tr><td>Unicode in UTF-8</td><td>765 items</td><td>34 items</td></tr>
</table>
<p>If the size of name member is insufficient for the LFN, the item is treated as without LFN. When LFN is not enabled, these options have no effect.</p>
<p>If the size of <tt>fname[]</tt> is insufficient for the LFN, the directory item is treated as without LFN. When LFN is not enabled, these options have no effect.</p>
<h4 id="fs_rpath">FF_FS_RPATH</h4>
<p>This option configures relative path function. For more information, read <a href="filename.html#nam">here</a>.</p>
<h4 id="fs_rpath">FF_RPATH</h4>
<p>This option configures relative path functions. For more information about relative path, read <a href="filename.html#nam">here</a>.</p>
<table class="lst1">
<tr><th>Value</th><th>Description</th></tr>
<tr><td>0</td><td>Disable relative path and remove related functions.</td></tr>
<tr><td>1</td><td>Enable relative path. <tt>f_chdir</tt> and <tt>f_chdrive</tt> function is available.</td></tr>
<tr><td>2</td><td><tt>f_getcwd</tt> function is available in addition to 1</td></tr>
<tr><td>0</td><td>Disable relative path and remove related APIs.</td></tr>
<tr><td>1</td><td>Enable relative path. <tt>f_chdir</tt> and <tt>f_chdrive</tt> are available.</td></tr>
<tr><td>2</td><td><tt>f_getcwd</tt> is available in addition.</td></tr>
</table>
<h4 id="fs_depth">FF_PATH_DEPTH</h4>
<p>This option defines maximum depth of directory in the path name on the exFAT volume. For example, <tt>FF_PATH_DEPTH = 3</tt> will able to follow a path <tt>"/dir1/dir2/dir3/file"</tt> but sub-directories in the <tt>dir3</tt> will not able to be followed and set current directory. This is NOT relevant to FAT/FAT32 volume.</p>
<p>The size of filesystem object (<tt>FATFS</tt>) increases <tt>FF_PATH_DEPTH * 24</tt> bytes to store the current directory path. When <tt>FF_FS_EXFAT == 0</tt> or <tt>FF_FS_RPATH == 0</tt>, this option has no effect.</p>
</div>
@@ -224,12 +229,12 @@
<p>This option configures number of volumes (logical drives up to 10) to be used.</p>
<h4 id="str_volume_id">FF_STR_VOLUME_ID</h4>
<p>This option switches the support for string volume ID. When arbitrary string for the volume ID is enabled for the drive prefix, also pre-defined strings by <tt>FF_VOLUME_STRS</tt> or user defined strings can be used as drive prefix in the path name. Numeric drive number is always valid regardless of this option, and also either format of drive prefix can be enabled by this option.</p>
<p>This option switches the support for string volume ID. When arbitrary string for the volume ID is enabled for the drive prefix, also pre-defined strings by <tt>FF_VOLUME_STRS</tt> or user defined strings can be used as drive prefix in the path name. DOS/Windows style numeric volume ID is always valid regardless of this option, and also either format of drive prefix can be enabled by this option.</p>
<table class="lst2">
<tr><th>Value</th><th>Description</th><th>Example</th></tr>
<tr><td>0</td><td>DOS/Windows style drive prefix in numeric ID.</td><td>1:/filename</td></tr>
<tr><td>1</td><td>0 + DOS/Windows style drive prefix in arbitry string ID.</td><td>flash:/filename</td></tr>
<tr><td>2</td><td>0 + Unix style drive prefix in arbitry string ID.</td><td>/flash/filename</td></tr>
<tr><td>0</td><td>DOS/Windows style drive prefix in numeric ID.</td><td><em>1:</em>/filename</td></tr>
<tr><td>1</td><td>0 + DOS/Windows style drive prefix in arbitry string ID.</td><td><em>flash:</em>/filename</td></tr>
<tr><td>2</td><td>0 + Unix style drive prefix in arbitry string ID.</td><td><em>/flash</em>/filename</td></tr>
</table>
<h4 id="volume_strs">FF_VOLUME_STRS</h4>
@@ -272,7 +277,7 @@ const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb"};
<h4 id="nortc_time">FF_NORTC_MON, FF_NORTC_MDAY, FF_NORTC_YEAR</h4>
<p>This set of options defines the time to be used in no RTC systems. This option has no effect in read-only configuration or <tt>FF_FS_NORTC == 0</tt>.</p>
<h4 id="fs_ctime">FF_FS_CTIME</h4>
<h4 id="fs_ctime">FF_FS_CRTIME</h4>
<p>This option enables (1) or disables (0) to access the file creation time with <tt>FILINFO</tt> structure.</p>
<h4 id="fs_nofsinfo">FF_FS_NOFSINFO</h4>
@@ -302,6 +307,6 @@ const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb"};
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/dinit.html
+1 -1
View File
@@ -40,6 +40,6 @@ DSTATUS disk_initialize (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/dioctl.html
+1 -1
View File
@@ -94,6 +94,6 @@ DRESULT disk_ioctl (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/dread.html
+1 -1
View File
@@ -66,6 +66,6 @@ DRESULT disk_read (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/dstat.html
+1 -1
View File
@@ -42,6 +42,6 @@ DSTATUS disk_status (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/dwrite.html
+1 -1
View File
@@ -69,6 +69,6 @@ DRESULT disk_write (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/eof.html
+1 -1
View File
@@ -56,6 +56,6 @@ int f_eof (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/error.html
+1 -1
View File
@@ -56,6 +56,6 @@ int f_error (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/expand.html
+1 -1
View File
@@ -111,6 +111,6 @@ FRESULT f_expand (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/fattime.html
+1 -1
View File
@@ -73,6 +73,6 @@ DWORD get_fattime (void)
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/fdisk.html
+1 -1
View File
@@ -89,6 +89,6 @@ FRESULT f_fdisk (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/filename.html
+14 -18
View File
@@ -12,12 +12,12 @@
<div class="para doc" id="nam">
<h3>Format of the Path Names</h3>
<p>The format of path name on the FatFs module is similer to the filename specs of DOS/Windos as follows:</p>
<p>The format of path name (path to an object (file or sub-directory)) on the FatFs module is similer to the file name specs of DOS/Windos as follows:</p>
<pre>[<em>drive#</em>:][/]<em>directory</em>/<em>file</em></pre>
<p>The FatFs module supports long file name (LFN) and 8.3 format file name (SFN). The LFN can be used when <tt><a href="config.html#use_lfn">FF_USE_LFN</a> &gt;= 1</tt>. The sub-directories are separated with a <tt>\</tt> or <tt>/</tt> as the same way as DOS/Windows API. Duplicated separator and terminating separator, such as <tt>"/<em>/</em>animal/<em>//</em>cat<em>/</em>"</tt>, are ignored. Only a difference is that the heading drive prefix to specify the <a href="#vol">logical drive</a>, an FAT volume, is in a digit (0-9) + a colon, while it is in an alphabet (A-Z) + a colon in DOS/Windows. The logical drive number is the identifier to specify the volume to be accessed. When drive prefix is omitted, the logical drive number is assumed as <em>default drive</em>.</p>
<p>Control characters (<tt>\0</tt> to <tt>\x1F</tt>) are recognized as end of the path name. In LFN configuration, leading or embedded white spaces in the file name are valid as part of the file name, but the treminating white space and dot of the file name are ignored and truncated. In non-LFN configuration, white space is recognized as end of the path name.</p>
<p>In default configuration (<tt><a href="config.html#fs_rpath">FF_FS_RPATH</a> == 0</tt>), it does not have a concept of current directory like OS oriented filesystem. Every object on the volume is always specified in full path name followed from the root directory. Dot directory names (<tt>".", ".."</tt>) are not allowed. Heading separator is ignored and it can be exist or omitted. The default drive is fixed to drive 0.</p>
<p>When relative path feature is enabled (<tt>FF_FS_RPATH &gt;= 1</tt>), specified path is followed from the root directory if a heading separator is exist. If not, it is followed from the current directory of the default drive. Dot directory name is also allowed for the path name. The current directory is set by <a href="chdir.html"><tt>f_chdir</tt></a> function and the default drive is the current drive set by <a href="chdrive.html"><tt>f_chdrive</tt></a> function.</p>
<p>The FatFs module supports long file name (LFN) and 8.3 format file name (SFN). The LFN can be used when <tt><a href="config.html#use_lfn">FF_USE_LFN</a> &gt;= 1</tt>. The sub-directories are separated with a <tt>\</tt> or <tt>/</tt> as the same way as DOS/Windows API. Duplicated separator and terminating separator, such as <tt>"/<em>/</em>animal/<em>//</em>cat<em>/</em>"</tt>, are ignored. Only a difference is that the heading drive prefix to specify the <a href="#vol">logical drive</a> (FAT volume) is in a digit (0-9) + a colon, while it is in an alphabet (A-Z) + a colon in DOS/Windows API. The logical drive number is the identifier to specify the FAT volume to be accessed. When drive prefix is omitted, the logical drive number is assumed as <em>default drive</em>.</p>
<p>Control characters (<tt>\0</tt> to <tt>\x1F</tt>) are recognized as end of the path name. In LFN configuration, leading or embedded white spaces and dots in the file name are valid as part of the file name, but the treminating white space and dot of the file name are ignored and truncated. In non-LFN configuration, white space is recognized as end of the path name.</p>
<p>In default configuration (<tt><a href="config.html#fs_rpath">FF_FS_RPATH</a> == 0</tt>), it does not have a concept of current directory like OS oriented filesystems. Every object on the volume is always specified in absolute path name that followed from the root directory. Dot directory names (<tt>"." and ".."</tt>) are not allowed. Heading separator is ignored and it can be exist or omitted. The default drive is fixed to drive 0.</p>
<p>When relative path feature is enabled (<tt>FF_FS_RPATH &gt;= 1</tt>), specified path is followed from the root directory if a heading separator is exist. If not, it is followed from the current directory. Dot directory names (not the object but to refer this directory or parent directory) are also allowed for the path name. The current directory is set by <a href="chdir.html"><tt>f_chdir</tt></a> function and the default drive is the current drive set by <a href="chdrive.html"><tt>f_chdrive</tt></a> function.</p>
<table class="lst2">
<tr><td>Path name</td><td>FF_FS_RPATH == 0</td><td>FF_FS_RPATH &gt;= 1</td></tr>
<tr class="lst3"><td>file.txt</td><td>A file in the root directory of the drive 0</td><td>A file in the current directory of the current drive</td></tr>
@@ -27,22 +27,20 @@
<tr><td>2:</td><td>The root directory of the drive 2</td><td>The current directory of the drive 2</td></tr>
<tr><td>2:/</td><td>The root directory of the drive 2</td><td>The root directory of the drive 2</td></tr>
<tr><td>2:file.txt</td><td>A file in the root directory of the drive 2</td><td>A file in the current directory of the drive 2</td></tr>
<tr><td>../file.txt</td><td>Invalid name</td><td>A file in the parent directory</td></tr>
<tr><td>.</td><td>Invalid name</td><td>This directory</td></tr>
<tr><td>..</td><td>Invalid name</td><td>Parent directory of the current directory (*)</td></tr>
<tr><td>dir1/..</td><td>Invalid name</td><td>The current directory</td></tr>
<tr><td>..</td><td>Invalid name</td><td>Parent directory</td></tr>
<tr><td>../file.txt</td><td>Invalid name</td><td>A file in the parent directory</td></tr>
<tr><td>/..</td><td>Invalid name</td><td>The root directory (sticks the top level)</td></tr>
</table>
<p>Also the drive prefix can be in pre-defined arbitrary string. When the option <tt><a href="config.html#str_volume_id">FF_STR_VOLUME_ID</a> == 1</tt>, also arbitrary string volume ID can be used as drive prefix. e.g. <tt>"<em>flash:</em>file1.txt"</tt>, <tt>"<em>ram:</em>temp.dat"</tt> or <tt>"<em>sd:</em>"</tt>. If the srting does not match any volume ID, the function fails with <tt>FR_INVALID_DRIVE</tt>.</p>
<p>When <tt>FF_STR_VOLUME_ID == 2</tt>, Unix style drive prefix can be used. e.g. <tt>"<em>/flash</em>/file1.txt"</tt>, <tt>"<em>/ram</em>/temp.dat"</tt> or <tt>"<em>/sd</em>"</tt>. If a heading separator is exist, it is treated as an absolute path with a heading node ID. Any form as "root directory in current drive" and "current directory in specified drive" cannot be used. Double dot name cannot traverse the volumes such as <tt>"<em>/flash</em>/..<em>/ram</em>/foo.dat"</tt>.</p>
<p><em>Remark: In this revision, double dot name <tt>".."</tt> cannot follow the parent directory on the exFAT volume. It will work as <tt>"."</tt> and stay there.</em></p>
<p>The drive prefix can be in pre-defined arbitrary string. When the option <tt><a href="config.html#str_volume_id">FF_STR_VOLUME_ID</a> == 1</tt>, also arbitrary string volume ID can be used as drive prefix. e.g. <tt>"<em>flash:</em>file1.txt"</tt>, <tt>"<em>ram:</em>temp.dat"</tt> or <tt>"<em>sd:</em>"</tt>. If the srting does not match any volume ID, the function fails with <tt>FR_INVALID_DRIVE</tt>.</p>
<p>When <tt>FF_STR_VOLUME_ID == 2</tt>, Unix style drive prefix can be used. e.g. <tt>"<em>/flash</em>/file1.txt"</tt>, <tt>"<em>/ram</em>/temp.dat"</tt> or <tt>"<em>/sd</em>"</tt>. If a heading separator is exist, it is treated as an absolute path with a heading volume ID. Any form as "root directory in current drive" and "current directory in specified drive" cannot be used. ".." cannot traverse the volumes such as <tt>"<em>/flash</em>/..<em>/ram</em>/foo.dat"</tt>.</p>
</div>
<div class="para doc" id="case">
<h3>Legal Characters and Case Sensitivity</h3>
<p>In the generic FAT filesystems, the legal characters for object name (file/directory name) are, <tt>0-9 A-Z ! # $ % &amp; ' ( ) - @ ^ _ ` { } ~</tt> in ASCII and extended characters <tt>\x80</tt> to <tt>\xFF</tt>. In the FAT filesystems with LFN extention, also <tt>+ , ; = [ ]</tt>, white space and extended characters <tt>U+000080</tt> to <tt>U+10FFFF</tt> are legal for the object name. White spaces and dots can be placed anywhere in the path name except end of the name. Trailing white spaces and dots are ignored.</p>
<p>FAT filesystem is case-insensitive to the object names on the volume. Object names on the FAT volume are compared in case-insensitive. For instance, these three names, <tt>file.txt</tt>, <tt>File.Txt</tt> and <tt>FILE.TXT</tt>, are identical on the FAT filesystem. This is applied to extended charactres as well. When an object is created on the FAT volume, up converted name is recorded to the SFN entry, and the original name is recorded to the LFN entry if LFN extension is enabled.</p>
<p>On the MS-DOS and PC DOS for Chinese, Japanese and Korean (DOS/DBCS), extended characters are recorded to the SFN entry without up-case conversion and compared in case-sensitive. This causes a problem on compatibility with Windows system when the object with extended characters is created on the volume by DOS/DBCS system; therfore the object names with DBCS extended characters should not be used on the FAT volume shared by those systems. FatFs works with case-sensitive to the extended characters in only non-LFN with DBCS configuration (DOS/DBCS specs). However, FatFs works with case-insensitive to the extended character (WindowsNT specs) in LFN configuration.</p>
<p>In the generic FAT filesystems, the legal characters for the object (file or sub-directory) name are, <tt>0-9 A-Z ! # $ % &amp; ' ( ) - @ ^ _ ` { } ~</tt> in ASCII and extended characters <tt>\x80</tt> to <tt>\xFF</tt>. In the FAT filesystems with LFN extention, also <tt>+ , ; = [ ]</tt>, white space and extended characters <tt>U+000080</tt> to <tt>U+10FFFF</tt> are legal for the object name. White spaces and dots can be placed anywhere in the path name except end of the name. Trailing white spaces and dots are ignored.</p>
<p>FAT filesystem is case-insensitive to the object names on the volume. Object names on the FAT volume are compared in case-insensitive. For instance, these three object names, <tt>file.txt</tt>, <tt>File.Txt</tt> and <tt>FILE.TXT</tt>, are identical on the FAT filesystem. This is applied to the extended charactres as well. When an object is created on the FAT volume, up converted name is recorded to the SFN entry, and the original name is recorded to the LFN entry if LFN extension is enabled.</p>
<p>On the MS-DOS and PC DOS for Chinese, Japanese and Korean (DOS/DBCS), extended characters are recorded to the SFN entry without up-case conversion and compared in case-sensitive. This causes a problem on compatibility with Windows system when the file with extended characters is created on the volume by DOS/DBCS system; therfore the object names with DBCS extended characters should not be used on the FAT volume shared by those systems. FatFs works with case-sensitive to the extended characters in only non-LFN with DBCS configuration (DOS/DBCS specs). However, FatFs works with case-insensitive to the extended character (WindowsNT specs) in LFN configuration.</p>
</div>
<div class="para doc" id="uni">
@@ -71,10 +69,8 @@ PARTITION VolToPart[FF_VOLUMES] = {
{0, 3}, <span class="c">/* "2:" ==> 3rd partition on the pd#0 */</span>
{1, 0} <span class="c">/* "3:" ==> pd#1 as removable drive (auto-search) */</span>
};
<img src="../res/f7.png" width="900" height="288" alt="relationship between logical drive and physical drive">
</pre>
<img src="../res/f7.png" width="900" height="288" alt="relationship between logical drive and physical drive">
<p>There are some considerations when enable the multi-partition configuration.</p>
<ul>
<li>The physical drive that hosts two or more mounted partitions should be non-removable, or all volumes on the drive must be unmounted when remove the medium.</li>
@@ -88,6 +84,6 @@ PARTITION VolToPart[FF_VOLUMES] = {
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/findfirst.html
+1 -1
View File
@@ -111,6 +111,6 @@ void find_image_file (void)
<p><tt><a href="findnext.html">f_findnext</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/findnext.html
+1 -1
View File
@@ -63,6 +63,6 @@ FRESULT f_findnext (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/forward.html
+1 -1
View File
@@ -133,6 +133,6 @@ FRESULT play_file (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/getcwd.html
+5 -6
View File
@@ -11,11 +11,11 @@
<div class="para func">
<h2>f_getcwd</h2>
<p>The f_getcwd function retrieves the current directory of the current drive.</p>
<p>The f_getcwd function retrieves the current directory and current drive.</p>
<pre>
FRESULT f_getcwd (
TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Buffer to return path name */</span>
UINT <span class="arg">len</span> <span class="c">/* [IN] The length of the buffer */</span>
UINT <span class="arg">len</span> <span class="c">/* [IN] Buffer length */</span>
);
</pre>
</div>
@@ -24,9 +24,9 @@ FRESULT f_getcwd (
<h4>Parameters</h4>
<dl class="par">
<dt>buff</dt>
<dd>Pointer to the buffer to receive the current directory string.</dd>
<dd>Pointer to the string buffer to receive the current directory path.</dd>
<dt>len</dt>
<dd>Size of the buffer in unit of <tt>TCHAR</tt>.</dd>
<dd>Size of the buffer in unit of <tt>(TCHAR)</tt>.</dd>
</dl>
</div>
@@ -49,7 +49,6 @@ FRESULT f_getcwd (
<div class="para desc">
<h4>Description</h4>
<p>The <tt>f_getcwd</tt> function retrieves full path name of the current directory of the current drive. When <tt><a href="config.html#volumes">FF_VOLUMES</a> &gt;= 2</tt>, a heading drive prefix is added to the path name. The style of drive prefix depends on <tt><a href="config.html#str_volume_id">FF_STR_VOLUME_ID</a></tt>.</p>
<p><em>Note: In this revision, this function cannot retrieve the current directory path on the exFAT volume. It always returns the root directory path.</em></p>
</div>
@@ -77,6 +76,6 @@ FRESULT f_getcwd (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/getfree.html
+1 -1
View File
@@ -87,6 +87,6 @@ FRESULT f_getfree (
<p><tt><a href="sfatfs.html">FATFS</a></tt></p>
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/getlabel.html
+1 -1
View File
@@ -83,6 +83,6 @@ FRESULT f_getlabel (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/gets.html
+1 -1
View File
@@ -59,6 +59,6 @@ TCHAR* f_gets (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/index.html
+11
View File
@@ -0,0 +1,11 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Style-Type" content="text/css">
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="refresh" content="0; url=../">
</head>
<body>
</body>
</html>
documents/doc/lseek.html
+1 -1
View File
@@ -134,6 +134,6 @@ FRESULT f_rewind (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/mkdir.html
+1 -1
View File
@@ -74,6 +74,6 @@ FRESULT f_mkdir (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/mkfs.html
+1 -1
View File
@@ -121,6 +121,6 @@ int main (void)
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/mount.html
+9 -9
View File
@@ -30,11 +30,11 @@ FRESULT f_unmount (
<h4>Parameters</h4>
<dl class="par">
<dt>fs</dt>
<dd>Pointer to the filesystem object to be registered and cleared. Null pointer unregisters the registered filesystem object.</dd>
<dd>Pointer to the filesystem object to be registered and cleared. A null pointer unregisters the registered filesystem object.</dd>
<dt>path</dt>
<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. The string without drive number means the default drive.</dd>
<dt>opt</dt>
<dd>Mounting option. 0: Do not mount now (to be mounted on the first access to the volume), 1: Force mounted the volume to check if it is ready to work.</dd>
<dd>Mounting option. 0: Do not mount now (to be mounted on the first access to the volume), 1: Force mounted the volume to check if it is ready to work. If <tt class="arg">fs</tt> is a NULL, this argument has no meaning.</dd>
</dl>
</div>
@@ -53,7 +53,7 @@ FRESULT f_unmount (
<div class="para desc">
<h4>Description</h4>
<p>FatFs requires work area (<em>filesystem object</em>) for each logical drives (FAT volumes). Prior to perform any file/directory operations, a filesystem object needs to be registered with <tt>f_mount</tt> function for the logical drive. The file/directory API functions get ready to work after this procedure. Some volume management functions, <tt>f_mkfs</tt>, <tt>f_fdisk</tt> and <tt>f_setcp</tt>, do not want a filesystem object.</p>
<p>FatFs requires work area (<em>filesystem object</em>) for each logical drive (FAT volume). Prior to perform file/directory operations, a filesystem object needs to be registered with <tt>f_mount</tt> function for the logical drive. The file/directory API functions get ready to work after this procedure. Some volume management functions, <tt>f_mkfs</tt>, <tt>f_fdisk</tt> and <tt>f_setcp</tt>, do not want a filesystem object.</p>
<p>The <tt>f_mount</tt> function registers/unregisters a filesystem object to the FatFs module as follows:</p>
<ol>
<li>Determines the logical drive which specified by <tt class="arg">path</tt>.</li>
@@ -61,14 +61,14 @@ FRESULT f_unmount (
<li>Clears and registers the new work area to the volume if <tt class="arg">fs</tt> is not NULL.</li>
<li>Performs volume mount process to the volume if forced mounting is specified.</li>
</ol>
<p>If there is any open object of file or directory on the logical drive, the object will be invalidated by this function.</p>
<p>If forced mounting is not specified (<tt>opt = 0</tt>), this function always succeeds regardless of the physical drive status. It only clears (de-initializes) the given work area and registers its address to the internal table and no activity of the physical drive in this function. The volume mount process will be attempted on subsequent file/directroy function if the filesystem object is not initialized. (delayed mounting) The volume mount processes, initialize the corresponding physical drive, find the FAT volume in it and then initialize the work area, is performed in the subsequent file/directory functions when either of following conditions is true.</p>
<p>If there are open objects of file or directory on the logical drive, they will be invalidated by this function.</p>
<p>If forced mounting is not specified (<tt>opt = 0</tt>), this function always succeeds regardless of the physical drive status. It only clears (de-initializes) the given work area and registers its address to the internal table. There is no action to the physical drive in this function. The volume mount process will be attempted on subsequent file/directroy function if the filesystem object is not initialized. (delayed mounting) The volume mount processes, initialize the corresponding physical drive, find the FAT volume in it and then initialize the work area, is performed in the subsequent file/directory functions when either of following conditions is true.</p>
<ul>
<li>Filesystem object has not been initialized. It is de-initialized by <tt>f_mount</tt> function.</li>
<li>Physical drive is not initialized. It is de-initialized by system reset or media removal.</li>
<li>The filesystem object has not been initialized. It is de-initialized by <tt>f_mount</tt> function.</li>
<li>The physical drive is not initialized. It is de-initialized by system reset or media removal.</li>
</ul>
<p>If the function with forced mounting (<tt>opt = 1</tt>) failed with <tt>FR_NOT_READY</tt>, it means that the filesystem object has been registered successfully but the volume is currently not ready to work. The volume mount process will be attempted on subsequent file/directroy function.</p>
<p>If implementation of the disk I/O layer lacks asynchronous media change detection, application program needs to perform <tt>f_mount</tt> function after each media change to force cleared the filesystem object.</p>
<p>If implementation of the disk I/O layer lacks asynchronous media change detection, the application program needs to perform <tt>f_mount</tt> function after each media change to force cleared the filesystem object.</p>
<p>To unregister the work area, specify a NULL to the <tt class="arg">fs</tt>, and then the work area can be discarded. <tt>f_unmount</tt> function is implemented as a macro.</p>
<pre>
#define <em>f_unmount</em>(path) f_mount(0, path, 0)
@@ -116,6 +116,6 @@ int main (void)
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/open.html
+1 -1
View File
@@ -180,6 +180,6 @@ int main (void)
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/opendir.html
+1 -1
View File
@@ -69,6 +69,6 @@ FRESULT f_opendir (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/printf.html
+1 -1
View File
@@ -109,6 +109,6 @@ int f_printf (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/putc.html
+1 -1
View File
@@ -54,6 +54,6 @@ int f_putc (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/puts.html
+1 -1
View File
@@ -55,6 +55,6 @@ int f_puts (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/rc.html
+18 -17
View File
@@ -17,7 +17,7 @@
<dd>The function succeeded.</dd>
<dt id="de">FR_DISK_ERR</dt>
<dd>The lower layer, <tt>disk_read</tt>, <tt>disk_write</tt> or <tt>disk_ioctl</tt> function, reported that an unrecoverable hard error occured.<br>Note that if once this error occured at any operation to an open file, the file object is aborted and any operations to the file except for close will be rejected.</dd>
<dd>The lower layer, <tt>disk_read</tt>, <tt>disk_write</tt> or <tt>disk_ioctl</tt> function, reported that an unrecoverable hard error occured.<br>Note that if once this error occured in the operation to an open file, the file object is aborted and any operations to the file except <tt>f_close</tt> will be rejected.</dd>
<dt id="ie">FR_INT_ERR</dt>
<dd>Assertion failed and an insanity is detected in the internal process. One of the following possibilities is suspected.
@@ -27,7 +27,7 @@
<li>There is a bug in the FatFs module itself.</li>
<li>Wrong lower layer implementation.</li>
</ul>
Note that if once this error occured in the operation to an open file, the file object is aborted and any operation to the file except for close will be rejected.
Note that if once this error occured in the operation to an open file, the file object is aborted and any operation to the file except <tt>f_close</tt> will be rejected.
</dd>
<dt id="nr">FR_NOT_READY</dt>
@@ -44,14 +44,14 @@ Note that if once this error occured in the operation to an open file, the file
<dd>Could not find the file in the directory.</dd>
<dt id="np">FR_NO_PATH</dt>
<dd>Could not find the path. A directory in the path name could not be found.</dd>
<dd>Could not follow the path. A sub-directory in the path name could not be found.</dd>
<dt id="in">FR_INVALID_NAME</dt>
<dd>The given string is invalid as a <a href="filename.html">path name</a>. One of the following possibilities is suspected.
<ul>
<li>There is a character not allowed for the file name.</li>
<li>There is a character not allowed for the file name .</li>
<li>The file name is out of 8.3 format. (at non-LFN cfg.)</li>
<li><tt>FF_MAX_LFN</tt> is insufficient for the file name. (at LFN cfg.)</li>
<li><tt>FF_MAX_LFN</tt> is insufficient for the length of file name. (at LFN cfg.)</li>
<li>There is a character encoding error in the string.</li>
</ul>
</dd>
@@ -59,30 +59,30 @@ Note that if once this error occured in the operation to an open file, the file
<dt id="dn">FR_DENIED</dt>
<dd>The required access was denied due to one of the following reasons:
<ul>
<li>Write mode open against the read-only file. (f_open)</li>
<li>Deleting the read-only file or directory. (f_unlink)</li>
<li>Deleting the non-empty directory or current directory. (f_unlink)</li>
<li>Reading the file opened without <tt>FA_READ</tt> flag. (f_read)</li>
<li>Any modification to the file opened without <tt>FA_WRITE</tt> flag. (f_write, f_truncate, f_expand)</li>
<li>Could not create the object due to root directory full or disk full. (f_open, f_mkdir)</li>
<li>Could not find a contiguous area for the file. (f_expand)</li>
<li>Write mode open against the read-only file. (<tt>f_open</tt>)</li>
<li>Deleting the read-only file or directory. (<tt>f_unlink</tt>)</li>
<li>Deleting the non-empty directory or current directory. (<tt>f_unlink</tt>)</li>
<li>Reading the file opened without <tt>FA_READ</tt> flag. (<tt>f_read</tt>)</li>
<li>Any modification to the file opened without <tt>FA_WRITE</tt> flag. (<tt>f_write, f_truncate, f_expand</tt>)</li>
<li>Could not create the object due to root directory full or disk full. (<tt>f_open, f_mkdir</tt>)</li>
<li>Could not find a contiguous data area for the file. (<tt>f_expand</tt>)</li>
</ul>
</dd>
<dt id="ex">FR_EXIST</dt>
<dd>Name collision. An object with the same name is already existing in the directory.</dd>
<dd>Name collision. A file or sub-directory with the same name is already existing in the directory.</dd>
<dt id="io">FR_INVALID_OBJECT</dt>
<dd>The file/directory object is invalid or the pointer is null. There are some reasons as follows:
<ul>
<li>The file/directory has been closed.</li>
<li>The file/directory object has been closed.</li>
<li>The file/directory object has been invalidated or the structure has been collapsed. Open objects on the volume will be invalidated by a voulme mount process.</li>
<li>Physical drive is not ready to work due to a media removal.</li>
</ul>
</dd>
<dt id="wp">FR_WRITE_PROTECTED</dt>
<dd>A write mode operation against the write-protected media.</dd>
<dd>A write mode operation against the write-protected medium.</dd>
<dt id="id">FR_INVALID_DRIVE</dt>
<dd>Invalid drive number is specified in the path name or a null pointer is given as the path name. (Related option: <tt><a href="config.html#volumes">FF_VOLUMES</a></tt>)</dd>
@@ -111,13 +111,14 @@ Note that if once this error occured in the operation to an open file, the file
<dd>The function was canceled due to a timeout of <a href="appnote.html#reentrant">thread-safe control</a>. (Related option: <tt><a href="config.html#timeout">FF_TIMEOUT</a></tt>)</dd>
<dt id="lo">FR_LOCKED</dt>
<dd>The operation to the object was rejected by <a href="appnote.html#dup">file sharing control</a>. (Related option: <tt><a href="config.html#fs_lock">FF_FS_LOCK</a></tt>)</dd>
<dd>The operation to the file or sub-directory was rejected by <a href="appnote.html#dup">file sharing control</a>. (Related option: <tt><a href="config.html#fs_lock">FF_FS_LOCK</a></tt>)</dd>
<dt id="nc">FR_NOT_ENOUGH_CORE</dt>
<dd>Not enough memory for the operation. There is one of the following reasons:
<ul>
<li>Could not allocate a memory for LFN working buffer. (Related option: <tt><a href="config.html#use_lfn">FF_USE_LFN</a></tt>)</li>
<li>Size of the given buffer is insufficient for the size required.</li>
<li><tt><a href="config.html#fs_depth">FF_PATH_DEPTH</a></tt> is insufficient to follow the deep path. (on exFAT volume)</li>
</ul>
</dd>
@@ -129,6 +130,6 @@ Note that if once this error occured in the operation to an open file, the file
</dl>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/read.html
+1 -1
View File
@@ -74,6 +74,6 @@ FRESULT f_read (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/readdir.html
+1 -1
View File
@@ -168,6 +168,6 @@ int main (void)
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/rename.html
+7 -5
View File
@@ -24,9 +24,9 @@ FRESULT f_rename (
<h4>Parameters</h4>
<dl class="par">
<dt>old_name</dt>
<dd>Pointer to a null-terminated string that specifies the existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd>
<dd>Pointer to the null-terminated string that specifies the existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd>
<dt>new_name</dt>
<dd>Pointer to a null-terminated string that specifies the new object name. A drive number may be specified in this string but it is ignored and assumed as the same drive of the <tt class="arg">old_name</tt>. Any object with this path name except <tt class="arg">old_name</tt> must not be exist, or the function fails with <tt>FR_EXIST</tt>.</dd>
<dd>Pointer to the null-terminated string that specifies the new object name. A drive number may be specified in this string but it is ignored and assumed as the same drive of the <tt class="arg">old_name</tt>. Any object with this name except <tt class="arg">old_name</tt> must not be exist, or the function fails with <tt>FR_EXIST</tt>.</dd>
</dl>
</div>
@@ -55,7 +55,9 @@ FRESULT f_rename (
<div class="para desc">
<h4>Description</h4>
<p>Renames a file or sub-directory and can also move it to other directory in the same volume. The object to be renamed must not be an open object, or <em>the FAT volume can be collapsed</em>. Such the wrong operation is rejected safely when <a href="appnote.html#dup">file lock function</a> is enabled.</p>
<p>Renames a file or sub-directory and can also move it to another directory in the same volume. The file to be renamed must not be an open file, or <em>the FAT volume can be collapsed</em>. Such the wrong file renaming is rejected safely when <a href="appnote.html#dup">file lock function</a> is enabled.</p>
<p>Any sub-directory in the current directory path should not be renamed. It will be rejected on the exFAT volume but succeeds on the FAT/FAT32 volume.</p>
<p><em>Remark: Be careful in moving a sub-directory. The sub-directory must not be moved into itself and any sub-directory in it, or the moved sub-directory will be lost.</em></p>
</div>
@@ -74,12 +76,12 @@ FRESULT f_rename (
<span class="c">/* Rename an object in the drive 2 */</span>
<em>f_rename</em>("2:oldname.txt", "newname.txt");
<span class="c">/* Rename an object and move it to another directory in the drive */</span>
<span class="c">/* Rename an object and move it into another directory in the drive */</span>
<em>f_rename</em>("log.txt", "old/log0001.txt");
</pre>
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/sdir.html
+3 -3
View File
@@ -14,7 +14,7 @@
<p>The <tt>DIR</tt> structure is used for the work area to read a directory by <tt>f_oepndir</tt>, <tt>f_readdir</tt>, <tt>f_findfirst</tt> and <tt>f_findnext</tt> function. Application program <em>must not</em> modify any member in this structure, or <tt>f_readdir</tt> function will not work properly.</p>
<pre>
<span class="k">typedef</span> <span class="k">struct</span> {
FFOBJID obj; <span class="c">/* Object identifier */</span>
<a href="sobjid.hrml">FFOBJID</a> obj; <span class="c">/* Object identifier */</span>
DWORD dptr; <span class="c">/* Current read/write offset */</span>
DWORD clust; <span class="c">/* Current cluster */</span>
LBA_t sect; <span class="c">/* Current sector */</span>
@@ -25,13 +25,13 @@
WCHAR* lfn; <span class="c">/* Pointer to the LFN working buffer (in/out) */</span>
<span class="k">#endif</span>
<span class="k">#if</span> FF_USE_FIND
const TCHAR* pat; <span class="c">/* Ponter to the matching pattern */</span>
const TCHAR* pat; <span class="c">/* Ponter to the matching pattern */</span>
<span class="k">#endif</span>
} DIR;
</pre>
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/setcp.html
+1 -1
View File
@@ -75,6 +75,6 @@ FRESULT f_setcp (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/setlabel.html
+1 -1
View File
@@ -88,6 +88,6 @@ FRESULT f_setlabel (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/sfatfs.html
+16 -15
View File
@@ -15,7 +15,8 @@
<pre>
<span class="k">typedef</span> <span class="k">struct</span> {
BYTE fs_type; <span class="c">/* FAT type (0, FS_FAT12, FS_FAT16, FS_FAT32 or FS_EXFAT) */</span>
BYTE pdrv; <span class="c">/* Hosting physical drive of this volume */</span>
BYTE pdrv; <span class="c">/* Physical drive that holds this volume */</span>
BYTE ldrv; <span class="c">/* Logical drive number (used only when FF_FS_REENTRANT) */</span>
BYTE n_fats; <span class="c">/* Number of FAT copies (1,2) */</span>
BYTE wflag; <span class="c">/* win[] flag (b0:win[] is dirty) */</span>
BYTE fsi_flag; <span class="c">/* FSINFO flags (b7:Disabled, b0:Dirty) */</span>
@@ -25,36 +26,36 @@
<span class="k">#if</span> FF_MAX_SS != FF_MIN_SS
WORD ssize; <span class="c">/* Sector size (512,1024,2048 or 4096) */</span>
<span class="k">#endif</span>
<span class="k">#if</span> FF_FS_EXFAT
BYTE* dirbuf; <span class="c">/* Directory entry block scratchpad buffer */</span>
<span class="k">#endif</span>
<span class="k">#if</span> FF_FS_REENTRANT
FF_SYNC_t sobj; <span class="c">/* Identifier of sync object */</span>
<span class="k">#if</span> FF_USE_LFN
WCHAR* lfnbuf; <span class="c">/* Pointer to LFN working buffer */</span>
<span class="k">#endif</span>
<span class="k">#if</span> !FF_FS_READONLY
DWORD last_clust; <span class="c">/* FSINFO: Last allocated cluster (0xFFFFFFFF if invalid) */</span>
DWORD free_clust; <span class="c">/* FSINFO: Number of free clusters (0xFFFFFFFF if invalid) */</span>
DWORD last_clust; <span class="c">/* FSINFO: Last allocated cluster (invalid if &gt;=n_fatent) */</span>
DWORD free_clust; <span class="c">/* FSINFO: Number of free clusters (invalid if &gt;=fs->n_fatent-2) */</span>
<span class="k">#endif</span>
<span class="k">#if</span> FF_FS_RPATH
DWORD cdir; <span class="c">/* Cluster number of current directory (0:root) */</span>
<span class="k">#if</span> FF_FS_EXFAT
DWORD cdc_scl; <span class="c">/* Containing directory start cluster (invalid when cdir is 0) */</span>
DWORD cdc_size; <span class="c">/* b31-b8:Size of containing directory, b7-b0: Chain status */</span>
DWORD cdc_ofs; <span class="c">/* Offset in the containing directory (invalid when cdir is 0) */</span>
<span class="k">#endif</span>
<span class="k">#endif</span>
DWORD n_fatent; <span class="c">/* Number of FAT entries (Number of clusters + 2) */</span>
DWORD fsize; <span class="c">/* Sectors per FAT */</span>
LBA_t winsect; <span class="c">/* Sector LBA appearing in the win[] */</span>
LBA_t volbase; <span class="c">/* Volume base LBA */</span>
LBA_t fatbase; <span class="c">/* FAT base LBA */</span>
LBA_t dirbase; <span class="c">/* Root directory base (LBA|Cluster) */</span>
LBA_t database; <span class="c">/* Data base LBA */</span>
LBA_t winsect; <span class="c">/* Sector LBA appearing in the win[] */</span>
<span class="k">#if</span> FF_FS_EXFAT
LBA_t bitbase; <span class="c">/* Allocation bitmap base sector */</span>
BYTE* dirbuf; <span class="c">/* Directory entry block scratchpad buffer */</span>
<span class="k">#if</span> FF_FS_RPATH
<a href="sxcwds.html">FFXCWDS</a> xcwds; <span class="c">/* Current working directory structure */</span>
FFXCWDS xcwds2; <span class="c">/* Working buffer to follow the path */</span>
<span class="k">#endif</span>
<span class="k">#endif</span>
BYTE win[FF_MAX_SS]; <span class="c">/* Disk access window for directory, FAT (and file data at tiny cfg) */</span>
} FATFS;
</pre>
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/sfile.html
+8 -8
View File
@@ -15,18 +15,18 @@
<pre>
<span class="k">typedef</span> <span class="k">struct</span> {
FFOBJID obj; <span class="c">/* Object identifier */</span>
BYTE flag; <span class="c">/* File object status flags */</span>
<a href="sobjid.html">FFOBJID</a> obj; <span class="c">/* Object identifier */</span>
BYTE flag; <span class="c">/* File status flags */</span>
BYTE err; <span class="c">/* Abort flag (error code) */</span>
FSIZE_t fptr; <span class="c">/* File read/write pointer (Byte offset origin from top of the file) */</span>
DWORD clust; <span class="c">/* Current cluster of fptr (One cluster behind if fptr is on the cluster boundary. Invalid if fptr == 0.) */</span>
LBA_t sect; <span class="c">/* Current data sector (Can be invalid if fptr is on the cluster boundary.)*/</span>
FSIZE_t fptr; <span class="c">/* File read/write pointer (byte offset origin from top of the file; 0 on open) */</span>
DWORD clust; <span class="c">/* Current cluster of fptr (one cluster behind if fptr is on the cluster boundary; invalid if fptr == 0) */</span>
LBA_t sect; <span class="c">/* Current data sector (can be invalid if fptr is on the cluster boundary)*/</span>
<span class="k">#if</span> !FF_FS_READONLY
LBA_t dir_sect; <span class="c">/* Sector number containing the directory entry */</span>
BYTE* dir_ptr; <span class="c">/* Ponter to the directory entry in the window */</span>
BYTE* dir_ptr; <span class="c">/* Pointer to the directory entry in the window */</span>
<span class="k">#endif</span>
<span class="k">#if</span> FF_USE_FASTSEEK
DWORD* cltbl; <span class="c">/* Pointer to the cluster link map table (Nulled on file open. Set by application.) */</span>
DWORD* cltbl; <span class="c">/* Pointer to the cluster link map table (nulled on file open; set by application) */</span>
<span class="k">#endif</span>
<span class="k">#if</span> !FF_FS_TINY
BYTE buf[FF_MAX_SS]; <span class="c">/* File private data transfer buffer (Always valid if fptr is not on the sector boundary but can be invalid if fptr is on the sector boundary.) */</span>
@@ -37,6 +37,6 @@
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/sfileinfo.html
+7 -7
View File
@@ -14,14 +14,14 @@
<p>The <tt>FILINFO</tt> structure holds information about the object retrieved by <tt>f_readdir</tt>, <tt>f_findfirst</tt>, <tt>f_findnext</tt> and <tt>f_stat</tt> function. Be careful in the size of structure when LFN is enabled.</p>
<pre>
<span class="k">typedef struct</span> {
FSIZE_t fsize; <span class="c">/* File size */</span>
WORD fdate; <span class="c">/* Last modified date */</span>
WORD ftime; <span class="c">/* Last modified time */</span>
FSIZE_t fsize; <span class="c">/* File size (invalid for directory) */</span>
WORD fdate; <span class="c">/* Date of file modification or directory creation */</span>
WORD ftime; <span class="c">/* Time of file modification or directory creation */</span>
<span class="k">#if</span> FF_FS_CRTIME
WORD crdate; <span class="c">/* Created date */</span>
WORD crtime; <span class="c">/* Created time */</span>
WORD crdate; <span class="c">/* Date of object createion */</span>
WORD crtime; <span class="c">/* Time of object createion */</span>
<span class="k">#endif</span>
BYTE fattrib; <span class="c">/* Attribute */</span>
BYTE fattrib; <span class="c">/* Object attribute */</span>
<span class="k">#if</span> FF_USE_LFN
TCHAR altname[FF_SFN_BUF + 1]; <span class="c">/* Alternative object name */</span>
TCHAR fname[FF_LFN_BUF + 1]; <span class="c">/* Primary object name */</span>
@@ -82,6 +82,6 @@
</dl>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/size.html
+1 -1
View File
@@ -56,6 +56,6 @@ FSIZE_t f_size (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/sobjid.html
+42
View File
@@ -0,0 +1,42 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - FFOBJID</title>
</head>
<body>
<div class="para">
<h2>FFOBJID</h2>
<p>The <tt>FFOBJID</tt> structure is an object identifier that holds the common status of open objects. This structure is for only internal use and it does not appear on the API.</p>
<pre>
<span class="k">typedef</span> <span class="k">struct</span> {
FATFS* fs; <span class="c">/* Pointer to the volume holds this object */</span>
WORD id; <span class="c">/* Volume mount ID when this object was opened */</span>
BYTE attr; <span class="c">/* Object attribute */</span>
BYTE stat; <span class="c">/* Object chain status (exFAT: b1-0: =0:not contiguous, =2:contiguous, =3:fragmented in this session, b2:sub-directory stretched) */</span>
DWORD sclust; <span class="c">/* Object data cluster (0:no data or root directory) */</span>
FSIZE_t objsize; <span class="c">/* Object size (valid when sclust != 0) */</span>
<span class="k">#if</span> FF_FS_EXFAT
DWORD n_cont; <span class="c">/* Size of first fragment - 1 (valid when stat == 3) */</span>
DWORD n_frag; <span class="c">/* Size of last fragment needs to be written to FAT (valid when not zero) */</span>
DWORD c_scl; <span class="c">/* Cluster of directory holds this object (valid when sclust != 0) */</span>
DWORD c_size; <span class="c">/* Size of directory holds this object (b7-b0: allocation status, valid when c_scl != 0) */</span>
DWORD c_ofs; <span class="c">/* Offset of entry of this object in the directory */</span>
<span class="k">#endif</span>
<span class="k">#if</span> FF_FS_LOCK
UINT lockid; <span class="c">/* File lock ID origin from 1 (index of file semaphore table Files[]) */</span>
<span class="k">#endif</span>
} FFOBJID;
</pre>
</div>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/stat.html
+1 -1
View File
@@ -107,6 +107,6 @@ FRESULT f_stat (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/sxcwds.html
+31
View File
@@ -0,0 +1,31 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - FFXCWDS</title>
</head>
<body>
<div class="para">
<h2>FFXCWDS</h2>
<p>The <tt>FFXCWDS</tt> structure holds a current working directory path. It is defined and used only when <tt>FF_FS_EXFAT == 1 &amp;&amp; FF_FS_RPATH != 0</tt>. This structure is for only internal use and it does not appear on the API.</p>
<pre>
<span class="k">typedef struct</span> {
DWORD d_scl; <span class="c">/* Directory start cluster (0:root dir) */</span>
DWORD d_size; <span class="c">/* Size of directory (b7-b0: cluster chain status) (invalid if d_scl == 0) */</span>
DWORD nxt_ofs; <span class="c">/* Offset of entry of next dir in this directory (invalid if last link) */</span>
} FFXCWDL;
<span class="k">typedef struct</span> {
UINT depth; <span class="c">/* Current directory depth (0:root dir) */</span>
FFXCWDL tbl[FF_PATH_DEPTH + 1]; <span class="c">/* Directory chain of current directory path */</span>
} FFXCWDS;
</pre>
</div>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/sync.html
+1 -1
View File
@@ -82,6 +82,6 @@ S - f_sync()
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/tell.html
+1 -1
View File
@@ -56,6 +56,6 @@ FSIZE_t f_tell (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/truncate.html
+1 -1
View File
@@ -59,6 +59,6 @@ FRESULT f_truncate (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/unlink.html
+1 -1
View File
@@ -67,6 +67,6 @@ If condition of the object to be removed is applicable to the following terms, t
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/utime.html
+1 -1
View File
@@ -95,6 +95,6 @@ FRESULT set_timestamp (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
documents/doc/write.html
+1 -1
View File
@@ -74,6 +74,6 @@ FRESULT f_write (
</div>
<p class="foot"><a href="../00index_e.html">Return</a></p>
<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>