Macros
#define	_FS_READONLY 1
	This option switches read-only configuration. More...

#define	_FS_MINIMIZE 0
	This option defines minimization level to remove some basic API functions. More...

#define	_USE_STRFUNC 2
	This option switches string functions, f_gets(), f_putc(), f_puts() and f_printf(). More...

#define	_USE_FIND 0
	This option switches filtered directory read functions, f_findfirst() and f_findnext(). More...

#define	_USE_MKFS 1
	This option switches f_mkfs() function. More...

#define	_USE_FASTSEEK 1
	This option switches fast seek feature. More...

#define	_USE_EXPAND 0
	This option switches f_expand function. More...

#define	_USE_CHMOD 0
	This option switches attribute manipulation functions, f_chmod() and f_utime(). More...

#define	_USE_LABEL 0
	This option switches volume label functions, f_getlabel() and f_setlabel(). More...

#define	_USE_FORWARD 0
	This option switches f_forward() function. More...

#define	_CODE_PAGE 850
	This option specifies the OEM code page to be used on the target system. More...

#define	_USE_LFN 1
	This option switches the support of long file name (LFN). More...

#define	_MAX_LFN 255

#define	_LFN_UNICODE 0
	This option switches character encoding on the API. More...

#define	_STRF_ENCODE 3
	When _LFN_UNICODE == 1, this option selects the character encoding on the file to be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf(). More...

#define	_FS_RPATH 0
	This option configures support of relative path. More...

#define	_VOLUMES 1

#define	_STR_VOLUME_ID 0
	This option switches string support of volume ID. More...

#define	_VOLUME_STRS "RAM", "NAND", "CF", "SD1", "SD2", "USB1", "USB2", "USB3"
	Defines the drive ID strings for each logical drives. More...

#define	_MULTI_PARTITION 0
	This option switches support of multi-partition on a physical drive. More...

#define	_MIN_SS 512
	These options configure the range of sector size to be supported. (512, 1024, 2048 or 4096) More...

#define	_MAX_SS 512
	These options configure the range of sector size to be supported. (512, 1024, 2048 or 4096) More...

#define	_USE_TRIM 0
	This option switches support of ATA-TRIM. More...

#define	_FS_NOFSINFO 0
	If you need to know correct free space on the FAT32 volume, set bit 0 of this option. (0, 1, 2 or 3) More...

#define	_FS_TINY 0
	This option switches tiny buffer configuration. More...

#define	_FS_EXFAT 0
	This option switches support of exFAT file system. More...

#define	_FS_NORTC 0
	This option switches timestamp function. More...

#define	_NORTC_MON 6

#define	_NORTC_MDAY 4

#define	_NORTC_YEAR 2018

#define	_FS_LOCK 0
	This option switches file lock function to control duplicated file open and illegal operation to open objects. More...

#define	_FS_REENTRANT 0
	This option switches the re-entrancy (thread safe) of the FatFs module itself. (0:Disable or 1:Enable) More...

#define	_FS_TIMEOUT 1000

#define	_SYNC_t osSemaphoreId

#define	ff_malloc malloc

#define	ff_free free

Detailed Description

Macro Definition Documentation

◆ _CODE_PAGE

#define _CODE_PAGE 850

This option specifies the OEM code page to be used on the target system.

Incorrect setting of the code page can cause a file open failure.

1 - ASCII (No extended character. Non-LFN cfg. only)
437 - U.S.
720 - Arabic
737 - Greek
771 - KBL
775 - Baltic
850 - Latin 1
852 - Latin 2
855 - Cyrillic
857 - Turkish
860 - Portuguese
861 - Icelandic
862 - Hebrew
863 - Canadian French
864 - Arabic
865 - Nordic
866 - Russian
869 - Greek 2
932 - Japanese (DBCS)
936 - Simplified Chinese (DBCS)
949 - Korean (DBCS)
950 - Traditional Chinese (DBCS)

Definition at line 167 of file ffconf.h.

◆ _FS_EXFAT

#define _FS_EXFAT 0

This option switches support of exFAT file system.

0: Disable
1: Enable

Note: When enabling exFAT, also LFN needs to be enabled. (_USE_LFN >= 1).; Enabling exFAT discards C89 compatibility.

Definition at line 340 of file ffconf.h.

◆ _FS_LOCK

#define _FS_LOCK 0

This option switches file lock function to control duplicated file open and illegal operation to open objects.

0: Disable file lock function. To avoid volume corruption, application program should avoid illegal open, remove and rename to the open objects.
>0: Enable file lock function. The value defines how many files/sub-directories can be opened simultaneously under file lock control. Note that the file lock control is independent of re-entrancy.

Note: This option must be 0 when _FS_READONLY is 1.

Definition at line 380 of file ffconf.h.

◆ _FS_MINIMIZE

#define _FS_MINIMIZE 0

This option defines minimization level to remove some basic API functions.

