ffconf_template.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. /*----------------------------------------------------------------------------/
  2. / FatFs - Generic FAT file system module R0.12c /
  3. /-----------------------------------------------------------------------------/
  4. /
  5. / Copyright (C) 2017, ChaN, all right reserved.
  6. / Portions Copyright (C) STMicroelectronics, all right reserved.
  7. /
  8. / FatFs module is an open source software. Redistribution and use of FatFs in
  9. / source and binary forms, with or without modification, are permitted provided
  10. / that the following condition is met:
  11. / 1. Redistributions of source code must retain the above copyright notice,
  12. / this condition and the following disclaimer.
  13. /
  14. / This software is provided by the copyright holder and contributors "AS IS"
  15. / and any warranties related to this software are DISCLAIMED.
  16. / The copyright owner or contributors be NOT LIABLE for any damages caused
  17. / by use of this software.
  18. /----------------------------------------------------------------------------*/
  19. /*---------------------------------------------------------------------------/
  20. / FatFs - FAT file system module configuration file
  21. /---------------------------------------------------------------------------*/
  22. #define _FFCONF 68300 /* Revision ID */
  23. /*---------------------------------------------------------------------------/
  24. / Function Configurations
  25. /---------------------------------------------------------------------------*/
  26. #define _FS_READONLY 0
  27. /* This option switches read-only configuration. (0:Read/Write or 1:Read-only)
  28. / Read-only configuration removes writing API functions, f_write(), f_sync(),
  29. / f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree()
  30. / and optional writing functions as well. */
  31. #define _FS_MINIMIZE 0
  32. /* This option defines minimization level to remove some basic API functions.
  33. /
  34. / 0: All basic functions are enabled.
  35. / 1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_truncate() and f_rename()
  36. / are removed.
  37. / 2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1.
  38. / 3: f_lseek() function is removed in addition to 2. */
  39. #define _USE_STRFUNC 0
  40. /* This option switches string functions, f_gets(), f_putc(), f_puts() and
  41. / f_printf().
  42. /
  43. / 0: Disable string functions.
  44. / 1: Enable without LF-CRLF conversion.
  45. / 2: Enable with LF-CRLF conversion. */
  46. #define _USE_FIND 0
  47. /* This option switches filtered directory read functions, f_findfirst() and
  48. / f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */
  49. #define _USE_MKFS 1
  50. /* This option switches f_mkfs() function. (0:Disable or 1:Enable) */
  51. #define _USE_FASTSEEK 1
  52. /* This option switches fast seek function. (0:Disable or 1:Enable) */
  53. #define _USE_EXPAND 0
  54. /* This option switches f_expand function. (0:Disable or 1:Enable) */
  55. #define _USE_CHMOD 0
  56. /* This option switches attribute manipulation functions, f_chmod() and f_utime().
  57. / (0:Disable or 1:Enable) Also _FS_READONLY needs to be 0 to enable this option. */
  58. #define _USE_LABEL 0
  59. /* This option switches volume label functions, f_getlabel() and f_setlabel().
  60. / (0:Disable or 1:Enable) */
  61. #define _USE_FORWARD 0
  62. /* This option switches f_forward() function. (0:Disable or 1:Enable) */
  63. /*---------------------------------------------------------------------------/
  64. / Locale and Namespace Configurations
  65. /---------------------------------------------------------------------------*/
  66. #define _CODE_PAGE 850
  67. /* This option specifies the OEM code page to be used on the target system.
  68. / Incorrect setting of the code page can cause a file open failure.
  69. /
  70. / 1 - ASCII (No extended character. Non-LFN cfg. only)
  71. / 437 - U.S.
  72. / 720 - Arabic
  73. / 737 - Greek
  74. / 771 - KBL
  75. / 775 - Baltic
  76. / 850 - Latin 1
  77. / 852 - Latin 2
  78. / 855 - Cyrillic
  79. / 857 - Turkish
  80. / 860 - Portuguese
  81. / 861 - Icelandic
  82. / 862 - Hebrew
  83. / 863 - Canadian French
  84. / 864 - Arabic
  85. / 865 - Nordic
  86. / 866 - Russian
  87. / 869 - Greek 2
  88. / 932 - Japanese (DBCS)
  89. / 936 - Simplified Chinese (DBCS)
  90. / 949 - Korean (DBCS)
  91. / 950 - Traditional Chinese (DBCS)
  92. */
  93. #define _USE_LFN 3
  94. #define _MAX_LFN 255
  95. /* The _USE_LFN switches the support of long file name (LFN).
  96. /
  97. / 0: Disable support of LFN. _MAX_LFN has no effect.
  98. / 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe.
  99. / 2: Enable LFN with dynamic working buffer on the STACK.
  100. / 3: Enable LFN with dynamic working buffer on the HEAP.
  101. /
  102. / To enable the LFN, Unicode handling functions (option/unicode.c) must be added
  103. / to the project. The working buffer occupies (_MAX_LFN + 1) * 2 bytes and
  104. / additional 608 bytes at exFAT enabled. _MAX_LFN can be in range from 12 to 255.
  105. / It should be set 255 to support full featured LFN operations.
  106. / When use stack for the working buffer, take care on stack overflow. When use heap
  107. / memory for the working buffer, memory management functions, ff_memalloc() and
  108. / ff_memfree(), must be added to the project. */
  109. #define _LFN_UNICODE 0
  110. /* This option switches character encoding on the API. (0:ANSI/OEM or 1:UTF-16)
  111. / To use Unicode string for the path name, enable LFN and set _LFN_UNICODE = 1.
  112. / This option also affects behavior of string I/O functions. */
  113. #define _STRF_ENCODE 3
  114. /* When _LFN_UNICODE == 1, this option selects the character encoding ON THE FILE to
  115. / be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf().
  116. /
  117. / 0: ANSI/OEM
  118. / 1: UTF-16LE
  119. / 2: UTF-16BE
  120. / 3: UTF-8
  121. /
  122. / This option has no effect when _LFN_UNICODE == 0. */
  123. #define _FS_RPATH 0
  124. /* This option configures support of relative path.
  125. /
  126. / 0: Disable relative path and remove related functions.
  127. / 1: Enable relative path. f_chdir() and f_chdrive() are available.
  128. / 2: f_getcwd() function is available in addition to 1.
  129. */
  130. /*---------------------------------------------------------------------------/
  131. / Drive/Volume Configurations
  132. /---------------------------------------------------------------------------*/
  133. #define _VOLUMES 2
  134. /* Number of volumes (logical drives) to be used. */
  135. #define _STR_VOLUME_ID 0
  136. #define _VOLUME_STRS "RAM","NAND","CF","SD","SD2","USB","USB2","USB3"
  137. /* _STR_VOLUME_ID switches string support of volume ID.
  138. / When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive
  139. / number in the path name. _VOLUME_STRS defines the drive ID strings for each
  140. / logical drives. Number of items must be equal to _VOLUMES. Valid characters for
  141. / the drive ID strings are: A-Z and 0-9. */
  142. #define _MULTI_PARTITION 0
  143. /* This option switches support of multi-partition on a physical drive.
  144. / By default (0), each logical drive number is bound to the same physical drive
  145. / number and only an FAT volume found on the physical drive will be mounted.
  146. / When multi-partition is enabled (1), each logical drive number can be bound to
  147. / arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk()
  148. / funciton will be available. */
  149. #define _MIN_SS 512
  150. #define _MAX_SS 512
  151. /* These options configure the range of sector size to be supported. (512, 1024,
  152. / 2048 or 4096) Always set both 512 for most systems, all type of memory cards and
  153. / harddisk. But a larger value may be required for on-board flash memory and some
  154. / type of optical media. When _MAX_SS is larger than _MIN_SS, FatFs is configured
  155. / to variable sector size and GET_SECTOR_SIZE command must be implemented to the
  156. / disk_ioctl() function. */
  157. #define _USE_TRIM 0
  158. /* This option switches support of ATA-TRIM. (0:Disable or 1:Enable)
  159. / To enable Trim function, also CTRL_TRIM command should be implemented to the
  160. / disk_ioctl() function. */
  161. #define _FS_NOFSINFO 0
  162. /* If you need to know correct free space on the FAT32 volume, set bit 0 of this
  163. / option, and f_getfree() function at first time after volume mount will force
  164. / a full FAT scan. Bit 1 controls the use of last allocated cluster number.
  165. /
  166. / bit0=0: Use free cluster count in the FSINFO if available.
  167. / bit0=1: Do not trust free cluster count in the FSINFO.
  168. / bit1=0: Use last allocated cluster number in the FSINFO if available.
  169. / bit1=1: Do not trust last allocated cluster number in the FSINFO.
  170. */
  171. /*---------------------------------------------------------------------------/
  172. / System Configurations
  173. /---------------------------------------------------------------------------*/
  174. #define _FS_TINY 0
  175. /* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)
  176. / At the tiny configuration, size of file object (FIL) is reduced _MAX_SS bytes.
  177. / Instead of private sector buffer eliminated from the file object, common sector
  178. / buffer in the file system object (FATFS) is used for the file data transfer. */
  179. #define _FS_EXFAT 0
  180. /* This option switches support of exFAT file system. (0:Disable or 1:Enable)
  181. / When enable exFAT, also LFN needs to be enabled. (_USE_LFN >= 1)
  182. / Note that enabling exFAT discards C89 compatibility. */
  183. #define _FS_NORTC 0
  184. #define _NORTC_MON 1
  185. #define _NORTC_MDAY 1
  186. #define _NORTC_YEAR 2016
  187. /* The option _FS_NORTC switches timestamp functiton. If the system does not have
  188. / any RTC function or valid timestamp is not needed, set _FS_NORTC = 1 to disable
  189. / the timestamp function. All objects modified by FatFs will have a fixed timestamp
  190. / defined by _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR in local time.
  191. / To enable timestamp function (_FS_NORTC = 0), get_fattime() function need to be
  192. / added to the project to get current time form real-time clock. _NORTC_MON,
  193. / _NORTC_MDAY and _NORTC_YEAR have no effect.
  194. / These options have no effect at read-only configuration (_FS_READONLY = 1). */
  195. #define _FS_LOCK 2
  196. /* The option _FS_LOCK switches file lock function to control duplicated file open
  197. / and illegal operation to open objects. This option must be 0 when _FS_READONLY
  198. / is 1.
  199. /
  200. / 0: Disable file lock function. To avoid volume corruption, application program
  201. / should avoid illegal open, remove and rename to the open objects.
  202. / >0: Enable file lock function. The value defines how many files/sub-directories
  203. / can be opened simultaneously under file lock control. Note that the file
  204. / lock control is independent of re-entrancy. */
  205. #define _FS_REENTRANT 1
  206. #if _FS_REENTRANT
  207. #include "cmsis_os.h"
  208. #define _FS_TIMEOUT 1000
  209. #define _SYNC_t osSemaphoreId
  210. #endif
  211. /* The option _FS_REENTRANT switches the re-entrancy (thread safe) of the FatFs
  212. / module itself. Note that regardless of this option, file access to different
  213. / volume is always re-entrant and volume control functions, f_mount(), f_mkfs()
  214. / and f_fdisk() function, are always not re-entrant. Only file/directory access
  215. / to the same volume is under control of this function.
  216. /
  217. / 0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect.
  218. / 1: Enable re-entrancy. Also user provided synchronization handlers,
  219. / ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj()
  220. / function, must be added to the project. Samples are available in
  221. / option/syscall.c.
  222. /
  223. / The _FS_TIMEOUT defines timeout period in unit of time tick.
  224. / The _SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*,
  225. / SemaphoreHandle_t and etc.. A header file for O/S definitions needs to be
  226. / included somewhere in the scope of ff.h. */
  227. /* #include <windows.h> // O/S definitions */
  228. #if _USE_LFN == 3
  229. #if !defined(ff_malloc) || !defined(ff_free)
  230. #include <stdlib.h>
  231. #endif
  232. #if !defined(ff_malloc)
  233. #define ff_malloc malloc
  234. #endif
  235. #if !defined(ff_free)
  236. #define ff_free free
  237. #endif
  238. #endif
  239. /*--- End of configuration options ---*/