FatFs R0.11a, released September 5, 2015

2015-10-19 08:53:27 -07:00
parent 095cc0fc01
commit 95374bbf12
81 changed files with 5038 additions and 4673 deletions
@@ -43,18 +43,18 @@ The FatFs module assumes that size of char/short/long are 8/16/32 bit and int is
 <p>The dependency diagram shown below is a typical configuration of the embedded system with FatFs module.</p>
 <p><img src="../img/modules.png" width="580" height="280" alt="dependency diagram"></p>
 <p>(a) If a working disk module with FatFs API is provided, no additional function is needed. (b) To attach existing disk drivers with different API, glue functions are needed to translate the APIs between FatFs and the drivers.</p>
-<p><img src="../img/funcs.png" width="680" height="430" alt="functional diagram"></p>
+<p><img src="../img/funcs.png" width="680" height="420" alt="functional diagram"></p>

 <h4>Which function is required?</h4>
-<p>You need to provide only low level disk I/O functions that required by FatFs module and nothing else. If a working disk module for the target system is already existing, you need to write only glue functions to attach it to the FatFs module. If not, you need to port any other disk module or write it from scratch. Most of defined functions are not that always required. For example, disk write function is not required at read-only configuration. Following table shows which function is required depends on configuration options.</p>
+<p>You need to provide only low level disk I/O functions that required by FatFs module and nothing else. If a working disk module for the target system is already existing, you need to write only glue functions to attach it to the FatFs module. If not, you need to port any other disk module or write it from scratch. Most of defined functions are not that always required. For example, disk write function is not required at read-only configuration. Following table shows which function is required depends on the configuration options.</p>
 <table class="lst2">
-<tr><th>Function</th><th>Required when:</th><th>Note</th></tr>
+<tr><th>Function</th><th>Required when</th><th>Note</th></tr>
 <tr><td>disk_status<br>disk_initialize<br>disk_read</td><td>Always</td><td rowspan="5">Disk I/O functions.<br>Samples available in ffsample.zip.<br>There are many implementations on the web.</td></tr>
 <tr><td>disk_write<br>get_fattime<br>disk_ioctl (CTRL_SYNC)</td><td>_FS_READONLY == 0</td></tr>
 <tr><td>disk_ioctl (GET_SECTOR_COUNT)<br>disk_ioctl (GET_BLOCK_SIZE)</td><td>_USE_MKFS == 1</td></tr>
 <tr><td>disk_ioctl (GET_SECTOR_SIZE)</td><td>_MAX_SS != _MIN_SS</td></tr>
 <tr><td>disk_ioctl (CTRL_TRIM)</td><td>_USE_TRIM == 1</td></tr>
-<tr><td>ff_convert<br>ff_wtoupper</td><td>_USE_LFN &gt;= 1</td><td>Unicode support functions.<br>Available in option/unicode.c.</td></tr>
+<tr><td>ff_convert<br>ff_wtoupper</td><td>_USE_LFN != 0</td><td>Unicode support functions.<br>Just add option/unicode.c to the project.</td></tr>
 <tr><td>ff_cre_syncobj<br>ff_del_syncobj<br>ff_req_grant<br>ff_rel_grant</td><td>_FS_REENTRANT == 1</td><td rowspan="2">O/S dependent functions.<br>Samples available in option/syscall.c.</td></tr>
 <tr><td>ff_mem_alloc<br>ff_mem_free</td><td>_USE_LFN == 3</td></tr>
 </table>
@@ -75,6 +75,7 @@ The FatFs module assumes that size of char/short/long are 8/16/32 bit and int is

 <div class="para doc" id="memory">
 <h3>Memory Usage</h3>
+<p>The memory usage varies depends on the <a href="config.html">configuration options</a>.</p>
 <table class="lst2">
 <tr><th></th><th>ARM7<small><br>32bit</small></th><th>ARM7<small><br>Thumb</small></th><th>CM3<small><br>Thumb-2</small></th><th>AVR</th><th>H8/300H</th><th>PIC24</th><th>RL78</th><th>V850ES</th><th>SH-2A</th><th>RX600</th><th>IA-32</th></tr>
 <tr class="cal">     <td>Compiler</td><td>GCC</td><td>GCC</td><td>GCC</td><td>GCC</td><td>CH38</td><td>C30</td><td>CC78K0R</td><td>CA850</td><td>SHC</td><td>RXC</td><td>VC6</td></tr>
@@ -100,9 +101,9 @@ _WORD_ACCESS   0 or 1 (Set for 1 if possible)

 <div class="para doc" id="reduce">
 <h3>Module Size Reduction</h3>
-<p>Follwing table shows which API function is removed by configuration options for the module size reduction. To use any API function, the row must be clear.</p>
+<p>Follwing table shows which API function is removed by configuration options for the module size reduction. To use any API function, the row of the function must be clear.</p>
 <table class="lst2">
-<tr><td rowspan="2">Function</td><td colspan="4">_FS_MINIMIZE</td><td colspan="2">_FS_READONLY</td><td colspan="2">_USE_STRFUNC</td><td colspan="3">_FS_RPATH</td><td colspan="2">_USE_FIND</td><td colspan="2">_FS_LABEL</td><td colspan="2">_USE_MKFS</td><td colspan="2">_USE_FORWARD</td><td colspan="2">_MULTI_PARTITION</td></tr>
+<tr><td rowspan="2">Function</td><td colspan="4">_FS_MINIMIZE</td><td colspan="2">_FS_READONLY</td><td colspan="2">_USE_STRFUNC</td><td colspan="3">_FS_RPATH</td><td colspan="2">_USE_FIND</td><td colspan="2">_USE_LABEL</td><td colspan="2">_USE_MKFS</td><td colspan="2">_USE_FORWARD</td><td colspan="2">_MULTI_PARTITION</td></tr>
 <tr><td>0</td><td>1</td><td>2</td><td>3</td><td>0</td><td>1</td><td>0&nbsp;&nbsp;</td><td>1/2</td><td>0</td><td>1</td><td>2</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td><td>0</td><td>1</td></tr>
 <tr class="lst3"><td>f_mount</td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
 <tr><td>f_open</td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
@@ -141,15 +142,15 @@ _WORD_ACCESS   0 or 1 (Set for 1 if possible)

 <div class="para doc" id="lfn">
 <h3>Long File Name</h3>
-<p>FatFs module supports LFN (long file name). The two different file names, SFN (short file name) and LFN, of a file is transparent on the API except for <tt>f_readdir</tt> function. The LFN feature is disabled by default. To enable it, set <tt>_USE_LFN</tt> to 1, 2 or 3, and add <tt>option/unicode.c</tt> to the project. The LFN feature requiers a certain working buffer in addition. The buffer size can be configured by <tt>_MAX_LFN</tt> according to the available memory. The length of an LFN will reach up to 255 characters, so that the <tt>_MAX_LFN</tt> should be set to 255 for full featured LFN operation. If the size of working buffer is insufficient for the input file name, the file function fails with <tt>FR_INVALID_NAME</tt>. When enable the LFN feature under re-entrant configuration, <tt>_USE_LFN</tt> must be set to 2 or 3. In this case, the file function allocates the working buffer on the stack or heap. The working buffer occupies <tt>(_MAX_LFN + 1) * 2</tt> bytes.</p>
+<p>FatFs module supports LFN (long file name). The two different file names, SFN (short file name) and LFN, of a file is transparent on the API except for <tt>f_readdir</tt> function. The LFN feature is disabled by default. To enable it, set <tt><a href="config.html#use_lfn">_USE_LFN</a></tt> to 1, 2 or 3, and add <tt>option/unicode.c</tt> to the project. The LFN feature requiers a certain working buffer in addition. The buffer size can be configured by <tt><a href="config.html#max_lfn">_MAX_LFN</a></tt> according to the available memory. The length of an LFN will reach up to 255 characters, so that the <tt>_MAX_LFN</tt> should be set to 255 for full featured LFN operation. If the size of working buffer is insufficient for the input file name, the file function fails with <tt>FR_INVALID_NAME</tt>. When use any re-entry to the API with the LFN feature, <tt>_USE_LFN</tt> must be set to 2 or 3. In this case, the file function allocates the working buffer on the stack or heap. The working buffer occupies <tt>(_MAX_LFN + 1) * 2</tt> bytes.</p>
 <table class="lst2 rset">
-<caption>LFN cfg. at CM3</caption>
-<tr><th><tt>_CODE_PAGE</tt></th><th>Extra code</th></tr>
+<caption>LFN cfg. at CM3/gcc</caption>
+<tr><th><tt>_CODE_PAGE</tt></th><th>Code size</th></tr>
 <tr><td>SBCS</td><td>+2.8K</td></tr>
-<tr><td>932(Shift_JIS)</td><td>+62.6k</td></tr>
-<tr><td>936(GBK)</td><td>+177k</td></tr>
+<tr><td>932(Japanese)</td><td>+62.6k</td></tr>
+<tr><td>936(Simplified Chinese)</td><td>+177k</td></tr>
 <tr><td>949(Korean)</td><td>+139k</td></tr>
-<tr><td>950(Big5)</td><td>+111k</td></tr>
+<tr><td>950(Traditional Chinese)</td><td>+111k</td></tr>
 </table>
 <p>When the LFN feature is enabled, the module size will be increased depends on the configured code page. Right table shows how much code size increased when LFN feature is enabled with some code pages. Especially, in the CJK region, tens of thousands of characters are being used. Unfortunately, it requires a huge OEM-Unicode bidirectional conversion table and the module size will be drastically increased as shown in the table. As the result, the FatFs with LFN feature with those code pages will not able to be implemented to most 8-bit microcontrollers.</p>
 <p>Note that the LFN feature on the FAT file system is a patent of Microsoft Corporation. This is not the case on FAT32 but most FAT32 drivers come with the LFN feature. FatFs can swich the LFN feature on/off by configuration option. When enable LFN feature on the commercial products, a license from Microsoft may be required depends on the final destination.</p>
@@ -157,21 +158,22 @@ _WORD_ACCESS   0 or 1 (Set for 1 if possible)

 <div class="para doc" id="unicode">
 <h3>Unicode API</h3>
-<p>By default, FatFs uses ANSI/OEM code set on the API under LFN configuration. FatFs can also switch the character encoding to Unicode on the API by <tt>_LFN_UNICODE</tt> option. This means that the FatFs supports the True-LFN feature. For more information, refer to the description in the <a href="filename.html#uni">file name</a>.</p>
+<p>By default, FatFs uses ANSI/OEM code set on the API even at LFN configuration. FatFs can also switch the character encoding on the API to Unicode by <tt><a href="config.html#lfn_unicode">_LFN_UNICODE</a></tt> option. This means that the FatFs supports the True-LFN feature. For more information, refer to the description in the <a href="filename.html#uni">file name</a>.</p>
 </div>

 <div class="para doc" id="reentrant">
 <h3>Re-entrancy</h3>
