# FatFs Module Application Note

### How to port

#### Basic considerations

The FatFs module is assuming following conditions on portability.

- ANSI C
  The FatFs module is a middleware which is written in ANSI C. There is no platform dependence, so long as the compiler is in compliance with ANSI C.
- Size of integer types
  The FatFs module assumes that size of char/short/long are 8/16/32 bit and int is 16 or 32 bit. These correspondence are defined in integer.h. This will not be a problem on most compilers. When any conflict with existing definitions is occured, you must resolve it with care.

#### Which function is required?

You need to provide only low level disk I/O functions that required by FatFs module and nothing else. If a working disk module for the target is already existing, you need to write only glue functions to attach it to the FatFs module. If not, you need to port any other disk module or write it from scratch. All defined functions are not that always required. For example, disk write function is not required in read-only configuration. Following table shows which function is required depends on configuration options.

Function | Required when: | Note
--- | --- | ---
disk_initialize | Always | Samples available in ffsample.zip. There are many implementations on the web.
disk_status | Always
disk_read | Always
disk_write | _FS_READONLY == 0
disk_ioctl (CTRL_SYNC) | _FS_READONLY == 0
disk_ioctl (GET_SECTOR_COUNT) | _USE_MKFS == 1
disk_ioctl (GET_SECTOR_SIZE) | _MAX_SS >= 1024
disk_ioctl (GET_BLOCK_SIZE) | _USE_MKFS == 1
get_fattime | _FS_READONLY == 0
ff_convert | _USE_LFN >= 1 | Available in option/cc*.c.
ff_wtoupper | _USE_LFN >= 1
ff_cre_syncobj | _FS_REENTRANT == 1 | Samples available in option/syscall.c.
ff_del_syncobj | _FS_REENTRANT == 1
ff_req_grant | _FS_REENTRANT == 1
ff_rel_grant | _FS_REENTRANT == 1
ff_mem_alloc | _USE_LFN == 3
ff_mem_free | _USE_LFN == 3

### Limits

- FAT sub-types: FAT12, FAT16 and FAT32.
- Number of open files: Unlimited, depends on available memory.
- Number of volumes: Upto 10.
- File size: Depends on FAT specs. (upto 4G-1 bytes)
- Volume size: Depends on FAT specs. (upto 2T bytes on 512 bytes/sector)
- Cluster size: Depends on FAT specs. (upto 64K bytes on 512 bytes/sector)
- Sector size: Depends on FAT specs. (upto 4K bytes)

### Memory Usage (R0.08)

| AVR | H8/300H | PIC24 | V850ES | SH-2A | ARM7 | x86
--- | --- | --- | --- | --- | --- | --- | ---
Compiler | WinAVR(gcc) | CH38 | C30(gcc) | CA850 | SHC | WinARM(gcc) | VC6
_WORD_ACCESS | 1 | 0 | 0 | 1 | 0 | 0 | 1
text (Full, R/W) | 12700 | 10686 | 11376 | 7730 | 8592 | 10520 | 7545
text (Min, R/W) | 8386 | 6980 | 7395 | 4930 | 5600 | 6636 | 4923
text (Full, R/O) | 6012 | 4874 | 5250 | 3556 | 3848 | 4656 | 3450
text (Min, R/O) | 4384 | 3774 | 3939 | 2684 | 2996 | 3416 | 2664
bss | D*2 + 2 | D*4 + 2 | D*2 + 2 | D*4 + 2 | D*4 + 2 | D*4 + 2 | D*4 + 2
Work area (_FS_TINY == 0) | D*560 + F*544 | D*560 + F*550 | D*560 + F*544 | D*560 + F*550 | D*560 + F*550 | D*560 + F*550 | D*560 + F*550
Work area (_FS_TINY == 1) | D*560 + F*32 | D*560 + F*36 | D*560 + F*32 | D*560 + F*36 | D*560 + F*36 | D*560 + F*36 | D*560 + F*36

