ffconf.h

00001 /*---------------------------------------------------------------------------/
00002 /  FatFs - FAT file system module configuration file  R0.11 (C)ChaN, 2015
00003 /---------------------------------------------------------------------------*/
00004 
00005 #define _FFCONF 32020   /* Revision ID */
00006 
00007 #define FFS_DBG         0
00008 
00009 /*---------------------------------------------------------------------------/
00010 / Functions and Buffer Configurations
00011 /---------------------------------------------------------------------------*/
00012 
00013 #define _FS_TINY        0
00014 /* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)
00015 /  At the tiny configuration, size of the file object (FIL) is reduced _MAX_SS
00016 /  bytes. Instead of private sector buffer eliminated from the file object,
00017 /  common sector buffer in the file system object (FATFS) is used for the file
00018 /  data transfer. */
00019 
00020 
00021 #define _FS_READONLY    0
00022 /* This option switches read-only configuration. (0:Read/Write or 1:Read-only)
00023 /  Read-only configuration removes writing API functions, f_write(), f_sync(),
00024 /  f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree()
00025 /  and optional writing functions as well. */
00026 
00027 
00028 #define _FS_MINIMIZE    0
00029 /* This option defines minimization level to remove some basic API functions.
00030 /
00031 /   0: All basic functions are enabled.
00032 /   1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_chmod(), f_utime(),
00033 /      f_truncate() and f_rename() function are removed.
00034 /   2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1.
00035 /   3: f_lseek() function is removed in addition to 2. */
00036 
00037 
00038 #define _USE_STRFUNC    0
00039 /* This option switches string functions, f_gets(), f_putc(), f_puts() and
00040 /  f_printf().
00041 /
00042 /  0: Disable string functions.
00043 /  1: Enable without LF-CRLF conversion.
00044 /  2: Enable with LF-CRLF conversion. */
00045 
00046 
00047 #define _USE_FIND       0
00048 /* This option switches filtered directory read feature and related functions,
00049 /  f_findfirst() and f_findnext(). (0:Disable or 1:Enable) */
00050 
00051 
00052 #define _USE_MKFS       1
00053 /* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
00054 
00055 
00056 #define _USE_FASTSEEK   0
00057 /* This option switches fast seek feature. (0:Disable or 1:Enable) */
00058 
00059 
00060 #define _USE_LABEL      0
00061 /* This option switches volume label functions, f_getlabel() and f_setlabel().
00062 /  (0:Disable or 1:Enable) */
00063 
00064 
00065 #define _USE_FORWARD    0
00066 /* This option switches f_forward() function. (0:Disable or 1:Enable)
00067 /  To enable it, also _FS_TINY need to be set to 1. */
00068 
00069 
00070 /*---------------------------------------------------------------------------/
00071 / Locale and Namespace Configurations
00072 /---------------------------------------------------------------------------*/
00073 
00074 #define _CODE_PAGE  858
00075 /* This option specifies the OEM code page to be used on the target system.
00076 /  Incorrect setting of the code page can cause a file open failure.
00077 /
00078 /   1    - ASCII (No extended character. Non-LFN cfg. only)
00079 /   437  - U.S.
00080 /   720  - Arabic
00081 /   737  - Greek
00082 /   775  - Baltic
00083 /   850  - Multilingual Latin 1
00084 /   852  - Latin 2
00085 /   855  - Cyrillic
00086 /   857  - Turkish
00087 /   858  - Multilingual Latin 1 + Euro
00088 /   862  - Hebrew
00089 /   866  - Russian
00090 /   874  - Thai
00091 /   932  - Japanese Shift_JIS (DBCS)
00092 /   936  - Simplified Chinese GBK (DBCS)
00093 /   949  - Korean (DBCS)
00094 /   950  - Traditional Chinese Big5 (DBCS)
00095 */
00096 
00097 
00098 #define _USE_LFN    1
00099 #define _MAX_LFN    255
00100 /* The _USE_LFN option switches the LFN feature.
00101 /
00102 /   0: Disable LFN feature. _MAX_LFN has no effect.
00103 /   1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
00104 /   2: Enable LFN with dynamic working buffer on the STACK.
00105 /   3: Enable LFN with dynamic working buffer on the HEAP.
00106 /
00107 /  When enable the LFN feature, Unicode handling functions (option/unicode.c) must
00108 /  be added to the project. The LFN working buffer occupies (_MAX_LFN + 1) * 2 bytes.
00109 /  When use stack for the working buffer, take care on stack overflow. When use heap
00110 /  memory for the working buffer, memory management functions, ff_memalloc() and
00111 /  ff_memfree(), must be added to the project. */
00112 
00113 
00114 #define _LFN_UNICODE    0
00115 /* This option switches character encoding on the API. (0:ANSI/OEM or 1:Unicode)
00116 /  To use Unicode string for the path name, enable LFN feature and set _LFN_UNICODE
00117 /  to 1. This option also affects behavior of string I/O functions. */
00118 
00119 
00120 #define _STRF_ENCODE    3
00121 /* When _LFN_UNICODE is 1, this option selects the character encoding on the file to
00122 /  be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf().
00123 /
00124 /  0: ANSI/OEM
00125 /  1: UTF-16LE
00126 /  2: UTF-16BE
00127 /  3: UTF-8
00128 /
00129 /  When _LFN_UNICODE is 0, this option has no effect. */
00130 
00131 
00132 #define _FS_RPATH   0
00133 /* This option configures relative path feature.
00134 /
00135 /   0: Disable relative path feature and remove related functions.
00136 /   1: Enable relative path feature. f_chdir() and f_chdrive() are available.
00137 /   2: f_getcwd() function is available in addition to 1.
00138 /
00139 /  Note that directory items read via f_readdir() are affected by this option. */
00140 
00141 
00142 /*---------------------------------------------------------------------------/
00143 / Drive/Volume Configurations
00144 /---------------------------------------------------------------------------*/
00145 
00146 #define _VOLUMES    1
00147 /* Number of volumes (logical drives) to be used. */
00148 
00149 
00150 #define _STR_VOLUME_ID  0
00151 #define _VOLUME_STRS    "RAM","NAND","CF","SD1","SD2","USB1","USB2","USB3"
00152 /* _STR_VOLUME_ID option switches string volume ID feature.
00153 /  When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive
00154 /  number in the path name. _VOLUME_STRS defines the drive ID strings for each
00155 /  logical drives. Number of items must be equal to _VOLUMES. Valid characters for
00156 /  the drive ID strings are: A-Z and 0-9. */
00157 
00158 
00159 #define _MULTI_PARTITION    0
00160 /* This option switches multi-partition feature. By default (0), each logical drive
00161 /  number is bound to the same physical drive number and only an FAT volume found on
00162 /  the physical drive will be mounted. When multi-partition feature is enabled (1),
00163 /  each logical drive number is bound to arbitrary physical drive and partition
00164 /  listed in the VolToPart[]. Also f_fdisk() funciton will be available. */
00165 
00166 
00167 #define _MIN_SS     512
00168 #define _MAX_SS     512
00169 /* These options configure the range of sector size to be supported. (512, 1024,
00170 /  2048 or 4096) Always set both 512 for most systems, all type of memory cards and
00171 /  harddisk. But a larger value may be required for on-board flash memory and some
00172 /  type of optical media. When _MAX_SS is larger than _MIN_SS, FatFs is configured
00173 /  to variable sector size and GET_SECTOR_SIZE command must be implemented to the
00174 /  disk_ioctl() function. */
00175 
00176 
00177 #define _USE_TRIM   0
00178 /* This option switches ATA-TRIM feature. (0:Disable or 1:Enable)
00179 /  To enable Trim feature, also CTRL_TRIM command should be implemented to the
00180 /  disk_ioctl() function. */
00181 
00182 
00183 #define _FS_NOFSINFO    0
00184 /* If you need to know correct free space on the FAT32 volume, set bit 0 of this
00185 /  option, and f_getfree() function at first time after volume mount will force
00186 /  a full FAT scan. Bit 1 controls the use of last allocated cluster number.
00187 /
00188 /  bit0=0: Use free cluster count in the FSINFO if available.
00189 /  bit0=1: Do not trust free cluster count in the FSINFO.
00190 /  bit1=0: Use last allocated cluster number in the FSINFO if available.
00191 /  bit1=1: Do not trust last allocated cluster number in the FSINFO.
00192 */
00193 
00194 
00195 
00196 /*---------------------------------------------------------------------------/
00197 / System Configurations
00198 /---------------------------------------------------------------------------*/
00199 
00200 #define _FS_NORTC   0
00201 #define _NORTC_MON  2
00202 #define _NORTC_MDAY 1
00203 #define _NORTC_YEAR 2015
00204 /* The _FS_NORTC option switches timestamp feature. If the system does not have
00205 /  an RTC function or valid timestamp is not needed, set _FS_NORTC to 1 to disable
00206 /  the timestamp feature. All objects modified by FatFs will have a fixed timestamp
00207 /  defined by _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR.
00208 /  When timestamp feature is enabled (_FS_NORTC == 0), get_fattime() function need
00209 /  to be added to the project to read current time form RTC. _NORTC_MON,
00210 /  _NORTC_MDAY and _NORTC_YEAR have no effect. 
00211 /  These options have no effect at read-only configuration (_FS_READONLY == 1). */
00212 
00213 
00214 #define _FS_LOCK    0
00215 /* The _FS_LOCK option switches file lock feature to control duplicated file open
00216 /  and illegal operation to open objects. This option must be 0 when _FS_READONLY
00217 /  is 1.
00218 /
00219 /  0:  Disable file lock feature. To avoid volume corruption, application program
00220 /      should avoid illegal open, remove and rename to the open objects.
00221 /  >0: Enable file lock feature. The value defines how many files/sub-directories
00222 /      can be opened simultaneously under file lock control. Note that the file
00223 /      lock feature is independent of re-entrancy. */
00224 
00225 
00226 #define _FS_REENTRANT   0
00227 #define _FS_TIMEOUT     1000
00228 #define _SYNC_t         HANDLE
00229 /* The _FS_REENTRANT option switches the re-entrancy (thread safe) of the FatFs
00230 /  module itself. Note that regardless of this option, file access to different
00231 /  volume is always re-entrant and volume control functions, f_mount(), f_mkfs()
00232 /  and f_fdisk() function, are always not re-entrant. Only file/directory access
00233 /  to the same volume is under control of this feature.
00234 /
00235 /   0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect.
00236 /   1: Enable re-entrancy. Also user provided synchronization handlers,
00237 /      ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj()
00238 /      function, must be added to the project. Samples are available in
00239 /      option/syscall.c.
00240 /
00241 /  The _FS_TIMEOUT defines timeout period in unit of time tick.
00242 /  The _SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*,
00243 /  SemaphoreHandle_t and etc.. A header file for O/S definitions needs to be
00244 /  included somewhere in the scope of ff.c. */
00245 
00246 
00247 #define _WORD_ACCESS    0
00248 /* The _WORD_ACCESS option is an only platform dependent option. It defines
00249 /  which access method is used to the word data on the FAT volume.
00250 /
00251 /   0: Byte-by-byte access. Always compatible with all platforms.
00252 /   1: Word access. Do not choose this unless under both the following conditions.
00253 /
00254 /  * Address misaligned memory access is always allowed to ALL instructions.
00255 /  * Byte order on the memory is little-endian.
00256 /
00257 /  If it is the case, _WORD_ACCESS can also be set to 1 to reduce code size.
00258 /  Following table shows allowable settings of some processor types.
00259 /
00260 /  ARM7TDMI   0   *2          ColdFire   0    *1         V850E      0    *2
00261 /  Cortex-M3  0   *3          Z80        0/1             V850ES     0/1
00262 /  Cortex-M0  0   *2          x86        0/1             TLCS-870   0/1
00263 /  AVR        0/1             RX600(LE)  0/1             TLCS-900   0/1
00264 /  AVR32      0   *1          RL78       0    *2         R32C       0    *2
00265 /  PIC18      0/1             SH-2       0    *1         M16C       0/1
00266 /  PIC24      0   *2          H8S        0    *1         MSP430     0    *2
00267 /  PIC32      0   *1          H8/300H    0    *1         8051       0/1
00268 /
00269 /  *1:Big-endian.
00270 /  *2:Unaligned memory access is not supported.
00271 /  *3:Some compilers generate LDM/STM for mem_cpy function.
00272 */
00273 
00274 #define FLUSH_ON_NEW_CLUSTER    0   /* Sync the file on every new cluster */
00275 #define FLUSH_ON_NEW_SECTOR     1   /* Sync the file on every new sector */
00276 /* Only one of these two defines needs to be set to 1. If both are set to 0
00277    the file is only sync when closed.
00278    Clusters are group of sectors (eg: 8 sectors). Flushing on new cluster means
00279    it would be less often than flushing on new sector. Sectors are generally
00280    512 Bytes long. */