Import fatfs R0.10b

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

/*---------------------------------------------------------------------------/\r
/  FatFs - FAT file system module configuration file  R0.10b (C)ChaN, 2014\r
/---------------------------------------------------------------------------*/\r
\r
#ifndef _FFCONF\r
#define _FFCONF 8051	/* Revision ID */\r
\r
\r
/*---------------------------------------------------------------------------/\r
/ Functions and Buffer Configurations\r
/---------------------------------------------------------------------------*/\r
\r
#define	_FS_TINY		0	/* 0:Normal or 1:Tiny */\r
/* When _FS_TINY is set to 1, it reduces memory consumption _MAX_SS bytes each\r
/  file object. For file data transfer, FatFs uses the common sector buffer in\r
/  the file system object (FATFS) instead of private sector buffer eliminated\r
/  from the file object (FIL). */\r
\r
\r
#define _FS_READONLY	0	/* 0:Read/Write or 1:Read only */\r
/* Setting _FS_READONLY to 1 defines read only configuration. This removes\r
/  writing functions, f_write(), f_sync(), f_unlink(), f_mkdir(), f_chmod(),\r
/  f_rename(), f_truncate() and useless f_getfree(). */\r
\r
\r
#define _FS_MINIMIZE	0	/* 0 to 3 */\r
/* The _FS_MINIMIZE option defines minimization level to remove API functions.\r
/\r
/   0: All basic functions are enabled.\r
/   1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_chmod(), f_utime(),\r
/      f_truncate() and f_rename() function 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	/* 0:Disable or 1-2:Enable */\r
/* To enable string functions, set _USE_STRFUNC to 1 or 2. */\r
\r
\r
#define	_USE_MKFS		0	/* 0:Disable or 1:Enable */\r
/* To enable f_mkfs() function, set _USE_MKFS to 1 and set _FS_READONLY to 0 */\r
\r
\r
#define	_USE_FASTSEEK	0	/* 0:Disable or 1:Enable */\r
/* To enable fast seek feature, set _USE_FASTSEEK to 1. */\r
\r
\r
#define _USE_LABEL		0	/* 0:Disable or 1:Enable */\r
/* To enable volume label functions, set _USE_LAVEL to 1 */\r
\r
\r
#define	_USE_FORWARD	0	/* 0:Disable or 1:Enable */\r
/* To enable f_forward() function, set _USE_FORWARD to 1 and set _FS_TINY to 1. */\r
\r
\r
/*---------------------------------------------------------------------------/\r
/ Locale and Namespace Configurations\r
/---------------------------------------------------------------------------*/\r
\r
#define _CODE_PAGE	932\r
/* The _CODE_PAGE 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
/   932  - Japanese Shift_JIS (DBCS, OEM, Windows)\r
/   936  - Simplified Chinese GBK (DBCS, OEM, Windows)\r
/   949  - Korean (DBCS, OEM, Windows)\r
/   950  - Traditional Chinese Big5 (DBCS, OEM, Windows)\r
/   1250 - Central Europe (Windows)\r
/   1251 - Cyrillic (Windows)\r
/   1252 - Latin 1 (Windows)\r
/   1253 - Greek (Windows)\r
/   1254 - Turkish (Windows)\r
/   1255 - Hebrew (Windows)\r
/   1256 - Arabic (Windows)\r
/   1257 - Baltic (Windows)\r
/   1258 - Vietnam (OEM, Windows)\r
/   437  - U.S. (OEM)\r
/   720  - Arabic (OEM)\r
/   737  - Greek (OEM)\r
/   775  - Baltic (OEM)\r
/   850  - Multilingual Latin 1 (OEM)\r
/   858  - Multilingual Latin 1 + Euro (OEM)\r
/   852  - Latin 2 (OEM)\r
/   855  - Cyrillic (OEM)\r
/   866  - Russian (OEM)\r
/   857  - Turkish (OEM)\r
/   862  - Hebrew (OEM)\r
/   874  - Thai (OEM, Windows)\r
/   1    - ASCII (Valid for only non-LFN configuration) */\r
\r
\r
#define	_USE_LFN	0		/* 0 to 3 */\r
#define	_MAX_LFN	255		/* Maximum LFN length to handle (12 to 255) */\r
/* The _USE_LFN option switches the LFN feature.\r
/\r
/   0: Disable LFN feature. _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
/  When enable LFN feature, Unicode handling functions ff_convert() and ff_wtoupper()\r
/  function must be added to the project.\r
/  The LFN working buffer occupies (_MAX_LFN + 1) * 2 bytes. When use stack for the\r
/  working buffer, take care on stack overflow. When use heap memory for the working\r
/  buffer, memory management functions, ff_memalloc() and ff_memfree(), must be added\r
/  to the project. */\r
\r
\r
#define	_LFN_UNICODE	0	/* 0:ANSI/OEM or 1:Unicode */\r
/* To switch the character encoding on the FatFs API (TCHAR) to Unicode, enable LFN\r
/  feature and set _LFN_UNICODE to 1. This option affects behavior of string I/O\r
/  functions. This option must be 0 when LFN feature is not enabled. */\r
\r
\r
#define _STRF_ENCODE	3	/* 0:ANSI/OEM, 1:UTF-16LE, 2:UTF-16BE, 3:UTF-8 */\r
/* When Unicode API is enabled by _LFN_UNICODE option, this option selects the character\r
/  encoding on the file to be read/written via string I/O functions, f_gets(), f_putc(),\r
/  f_puts and f_printf(). This option has no effect when _LFN_UNICODE == 0. Note that\r
/  FatFs supports only BMP. */\r
\r
\r
#define _FS_RPATH		0	/* 0 to 2 */\r
/* The _FS_RPATH option configures relative path feature.\r
/\r
/   0: Disable relative path feature and remove related functions.\r
/   1: Enable relative path. f_chdrive() and f_chdir() function are available.\r
/   2: f_getcwd() function is available in addition to 1.\r
/\r
/  Note that output of the f_readdir() fnction is affected by this option. */\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	/* 0:Use only 0-9 for drive ID, 1:Use strings for drive ID */\r
#define _VOLUME_STRS	"RAM","NAND","CF","SD1","SD2","USB1","USB2","USB3"\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 logical\r
/  drives. Number of items must be equal to _VOLUMES. Valid characters for the drive ID\r
/  strings are: 0-9 and A-Z. */\r
\r
\r
#define	_MULTI_PARTITION	0	/* 0:Single partition, 1:Enable multiple partition */\r
/* By default(0), each logical drive number is bound to the same physical drive number\r
/  and only a FAT volume found on the physical drive is mounted. When it is set to 1,\r
/  each logical drive number is bound to arbitrary drive/partition listed in VolToPart[].\r
*/\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, 2048 or\r
/  4096) Always set both 512 for most systems, all memory card and harddisk. But a larger\r
/  value may be required for on-board flash memory and some type of optical media.\r
/  When _MAX_SS is larger than _MIN_SS, FatFs is configured to variable sector size and\r
/  GET_SECTOR_SIZE command must be implemented to the disk_ioctl() function. */\r
\r
\r
#define	_USE_ERASE	0	/* 0:Disable or 1:Enable */\r
/* To enable sector erase feature, set _USE_ERASE to 1. Also CTRL_ERASE_SECTOR command\r
/  should be added to the disk_ioctl() function. */\r
\r
\r
#define _FS_NOFSINFO	0	/* 0 to 3 */\r
/* If you need to know correct free space on the FAT32 volume, set bit 0 of this option\r
/  and f_getfree() function at first time after volume mount will force a full FAT scan.\r
/  Bit 1 controls the last allocated cluster number as bit 0.\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_LOCK	0	/* 0:Disable or >=1:Enable */\r
/* To enable file lock control feature, set _FS_LOCK to non-zero value.\r
/  The value defines how many files/sub-directories can be opened simultaneously\r
/  with file lock control. This feature uses bss _FS_LOCK * 12 bytes. */\r
\r
\r
#define _FS_REENTRANT	0		/* 0:Disable or 1:Enable */\r
#define _FS_TIMEOUT		1000	/* Timeout period in unit of time tick */\r
#define	_SYNC_t			HANDLE	/* O/S dependent sync object type. e.g. HANDLE, OS_EVENT*, ID, SemaphoreHandle_t and etc.. */\r
/* The _FS_REENTRANT option switches the re-entrancy (thread safe) of the FatFs module.\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.\r
*/\r
\r
\r
#define _WORD_ACCESS	0	/* 0 or 1 */\r
/* The _WORD_ACCESS option is an only platform dependent option. It defines\r
/  which access method is used to the word data on the FAT volume.\r
/\r
/   0: Byte-by-byte access. Always compatible with all platforms.\r
/   1: Word access. Do not choose this unless under both the following conditions.\r
/\r
/  * Address misaligned memory access is always allowed for ALL instructions.\r
/  * Byte order on the memory is little-endian.\r
/\r
/  If it is the case, _WORD_ACCESS can also be set to 1 to improve performance and\r
/  reduce code size. Following table shows an example of some processor types.\r
/\r
/   ARM7TDMI    0           ColdFire    0           V850E       0\r
/   Cortex-M3   0           Z80         0/1         V850ES      0/1\r
/   Cortex-M0   0           RX600(LE)   0/1         TLCS-870    0/1\r
/   AVR         0/1         RX600(BE)   0           TLCS-900    0/1\r
/   AVR32       0           RL78        0           R32C        0\r
/   PIC18       0/1         SH-2        0           M16C        0/1\r
/   PIC24       0           H8S         0           MSP430      0\r
/   PIC32       0           H8/300H     0           x86         0/1\r
*/\r
\r
\r
#endif /* _FFCONF */\r