These are the memory usage on some target systems with following condition. The memory sizes are in unit of byte, D means number of volumes and F means number of open files. All samples are optimezed in code size.

    _FS_READONLY     0 (R/W), 1 (R/O)
    _FS_MINIMIZE     0 (Full function), 3 (Minimized function)
    _USE_STRFUNC     0 (Disable string functions)
    _USE_MKFS        0 (Disable f_mkfs function)
    _USE_FORWARD     0 (Disable f_forward function)
    _USE_FASTSEEK    0 (Disable fast seek feature)
    _CODE_PAGE       932 (Japanese Shift-JIS)
    _USE_LFN         0 (Disable LFN)
    _MAX_SS          512 (Fixed sector size)
    _FS_RPATH        0 (Disable relative path)
    _MULTI_PARTITION 0 (Single partition per drive)
    _FS_REENTRANT    0 (Disable reentrancy)
    _FS_SHARE        0 (Disable shareing control)

### Module Size Reduction

Follwing table shows which function is removed by configuration options for the module size reduction.

Function | _FS_MINIMIZE | _FS_READONLY | _USE_STRFUNC | _FS_RPATH | _USE_MKFS | _USE_FORWARD
1 | 2 | 3 | 1 | 0 | 0 | 0 | 0
f_mount |  |  |  |  |  |  |  |
f_open |  |  |  |  |  |  |  |
f_close |  |  |  |  |  |  |  |
f_read |  |  |  |  |  |  |  |
f_write |  |  |  | x |  |  |  |
f_sync |  |  |  | x |  |  |  |
f_lseek |  |  | x |  |  |  |  |
f_opendir |  | x | x |  |  |  |  |
f_readdir |  | x | x |  |  |  |  |
f_stat | x | x | x |  |  |  |  |
f_getfree | x | x | x | x |  |  |  |
f_truncate | x | x | x | x |  |  |  |
f_unlink | x | x | x | x |  |  |  |
f_mkdir | x | x | x | x |  |  |  |
f_chmod | x | x | x | x |  |  |  |
f_utime | x | x | x | x |  |  |  |
f_rename | x | x | x | x |  |  |  |
f_chdir |  |  |  |  |  | x |  |
f_chdrive |  |  |  |  |  | x |  |
f_mkfs |  |  |  | x |  |  | x |
f_forward |  |  |  |  |  |  |  | x
f_putc |  |  |  | x | x |  |  |
f_puts |  |  |  | x | x |  |  |
f_printf |  |  |  | x | x |  |  |
f_gets |  |  |  |  | x |  |  |

### Long File Name

The FatFs module has started to support long file name (LFN) at revision 0.07. The two different file names, SFN and LFN, of a file is transparent in the file functions except for f_readdir function. To enable LFN feature, set `_USE_LFN` to 1, 2 or 3, and add a Unicode code conversion function `ff_convert()` and `ff_wtoupper()` to the project. The LFN feature requiers a certain working buffer in addition. The buffer size can be configured by `_MAX_LFN` corresponding to the available memory size. The size of long file name will reach up to 255 characters so that the `_MAX_LFN` should be set to 255 for full featured LFN operation. If the size of working buffer is insufficient for the given file name, the file function fails with `FR_INVALID_NAME`. When enable the LFN feature with re-entrant feature, `_USE_LFN` must be set to 2 or 3. In this case, the file function allocates the working buffer on the stack or heap. The working buffer occupies `(_MAX_LFN + 1) * 2` bytes.

LFN cfg on ARM7
Code page | Program size
--- | ---
SBCS | +3.7K
932(Shift-JIS) | +62K
936(GBK) | +177K
949(Korean) | +139K
950(Big5) | +111K

When the LFN feature is enabled, the module size will be increased depends on the selected code page. Right table shows how many bytes increased when LFN feature is enabled with some code pages. We are the Japanese, Chinese and Korean have tens of thousands of characters. Unfortunately, it requires a huge OEM-Unicode bidirectional conversion table and the module size will be drastically increased that shown in the table. As the result, the FatFs with LFN feature with DBCS will not able to be implemented to most 8-bit microcontrollers. This is the reason why I had not been interested in implementing the LFN feature for a long time :-)

Note that the LFN feature on the FAT file system is a patent of Microsoft Corporation. When enable it on the commercial products, a license from Microsoft may be required depends on the final destination.

### Unicode API

FatFs supports ANSI/OEM code set on the API in default but FatFs can also switch the code set to Unicode. For more information, refer to the description in the file name.

### Re-entrancy

The file operations to the different volume can always work simultaneously regardless of re-entrancy setting. The re-entrancy to the same volume can be enabled with `_FS_REENTRANT` option. In this case, also the OS dependent synchronization object control functions, ff_cre_syncobj, ff_del_syncobj, ff_req_grant and ff_rel_grant must be added to the project.