0: All basic functions are enabled.
1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_truncate() and f_rename() are removed.
2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1.
3: f_lseek() function is removed in addition to 2.

Definition at line 60 of file ffconf.h.

◆ _FS_NOFSINFO

#define _FS_NOFSINFO 0

If you need to know correct free space on the FAT32 volume, set bit 0 of this option. (0, 1, 2 or 3)

f_getfree() function at first time after volume mount will force a full FAT scan. Bit 1 controls the use of last allocated cluster number.

bit0 = 0: Use free cluster count in the FSINFO if available.
bit0 = 1: Do not trust free cluster count in the FSINFO.
bit1 = 0: Use last allocated cluster number in the FSINFO if available.
bit1 = 1: Do not trust last allocated cluster number in the FSINFO.

Definition at line 312 of file ffconf.h.

◆ _FS_NORTC

#define _FS_NORTC 0

This option switches timestamp function.

If the system does not have any RTC function or valid timestamp is not needed, set _FS_NORTC = 1 to disable the timestamp function. All objects modified by FatFs will have a fixed timestamp defined by _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR in local time. To enable timestamp function (_FS_NORTC = 0), get_fattime() function need to be added to the project to get current time from real-time clock. _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR have no effect.

These options have no effect at read-only configuration (_FS_READONLY = 1).

Definition at line 355 of file ffconf.h.

◆ _FS_READONLY

#define _FS_READONLY 1

This option switches read-only configuration.

0: Read/Write
1: Read-only

Read-only configuration removes writing API functions, f_write(), f_sync(), f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree() and optional writing functions as well.

Definition at line 48 of file ffconf.h.

◆ _FS_REENTRANT

#define _FS_REENTRANT 0

This option switches the re-entrancy (thread safe) of the FatFs module itself. (0:Disable or 1:Enable)

Note that regardless of this option, file access to different volume is always re-entrant and volume control functions, f_mount(), f_mkfs() and f_fdisk() function, are always not re-entrant. Only file/directory access to the same volume is under control of this function.

0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect.
1: Enable re-entrancy. Also user provided synchronization handlers, ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj() function, must be added to the project. Samples are available in option/syscall.c.

The _FS_TIMEOUT defines timeout period in unit of time tick. The _SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*, SemaphoreHandle_t and etc. A header file for O/S definitions needs to be included somewhere in the scope of ff.h.

Definition at line 402 of file ffconf.h.

◆ _FS_RPATH

#define _FS_RPATH 0

This option configures support of relative path.

0: Disable relative path and remove related functions.
1: Enable relative path. f_chdir() and f_chdrive() are available.
2: f_getcwd() function is available in addition to 1.

Definition at line 224 of file ffconf.h.

◆ _FS_TIMEOUT

#define _FS_TIMEOUT 1000

Define the timeout period in unit of time tick.

Definition at line 405 of file ffconf.h.

◆ _FS_TINY

#define _FS_TINY 0

This option switches tiny buffer configuration.

0: Normal
1: Tiny

At the tiny configuration, size of file object (FIL) is reduced _MAX_SS bytes. Instead of private sector buffer eliminated from the file object, common sector buffer in the file system object (FATFS) is used for the file data transfer.

Definition at line 329 of file ffconf.h.

◆ _LFN_UNICODE

#define _LFN_UNICODE 0

This option switches character encoding on the API.

0: ANSI/OEM
1: Unicode

To use Unicode string for the path name, enable LFN and set _LFN_UNICODE = 1. This option also affects behavior of string I/O functions.

Definition at line 201 of file ffconf.h.

◆ _MAX_LFN

#define _MAX_LFN 255

Maximum LFN length to handle (12 to 255)

Definition at line 189 of file ffconf.h.

◆ _MAX_SS

#define _MAX_SS 512

These options configure the range of sector size to be supported. (512, 1024, 2048 or 4096)

Always set both 512 for most systems, all type of memory cards and harddisk. But a larger value may be required for on-board flash memory and some type of optical media. When _MAX_SS is larger than _MIN_SS, FatFs is configured to variable sector size and GET_SECTOR_SIZE command must be implemented to the disk_ioctl() function.

Definition at line 287 of file ffconf.h.

◆ _MIN_SS

#define _MIN_SS 512

These options configure the range of sector size to be supported. (512, 1024, 2048 or 4096)

Always set both 512 for most systems, all type of memory cards and harddisk. But a larger value may be required for on-board flash memory and some type of optical media. When _MAX_SS is larger than _MIN_SS, FatFs is configured to variable sector size and GET_SECTOR_SIZE command must be implemented to the disk_ioctl() function.

Definition at line 275 of file ffconf.h.

◆ _MULTI_PARTITION

#define _MULTI_PARTITION 0

This option switches support of multi-partition on a physical drive.

0: Single partition
1: Multiple partition

By default (0), each logical drive number is bound to the same physical drive number and only an FAT volume found on the physical drive will be mounted. When multi-partition is enabled (1), each logical drive number can be bound to arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk() function will be available.

