Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

ffconf.h

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

Generated on Tue Apr 7 20:07:43 2015 for BF592A Library by doxygen 1.3.1