-<p>The file operations to the different volume is always re-entrant and can work simultaneously. The file operations to the same volume is not re-entrant but it can also be configured to thread-safe by <tt>_FS_REENTRANT</tt> option. In this case, also the OS dependent synchronization object control functions, <tt>ff_cre_syncobj/ff_del_syncobj/ff_req_grant/ff_rel_grant</tt>, must be added to the project. There are some examples in the <tt>option/syscall.c</tt>.</p>
-<p>When a file function is called while the volume is in use by any other task, the file function is suspended until that task leaves the file function. If wait time exceeded a period defined by <tt>_TIMEOUT</tt>, the file function will abort with <tt>FR_TIMEOUT</tt>. The timeout feature might not be supported by some RTOS.</p>
-<p>There is an exception for <tt>f_mount/f_mkfs/f_fdisk</tt> function. These functions are not re-entrant to the same volume or corresponding physical drive. When use these functions, all other tasks must unmount the volume and avoid to access the volume.</p>
-<p>Note that this section describes on the re-entrancy of the FatFs module itself but also the low level disk I/O layer will need to be re-entrant.</p>
+<p>The file operations to the different volume is always re-entrant regardless of configurations and it can work simultaneously without any mutual exclusion.</p>
+<p>The file operations to the same volume is not re-entrant but it can also be configured to thread-safe by <tt><a href="config.html#fs_reentrant">_FS_REENTRANT</a></tt> option. It enables to control exclusive use of each file system object. In this case, also the OS dependent synchronization object control functions, <tt>ff_cre_syncobj/ff_del_syncobj/ff_req_grant/ff_rel_grant</tt>, needed to be added to the project. There are some examples in the <tt>option/syscall.c</tt>.</p>
+<p>When a file function is called while the volume is being accessed by any other task, the file function to the volume will be suspended until that task leaves the file function. If the wait time exceeded a period defined by <tt>_TIMEOUT</tt>, the file function will abort with <tt>FR_TIMEOUT</tt>. The timeout feature might not be supported on the some RTOSs.</p>
+<p>There is an exception on the re-entrancy for <tt>f_mount/f_mkfs/f_fdisk</tt> function. These volume control functions are not re-entrant to the same volume and corresponding physical drive. When use these functions, any other tasks need to avoid to access the volume.</p>
+<p>Note that this section describes on the re-entrancy of the FatFs module itself. The low level disk I/O layer must be thread-safe when any FatFs API is re-entered.</p>
 </div>

 <div class="para doc" id="dup">
 <h3>Duplicated File Access</h3>
-<p>FatFs module does not support the read/write collision control of duplicated open to a file. The duplicated open is permitted only when each of open method to a file is read mode. The duplicated open with one or more write mode to a file is always prohibited, and also open file must not be renamed and deleted. A violation of these rules can cause data colluption.</p>
-<p>The file lock control can be enabled by <tt>_FS_LOCK</tt> option. The value of option defines the number of open objects to manage simultaneously. In this case, if any open, rename or remove that violating the file shareing rule that described above is attempted, the file function will fail with <tt>FR_LOCKED</tt>. If number of open objects, files and sub-directories, is equal to <tt>_FS_LOCK</tt>, an extra <tt>f_open/f_optndir/f_findfirst</tt> function will fail with <tt>FR_TOO_MANY_OPEN_FILES</tt>.</p>
+<p>FatFs module does not support the read/write collision control of duplicated open to a file. The duplicated open is permitted only when each of open method to a file is read mode. The duplicated open with one or more write mode to a file is always prohibited, and also open file must not be renamed or deleted. A violation of these rules can cause data colluption.</p>
+<p>The file lock control can be enabled by <tt><a href="config.html#fs_lock">_FS_LOCK</a></tt> option. The value of option defines the number of open objects to manage simultaneously. In this case, if any open, rename or remove that violating the file shareing rule that described above is attempted, the file function will fail with <tt>FR_LOCKED</tt>. If number of open objects, files and sub-directories, is equal to <tt>_FS_LOCK</tt>, an extra <tt>f_open/f_optndir/f_findfirst</tt> function will fail with <tt>FR_TOO_MANY_OPEN_FILES</tt>.</p>
 </div>

 <div class="para doc" id="fs1">
@@ -186,7 +188,7 @@ _WORD_ACCESS   0 or 1 (Set for 1 if possible)
 <p>Figure 3. Fully sector aligned read<br>
 <img src="../img/f3.png" width="490" height="119" alt="">
 </p>
-<p>The file I/O buffer is a sector buffer to read/write a partial data on the sector. The sector buffer is either file private sector buffer on each file object or shared sector buffer in the file system object. The buffer configuration option <tt>_FS_TINY</tt> determins which sector buffer is used for the file data transfer. When tiny buffer configuration (1) is selected, data memory consumption is reduced <tt>_MAX_SS</tt> bytes each file object. In this case, FatFs module uses only a sector buffer in the file system object for file data transfer and FAT/directory access. The disadvantage of the tiny buffer configuration is: the FAT data cached in the sector buffer will be lost by file data transfer and it must be reloaded at every cluster boundary. However it will be suitable for most application from view point of the decent performance and low memory comsumption.</p>
+<p>The file I/O buffer is a sector buffer to read/write a partial data on the sector. The sector buffer is either file private sector buffer on each file object or shared sector buffer in the file system object. The buffer configuration option <tt><a href="config.html#fs_tiny">_FS_TINY</a></tt> determins which sector buffer is used for the file data transfer. When tiny buffer configuration (1) is selected, data memory consumption is reduced <tt>_MAX_SS</tt> bytes each file object. In this case, FatFs module uses only a sector buffer in the file system object for file data transfer and FAT/directory access. The disadvantage of the tiny buffer configuration is: the FAT data cached in the sector buffer will be lost by file data transfer and it must be reloaded at every cluster boundary. However it will be suitable for most application from view point of the decent performance and low memory comsumption.</p>
 <p>Figure 1 shows that a partial sector, sector misaligned part of the file, is transferred via the file I/O buffer. At long data transfer shown in Figure 2, middle of transfer data that covers one or more sector is transferred to the application buffer directly. Figure 3 shows that the case of entier transfer data is aligned to the sector boundary. In this case, file I/O buffer is not used. On the direct transfer, the maximum extent of sectors are read with <tt>disk_read</tt> function at a time but the multiple sector transfer is divided at cluster boundary even if it is contiguous.</p>
 <p>Therefore taking effort to sector aligned read/write accesss eliminates buffered data transfer and the read/write performance will be improved. Besides the effect, cached FAT data will not be flushed by file data transfer at the tiny configuration, so that it can achieve same performance as non-tiny configuration with small memory footprint.</p>
 </div>
@@ -202,7 +204,7 @@ Figure 6. Comparison between Multiple/Single Sector Write<br>
 <p>The write throughput of the flash memory media becomes the worst at single sector write transaction. The write throughput increases as the number of sectors per a write transaction as shown in Figure 6. This effect more appers at faster interface speed and the performance ratio often becomes grater than ten. <a href="../img/rwtest2.png">This graph</a> is clearly explaining how fast is multiple block write (W:16K, 32 sectors) than single block write (W:100, 1 sector), and also larger card tends to be slow at single block write. Number of write transactions also affects life time of the flash memory media. When compared at same amount of write data, the single sector write in Figure 6 above wears flash memory media 16 times more than multiple sector write in Figure 6 below. Single sector write is pretty pain for the flash memory media.</p>
 <p>Therefore the application program should write the data in large block as possible. The ideal write chunk size and alighment is size of sector, and size of cluster is the best. Of course all layers between the application and the storage device must have consideration on multiple sector write, however most of open-source memory card drivers lack it. Do not split a multiple sector write request into single sector write transactions or the write throughput gets poor. Note that FatFs module and its sample disk drivers supprt multiple sector read/write feature. </p>
 <h4>Forcing Memory Erase</h4>
-<p>When remove a file with <tt>f_remove</tt> function, the data clusters occupied by the file are marked 'free' on the FAT. But the data sectors containing the file data are not that applied any process, so that the file data left occupies a part of the flash memory array as 'live block'. If the file data is forced erased on removing the file, those data blocks will be turned in to the free block pool. This may skip internal block erase operation to the data block on next write operation. As the result the write performance might be improved. FatFs can manage this feature by setting <tt>_USE_TRIM</tt> to 1. Note that this is an expectation of internal process of the flash memory storage and not that always effective. Also <tt>f_remove</tt> function will take a time when remove a large file. Most applications will not need this feature.</p>
+<p>When remove a file with <tt>f_remove</tt> function, the data clusters occupied by the file are marked 'free' on the FAT. But the data sectors containing the file data are not that applied any process, so that the file data left occupies a part of the flash memory array as 'live block'. If the file data is forced erased on removing the file, those data blocks will be turned in to the free block pool. This may skip internal block erase operation to the data block on next write operation. As the result the write performance might be improved. FatFs can manage this feature by setting <tt><a href="config.html#use_trim">_USE_TRIM</a></tt> to 1. Note that this is an expectation of internal process of the flash memory storage and not that always effective. Also <tt>f_remove</tt> function will take a time when remove a large file. Most applications will not need this feature.</p>
 </div>

 <div class="para doc" id="critical">
@@ -261,9 +263,9 @@ Figure 5. Minimized critical section<br>
 / by use of this software.
 /----------------------------------------------------------------------------*/
 </pre>
-<p>Therefore FatFs license is one of the BSD-style licenses but there is a significant feature. FatFs is mainly intended for embedded systems. In order to extend the usability for commercial products, the redistributions of FatFs in binary form, such as embedded code or any forms without source code, does not need to explain about use of FatFs in the documentations. This is equivalent to the 1-clause BSD license. Of course FatFs is compatible with the most open source software licenses including GNU GPL. When redistribute the FatFs source code with any modification or branch it as a fork, the license can also be changed to GNU GPL, BSD-style license or any open source software licenses that not conflict with FatFs license.</p>
+<p>Therefore FatFs license is one of the BSD-style licenses but there is a significant feature. FatFs is mainly intended for embedded systems. In order to extend the usability for commercial products, the redistributions of FatFs in binary form, such as embedded code or any forms without source code, does not need to explain about use of FatFs in the documentations. This is equivalent to the 1-clause BSD license. Of course FatFs is compatible with the most open source software licenses including GNU GPL. When you redistribute the FatFs source code with any modification or create a fork, the license can also be changed to GNU GPL, BSD-style license or any open source software licenses that not conflict with FatFs license.</p>
 </div>

