Import fatfs R0.12b

[z180-stamp.git] / fatfs / src / ffconf.h

/*---------------------------------------------------------------------------/\r
/  FatFs - FAT file system module configuration file\r
/---------------------------------------------------------------------------*/\r
\r
#define _FFCONF 68020	/* Revision ID */\r
\r
/*---------------------------------------------------------------------------/\r
/ Function Configurations\r
/---------------------------------------------------------------------------*/\r
\r
#define _FS_READONLY	0\r
/* This option switches read-only configuration. (0:Read/Write or 1:Read-only)\r
/  Read-only configuration removes writing API functions, f_write(), f_sync(),\r
/  f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree()\r
/  and optional writing functions as well. */\r
\r
\r
#define _FS_MINIMIZE	0\r
/* This option defines minimization level to remove some basic API functions.\r
/\r
/   0: All basic functions are enabled.\r
/   1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_truncate() and f_rename()\r
/      are removed.\r
/   2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1.\r
/   3: f_lseek() function is removed in addition to 2. */\r
\r
\r
#define	_USE_STRFUNC	0\r
/* This option switches string functions, f_gets(), f_putc(), f_puts() and\r
/  f_printf().\r
/\r
/  0: Disable string functions.\r
/  1: Enable without LF-CRLF conversion.\r
/  2: Enable with LF-CRLF conversion. */\r
\r
\r
#define _USE_FIND		0\r
/* This option switches filtered directory read functions, f_findfirst() and\r
/  f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */\r
\r
\r
#define	_USE_MKFS		0\r
/* This option switches f_mkfs() function. (0:Disable or 1:Enable) */\r
\r
\r
#define	_USE_FASTSEEK	0\r
/* This option switches fast seek function. (0:Disable or 1:Enable) */\r
\r
\r
#define	_USE_EXPAND		0\r
/* This option switches f_expand function. (0:Disable or 1:Enable) */\r
\r
\r
#define _USE_CHMOD		0\r
/* This option switches attribute manipulation functions, f_chmod() and f_utime().\r
/  (0:Disable or 1:Enable) Also _FS_READONLY needs to be 0 to enable this option. */\r
\r
\r
#define _USE_LABEL		0\r
/* This option switches volume label functions, f_getlabel() and f_setlabel().\r
/  (0:Disable or 1:Enable) */\r
\r
\r
#define	_USE_FORWARD	0\r
/* This option switches f_forward() function. (0:Disable or 1:Enable) */\r
\r
\r
/*---------------------------------------------------------------------------/\r
/ Locale and Namespace Configurations\r
/---------------------------------------------------------------------------*/\r
\r
#define _CODE_PAGE	932\r
/* This option specifies the OEM code page to be used on the target system.\r
/  Incorrect setting of the code page can cause a file open failure.\r
/\r
/   1   - ASCII (No extended character. Non-LFN cfg. only)\r
/   437 - U.S.\r
/   720 - Arabic\r
/   737 - Greek\r
/   771 - KBL\r
/   775 - Baltic\r
/   850 - Latin 1\r
/   852 - Latin 2\r
/   855 - Cyrillic\r
/   857 - Turkish\r
/   860 - Portuguese\r
/   861 - Icelandic\r
/   862 - Hebrew\r
/   863 - Canadian French\r
/   864 - Arabic\r
/   865 - Nordic\r
/   866 - Russian\r
/   869 - Greek 2\r
/   932 - Japanese (DBCS)\r
/   936 - Simplified Chinese (DBCS)\r
/   949 - Korean (DBCS)\r
/   950 - Traditional Chinese (DBCS)\r
*/\r
\r
\r
#define	_USE_LFN	0\r
#define	_MAX_LFN	255\r
/* The _USE_LFN switches the support of long file name (LFN).\r
/\r
/   0: Disable support of LFN. _MAX_LFN has no effect.\r
/   1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.\r
/   2: Enable LFN with dynamic working buffer on the STACK.\r
/   3: Enable LFN with dynamic working buffer on the HEAP.\r
/\r
/  To enable the LFN, Unicode handling functions (option/unicode.c) must be added\r
/  to the project. The working buffer occupies (_MAX_LFN + 1) * 2 bytes and\r
/  additional 608 bytes at exFAT enabled. _MAX_LFN can be in range from 12 to 255.\r
/  It should be set 255 to support full featured LFN operations.\r
/  When use stack for the working buffer, take care on stack overflow. When use heap\r
/  memory for the working buffer, memory management functions, ff_memalloc() and\r
/  ff_memfree(), must be added to the project. */\r
\r
\r
#define	_LFN_UNICODE	0\r
/* This option switches character encoding on the API. (0:ANSI/OEM or 1:UTF-16)\r
/  To use Unicode string for the path name, enable LFN and set _LFN_UNICODE = 1.\r
/  This option also affects behavior of string I/O functions. */\r
\r
\r
#define _STRF_ENCODE	3\r
/* When _LFN_UNICODE == 1, this option selects the character encoding ON THE FILE to\r
/  be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf().\r
/\r
/  0: ANSI/OEM\r
/  1: UTF-16LE\r
/  2: UTF-16BE\r
/  3: UTF-8\r
/\r
/  This option has no effect when _LFN_UNICODE == 0. */\r
\r
\r
#define _FS_RPATH	0\r
/* This option configures support of relative path.\r
/\r
/   0: Disable relative path and remove related functions.\r
/   1: Enable relative path. f_chdir() and f_chdrive() are available.\r
/   2: f_getcwd() function is available in addition to 1.\r
*/\r
\r
\r
/*---------------------------------------------------------------------------/\r
/ Drive/Volume Configurations\r
/---------------------------------------------------------------------------*/\r
\r
#define _VOLUMES	1\r
/* Number of volumes (logical drives) to be used. */\r
\r
\r
#define _STR_VOLUME_ID	0\r
#define _VOLUME_STRS	"RAM","NAND","CF","SD","SD2","USB","USB2","USB3"\r
/* _STR_VOLUME_ID switches string support of volume ID.\r
/  When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive\r
/  number in the path name. _VOLUME_STRS defines the drive ID strings for each\r
/  logical drives. Number of items must be equal to _VOLUMES. Valid characters for\r
/  the drive ID strings are: A-Z and 0-9. */\r
\r
\r
#define	_MULTI_PARTITION	0\r
/* This option switches support of multi-partition on a physical drive.\r
/  By default (0), each logical drive number is bound to the same physical drive\r
/  number and only an FAT volume found on the physical drive will be mounted.\r
/  When multi-partition is enabled (1), each logical drive number can be bound to\r
/  arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk()\r
/  funciton will be available. */\r
\r
\r
#define	_MIN_SS		512\r
#define	_MAX_SS		512\r
/* These options configure the range of sector size to be supported. (512, 1024,\r
/  2048 or 4096) Always set both 512 for most systems, all type of memory cards and\r
/  harddisk. But a larger value may be required for on-board flash memory and some\r
/  type of optical media. When _MAX_SS is larger than _MIN_SS, FatFs is configured\r
/  to variable sector size and GET_SECTOR_SIZE command must be implemented to the\r
/  disk_ioctl() function. */\r
\r
\r
#define	_USE_TRIM	0\r
/* This option switches support of ATA-TRIM. (0:Disable or 1:Enable)\r
/  To enable Trim function, also CTRL_TRIM command should be implemented to the\r
/  disk_ioctl() function. */\r
\r
\r
#define _FS_NOFSINFO	0\r
/* If you need to know correct free space on the FAT32 volume, set bit 0 of this\r
/  option, and f_getfree() function at first time after volume mount will force\r
/  a full FAT scan. Bit 1 controls the use of last allocated cluster number.\r
/\r
/  bit0=0: Use free cluster count in the FSINFO if available.\r
/  bit0=1: Do not trust free cluster count in the FSINFO.\r
/  bit1=0: Use last allocated cluster number in the FSINFO if available.\r
/  bit1=1: Do not trust last allocated cluster number in the FSINFO.\r
*/\r
\r
\r
\r
/*---------------------------------------------------------------------------/\r
/ System Configurations\r
/---------------------------------------------------------------------------*/\r
\r
#define	_FS_TINY	0\r
/* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)\r
/  At the tiny configuration, size of file object (FIL) is reduced _MAX_SS bytes.\r
/  Instead of private sector buffer eliminated from the file object, common sector\r
/  buffer in the file system object (FATFS) is used for the file data transfer. */\r
\r
\r
#define _FS_EXFAT	0\r
/* This option switches support of exFAT file system. (0:Disable or 1:Enable)\r
/  When enable exFAT, also LFN needs to be enabled. (_USE_LFN >= 1)\r
/  Note that enabling exFAT discards C89 compatibility. */\r
\r
\r
#define _FS_NORTC	0\r
#define _NORTC_MON	1\r
#define _NORTC_MDAY	1\r
#define _NORTC_YEAR	2016\r
/* The option _FS_NORTC switches timestamp functiton. If the system does not have\r
/  any RTC function or valid timestamp is not needed, set _FS_NORTC = 1 to disable\r
/  the timestamp function. All objects modified by FatFs will have a fixed timestamp\r
/  defined by _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR in local time.\r
/  To enable timestamp function (_FS_NORTC = 0), get_fattime() function need to be\r
/  added to the project to get current time form real-time clock. _NORTC_MON,\r
/  _NORTC_MDAY and _NORTC_YEAR have no effect. \r
/  These options have no effect at read-only configuration (_FS_READONLY = 1). */\r
\r
\r
#define	_FS_LOCK	0\r
/* The option _FS_LOCK switches file lock function to control duplicated file open\r
/  and illegal operation to open objects. This option must be 0 when _FS_READONLY\r
/  is 1.\r
/\r
/  0:  Disable file lock function. To avoid volume corruption, application program\r
/      should avoid illegal open, remove and rename to the open objects.\r
/  >0: Enable file lock function. The value defines how many files/sub-directories\r
/      can be opened simultaneously under file lock control. Note that the file\r
/      lock control is independent of re-entrancy. */\r
\r
\r
#define _FS_REENTRANT	0\r
#define _FS_TIMEOUT		1000\r
#define	_SYNC_t			HANDLE\r
/* The option _FS_REENTRANT switches the re-entrancy (thread safe) of the FatFs\r
/  module itself. Note that regardless of this option, file access to different\r
/  volume is always re-entrant and volume control functions, f_mount(), f_mkfs()\r
/  and f_fdisk() function, are always not re-entrant. Only file/directory access\r
/  to the same volume is under control of this function.\r
/\r
/   0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect.\r
/   1: Enable re-entrancy. Also user provided synchronization handlers,\r
/      ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj()\r
/      function, must be added to the project. Samples are available in\r
/      option/syscall.c.\r
/\r
/  The _FS_TIMEOUT defines timeout period in unit of time tick.\r
/  The _SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*,\r
/  SemaphoreHandle_t and etc.. A header file for O/S definitions needs to be\r
/  included somewhere in the scope of ff.h. */\r
\r
/* #include <windows.h>	// O/S definitions  */\r
\r
\r
/*--- End of configuration options ---*/\r