When a file function is called while the volume is in use by any other task, the access is blocked until the task leaves file function. If wait time exceeded a period defined by `_TIMEOUT`, the file function will abort with `FR_TIMEOUT`. The timeout feature might not be supported on some RTOS.

There is an exception on f_mount and f_mkfs function. These functions are not re-entrant to the same volume. When use these functions, all other task must close the corresponding file on the volume and avoid to access the volume.

Note that this section describes on the re-entrancy of the FatFs module itself. There is no assumtion on the re-entrancy of low level disk I/O module.

### Duplicated file access

FatFs module does not support the shareing controls of duplicated file access in default. It is permitted when open method to a file is only read mode. The duplicated open in write mode to a file is always prohibited and open file must not be renamed, deleted, otherwise the FAT structure on the volume can be collapted. Also current directory must not be deleted.

The file shareing control can also be available when `_FS_SHARE` is set to 1 or grater. In this case, if any open, rename or remove that violating the file shareing rule that described above is attempted, the file function will fail with `FR_LOCKED`.

### Performance effective file access

For good performance on reading/writing files on the small embedded system, application programmer should consider what process is done in the FatFs module. The file data on the disk is transferred in following sequence by f_read function.

Figure 1. Sector miss-aligned read (short)

Figure 2. Sector miss-aligned read (long)

Figure 3. Sector aligned read

The file I/O buffer means a sector buffer to read/write a partial data on the sector. The sector buffer is either file private sector buffer on each file object or shared sector buffer on the file system object. The buffer configuration option `_FS_TINY` determins which sector buffer is used for the file data transfer. When tiny buffer (1) is selected, data memory consumption is reduced 512 bytes each file object. In this case, FatFs module uses only a sector buffer on the file system object for file data transfer and FAT/directory access. The disadvantage of the tiny buffer configuration is: the FAT data cached in the sector buffer will be lost by file data transfer and it must be reloaded at every cluster boundary. However it will be suitable for most application from view point of the decent performance and low memory comsumption.

Figure 1 shows that partial sector data is transferred via the file I/O buffer. On long data transfer shown in Figure 2, middle of transfer data that covers one or more sector is transferred to 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 disk_read function at a time but the multi sector transfer never across the cluster boundary even if it is contiguous.

Therefore taking effort to sector aligned read/write accesss avoids 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 on the tiny configuration so that it can achieve same performance as non-tiny configuration with small memory footprint.

### Critical Section

If a write operation to the FAT file system is interrupted due to any accidental failure, such as sudden blackout, incorrect disk removal and unrecoverable disk error, the FAT structure can be collapted. Following images shows the critical section on the FatFs application.

Figure 4. Long critical section
Figure 5. Minimized critical section

An interruption in the red section can cause a cross link; as a result, the object being changed may be lost. There is one or more possibility listed below when an interruption in the yellow section is occured.

- File data being rewrited is collapted.
- A file being appended returns initial state.
- A file created as new is gone.
- A file created as new or in overwritten remains with no content.
- Efficiency of disk use gets worse due to lost chain.

Each case does not affect the files that not in write mode open. To minimize risk of data loss, the critical section can be minimized like shown in Figure 5 by minimizing the time that file is opened in write mode or using f_sync function properly.

### About FatFs License

This is a copy of the FatFs license document that included in the source codes.

    /*----------------------------------------------------------------------------/
    /  FatFs - FAT file system module  R0.08                     (C)ChaN, 2010
    /-----------------------------------------------------------------------------/
    / FatFs module is a generic FAT file system module for small embedded systems.
    / This is a free software that opened for education, research and commercial
    / developments under license policy of following trems.
    /
    /  Copyright (C) 2010, ChaN, all right reserved.
    /
    / * The FatFs module is a free software and there is NO WARRANTY.
    / * No restriction on use. You can use, modify and redistribute it for
    /   personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
    / * Redistributions of source code must retain the above copyright notice.
    /
    /-----------------------------------------------------------------------------/

Therefore FatFs license is one of the BSD-style license but there is a big difference. Because FatFs is for embedded projects, the conditions for redistributions in binary form, such as embedded code, hex file and binary library, are not specified to increase its usability. The documentation of the distributions need not include about FatFs and its license document, and it may also. Of course FatFs is compatible with the projects under GNU GPL. When redistribute it with any modification, the license can also be changed to GNU GPL or BSD-style license.

Return