fatfs/src/ffconf.h

   1 /*---------------------------------------------------------------------------/
   2 /  FatFs - FAT file system module configuration file  R0.10b (C)ChaN, 2014
   3 /---------------------------------------------------------------------------*/
   4
   5 #ifndef _FFCONF
   6 #define _FFCONF 8051    /* Revision ID */
   7
   8
   9 /*---------------------------------------------------------------------------/
  10 / Functions and Buffer Configurations
  11 /---------------------------------------------------------------------------*/
  12
  13 #define _FS_TINY                0       /* 0:Normal or 1:Tiny */
  14 /* When _FS_TINY is set to 1, it reduces memory consumption _MAX_SS bytes each
  15 /  file object. For file data transfer, FatFs uses the common sector buffer in
  16 /  the file system object (FATFS) instead of private sector buffer eliminated
  17 /  from the file object (FIL). */
  18
  19
  20 #define _FS_READONLY    0       /* 0:Read/Write or 1:Read only */
  21 /* Setting _FS_READONLY to 1 defines read only configuration. This removes
  22 /  writing functions, f_write(), f_sync(), f_unlink(), f_mkdir(), f_chmod(),
  23 /  f_rename(), f_truncate() and useless f_getfree(). */
  24
  25
  26 #define _FS_MINIMIZE    0       /* 0 to 3 */
  27 /* The _FS_MINIMIZE option defines minimization level to remove API functions.
  28 /
  29 /   0: All basic functions are enabled.
  30 /   1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_chmod(), f_utime(),
  31 /      f_truncate() and f_rename() function are removed.
  32 /   2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1.
  33 /   3: f_lseek() function is removed in addition to 2. */
  34
  35
  36 #define _USE_STRFUNC    0       /* 0:Disable or 1-2:Enable */
  37 /* To enable string functions, set _USE_STRFUNC to 1 or 2. */
  38
  39
  40 #define _USE_MKFS               0       /* 0:Disable or 1:Enable */
  41 /* To enable f_mkfs() function, set _USE_MKFS to 1 and set _FS_READONLY to 0 */
  42
  43
  44 #define _USE_FASTSEEK   0       /* 0:Disable or 1:Enable */
  45 /* To enable fast seek feature, set _USE_FASTSEEK to 1. */
  46
  47
  48 #define _USE_LABEL              0       /* 0:Disable or 1:Enable */
  49 /* To enable volume label functions, set _USE_LAVEL to 1 */
  50
  51
  52 #define _USE_FORWARD    0       /* 0:Disable or 1:Enable */
  53 /* To enable f_forward() function, set _USE_FORWARD to 1 and set _FS_TINY to 1. */
  54
  55
  56 /*---------------------------------------------------------------------------/
  57 / Locale and Namespace Configurations
  58 /---------------------------------------------------------------------------*/
  59
  60 #define _CODE_PAGE      932
  61 /* The _CODE_PAGE specifies the OEM code page to be used on the target system.
  62 /  Incorrect setting of the code page can cause a file open failure.
  63 /
  64 /   932  - Japanese Shift_JIS (DBCS, OEM, Windows)
  65 /   936  - Simplified Chinese GBK (DBCS, OEM, Windows)
  66 /   949  - Korean (DBCS, OEM, Windows)
  67 /   950  - Traditional Chinese Big5 (DBCS, OEM, Windows)
  68 /   1250 - Central Europe (Windows)
  69 /   1251 - Cyrillic (Windows)
  70 /   1252 - Latin 1 (Windows)
  71 /   1253 - Greek (Windows)
  72 /   1254 - Turkish (Windows)
  73 /   1255 - Hebrew (Windows)
  74 /   1256 - Arabic (Windows)
  75 /   1257 - Baltic (Windows)
  76 /   1258 - Vietnam (OEM, Windows)
  77 /   437  - U.S. (OEM)
  78 /   720  - Arabic (OEM)
  79 /   737  - Greek (OEM)
  80 /   775  - Baltic (OEM)
  81 /   850  - Multilingual Latin 1 (OEM)
  82 /   858  - Multilingual Latin 1 + Euro (OEM)
  83 /   852  - Latin 2 (OEM)
  84 /   855  - Cyrillic (OEM)
  85 /   866  - Russian (OEM)
  86 /   857  - Turkish (OEM)
  87 /   862  - Hebrew (OEM)
  88 /   874  - Thai (OEM, Windows)
  89 /   1    - ASCII (Valid for only non-LFN configuration) */
  90
  91
  92 #define _USE_LFN        0               /* 0 to 3 */
  93 #define _MAX_LFN        255             /* Maximum LFN length to handle (12 to 255) */
  94 /* The _USE_LFN option switches the LFN feature.
  95 /
  96 /   0: Disable LFN feature. _MAX_LFN has no effect.
  97 /   1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
  98 /   2: Enable LFN with dynamic working buffer on the STACK.
  99 /   3: Enable LFN with dynamic working buffer on the HEAP.
 100 /
 101 /  When enable LFN feature, Unicode handling functions ff_convert() and ff_wtoupper()
 102 /  function must be added to the project.
 103 /  The LFN working buffer occupies (_MAX_LFN + 1) * 2 bytes. When use stack for the
 104 /  working buffer, take care on stack overflow. When use heap memory for the working
 105 /  buffer, memory management functions, ff_memalloc() and ff_memfree(), must be added
 106 /  to the project. */
 107
 108
 109 #define _LFN_UNICODE    0       /* 0:ANSI/OEM or 1:Unicode */
 110 /* To switch the character encoding on the FatFs API (TCHAR) to Unicode, enable LFN
 111 /  feature and set _LFN_UNICODE to 1. This option affects behavior of string I/O
 112 /  functions. This option must be 0 when LFN feature is not enabled. */
 113
 114
 115 #define _STRF_ENCODE    3       /* 0:ANSI/OEM, 1:UTF-16LE, 2:UTF-16BE, 3:UTF-8 */
 116 /* When Unicode API is enabled by _LFN_UNICODE option, this option selects the character
 117 /  encoding on the file to be read/written via string I/O functions, f_gets(), f_putc(),
 118 /  f_puts and f_printf(). This option has no effect when _LFN_UNICODE == 0. Note that
 119 /  FatFs supports only BMP. */
 120
 121
 122 #define _FS_RPATH               2       /* 0 to 2 */
 123 /* The _FS_RPATH option configures relative path feature.
 124 /
 125 /   0: Disable relative path feature and remove related functions.
 126 /   1: Enable relative path. f_chdrive() and f_chdir() function are available.
 127 /   2: f_getcwd() function is available in addition to 1.
 128 /
 129 /  Note that output of the f_readdir() fnction is affected by this option. */
 130
 131
 132 /*---------------------------------------------------------------------------/
 133 / Drive/Volume Configurations
 134 /---------------------------------------------------------------------------*/
 135
 136 #define _VOLUMES        1
 137 /* Number of volumes (logical drives) to be used. */
 138
 139
 140 #define _STR_VOLUME_ID  0       /* 0:Use only 0-9 for drive ID, 1:Use strings for drive ID */
 141 #define _VOLUME_STRS    "RAM","NAND","CF","SD1","SD2","USB1","USB2","USB3"
 142 /* When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive
 143 /  number in the path name. _VOLUME_STRS defines the drive ID strings for each logical
 144 /  drives. Number of items must be equal to _VOLUMES. Valid characters for the drive ID
 145 /  strings are: 0-9 and A-Z. */
 146
 147
 148 #define _MULTI_PARTITION        0       /* 0:Single partition, 1:Enable multiple partition */
 149 /* By default(0), each logical drive number is bound to the same physical drive number
 150 /  and only a FAT volume found on the physical drive is mounted. When it is set to 1,
 151 /  each logical drive number is bound to arbitrary drive/partition listed in VolToPart[].
 152 */
 153
 154
 155 #define _MIN_SS         512
 156 #define _MAX_SS         512
 157 /* These options configure the range of sector size to be supported. (512, 1024, 2048 or
 158 /  4096) Always set both 512 for most systems, all memory card and harddisk. But a larger
 159 /  value may be required for on-board flash memory and some type of optical media.
 160 /  When _MAX_SS is larger than _MIN_SS, FatFs is configured to variable sector size and
 161 /  GET_SECTOR_SIZE command must be implemented to the disk_ioctl() function. */
 162
 163
 164 #define _USE_ERASE      0       /* 0:Disable or 1:Enable */
 165 /* To enable sector erase feature, set _USE_ERASE to 1. Also CTRL_ERASE_SECTOR command
 166 /  should be added to the disk_ioctl() function. */
 167
 168
 169 #define _FS_NOFSINFO    0       /* 0 to 3 */
 170 /* If you need to know correct free space on the FAT32 volume, set bit 0 of this option
 171 /  and f_getfree() function at first time after volume mount will force a full FAT scan.
 172 /  Bit 1 controls the last allocated cluster number as bit 0.
 173 /
 174 /  bit0=0: Use free cluster count in the FSINFO if available.
 175 /  bit0=1: Do not trust free cluster count in the FSINFO.
 176 /  bit1=0: Use last allocated cluster number in the FSINFO if available.
 177 /  bit1=1: Do not trust last allocated cluster number in the FSINFO.
 178 */
 179
 180
 181
 182 /*---------------------------------------------------------------------------/
 183 / System Configurations
 184 /---------------------------------------------------------------------------*/
 185
 186 #define _FS_LOCK        0       /* 0:Disable or >=1:Enable */
 187 /* To enable file lock control feature, set _FS_LOCK to non-zero value.
 188 /  The value defines how many files/sub-directories can be opened simultaneously
 189 /  with file lock control. This feature uses bss _FS_LOCK * 12 bytes. */
 190
 191
 192 #define _FS_REENTRANT   0               /* 0:Disable or 1:Enable */
 193 #define _FS_TIMEOUT             1000    /* Timeout period in unit of time tick */
 194 #define _SYNC_t                 HANDLE  /* O/S dependent sync object type. e.g. HANDLE, OS_EVENT*, ID, SemaphoreHandle_t and etc.. */
 195 /* The _FS_REENTRANT option switches the re-entrancy (thread safe) of the FatFs module.
 196 /
 197 /   0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect.
 198 /   1: Enable re-entrancy. Also user provided synchronization handlers,
 199 /      ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj()
 200 /      function must be added to the project.
 201 */
 202
 203
 204 #define _WORD_ACCESS    1       /* 0 or 1 */
 205 /* The _WORD_ACCESS option is an only platform dependent option. It defines
 206 /  which access method is used to the word data on the FAT volume.
 207 /
 208 /   0: Byte-by-byte access. Always compatible with all platforms.
 209 /   1: Word access. Do not choose this unless under both the following conditions.
 210 /
 211 /  * Address misaligned memory access is always allowed for ALL instructions.
 212 /  * Byte order on the memory is little-endian.
 213 /
 214 /  If it is the case, _WORD_ACCESS can also be set to 1 to improve performance and
 215 /  reduce code size. Following table shows an example of some processor types.
 216 /
 217 /   ARM7TDMI    0           ColdFire    0           V850E       0
 218 /   Cortex-M3   0           Z80         0/1         V850ES      0/1
 219 /   Cortex-M0   0           RX600(LE)   0/1         TLCS-870    0/1
 220 /   AVR         0/1         RX600(BE)   0           TLCS-900    0/1
 221 /   AVR32       0           RL78        0           R32C        0
 222 /   PIC18       0/1         SH-2        0           M16C        0/1
 223 /   PIC24       0           H8S         0           MSP430      0
 224 /   PIC32       0           H8/300H     0           x86         0/1
 225 */
 226
 227
 228 #endif /* _FFCONF */