-<p class="foot"><a href="../00index_e.html">Return</a></p>
+<p class="foot"><a href="../00index_e.html">Return Home</a></p>
 </body>
 </html>
@@ -36,7 +36,6 @@ FRESULT f_close (
 <a href="rc.html#ok">FR_OK</a>,
 <a href="rc.html#de">FR_DISK_ERR</a>,
 <a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
 <a href="rc.html#tm">FR_TIMEOUT</a>
 </p>
@@ -0,0 +1,220 @@
+<!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="up" title="FatFs" href="../00index_e.html">
+<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/config.html">
+<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
+<title>FatFs - Configuration Options</title>
+</head>
+
+<body>
+<h1>Configuration Options</h1>
+<p>There are many options to configure the functions of FatFs for each project. The configuration options are defined in the <tt>ffconf.h</tt>.</p>
+
+<div class="para doc" id="func">
+<h3>Function Configurations</h3>
+
+<h4 id="fs_readonly">_FS_READONLY</h4>
+<p>Read/Write(0) or Read-only(1). Read-only configuration removes writing API functions, <tt>f_write</tt>, <tt>f_sync</tt>, <tt>f_unlink</tt>, <tt>f_mkdir</tt>, <tt>f_chmod</tt>, <tt>f_rename</tt>, <tt>f_truncate</tt>, <tt>f_getfree</tt> and optional writing functions as well.</p>
+
+<h4 id="fs_minimize">_FS_MINIMIZE</h4>
+<p>This option defines minimization level to remove some basic API functions as follows:</p>
+<table class="lst1">
+<tr><th>Value</th><th>Description</th></tr>
+<tr><td>0</td><td>All basic API functions are available.</td></tr>
+<tr><td>1</td><td><tt>f_stat</tt>, <tt>f_getfree</tt>, <tt>f_unlink</tt>, <tt>f_mkdir</tt>, <tt>f_chmod</tt>, <tt>f_utime</tt>, <tt>f_truncate</tt> and <tt>f_rename</tt> function are removed.</td></tr>
+<tr><td>2</td><td><tt>f_opendir</tt>, <tt>f_readdir</tt> and <tt>f_closedir</tt> function are removed in addition to 1.</td></tr>
+<tr><td>3</td><td><tt>f_lseek</tt> function is removed in addition to 2.</td></tr>
+</table>
+
+<h4 id="use_strfunc">_USE_STRFUNC</h4>
+<p>This option switches string functions, <tt>f_gets</tt>, <tt>f_putc</tt>, <tt>f_puts</tt> and <tt>f_printf</tt>.</p>
+<table class="lst1">
+<tr><th>Value</th><th>Description</th></tr>
+<tr><td>0</td><td>Disable string functions.</td></tr>
+<tr><td>1</td><td>Enable string functions without LF-CRLF conversion.</td></tr>
+<tr><td>2</td><td>Enable string functions with LF-CRLF conversion.</td></tr>
+</table>
+
+<h4 id="use_find">_USE_FIND</h4>
+<p>Disable(0) or Enable(1). This option switches filtered directory read feature and related functions, <tt>f_findfirst</tt> and <tt>f_findnext</tt>.</p>
+
+<h4 id="use_mkfs">_USE_MKFS</h4>
+<p>Disable(0) or Enable(1). This option switches <tt>f_mkfs</tt> function.</p>
+
+<h4 id="use_fastseek">_USE_FASTSEEK</h4>
+<p>Disable(0) or Enable(1). This option switches fast seek feature to enable accelerated mode of <tt>f_lseek</tt>, <tt>f_read</tt> and <tt>f_write</tt> function. For more information, read <a href="lseek.html">here</a>.</p>
+
+<h4 id="use_label">_USE_LABEL</h4>
+<p>Disable(0) or Enable(1). This option switches volume label functions, <tt>f_getlabel</tt> and <tt>f_setlabel</tt>.</p>
+
+<h4 id="use_forward">_USE_FORWARD</h4>
+<p>Disable(0) or Enable(1). This option switches <tt>f_forward</tt> function. also <tt>_FS_TINY</tt> needs to be set to 1.</p>
+
+</div>
+
+
+<div class="para doc" id="name">
+<h3>Namespace and Locale Configurations</h3>
+
+<h4 id="code_page">_CODE_PAGE</h4>
+<p>This option specifies the OEM code page to be used on the target system. Incorrect setting of the code page can cause a file open failure. If any extended character is not used at all, there is no difference between any code pages.</p>
+<table class="lst1">
+<tr><th>Value</th><th>Description</th></tr>
+<tr><td>1</td><td>ASCII (valid at non-LFN cfg.)</td></tr>
+<tr><td>437</td><td>U.S.</td></tr>
+<tr><td>720</td><td>Arabic</td></tr>
+<tr><td>737</td><td>Greek</td></tr>
+<tr><td>771</td><td>KBL</td></tr>
+<tr><td>775</td><td>Baltic</td></tr>
+<tr><td>850</td><td>Latin 1</td></tr>
+<tr><td>852</td><td>Latin 2</td></tr>
+<tr><td>855</td><td>Cyrillic</td></tr>
+<tr><td>857</td><td>Turkish</td></tr>
+<tr><td>860</td><td>Portuguese</td></tr>
+<tr><td>861</td><td>Icelandic</td></tr>
+<tr><td>862</td><td>Hebrew</td></tr>
+<tr><td>863</td><td>Canadian French</td></tr>
+<tr><td>864</td><td>Arabic</td></tr>
+<tr><td>865</td><td>Nordic</td></tr>
+<tr><td>866</td><td>Russian</td></tr>
+<tr><td>869</td><td>Greek 2</td></tr>
+<tr><td>932</td><td>Japanese (DBCS)</td></tr>
+<tr><td>936</td><td>Simplified Chinese (DBCS)</td></tr>
+<tr><td>949</td><td>Korean (DBCS)</td></tr>
+<tr><td>950</td><td>Traditional Chinese (DBCS)</td></tr>
+</table>
+
+<h4 id="use_lfn">_USE_LFN</h4>
+<p>This option switches the LFN feature. When enable the LFN feature, Unicode handling functions <tt>option/unicode.c</tt> must be added to the project. The LFN working buffer occupies <tt>(_MAX_LFN + 1) * 2</tt> bytes. 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>, must be added to the project.</p>
+<table class="lst1">
+<tr><th>Value</th><th>Description</th></tr>
+<tr><td>0</td><td>Disable LFN feature. Only 8.3 format can be used.</td></tr>
+<tr><td>1</td><td>Enable LFN with static working buffer on the BSS. Always NOT thread-safe.</td></tr>
+<tr><td>2</td><td>Enable LFN with dynamic working buffer on the STACK.</td></tr>
+<tr><td>3</td><td>Enable LFN with dynamic working buffer on the HEAP.</td></tr>
+</table>
+
+<h4 id="max_lfn">_MAX_LFN</h4>
+<p>This option defines the size of LFN working buffer from 12 to 255 in unit of character. This option has no effect when LFN feature is disabled.</p>
+
+<h4 id="lfn_unicode">_LFN_UNICODE</h4>
+<p>ANSI/OEM(0) or Unicode(1). This option switches character encoding on the API. To use Unicode (UTF16) string for the path name, enable LFN feature and set this option to 1. This option also affects behavior of string I/O functions. When LFN feature is disabled, this option must be 0. For more information, read <a href="filename.html#uni">here</a>.</p>
+
+<h4 id="strf_encode">_STRF_ENCODE</h4>
+<p>When Unicode API is selected by <tt>_LFN_UNICODE</tt>, this option defines the assumption of character encoding on the file to be read/written via string I/O functions, <tt>f_gets</tt>, <tt>f_putc</tt>, <tt>f_puts</tt> and <tt>f_printf</tt>. This option has no effect when <tt>_LFN_UNICODE == 0</tt>.</p>
+<table class="lst1">
+<tr><th>Value</th><th>Description</th></tr>
+<tr><td>0</td><td>ANSI/OEM</td></tr>
+<tr><td>1</td><td>UTF-16LE</td></tr>
+<tr><td>2</td><td>UTF-16BE</td></tr>
+<tr><td>3</td><td>UTF-8</td></tr>
+</table>
+
+<h4 id="fs_rpath">_FS_RPATH</h4>
+<p>This option configures relative path feature. Note that directory items read via directory functions are affected by this option. For more information, 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 feature and remove related functions.</td></tr>
+<tr><td>1</td><td>Enable relative path feature. <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>
+</table>
+
+</div>
+
+
+<div class="para doc" id="volume">
+<h3>Volume/Drive Configurations</h3>
+
+<h4 id="volumes">_VOLUMES</h4>
+<p>This option configures number of volumes (logical drives, from 1 to 9) to be used.</p>
+
+<h4 id="str_volume_id">_STR_VOLUME_ID</h4>
+<p>Disable(0) or Enable(1). This option switches string volume ID feature. When enabled, also pre-defined strings in <tt>_VOLUME_STRS</tt> can be used as drive identifier in the path name.</p>
+
+<h4 id="volume_strs">_VOLUME_STRS</h4>
+<p>This option defines the drive ID strings for each logical drives. Number of items must be equal to <tt>_VOLUMES</tt>. Valid characters for the drive ID strings are: A-Z and 0-9.</p>
+
+<h4 id="multi_partition">_MULTI_PARTITION</h4>
+<p>Disable(0) or Enable(1). This option switches multi-partition feature. By default (0), each logical drive number is bound to the same physical drive number and only an FAT volume each physical drive are mounted. When enabled, each logical drive is bound to the partition on the physical drive listed in the user defined partition resolution table <tt>VolToPart[]</tt>. Also <tt>f_fdisk</tt> funciton will be enabled. For more information, read <a href="filename.html#vol">here</a>.</p>
+
+<h4 id="max_ss">_MIN_SS, _MAX_SS</h4>
+<p>This set of options defines size of sector on the low level disk I/O interface, <tt>disk_read</tt> and <tt>disk_write</tt> function. Valid numbers are 512, 1024, 2048 and 4096. <tt>_MIN_SS</tt> defines minimum size of sector and <tt>_MAX_SS</tt> defines the maximum size of sector. Always set both 512 for all type of memory cards and harddisk. But a larger value may be required for on-board flash memory and some type of optical media. When <tt>_MAX_SS &gt; _MIN_SS</tt>, FatFs is configured to variable sector size and <tt>GET_SECTOR_SIZE</tt> command must be implemented to the <tt>disk_ioctl</tt> function.</p>
+
+<h4 id="use_trim">_USE_TRIM</h4>
+<p>Disable(0) or Enable(1). This option switches ATA-TRIM feature. To enable Trim feature, also <tt>CTRL_TRIM</tt> command should be implemented to the <tt>disk_ioctl</tt> function.</p>
+
+<h4 id="fs_nofsinfo">_FS_NOFSINFO</h4>
+<p>0 to 3. If you need to know correct free space on the FAT32 volume, set bit 0 of this option, and <tt>f_getfree</tt> function at first time after volume mount will force a full FAT scan. Bit 1 controls the use of last allocated cluster number.</p>
+<table class="lst1">
+<tr><th>Value</th><th>Description</th></tr>
+<tr><td>bit0=0</td><td>Use free cluster count in the FSINFO if available.</td></tr>
+<tr><td>bit0=1</td><td>Do not trust free cluster count in the FSINFO.</td></tr>
+<tr><td>bit1=0</td><td>Use last allocated cluster number in the FSINFO to find a free cluster if available.</td></tr>
+<tr><td>bit1=1</td><td>Do not trust last allocated cluster number in the FSINFO.</td></tr>
+</table>
+
+</div>
+
+
+<div class="para doc" id="system">
+<h3>System Configurations</h3>
+
+<h4 id="fs_tiny">_FS_TINY</h4>
+<p>Normal(0) or Tiny(1). At the tiny configuration, size of the file object <tt>FIL</tt> is reduced <tt>_MAX_SS</tt> bytes. Instead of private data buffer eliminated from the file object, common sector buffer in the file system object <tt>FATFS</tt> is used for the file data transfer.</p>
+
+<h4 id="fs_nortc">_FS_NORTC</h4>
+<p>Use RTC(0) or Do not use RTC(1). This option controls timestamp feature. If the system does not have an RTC function or valid timestamp is not needed, set <tt>_FS_NORTC</tt> to 1 to disable the timestamp feature. Any object modified by FatFs will have a fixed timestamp value defined by <tt>_NORTC_MON</tt>, <tt>_NORTC_MDAY</tt> and <tt>_NORTC_YEAR</tt>. To use the timestamp feature, set <tt>_FS_NORTC</tt> to 0 and add <tt>get_fattime</tt> function to the project to get the current time form RTC. This option has no effect at read-only configuration.</p>
+
+<h4 id="nortc_time">_NORTC_MON, _NORTC_MDAY, _NORTC_YEAR</h4>
+<p>This set of options defines default timestamp to be used at no RTC systems. This option has no effect at read-only configuration or <tt>_FS_NORTC == 0</tt>.</p>
+
+<h4 id="fs_lock">_FS_LOCK</h4>
+<p>This option switches file lock feature to control duplicated file open and illegal operations to open objects. Note that the file lock feature is independent of re-entrancy. This option must be 0 at read-only configuration.</p>
+<table class="lst1">
+<tr><th>Value</th><th>Description</th></tr>
+<tr><td>0</td><td>Disable file lock feature. To avoid volume corruption, application program should avoid illegal open, remove and rename to the open objects.</td></tr>
+<tr><td>&gt;0</td><td>Enable file lock feature. The value defines how many files/sub-directories can be opened simultaneously under file lock control. Illigal operations to the open object will be rejected with <tt>FR_LOCKED</tt>.</td></tr>
+</table>
+
+<h4 id="fs_reentrant">_FS_REENTRANT</h4>
+<p>Disable(0) or Enable(1). This option switches the re-entrancy (thread safe) of the FatFs module itself. Note that file/directory access to the different volume is always re-entrant and it can work simultaneously regardless of this option but volume control functions, <tt>f_mount</tt>, <tt>f_mkfs</tt> and <tt>f_fdisk</tt>, are always not re-entrant. Only file/directory access to the same volume, in other words, exclusive use of each file system object, is under control of this feature. To enable this feature, also user provided synchronization handlers, <tt>ff_req_grant</tt>, <tt>ff_rel_grant</tt>, <tt>ff_del_syncobj</tt> and <tt>ff_cre_syncobj</tt>, must be added to the project. Samples are available in <tt>option/syscall.c</tt>.</p>
+
+<h4 id="fs_timeout">_FS_TIMEOUT</h4>
+<p>Number of time ticks to abort the file function with <tt>FR_TIMEOUT</tt> when wait time is too long. This option has no effect when <tt>_FS_REENTRANT == 0</tt>.</p>
+
+<h4 id="sync_t">_SYNC_t</h4>
+<p>This option defines O/S dependent sync object type. e.g. <tt>HANDLE</tt>, <tt>ID</tt>, <tt>OS_EVENT*</tt>, <tt>SemaphoreHandle_t</tt> and etc. A header file for O/S definitions needs to be included somewhere in the scope of <tt>ff.c</tt>. This option has no effect when <tt>_FS_REENTRANT == 0</tt>.</p>
+
+<h4 id="word_access">_WORD_ACCESS</h4>
+<p>This is an only platform dependent option. It defines which access method is used to the word data on the FAT volume.</p>
+<table class="lst1">
+<tr><th>Value</th><th>Description</th></tr>
+<tr><td>0</td><td>Byte-by-byte access. Always compatible with all platforms.</td></tr>
+<tr><td>1</td><td>Word access. Code size will be slightly reduced but do not choose this unless under both the following conditions.<br>
+* Unaligned memory access is always allowed to ALL instructions.<br>
+* Byte order on the memory is little-endian.</td></tr>
+</table>
+<p>Following table shows an example of allowable settings of some type of processors.</p>
+<pre>
+   ARM7TDMI   0   *2         ColdFire   0   *1         V850E      0   *2
+   Cortex-M3  0   *3         Z80        0/1            V850ES     0/1
+   Cortex-M0  0   *2         x86        0/1            TLCS-870   0/1
+   AVR        0/1            RX600(LE)  0/1            TLCS-900   0/1
+   AVR32      0   *1         RL78       0   *2         R32C       0   *2
+   PIC18      0/1            SH-2       0   *1         M16C       0/1
+   PIC24      0   *2         H8S        0   *1         MSP430     0   *2
+   PIC32      0   *1         H8/300H    0   *1         8051       0/1
+
+   *1:Big-endian.
+   *2:Unaligned memory access is not supported.
+   *3:Some compilers generate LDM/STM for mem_cpy function.
+</pre>
+
+</div>
+
+<p class="foot"><a href="../00index_e.html">Return</a></p>
+</body>
+</html>
@@ -38,7 +38,7 @@ DSTATUS disk_initialize (
 <div class="para desc">
 <h4>Description</h4>
 <p>This function initializes the storage device and put it ready to generic read/write. When the function succeeded, <tt>STA_NOINIT</tt> flag in the return value is cleared.</p>
-<p><em>Application program MUST NOT call this function, or FAT structure on the volume can be broken. To re-initialize the file system, use <tt>f_mount</tt> function instead.</em> This function is called at volume mount process by FatFs module to manage the media change.</p>
+<p>This function is under control of FatFs module. <em>Application program MUST NOT call this function, or FAT structure on the volume can be broken. To re-initialize the file system, use <tt>f_mount</tt> function instead.</em></p>
 </div>

 <p class="foot"><a href="../00index_e.html">Return</a></p>
@@ -34,7 +34,7 @@ DRESULT disk_read (
 <dt>sector</dt>
 <dd>Start sector number in 32-bit LBA.</dd>
 <dt>count</dt>
-<dd>Number of sectors to read in range of from 1 to 128..</dd>
+<dd>Number of sectors to read. FatFs specifies the value in range of from 1 to 128.</dd>
 </dl>
 </div>

@@ -60,8 +60,8 @@ DRESULT disk_read (
 <p>The memory address specified by <tt class="arg">buff</tt> is not that always aligned to word boundary because the argument is defined as <tt>BYTE*</tt>. The misaligned read/write request can occure at <a href="appnote.html#fs1">direct transfer</a>. If the bus architecture, especially DMA controller, does not allow misaligned memory access, it should be solved in this function. There are some workarounds described below to avoid this issue.</p>
 <ul>
 <li>Convert word transfer to byte transfer in this function if needed. - Recommended.</li>
-<li>For any <tt>f_read</tt> calls, avoid long read request that includes a whole of sector. - Direct transfer will never occure.</li>
-<li>For <tt>f_read(fp, buff, btr, &amp;br)</tt> call, make sure that <tt>(((UINT)buff &amp; 3) == (f_tell(fp) &amp; 3))</tt> is true. - Word aligned direct transfer is guaranteed.</li>
+<li>At the any <tt>f_read</tt> calls, avoid long read request that includes a whole of sector. - Direct transfer will never occure.</li>
+<li>At the <tt>f_read(fp, data, btr, &amp;br)</tt> call, make sure that <tt>(((UINT)data &amp; 3) == (f_tell(fp) &amp; 3))</tt> is true. - Word alignment of <tt>buff</tt> is guaranteed.</li>
 </ul>
 <p>Generally, a multiple sector transfer request must not be split into single sector transactions to the storage device, or you will not get good read throughput.</p>
 </div>
@@ -34,7 +34,7 @@ DRESULT disk_write (
 <dt>sector</dt>
 <dd>Start sector number in 32-bit LBA.</dd>
 <dt>count</dt>
-<dd>Number of sectors to write in range of from 1 to 128.</dd>
+<dd>Number of sectors to write. FatFs specifies the value in range of from 1 to 128.</dd>
 </dl>
 </div>

@@ -60,7 +60,7 @@ DRESULT disk_write (
 <h4>Description</h4>
 <p>The specified memory address is not that always aligned to word boundary because the type of pointer is defined as <tt>BYTE*</tt>. For more information, refer to the description of <a href="dread.html"><tt>disk_read</tt></a> function.</p>
 <p>Generally, a multiple sector transfer request must not be split into single sector transactions to the storage device, or you will never get good write throughput.</p>
-<p>FatFs expects delayed write feature of the disk functions. The write operation to the media need not to be completed due to write operation is in progress or only stored it into the cache buffer when return from this function. But data on the <tt class="arg">buff</tt> is invalid after return from this function. The write completion request is done by <tt>CTRL_SYNC</tt> command of <tt><a href="dioctl.html">disk_ioctl</a></tt> function. Therefore, if delayed write feature is implemented, the write throughput may be improved.</p>
+<p>FatFs expects delayed write feature of the disk control layer. The write operation to the media need not to be completed due to write operation is in progress or data is stored into the write-back cache when return from this function. But write data on the <tt class="arg">buff</tt> is invalid after return from this function. The write completion request is done by <tt>CTRL_SYNC</tt> command of <tt><a href="dioctl.html">disk_ioctl</a></tt> function. Therefore, if a delayed write feature is implemented, the write throughput will be improved.</p>
 <p><em>Application program MUST NOT call this function, or FAT structure on the volume can be collapsed.</em></p>
 </div>

@@ -39,7 +39,7 @@ int f_eof (

 <div class="para desc">
 <h4>Description</h4>
-<p>In this revision, this function is implemented as a macro.</p>
+<p>In this revision, this function is implemented as a macro. It has not any validation and mutual exclusion.</p>
 <pre>
 <span class="k">#define</span> f_eof(fp) ((int)((fp)->fptr == (fp)->fsize))
 </pre>
@@ -39,7 +39,7 @@ int f_error (

 <div class="para desc">
 <h4>Description</h4>
-<p>In this revision, this function is implemented as a macro.</p>
+<p>In this revision, this function is implemented as a macro. It has not any validation and mutual exclusion.</p>
 <pre>
 <span class="k">#define</span> f_error(fp) ((fp)->flag)
 </pre>
@@ -16,12 +16,12 @@
 <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>
 <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 LFN feature is enabled (<tt>_USE_LFN &gt; 0</tt>). The sub directories are separated with a \ or / in the same way as DOS/Windows API. Duplicated separators are skipped and ignored. Only a difference is that the logical drive is specified in a numeral with a colon. When drive number is omitted, the drive number is assumed as <em>default drive</em> (drive 0 or current drive).</p>
+<p>The FatFs module supports long file name (LFN) and 8.3 format file name (SFN). The LFN can be used when LFN feature is enabled (<tt><a href="config.html#use_lfn">_USE_LFN</a> &gt; 0</tt>). The sub directories are separated with a \ or / in the same way as DOS/Windows API. Duplicated separators are skipped and ignored. Only a difference is that the logical drive is specified in a numeral with a colon. When drive number is omitted, the drive number is assumed as <em>default drive</em> (drive 0 or current drive).</p>
 <p>Control characters (<tt>'\0'</tt> to <tt>'\x1F'</tt>) are recognized as end of the path name. Leading/embedded spaces in the path name are valid as a part of the name at LFN configuration but the space is recognized as end of the path name at non-LFN configuration. Trailing spaces and dots are ignored at both configurations.</p>
-<p>In default configuration (<tt>_FS_RPATH == 0</tt>), it does not have a concept of current directory like OS oriented file system. All objects on the volume are always specified in full path name that follows 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>_FS_RPATH == 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 drive set by <a href="chdir.html">f_chdir</a> function. Dot names are also allowed for the path names. The default drive is the current drive set by <a href="chdrive.html">f_chdrive</a> function.</p>
+<p>In default configuration (<tt><a href="config.html#fs_rpath">_FS_RPATH</a> &gt;= 0</tt>), it does not have a concept of current directory like OS oriented file system. All objects on the volume are always specified in full path name that follows 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>_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 drive set by <a href="chdir.html">f_chdir</a> function. Dot names are also allowed for the path names. The default drive is the current drive set by <a href="chdrive.html">f_chdrive</a> function.</p>
 <table class="lst2">
-<tr><td>Path name</td><td>_FS_RPATH == 0</td><td>_FS_RPATH == 1</td></tr>
+<tr><td>Path name</td><td>_FS_RPATH == 0</td><td>_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>
 <tr><td>/file.txt</td><td>A file in the root directory of the drive 0</td><td>A file in the root directory of the current drive</td></tr>
 <tr><td></td><td>The root directory of the drive 0</td><td>The current directory of the current drive</td></tr>
@@ -35,7 +35,7 @@
 <tr><td>dir1/..</td><td>Invalid name</td><td>The current directory</td></tr>
 <tr><td>/..</td><td>Invalid name</td><td>The root directory (sticks the top level)</td></tr>
 </table>
-<p>When option <tt>_STR_VOLUME_ID</tt> is specified, also pre-defined strings can be used as drive identifier in the path name instead of a numeral. e.g. <tt>"sd:file1.txt"</tt> or <tt>"ram:swapfile.dat"</tt>.</p>
+<p>When option <tt><a href="config.html#str_volume_id">_STR_VOLUME_ID</a></tt> is specified, also pre-defined strings can be used as drive identifier in the path name instead of a numeral. e.g. <tt>"sd:file1.txt"</tt> or <tt>"ram:swapfile.dat"</tt>.</p>
 </div>

 <div class="para doc" id="case">
@@ -47,7 +47,7 @@

 <div class="para doc" id="uni">
 <h3>Unicode API</h3>
-<p>The path names are input/output in either ANSI/OEM code or Unicode depends on the configuration options. The type of arguments which specify the path names are defined as <tt>TCHAR</tt>. It is an alias of <tt>char</tt> by default. The code set used to the path name string is ANSI/OEM specifid by <tt>_CODE_PAGE</tt>. When <tt>_LFN_UNICODE</tt> is set to 1, the type of the <tt>TCHAR</tt> is switched to <tt>WCHAR</tt> to support Unicode (UTF-16 encoding). In this case, the LFN feature is fully supported and the Unicode specific characters, such as ✝☪✡☸☭, can also be used for the path name. It also affects data types and encoding of the string I/O functions. To define literal strings, <tt>_T(s)</tt> and <tt>_TEXT(s)</tt> macro are available to select either ANSI/OEM or Unicode automatically. The code shown below is an example to define the literal strings.</p>
+<p>The path names are input/output in either ANSI/OEM code or Unicode depends on the configuration options. The type of arguments which specify the path names are defined as <tt>TCHAR</tt>. It is an alias of <tt>char</tt> by default. The code set used to the path name string is ANSI/OEM specifid by <tt><a href="config.html#code_page">_CODE_PAGE</a></tt>. When <tt><a href="config.html#lfn_unicode">_LFN_UNICODE</a></tt> is set to 1, the type of the <tt>TCHAR</tt> is switched to <tt>WCHAR</tt> to support Unicode (UTF-16 encoding). In this case, the LFN feature is fully supported and the Unicode specific characters, such as ✝☪✡☸☭, can also be used for the path name. It also affects data types and encoding of the string I/O functions. To define literal strings, <tt>_T(s)</tt> and <tt>_TEXT(s)</tt> macro are available to select either ANSI/OEM or Unicode automatically. The code shown below is an example to define the literal strings.</p>
 <pre>
 f_open(fp, "filename.txt", FA_READ);      <span class="c">/* ANSI/OEM string */</span>
 f_open(fp, L"filename.txt", FA_READ);     <span class="c">/* Unicode string */</span>
@@ -58,7 +58,7 @@
 <div class="para doc" id="vol">
 <h3>Volume Management</h3>
 <p>The FatFs module needs dynamic work area called <em>file system object</em> for each volume (logical drive). It is registered to the FatFs module by <tt>f_mount</tt> function. By default, each logical drive is bound to the physical drive with the same drive number and an FAT volume on the drive is serched by auto detect feature. It loads boot sectors and checks it if it is an FAT boot sector in order of sector 0 as SFD format, 1st partition, 2nd partition, 3rd partition and 4th partition as FDISK format.</p>
-<p>When <tt>_MULTI_PARTITION == 1</tt> is specified by configuration option, each individual logical drive is bound to the partition on the physical drive specified by volume management table. The volume management table must be defined by user to resolve relationship between logical drives and partitions. Following code is an example of a volume management table.</p>
+<p>When <tt><a href="config.html#multi_partition">_MULTI_PARTITION</a> == 1</tt> is specified by configuration option, each individual logical drive is bound to the partition on the physical drive specified by volume management table. The volume management table must be defined by user to resolve the relationship between logical drives and partitions. Following code is an example of a volume management table.</p>
 <pre>
 Example: Logical drive 0-2 are tied to three pri-partitions on the physical drive 0 (fixed disk)
         Logical drive 3 is tied to an FAT volume on the physical drive 1 (removable disk)
@@ -71,7 +71,7 @@ PARTITION VolToPart[] = {
 };
 </pre>
 <div><img src="../img/f7.png" width="828" height="288" alt="relationship between logical drive and physical drive"></div>
-<p>There are some considerations on using <tt>_MULTI_PARTITION</tt> configuration.</p>
+<p>There are some considerations on using multi-partition configuration.</p>
 <ul>
 <li>The physical drive that has two or more mounted partitions must be non-removable. Media change while a system operation is prohibited.</li>
 <li>Only four primary partitions can be specified. Extended partition is not supported.</li>
@@ -79,5 +79,6 @@ PARTITION VolToPart[] = {
 </ul>
 </div>

+<p class="foot"><a href="../00index_e.html">Return</a></p>
 </body>
 </html>
@@ -28,13 +28,13 @@ FRESULT f_findfirst (
 <h4>Parameters</h4>
 <dl class="par">
 <dt>dp</dt>
-<dd>Pinter to the blank directory object.</dd>
+<dd>Pointer to the blank directory object.</dd>
 <dt>fno</dt>
 <dd>Pointer to the file information structure to store the information about the found item.</dd>
 <dt>path</dt>
-<dd>Pinter to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>
+<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>
 <dt>pattern</dt>
-<dd>Pinter to the null-terminated string that specifies the name matching pattern to be searched for. It is referred by also subsequent <tt>f_findnext</tt> function, so that the string must be valid while the successive function calls.</dd>
+<dd>Pointer to the null-terminated string that specifies the name matching pattern to be searched for. It is referred by also subsequent <tt>f_findnext</tt> function, so that the string must be valid while the successive function calls.</dd>
 </dl>
 </div>

@@ -62,10 +62,10 @@ FRESULT f_findfirst (
 <div class="para desc">
 <h4>Description</h4>
 <p>After the directory specified by <tt class="arg">path</tt> could be opened, it starts to search the directory for the item with a name specified by <tt class="arg">pattern</tt>. If found, the information about the object is stored into the file information structure. For more information about file information structure, refer to <a href="readdir.html"><tt>f_readdir</tt></a> function.</p>
-<p>The matching pattern can contain wildcard characters (<tt>?</tt> and <tt>*</tt>). A <tt>?</tt> matches an any character and an <tt>*</tt> matches an any string in length of zero or longer. At LFN configuration, both names of the item, SFN and LFN (if exist), are tested. In this revision, there are some differences listed below between FatFs and reference systems in matching condition.</p>
+<p>The matching pattern can contain wildcard characters (<tt>?</tt> and <tt>*</tt>). A <tt>?</tt> matches an any character and an <tt>*</tt> matches an any string in length of zero or longer. At LFN configuration, both names of the item, SFN and LFN (if exist), are tested. In this revision, there are some differences listed below between FatFs and standard systems in matching condition.</p>
 <ul>
-<li><tt>"*.*"</tt> never matches any name without extension. (It matches all names at the reference systems)</li>
-<li>Any pattern terminated with a period like <tt>"*."</tt> never matches any name. (It matches any names without extensiton at the reference systems)</li>
+<li><tt>"*.*"</tt> never matches any name without extension. (It matches all names at the standard systems)</li>
+<li>Any pattern terminated with a period never matches any name. (It matches the names without extensiton at the standard systems)</li>
 <li><a href="filename.html#case">DBCS extended characters</a> are compared in case-sensitive at LFN with non-Unicode configuration.</li>
 </ul>
 </div>
@@ -90,7 +90,7 @@ void find_image (void)
 <span class="k">#if</span> _USE_LFN
    char lfn[_MAX_LFN + 1];
    fno.lfname = lfn;
-    fno.lfsize = sizeof lfn;
+    fno.lfsize = _MAX_LFN + 1;
 <span class="k">#endif</span>

    fr = f_findfirst(&amp;dj, &amp;fno, "", "dsc*.jpg");  <span class="c">/* Start to search for JPEG files with the name started by "dsc" */</span>
@@ -26,7 +26,7 @@ FRESULT f_findnext (
 <h4>Parameters</h4>
 <dl class="par">
 <dt>dp</dt>
-<dd>Pinter to the valid directory object created by <tt>f_findfirst</tt> function.</dd>
+<dd>Pointer to the valid directory object created by <tt>f_findfirst</tt> function.</dd>
 <dt>fno</dt>
 <dd>Pointer to the file information structure to store the information about the found directory item.</dd>
 </dl>
@@ -45,7 +45,6 @@ FRESULT f_forward (
 <a href="rc.html#ok">FR_OK</a>,
 <a href="rc.html#de">FR_DISK_ERR</a>,
 <a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
 <a href="rc.html#tm">FR_TIMEOUT</a>
 </p>
@@ -13,7 +13,7 @@

 <div class="para func">
 <h2>f_getcwd</h2>
-<p>The f_getcwd function retrieves the current directory.</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>
@@ -27,7 +27,7 @@ FRESULT f_getfree (
 <h4>Parameters</h4>
 <dl class="par">
 <dt>path</dt>
-<dd>Pinter to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. A null-string means the default drive.</dd>
+<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. A null-string means the default drive.</dd>
 <dt>nclst</dt>
 <dd>Pointer to the <tt>DWORD</tt> variable to store number of free clusters.</dd>
 <dt>fatfs</dt>
@@ -53,7 +53,7 @@ FRESULT f_getfree (

 <div class="para desc">
 <h4>Descriptions</h4>
-<p>The <tt>f_getfree</tt> function gets number of free clusters on the volume. The member <tt>csize</tt> in the file system object indicates number of sectors per cluster, so that the free space in unit of sector can be calcurated with this information. When FSINFO structure on the FAT32 volume is not in sync, this function can return an incorrect free cluster count. To avoid this problem, FatFs can be forced full FAT scan by <tt>_FS_NOFSINFO</tt> option.</p>
+<p>The <tt>f_getfree</tt> function gets number of free clusters on the volume. The member <tt>csize</tt> in the file system object indicates number of sectors per cluster, so that the free space in unit of sector can be calcurated with this information. When FSINFO structure on the FAT32 volume is not in sync, this function can return an incorrect free cluster count. To avoid this problem, FatFs can be forced full FAT scan by <tt><a href="config.html#fs_nofsinfo">_FS_NOFSINFO</a></tt> option.</p>
 </div>


@@ -40,7 +40,6 @@ FRESULT f_lseek (
 <a href="rc.html#ok">FR_OK</a>,
 <a href="rc.html#de">FR_DISK_ERR</a>,
 <a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
 <a href="rc.html#tm">FR_TIMEOUT</a>
 </p>
@@ -54,14 +53,14 @@ FRESULT f_lseek (
 <li>End of file. The specified <tt class="arg">ofs</tt> was clipped at end of the file because the file has been opened in read-only mode.</li>
 <li>Disk full. There is insufficient free space on the volume to expand the file.</li>
 </ul>
-<p>Fast seek feature is enabled when <tt>_USE_FASTSEEK</tt> is set to 1 and the member <tt>cltbl</tt> in the file object is not NULL. This feature enables fast backward/long seek operations without FAT access by using CLMT (cluster link map table). The fast seek feature is also applied to <tt>f_read</tt> and <tt>f_write</tt> function, however, the file size cannot be expanded by <tt>f_write</tt>, <tt>f_lseek</tt> function.</p>
-<p>The CLMT must be created in the user defined <tt>DWORD</tt> array prior to use the fast seek feature. To create the CLMT, set address of the <tt>DWORD</tt> array to the member <tt>cltbl</tt> in the file object, set the array size in unit of items into the first item and call the <tt>f_lseek</tt> function with <tt class="arg">ofs</tt><tt> = CREATE_LINKMAP</tt>. After the function succeeded and CLMT is created, no FAT access is occured at subsequent <tt>f_read</tt>, <tt>f_write</tt>, <tt>f_lseek</tt> function to the file. If the function failed with <tt>FR_NOT_ENOUGH_CORE</tt>, the given array size is insufficient for the file and number of items required is returned into the first item of the array. The required array size is (number of fragments + 1) * 2 items. For example, when the file is fragmented in 5, 12 items will be required for the CLMT.</p>
+<p>The fast seek feature enables fast backward/long seek operations without FAT access by using an on-memory CLMT (cluster link map table). It is applied to <tt>f_read</tt> and <tt>f_write</tt> function as well, however, the file size cannot be expanded by <tt>f_write</tt>, <tt>f_lseek</tt> function while the file is in fast seek mode.</p>
+<p>The fast seek feature is enabled when the member <tt>cltbl</tt> in the file object is not NULL. The CLMT must be created into the <tt>DWORD</tt> array prior to use the fast seek feature. To create the CLMT, set address of the <tt>DWORD</tt> array to the member <tt>cltbl</tt> in the open file object, set the size of array in unit of items to the first item and call the <tt>f_lseek</tt> function with <tt class="arg">ofs</tt><tt> = CREATE_LINKMAP</tt>. After the function succeeded and CLMT is created, no FAT access is occured in subsequent <tt>f_read</tt>, <tt>f_write</tt>, <tt>f_lseek</tt> function to the file. The number of items used or required is returned into the first item of the array. The number of items to be used is (number of the file fragments + 1) * 2. For example, when the file is fragmented in 5, 12 items in the array will be used. If the function failed with <tt>FR_NOT_ENOUGH_CORE</tt>, the given array size is insufficient for the file.</p>
 </div>


 <div class="para comp">
 <h4>QuickInfo</h4>
-<p>Available when <tt>_FS_MINIMIZE &lt;= 2</tt>.</p>
+<p>Available when <tt>_FS_MINIMIZE &lt;= 2</tt>. To use fast seek feature, <tt>_USE_FASTSEEK</tt> needs to be set 1.</p>
 </div>


@@ -94,7 +93,7 @@ FRESULT f_lseek (
    if (res || f_tell(fp) != PRE_SIZE) ...   <span class="c">/* Check if the file has been expanded */</span>

    res = f_lseek(fp, DATA_START);           <span class="c">/* Record data stream WITHOUT cluster allocation delay */</span>
-    ...                                      <span class="c">/* DATA_START and write block size should be aligned to sector boundary */</span>
+    ...                                      <span class="c">/* Write operation should be aligned to sector boundary to optimize the write throughput */</span>

    res = f_truncate(fp);                    <span class="c">/* Truncate unused area */</span>
    res = f_lseek(fp, 0);                    <span class="c">/* Put file header */</span>
@@ -107,6 +106,8 @@ FRESULT f_lseek (

    DWORD clmt[SZ_TBL];                    <span class="c">/* Cluster link map table buffer */</span>

+    res = f_open(fp, fname, FA_READ | FA_WRITE);   <span class="c">/* Open a file */</span>
+
    res = f_lseek(fp, ofs1);               <span class="c">/* This is normal seek (cltbl is nulled on file open) */</span>

    fp-&gt;cltbl = clmt;                      <span class="c">/* Enable fast seek feature (cltbl != NULL) */</span>
@@ -27,7 +27,7 @@ FRESULT f_mkfs (
 <h4>Parameters</h4>
 <dl class="par">
 <dt>path</dt>
-<dd>Pinter to the null-terminated string that specifies the <a href="filename.html">logical drive</a> to be formatted. If there is no drive number, it means the default drive.</dd>
+<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a> to be formatted. If there is no drive number, it means the default drive.</dd>
 <dt>sfd</dt>
 <dd>Specifies partitioning rule (FDISK(0) or SFD(1)). This argument will be ignored on some case.</dd>
 <dt>au</dt>
@@ -52,7 +52,7 @@ FRESULT f_mkfs (
 <div class="para desc">
 <h4>Description</h4>
 <p>The <tt>f_mkfs</tt> function creates an FAT volume on the specified logical drive. When FDISK format is specified, a primary partition occupies entire space of the physical drive is created and then an FAT volume is created on the partition. When SFD format is specified, the FAT volume starts from the first sector of the physical drive.</p>
-<p>If the logical drive is bound to the specific partition (1-4) by multiple partition feature (<tt>_MULTI_PARTITION</tt>), the FAT volume is created into the partition. In this case, the second argument <tt class="arg">sfd</tt> is ignored. The physical drive must have been partitioned with <tt>f_fdisk</tt> function or any other partitioning tools prior to create the FAT volume with this function.</p>
+<p>If the logical drive is bound to the specific partition (1-4) by multiple partition feature (<tt><a href="config.html#multi_partition">_MULTI_PARTITION</a></tt>), the FAT volume is created into the partition. In this case, the second argument <tt class="arg">sfd</tt> is ignored. The physical drive must have been partitioned with <tt>f_fdisk</tt> function or any other partitioning tools prior to create the FAT volume with this function.</p>
 <p>Note that there are two partitioning rules, FDISK and SFD. The FDISK partitioning is usually used for harddisk, MMC, SDC, CFC and U Disk. It can divide a physical drive into one or more partitions with a partition table on the MBR. However Windows does not support multiple partition on the removable disk. The SFD is non-partitioned method. The FAT volume starts from the first sector on the physical drive without partition table. It is usually used for floppy disk, Microdrive, optical disk and any type of super-floppy media.</p>
 <p>The FAT sub-type, FAT12/FAT16/FAT32, is determined by number of clusters on the volume and nothing else, according to the FAT specification issued by Microsoft. Thus which FAT sub-type is selected, is depends on the volume size and the specified cluster size. The cluster size affects read/write throughput and space usage efficiency. Larger cluster size increases the read/write throughput and decreases the space usage efficiency of the volume.</p>
 <p>In case of the number of clusters gets near the FAT sub-type boundaries, the function can fail with <tt>FR_MKFS_ABORTED</tt>.</p>
@@ -27,11 +27,11 @@ FRESULT f_mount (
 <h4>Parameters</h4>
 <dl class="par">
 <dt>fs</dt>
-<dd>Pointer to the new file system object to be registered. Null pointer unregisters the registered file system object.</dd>
+<dd>Pointer to the file system object to be registered and cleared. Null pointer unregisters the registered file system object.</dd>
 <dt>path</dt>
-<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. The string with no drive number means the default drive.</dd>
+<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>Initialization option. 0: Do not mount now (to be mounted later), 1: Force mounted the volume to check if the FAT volume is available.</dd>
+<dd>Initialization option. 0: Do not mount now (to be mounted later), 1: Force mounted the volume to check if the FAT volume is ready to work.</dd>
 </dl>
 </div>

@@ -56,13 +56,13 @@ FRESULT f_mount (
 <li>Clears and registers the new work area to the drive if <tt class="arg">fs</tt> is not NULL.</li>
 <li>Performs volume mount process to the drive if forced mount is specified.</li>
 </ol>
-<p>The file system object is the work area needed for each logical drive. It must be given to the logical drive with this function prior to use any other file functions except for <tt>f_fdisk</tt> function. To unregister the work area, specify a NULL to the <tt class="arg">fs</tt>, and then the work area can be discarded.</p>
+<p>The file system object is the work area needed for each logical drive. It must be given to the logical drive with this function prior to use any other file functions except for <tt>f_fdisk</tt> function to the logical drive. To unregister the work area, specify a NULL to the <tt class="arg">fs</tt>, and then the work area can be discarded.</p>
 <p>If forced mounting is not specified, this function always succeeds regardless of the physical drive status due to delayed mount feature. It only clears (de-initializes) the given work area and registers its address to the internal table. No activity of the physical drive in this function. It can also be used to force de-initialized the registered work area of a logical drive. The volume mount processes, initialize the corresponding physical drive, find the FAT volume in it and initialize the work area, is performed in the subsequent file access functions when either or both of following condition is true.</p>
 <ul>
-<li>File system object is not initialized. It is cleared by <tt>f_mount</tt> function.</li>
+<li>File system object is not 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>
 </ul>
-<p>If the function with forced mounting failed, it means that the file system object has been registered successfully but the volume is currently not ready to use. Mount process will also be attempted in subsequent file access functions.</p>
+<p>If the function with forced mounting failed, it means that the file system object has been registered successfully but the volume is currently not ready to work. The volume mount process will also be attempted at subsequent file access functions.</p>
 <p>If implementation of the disk I/O layer lacks media change detection, application program needs to perform a <tt>f_mount</tt> function after each media change to force cleared the file system object.</p>
 </div>

@@ -27,18 +27,18 @@ FRESULT f_open (
 <h4>Parameters</h4>
 <dl class="par">
 <dt>fp</dt>
-<dd>Pointer to the blank file object structure to be created.</dd>
+<dd>Pointer to the blank file object structure.</dd>
 <dt>path</dt>
-<dd>Pointer to a null-terminated string that specifies the <a href="filename.html">file name</a> to open or create.</dd>
+<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">file name</a> to open or create.</dd>
 <dt>mode</dt>
 <dd>Mode flags that specifies the type of access and open method for the file. It is specified by a combination of following flags.<br>
 <table class="lst">
 <tr><th>Value</th><th>Description</th></tr>
-<tr><td>FA_READ</td><td>Specifies read access to the object. Data can be read from the file. Combine with <tt>FA_WRITE</tt> for read-write access.</td></tr>
+<tr><td>FA_READ</td><td>Specifies read access to the object. Data can be read from the file.</tr>
 <tr><td>FA_WRITE</td><td>Specifies write access to the object. Data can be written to the file. Combine with <tt>FA_READ</tt> for read-write access.</td></tr>
 <tr><td>FA_OPEN_EXISTING</td><td>Opens the file. The function fails if the file is not existing. (Default)</td></tr>
-<tr><td>FA_OPEN_ALWAYS</td><td>Opens the file if it is existing. If not, a new file is created.<br>
-To append data to the file, use <a href="lseek.html"><tt>f_lseek</tt></a> function after file open in this method.</td></tr>
+<tr><td>FA_OPEN_ALWAYS</td><td>Opens the file if it is existing. If not, a new file will be created.<br>
+To append data to the file, use <a href="lseek.html"><tt>f_lseek</tt></a> function after the file open in this method.</td></tr>
 <tr><td>FA_CREATE_NEW</td><td>Creates a new file. The function fails with <tt>FR_EXIST</tt> if the file is existing.</td></tr>
 <tr><td>FA_CREATE_ALWAYS</td><td>Creates a new file. If the file is existing, it will be truncated and overwritten.</td></tr>
 </table>
@@ -74,9 +74,9 @@ To append data to the file, use <a href="lseek.html"><tt>f_lseek</tt></a> functi

 <div class="para desc">
 <h4>Description</h4>
-<p>After <tt>f_open</tt> function succeeded, the file object is valid. The file object is used for subsequent read/write functions to identify the file. Open files must be closed prior to shutdown, media removal or re-mount, or the file data will be collapsed. To close an open file, use <a href="close.html"><tt>f_close</tt></a> function.</p>
-<p>If duplicated file open is needed, read <a href="appnote.html#dup">here</a> carefully. However duplicated open of a file with write mode flag is always prohibited.</p>
 <p>Before using any file function, a work area (file system object) must be registered to the logical drive with <a href="mount.html"><tt>f_mount</tt></a> function. All API functions except for <a href="fdisk.html"><tt>f_fdisk</tt></a> function can work after this procedure.</p>
+<p>After <tt>f_open</tt> function succeeded, the file object is valid. The file object is used for subsequent operations to the file to identify the file. Open file must be closed prior to power down, media removal or re-mount, or the file can be collapsed. To close an open file, use <a href="close.html"><tt>f_close</tt></a> function.</p>
+<p>If duplicated file open is needed, read <a href="appnote.html#dup">here</a> carefully. However duplicated open of a file with any write mode flag is always prohibited.</p>
 </div>


@@ -134,11 +134,11 @@ int main (void)
    f_mount(&amp;fs[1], "1:", 0);

    <span class="c">/* Open source file on the drive 1 */</span>
-    fr = f_open(&amp;fsrc, "1:file.bin", FA_OPEN_EXISTING | FA_READ);
+    fr = f_open(&amp;fsrc, "1:file.bin", FA_READ);
    if (fr) return (int)fr;

    <span class="c">/* Create destination file on the drive 0 */</span>
-    fr = f_open(&amp;fdst, "0:file.bin", FA_CREATE_ALWAYS | FA_WRITE);
+    fr = f_open(&amp;fdst, "0:file.bin", FA_WRITE | FA_CREATE_ALWAYS);
    if (fr) return (int)fr;

    <span class="c">/* Copy source to destination */</span>
@@ -28,7 +28,7 @@ FRESULT f_opendir (
 <dt>dp</dt>
 <dd>Pointer to the blank directory object to create a new one.</dd>
 <dt>path</dt>
-<dd>Pinter to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>
+<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>
 </dl>
 </div>

@@ -27,7 +27,7 @@
 Note that if once this error occured at any operation to an open file, the file object is aborted and all operations to the file except for close will be rejected.
 </dd>
 <dt id="nr">FR_NOT_READY</dt>
-<dd>The disk drive cannot work due to incorrect medium removal or <tt>disk_initialize</tt> function failed.</dd>
+<dd>The storage device cannot work due to a failure of <a href="dinit.html"><tt>disk_initialize</tt></a> function due to no medium or any other reason.</dd>
 <dt id="nf">FR_NO_FILE</dt>
 <dd>Could not find the file.</dd>
 <dt id="np">FR_NO_PATH</dt>
@@ -49,11 +49,17 @@ Note that if once this error occured at any operation to an open file, the file
 <dt id="ex">FR_EXIST</dt>
 <dd>Name collision. Any object that has the same name is already existing.</dd>
 <dt id="io">FR_INVALID_OBJECT</dt>
-<dd>The file/directory object structure is invalid or a null pointer is given. All open objects of the logical drive are invalidated by the voulme mount process.</dd>
+<dd>The file/directory object is invalid or a null pointer is given. There are some reasons as follows:
+<ul>
+<li>It has been closed, it is not opened or it can be collapsed.</li>
+<li>It has been invalidated by a voulme mount process. All open objects of the volume are invalidated as well.</li>
+<li>The corresponding physical drive is not ready due to a media removal.</li>
+</ul>
+</dd>
 <dt id="wp">FR_WRITE_PROTECTED</dt>
 <dd>Any write mode operation against the write-protected media.</dd>
 <dt id="id">FR_INVALID_DRIVE</dt>
-<dd>Invalid drive number is specified in the path name. A null pointer is given as the path name. (Related option: <tt>_VOLUMES</tt>)</dd>
+<dd>Invalid drive number is specified in the path name. A null pointer is given as the path name. (Related option: <tt><a href="config.html#volumes">_VOLUMES</a></tt>)</dd>
 <dt id="ne">FR_NOT_ENABLED</dt>
 <dd>Work area for the logical drive has not been registered by <tt>f_mount</tt> function.</dd>
 <dt id="ns">FR_NO_FILESYSTEM</dt>
@@ -63,25 +69,26 @@ Note that if once this error occured at any operation to an open file, the file
 <ul>
 <li>The disk/partition size is too small.</li>
 <li>Not allowable cluster size for this disk. This can occure when number of clusters gets near the boundaries of FAT sub-types.</li>
-<li>There is no partition related to the logical drive. (Related option: <tt>_MULTI_PARTITION</tt>)</li>
+<li>There is no partition related to the logical drive. (Related option: <tt><a href="config.html#multi_partition">_MULTI_PARTITION</a></tt>)</li>
 </ul>
 </dd>
 <dt id="tm">FR_TIMEOUT</dt>
-<dd>The function was canceled due to a timeout of <a href="appnote.html#reentrant">thread-safe control</a>. (Related option: <tt>_TIMEOUT</tt>)</dd>
+<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">_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>_FS_LOCK</tt>)</dd>
+<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">_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>_USE_LFN</tt>)</li>
+<li>Could not allocate a memory for LFN working buffer. (Related option: <tt><a href="config.html#use_lfn">_USE_LFN</a></tt>)</li>
 <li>Size of the given buffer is insufficient for the size required.</li>
 </ul>
 </dd>
 <dt id="tf">FR_TOO_MANY_OPEN_FILES</dt>
-<dd>Number of open objects has been reached maximum value and no more object can be opened. (Related option: <tt>_FS_LOCK</tt>)</dd>
+<dd>Number of open objects has been reached maximum value and no more object can be opened. (Related option: <tt><a href="config.html#fs_lock">_FS_LOCK</a></tt>)</dd>
 <dt id="ip">FR_INVALID_PARAMETER</dt>
 <dd>The given parameter is invalid or there is any inconsistent.</dd>
 </dl>

+<p class="foot"><a href="../00index_e.html">Return</a></p>
 </body>
 </html>
@@ -45,7 +45,6 @@ FRESULT f_read (
 <a href="rc.html#ok">FR_OK</a>,
 <a href="rc.html#de">FR_DISK_ERR</a>,
 <a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
 <a href="rc.html#tm">FR_TIMEOUT</a>
 </p>
@@ -26,7 +26,7 @@ FRESULT f_readdir (
 <h4>Parameters</h4>
 <dl class="par">
 <dt>dp</dt>
-<dd>Pointer to the directory object opened by <tt>f_opendir</tt> function.</dd>
+<dd>Pointer to the directory object created by <tt>f_opendir</tt> function.</dd>
 <dt>fno</dt>
 <dd>Pointer to the file information structure to store the information about read item.</dd>
 </dl>
@@ -39,7 +39,6 @@ FRESULT f_readdir (
 <a href="rc.html#ok">FR_OK</a>,
 <a href="rc.html#de">FR_DISK_ERR</a>,
 <a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
 <a href="rc.html#tm">FR_TIMEOUT</a>,
 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
@@ -49,14 +48,13 @@ FRESULT f_readdir (

 <div class="para desc">
 <h4>Description</h4>
-<p>The <tt>f_readdir</tt> function reads directory items, informations about file and directory, in sequence. All items in the directory can be read by calling <tt>f_readdir</tt> function repeatedly. When relative path feature is enabled (<tt>_FS_RPATH &gt;= 1</tt>), dot entries (<tt>"."</tt> and <tt>".."</tt>) are not filtered out and they will appear in the read items. When all directory items have been read and no item to read, a null string is stored into the <tt>fno-&gt;fname[]</tt> without any error. When a null pointer is given to the <tt class="arg">fno</tt>, the read index of the directory object is rewinded.</p>
-<p>When LFN feature is enabled, <tt>lfname</tt> and <tt>lfsize</tt> in the file information structure must be initialized with valid value prior to use it. The <tt>lfname</tt> is a pointer to the LFN read buffer. The <tt>lfsize</tt> is size of the LFN read buffer in unit of <tt>TCHAR</tt>. If the LFN is not needed, set a null pointer to the <tt>lfname</tt> and the LFN is not returned. A null string will be returned into the LFN read buffer in case of following conditions.</p>
+<p>The <tt>f_readdir</tt> function reads directory items, informations about file and directory, in sequence. All items in the directory can be read by calling <tt>f_readdir</tt> function repeatedly. When relative path feature is enabled (<tt><a href="config.html#fs_rpath">_FS_RPATH</a> &gt;= 1</tt>), dot entries (<tt>"."</tt> and <tt>".."</tt>) are not filtered out and they will appear in the read items. When all directory items have been read and no item to read, a null string is stored into the <tt>fno-&gt;fname[]</tt> without any error. When a null pointer is given to the <tt class="arg">fno</tt>, the read index of the directory object is rewinded.</p>
+<p>When LFN feature is enabled, <tt>fno-&gt;lfname</tt> and <tt>fno-&gt;lfsize</tt> in the file information structure must be initialized with valid value prior to use it. The <tt>lfname</tt> points the LFN read buffer. The <tt>lfsize</tt> is size of the LFN read buffer in unit of <tt>TCHAR</tt>. If the LFN is not needed, set a null pointer to the <tt>lfname</tt> and the LFN is not returned. A null string will be returned into the LFN read buffer in case of following conditions.</p>
 <ul>
-<li>The directory item has no LFN information.</li>
+<li>The directory item has no LFN information. In this case, lower case characters can be contained in the <tt>fname[]</tt>.</li>
 <li>Either the size of read buffer or LFN working buffer is insufficient for the LFN.</li>
-<li>The LFN contains any Unicode character that cannot be converted to OEM code. (not the case at Unicode API cfg.)</li>
+<li>The LFN contains any Unicode character that cannot be converted to OEM code. (Not the case at Unicode API configuration)</li>
 </ul>
-<p>When the directory item has no LFN, lower case characters can be contained in the <tt>fname[]</tt>.</p>
 </div>


@@ -26,9 +26,9 @@ FRESULT f_rename (
 <h4>Parameters</h4>
 <dl class="par">
 <dt>old_name</dt>
-<dd>Pointer to a null-terminated string that specifies an existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd>
+<dd>Pointer to a 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. The drive number specified in this string is ignored and one determined by <tt class="arg">old_name</tt> is used instead.</dd>
+<dd>Pointer to a null-terminated string that specifies the new object name. Any 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>.</dd>
 </dl>
 </div>

@@ -58,7 +58,7 @@ 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 logical drive. The object must not be opened, or <em>the FAT volume can be collapsed</em>. It will be rejected when <a href="appnote.html#dup">file lock feature</a> is enabled.</p>
+<p>Renames a file or sub-directory and can also move it to other directory in the same logical drive. The object to be renamed must not be an open object, or <em>the FAT volume can be collapsed</em>. Such the wrong operation can be rejected safely when <a href="appnote.html#dup">file lock feature</a> is enabled.</p>
 </div>


@@ -71,11 +71,14 @@ FRESULT f_rename (
 <div class="para use">
 <h4>Example</h4>
 <pre>
-    <span class="c">/* Rename an object */</span>
+    <span class="c">/* Rename an object in the default drive */</span>
    f_rename("oldname.txt", "newname.txt");

-    <span class="c">/* Rename and move an object to other directory */</span>
-    f_rename("oldname.txt", "dir1/newname.txt");
+    <span class="c">/* Rename an object in the drive 2 */</span>
+    f_rename("2:oldname.txt", "newname.txt");
+
+    <span class="c">/* Rename an object and move it to other directory */</span>
+    f_rename("log.txt", "old/log0001.txt");
 </pre>
 </div>

@@ -51,11 +51,11 @@ FRESULT f_setlabel (
 <h4>Description</h4>
 <p>When the string has a drive number, the volume label will be set to the volume specified by the drive number. If not, the volume label will be set to the default drive. If length of the given volume label is zero, the volume label on the volume will be removed. The format of the volume label is similar to the short file name but there are some differences shown below:</p>
 <ul>
-<li>11 bytes or less in length as conversion into OEM code page. LFN extension is not applied to the volume label.</li>
+<li>11 bytes or less in length as conversion into OEM code page. LFN feature is not applied to the volume label.</li>
 <li>Cannot contain period.</li>
-<li>Can contain spaces anywhere in the volume label. Trailing spaces are truncated off.</li>
+<li>Can contain spaces anywhere in it. Trailing spaces are truncated off.</li>
 </ul>
-<p>Remark: The reference system (Windows) has a problem on handling of the volume label with a heading <tt>\xE5</tt>. To avoid this problem, this function rejects such volume labels as invalid name.</p>
+<p>Remark: The standard system (Windows) has a problem on handling of the volume label with a heading <tt>\xE5</tt>. To avoid this problem, this function rejects such volume labels as invalid name.</p>
 </div>

 <div class="para comp">
@@ -39,7 +39,7 @@ DWORD f_size (

 <div class="para desc">
 <h4>Description</h4>
-<p>In this revision, the <tt>f_size</tt> function is implemented as a macro.</p>
+<p>In this revision, the <tt>f_size</tt> function is implemented as a macro. It has not any validation and mutual exclusion.</p>
 <pre>
 <span class="k">#define</span> f_size(fp) ((fp)->fsize)
 </pre>
@@ -36,7 +36,6 @@ FRESULT f_sync (
 <a href="rc.html#ok">FR_OK</a>,
 <a href="rc.html#de">FR_DISK_ERR</a>,
 <a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
 <a href="rc.html#tm">FR_TIMEOUT</a>
 </p>
@@ -39,7 +39,7 @@ DWORD f_tell (

 <div class="para desc">
 <h4>Description</h4>
-<p>In this revision, the <tt>f_tell</tt> function is implemented as a macro.</p>
+<p>In this revision, the <tt>f_tell</tt> function is implemented as a macro. It has not any validation and mutual exclusion.</p>
 <pre>
 <span class="k">#define</span> f_tell(fp) ((fp)->fptr)
 </pre>
@@ -36,7 +36,6 @@ FRESULT f_truncate (
 <a href="rc.html#ok">FR_OK</a>,
 <a href="rc.html#de">FR_DISK_ERR</a>,
 <a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
 <a href="rc.html#tm">FR_TIMEOUT</a>
 </p>
@@ -25,7 +25,7 @@ FRESULT f_unlink (
 <h4>Parameter</h4>
 <dl class="par">
 <dt>path</dt>
-<dd>Pointer to the null-terminated string that specifies an <a href="filename.html">object</a> to be removed.</dd>
+<dd>Pointer to a null-terminated string that specifies the <a href="filename.html">file or sub-directory</a> to be removed.</dd>
 </dl>
 </div>

@@ -59,7 +59,7 @@ FRESULT f_unlink (
 If condition of the object to be removed is applicable to the following terms, the function will be rejected.<ul>
 <li>The file/sub-directory must not have read-only attribute (<tt>AM_RDO</tt>), or the function will be rejected with <tt>FR_DENIED</tt>.</li>
 <li>The sub-directory must be empty and must not be current directory, or the function will be rejected with <tt>FR_DENIED</tt>.</li>
-<li>The file/sub-directory must not be opened, or the <em>FAT volume can be collapsed</em>. It will be rejected when <a href="appnote.html#dup">file lock feature</a> is enabled.</li>
+<li>The file/sub-directory must not be opened, or the <em>FAT volume can be collapsed</em>. It will be rejected safely when <a href="appnote.html#dup">file lock feature</a> is enabled.</li>
 </ul>
 </div>

@@ -45,7 +45,6 @@ FRESULT f_write (
 <a href="rc.html#ok">FR_OK</a>,
 <a href="rc.html#de">FR_DISK_ERR</a>,
 <a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
 <a href="rc.html#tm">FR_TIMEOUT</a>
 </p>