What changed, and why it matters
This commit updates the third-party FatFs file-system library inside the BitBox02 firmware from version R0.14b to R0.16 plus an upstream patch. The change is a routine dependency refresh: it replaces the vendored source files with the newer upstream release while keeping BitBox's existing configuration (long-file-name support, tiny mode, code page 850, fixed timestamps, no exFAT, no labels, no 64-bit LBA). Most of the visible diff is documentation and metadata; the actual C source files (ff.c, ff.h, ffconf.h, diskio.c, etc.) are updated wholesale. The commit message does not claim to fix any security issue, and no independent security advisory or CVE is supplied.
Treat as a standard dependency maintenance update. Review the upstream FatFs R0.16 and patch 1 changelogs for any security-relevant fixes, run the project's existing firmware tests for SD card / filesystem operations, and verify that the preserved ffconf.h settings still compile and behave correctly with the new upstream sources. No immediate security response is indicated by the commit itself.
Security signals we found
Third-party dependency update (FatFs R0.14b -> R0.16+p1)
No explicit security claim in commit message
No CVE or advisory referenced in commit or supplied references
Configuration preserved: LFN enabled, tiny mode, mkfs support, code page 850, fixed timestamps, exFAT/labels/LBA64 disabled
Potential for upstream bug fixes (including possible filesystem correctness/security fixes) introduced by version bump, but not identifiable from the provided diff
Evidence from the diff
The commit is a bulk vendor import of FatFs R0.16+p1 into src/rust/fatfs-sys/depend/fatfs. It deletes the old R0.14b tree and adds the new R0.16 tree. The BitBox-specific ffconf.h choices are preserved, so functional behavior for the firmware should remain largely unchanged except for upstream bug fixes and minor API renames (e.g., sync-object functions renamed from ff_cre_syncobj/ff_del_syncobj/ff_req_grant/ff_rel_grant to ff_mutex_create/ff_mutex_delete/ff_mutex_take/ff_mutex_give, and FF_FS_RPATH renamed to FF_RPATH in documentation). The diff provided is almost entirely HTML documentation; the C code diff is not shown in detail, so individual upstream fixes cannot be verified from the supplied material alone.
Changed components
src/rust/fatfs-sys/depend/fatfs/source/ff.csrc/rust/fatfs-sys/depend/fatfs/source/ff.hsrc/rust/fatfs-sys/depend/fatfs/source/ffconf.hsrc/rust/fatfs-sys/depend/fatfs/source/diskio.csrc/rust/fatfs-sys/depend/fatfs/source/diskio.hsrc/rust/fatfs-sys/depend/fatfs/source/ffsystem.csrc/rust/fatfs-sys/depend/fatfs/source/ffunicode.cInspect captured patch +3842 / −2569
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/00index_e.html b/src/rust/fatfs-sys/depend/fatfs/documents/00index_e.html
deleted file mode 100644
index 0c20aa7..0000000
--- a/src/rust/fatfs-sys/depend/fatfs/documents/00index_e.html
+++ /dev/null
@@ -1,146 +0,0 @@
-<!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 name="description" content="Open source FAT filesystem for embedded projects">
-<link rel="stylesheet" href="css_e.css" type="text/css" media="screen" title="ELM Default">
-<title>FatFs - Generic FAT Filesystem Module</title>
-</head>
-
-<body>
-<h1>FatFs - Generic FAT Filesystem Module</h1>
-<hr>
-
-<div class="abst">
-<img src="res/layers.png" class="rset" width="245" height="255" alt="layer">
-<p>FatFs is a generic FAT/exFAT filesystem module for small embedded systems. The FatFs module is written in compliance with ANSI C (C89) and completely separated from the disk I/O layer. Therefore it is independent of the platform. It can be incorporated into small microcontrollers with limited resource, such as 8051, PIC, AVR, ARM, Z80, RX and etc. Also Petit FatFs module for tiny microcontrollers is available <a href="http://elm-chan.org/fsw/ff/00index_p.html">here</a>.</p>
-
-<h4>Features</h4>
-<ul>
- <li>DOS/Windows compatible FAT/exFAT filesystem.</li>
- <li>Platform independent. <a href="doc/appnote.html#port">Easy to port</a>.</li>
- <li>Very small <a href="doc/appnote.html#memory">footprint</a> for program code and work area.</li>
- <li>Various <a href="doc/config.html">configuration options</a> to support for:
- <ul>
- <li>Long file name in ANSI/OEM or Unicode.</li>
- <li>exFAT filesystem, 64-bit LBA and GPT for huge storages.</li>
- <li>Thread safe for RTOS.</li>
- <li>Multiple volumes. (physical drives and partitions)</li>
- <li>Variable sector size.</li>
- <li>Multiple code pages including DBCS.</li>
- <li>Read-only, optional APIs, I/O buffer and etc...</li>
- </ul>
- </li>
-</ul>
-</div>
-
-
-<div class="para">
-<h3>Application Interface</h3>
-<img src="res/layers1.png" class="rset" width="245" height="220" alt="layer">
-<p>FatFs provides various filesystem functions for the applications as shown below.</p>
-<ul>
- <li>File Access
- <ul>
- <li><a href="doc/open.html">f_open</a> - Open/Create a file</li>
- <li><a href="doc/close.html">f_close</a> - Close an open file</li>
- <li><a href="doc/read.html">f_read</a> - Read data from the file</li>
- <li><a href="doc/write.html">f_write</a> - Write data to the file</li>
- <li><a href="doc/lseek.html">f_lseek</a> - Move read/write pointer, Expand size</li>
- <li><a href="doc/truncate.html">f_truncate</a> - Truncate file size</li>
- <li><a href="doc/sync.html">f_sync</a> - Flush cached data</li>
- <li><a href="doc/forward.html">f_forward</a> - Forward data to the stream</li>
- <li><a href="doc/expand.html">f_expand</a> - Allocate a contiguous block to the file</li>
- <li><a href="doc/gets.html">f_gets</a> - Read a string</li>
- <li><a href="doc/putc.html">f_putc</a> - Write a character</li>
- <li><a href="doc/puts.html">f_puts</a> - Write a string</li>
- <li><a href="doc/printf.html">f_printf</a> - Write a formatted string</li>
- <li><a href="doc/tell.html">f_tell</a> - Get current read/write pointer</li>
- <li><a href="doc/eof.html">f_eof</a> - Test for end-of-file</li>
- <li><a href="doc/size.html">f_size</a> - Get size</li>
- <li><a href="doc/error.html">f_error</a> - Test for an error</li>
- </ul>
- </li>
- <li>Directory Access
- <ul>
- <li><a href="doc/opendir.html">f_opendir</a> - Open a directory</li>
- <li><a href="doc/closedir.html">f_closedir</a> - Close an open directory</li>
- <li><a href="doc/readdir.html">f_readdir</a> - Read a directory item</li>
- <li><a href="doc/findfirst.html">f_findfirst</a> - Open a directory and read the first item matched</li>
- <li><a href="doc/findnext.html">f_findnext</a> - Read a next item matched</li>
- </ul>
- </li>
- <li>File and Directory Management
- <ul>
- <li><a href="doc/stat.html">f_stat</a> - Check existance of a file or sub-directory</li>
- <li><a href="doc/unlink.html">f_unlink</a> - Remove a file or sub-directory</li>
- <li><a href="doc/rename.html">f_rename</a> - Rename/Move a file or sub-directory</li>
- <li><a href="doc/chmod.html">f_chmod</a> - Change attribute of a file or sub-directory</li>
- <li><a href="doc/utime.html">f_utime</a> - Change timestamp of a file or sub-directory</li>
- <li><a href="doc/mkdir.html">f_mkdir</a> - Create a sub-directory</li>
- <li><a href="doc/chdir.html">f_chdir</a> - Change current directory</li>
- <li><a href="doc/chdrive.html">f_chdrive</a> - Change current drive</li>
- <li><a href="doc/getcwd.html">f_getcwd</a> - Retrieve the current directory and drive</li>
- </ul>
- </li>
- <li>Volume Management and System Configuration
- <ul>
- <li><a href="doc/mount.html">f_mount</a> - Register/Unregister the work area of the volume</li>
- <li><a href="doc/mkfs.html">f_mkfs</a> - Create an FAT volume on the logical drive</li>
- <li><a href="doc/fdisk.html">f_fdisk</a> - Create partitions on the physical drive</li>
- <li><a href="doc/getfree.html">f_getfree</a> - Get free space on the volume</li>
- <li><a href="doc/getlabel.html">f_getlabel</a> - Get volume label</li>
- <li><a href="doc/setlabel.html">f_setlabel</a> - Set volume label</li>
- <li><a href="doc/setcp.html">f_setcp</a> - Set active code page</li>
- </ul>
- </li>
-</ul>
-</div>
-
-
-<div class="para">
-<h3>Media Access Interface</h3>
-<img src="res/layers2.png" class="rset" width="245" height="220" alt="layer">
-<p>Since FatFs module is the <em>Filesystem Layer</em> independent of platforms and storage media, it is completely separated from the physical devices, such as memory card, harddisk and any type of storage device. The storage device control module is <em>not any part of FatFs module</em> and it needs to be provided by implementer. FatFs controls the storage devices via a simple media access interface shown below. Also sample implementations for some platforms are available in the downloads. A function checker for storage device control module is available <a href="res/app4.c">here</a>.</p>
-<ul>
- <li>Storage Device Controls
- <ul>
- <li><a href="doc/dstat.html">disk_status</a> - Get device status</li>
- <li><a href="doc/dinit.html">disk_initialize</a> - Initialize device</li>
- <li><a href="doc/dread.html">disk_read</a> - Read data</li>
- <li><a href="doc/dwrite.html">disk_write</a> - Write data</li>
- <li><a href="doc/dioctl.html">disk_ioctl</a> - Control device dependent functions</li>
- </ul>
- </li>
- <li>Real Time Clock
- <ul>
- <li><a href="doc/fattime.html">get_fattime</a> - Get current time</li>
- </ul>
- </li>
-</ul>
-</div>
-
-
-<div class="para">
-<h3>Resources</h3>
-<p>The FatFs module is a free software opened for education, research and development. You can use, modify and/or redistribute it for any purpose without any restriction under your responsibility. For further information, refer to the application note.</p>
-<ul>
- <li><em>Getting Started: <a href="doc/appnote.html">FatFs Application Node</a></em></li>
- <li>Download: <a href="http://elm-chan.org/fsw/ff/archives.html">Previous Releases</a></li>
- <li>Community: <a href="http://elm-chan.org/fsw/ff/bd/">FatFs User Forum</a></li>
- <li><a href="https://msdn.microsoft.com/en-us/windows/hardware/gg463080.aspx">FAT32 Specification by Microsoft</a>↗ (The authorized document on FAT filesystem)</li>
- <li><a href="http://elm-chan.org/docs/fat_e.html">The basics of FAT filesystem</a></li>
- <li><a href="http://elm-chan.org/docs/exfat_e.html">The basics of exFAT filesystem</a></li>
- <li><a href="http://elm-chan.org/docs/mmc/mmc_e.html">How to use MMC/SDC</a></li>
- <li><a href="http://elm-chan.org/junk/fa/faff.html">Playing with FlashAir and FatFs</a></li>
- <li><a href="http://nemuisan.blog.bai.ne.jp/">Nemuisan's Blog</a>↗ (Well written implementations for STM32F/SPI & SDIO and LPC4088/SDMMC)</li>
- <li><a href="http://stm32f4-discovery.net/2014/07/library-21-read-sd-card-fatfs-stm32f4xx-devices/">Read SD card with FatFs on STM32F4xx devices by Tilen Majerle</a>↗ (Quick and easy implementation for STM32F4-Discovery)</li>
- <li><a href="res/rwtest1.png">Benchmark 1</a> (ATmega1284/20MHz with MMC via USART in SPI, CFC via GPIO)</li>
- <li><a href="res/rwtest2.png">Benchmark 2</a> (LPC2368/72MHz with MMC via MCI)</li>
- <li><a href="res/fd.mp4">Demo movie of an application</a> (this project is in ffsample.zip/lpc23xx)</li></ul>
-</div>
-
-</body>
-</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/css_e.css b/src/rust/fatfs-sys/depend/fatfs/documents/css_e.css
index 8274af3..faa27fd 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/css_e.css
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/css_e.css
@@ -14,6 +14,7 @@ strong {}
pre {border: 1px dashed gray; margin: 0.5em 1em; padding: 0.5em; line-height: 1.2em; font-size: 85%; font-family: "Consolas", "Courier New", monospace; background-color: white;}
pre span.c {color: green;}
pre span.k {color: blue;}
+pre span.e {color: red;}
pre span.b {font-weight: bold;}
pre span.arg {font-style: italic;}
tt {margin: 0 0.2em; font-size: 0.85em; font-family: "Consolas", "Courier New", monospace; }
@@ -30,6 +31,7 @@ hr {border-width: 1px; margin: 1em;}
div.abst {font-family: sans-serif;}
div.para {clear: both; font-family: serif;}
div.ret a {font-size: 0.85em; font-family: "Consolas", "Courier New", monospace; }
+ul.plain {margin: 0 0 0 1em;}
.equ {text-indent: 0; margin: 1em 2em 1em;}
.indent {margin-left: 2em;}
.rset {float: right; margin: 0.3em 0 0.5em 0.5em;}
@@ -37,6 +39,7 @@ div.ret a {font-size: 0.85em; font-family: "Consolas", "Courier New", monospace;
ul.flat li {list-style-type: none; margin: 0;}
a.imglnk img {border: 1px solid;}
.iequ {white-space: nowrap; font-weight: bold;}
+.lnk {opacity: 0.5;}
.clr {clear: both;}
.it {font-style: italic;}
.mfd {font-size: 0.7em; padding: 0 1px; border: 1px solid; white-space : nowrap}
@@ -57,13 +60,16 @@ small {font-size: 80%;}
.indent {margin-left: 2em;}
/* Tables */
-table {margin: 0.5em 1em; border-collapse: collapse; border: 2px solid black; }
-th {background-color: white; border-style: solid; border-width: 1px 1px 2px; border-color: black; padding: 0 3px; vertical-align: top; white-space: nowrap;}
-td {background-color: white; border: 1px solid black; padding: 0 3px; vertical-align: top; line-height: 1.3em;}
+table {margin: 0.5em 1em; border-collapse: collapse; border: 2px solid gray; }
+table caption {font-family: sans-serif; font-weight: bold;}
+table th {background-color: white; border-style: solid; border-width: 1px 1px 2px; border-color: gray; padding: 0 3px; vertical-align: top; white-space: nowrap;}
+table td {background-color: white; border: 1px solid gray; padding: 0 3px; vertical-align: top; line-height: 1.3em;}
table.lst td:first-child {font-size: 0.85em; font-family: "Consolas", "Courier New", monospace; white-space: nowrap;}
table.lst2 td {font-size: 0.85em; font-family: "Consolas", "Courier New", monospace; white-space: nowrap;}
table.lst3 td {font-family: "Consolas", "Courier New", monospace; white-space: nowrap;}
-table caption {font-family: sans-serif; font-weight: bold;}
-tr.lst3 td { border-width: 2px 1px 1px; }
+tr.lst3 td {border-width: 2px 1px 1px; }
+table.lst4 td {padding: 0.3em;}
+table.lst4 td:nth-child(2) {width: 45%;}
+table.lst4 td:nth-child(3) {width: 45%;}
p.foot {clear: both; text-indent: 0; margin: 1em 0.5em 1em;}
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/appnote.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/appnote.html
index 82ebdd4..32e900f 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/appnote.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/appnote.html
@@ -3,8 +3,6 @@
<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/appnote.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs Module Application Note</title>
</head>
@@ -41,8 +39,13 @@ The FatFs module is a middleware written in ANSI C (C89). There is no platform d
<ul>
<li>Size of <tt>char</tt> must be 8-bit.</li>
<li>Size of <tt>int</tt>, as well as integer promotion, must be 16-bit or 32-bit.</li>
-<li>When the C standard is in C89, size of <tt>short</tt> and <tt>long</tt> must be 16-bit and 32-bit respectively.</li>
-<li>When it is in C99 or later, <tt>stdint.h</tt> is used to obtain the integer sizes.</li>
+<li>Size of <tt>short</tt> and <tt>long</tt> must be 16-bit and 32-bit respectively. (in C89 only)</li>
+</ul>
+<li>Dependency<br>
+<ul>
+<li>C89: <tt>string.h</tt>.</li>
+<li>C99: <tt>string.h</tt> and <tt>stdint.h</tt>.</li>
+<li>Optional: <tt>stdarg.h</tt> and <tt>math.h</tt>.</li>
</ul>
</ul>
@@ -67,19 +70,19 @@ The FatFs module is a middleware written in ANSI C (C89). There is no platform d
<p><img src="../res/funcs.png" width="750" height="420" alt="functional diagram"></p>
<h4>Required Functions</h4>
-<p>You need to provide only MAI functions required by FatFs module and nothing else. If a working device control module for the target system is available, you need to write only glue functions to attach it to the FatFs module. If not, you need to port another device control module or write it from scratch. Most of MAI functions are not that always required. For instance, the write function is not required in read-only configuration. Following table shows which function is required depends on the configuration options.</p>
+<p>You need to provide only MAI functions and some additional functions required by FatFs module and nothing else. If a working device control module for the target system is available, you need to write only glue functions to attach it to the FatFs module. If not, you need to port another device control module or write it from scratch. Most of MAI functions are not that always required. For instance, the write function is not required in 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><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><a href="config.html#fs_readonly">FF_FS_READONLY == 0</a></td></tr>
+<tr><td><a href="dstat.html">disk_status</a><br><a href="dinit.html">disk_initialize</a><br><a href="dread.html">disk_read</a></td><td>Always</td><td rowspan="5">MAI functions.<br>Samples available in ffsample.zip.<br>There are many implementations on the web.</td></tr>
+<tr><td><a href="dwrite.html">disk_write</a><br><a href="fattime.html">get_fattime</a><br><a href="dioctl.html">disk_ioctl</a> (CTRL_SYNC)</td><td><a href="config.html#fs_readonly">FF_FS_READONLY == 0</a></td></tr>
<tr><td>disk_ioctl (GET_SECTOR_COUNT)<br>disk_ioctl (GET_BLOCK_SIZE)</td><td><a href="config.html#use_mkfs">FF_USE_MKFS == 1</a></td></tr>
<tr><td>disk_ioctl (GET_SECTOR_SIZE)</td><td><a href="config.html#max_ss">FF_MAX_SS != FF_MIN_SS</a></td></tr>
<tr><td>disk_ioctl (CTRL_TRIM)</td><td><a href="config.html#use_trim">FF_USE_TRIM == 1</a></td></tr>
-<tr><td>ff_uni2oem<br>ff_oem2uni<br>ff_wtoupper</td><td><a href="config.html#use_lfn">FF_USE_LFN != 0</a></td><td>Unicode support functions.<br>Add optional module ffunicode.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><a href="config.html#fs_reentrant">FF_FS_REENTRANT == 1</a></td><td rowspan="2">O/S dependent functions.<br>Sample code is available in ffsystem.c.</td></tr>
-<tr><td>ff_mem_alloc<br>ff_mem_free</td><td>FF_USE_LFN == 3</td></tr>
+<tr><td><a href="uni2oem.html">ff_uni2oem</a><br><a href="oem2uni.html">ff_oem2uni</a><br><a href="wtoupper.html">ff_wtoupper</a></td><td><a href="config.html#use_lfn">FF_USE_LFN != 0</a></td><td>Unicode support functions.<br>Just add ffunicode.c to the project.</td></tr>
+<tr><td><a href="m_create.html">ff_mutex_create</a><br><a href="m_delete.html">ff_mutex_delete</a><br><a href="m_take.html">ff_mutex_take</a><br><a href="m_give.html">ff_mutex_give</a></td><td><a href="config.html#fs_reentrant">FF_FS_REENTRANT == 1</a></td><td rowspan="2">O/S related functions.<br>Some sample codes are available in ffsystem.c.</td></tr>
+<tr><td><a href="m_alloc.html">ff_memalloc</a><br><a href="m_free.html">ff_memfree</e></td><td>FF_USE_LFN == 3</td></tr>
</table>
-<p>FatFs cares about neither what kind of storage device is used nor how it is implemented. Only a requirement is that it is a block device read/written in fixed-size blocks that accessible via the disk I/O functions defined above.</p>
+<p>FatFs cares about neither what kind of storage device is used nor how it is implemented. Only a requirement is that the storage is a <em>block device</em> that can be read/written via the MAI functions defined above.</p>
</div>
<div class="para doc" id="limits">
@@ -87,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>
@@ -103,21 +106,21 @@ The FatFs module is a middleware written in ANSI C (C89). There is no platform d
<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>MSC</td></tr>
<!-- ARM Thumb CM3 AVR H8 PIC24 RL78 V850ES SH-2A RX600 IA-32 -->
-<tr class="ral"><td class="cal">.text (Def, R/W)</td><td>10.4k</td><td>6.7k</td><td>6.1k</td><td>12.5k</td><td>11.0k</td><td>11.6k</td><td>13.0k</td><td>8.9k</td><td>9.2k</td><td>6.5k</td><td>8.9k</td></tr>
-<tr class="ral"><td class="cal">.text (Min, R/W)</td> <td>7.0k</td><td>4.7k</td><td>4.2k</td> <td>8.5k</td> <td>7.6k</td> <td>8.1k</td> <td>9.5k</td><td>6.2k</td><td>6.4k</td><td>4.6k</td><td>6.4k</td></tr>
-<tr class="ral"><td class="cal">.text (Def, R/O)</td> <td>4.9k</td><td>3.2k</td><td>2.7k</td> <td>6.1k</td> <td>5.2k</td> <td>5.5k</td> <td>6.5k</td><td>4.3k</td><td>4.2k</td><td>3.2k</td><td>4.3k</td></tr>
-<tr class="ral"><td class="cal">.text (Min, R/O)</td> <td>3.7k</td><td>2.5k</td><td>2.1k</td> <td>4.4k</td> <td>4.0k</td> <td>4.3k</td> <td>5.1k</td><td>3.4k</td><td>3.3k</td><td>2.5k</td><td>3.5k</td></tr>
+<tr class="ral"><td class="cal">.text (Def, R/W)</td><td>10.5k</td><td>6.7k</td><td>6.1k</td><td>12.6k</td><td>11.0k</td><td>11.4k</td><td>13.0k</td><td>8.9k</td><td>9.2k</td><td>6.5k</td><td>8.9k</td></tr>
+<tr class="ral"><td class="cal">.text (Min, R/W)</td> <td>7.0k</td><td>4.7k</td><td>4.2k</td> <td>8.5k</td> <td>7.6k</td> <td>7.9k</td> <td>9.4k</td><td>6.3k</td><td>6.4k</td><td>4.7k</td><td>6.3k</td></tr>
+<tr class="ral"><td class="cal">.text (Def, R/O)</td> <td>4.9k</td><td>3.2k</td><td>2.8k</td> <td>6.1k</td> <td>5.2k</td> <td>5.5k</td> <td>6.5k</td><td>4.4k</td><td>4.2k</td><td>3.2k</td><td>4.3k</td></tr>
+<tr class="ral"><td class="cal">.text (Min, R/O)</td> <td>3.7k</td><td>2.5k</td><td>2.1k</td> <td>4.4k</td> <td>4.0k</td> <td>4.2k</td> <td>5.0k</td><td>3.4k</td><td>3.3k</td><td>2.5k</td><td>3.4k</td></tr>
<tr class="ral"><td class="cal">.bss</td><td>V*4 + 2</td><td>V*4 + 2</td><td>V*4 + 2</td><td>V*2 + 2</td><td>V*4 + 2</td><td>V*2 + 2</td><td>V*2 + 2</td><td>V*4 + 2</td><td>V*4 + 2</td><td>V*4 + 2</td><td>V*4 + 2</td></tr>
<tr class="ral"><td class="cal">Work area<br><small>(FF_FS_TINY == 0)</small></td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td><td>V*560<br>+ F*546</td><td>V*560<br>+ F*546</td><td>V*560<br>+ F*546</td><td>V*560<br>+ F*546</td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td><td>V*564<br>+ F*552</td></tr>
<tr class="ral"><td class="cal">Work area<br><small>(FF_FS_TINY == 1)</small></td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td><td>V*560<br>+ F*34</td><td>V*560<br>+ F*34</td><td>V*560<br>+ F*34</td><td>V*560<br>+ F*34</td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td><td>V*564<br>+ F*40</td></tr>
</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>
+<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 on compilation.</p>
<pre>
-FatFs R0.14b 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>
@@ -166,169 +169,170 @@ And any other options are left unchanged from original setting.
<div class="para doc" id="lfn">
<h3>Long File Name</h3>
-<p>FatFs module supports the long file name (LFN) extension of the FAT filesystem. The two different file names, short file name (SFN) and LFN, of a file is transparent on the API. The support for LFN feature is disabled by default. To enable the LFN, set <tt><a href="config.html#use_lfn">FF_USE_LFN</a></tt> to 1, 2 or 3, and add <tt>ffunicode.c</tt> to the project. The LFN feature requiers a certain working buffer. The buffer size can be configured by <tt><a href="config.html#max_lfn">FF_MAX_LFN</a></tt> according to the available memory. The length of LFN can be up to 255 characters, so that the <tt>FF_MAX_LFN</tt> should be set to 255 for any existing file names. 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 LFN feature in RTOS environment, <tt>FF_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 LFN 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.</p>
-<h4>Impact upon Module Size</h4>
-<table class="lst2 rset">
-<caption>With LFN at CM3 + gcc</caption>
-<tr><th><tt>FF_CODE_PAGE</tt></th><th>Code size</th></tr>
-<tr><td>437-869 (SBCS)</td><td>+3.3k</td></tr>
-<tr><td>932 (Japanese)</td><td>+62k</td></tr>
-<tr><td>936 (Simplified Chinese)</td><td>+177k</td></tr>
-<tr><td>949 (Korean)</td><td>+140k</td></tr>
-<tr><td>950 (Traditional Chinese)</td><td>+111k</td></tr>
-<tr><td>0 (All code pages)</td><td>+486k</td></tr>
-</table>
-<p>When the LFN is enabled, the module size will be increased depends on the configured code page. Right table shows the increment of code size in 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.</p>
-<p>As the result, the FatFs with LFN enabled with DBCS code pages will not able to be ported on the most 8-bit MCU systems. If the target system is in legacy-free, in only Unicode and any ANSI/OEM code is not used at all, the code page setting gets meaningless. You will able to reduce the code size by configureing FatFs for Unicode API with any SBCS code page.</p>
-<p>There ware some restrictions on using LFN for open source project, because the LFN extension on the FAT filesystem was a patent of Microsoft Corporation. However the related patents all have expired and using the LFN feature is free for any projects.</p>
-</div>
-
-<div class="para doc" id="unicode">
-<h3>Unicode API</h3>
-<p>By default, FatFs uses ANSI/OEM code set on the API even in LFN configuration. FatFs can also switch the character encoding on the API to Unicode by configuration option <tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a></tt>. This means that FatFs is compliant with the full featured LFN specification. The data type <tt>TCHAR</tt> specifies path name strings on the API is an alias of either <tt>char</tt>(ANSI/OEM or UTF-8), <tt>WCHAR</tt>(UTF-16) or <tt>DWORD</tt>(UTF-32) depends on that option. For more information, refer to the description in the <a href="filename.html#uni">file name</a>.</p>
-<p>Note that setting of code page, <tt><a href="config.html#code_page">FF_CODE_PAGE</a></tt>, has actually no meaning when FatFs is configured for the Unicode API. It should be set 437 to reduce the module size. However it still affects code conversion of string I/O functions when <tt><a href="config.html#strf_encode">FF_STRF_ENCODE</a> == 0</tt>, and also backward compatibility with legacy systems. In this case, the code page may need to be configured properly if it is considered a problem.</p>
-</div>
-
-<div class="para doc" id="exfat">
-<h3>exFAT Filesystem</h3>
-<p>The exFAT (Microsoft's Extended File Allocation Table) filesystem is a succession of the FAT/FAT32 filesystem which has been widely used in embedded systems, consumer devices and portable storage media. It is adopted by SDA (SD Association) as the filesystem for SDXC card, 64 GB and larger, and they are being shipped with this format. Therefore the exFAT is one of the standard filesystems for removable media as well as FAT. The exFAT filesystem allows the file size beyond the 4 GB limit what FAT filesystem allows up to and some filesystem overhead, especially cluster allocation delay, are reduced as well. These features allow to record the large data without dividing into some files and improve the write throughput to the file.</p>
-<p>Note that the exFAT filesystem is a patent of Microsoft Corporation. The exFAT feature of FatFs is an implementation based on <cite>US. Pat. App. Pub. No. 2009/0164440 A1</cite>. FatFs module can switch the exFAT on or off by a configuration option, <tt><a href="config.html#fs_exfat">FF_FS_EXFAT</a></tt>. When enable the exFAT for the commercial products, a license by Microsoft will be needed depends on the final destination of the products.</p>
-<p><em>Remarks: Enabling exFAT discards C89 compatibility and it wants C99 because of need for 64-bit integer type.</em></p>
-</div>
-
-<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 partiotion 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">
-<h3>Re-entrancy</h3>
-<p>The file operations of two tasks to the <em>different volumes</em> each other is always re-entrant regardless of the configurations except when LFN is enabled with static working buffer (<tt>FF_USE_LFN = 1</tt>). It can work concurrently without any mutual exclusion.</p>
-<p>The file operations of two tasks to the <em>same volume</em> is not re-entrant in default. FatFs can also be configured to make it thread-safe by option <tt><a href="config.html#fs_reentrant">FF_FS_REENTRANT</a></tt>. In this case, also the OS dependent synchronization control functions, <tt>ff_cre_syncobj/ff_del_syncobj/ff_req_grant/ff_rel_grant</tt>, need to be added to the project. There are some examples in the <tt>ffsystem.c</tt>. When a file function is called while the volume is being accessed by another 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>FF_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</tt> function. These volume management functions are not re-entrant to the same volume. When use these functions, other tasks need to avoid to access the volume.</p>
-<div class="rset">
-<table class="lst2">
-<tr><th><tt>Function</tt></th><th>Case 1</th><th>Case 2</th><th>Case 3</th></tr>
-<tr><td>disk_status</td><td>Yes</td><td>Yes</td><td>Yes(*)</td></tr>
-<tr><td>disk_initialize</td><td>No</td><td>Yes</td><td>Yes(*)</td></tr>
-<tr><td>disk_read</td><td>No</td><td>Yes</td><td>Yes(*)</td></tr>
-<tr><td>disk_write</td><td>No</td><td>Yes</td><td>Yes(*)</td></tr>
-<tr><td>disk_ioctl</td><td>No</td><td>Yes</td><td>Yes(*)</td></tr>
-<tr><td>get_fattime</td><td>No</td><td>Yes</td><td>Yes</td></tr>
-</table>
-<small>
-Case 1: Same volume.<br>
-Case 2: Different volume on the same drive.<br>
-Case 3: Different volume on the different drive.<br>
-(*) In only different drive number.
-</small>
-</div>
-<p>Remarks: This section describes on the re-entrancy of the FatFs module itself. The <tt>FF_FS_REENTRANT</tt> option enables only exclusive use of each filesystem objects and FatFs does not that prevent to re-enter the storage device control functions. Thus the device control layer needs to be always thread-safe when FatFs API is re-entered for different volumes. Right table shows which control function can be re-entered when FatFs API is re-entered on some conditions.</p>
-</div>
-
-<div class="para doc" id="dup">
-<h3>Duplicated File Open</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 or deleted. A violation of these rules can cause data collaption.</p>
-<p>The file lock control can be enabled by <tt><a href="config.html#fs_lock">FF_FS_LOCK</a></tt> option. The value of option defines the number of open objects to manage simultaneously. In this case, if any opening, renaming or removing against the file shareing rule that described above is attempted, the file function will be rejected with <tt>FR_LOCKED</tt>. If number of open objects, files and sub-directories, is equal to <tt>FF_FS_LOCK</tt>, an extra <tt>f_open/f_opendir</tt> function will fail with <tt>FR_TOO_MANY_OPEN_FILES</tt>.</p>
-</div>
-
-<div class="para doc" id="fs1">
-<h3>Performance Effective File Access</h3>
-<p>For good read/write throughput on the small embedded systems with limited size of memory, application programmer should consider what process is done in the FatFs module. The file data on the volume is transferred in following sequence by <tt>f_read</tt> function.</p>
-<p>Figure 1. Sector unaligned read (short)<br>
-<img src="../res/f1.png" width="490" height="110" alt="">
-</p>
-<p>Figure 2. Sector unaligned read (long)<br>
-<img src="../res/f2.png" width="490" height="140" alt="">
-</p>
-<p>Figure 3. Fully sector aligned read<br>
-<img src="../res/f3.png" width="490" height="119" alt="">
-</p>
-<p>The file I/O buffer is a sector buffer to read/write a part of data on the sector. The sector buffer is either file private sector buffer on each file object or shared sector buffer in the filesystem object. The buffer configuration option <tt><a href="config.html#fs_tiny">FF_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>FF_MAX_SS</tt> bytes each file object. In this case, FatFs module uses only a sector buffer in the filesystem 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 unaligned 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>
-
-<div class="para doc" id="fs2">
-<h3>Considerations on Flash Memory Media</h3>
-<p>To maximize the write performance of flash memory media, such as SDC, CFC and U Disk, it must be controlled in consideration of its characteristitcs.</p>
-<h4>Using Mutiple-Sector Write</h4>
-<div class="rset">
-Figure 6. Comparison between Multiple/Single Sector Write<br>
-<img src="../res/f6.png" width="630" height="148" alt="fig.6">
-</div>
-<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="../res/rwtest2.png">This result</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 operation. </p>
-<h4>Forcing Memory Erase</h4>
-<p>When remove a file with <tt>f_unlink</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 can be erased on removing the file, those data blocks will be turned into 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 function by setting <tt><a href="config.html#use_trim">FF_USE_TRIM</a></tt> to 1. Note that because this effect is from an expectation of internal process of the storage device, it is not that always effective. Most applications will not need this function. Also <tt>f_unlink</tt> function can take a time when remove a large file.</p>
-</div>
-
-<div class="para doc" id="critical">
-<h3>Critical Section</h3>
-<p>If a write operation to the FAT volume is interrupted due to an accidental failure, such as sudden blackout, wrong media removal and unrecoverable disk error, the FAT structure on the volume can be broken. Following images shows the critical section of the FatFs module.</p>
-<div class="lset">
-Figure 4. Long critical section<br>
-<img src="../res/f4.png" width="320" height="436" alt="fig.4">
-</div>
-<div class="lset">
-Figure 5. Minimized critical section<br>
-<img src="../res/f5.png" width="320" height="436" alt="fig.5">
-</div>
-<br class="clr">
-<p>An interruption in the red section can cause a cross link; as a result, the object being changed can be lost. If an interruption in the yellow section is occured, there is one or more possibility listed below.</p>
-<ul>
-<li>The file data being rewrited is collapsed.</li>
-<li>The file being appended returns initial state.</li>
-<li>The file created as new is gone.</li>
-<li>The file created as new or overwritten remains but no content.</li>
-<li>Efficiency of disk use gets worse due to lost clusters.</li>
-</ul>
-<p>Each case does not affect any file not opened in write mode. To minimize risk of data loss, the critical section can be minimized by minimizing the time that file is opened in write mode or using <tt>f_sync</tt> function as shown in Figure 5.</p>
-</div>
-
-<div class="para doc" id="fs3">
-<h3>Various Usable Functions for FatFs Projects</h3>
-<p>These are examples of extended use of FatFs APIs. New item will be added when useful code example is found.</p>
-<ol>
-<li><a href="http://elm-chan.org/fsw/ff/res/app1.c">Open or Create File for Append</a> (superseded by FA_OPEN_APPEND flag added at R0.12)</li>
-<li><a href="http://elm-chan.org/fsw/ff/res/app2.c">Delete Non-empty Sub-directory</a> (for R0.12 and later)</li>
-<li><a href="http://elm-chan.org/fsw/ff/res/app3.c">Create Contiguous File</a> (superseded by f_expand function added at R0.12)</li>
-<li><a href="http://elm-chan.org/fsw/ff/res/app5.c">Test if the File is Contiguous or Not</a></li>
-<li><a href="http://elm-chan.org/fsw/ff/res/app4.c">Compatibility Checker for Storage Device Control Module</a></li>
-<li><a href="http://elm-chan.org/fsw/ff/res/app6.c">Performance Checker for Storage Device Control Module</a></li>
-<li><a href="http://elm-chan.org/fsw/ff/res/mkfatimg.zip">FAT Volume Image Creator</a> (Pre-creating built-in FAT volume)</li>
-<li>Virtual Drive Feature (refer to lpc176x/ in <a href="../ffsample.zip">ffsample.zip</a>)</li>
-<li><a href="http://elm-chan.org/fsw/ff/res/uniconv.zip">Embedded Unicode String Utilities</a> (OEMxxx→Unicode, Unicode→OEMxxx, Unicode→Unicode)</li>
-</ol>
-</div>
-
-<div class="para doc" id="license">
-<h3>About FatFs License</h3>
-<p>FatFs has being developped as a personal project of the author, ChaN. It is free from the code anyone else wrote at current release. Following code block shows a copy of the FatFs license document that included in the source files.</p>
-<pre>
-/*----------------------------------------------------------------------------/
-/ FatFs - Generic FAT Filesystem Module Rx.xx /
-/-----------------------------------------------------------------------------/
-/
-/ Copyright (C) 20xx, ChaN, all right reserved.
-/
-/ FatFs module is an open source software. Redistribution and use of FatFs in
-/ source and binary forms, with or without modification, are permitted provided
-/ that the following condition is met:
-/
-/ 1. Redistributions of source code must retain the above copyright notice,
-/ this condition and the following disclaimer.
-/
-/ This software is provided by the copyright holder and contributors "AS IS"
-/ and any warranties related to this software are DISCLAIMED.
-/ The copyright owner or contributors be NOT LIABLE for any damages caused
-/ 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, binary library and any forms without source code, does not need to include about FatFs in the documentations. This is equivalent to the 1-clause BSD license. Of course FatFs is compatible with the most of open source software licenses includes GNU GPL. When you redistribute the FatFs source code with any changes or create a fork, the license can also be changed to GNU GPL, BSD-style license or any open source software license that compatible with FatFs license.</p>
-</div>
-
-<p class="foot"><a href="../00index_e.html">Return Home</a></p>
-</body>
-</html>
+<p>FatFs module supports the long file name (LFN) extension of the FAT filesystem. The two different file names, short file name (SFN) and LFN, of a file are transparent on the API. The support for LFN feature is disabled by default. To enable the LFN, set <tt><a href="config.html#use_lfn">FF_USE_LFN</a></tt> to 1, 2 or 3, and add <tt>ffunicode.c</tt> to the project. The LFN feature requiers a certain working buffer. The buffer size can be configured by <tt><a href="config.html#max_lfn">FF_MAX_LFN</a></tt> according to the available memory. The LFN specification allows the length of LFN up to 255 characters, so that the <tt>FF_MAX_LFN</tt> should be set to 255 for every existing file name. 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 file API with LFN feature in RTOS environment, <tt>FF_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 LFN 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.</p>
+<h4>Code Page and Module Size</h4>
+<table class="lst2 rset">
+<caption>With LFN at CM3 + gcc</caption>
+<tr><th><tt>FF_CODE_PAGE</tt></th><th>Code size</th></tr>
+<tr><td>437-869 (SBCS)</td><td>+3.3k</td></tr>
+<tr><td>932 (Japanese)</td><td>+62k</td></tr>
+<tr><td>936 (Simplified Chinese)</td><td>+177k</td></tr>
+<tr><td>949 (Korean)</td><td>+140k</td></tr>
+<tr><td>950 (Traditional Chinese)</td><td>+111k</td></tr>
+<tr><td>0 (All code pages)</td><td>+486k</td></tr>
+</table>
+<p>When the LFN is enabled, the module size will be increased depends on the configured code page. Right table shows the increment of code size in 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.</p>
+<p>As the result, the FatFs with LFN enabled with DBCS code pages will not able to be ported on the most 8-bit MCU systems. If the target system is in legacy-free, in only Unicode and any ANSI/OEM code is not used at all, the code page setting is meaningless. The code size will able to be reduced by configureing FatFs for Unicode API with some SBCS code page.</p>
+<p>There ware some restrictions on using the LFN in open source project, because the LFN extension on the FAT filesystem was a patent of Microsoft Corporation. However the related patents all have expired and using the LFN feature is free for any project.</p>
+</div>
+
+<div class="para doc" id="unicode">
+<h3>Unicode API</h3>
+<p>By default, FatFs uses ANSI/OEM code set on the API even in LFN configuration. FatFs can also switch the character encoding on the API to Unicode by configuration option <tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a></tt>. This means that FatFs is compliant with the full featured LFN specification. The data type <tt>TCHAR</tt> specifies path name strings on the API is an alias of either <tt>char</tt>(ANSI/OEM or UTF-8), <tt>WCHAR</tt>(UTF-16) or <tt>DWORD</tt>(UTF-32) depends on that option. For more information, refer to the description in the <a href="filename.html#uni">file name</a>.</p>
+<p>Note that setting of code page, <tt><a href="config.html#code_page">FF_CODE_PAGE</a></tt>, has actually no meaning when FatFs is configured for the Unicode API. It should be set 437 to reduce the module size. However it still affects code conversion of string I/O functions when <tt><a href="config.html#strf_encode">FF_STRF_ENCODE</a> == 0</tt>, and also backward compatibility with legacy systems. In this case, the code page may need to be configured properly if it is considered a problem.</p>
+</div>
+
+<div class="para doc" id="exfat">
+<h3>exFAT Filesystem</h3>
+<p>The exFAT (Microsoft's Extended File Allocation Table) filesystem is a succession of the FAT/FAT32 filesystem which has been widely used in embedded systems, consumer devices and portable storage media. It is adopted by SDA (SD Association) as the filesystem for SDXC card, 64 GB and larger, and they are being shipped with this format. Therefore the exFAT is one of the standard filesystems for removable media as well as FAT. The exFAT filesystem allows the file size beyond the 4 GB limit what FAT filesystem allows up to and some filesystem overhead, especially cluster allocation delay, are reduced as well. These features allow to record the large data without dividing into some files and improve the write throughput to the file.</p>
+<p>Note that the exFAT filesystem is a patent of Microsoft Corporation. The exFAT feature of FatFs is an implementation based on <cite>US. Pat. App. Pub. No. 2009/0164440 A1</cite>. FatFs module can switch the exFAT on or off by a configuration option, <tt><a href="config.html#fs_exfat">FF_FS_EXFAT</a></tt>. When enable the exFAT for the commercial products, a license by Microsoft will be needed depends on the final destination of the products.</p>
+<p><em>Remarks: Enabling exFAT discards C89 compatibility and it wants C99 because of need for 64-bit integer type.</em></p>
+</div>
+
+<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. 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">
+<h3>Re-entrancy</h3>
+<p>The file operations of two tasks to the <em>different volumes</em> each other is always re-entrant and it can work concurrently without any mutual exclusion regardless of the configurations except when LFN is enabled with static working buffer (<tt>FF_USE_LFN = 1</tt>).</p>
+<p>The file operations of two tasks to the <em>same volume</em> is not thread-safe by default. FatFs can also be configured to make it thread-safe by an option <tt><a href="config.html#fs_reentrant">FF_FS_REENTRANT</a></tt>. When a file function is called while the volume is being accessed by another 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>FF_TIMEOUT</tt>, the file function aborts with <tt>FR_TIMEOUT</tt>. The timeout feature might not be supported on the some OSs. To enable this feature, OS dependent synchronization control functions, <tt>ff_mutex_create/ff_mutex_delete/ff_mutex_take/ff_mutex_give</tt>, need to be added to the project. There are some example codes in the <tt>ffsystem.c</tt> for some platforms.</p>
+<p>Note that there is an exception on the re-entrancy for <tt>f_mount</tt> and <tt>f_mkfs</tt> function. You would know why it is. These volume management functions are always not thread-safe to the volume processed. When use these functions, other tasks need to avoid to access the corresponding volume.</p>
+<div class="rset">
+<table class="lst2">
+<tr><th><tt>Function</tt></th><th>Case 1</th><th>Case 2</th><th>Case 3</th></tr>
+<tr><td>disk_status</td><td>Yes</td><td>Yes</td><td>Yes(*)</td></tr>
+<tr><td>disk_initialize</td><td>No</td><td>Yes</td><td>Yes(*)</td></tr>
+<tr><td>disk_read</td><td>No</td><td>Yes</td><td>Yes(*)</td></tr>
+<tr><td>disk_write</td><td>No</td><td>Yes</td><td>Yes(*)</td></tr>
+<tr><td>disk_ioctl</td><td>No</td><td>Yes</td><td>Yes(*)</td></tr>
+<tr><td>get_fattime</td><td>No</td><td>Yes</td><td>Yes</td></tr>
+</table>
+<small>
+Case 1: Same volume.<br>
+Case 2: Different volume on the same drive.<br>
+Case 3: Different volume on the different drive.<br>
+(*) In only different drive number.
+</small>
+</div>
+<p>Remarks: This section describes on the re-entrancy of the FatFs module itself. The <tt>FF_FS_REENTRANT</tt> option enables only exclusive use of each filesystem objects and FatFs does not that prevent to re-enter the storage device control functions. Thus the device control layer needs to be always thread-safe when FatFs API is re-entered for different volumes. Right table shows which control function can be re-entered when FatFs API is re-entered on some conditions.</p>
+</div>
+
+<div class="para doc" id="dup">
+<h3>Duplicated File Open</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 or deleted. A violation of these rules can cause data collaption.</p>
+<p>The file lock control can be enabled by <tt><a href="config.html#fs_lock">FF_FS_LOCK</a></tt> option. The value of option defines the number of open objects to manage simultaneously. In this case, if any opening, renaming or removing against the file shareing rule that described above is attempted, the file function will be rejected with <tt>FR_LOCKED</tt>. If number of open objects, files and sub-directories, is equal to <tt>FF_FS_LOCK</tt>, an extra <tt>f_open</tt> or <tt>f_opendir</tt> function will fail with <tt>FR_TOO_MANY_OPEN_FILES</tt>.</p>
+</div>
+
+<div class="para doc" id="fs1">
+<h3>Performance Effective File Access</h3>
+<p>For good read/write throughput on the small embedded systems with limited size of memory, application programmer should consider what process is done in the FatFs module. The file data on the volume is transferred in following sequence by <tt>f_read</tt> function.</p>
+<p>Figure 1. Sector unaligned read (short)<br>
+<img src="../res/f1.png" width="490" height="110" alt="">
+</p>
+<p>Figure 2. Sector unaligned read (long)<br>
+<img src="../res/f2.png" width="490" height="140" alt="">
+</p>
+<p>Figure 3. Fully sector aligned read<br>
+<img src="../res/f3.png" width="490" height="119" alt="">
+</p>
+<p>The file I/O buffer is a sector buffer to read/write a part of data on the sector. The sector buffer is either file private sector buffer on each file object or shared sector buffer in the filesystem object. The buffer configuration option <tt><a href="config.html#fs_tiny">FF_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>FF_MAX_SS</tt> bytes each file object. In this case, FatFs module uses only a sector buffer in the filesystem 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 flushed by file data transfer and it needs to be reloaded at every cluster boundary. However it will be suitable for not a few applications from the viewpoint of decent performance and low memory comsumption.</p>
+<p>Figure 1 shows a short data transfer within the sector size. The partial sector, sector unaligned part of the file, is transferred via the file I/O buffer. Figure 2 shows a long data transfer spans multiple sector. The middle of transfer data that covers one or more sector is transferred to the application buffer directly. Figure 3 shows a case of entier transfer data is aligned to the sector boundary. In this case, file I/O buffer is not used at all. 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>
+
+<div class="para doc" id="fs2">
+<h3>Considerations on Flash Memory Media</h3>
+<p>To maximize the write performance of flash memory media, such as SDC, CFC and U Disk, it must be controlled in consideration of its characteristitcs.</p>
+<h4>Using Mutiple-Sector Write</h4>
+<div class="rset">
+Figure 6. Comparison between Multiple/Single Sector Write<br>
+<img src="../res/f6.png" width="630" height="148" alt="fig.6">
+</div>
+<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="../res/rwtest2.png">This result</a> clearly shows multiple block write (W:16K, 32 sectors) is much higher than single block write (W:100, 1 sector) in write turoughput, 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 not a few memory card driver implementations 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 operation.</p>
+<h4>Forcing Memory Erase</h4>
+<p>When remove a file with <tt>f_unlink</tt> function, the data clusters allocated to the file are marked 'free' on the FAT. However, 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 can be marked 'blank' on remove the file, those data blocks will be turned into 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 function by setting <tt><a href="config.html#use_trim">FF_USE_TRIM</a></tt> to 1. Note that because this effect is from an expectation of internal process of the storage device, it is not that always effective. In this configuration, <tt>f_unlink</tt> function might take a time when remove a large file. Most applications will not need this function.</p>
+</div>
+
+<div class="para doc" id="critical">
+<h3>Critical Section</h3>
+<p>If a write operation to the FAT volume is interrupted due to an accidental failure, such as sudden blackout, wrong media removal and unrecoverable disk error, the FAT structure on the volume can be broken. Following images shows the critical section of the FatFs module.</p>
+<div class="lset">
+Figure 4. Long critical section<br>
+<img src="../res/f4.png" width="320" height="436" alt="fig.4">
+</div>
+<div class="lset">
+Figure 5. Minimized critical section<br>
+<img src="../res/f5.png" width="320" height="436" alt="fig.5">
+</div>
+<br class="clr">
+<p>An interruption in the red section can cause a cross link; as a result, the object being changed can be lost. If an interruption in the yellow section is occured, there is one or more possibility listed below.</p>
+<ul>
+<li>The file data being rewrited is collapsed.</li>
+<li>The file being appended returns initial state.</li>
+<li>The file created as new is gone.</li>
+<li>The file created as new or overwritten remains but no content.</li>
+<li>Efficiency of disk use gets worse due to lost clusters.</li>
+</ul>
+<p>Each case does not affect any file not opened in write mode. To minimize risk of data loss, the critical section can be minimized by minimizing the time that file is opened in write mode or using <tt>f_sync</tt> function as shown in Figure 5.</p>
+</div>
+
+<div class="para doc" id="fs3">
+<h3>Various Usable Functions for FatFs Projects</h3>
+<p>These are examples of extended use of FatFs APIs. New item will be added when useful code example is found.</p>
+<ol>
+<li><a href="http://elm-chan.org/fsw/ff/res/app1.c">Open or Create File for Append</a> (superseded by FA_OPEN_APPEND flag added at R0.12)</li>
+<li><a href="http://elm-chan.org/fsw/ff/res/app2.c">Delete Non-empty Sub-directory</a> (for R0.12 and later)</li>
+<li><a href="http://elm-chan.org/fsw/ff/res/app3.c">Create Contiguous File</a> (superseded by f_expand function added at R0.12)</li>
+<li><a href="http://elm-chan.org/fsw/ff/res/app5.c">Test if the File is Contiguous or Not</a></li>
+<li><a href="http://elm-chan.org/fsw/ff/res/app4.c">Compatibility Checker for Storage Device Control Module</a></li>
+<li><a href="http://elm-chan.org/fsw/ff/res/app6.c">Performance Checker for Storage Device Control Module</a></li>
+<li><a href="http://elm-chan.org/fsw/ff/res/mkfatimg.zip">FAT Volume Image Creator</a> (Pre-creating built-in FAT volume)</li>
+<li>Virtual Drive Feature (refer to lpc176x/ in <a href="../ffsample.zip">ffsample.zip</a>)</li>
+<li><a href="http://elm-chan.org/fsw/ff/res/uniconv.zip">Embedded Unicode String Utilities</a> (OEMxxx→Unicode, Unicode→OEMxxx, Unicode→Unicode)</li>
+</ol>
+</div>
+
+<div class="para doc" id="license">
+<h3>About FatFs License</h3>
+<p>FatFs has being developped as a personal project of the author, ChaN. It is free from the code anyone else wrote at current release. Following code block shows a copy of the FatFs license document that included in the source files.</p>
+<pre>
+/*----------------------------------------------------------------------------/
+/ FatFs - Generic FAT Filesystem Module Rx.xx /
+/-----------------------------------------------------------------------------/
+/
+/ Copyright (C) 20xx, ChaN, all right reserved.
+/
+/ FatFs module is an open source software. Redistribution and use of FatFs in
+/ source and binary forms, with or without modification, are permitted provided
+/ that the following condition is met:
+/
+/ 1. Redistributions of source code must retain the above copyright notice,
+/ this condition and the following disclaimer.
+/
+/ This software is provided by the copyright holder and contributors "AS IS"
+/ and any warranties related to this software are DISCLAIMED.
+/ The copyright owner or contributors be NOT LIABLE for any damages caused
+/ 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, binary library and any forms without source code, does not need to include about FatFs in the documentations. This is equivalent to the 1-clause BSD license. Of course FatFs is compatible with the most of open source software licenses includes GNU GPL. When you redistribute the FatFs source code with any changes or create a fork, the license can also be changed to GNU GPL, BSD-style license or any open source software license that compatible with FatFs license.</p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/chdir.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/chdir.html
index 93e116c..41dc847 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/chdir.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/chdir.html
@@ -3,8 +3,6 @@
<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/chdir.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_chdir</title>
</head>
@@ -50,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>
@@ -64,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>
@@ -83,6 +81,7 @@ FRESULT f_chdir (
<p><tt><a href="chdrive.html">f_chdrive</a>, <a href="getcwd.html">f_getcwd</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/chdrive.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/chdrive.html
index 4dfc7d8..2df0d9f 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/chdrive.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/chdrive.html
@@ -3,8 +3,6 @@
<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/chdrive.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_chdrive</title>
</head>
@@ -65,6 +63,7 @@ FRESULT f_chdrive (
<p><tt><a href="chdir.html">f_chdir</a>, <a href="getcwd.html">f_getcwd</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/chmod.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/chmod.html
index 91e520f..79e0fcc 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/chmod.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/chmod.html
@@ -3,8 +3,6 @@
<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/chmod.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_chmod</title>
</head>
@@ -27,7 +25,7 @@ FRESULT f_chmod (
<h4>Parameters</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 changed</dd>
+<dd>Pointer to the null-terminated string that specifies an <a href="filename.html">object</a> to be changed. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>
<dt>attr</dt>
<dd>Attribute flags to be set in one or more combination of the following flags. The specified flags are set and others are cleard.<br>
<table class="lst">
@@ -84,6 +82,7 @@ FRESULT f_chmod (
</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/close.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/close.html
index f4cd2df..b817e37 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/close.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/close.html
@@ -3,8 +3,6 @@
<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/close.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_close</title>
</head>
@@ -60,6 +58,7 @@ FRESULT f_close (
<p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="write.html">f_write</a>, <a href="sync.html">f_sync</a>, <a href="sfile.html">FIL</a>, <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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/closedir.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/closedir.html
index 3f5df57..af3b31e 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/closedir.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/closedir.html
@@ -3,8 +3,6 @@
<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/close.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_closedir</title>
</head>
@@ -59,6 +57,7 @@ FRESULT f_closedir (
<p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/config.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/config.html
index a4c7814..cc704fb 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/config.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/config.html
@@ -3,15 +3,13 @@
<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 requirement of each project. The configuration options are defined in the <em><tt>ffconf.h</tt></em>.</p>
+<p>There are many options to configure the features of FatFs for various requirements of each project. The configuration options are defined in <em><tt>ffconf.h</tt></em>.</p>
<ul>
<li>Function Configurations
<ul>
@@ -37,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
@@ -58,11 +57,11 @@
<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_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>
<li><a href="#fs_timeout">FF_FS_TIMEOUT</a></li>
- <li><a href="#sync_t">FF_SYNC_t</a></li>
</ul>
</li>
</ul>
@@ -105,29 +104,29 @@
<p>Disable (0) or Enable (1) <tt>f_forward</tt> function.</p>
<h4 id="use_strfunc">FF_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>. These functions are equivalents of regular string stream I/O functions in POSIX. If <tt>sprintf</tt> is available and code conversion is not needed, <tt>f_write</tt> with <tt>sprintf</tt> will be efficient in code size and performance rather than <tt>f_printf</tt>.</p>
+<p>This option switches string I/O functions, <tt>f_gets</tt>, <tt>f_putc</tt>, <tt>f_puts</tt> and <tt>f_printf</tt>. These functions are the equivalents of regular string stream I/O functions in POSIX. If <tt>sprintf</tt> is available and code conversion is not needed, <tt>f_write</tt> with <tt>sprintf</tt> will be efficient in code size and performance better than <tt>f_printf</tt>. When enable this feature, <tt>stdarg.h</tt> is included in <tt>ff.c</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>
+<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="print_lli">FF_PRINT_LLI</h4>
<p>This option switches support for long long integer argument in <tt>f_printf</tt>.</p>
-<p>Disable (0) or Enable (1). C standard needs to be C99 or later to enable this feature.</p>
+<p>Disable (0) or Enable (1). When enable this feature, C standard needs to be C99 or later. This option has no effect when <tt>FF_USE_STRFUNC == 0</tt>.</p>
<h4 id="print_fp">FF_PRINT_FLOAT</h4>
-<p>This option switches support for floating point argument in <tt>f_printf</tt>. C standard needs to be C99 or later to enable this feature.</p>
+<p>This option switches support for floating point argument in <tt>f_printf</tt>. When enable this feature, C standard needs to be C99 or later and <tt>math.h</tt> is included in <tt>ff.c</tt>. This option has no effect when <tt>FF_USE_STRFUNC == 0</tt>.</p>
<table class="lst1">
<tr><th>Value</th><th>Description</th></tr>
<tr><td>0</td><td>Disable floating point argument.</td></tr>
<tr><td>1</td><td>Enable floating point argument in type <tt>'f'</tt>, <tt>'e'</tt> and <tt>'E'</tt>.</td></tr>
-<tr><td>2</td><td>Enable with decimal separator <tt>','</tt> instead of <tt>'.'</tt>.</td></tr>
+<tr><td>2</td><td>Same as 1 but with decimal separator <tt>','</tt> instead of <tt>'.'</tt> in output string.</td></tr>
</table>
<h4 id="strf_encode">FF_STRF_ENCODE</h4>
-<p>When character encoding on the API is Unicode (<tt>FF_LFN_UNICODE >= 1</tt>), string I/O functions enabled by <tt>FF_USE_STRFUNC</tt> convert the character encoding in it. This option defines the assumption of character encoding <em>on the file</em> to be read/written via those functions. When LFN is not enabled or <tt>FF_LFN_UNICODE == 0</tt>, the string functions work without any code conversion and this option has no effect.</p>
+<p>When the character encoding on the API is Unicode (<tt>FF_LFN_UNICODE >= 1</tt>), string I/O functions enabled by <tt>FF_USE_STRFUNC</tt> convert the character encoding in it. This option defines the assumption of character encoding <em>on the file</em> to be read/written via the string I/O functions. When LFN is not enabled or <tt>FF_LFN_UNICODE == 0</tt>, the string I/O functions work without any code conversion and this option has no effect.</p>
<table class="lst2">
<tr><th>Value</th><th>Character encoding on the file</th></tr>
<tr><td>0</td><td>ANSI/OEM in current code page</td></tr>
@@ -171,7 +170,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>
@@ -181,7 +180,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>
@@ -192,7 +191,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>
@@ -204,17 +203,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 function and remove related functions.</td></tr>
-<tr><td>1</td><td>Enable relative path function. <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 open a file <tt>"/dir1/dir2/dir3/file"</tt> or set <tt>dir3</tt> current directory but the sub-directories in the <tt>dir3</tt>, where 4-level lower from the root directory, will not able to be followed or 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>
@@ -225,12 +228,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>Only DOS/Windows style drive prefix in numeric ID can be used.</td><td>1:/filename</td></tr>
-<tr><td>1</td><td>Also DOS/Windows style drive prefix in string ID can be used.</td><td>flash:/filename</td></tr>
-<tr><td>2</td><td>Also Unix style drive prefix in string ID can be used.</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 arbitrary string ID.</td><td><em>flash:</em>/filename</td></tr>
+<tr><td>2</td><td>0 + Unix style drive prefix in arbitrary string ID.</td><td><em>/flash</em>/filename</td></tr>
</table>
<h4 id="volume_strs">FF_VOLUME_STRS</h4>
@@ -241,19 +244,19 @@ const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb"};
</pre>
<h4 id="multi_partition">FF_MULTI_PARTITION</h4>
-<p>Disable (0) or Enable (1). This option switches multi-partition function. By default (0), each logical drive number is bound to the same physical drive number and only a volume in the physical drive is 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 available. For more information, read <a href="filename.html#vol">here</a>.</p>
+<p>This option switches multi-partition featuer. By default (0), each logical drive number is bound to the same physical drive number and only one volume found in the physical drive is mounted. When it is enabled (1), each logical drive can be bound to the specific partition or physical drive listed in the user defined partition resolution table <tt>VolToPart[]</tt>. Also <tt>f_fdisk</tt> funciton is available to create the arbitrary partitions on the physical drive. For more information, read <a href="filename.html#vol">here</a>.</p>
<h4 id="max_ss">FF_MIN_SS, FF_MAX_SS</h4>
-<p>This set of options defines the extent of sector size used for the low level disk I/O interface, <tt>disk_read</tt> and <tt>disk_write</tt> function. Valid values are 512, 1024, 2048 and 4096. <tt>FF_MIN_SS</tt> defines minimum sector size and <tt>FF_MAX_SS</tt> defines the maximum sector size. Always set both 512 for memory card and harddisk. But a larger value may be required for on-board flash memory and some type of optical media. When <tt>FF_MAX_SS > FF_MIN_SS</tt>, support of variable sector size is enabled and <tt>GET_SECTOR_SIZE</tt> command needs to be implemented to the <tt>disk_ioctl</tt> function.</p>
+<p>This set of options defines the extent of sector size used in MAI, <tt>disk_read</tt> and <tt>disk_write</tt> function. Valid values are 512, 1024, 2048 and 4096. The <tt>FF_MIN_SS</tt> defines minimum sector size and the <tt>FF_MAX_SS</tt> defines maximum sector size. Always set both 512 for common memory cards and harddisks but a larger value may be required for on-board flash memory and some type of optical media. When <tt>FF_MAX_SS > FF_MIN_SS</tt>, support of variable sector size is enabled and <tt>GET_SECTOR_SIZE</tt> command needs to be implemented to the <tt>disk_ioctl</tt> function.</p>
<h4 id="fs_lba64">FF_LBA64</h4>
-<p>This option switches media access interface to 64-bit LBA and enables GUID Partition Table (GPT) for partition management, Enabled (1) or Disabled (0). exFAT filesystem needs to be enabled to enable this feature.</p>
+<p>This option switches the addressing mode on the MAI to 64-bit LBA, Enabled (1) or Disabled (0). It also enables GUID Partition Table (GPT) for the partition management. The exFAT filesystem needs to be enabled to enable this feature.</p>
<h4 id="fs_gptmin">FF_MIN_GPT</h4>
-<p>This option specifies the threshold of determination of partitioning format when create patitions on the drive in <tt>f_mkfs</tt> and <tt>f_fdisk</tt> function. When number of sectors on the drive is equal or larger than this value, the drive will be partitioned in GPT. This option has no effect when <tt>FF_LBA64 == 0</tt>.</p>
+<p>This option specifies the threshold of determination of partitioning format when create patitions on the physical drive in <tt>f_mkfs</tt> and <tt>f_fdisk</tt> function. When number of available sectors on the drive is equal or larger than this value, the drive will be partitioned in GPT. This option has no effect when 64-bit LBA is not enabled.</p>
<h4 id="use_trim">FF_USE_TRIM</h4>
-<p>Disable (0) or Enable (1). This option switches ATA-TRIM function. To enable Trim function, also <tt>CTRL_TRIM</tt> command should be implemented to the <tt>disk_ioctl</tt> function.</p>
+<p>This option switches ATA-TRIM function, Disable (0) or Enable (1). To enable Trim function, also <tt>CTRL_TRIM</tt> command should be implemented to the <tt>disk_ioctl</tt> function.</p>
</div>
@@ -268,13 +271,16 @@ const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb"};
<p>This option switches support for exFAT filesystem in addition to the FAT/FAT32 filesystem, Enabled (1) or Disabled (0). To enable exFAT, also LFN must be enabled and configureing <tt>FF_LFN_UNICODE >= 1</tt> and <tt>FF_MAX_LFN == 255</tt> is recommended for full-featured exFAT function. Note that enabling exFAT discards ANSI C (C89) compatibility and wants C99 because of need for 64-bit integer type.</p>
<h4 id="fs_nortc">FF_FS_NORTC</h4>
-<p>Use RTC (0) or Do not use RTC (1). This option controls timestamp function. If the system does not have any RTC function or valid timestamp is not needed, set <tt>FF_FS_NORTC</tt> to 1 to disable the timestamp function. Every objects modified by FatFs will have a fixed timestamp defined by <tt>FF_NORTC_MON</tt>, <tt>FF_NORTC_MDAY</tt> and <tt>FF_NORTC_YEAR</tt>. To use the timestamp function, set <tt>FF_FS_NORTC == 0</tt> and add <tt>get_fattime</tt> function to the project to get current time form the RTC. This option has no effect in read-only configuration.</p>
+<p>Use RTC (0) or Do not use RTC (1). This option controls timestamp featuer. If the system does not have an RTC or valid timestamp is not needed, set <tt>FF_FS_NORTC</tt> to 1 to disable the timestamp function. Every objects modified by FatFs will have a constant timestamp defined by <tt>FF_NORTC_MON</tt>, <tt>FF_NORTC_MDAY</tt> and <tt>FF_NORTC_YEAR</tt>. To use the timestamp featuer, set <tt>FF_FS_NORTC == 0</tt> and add <tt>get_fattime</tt> function to the project to get current time form the RTC. This option has no effect in read-only configuration.</p>
<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_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>
-<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 for new allocation.</p>
+<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 the volume mounted will force a full FAT scan. Bit 1 controls the use of last allocated cluster number for new allocation.</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>
@@ -284,24 +290,22 @@ const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb"};
</table>
<h4 id="fs_lock">FF_FS_LOCK</h4>
-<p>This option switches file lock function to control duplicated file open and illegal operations to open objects. Note that the file lock function is independent of re-entrancy. This option must be 0 in read-only configuration.</p>
+<p>This option switches file lock feature to control duplicated file open and illegal operations to the open objects. Note that this feature is independent of re-entrancy. This option must be 0 in read-only configuration.</p>
<table class="lst1">
<tr><th>Value</th><th>Description</th></tr>
-<tr><td>0</td><td>Disable file lock function. To avoid collapsing file by wrong file operation, application program needs to avoid illegal open, remove and rename to the open objects.</td></tr>
-<tr><td>>0</td><td>Enable file lock function. The value defines how many files/sub-directories can be opened simultaneously under the file lock control. Illigal operations to the open object will be rejected with <tt>FR_LOCKED</tt>.</td></tr>
+<tr><td>0</td><td>Disable file lock feature. To avoid to collapse files due to wrong file operations, application program needs to avoid illegal open, remove and rename to the open objects.</td></tr>
+<tr><td>>0</td><td>Enable file lock feature. The value defines how many files/sub-directories can be opened simultaneously under the file lock feature. Illigal operations to the open object will be rejected with <tt>FR_LOCKED</tt>.</td></tr>
</table>
<h4 id="fs_reentrant">FF_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, however, volume management 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 filesystem object, is under control of this function. 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>, need to be added to the project. Sample code is available in <tt>ffsystem.c</tt>.</p>
+<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, however, volume management functions, <tt>f_mount</tt>, <tt>f_mkfs</tt> and <tt>f_fdisk</tt>, are <em>always not re-entrant</em>. Only file/directory access to the same volume, in other words, exclusive use of each filesystem object, is under control in this feature. To enable this feature, also user provided synchronization handlers, <tt>ff_mutex_take</tt>, <tt>ff_mutex_give</tt>, <tt>ff_mutex_create</tt> and <tt>ff_mutex_delete</tt>, need to be added to the project. Sample code is available in <tt>ffsystem.c</tt>.</p>
<h4 id="fs_timeout">FF_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>FF_FS_REENTRANT == 0</tt>.</p>
-
-<h4 id="sync_t">FF_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>FF_FS_REENTRANT == 0</tt>.</p>
+<p>Number of O/S time ticks to abort the file function with <tt>FR_TIMEOUT</tt> when the wait time exceeds this period. This value will be refered in <tt>ff_mutex_take</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dinit.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dinit.html
index c668c66..1a4bd30 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dinit.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dinit.html
@@ -3,8 +3,6 @@
<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/dinit.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - disk_initialize</title>
</head>
@@ -41,6 +39,7 @@ DSTATUS disk_initialize (
<p><em>Remarks: This function needs to be under control of FatFs module. Application program MUST NOT call this function while FatFs is in use, or FAT structure on the volume can be broken. To re-initialize the filesystem, use <tt>f_mount</tt> function instead.</em></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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dioctl.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dioctl.html
index 5208782..de56362 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dioctl.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dioctl.html
@@ -3,8 +3,6 @@
<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/dioctl.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - disk_ioctl</title>
</head>
@@ -57,11 +55,11 @@ DRESULT disk_ioctl (
<table class="lst">
<caption>Standard ioctl command used by FatFs</caption>
<tr><th>Command</th><th>Description</th></tr>
-<tr><td>CTRL_SYNC</td><td>Makes sure that the device has finished pending write process. If the disk I/O layer or storage device has a write-back cache, the dirty cache data must be committed to media immediately. Nothing to do for this command if each write operation to the media is completed within the <tt>disk_write</tt> function.</td></tr>
-<tr><td>GET_SECTOR_COUNT</td><td>Retrieves number of available sectors, the largest allowable LBA + 1, on the drive into the <tt>LBA_t</tt> variable pointed by <tt class="arg">buff</tt>. This command is used by <tt>f_mkfs</tt> and <tt>f_fdisk</tt> function to determine the size of volume/partition to be created. It is required when <tt>FF_USE_MKFS == 1</tt>.</td></tr>
-<tr><td>GET_SECTOR_SIZE</td><td>Retrieves sector size, minimum data unit for generic read/write, into the <tt>WORD</tt> variable pointed by <tt class="arg">buff</tt>. Valid sector sizes are 512, 1024, 2048 and 4096. This command is required only if <tt>FF_MAX_SS > FF_MIN_SS</tt>. When <tt>FF_MAX_SS == FF_MIN_SS</tt>, this command will be never used and the read/write function must work in <tt>FF_MAX_SS</tt> bytes/sector.</td></tr>
-<tr><td>GET_BLOCK_SIZE</td><td>Retrieves <em>erase block size</em> of the flash memory media in unit of sector into the <tt>DWORD</tt> variable pointed by <tt class="arg">buff</tt>. The allowable value is 1 to 32768 in power of 2. Return 1 if the value is unknown or non flash memory media. This command is used by only <tt>f_mkfs</tt> function and it attempts to align data area on the erase block boundary. It is required when <tt>FF_USE_MKFS == 1</tt>.</td></tr>
-<tr><td>CTRL_TRIM</td><td>Informs the device that the data on the block of sectors is no longer needed and it can be erased. The sector block is specified in an <tt>LBA_t</tt> array {<Start LBA>, <End LBA>} pointed by <tt class="arg">buff</tt>. This is an identical command to Trim of ATA device. Nothing to do for this command if this funcion is not supported or not a flash memory device. FatFs does not check the result code and the file function is not affected even if the sector block was not erased well. This command is called on remove a cluster chain and in the <tt>f_mkfs</tt> function. It is required when <tt>FF_USE_TRIM == 1</tt>.</td></tr>
+<tr><td>CTRL_SYNC</td><td>Makes sure that the device has finished pending write process. If the disk I/O layer or storage device has a write-back cache, the dirty cache data must be committed to the medium immediately. Nothing to do for this command if each write operation to the medium is completed in the <tt>disk_write</tt> function.</td></tr>
+<tr><td>GET_SECTOR_COUNT</td><td>Retrieves number of available sectors (the largest allowable LBA + 1) on the drive into the <tt>LBA_t</tt> variable that pointed by <tt class="arg">buff</tt>. This command is used by <tt>f_mkfs</tt> and <tt>f_fdisk</tt> function to determine the size of volume/partition to be created.</td></tr>
+<tr><td>GET_SECTOR_SIZE</td><td>Retrieves sector size (minimum data unit for generic read/write) into the <tt>WORD</tt> variable that pointed by <tt class="arg">buff</tt>. Valid sector sizes are 512, 1024, 2048 and 4096. This command is required only if <tt>FF_MAX_SS > FF_MIN_SS</tt>. When <tt>FF_MAX_SS == FF_MIN_SS</tt>, this command will never be used and the <tt>disk_read</tt> and <tt>disk_write</tt> function must work in <tt>FF_MAX_SS</tt> bytes/sector.</td></tr>
+<tr><td>GET_BLOCK_SIZE</td><td>Retrieves <em>erase block size in unit of sector</em> of the flash memory media into the <tt>DWORD</tt> variable that pointed by <tt class="arg">buff</tt>. The allowable value is 1 to 32768 in power of 2. Return 1 if it is unknown or in non-flash memory media. This command is used by <tt>f_mkfs</tt> function with block size not specified and it attempts to align the data area on the suggested block boundary. Note that FatFs does not have FTL (flash translation layer), so that either disk I/O layter or storage device must have an FTL in it.</td></tr>
+<tr><td>CTRL_TRIM</td><td>Informs the disk I/O layter or the storage device that the data on the block of sectors is no longer needed and it can be erased. The sector block is specified in an <tt>LBA_t</tt> array <tt>{<Start LBA>, <End LBA>}</tt> that pointed by <tt class="arg">buff</tt>. This is an identical command to Trim of ATA device. Nothing to do for this command if this funcion is not supported or not a flash memory device. FatFs does not check the result code and the file function is not affected even if the sector block was not erased well. This command is called on remove a cluster chain and in the <tt>f_mkfs</tt> function. It is required when <tt>FF_USE_TRIM == 1</tt>.</td></tr>
</table>
<p>FatFs will never use any device dependent command nor user defined command. Following table shows an example of non-standard commands which may be useful for some applications.</p>
@@ -73,9 +71,9 @@ DRESULT disk_ioctl (
<tr><td>CTRL_POWER_OFF</td><td>Puts the device off state. Shut-down the power to the device and deinitialize the device interface if needed. <tt>STA_NOINIT</tt> in the current status flags must be set. The device goes active state by <tt>disk_initialize</tt> function.</td></tr>
<tr><td>CTRL_LOCK</td><td>Locks media eject mechanism.</td></tr>
<tr><td>CTRL_UNLOCK</td><td>Unlocks media eject mechanism.</td></tr>
-<tr><td>CTRL_EJECT</td><td>Ejects media cartridge. <tt>STA_NOINIT</tt> and <tt>STA_NODISK</tt> in status flag are set after the function succeeded.</td></tr>
+<tr><td>CTRL_EJECT</td><td>Ejects media cartridge. <tt>STA_NOINIT</tt> and <tt>STA_NODISK</tt> in status flag are set after the function succeeds.</td></tr>
<tr><td>CTRL_GET_SMART</td><td>Reads SMART information.</td></tr>
-<tr><td>MMC_GET_TYPE</td><td>Gets card type. The type flags, bit0:MMCv3, bit1:SDv1, bit2:SDv2+ and bit3:LBA, is stored to a BYTE variable pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr>
+<tr><td>MMC_GET_TYPE</td><td>Gets card type. The type flags, bit0:MMCv3, bit1:SDv1, bit2:SDv2+ and bit3:LBA, is stored to a <tt>BYTE</tt> variable pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr>
<tr><td>MMC_GET_CSD</td><td>Reads CSD register and sets it into a 16-byte buffer pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr>
<tr><td>MMC_GET_CID</td><td>Reads CID register and sets it into a 16-byte buffer pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr>
<tr><td>MMC_GET_OCR</td><td>Reads OCR register and sets it into a 4-byte buffer pointed by <tt class="arg">buff</tt>. (MMC/SDC specific command)</td></tr>
@@ -96,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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dread.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dread.html
index 46d2860..a0fa29a 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dread.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dread.html
@@ -3,8 +3,6 @@
<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/dread.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - disk_read</title>
</head>
@@ -13,7 +11,7 @@
<div class="para func">
<h2>disk_read</h2>
-<p>The disk_read function is called to read data from the sector(s) of storage device.</p>
+<p>The disk_read function is called to read data from the storage device.</p>
<pre>
DRESULT disk_read (
BYTE <span class="arg">pdrv</span>, <span class="c">/* [IN] Physical drive number */</span>
@@ -56,18 +54,18 @@ DRESULT disk_read (
<div class="para desc">
<h4>Description</h4>
-<p>Read/write operation to the generic storage devices, such as memory card, hadddisk and optical disk, is done in unit of block of data bytes called <em>sector</em>. FatFs supports the sector size in range of 512 to 4096 bytes. When FatFs is configured for fixed sector size (<tt>FF_MIN_SS == FF_MAX_SS</tt>, this is the most case), the generic read/write function must work at the sector size only. When FatFs is configured for variable sector size (<tt>FF_MIN_SS < FF_MAX_SS</tt>), the sector size of medium is inquired with <tt>disk_ioctl</tt> function after <tt>disk_initialize</tt> function succeeded.</p>
+<p>Read/write operation to the generic storage devices, such as memory card, hadddisk and optical disk, is done in unit of block of data bytes called <em>sector</em>. FatFs supports the sector size in range of 512 to 4096 bytes. When FatFs is configured for fixed sector size (<tt>FF_MIN_SS == FF_MAX_SS</tt>, this is the most case), the generic read/write function must work at this sector size only. When FatFs is configured for variable sector size (<tt>FF_MIN_SS < FF_MAX_SS</tt>), the sector size of medium is inquired with <tt>disk_ioctl</tt> function after <tt>disk_initialize</tt> function succeeds.</p>
<p>There are some considerations about the memory addres passed via <tt class="arg">buff</tt>. It is not that always aligned with the word boundary, because the argument is defined as <tt>BYTE*</tt>. The unaligned transfer request can occure at <a href="appnote.html#fs1">direct transfer</a>. If the bus architecture, especially DMA controller, does not allow unaligned memory access, it should be solved in this function. If it is the case, there are some workarounds described below to avoid this issue.</p>
<ul>
<li>Convert word transfer to byte transfer with some trick in this function. - Recommended.</li>
<li>On the <tt>f_read()</tt> calls, avoid long read request that includes a whole of sector. - Any direct transfer never occures.</li>
-<li>On the <tt>f_read(fp, dat, btw, bw)</tt> calls, make sure that <tt>(((UINT)dat & 3) == (f_tell(fp) & 3))</tt> is true. - Word alignment of <tt class="arg">buff</tt> is guaranteed.</li>
+<li>On the <tt>f_read(fp, data, btw, bw)</tt> calls, make sure that <tt>(((UINT)data & 3) == (f_tell(fp) & 3))</tt> is true. - Word alignment of <tt class="arg">buff</tt> is guaranteed.</li>
</ul>
-<p>Also the memory area may be out of reach in DMA. This is the case if it is located on the tightly coupled memory which is usually used for stack. Use double buffered transfer, or avoid to define file I/O buffer, FATFS and FIL structure as local variables where on the stack.</p>
+<p>Also the memory area may be out of reach in DMA. This is the case if it is located on the tightly coupled memory which is usually used for stack. Use double buffered transfer, or avoid to define file I/O buffer, <tt>FATFS</tt> and <tt>FIL</tt> structure as local variables where on the stack.</p>
<p>Generally, a multiple sector read request must not be split into single sector transactions to the storage device, or read throughput gets worse.</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dstat.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dstat.html
index a891489..c2191a0 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dstat.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dstat.html
@@ -3,8 +3,6 @@
<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/dstat.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - disk_status</title>
</head>
@@ -43,6 +41,7 @@ DSTATUS disk_status (
</dl>
</div>
-<p class="foot"><a href="../00index_e.html">Return</a></p>
+
+<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dwrite.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dwrite.html
index 1007284..fc48f61 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/dwrite.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/dwrite.html
@@ -3,8 +3,6 @@
<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/dwrite.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - disk_write</title>
</head>
@@ -13,7 +11,7 @@
<div class="para func">
<h2>disk_write</h2>
-<p>The disk_write function is called to write data to the sector(s) of storage device.</p>
+<p>The disk_write function is called to write data to the storage device.</p>
<pre>
DRESULT disk_write (
BYTE <span class="arg">pdrv</span>, <span class="c">/* [IN] Physical drive number */</span>
@@ -60,7 +58,7 @@ DRESULT disk_write (
<h4>Description</h4>
<p>The specified memory address is not that always aligned to word boundary because the argument 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 write request (<tt class="arg">count</tt><tt> > 1</tt>) must not be split into single sector transactions to the storage device, or the file write throughput will be drastically decreased.</p>
-<p>FatFs expects delayed write function of the disk control layer. The write operation to the media does not need to be completed when return from this function by what write operation is in progress or data is only stored into the write-back cache. 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 function is implemented, the write throughput of the filesystem will be improved.</p>
+<p>FatFs expects the disk control layer may have a delayed write feature. The write operation to the media does not need to be completed when return from this function by what media write operation is in progress or data is stored into the write-back cache. The 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 of the filesystem will be improved.</p>
<p><em>Remarks: Application program MUST NOT call this function, or FAT structure on the volume can be collapsed.</em></p>
</div>
@@ -71,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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/eof.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/eof.html
index efacfbf..d33c5d1 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/eof.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/eof.html
@@ -3,8 +3,6 @@
<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/eof.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_eof</title>
</head>
@@ -57,6 +55,7 @@ int f_eof (
<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/error.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/error.html
index bee9685..99385de 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/error.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/error.html
@@ -3,8 +3,6 @@
<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/error.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_error</title>
</head>
@@ -57,6 +55,7 @@ int f_error (
<p><tt><a href="open.html">f_open</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/expand.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/expand.html
index 7620ba9..ea39e0f 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/expand.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/expand.html
@@ -3,8 +3,6 @@
<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/lseek.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_expand</title>
</head>
@@ -28,7 +26,7 @@ FRESULT f_expand (
<h4>Parameters</h4>
<dl class="par">
<dt>fp</dt>
-<dd>Pointer to the open file object.</dd>
+<dd>Pointer to the open file object. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>
<dt>fsz</dt>
<dd>Number of bytes in size to prepare or allocate for the file. The data type <tt>FSIZE_t</tt> is an alias of either <tt>DWORD</tt>(32-bit) or <tt>QWORD</tt>(64-bit) depends on the configuration option <tt>FF_FS_EXFAT</tt>.</dd>
<dt>opt</dt>
@@ -59,9 +57,9 @@ FRESULT f_expand (
<li>The file has been opened in read-only mode.</li>
<li>Not allowable file size. (>= 4 GB on FAT volume)</li>
</ul>
-<p>When <tt class="arg">opt</tt> is 0, the function finds a contiguous data area and set it as suggested point for next allocation. The subsequent cluster allocation begins at top of the contiguous area found by this function. Thus the file allocation is guaranteed be contiguous and without allocation delay until the file size reaches this size unless any other changes to the volume is performed.</p>
+<p>When <tt class="arg">opt</tt> is 0, the function finds a contiguous data area and set it as suggested point for next allocation. The subsequent cluster allocation begins at top of the contiguous area found by this function. Thus the file allocation is guaranteed be contiguous and without allocation delay until the file size reaches this size unless any other allocation does not occure while the file write session.</p>
<p>The contiguous file has an advantage for time-critical read/write operations. It eliminates some overheads in the filesystem and the storage device caused by random access for fragmented file.</p>
-<p>Also the contiguous file can be easily accessed directly via low-level disk functions. However, this is not recommended in consideration of portability and future compatibility. If the file has not been confirmed be contiguous, use <a href="../res/app5.c">this function</a> to examine if the file is contiguous or not.</p>
+<p>The contiguous files can easily be accessed via low-level disk functions. However, this is not recommended in consideration of portability and future compatibility. If the file has not been confirmed be contiguous, use <a href="../res/app5.c">this function</a> to examine if the file is contiguous or not.</p>
</div>
<div class="para comp">
@@ -76,16 +74,16 @@ FRESULT f_expand (
<span class="c">/* Creating a contiguous file */</span>
<span class="c">/* Create a new file */</span>
- res = f_open(fp = malloc(sizeof (FIL)), "file.dat", FA_WRITE|FA_CREATE_ALWAYS);
+ res = <em>f_open</em>(fp = malloc(sizeof (FIL)), "file.dat", FA_WRITE|FA_CREATE_ALWAYS);
if (res) { <span class="c">/* Check if the file has been opened */</span>
free(fp);
die("Failed to open the file.");
}
- <span class="c">/* Alloacte a 100 MiB of contiguous area to the file */</span>
+ <span class="c">/* Allocate a 100 MiB of contiguous area to the file */</span>
res = <em>f_expand</em>(fp, 104857600, 1);
if (res) { <span class="c">/* Check if the file has been expanded */</span>
- f_close(fp);
+ <em>f_close</em>(fp);
free(fp);
die("Failed to allocate contiguous area.");
}
@@ -101,7 +99,7 @@ FRESULT f_expand (
lba = fp->obj.fs->database + fp->obj.fs->csize * (fp->obj.sclust - 2);
<span class="c">/* Write 2048 sectors from top of the file at a time */</span>
- res = disk_write(drv, buffer, lba, 2048);
+ res = <em>disk_write</em>(drv, data, lba, 2048);
</pre>
</div>
@@ -112,6 +110,7 @@ FRESULT f_expand (
<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/fattime.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/fattime.html
index 002733a..c338ccd 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/fattime.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/fattime.html
@@ -3,8 +3,6 @@
<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/fattime.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - get_fattime</title>
</head>
@@ -75,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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/fdisk.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/fdisk.html
index d8c40bd..36dd3a4 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/fdisk.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/fdisk.html
@@ -3,8 +3,6 @@
<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/fdisk.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_fdisk</title>
</head>
@@ -49,7 +47,7 @@ FRESULT f_fdisk (
<div class="para desc">
<h4>Description</h4>
-<p>The <tt>f_fdisk</tt> function creates partitions on the physical drive. The partitioning format can be in generic MBR or GPT. The partition map table specifies how to divide the physical drive. The first item specifies the size of the first partition and the partitions are located on the drive in order of from the first item. When the value of item is less than or equal to 100, it specifies the partition size in percentage of the entire drive space. When it is larger than 100, it specifies number of sectors. The partition map table is terminated by a zero, no space is remaining for next allocation or 4th partition is created in MBR format. If the specified size is larger than remaining space on the drive, the partition is truncated at end of the drive.</p>
+<p>The <tt>f_fdisk</tt> function creates partitions on the physical drive. The partitioning format can be in generic MBR or GPT. The partition map table specifies how to divide the physical drive. The first item specifies the size of the first partition and the partitions are located on the drive in order of from the first item. When the value of item is less than or equal to 100, it specifies the partition size in percentage of the entire drive space. When it is larger than 100, it specifies number of sectors. The partition map table is terminated by a zero, 4th partition in MBR format or no remainin space for next allocation. If the specified size is larger than remaining space on the drive, the partition is truncated at end of the drive.</p>
<p>By default, partitions are created in MBR format. It can create upto four primary partitions on a drive. GPT format is used to create the partitions when 64-bit LBA is enabled (<tt>FF_LBA64 = 1</tt>) and the drive size is equal to or larger than <tt><a href="config.html#fs_gptmin">FF_MIN_GPT</a></tt> sectors. It can create over ten partitions on a drive.</p>
</div>
@@ -64,23 +62,23 @@ FRESULT f_fdisk (
<span class="c">/* Volume mapping table defined by user (required when FF_MULTI_PARTITION == 1) */</span>
PARTITION VolToPart[FF_VOLUMES] = {
- {0, 1}, <span class="c">/* "0:" ==> 1st partition in PD#0 */</span>
- {0, 2}, <span class="c">/* "1:" ==> 2nd partition in PD#0 */</span>
- {1, 0} <span class="c">/* "2:" ==> PD#1 as removable drive */</span>
+ {0, 1}, <span class="c">/* "0:" ==> 1st partition in physical drive 0 */</span>
+ {0, 2}, <span class="c">/* "1:" ==> 2nd partition in physical drive 0 */</span>
+ {1, 0} <span class="c">/* "2:" ==> Physical drive 1 as removable drive */</span>
};
</pre>
<pre>
<span class="c">/* Initialize a brand-new disk drive mapped to physical drive 0 */</span>
BYTE work[FF_MAX_SS]; <span class="c">/* Working buffer */</span>
- LBA_t plist[] = {50, 50, 0}; <span class="c">/* Divide the drive into two partitions */</span>
- <span class="c">/* {0x10000000, 100}; 256M sectors for 1st partition and left all for 2nd partition */</span>
+ LBA_t plist[] = {50, 50, 0}; <span class="c">/* Divide the drive by 2 */</span>
+ <span class="c">/* {0x10000000, 100}; 256M sectors for the 1st partition and the remaining for the 2nd partition */</span>
<span class="c">/* {20, 20, 20, 0}; 20% for 3 partitions each and remaing space is left not allocated */</span>
- <em>f_fdisk</em>(0, plist, work); <span class="c">/* Divide physical drive 0 */</span>
+ <em>f_fdisk</em>(0, plist, work); <span class="c">/* Divide the physical drive 0 */</span>
- f_mkfs("0:", 0, work, sizeof work); <span class="c">/* Create FAT volume on the logical drive 0 */</span>
- f_mkfs("1:", 0, work, sizeof work); <span class="c">/* Create FAT volume on the logical drive 1 */</span>
+ <em>f_mkfs</em>("0:", 0, work, sizeof work); <span class="c">/* Create FAT volume on the logical drive 0 */</span>
+ <em>f_mkfs</em>("1:", 0, work, sizeof work); <span class="c">/* Create FAT volume on the logical drive 1 */</span>
</pre>
</div>
@@ -90,6 +88,7 @@ FRESULT f_fdisk (
<p><a href="filename.html#vol">Volume management</a>, <a href="mkfs.html"><tt>f_mkfs</tt></a></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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/filename.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/filename.html
index 5e4f48a..931d01b 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/filename.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/filename.html
@@ -3,8 +3,6 @@
<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/filename.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - Path Names</title>
</head>
@@ -14,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> >= 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 >= 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> >= 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 (FAT volume)</a> 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 >= 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 >= 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>
@@ -29,39 +27,37 @@
<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 start of drive prefix and in absolute path. Any form as "root directory in current drive" and "current directory in specified drive" cannot be used. Double dot name cannot traverse the drives 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 ! # $ % & ' ( ) - @ ^ _ ` { } ~</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 name on the FAT volume is 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 raw name is recorded to the LFN entry when LFN extension is exist.</p>
-<p>As for the MS-DOS and PC DOS for CJK (DOS/DBCS), extended characters ware 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). But in LFN configuration, FatFs works with case-insensitive to the extended character (WindowsNT specs).</p>
+<p>In the generic FAT filesystems, the legal characters for the object (file or sub-directory) name are, <tt>0-9 A-Z ! # $ % & ' ( ) - @ ^ _ ` { } ~</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 the compatibility with Windows system when the file with extended characters is created on the volume by DOS/DBCS systems; therfore the object names with DBCS extended characters should not be used on the FAT volume shared by those systems. FatFs works with case-insensitive to the extended character (WindowsNT specs) in LFN configuration. On the other hand, FatFs works with case-sensitive to the extended characters in only non-LFN with DBCS configuration (DOS/DBCS specs).</p>
</div>
<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 specifies the path names is defined as <tt>TCHAR</tt>. It is an alias of <tt>char</tt> by default and the code set used for the path name string is ANSI/OEM specifid by <tt><a href="config.html#code_page">FF_CODE_PAGE</a></tt>. When <tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a></tt> is set to 1 or larger, the type of the <tt>TCHAR</tt> is switched to proper type to support the Unicode string. When Unicode API is specified by this option, the full-featured LFN specification is supported and the Unicode specific characters, such as ✝☪✡☸☭ and any character not in BMP, 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 specify the string in proper type. 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 specifies the path names is defined as <tt>TCHAR</tt>. It is an alias of <tt>char</tt> by default and the code set used for the path name string is ANSI/OEM specifid by <tt><a href="config.html#code_page">FF_CODE_PAGE</a></tt>. When <tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a></tt> is set non-zero value, the type of the <tt>TCHAR</tt> is switched to proper type to support the Unicode string. When Unicode API is specified by this option, the full-featured LFN specification is supported and the Unicode specific characters, such as ✝☪✡☸☭ and any character not in BMP, 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 specify the string in proper type. The code shown below is an example to define the literal strings.</p>
<pre>
f_open(fp, <span class="e">"filename.txt"</span>, FA_READ); <span class="c">/* ANSI/OEM string (char) */</span>
f_open(fp, <span class="e">L"filename.txt"</span>, FA_READ); <span class="c">/* UTF-16 string (WCHAR) */</span>
f_open(fp, <span class="e">u8"filename.txt"</span>, FA_READ); <span class="c">/* UTF-8 string (char) */</span>
f_open(fp, <span class="e">U"filename.txt"</span>, FA_READ); <span class="c">/* UTF-32 string (DWORD) */</span>
- f_open(fp, <span class="e">_T("filename.txt")</span>, FA_READ); <span class="c">/* Changed by configuration (TCHAR) */</span>
+ f_open(fp, <span class="e">_T("filename.txt")</span>, FA_READ); <span class="c">/* Depends on <tt>FF_LFN_UNICODE</tt> (TCHAR) */</span>
</pre>
</div>
<div class="para doc" id="vol">
<h3>Volume Management</h3>
-<p>By default, each logical drive is associated with the physical drive in same drive number. An FAT volume on the physical drive is serched in the volume mount process. It reads boot sectors and checks it if it is an FAT boot sector in order of LBA 0 as SFD format, 1st partition, 2nd partition, 3rd partition, ..., as MBR or GPT format.</p>
+<p>By default, each logical drive (FAT volume) is associated with the physical drive in same drive number. An FAT volume on the physical drive is serched in the volume mount process. It reads boot sectors and checks it if it is an FAT VBR in order of LBA 0 as SFD format, 1st partition, 2nd partition, 3rd partition, ..., as MBR or GPT format.</p>
<p>When multiple partition feature is enabled, <tt><a href="config.html#multi_partition">FF_MULTI_PARTITION = 1</a></tt>, each individual logical drive is associated with arbitrary partition or physical drive specified by volume management table, <tt>VolToPart[]</tt>. The table needs to be defined by user to resolve mappings of the logical drive numbers and the associated partitions or drives. Following code is an example of the volume management table.</p>
<pre>
Example: "0:", "1:" and "2:" are associated with three partitions on the physical drive 0 (a non-removable drive)
@@ -74,19 +70,20 @@ PARTITION VolToPart[FF_VOLUMES] = {
{1, 0} <span class="c">/* "3:" ==> pd#1 as removable drive (auto-search) */</span>
};
</pre>
-<div><img src="../res/f7.png" width="900" height="288" alt="relationship between logical drive and physical drive"></div>
+<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>
<li>When make any change to the <tt>VolToPart[]</tt>, corresponding volume should be unmounted prior to make change the item.</li>
-<li>On the MBR format drive, up to four primary partitions (1-4) can be specified. The partition number 1 specifies the first item in the partition table and the partition number 2 specifies the second one, and so on. The logical patitions (5-) in the extended partition is not supported.</li>
+<li>On the MBR format drive, up to four primary partitions (1-4) can be specified. The partition number 1 specifies the first item in the partition table and the partition number 2 specifies the second one, and so on. The logical patition (5-, partitions in the extended partition) is not supported.</li>
<li>On the GPT format drive, the partition number 1 specifies the first Microsoft BDP found in the partition table and the partition number 2 specifies the second one found, and so on.</li>
<li>Windows 10 earlier than 1703 does not support multiple volumes on the physical drive with removable class. Only the first parition found on the drive will be mounted. Windows OS does not support SFD format on the physical drive with non-removable class.</li>
-<li>Some systems manage the on-board storage in non-standard partition format and each partition is mapped as physical drive in <tt>disk_*</tt> functions. For such system, <tt>FF_MULTI_PARTITION</tt> should be always 0.</li>
-<li>For further information about the volume management, refer to the description in <tt><a href="fdisk.html">f_fdisk</a></tt> and <tt><a href="mkfs.html">f_mkfs</a></tt>.</li>
+<li>Some systems manage the on-board storage in non-standard partition format and each partition is mapped as physical drive in <tt>disk_*</tt> functions. For such system, <tt>FF_MULTI_PARTITION</tt> should be always 0 and use <tt>FM_SFD</tt> flag in <tt><a href="mkfs.html">f_mkfs</a></tt>.</li>
+<li>For further information about the volume management, refer to the description in <tt>f_mkfs</tt> and <tt><a href="fdisk.html">f_fdisk</a></tt>.</li>
</ul>
</div>
-<p class="foot"><a href="../00index_e.html">Return</a></p>
+
+<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/findfirst.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/findfirst.html
index 0cd1704..810a279 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/findfirst.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/findfirst.html
@@ -3,8 +3,6 @@
<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/findfirst.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_findfirst</title>
</head>
@@ -28,7 +26,7 @@ FRESULT f_findfirst (
<h4>Parameters</h4>
<dl class="par">
<dt>dp</dt>
-<dd>Pointer to the blank directory object.</dd>
+<dd>Pointer to the blank directory object. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>
<dt>fno</dt>
<dd>Pointer to the <a href="sfileinfo.html">file information structure</a> to store the information about the found item.</dd>
<dt>path</dt>
@@ -62,18 +60,19 @@ 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 items with the matching pattern specified by <tt class="arg">pattern</tt>. If the first item is found, the information about the item is stored into the file information structure <tt class="arg">fno</tt>. If not found, <tt>fno->fname[]</tt> has a null string.</p>
-<p>The matching pattern string can contain wildcard terms. For example:</p>
+<p>The matching pattern string can contain wildcards. For example:</p>
<ul>
-<li><tt>?</tt> - An any character.</li>
-<li><tt>???</tt> - An any string in length of three characters.</li>
-<li><tt>*</tt> - An any string in length of zero or longer.</li>
-<li><tt>????*</tt> - An any string in length of four characters or longer.</li>
+<li><tt>?</tt> - Any character.</li>
+<li><tt>???</tt> - Any string in length of three characters.</li>
+<li><tt>*</tt> - Any string in length of zero or longer.</li>
+<li><tt>????*</tt> - Any string in length of four characters or longer.</li>
+<li><tt>"?* ?*.txt"</tt> - Text file with two or more words of body.</li>
</ul>
-<p>Since the matching algorithm uses recursion, number of wildcard terms in the matching pattern is limited to four to limit the stack usage. Any pattern with too many wildcard terms does not match any name. In LFN configuration, only <tt>fname[]</tt> is tested when <tt>FF_USE_FIND == 1</tt> and also <tt>altname[]</tt> is tested when <tt>FF_USE_FIND == 2</tt>. There are some differences listed below between FatFs and standard systems in matching condition.</p>
+<p>Since the matching algorithm uses recursion, number of wildcards in the matching pattern is limited to four to limit the stack usage. The pattern with too many wildcards does not match any name. In LFN configuration, only <tt>fname[]</tt> is tested when <tt>FF_USE_FIND == 1</tt> and also <tt>altname[]</tt> is tested when <tt>FF_USE_FIND == 2</tt>. 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 while it matches any name with or without extension in standard systems.</li>
-<li>Any pattern terminated with a dot never matches any name while it matches the name without extensiton in standard systems.</li>
-<li><a href="filename.html#case">DBCS extended characters</a> are compared in case-sensitive when LFN is enabled with ANSI/OEM code API.</li>
+<li><tt>"*.*"</tt> does not match any name without extension while it matches any name with or without extension in standard systems.</li>
+<li>The pattern terminated with a dot does not match any name while it matches the name without extensiton in standard systems.</li>
+<li><a href="filename.html#case">DBCS extended characters</a> are compared in case-sensitive when LFN is enabled with <tt>!FF_LFN_UNICODE</tt>.</li>
</ul>
</div>
@@ -95,14 +94,14 @@ void find_image_file (void)
DIR dj; <span class="c">/* Directory object */</span>
FILINFO fno; <span class="c">/* File information */</span>
- fr = <em>f_findfirst</em>(&dj, &fno, "", "????????.JPG"); <span class="c">/* Start to search for photo files */</span>
+ fr = <em>f_findfirst</em>(&dj, &fno, "", "*.jpg"); <span class="c">/* Start to find JPEG image files */</span>
- while (fr == FR_OK && fno.fname[0]) { <span class="c">/* Repeat while an item is found */</span>
- printf("%s\n", fno.fname); <span class="c">/* Print the object name */</span>
- fr = f_findnext(&dj, &fno); <span class="c">/* Search for next item */</span>
+ while (fr == FR_OK && fno.fname[0]) { <span class="c">/* Repeat while an item is found */</span>
+ printf("%s\n", fno.fname); <span class="c">/* Print the object name */</span>
+ fr = <em>f_findnext</em>(&dj, &fno); <span class="c">/* Search for next item */</span>
}
- f_closedir(&dj);
+ <em>f_closedir</em>(&dj);
}
</pre>
</div>
@@ -113,6 +112,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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/findnext.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/findnext.html
index f39f0fb..6dfe8d7 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/findnext.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/findnext.html
@@ -3,8 +3,6 @@
<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/findnext.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_findnext</title>
</head>
@@ -64,6 +62,7 @@ FRESULT f_findnext (
<p><tt><a href="findfirst.html">f_findfirst</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/forward.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/forward.html
index 97a793d..ce36736 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/forward.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/forward.html
@@ -3,8 +3,6 @@
<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/forward.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_forward</title>
</head>
@@ -28,13 +26,13 @@ FRESULT f_forward (
<h4>Parameters</h4>
<dl class="par">
<dt>fp</dt>
-<dd>Pointer to the open file object.</dd>
+<dd>Pointer to the open file object. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>
<dt>func</dt>
<dd>Pointer to the user-defined data streaming function. For details, refer to the sample code.</dd>
<dt>btf</dt>
<dd>Number of bytes to forward in range of <tt>UINT</tt>.</dd>
<dt>bf</dt>
-<dd>Pointer to the <tt>UINT</tt> variable to return number of bytes forwarded.</dd>
+<dd>Pointer to the variable in <tt>UINT</tt> type to return number of bytes forwarded.</dd>
</dl>
</div>
@@ -54,7 +52,7 @@ FRESULT f_forward (
<div class="para desc">
<h4>Description</h4>
-<p>The <tt>f_forward</tt> function reads the data from the file and forward it to the outgoing stream without data buffer. This is suitable for small memory system because it does not require any data buffer at application module. The file pointer of the file object increases in number of bytes forwarded. In case of <tt class="arg">*bf</tt> is less than <tt class="arg">btf</tt> without error, it means the requested bytes could not be transferred due to end of file or stream goes busy during data transfer.</p>
+<p>The <tt>f_forward</tt> function reads the data from the file and forward it to the outgoing stream. This function is suitable for small memory system, because it does not require any data buffer in the application module. The file pointer of the file object advances in number of bytes forwarded. In case of <tt class="arg">*bf</tt> is less than <tt class="arg">btf</tt> without error, it means the requested size of data could not be transferred due to end of file or stream goes busy during data transfer.</p>
</div>
@@ -109,11 +107,11 @@ FRESULT play_file (
UINT dmy;
<span class="c">/* Open the audio file in read only mode */</span>
- rc = f_open(&fil, fn, FA_READ);
+ rc = <em>f_open</em>(&fil, fn, FA_READ);
if (rc) return rc;
<span class="c">/* Repeat until the file pointer reaches end of the file */</span>
- while (rc == FR_OK && !f_eof(&fil)) {
+ while (rc == FR_OK && !<em>f_eof</em>(&fil)) {
<span class="c">/* some processes... */</span>
@@ -122,7 +120,7 @@ FRESULT play_file (
}
<span class="c">/* Close the file and return */</span>
- f_close(&fil);
+ <em>f_close</em>(&fil);
return rc;
}
</pre>
@@ -134,6 +132,7 @@ FRESULT play_file (
<p><tt><a href="open.html">f_open</a>, <a href="gets.html">fgets</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/getcwd.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/getcwd.html
index 6eb9a58..20d0e66 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/getcwd.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/getcwd.html
@@ -3,8 +3,6 @@
<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/getcwd.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_getcwd</title>
</head>
@@ -13,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>
@@ -26,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>
@@ -50,8 +48,7 @@ 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> >= 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>
+<p>The <tt>f_getcwd</tt> function retrieves the full path name to the current directory of the current drive. When <tt><a href="config.html#volumes">FF_VOLUMES</a> >= 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>
</div>
@@ -78,6 +75,7 @@ FRESULT f_getcwd (
<p><tt><a href="chdrive.html">f_chdrive</a>, <a href="chdir.html">f_chdir</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/getfree.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/getfree.html
index 5e4f419..60ac9bc 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/getfree.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/getfree.html
@@ -3,8 +3,6 @@
<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/getfree.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_getfree</title>
</head>
@@ -89,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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/getlabel.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/getlabel.html
index 0ec6d0d..675b0f1 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/getlabel.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/getlabel.html
@@ -3,8 +3,6 @@
<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/getlabel.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_getlabel</title>
</head>
@@ -13,7 +11,7 @@
<div class="para func">
<h2>f_getlabel</h2>
-<p>The f_getlabel function returns volume label and volume serial number of a volume.</p>
+<p>The f_getlabel function retrieves volume label and volume serial number of a volume.</p>
<pre>
FRESULT f_getlabel (
const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Drive number */</span>
@@ -27,7 +25,7 @@ FRESULT f_getlabel (
<h4>Parameters</h4>
<dl class="par">
<dt>path</dt>
-<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. Null-string specifies the default drive.</dd>
+<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">logical drive</a>. Null-string specifies the default drive. If a null pointer is given, the function fails with <tt>FR_INVALID_DRIVE</tt>.</dd>
<dt>label</dt>
<dd>Pointer to the buffer to store the volume label. If the volume has no label, a null-string will be returned. Set null pointer if this information is not needed. The buffer size should be shown below at least to avoid buffer overflow.<br>
<table class="lst2">
@@ -71,10 +69,10 @@ FRESULT f_getlabel (
char str[12];
<span class="c">/* Get volume label of the default drive */</span>
- <em>f_getlabel</em>("", str, 0);
+ <em>f_getlabel</em>("", str, NULL);
<span class="c">/* Get volume label of the drive 2 */</span>
- <em>f_getlabel</em>("2:", str, 0);
+ <em>f_getlabel</em>("2:", str, NULL);
</pre>
</div>
@@ -85,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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/gets.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/gets.html
index 89d9560..68c65da 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/gets.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/gets.html
@@ -3,8 +3,6 @@
<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/gets.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_gets</title>
</head>
@@ -45,13 +43,13 @@ TCHAR* f_gets (
<div class="para desc">
<h4>Description</h4>
<p>The read operation continues until a <tt>'\n'</tt> is stored, reached end of the file or the buffer is filled with <tt>len - 1</tt> characters. The read string is terminated with a <tt>'\0'</tt>. When no character to read or any error occured during read operation, it returns a null pointer. The status of EOF and error can be examined with <tt>f_eof</tt> and <tt>f_error</tt> function.</p>
-<p>When FatFs is configured to Unicode API (<tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a> >= 1</tt>), data types on the srting fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt>, is also switched to Unicode. The character encoding <em>on the file</em> to be read via this function is assumed as <a href="config.html#strf_encode"><tt>FF_STRF_ENCODE</tt></a>. If the character encoding on the file differs from that on the API, it is converted in this function. In this case, input characters with wrong encoding will be lost.</p>
+<p>When FatFs is configured to Unicode API (<tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a> >= 1</tt>), data types on the srting fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt>, is also switched to Unicode. The character encoding <em>on the file</em> to be read via this function is assumed as <a href="config.html#strf_encode"><tt>FF_STRF_ENCODE</tt></a>. If the character encoding differs between file data and API, it is converted in this function. Input characters with wrong encoding for output will be lost.</p>
</div>
<div class="para comp">
<h4>QuickInfo</h4>
-<p>This is a wrapper function of <a href="read.html"><tt>f_read</tt></a> function. Available when <tt><a href="config.html#use_strfunc">FF_USE_STRFUNC</a> >= 1</tt>. When it is set to 2, <tt>'\r'</tt>s contained in the file are stripped out.</p>
+<p>This is a wrapper function of <a href="read.html"><tt>f_read</tt></a> function. Available when <tt><a href="config.html#use_strfunc">FF_USE_STRFUNC</a> >= 1</tt>. When it is set to 2, <tt>'\r'</tt>s contained in the read data are stripped off.</p>
</div>
@@ -60,6 +58,7 @@ TCHAR* f_gets (
<p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="putc.html">f_putc</a>, <a href="puts.html">f_puts</a>, <a href="printf.html">f_printf</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/index.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/index.html
new file mode 100644
index 0000000..8368bb6
--- /dev/null
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/index.html
@@ -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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/lseek.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/lseek.html
index 5fc933e..7760ee9 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/lseek.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/lseek.html
@@ -3,8 +3,6 @@
<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/lseek.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_lseek</title>
</head>
@@ -32,7 +30,7 @@ FRESULT f_rewind (
<h4>Parameters</h4>
<dl class="par">
<dt>fp</dt>
-<dd>Pointer to the open file object.</dd>
+<dd>Pointer to the open file object. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>
<dt>ofs</dt>
<dd>Byte offset from top of the file to set read/write pointer. The data type <tt>FSIZE_t</tt> is an alias of either <tt>DWORD</tt>(32-bit) or <tt>QWORD</tt>(64-bit) depends on the configuration option <tt><a href="config.html#fs_exfat">FF_FS_EXFAT</a></tt>.</dd>
</dl>
@@ -53,17 +51,18 @@ FRESULT f_rewind (
<div class="para desc">
<h4>Description</h4>
-<p>File read/write ponter in the open file object points the data byte to be read/written at next read/write operation. It advances as the number of bytes read/written. The <tt>f_lseek</tt> function moves the file read/write pointer without any read/write operation to the file. The <tt>f_rewind</tt> function is impremented as a macro.</p>
+<p>File read/write ponter in the open file object points the data byte to be read/written at next read/write operation. It advances as the number of bytes read/written. The <tt>f_lseek</tt> function moves the file read/write pointer without read/write operation to the file. The <tt>f_rewind</tt> function is impremented as a macro.</p>
<pre>
#define <em>f_rewind</em>(fp) f_lseek((fp), 0)
</pre>
-<p>If an offset beyond the file size is specified in write mode, the file size is expanded to the specified offset. The file data in the expanded part is <em>undefined</em>, because no data is written to the file in this process. This is suitable to pre-allocate a data area to the file quickly for fast write operation. When a contiguous data area needs to be allocated to the file, use <tt>f_expand</tt> function instead. After the <tt>f_lseek</tt> function succeeded, the current read/write pointer should be checked in order to make sure the read/write pointer has been moved correctry. In case of the read/write pointer is not pointing expected offset, either of followings has been occured.</p>
+<p>When an offset beyond the file size is specified in write mode, the file size is expanded to the specified offset <em>in this function</em>. The file data in the expanded part is <em>undefined</em>, because no data is written to the file in this process. Be careful about these behaviours differ from POSIX <tt>fseek</tt> function. This is suitable to pre-allocate a data area to the file for subsequent fast write operation. If a contiguous data area needs to be allocated to the file, use <tt>f_expand</tt> function instead.</p>
+<p>After the <tt>f_lseek</tt> function succeeded, the current read/write pointer should be checked in order to make sure the read/write pointer has been moved correctry. In case of the read/write pointer is not pointing expected offset, either of followings has been occured.</p>
<ul>
<li>End of file. The specified <tt class="arg">ofs</tt> was clipped at end of the file in read-only mode.</li>
<li>Disk full. There is no free space on the volume to expand the file.</li>
</ul>
-<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 at fast seek mode.</p>
-<p>The fast seek mode is enabled when <tt>FF_USE_FASTSEEK = 1</tt>. The CLMT must be created into the <tt>DWORD</tt> array prior to use the fast seek mode. 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 <tt>cltbl[0]</tt> and then call <tt>f_lseek</tt> function with <tt class="arg">ofs</tt><tt> = CREATE_LINKMAP</tt>. After the function succeeded, 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 <tt>cltbl[0]</tt>. The number of items needed is (number of the file fragments + 1) * 2. For example, 12 items in the array will be used for the file fragmented in 5 portions. If the function failed with <tt>FR_NOT_ENOUGH_CORE</tt>, the size of given array is insufficient for the file.</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 mode is available when <tt>FF_USE_FASTSEEK = 1</tt>. The CLMT must be created into a <tt>DWORD</tt> array prior to use the fast seek mode. 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 <tt>cltbl[0]</tt> and then call <tt>f_lseek</tt> function with <tt class="arg">ofs</tt><tt> = CREATE_LINKMAP</tt>. The number of items used or required is returned into the <tt>cltbl[0]</tt>. The number of items needed is (number of the file fragments + 1) * 2. For example, 12 items in the array will be used for the file fragmented in 5 portions. If the function failed with <tt>FR_NOT_ENOUGH_CORE</tt>, the size of given array is insufficient for the file. After the function succeeded, no FAT access is occured in subsequent <tt>f_read</tt>, <tt>f_write</tt>, <tt>f_lseek</tt> function to the file. To disable the fast seek mode, set null pointer to the <tt>cltbl</tt>.</p>
</div>
@@ -78,33 +77,33 @@ FRESULT f_rewind (
<pre>
<span class="c">/* Open file */</span>
fp = malloc(sizeof (FIL));
- res = f_open(fp, "file.dat", FA_READ|FA_WRITE);
+ res = <em>f_open</em>(fp, "file.dat", FA_READ|FA_WRITE);
if (res) ...
- <span class="c">/* Move to offset of 5000 from top of the file */</span>
+ <span class="c">/* Set read/write pointer to 5000 */</span>
res = <em>f_lseek</em>(fp, 5000);
- <span class="c">/* Move to end of the file to append data */</span>
+ <span class="c">/* Set read/write pointer to end of the file to append data */</span>
res = <em>f_lseek</em>(fp, f_size(fp));
- <span class="c">/* Forward 3000 bytes */</span>
+ <span class="c">/* Advance read/write pointer 3000 bytes */</span>
res = <em>f_lseek</em>(fp, f_tell(fp) + 3000);
- <span class="c">/* Rewind 2000 bytes (take care on wraparound) */</span>
+ <span class="c">/* Rewind read/write pointer 2000 bytes (take care on wraparound) */</span>
res = <em>f_lseek</em>(fp, f_tell(fp) - 2000);
</pre>
<pre>
<span class="c">/* Cluster pre-allocation (to prevent buffer overrun on streaming write) */</span>
- res = f_open(fp, recfile, FA_CREATE_NEW | FA_WRITE); <span class="c">/* Create a file */</span>
+ res = <em>f_open</em>(fp, recfile, FA_CREATE_NEW | FA_WRITE); <span class="c">/* Create a file */</span>
res = <em>f_lseek</em>(fp, PRE_SIZE); <span class="c">/* Expand file size (cluster pre-allocation) */</span>
- if (res || f_tell(fp) != PRE_SIZE) ... <span class="c">/* Check if the file has been expanded successfly */</span>
+ if (res || <em>f_tell</em>(fp) != PRE_SIZE) ... <span class="c">/* Check if the file has been expanded successfly */</span>
res = <em>f_lseek</em>(fp, OFS_DATA); <span class="c">/* Record data stream with free from cluster allocation delay */</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 = <em>f_truncate</em>(fp); <span class="c">/* Truncate unused area */</span>
res = <em>f_lseek</em>(fp, OFS_HEADER); <span class="c">/* Set file header */</span>
...
@@ -115,7 +114,7 @@ FRESULT f_rewind (
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 = <em>f_open</em>(fp, fname, FA_READ | FA_WRITE); <span class="c">/* Open a file */</span>
res = <em>f_lseek</em>(fp, ofs1); <span class="c">/* This is normal seek (cltbl is nulled on file open) */</span>
@@ -134,6 +133,7 @@ FRESULT f_rewind (
<p><tt><a href="open.html">f_open</a>, <a href="truncate.html">f_truncate</a>, <a href="expand.html">f_expand</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_alloc.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_alloc.html
new file mode 100644
index 0000000..f927bcc
--- /dev/null
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_alloc.html
@@ -0,0 +1,45 @@
+<!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 - ff_memalloc</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>ff_memalloc</h2>
+<p>The ff_memalloc function is an equivarent or alias of POSIX malloc function.</p>
+<pre>
+void* ff_memalloc (
+ UINT <span class="arg">msize</span> <span class="c">/* [IN] Size of memory block */</span>
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameter</h4>
+<dl class="par">
+<dt>msize</dt>
+<dd>Size of memory block to allocate in unit of byte.</dd>
+</dl>
+</div>
+
+
+<div class="para ret">
+<h4>Return Value</h4>
+<p>A void type pointer to the allocated memory block. If the memory block could not be allocated, a null pointer is returned and the file function may fail with <tt>FR_NOT_ENOUPH_CORE</tt>.</p>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>This function is required when <tt><a href="config.html#use_lfn">FF_USE_LFN = 3</a></tt>. It is intended to be used by FatFs but also application program may use this function.</p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_create.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_create.html
new file mode 100644
index 0000000..5453b65
--- /dev/null
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_create.html
@@ -0,0 +1,45 @@
+<!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 - ff_mutex_create</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>ff_mutex_create</h2>
+<p>The ff_mutex_create function is for mutal exclusion control of file system object. It is called on register a file system object and create its mutex.</p>
+<pre>
+int ff_mutex_create (
+ int <span class="arg">vol</span> <span class="c">/* [IN] Volume ID */</span>
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameter</h4>
+<dl class="par">
+<dt>vol</dt>
+<dd>Volume ID number in range from 0 to <tt><a href="config.html#volumes">FF_VOLUMES</a></tt>. The value is used for the index of internal table of mutexes.</dd>
+</dl>
+</div>
+
+
+<div class="para ret">
+<h4>Return Values</h4>
+<p>A non-zero value is returned if a new mutex was created or alreay created. If not, a zero is returned and <tt>f_mount</tt> function will fail with <tt>FR_INT_ERR</tt>.</p>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>This function is required when <tt><a href="config.html#fs_reentrant">FF_FS_REENTRANT = 1</a></tt>.</p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_delete.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_delete.html
new file mode 100644
index 0000000..3cc6026
--- /dev/null
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_delete.html
@@ -0,0 +1,39 @@
+<!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 - ff_mutex_delete</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>ff_mutex_delete</h2>
+<p>The ff_mutex_delete function is for mutal exclusion control of file system object. It is called on unregister a file system object and delete its mutex.</p>
+<pre>
+void ff_mutex_delete (
+ int <span class="arg">vol</span> <span class="c">/* [IN] Volume ID */</span>
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameter</h4>
+<dl class="par">
+<dt>vol</dt>
+<dd>Volume ID number in range from 0 to <tt><a href="config.html#volumes">FF_VOLUMES</a></tt>. The value is used for the index of internal table of mutexes.</dd>
+</dl>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>This function is required when <tt><a href="config.html#fs_reentrant">FF_FS_REENTRANT = 1</a></tt>.</p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_free.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_free.html
new file mode 100644
index 0000000..9fb9417
--- /dev/null
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_free.html
@@ -0,0 +1,39 @@
+<!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 - ff_memfree</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>ff_memfree</h2>
+<p>The ff_memfree function is an equivalent or an alias of POSIX free function.</p>
+<pre>
+void ff_memfree (
+ void* <span class="arg">mblock</span> <span class="c">/* [IN] Pointer to the memory block */</span>
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameter</h4>
+<dl class="par">
+<dt>mblock</dt>
+<dd>Pointer to the valid memory block allocated by ff_memalloc function. A null pointer has no effect.</dd>
+</dl>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>This function is required when <tt><a href="config.html#use_lfn">FF_USE_LFN = 3</a></tt>. It is intended to be used by FatFs but also application program may use this function.</p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_give.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_give.html
new file mode 100644
index 0000000..55d8307
--- /dev/null
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_give.html
@@ -0,0 +1,39 @@
+<!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 - ff_mutex_give</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>ff_mutex_give</h2>
+<p>The ff_mutex_give function is for mutal exclusion control of file system object. It is called on the control leaves file API to unlock the volume.</p>
+<pre>
+int ff_mutex_take (
+ int <span class="arg">vol</span> <span class="c">/* [IN] Volume ID */</span>
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameter</h4>
+<dl class="par">
+<dt>vol</dt>
+<dd>Volume ID number in range from 0 to <tt><a href="config.html#volumes">FF_VOLUMES</a></tt>. The value is used for the index of internal table of mutexes.</dd>
+</dl>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>This function is required when <tt><a href="config.html#fs_reentrant">FF_FS_REENTRANT = 1</a></tt>.</p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_take.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_take.html
new file mode 100644
index 0000000..51184f5
--- /dev/null
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/m_take.html
@@ -0,0 +1,45 @@
+<!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 - ff_mutex_take</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>ff_mutex_take</h2>
+<p>The ff_mutex_take function is for mutal exclusion control of file system object. It is called on the control enters file API to lock the volume.</p>
+<pre>
+int ff_mutex_take (
+ int <span class="arg">vol</span> <span class="c">/* [IN] Volume ID */</span>
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameter</h4>
+<dl class="par">
+<dt>vol</dt>
+<dd>Volume ID in range from 0 to <tt><a href="config.html#volumes">FF_VOLUMES</a></tt>. The value is used for the index of internal table of mutexes.</dd>
+</dl>
+</div>
+
+
+<div class="para ret">
+<h4>Return Values</h4>
+<p>A non-zero value is returned if the mutex was successfully taken. If not, a zero is returned and the file function will abort with <tt>FR_TIMEOUT</tt>.</p>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>This function is required when <tt><a href="config.html#fs_reentrant">FF_FS_REENTRANT = 1</a></tt>.</p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/mkdir.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/mkdir.html
index de32f83..6e954aa 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/mkdir.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/mkdir.html
@@ -3,8 +3,6 @@
<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/mkdir.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_mkdir</title>
</head>
@@ -75,6 +73,7 @@ FRESULT f_mkdir (
</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/mkfs.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/mkfs.html
index 3f3bd70..900c988 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/mkfs.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/mkfs.html
@@ -3,8 +3,6 @@
<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/mkfs.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_mkfs</title>
</head>
@@ -30,23 +28,23 @@ FRESULT f_mkfs (
<dt>path</dt>
<dd>Pointer to the null-terminated string specifies the <a href="filename.html">logical drive</a> to be formatted. If it does not have a drive number in it, it means to specify the default drive. The logical drive may or may not have been mounted for the format process.</dd>
<dt>opt</dt>
-<dd>Specifies the format option structure <tt>MKFS_PARM</tt> holding format options. If a null pointer is given, it gives the function all options in default value. The structure has five members described below:<br>
+<dd>Specifies the format option structure <tt>MKFS_PARM</tt> holding format options. If a null pointer is given, it gives the function every option in default value. The structure has five members in order of described below:<br>
<dl class="par">
<dt>BYTE fmt</dt>
-<dd>Specifies combination of FAT type flags, <tt>FM_FAT</tt>, <tt>FM_FAT32</tt>, <tt>FM_EXFAT</tt> and bitwise-or of these three, <tt>FM_ANY</tt>. <tt>FM_EXFAT</tt> is ignored when exFAT is not enabled. These flags specify which FAT type to be created on the volume. If two or more types are specified, one out of them will be selected depends on the volume size and <tt class="arg">au_size</tt>. The flag <tt>FM_SFD</tt> specifies to create the volume on the drive in SFD format. The default value is <tt>FM_ANY</tt>.</dd>
-<dt>DWORD au_size</dt>
-<dd>Specifies size of the allocation unit (cluter) in unit of byte. The valid value is power of 2 between sector size and 128 * sector size inclusive for FAT/FAT32 volume, or up to 16 MB for exFAT volume. If a zero (default value) or any invalid value is given, the function uses default allocation unit size depends on the volume size.</dd>
-<dt>UINT n_align</dt>
-<dd>Specifies alignment of the volume data area (file allocation pool, usually erase block boundary of flash memory media) in unit of sector. The valid value for this member is between 1 and 32768 inclusive in power of 2. If a zero (the default value) or any invalid value is given, the function obtains the block size from lower layer with <tt>disk_ioctl</tt> function.</dd>
+<dd>Specifies a combination of FAT type flags, <tt>FM_FAT</tt>, <tt>FM_FAT32</tt>, <tt>FM_EXFAT</tt> and bitwise-or of these three, <tt>FM_ANY</tt>. <tt>FM_EXFAT</tt> is ignored when exFAT is not enabled. These flags specify which type of FAT volume to be created. If two or more types are specified, one out of them will be selected depends on the volume size and <tt class="arg">au_size</tt>. The flag <tt>FM_SFD</tt> specifies to create the volume on the drive in SFD format. The default value is <tt>FM_ANY</tt>.</dd>
<dt>BYTE n_fat</dt>
<dd>Specifies number of FAT copies on the FAT/FAT32 volume. Valid value for this member is 1 or 2. The default value (0) and any invaid value gives 1. If the FAT type is exFAT, this member has no effect.</dd>
+<dt>UINT align</dt>
+<dd>Specifies alignment of the volume data area (file allocation pool, usually erase block boundary of flash memory media) <em>in unit of sector</em>. The valid value for this member is between 1 and 32768 inclusive in power of 2. If a zero (the default value) or an invalid value is given, the function obtains the block size from lower layer with <tt>disk_ioctl</tt> function.</dd>
<dt>UINT n_root</dt>
<dd>Specifies number of root directory entries on the FAT volume. Valid value for this member is up to 32768 and aligned to sector size / 32. The default value (0) and any invaid value gives 512. If the FAT type is FAT32 or exFAT, this member has no effect.</dd>
+<dt>DWORD au_size</dt>
+<dd>Specifies size of the cluster (allocation unit) <em>in unit of byte</em>. The valid value for this member is between sector size and 128 * sector size inclusive in power of 2 for FAT/FAT32 volume and up to 16 MB in power of 2 for exFAT volume. If a zero (default value) or an invalid value is given, the function uses a default cluster size depends on the volume size.</dd>
</dl>
<dt>work</dt>
-<dd>Pointer to the working buffer used for the format process. If a null pointer is given with <tt><a href="config.html#use_lfn">FF_USE_LFN</a> == 3</tt>, the function obtains a memory block for the working buffer in this function.</dd>
+<dd>Pointer to the working buffer used for the format process. If a null pointer is given with <tt><a href="config.html#use_lfn">FF_USE_LFN</a> == 3</tt>, the function uses a <tt>len</tt> bytes of heap memory in this function.</dd>
<dt>len</dt>
-<dd>Size of the working buffer in unit of byte. It needs to be <tt>FF_MAX_SS</tt> at least. Plenty of working buffer reduces number of write transactions to the drive and the format process will finish quickly.</dd>
+<dd>Size of the working buffer in unit of byte. It needs to be <tt>FF_MAX_SS</tt> at least. Plenty of working buffer reduces number of write transactions to the drive, thus the format process will finish quickly.</dd>
</dl>
</div>
@@ -69,9 +67,9 @@ FRESULT f_mkfs (
<p>The FAT sub-type, FAT12/FAT16/FAT32, of FAT volume except exFAT is determined by only number of clusters on the volume and nothing else, according to the FAT specification issued by Microsoft. Thus the FAT sub-type of created volume depends on the volume size and the cluster size. In case of the combination of FAT type and cluter size specified by argument is not valid for the volume size, the function will fail with <tt>FR_MKFS_ABORTED</tt>.</p>
<p>The allocation unit, also known as <em>cluster</em>, is a unit of disk space allocation for files. When the size of allocation unit is 32768 bytes, a file with 100 bytes in size occupies 32768 bytes of disk space. The space efficiency of disk usage gets worse as increasing size of allocation unit, but, on the other hand, the read/write performance increases. Therefore the size of allocation unit is a trade-off between space efficiency and performance. For the large volumes in GB order, 32768 bytes or larger, automatically selected by default, is recommended for most case unless extremely many small files are created in the volume.</p>
<p>When the logical drive to be formatted is associated with a physical drive (<tt><a href="config.html#multi_partition">FF_MULTI_PARTITION</a> == 0</tt> or <tt>VolToPart[].pt == 0</tt>) and <tt>FM_SFD</tt> flag is not specified, a partition occupies entire drive space is created and then the FAT volume is created in the partition. When <tt>FM_SFD</tt> flag is specified, the FAT volume is created without any disk partitioning.</p>
-<p>When the logical drive to be formatted is associated with a specific partition by multiple partition feature (<tt>FF_MULTI_PARTITION == 1</tt> and <tt>VolToPart[].pt > 0</tt>), the FAT volume is created in the partition of the physical drive specified by <a href="filename.html#vol">volume mapping table</a> and <tt>FM_SFD</tt> flag is ignored. The hosting physical drive needs to be partitioned with <tt>f_fdisk</tt> function or any partitioning tool prior to create the FAT volume with this function. If the partition is not exist, the function aborts with <tt>FR_MKFS_ABORTED</tt>.</p>
-<p>There are three standard disk partitioning formats, MBR, GPT and SFD. The MBR format, also known as FDISK format, is usually used for harddisk, memory card and U disk. It can divide a physical drive into one or more partitions with a partition table. The GPT, GUID Partition Table, is a newly defined patitioning format for large storage devices. FatFs suppors the GPT only when 64-bit LBA is enabled. The SFD, Super-Floppy Disk, is non-partitioned disk format. The FAT volume is located at LBA 0 and occupies the entire physical drive without any disk partitioning. It is usually used for floppy disk, optical disk and most super-floppy media. Some combination of systems and media support only either partitioned format or non-partitioned format and the other is not supported.</p>
-<p>Some systems manage the partitions in the on-board storage in non-standard format. The partitions are mapped as physical drives identified by <tt class="arg">pdrv</tt> in <tt>disk_*</tt> functions. For such systems, SFD format is suitable to create the FAT volume in the partition.</p>
+<p>When the logical drive to be formatted is associated with a specific partition by multiple partition feature (<tt>FF_MULTI_PARTITION == 1</tt> and <tt>VolToPart[].pt > 0</tt>), the FAT volume is created in the partition of the physical drive specified by <a href="filename.html#vol">volume mapping table</a> and <tt>FM_SFD</tt> flag is ignored. The hosting physical drive needs to be partitioned with <tt>f_fdisk</tt> function or some partitioning tool prior to create the FAT volume with this function. If the partition is not exist, the function fails with <tt>FR_MKFS_ABORTED</tt>.</p>
+<p>There are three standard disk partitioning formats, MBR, GPT and SFD. The MBR format, also known as FDISK format, is usually used for harddisk, memory card and U disk. It can divide a physical drive into one or more partitions with a partition table. The GPT, GUID Partition Table, is a newly defined patitioning format for large storage devices. FatFs suppors the GPT only when 64-bit LBA is enabled. The SFD, Super-Floppy Disk, is non-partitioned disk format. The FAT volume is located at LBA 0 and occupies the entire physical drive without disk partitioning. It is usually used for floppy disk, optical disk and most super-floppy media. Some combination of systems and media support only either partitioned format or non-partitioned format and the other is not supported.</p>
+<p>Some systems manage the partitions of on-board storage in non-standard format. The partitions are mapped as physical drives identified by <tt class="arg">pdrv</tt> in <tt>disk_*</tt> functions. For such systems, SFD format is suitable to create the FAT volume in the partition.</p>
</div>
<div class="para comp">
@@ -97,21 +95,21 @@ int main (void)
if (res) ...
<span class="c">/* Give a work area to the default drive */</span>
- f_mount(&fs, "", 0);
+ <em>f_mount</em>(&fs, "", 0);
<span class="c">/* Create a file as new */</span>
- res = f_open(&fil, "hello.txt", FA_CREATE_NEW | FA_WRITE);
+ res = <em>f_open</em>(&fil, "hello.txt", FA_CREATE_NEW | FA_WRITE);
if (res) ...
<span class="c">/* Write a message */</span>
- f_write(&fil, "Hello, World!\r\n", 15, &bw);
+ <em>f_write</em>(&fil, "Hello, World!\r\n", 15, &bw);
if (bw != 15) ...
<span class="c">/* Close the file */</span>
- f_close(&fil);
+ <em>f_close</em>(&fil);
<span class="c">/* Unregister work area */</span>
- f_mount(0, "", 0);
+ <em>f_mount</em>(0, "", 0);
...
</pre>
@@ -122,6 +120,7 @@ int main (void)
<p><a href="../res/mkfs.xlsx">Example of volume size and format parameters</a>, <a href="filename.html#vol">Volume management</a>, <tt><a href="fdisk.html">f_fdisk</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/mount.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/mount.html
index 57f40be..9b2eedf 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/mount.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/mount.html
@@ -3,8 +3,6 @@
<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/mount.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_mount</title>
</head>
@@ -32,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>
@@ -55,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>
@@ -63,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)
@@ -92,19 +90,19 @@ int main (void)
FATFS *fs; <span class="c">/* Ponter to the filesystem object */</span>
- fs = malloc(sizeof (FATFS)); <span class="c">/* Get work area for the volume */</span>
- <em>f_mount</em>(fs, "", 0); <span class="c">/* Mount the default drive */</span>
+ fs = malloc(sizeof (FATFS)); <span class="c">/* Get work area for the volume */</span>
+ <em>f_mount</em>(fs, "", 0); <span class="c">/* Mount the default drive */</span>
- f_open(... <span class="c">/* Here any file API can be used */</span>
+ f_open(... <span class="c">/* Here any file API can be used */</span>
...
- <em>f_mount</em>(fs, "", 0); <span class="c">/* Re-mount the default drive to reinitialize the filesystem */</span>
+ <em>f_mount</em>(fs, "", 0); <span class="c">/* Re-mount the default drive to reinitialize the filesystem */</span>
...
- <em>f_mount</em>(0, "", 0); <span class="c">/* Unmount the default drive */</span>
- free(fs); <span class="c">/* Here the work area can be discarded */</span>
+ <em>f_unmount</em>(""); <span class="c">/* Unmount the default drive */</span>
+ free(fs); <span class="c">/* Here the work area can be discarded */</span>
...
}
@@ -117,6 +115,7 @@ int main (void)
<p><tt><a href="open.html">f_open</a></tt>, <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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/oem2uni.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/oem2uni.html
new file mode 100644
index 0000000..19d1d1e
--- /dev/null
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/oem2uni.html
@@ -0,0 +1,48 @@
+<!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 - ff_oem2uni</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>ff_oem2uni</h2>
+<p>The ff_oem2uni function converts an OEM character into Unicode character.</p>
+<pre>
+WCHAR ff_oem2uni (
+ WCHAR <span class="arg">oem</span>, <span class="c">/* [IN] OEM character */</span>
+ WORD <span class="arg">cp</span> <span class="c">/* [IN] Code page */</span>
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameters</h4>
+<dl class="par">
+<dt>oem</dt>
+<dd>An OEM character to be converted into Unicode.</dd>
+<dt>cp</dt>
+<dd>Code page of input character. If <tt><a href="config.html#code_page">FF_CODE_PAGE</a></tt> specifies a code page, only this code page can be specified. If it specifies all code page, any supported code page can be specified.</dd>
+</dl>
+</div>
+
+
+<div class="para ret">
+<h4>Return Value</h4>
+<p>The function returns a Unicode character in UTF-16 encoding converted from input OEM character. If the input character code in specified code page is invalid, a null character is returned.</p>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>This function is provided in <tt>ffunicode.c</tt> and required when <tt><a href="config.html#use_lfn">FF_USE_LFN != 0</a></tt>. It is intended to be used by FatFs but also application program may use this function.</p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/open.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/open.html
index dd2a6e6..4f78f4f 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/open.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/open.html
@@ -3,8 +3,6 @@
<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/open.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_open</title>
</head>
@@ -27,19 +25,19 @@ FRESULT f_open (
<h4>Parameters</h4>
<dl class="par">
<dt>fp</dt>
-<dd>Pointer to the blank file object structure.</dd>
+<dd>Pointer to the blank file object structure. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>
<dt>path</dt>
-<dd>Pointer to the 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. If a null pointer is given, the function fails with <tt>FR_INVALID_DRIVE</tt>.</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>Flags</th><th>Meaning</th></tr>
<tr><td>FA_READ</td><td>Specifies read access to the file. Data can be read from the file.</tr>
<tr><td>FA_WRITE</td><td>Specifies write access to the file. 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 a file. The function fails if the file is not existing. (Default)</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>
-<tr><td>FA_OPEN_ALWAYS</td><td>Opens the file if it is existing. If not, a new file will be created.</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_CREATE_ALWAYS</td><td>Creates a new file. If the file is existing, the file is truncated and overwritten.</td></tr>
+<tr><td>FA_CREATE_NEW</td><td>Creates a new file. The function fails if the file is existing.</td></tr>
+<tr><td>FA_OPEN_ALWAYS</td><td>Opens the file. If it is not exist, a new file is created.</td></tr>
<tr><td>FA_OPEN_APPEND</td><td>Same as <tt>FA_OPEN_ALWAYS</tt> except the read/write pointer is set end of the file.</td></tr>
</table>
Mode flags in POSIX fopen() function corresponds to FatFs mode flags as follows:<br>
@@ -86,7 +84,8 @@ Mode flags in POSIX fopen() function corresponds to FatFs mode flags as follows:
<div class="para desc">
<h4>Description</h4>
-<p>The <tt>f_open</tt> function opens a file and creates a <em>file object</em>. The file object is used for subsequent read/write operations to the file to identify the file. Open file should be closed with <a href="close.html"><tt>f_close</tt></a> function after the session of the file access. If any change to the file is made and not closed prior to power down, media removal or re-mount, or the file can be collapsed.</p>
+<p>The <tt>f_open</tt> function opens a file and creates a <em>file object</em>. It is the identifier for subsequent read/write operations to the file. After the function succeeded, the file object is valid. If the function failed, the file object is set invalid.</p>
+<p>Open file should be closed with <a href="close.html"><tt>f_close</tt></a> function after the session of the file access. If any change to the file has been made and not closed prior to power off, media removal or re-mount, or the file can be collapsed.</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>
@@ -112,19 +111,19 @@ int main (void)
<span class="c">/* Give a work area to the default drive */</span>
- f_mount(&FatFs, "", 0);
+ <em>f_mount</em>(&FatFs, "", 0);
<span class="c">/* Open a text file */</span>
fr = <em>f_open</em>(&fil, "message.txt", FA_READ);
if (fr) return (int)fr;
<span class="c">/* Read every line and display it */</span>
- while (f_gets(line, sizeof line, &fil)) {
+ while (<em>f_gets</em>(line, sizeof line, &fil)) {
printf(line);
}
<span class="c">/* Close the file */</span>
- f_close(&fil);
+ <em>f_close</em>(&fil);
return 0;
}
@@ -142,8 +141,8 @@ int main (void)
<span class="c">/* Give work areas to each logical drive */</span>
- f_mount(&fs0, "0:", 0);
- f_mount(&fs1, "1:", 0);
+ <em>f_mount</em>(&fs0, "0:", 0);
+ <em>f_mount</em>(&fs1, "1:", 0);
<span class="c">/* Open source file on the drive 1 */</span>
fr = <em>f_open</em>(&fsrc, "1:file.bin", FA_READ);
@@ -155,19 +154,19 @@ int main (void)
<span class="c">/* Copy source to destination */</span>
for (;;) {
- fr = f_read(&fsrc, buffer, sizeof buffer, &br); <span class="c">/* Read a chunk of data from the source file */</span>
+ fr = <em>f_read</em>(&fsrc, buffer, sizeof buffer, &br); <span class="c">/* Read a chunk of data from the source file */</span>
if (br == 0) break; <span class="c">/* error or eof */</span>
- fr = f_write(&fdst, buffer, br, &bw); <span class="c">/* Write it to the destination file */</span>
+ fr = <em>f_write</em>(&fdst, buffer, br, &bw); <span class="c">/* Write it to the destination file */</span>
if (bw < br) break; <span class="c">/* error or disk full */</span>
}
<span class="c">/* Close open files */</span>
- f_close(&fsrc);
- f_close(&fdst);
+ <em>f_close</em>(&fsrc);
+ <em>f_close</em>(&fdst);
<span class="c">/* Unregister work area prior to discard it */</span>
- f_unmount("0:");
- f_unmount("1:");
+ <em>f_unmount</em>("0:");
+ <em>f_unmount</em>("1:");
return (int)fr;
}
@@ -180,6 +179,7 @@ int main (void)
<p><tt><a href="read.html">f_read</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a>, <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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/opendir.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/opendir.html
index 215c37a..bc6d457 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/opendir.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/opendir.html
@@ -3,8 +3,6 @@
<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/opendir.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_opendir</title>
</head>
@@ -26,9 +24,9 @@ FRESULT f_opendir (
<h4>Parameters</h4>
<dl class="par">
<dt>dp</dt>
-<dd>Pointer to the blank directory object to create a new one.</dd>
+<dd>Pointer to the blank directory object to create a new one. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>
<dt>path</dt>
-<dd>Pointer 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. If a null pointer is given, the function fails with <tt>FR_INVALID_DRIVE</tt>.</dd>
</dl>
</div>
@@ -70,6 +68,7 @@ FRESULT f_opendir (
<p><tt><a href="readdir.html">f_readdir</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/printf.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/printf.html
index 557fb57..1db4016 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/printf.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/printf.html
@@ -1,114 +1,114 @@
-<!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/printf.html">
-<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
-<title>FatFs - f_printf</title>
-</head>
-
-<body>
-
-<div class="para func">
-<h2>f_printf</h2>
-<p>The f_printf function writes formatted string to the file.</p>
-<pre>
-int f_printf (
- FIL* <span class="arg">fp</span>, <span class="c">/* [IN] File object */</span>
- const TCHAR* <span class="arg">fmt</span>, <span class="c">/* [IN] Format stirng */</span>
- ...
-);
-</pre>
-</div>
-
-<div class="para arg">
-<h4>Parameters</h4>
-<dl class="par">
-<dt>fp</dt>
-<dd>Pointer to the open file object structure.</dd>
-<dt>fmt</dt>
-<dd>Pointer to the null <tt>'\0'</tt> terminated format string. The terminator character will not be output.</dd>
-<dt>...</dt>
-<dd>Optional arguments...</dd>
-
-</dl>
-</div>
-
-
-<div class="para ret">
-<h4>Return Values</h4>
-<p>When the string was written successfuly, it returns number of character encoding units written to the file. When the function failed due to disk full or an error, a negative value will be returned.</p>
-</div>
-
-
-<div class="para desc">
-<h4>Description</h4>
-<p>The format control directive is a sub-set of standard library shown as follows:</p>
-<pre>
- %[flag][width][precision][size]type
-</pre>
-<dl>
-<dt>flag</dt><dd>Padding options. A <tt>-</tt> specifies left-aligned. A <tt>0</tt> specifies zero padded. The default setting is in right-aligned and space padded.</dd>
-<dt>width</dt><dd>Minimum width of the field, <tt>1-99</tt> or <tt>*</tt>. If the width of generated string is less than the specified value, rest field is padded with spaces or zeros. An <tt>*</tt> specifies the value comes from an argument in int type.</dd>
-<dt>precision</dt><dd>Specifies number of fractional digits or maximum width of string, <tt>.0-.99</tt> or <tt>.*</tt>. If number is omitted, it will be same as <tt>.0</tt>. Default setting is 6 for number and no limit for string.</dd>
-<dt>size</dt><dd>Specifies size of integer argument, <tt>l</tt>(long) and <tt>ll</tt>(long long). If <tt>sizeof (long) == sizeof (int)</tt> is true (this is typical of 32-bit systems), prefix <tt>l</tt> can be omitted for long integer argument. The default size is int for integer arrument and floating point argument is always assumed double.</dd>
-<dt>type</dt><dd>Specifies type of the output format and the argument as shown below. The length of generated string is in assumtion of int is 32-bit.
-<table class="lst1">
-<tr><th>Type</th><th>Format</th><th>Argument</th><th>Length</th></tr>
-<tr><td><tt>c</tt></td><td>Character</td><td rowspan="6"><tt>int</tt>,<br><tt>long</tt>,<br><tt>long long</tt></td><td>1 character.</td></tr>
-<tr><td><tt>d</tt></td><td>Signed decimal</td><td>1 to 11 (20 for ll) characters.</td></tr>
-<tr><td><tt>u</tt></td><td>Unsigned decimal</td><td>1 to 10 (20 for ll) characters.</td></tr>
-<tr><td><tt>o</tt></td><td>Unsigned octal</td><td>1 to 11 (22 for ll) characters.</td></tr>
-<tr><td><tt>x X</tt></td><td>Unsigned hexdecimal</td><td>1 to 8 (16 for ll) characters.</td></tr>
-<tr><td><tt>b</tt></td><td>Unsigned binary</td><td>1 to 32 characters. Limited to lower 32 digits when ll is specified.</td></tr>
-<tr><td><tt>s</tt></td><td>String</td><td><tt>TCHAR*</tt></td><td>As input string. Null pointer generates a null string.</td></tr>
-<tr><td><tt>f</tt></td><td>Floating point<br>(decimal)</td><td rowspan="2"><tt>double</tt></td><td>1 to 31 characters. If the number of characters exceeds 31, it writes <tt>"±OV"</tt>. Not a number and infinite write <tt>"NaN"</tt> and <tt>"±INF"</tt>.</td></tr>
-<tr><td><tt>e E</tt></td><td>Floating point<br>(e notation)</td><td>4 to 31 characters. If the number of characters exceeds 31 or exponent exceeds +99, it writes <tt>"±OV"</tt>.</td></tr>
-</table>
-</dd>
-</dl>
-<p>When FatFs is configured for Unicode API (<tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a> >= 1</tt>), character encoding on the string fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The Unicode characters in multiple encoding unit, such as surrogate pair and multi-byte sequence, should not be divided into two function calls, or the character will be lost. The character encoding <em>on the file</em> to be written via this function is selected by <tt><a href="config.html#strf_encode">FF_STRF_ENCODE</a></tt>. The characters with wrong encoding or invalid for the output encoding will be lost.</p>
-</div>
-
-
-<div class="para comp">
-<h4>QuickInfo</h4>
-<p>This is a wrapper function of <a href="write.html"><tt>f_write</tt></a> function. Available when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 0</tt> and <tt><a href="config.html#use_strfunc">FF_USE_STRFUNC</a> >= 1</tt>. When <tt>FF_USE_STRFUNC == 2</tt>, <tt>'\n'</tt>s in the generated string are written as <tt>'\r'+'\n'</tt> each.</p>
-</div>
-
-
-<div class="para use">
-<h4>Example</h4>
-<pre>
- <em>f_printf</em>(fp, "%d", 1234); <span class="c">/* "1234" */</span>
- <em>f_printf</em>(fp, "%6d,%3d%%", -200, 5); <span class="c">/* " -200, 5%" */</span>
- <em>f_printf</em>(fp, "%-6u", 100); <span class="c">/* "100 " */</span>
- <em>f_printf</em>(fp, "%ld", 12345678); <span class="c">/* "12345678" */</span>
- <em>f_printf</em>(fp, "%llu", 0x100000000); <span class="c">/* "4294967296" (<a href="config.html#print_lli">FF_PRINT_LLI</a>) */</span>
- <em>f_printf</em>(fp, "%lld", -1LL); <span class="c">/* "-1" (FF_PRINT_LLI) */</span>
- <em>f_printf</em>(fp, "%04x", 0xA3); <span class="c">/* "00a3" */</span>
- <em>f_printf</em>(fp, "%08lX", 0x123ABC); <span class="c">/* "00123ABC" */</span>
- <em>f_printf</em>(fp, "%016b", 0x550F); <span class="c">/* "0101010100001111" */</span>
- <em>f_printf</em>(fp, "%*d", 6, 100); <span class="c">/* " 100" */</span>
- <em>f_printf</em>(fp, "%s", "abcdefg"); <span class="c">/* "abcdefg" */</span>
- <em>f_printf</em>(fp, "%5s", "abc"); <span class="c">/* " abc" */</span>
- <em>f_printf</em>(fp, "%-5s", "abc"); <span class="c">/* "abc " */</span>
- <em>f_printf</em>(fp, "%.5s", "abcdefg"); <span class="c">/* "abcde" */</span>
- <em>f_printf</em>(fp, "%-5.2s", "abcdefg"); <span class="c">/* "ab " */</span>
- <em>f_printf</em>(fp, "%c", 'a'); <span class="c">/* "a" */</span>
- <em>f_printf</em>(fp, "%12f", 10.0); <span class="c">/* " 10.000000" (<a href="config.html#print_fp">FF_PRINT_FLOAT</a>) */</span>
- <em>f_printf</em>(fp, "%.4E", 123.45678); <span class="c">/* "1.2346E+02" (FF_PRINT_FLOAT) */</span>
-</pre>
-</div>
-
-
-<div class="para ref">
-<h4>See Also</h4>
-<p><tt><a href="open.html">f_open</a>, <a href="putc.html">f_putc</a>, <a href="puts.html">f_puts</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>
-</div>
-
-<p class="foot"><a href="../00index_e.html">Return</a></p>
-</body>
-</html>
+<!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 - f_printf</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>f_printf</h2>
+<p>The f_printf function writes formatted string to the file.</p>
+<pre>
+int f_printf (
+ FIL* <span class="arg">fp</span>, <span class="c">/* [IN] File object */</span>
+ const TCHAR* <span class="arg">fmt</span>, <span class="c">/* [IN] Format stirng */</span>
+ ...
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameters</h4>
+<dl class="par">
+<dt>fp</dt>
+<dd>Pointer to the open file object structure.</dd>
+<dt>fmt</dt>
+<dd>Pointer to the null <tt>'\0'</tt> terminated format string. The terminator character will not be output.</dd>
+<dt>...</dt>
+<dd>Optional arguments...</dd>
+
+</dl>
+</div>
+
+
+<div class="para ret">
+<h4>Return Values</h4>
+<p>When the string was written successfuly, it returns number of character encoding units written to the file. When the function failed due to disk full or an error, a negative value will be returned.</p>
+</div>
+
+
+<div class="para desc">
+<h4>Description</h4>
+<p>The format control directive is a sub-set of standard library shown as follows:</p>
+<pre>
+ %[flag][width][precision][size]type
+</pre>
+<dl>
+<dt>flag</dt><dd>Padding option. A <tt>-</tt> specifies left-aligned. A <tt>0</tt> specifies zero padded. The default setting is in right-aligned and space padded.</dd>
+<dt>width</dt><dd>Minimum width of the field, <tt>1-99</tt> or <tt>*</tt>. If the width of generated string is less than the minimum width, rest field is padded with spaces or zeros. An <tt>*</tt> specifies the value comes from an argument in int type. The default setting is zero.</dd>
+<dt>precision</dt><dd>Specifies number of fractional digits or maximum width of string, <tt>.0-.99</tt> or <tt>.*</tt>. If the number is omitted, it is same as <tt>.0</tt>. Default setting is 6 for number and no limit for string.</dd>
+<dt>size</dt><dd>Specifies size of integer argument, <tt>l</tt>(long) and <tt>ll</tt>(long long). If <tt>sizeof (long) == sizeof (int)</tt> is true (this is typical of 32-bit systems), prefix <tt>l</tt> can be omitted for long integer argument. The default size is int for integer argument and floating point argument is always assumed double as the default argument promotion.</dd>
+<dt>type</dt><dd>Specifies type of the output format and the argument as shown below. The length of generated string is in assumtion of int is 32-bit.
+<table class="lst1">
+<tr><th>Type</th><th>Format</th><th>Argument</th><th>Length</th></tr>
+<tr><td><tt>c</tt></td><td>Character</td><td rowspan="6"><tt>int</tt>,<br><tt>long</tt>,<br><tt>long long</tt></td><td>1 character.</td></tr>
+<tr><td><tt>d</tt></td><td>Signed decimal</td><td>1 to 11 (20 for ll) characters.</td></tr>
+<tr><td><tt>u</tt></td><td>Unsigned decimal</td><td>1 to 10 (20 for ll) characters.</td></tr>
+<tr><td><tt>o</tt></td><td>Unsigned octal</td><td>1 to 11 (22 for ll) characters.</td></tr>
+<tr><td><tt>x X</tt></td><td>Unsigned hexdecimal</td><td>1 to 8 (16 for ll) characters.</td></tr>
+<tr><td><tt>b</tt></td><td>Unsigned binary</td><td>1 to 32 characters. Limited to lower 32 digits when ll is specified.</td></tr>
+<tr><td><tt>s</tt></td><td>String</td><td><tt>TCHAR*</tt></td><td>As input string. A null pointer generates a zero-length string.</td></tr>
+<tr><td><tt>f</tt></td><td>Floating point<br>(decimal)</td><td rowspan="2"><tt>double</tt></td><td>1 to 31 characters. If the number of characters exceeds 31, it writes <tt>"±OV"</tt>. Not a number and infinite value write <tt>"NaN"</tt> and <tt>"±INF"</tt> respectively.</td></tr>
+<tr><td><tt>e E</tt></td><td>Floating point<br>(e notation)</td><td>4 to 31 characters. If the number of characters exceeds 31 or exponent exceeds +99, it writes <tt>"±OV"</tt>.</td></tr>
+</table>
+</dd>
+</dl>
+<p>When FatFs is configured for Unicode API (<tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a> >= 1</tt>), character encoding on the string fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The Unicode characters in multiple encoding unit, such as surrogate pair and multi-byte sequence, should not be divided into two function calls, or the character will be lost. The character encoding <em>on the file</em> to be written via this function is selected by <tt><a href="config.html#strf_encode">FF_STRF_ENCODE</a></tt>. If the character encoding differs between file data and API, it is converted in this function. Input characters with wrong encoding for output will be lost.</p>
+<p>If <tt>sprintf</tt> is used in the project and code conversion is not needed, <tt>f_write</tt> with <tt>sprintf</tt> will be better in code size and write throughput rather than <tt>f_printf</tt>.</p>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>This is a wrapper function of <a href="write.html"><tt>f_write</tt></a> function. Available when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 0</tt> and <tt><a href="config.html#use_strfunc">FF_USE_STRFUNC</a> >= 1</tt>. When <tt>FF_USE_STRFUNC == 2</tt>, <tt>'\n'</tt>s in the generated string are written as <tt>'\r'+'\n'</tt> each.</p>
+</div>
+
+
+<div class="para use">
+<h4>Example</h4>
+<pre>
+ <em>f_printf</em>(fp, "%d", 1234); <span class="c">/* "1234" */</span>
+ <em>f_printf</em>(fp, "%6d,%3d%%", -200, 5); <span class="c">/* " -200, 5%" */</span>
+ <em>f_printf</em>(fp, "%-6u", 100); <span class="c">/* "100 " */</span>
+ <em>f_printf</em>(fp, "%ld", 12345678); <span class="c">/* "12345678" */</span>
+ <em>f_printf</em>(fp, "%llu", 0x100000000); <span class="c">/* "4294967296" (<a href="config.html#print_lli">FF_PRINT_LLI</a>) */</span>
+ <em>f_printf</em>(fp, "%lld", -1LL); <span class="c">/* "-1" (FF_PRINT_LLI) */</span>
+ <em>f_printf</em>(fp, "%04x", 0xA3); <span class="c">/* "00a3" */</span>
+ <em>f_printf</em>(fp, "%08lX", 0x123ABC); <span class="c">/* "00123ABC" */</span>
+ <em>f_printf</em>(fp, "%016b", 0x550F); <span class="c">/* "0101010100001111" */</span>
+ <em>f_printf</em>(fp, "%*d", 6, 100); <span class="c">/* " 100" */</span>
+ <em>f_printf</em>(fp, "%s", "abcdefg"); <span class="c">/* "abcdefg" */</span>
+ <em>f_printf</em>(fp, "%5s", "abc"); <span class="c">/* " abc" */</span>
+ <em>f_printf</em>(fp, "%-5s", "abc"); <span class="c">/* "abc " */</span>
+ <em>f_printf</em>(fp, "%.5s", "abcdefg"); <span class="c">/* "abcde" */</span>
+ <em>f_printf</em>(fp, "%-5.2s", "abcdefg"); <span class="c">/* "ab " */</span>
+ <em>f_printf</em>(fp, "%c", 'a'); <span class="c">/* "a" */</span>
+ <em>f_printf</em>(fp, "%12f", 10.0); <span class="c">/* " 10.000000" (<a href="config.html#print_fp">FF_PRINT_FLOAT</a>) */</span>
+ <em>f_printf</em>(fp, "%.4E", 123.45678); <span class="c">/* "1.2346E+02" (FF_PRINT_FLOAT) */</span>
+</pre>
+</div>
+
+
+<div class="para ref">
+<h4>See Also</h4>
+<p><tt><a href="open.html">f_open</a>, <a href="putc.html">f_putc</a>, <a href="puts.html">f_puts</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>
+</div>
+
+
+<p class="foot"><a href="../index.html">Return</a></p>
+</body>
+</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/putc.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/putc.html
index 747b5fd..74552c9 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/putc.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/putc.html
@@ -3,8 +3,6 @@
<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/putc.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_putc</title>
</head>
@@ -55,6 +53,7 @@ int f_putc (
<p><tt><a href="open.html">f_open</a>, <a href="puts.html">f_puts</a>, <a href="printf.html">f_printf</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/puts.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/puts.html
index 3695942..de5833a 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/puts.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/puts.html
@@ -3,8 +3,6 @@
<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/puts.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_puts</title>
</head>
@@ -41,7 +39,7 @@ int f_puts (
<div class="para desc">
<h4>Description</h4>
-<p>When FatFs is configured for Unicode API (<tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a> >= 1</tt>), character encoding on the string fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The input Unicode characters in multiple encoding unit, such as surrogate pair and multi-byte sequence, should not be divided into two function calls, or the character will be lost. The character encoding <em>on the file</em> to be written via this functions is selected by <tt><a href="config.html#strf_encode">FF_STRF_ENCODE</a></tt>. The characters with wrong encoding or invalid for the output encoding will be lost.</p>
+<p>When FatFs is configured for Unicode API (<tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a> >= 1</tt>), character encoding on the string fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The input Unicode characters in multiple encoding unit, such as surrogate pair and multi-byte sequence, should not be divided into two function calls, or the character will be lost. The character encoding <em>on the file</em> to be written via this functions is selected by <tt><a href="config.html#strf_encode">FF_STRF_ENCODE</a></tt>. If the character encoding differs between file data and API, it is converted in this function. Input characters with wrong encoding for output will be lost.</p>
</div>
@@ -56,6 +54,7 @@ int f_puts (
<p><tt><a href="open.html">f_open</a>, <a href="putc.html">f_putc</a>, <a href="printf.html">f_printf</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/rc.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/rc.html
index 52b496c..8c4dba3 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/rc.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/rc.html
@@ -3,8 +3,6 @@
<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/rc.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - API Return Code</title>
</head>
@@ -19,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.
@@ -29,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>
@@ -46,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 the <a href="filename.html">path name</a>. One of the following possibilities is suspected.
+<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>
@@ -61,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_mkfs)</li>
-<li>Could not allocate a contiguous area to 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 a null pointer is given. There are some reasons as follows:
+<dd>The file/directory object is invalid or the pointer is null. There are some reasons as follows:
<ul>
-<li>It has been closed, or the structure has been collapsed.</li>
-<li>It has been invalidated. Open objects on the volume are invalidated by voulme mount process.</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>
@@ -93,8 +91,9 @@ Note that if once this error occured in the operation to an open file, the file
<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>
-<dd>No valid FAT volume could not be found in the drive. One of the following possibilities is suspected.
+<dd>Valid FAT volume could not be found in the drive. One of the following possibilities is suspected.
<ul>
+<li>The FAT volume on the drive is collapsed.</li>
<li>Wrong lower layer implementation.</li>
<li>Wrong <tt>VolToPart[]</tt> settings. (<tt>FF_MULTI_PARTITION = 1</tt>)</li>
</ul></dd>
@@ -112,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 +129,7 @@ Note that if once this error occured in the operation to an open file, the file
<dd>The given parameter is invalid or there is an inconsistent for the volume.</dd>
</dl>
-<p class="foot"><a href="../00index_e.html">Return</a></p>
+
+<p class="foot"><a href="../index.html">Return</a></p>
</body>
</html>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/read.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/read.html
index 4ab350d..3922c31 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/read.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/read.html
@@ -3,8 +3,6 @@
<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/read.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_read</title>
</head>
@@ -28,13 +26,13 @@ FRESULT f_read (
<h4>Parameters</h4>
<dl class="par">
<dt>fp</dt>
-<dd>Pointer to the open file object.</dd>
+<dd>Pointer to the open file object structure. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>
<dt>buff</dt>
<dd>Pointer to the buffer to store the read data.</dd>
<dt>btr</dt>
-<dd>Number of bytes to read in range of <tt>UINT</tt> type.</dd>
+<dd>Number of bytes to read in range of <tt>UINT</tt> type. If the file needs to be read fast, it should be read in large chunk as possible.</dd>
<dt>br</dt>
-<dd>Pointer to the <tt>UINT</tt> variable that receives number of bytes read. This value is always valid after the function call regardless of the function return code. If the return value is equal to <tt class="arg">btr</tt>, the function return code should be <tt>FR_OK</tt>.</dd>
+<dd>Pointer to the variable in <tt>UINT</tt> type that receives number of bytes read. This value is always valid after the function call regardless of the function return code. If the return value is equal to <tt class="arg">btr</tt>, the function return code should be <tt>FR_OK</tt>.</dd>
</dl>
</div>
@@ -54,7 +52,7 @@ FRESULT f_read (
<div class="para desc">
<h4>Description</h4>
-<p>The function starts to read data from the file at the file offset pointed by read/write pointer. The read/write pointer advances as number of bytes read. After the function succeeded, <tt class="arg">*br</tt> should be checked to detect end of the file. In case of <tt class="arg">*br</tt> < <tt class="arg">btr</tt>, it means the read/write pointer reached end of the file during read operation.</p>
+<p>The function starts to read data from the file at the file offset pointed by read/write pointer of the file object. The read/write pointer advances as number of bytes read. After the function succeeded, <tt class="arg">*br</tt> should be checked to detect end of the file. In case of <tt class="arg">*br</tt> < <tt class="arg">btr</tt>, it means the read/write pointer hit end of the file during read operation.</p>
</div>
@@ -75,6 +73,7 @@ FRESULT f_read (
<p><tt><a href="open.html">f_open</a>, <a href="gets.html">fgets</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</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>
diff --git a/src/rust/fatfs-sys/depend/fatfs/documents/doc/readdir.html b/src/rust/fatfs-sys/depend/fatfs/documents/doc/readdir.html
index 52a96b9..5eec3bb 100644
--- a/src/rust/fatfs-sys/depend/fatfs/documents/doc/readdir.html
+++ b/src/rust/fatfs-sys/depend/fatfs/documents/doc/readdir.html
@@ -3,8 +3,6 @@
<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/readdir.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_readdir</title>
</head>
@@ -53,19 +51,19 @@ FRESULT f_rewinddir (
<div class="para desc">
<h4>Description</h4>
-<p>The <tt>f_readdir</tt> function reads a directory item, informations about the object, from the open directory. Items in the directory can be read in sequence by <tt>f_readdir</tt> function calls. When all items in the directory have been read and no item to read, a null string is stored into the <tt>fno->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. The <tt>f_rewinddir</tt> function is implemented as a macro.</p>
+<p>The <tt>f_readdir</tt> function reads a directory item, informations about the object, from the open directory. Items in the directory can be read by <tt>f_readdir</tt> function calls in order of the directory table. When all items in the directory have been read and no item to read any more, a null string in <tt>fno->fname[]</tt> will be returned without an error. If an error occured, also <ttWhy this scored 27/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.