Definition at line 264 of file ffconf.h.

◆ _NORTC_MDAY

#define _NORTC_MDAY 4

Define for the day of the fixed timestamp.

Definition at line 361 of file ffconf.h.

◆ _NORTC_MON

#define _NORTC_MON 6

Define for the month of the fixed timestamp.

Definition at line 358 of file ffconf.h.

◆ _NORTC_YEAR

#define _NORTC_YEAR 2018

Define for the year of the fixed timestamp.

Definition at line 364 of file ffconf.h.

◆ _STR_VOLUME_ID

#define _STR_VOLUME_ID 0

This option switches string support of volume ID.

0: Use only 0-9 for drive ID
1: Use strings for drive ID

When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive number in the path name. See _VOLUME_STRS.

Definition at line 242 of file ffconf.h.

◆ _STRF_ENCODE

#define _STRF_ENCODE 3

When _LFN_UNICODE == 1, this option selects the character encoding on the file to be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf().

0: ANSI/OEM
1: UTF-16LE
2: UTF-16BE
3: UTF-8

Note: This option has no effect when _LFN_UNICODE == 0.

Definition at line 215 of file ffconf.h.

◆ _SYNC_t

#define _SYNC_t osSemaphoreId

Defines O/S dependent sync object type.

Definition at line 408 of file ffconf.h.

◆ _USE_CHMOD

#define _USE_CHMOD 0

This option switches attribute manipulation functions, f_chmod() and f_utime().

0: Disable
1: Enable

Note: _FS_READONLY needs to be 0 to enable this option.

Definition at line 115 of file ffconf.h.

◆ _USE_EXPAND

#define _USE_EXPAND 0

This option switches f_expand function.

0: Disable
1: Enable

Definition at line 104 of file ffconf.h.

◆ _USE_FASTSEEK

#define _USE_FASTSEEK 1

This option switches fast seek feature.

0: Disable
1: Enable

Definition at line 96 of file ffconf.h.

◆ _USE_FIND

#define _USE_FIND 0

This option switches filtered directory read functions, f_findfirst() and f_findnext().

0: Disable
1: Enable
2: Enable with matching altname[] too

Definition at line 80 of file ffconf.h.

◆ _USE_FORWARD

#define _USE_FORWARD 0

This option switches f_forward() function.

0: Disable
1: Enable

Definition at line 132 of file ffconf.h.

◆ _USE_LABEL

#define _USE_LABEL 0

This option switches volume label functions, f_getlabel() and f_setlabel().

0: Disable
1: Enable

Definition at line 124 of file ffconf.h.

◆ _USE_LFN

#define _USE_LFN 1

This option switches the support of long file name (LFN).

0: Disable support of LFN. _MAX_LFN has no effect.
1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
2: Enable LFN with dynamic working buffer on the STACK.
3: Enable LFN with dynamic working buffer on the HEAP.

To enable the LFN, Unicode handling functions (option/unicode.c) must be added to the project. The working buffer occupies (_MAX_LFN + 1) * 2 bytes and additional 608 bytes at exFAT enabled. _MAX_LFN can be in range from 12 to 255. It should be set 255 to support full featured LFN operations. When use stack for the working buffer, take care on stack overflow. When use heap memory for the working buffer, memory management functions, ff_memalloc() and ff_memfree(), must be added to the project.

Definition at line 186 of file ffconf.h.

◆ _USE_MKFS

#define _USE_MKFS 1

This option switches f_mkfs() function.

0: Disable
1: Enable

Definition at line 88 of file ffconf.h.

◆ _USE_STRFUNC

#define _USE_STRFUNC 2

This option switches string functions, f_gets(), f_putc(), f_puts() and f_printf().

0: Disable string functions.
1: Enable without LF-CRLF conversion.
2: Enable with LF-CRLF conversion.

Definition at line 70 of file ffconf.h.

◆ _USE_TRIM

#define _USE_TRIM 0

This option switches support of ATA-TRIM.

0: Disable
1: Enable

To enable Trim function, also CTRL_TRIM command should be implemented to the disk_ioctl() function.

Definition at line 298 of file ffconf.h.

◆ _VOLUME_STRS

#define _VOLUME_STRS "RAM", "NAND", "CF", "SD1", "SD2", "USB1", "USB2", "USB3"

Defines the drive ID strings for each logical drives.

Number of items must be equal to _VOLUMES. Valid characters for the drive ID strings are: A-Z and 0-9.

Definition at line 250 of file ffconf.h.

◆ _VOLUMES

#define _VOLUMES 1

Number of volumes (logical drives) to be used.

Definition at line 231 of file ffconf.h.

◆ ff_free

#define ff_free free

Definition for the ff_free macro.

Definition at line 416 of file ffconf.h.

◆ ff_malloc

#define ff_malloc malloc

Definition for the ff_malloc macro.

Definition at line 414 of file ffconf.h.

Macros