]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/source/ffconf.h.dist
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / source / ffconf.h.dist
diff --git a/fatfs/source/ffconf.h.dist b/fatfs/source/ffconf.h.dist
new file mode 100644 (file)
index 0000000..fe582ce
--- /dev/null
@@ -0,0 +1,289 @@
+/*---------------------------------------------------------------------------/\r
+/  FatFs - Configuration file\r
+/---------------------------------------------------------------------------*/\r
+\r
+#define FFCONF_DEF 63463       /* Revision ID */\r
+\r
+/*---------------------------------------------------------------------------/\r
+/ Function Configurations\r
+/---------------------------------------------------------------------------*/\r
+\r
+#define FF_FS_READONLY 0\r
+/* This option switches read-only configuration. (0:Read/Write or 1:Read-only)\r
+/  Read-only configuration removes writing API functions, f_write(), f_sync(),\r
+/  f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree()\r
+/  and optional writing functions as well. */\r
+\r
+\r
+#define FF_FS_MINIMIZE 0\r
+/* This option defines minimization level to remove some basic API functions.\r
+/\r
+/   0: Basic functions are fully enabled.\r
+/   1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_truncate() and f_rename()\r
+/      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 FF_USE_STRFUNC 0\r
+/* This option switches string functions, f_gets(), f_putc(), f_puts() and f_printf().\r
+/\r
+/  0: Disable string functions.\r
+/  1: Enable without LF-CRLF conversion.\r
+/  2: Enable with LF-CRLF conversion. */\r
+\r
+\r
+#define FF_USE_FIND            0\r
+/* This option switches filtered directory read functions, f_findfirst() and\r
+/  f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */\r
+\r
+\r
+#define FF_USE_MKFS            0\r
+/* This option switches f_mkfs() function. (0:Disable or 1:Enable) */\r
+\r
+\r
+#define FF_USE_FASTSEEK        0\r
+/* This option switches fast seek function. (0:Disable or 1:Enable) */\r
+\r
+\r
+#define FF_USE_EXPAND  0\r
+/* This option switches f_expand function. (0:Disable or 1:Enable) */\r
+\r
+\r
+#define FF_USE_CHMOD   0\r
+/* This option switches attribute manipulation functions, f_chmod() and f_utime().\r
+/  (0:Disable or 1:Enable) Also FF_FS_READONLY needs to be 0 to enable this option. */\r
+\r
+\r
+#define FF_USE_LABEL   0\r
+/* This option switches volume label functions, f_getlabel() and f_setlabel().\r
+/  (0:Disable or 1:Enable) */\r
+\r
+\r
+#define FF_USE_FORWARD 0\r
+/* This option switches f_forward() function. (0:Disable or 1:Enable) */\r
+\r
+\r
+/*---------------------------------------------------------------------------/\r
+/ Locale and Namespace Configurations\r
+/---------------------------------------------------------------------------*/\r
+\r
+#define FF_CODE_PAGE   932\r
+/* This option specifies the OEM code page to be used on the target system.\r
+/  Incorrect code page setting can cause a file open failure.\r
+/\r
+/   437 - U.S.\r
+/   720 - Arabic\r
+/   737 - Greek\r
+/   771 - KBL\r
+/   775 - Baltic\r
+/   850 - Latin 1\r
+/   852 - Latin 2\r
+/   855 - Cyrillic\r
+/   857 - Turkish\r
+/   860 - Portuguese\r
+/   861 - Icelandic\r
+/   862 - Hebrew\r
+/   863 - Canadian French\r
+/   864 - Arabic\r
+/   865 - Nordic\r
+/   866 - Russian\r
+/   869 - Greek 2\r
+/   932 - Japanese (DBCS)\r
+/   936 - Simplified Chinese (DBCS)\r
+/   949 - Korean (DBCS)\r
+/   950 - Traditional Chinese (DBCS)\r
+/     0 - Include all code pages above and configured by f_setcp()\r
+*/\r
+\r
+\r
+#define FF_USE_LFN             0\r
+#define FF_MAX_LFN             255\r
+/* The FF_USE_LFN switches the support for LFN (long file name).\r
+/\r
+/   0: Disable LFN. FF_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
+/  To enable the LFN, ffunicode.c needs to be added to the project. The LFN function\r
+/  requiers certain internal working buffer occupies (FF_MAX_LFN + 1) * 2 bytes and\r
+/  additional (FF_MAX_LFN + 44) / 15 * 32 bytes when exFAT is enabled.\r
+/  The FF_MAX_LFN defines size of the working buffer in UTF-16 code unit and it can\r
+/  be in range of 12 to 255. It is recommended to be set 255 to fully support LFN\r
+/  specification.\r
+/  When use stack for the working buffer, take care on stack overflow. When use heap\r
+/  memory for the working buffer, memory management functions, ff_memalloc() and\r
+/  ff_memfree() in ffsystem.c, need to be added to the project. */\r
+\r
+\r
+#define FF_LFN_UNICODE 0\r
+/* This option switches the character encoding on the API when LFN is enabled.\r
+/\r
+/   0: ANSI/OEM in current CP (TCHAR = char)\r
+/   1: Unicode in UTF-16 (TCHAR = WCHAR)\r
+/   2: Unicode in UTF-8 (TCHAR = char)\r
+/   3: Unicode in UTF-32 (TCHAR = DWORD)\r
+/\r
+/  Also behavior of string I/O functions will be affected by this option.\r
+/  When LFN is not enabled, this option has no effect. */\r
+\r
+\r
+#define FF_LFN_BUF             255\r
+#define FF_SFN_BUF             12\r
+/* This set of options defines size of file name members in the FILINFO structure\r
+/  which is used to read out directory items. These values should be suffcient for\r
+/  the file names to read. The maximum possible length of the read file name depends\r
+/  on character encoding. When LFN is not enabled, these options have no effect. */\r
+\r
+\r
+#define FF_STRF_ENCODE 3\r
+/* When FF_LFN_UNICODE >= 1 with LFN enabled, string I/O functions, f_gets(),\r
+/  f_putc(), f_puts and f_printf() convert the character encoding in it.\r
+/  This option selects assumption of character encoding ON THE FILE to be\r
+/  read/written via those functions.\r
+/\r
+/   0: ANSI/OEM in current CP\r
+/   1: Unicode in UTF-16LE\r
+/   2: Unicode in UTF-16BE\r
+/   3: Unicode in UTF-8\r
+*/\r
+\r
+\r
+#define FF_FS_RPATH            0\r
+/* This option configures support for relative path.\r
+/\r
+/   0: Disable relative path and remove related functions.\r
+/   1: Enable relative path. f_chdir() and f_chdrive() are available.\r
+/   2: f_getcwd() function is available in addition to 1.\r
+*/\r
+\r
+\r
+/*---------------------------------------------------------------------------/\r
+/ Drive/Volume Configurations\r
+/---------------------------------------------------------------------------*/\r
+\r
+#define FF_VOLUMES             1\r
+/* Number of volumes (logical drives) to be used. (1-10) */\r
+\r
+\r
+#define FF_STR_VOLUME_ID       0\r
+#define FF_VOLUME_STRS         "RAM","NAND","CF","SD","SD2","USB","USB2","USB3"\r
+/* FF_STR_VOLUME_ID switches support for volume ID in arbitrary strings.\r
+/  When FF_STR_VOLUME_ID is set to 1 or 2, arbitrary strings can be used as drive\r
+/  number in the path name. FF_VOLUME_STRS defines the volume ID strings for each\r
+/  logical drives. Number of items must not be less than FF_VOLUMES. Valid\r
+/  characters for the volume ID strings are A-Z, a-z and 0-9, however, they are\r
+/  compared in case-insensitive. If FF_STR_VOLUME_ID >= 1 and FF_VOLUME_STRS is\r
+/  not defined, a user defined volume string table needs to be defined as:\r
+/\r
+/  const char* VolumeStr[FF_VOLUMES] = {"ram","flash","sd","usb",...\r
+*/\r
+\r
+\r
+#define FF_MULTI_PARTITION     0\r
+/* This option switches support for multiple volumes on the physical drive.\r
+/  By default (0), each logical drive number is bound to the same physical drive\r
+/  number and only an FAT volume found on the physical drive will be mounted.\r
+/  When this function is enabled (1), each logical drive number can be bound to\r
+/  arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk()\r
+/  funciton will be available. */\r
+\r
+\r
+#define FF_MIN_SS              512\r
+#define FF_MAX_SS              512\r
+/* This set of options configures the range of sector size to be supported. (512,\r
+/  1024, 2048 or 4096) Always set both 512 for most systems, generic memory card and\r
+/  harddisk. But a larger value may be required for on-board flash memory and some\r
+/  type of optical media. When FF_MAX_SS is larger than FF_MIN_SS, FatFs is configured\r
+/  for variable sector size mode and disk_ioctl() function needs to implement\r
+/  GET_SECTOR_SIZE command. */\r
+\r
+\r
+#define FF_USE_TRIM            0\r
+/* This option switches support for ATA-TRIM. (0:Disable or 1:Enable)\r
+/  To enable Trim function, also CTRL_TRIM command should be implemented to the\r
+/  disk_ioctl() function. */\r
+\r
+\r
+#define FF_FS_NOFSINFO 0\r
+/* If you need to know correct free space on the FAT32 volume, set bit 0 of this\r
+/  option, and f_getfree() function at first time after volume mount will force\r
+/  a full FAT scan. Bit 1 controls the use of last allocated cluster number.\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 FF_FS_TINY             0\r
+/* This option switches tiny buffer configuration. (0:Normal or 1:Tiny)\r
+/  At the tiny configuration, size of file object (FIL) is shrinked FF_MAX_SS bytes.\r
+/  Instead of private sector buffer eliminated from the file object, common sector\r
+/  buffer in the filesystem object (FATFS) is used for the file data transfer. */\r
+\r
+\r
+#define FF_FS_EXFAT            0\r
+/* This option switches support for exFAT filesystem. (0:Disable or 1:Enable)\r
+/  To enable exFAT, also LFN needs to be enabled.\r
+/  Note that enabling exFAT discards ANSI C (C89) compatibility. */\r
+\r
+\r
+#define FF_FS_NORTC            0\r
+#define FF_NORTC_MON   1\r
+#define FF_NORTC_MDAY  1\r
+#define FF_NORTC_YEAR  2018\r
+/* The option FF_FS_NORTC switches timestamp functiton. If the system does not have\r
+/  any RTC function or valid timestamp is not needed, set FF_FS_NORTC = 1 to disable\r
+/  the timestamp function. Every object modified by FatFs will have a fixed timestamp\r
+/  defined by FF_NORTC_MON, FF_NORTC_MDAY and FF_NORTC_YEAR in local time.\r
+/  To enable timestamp function (FF_FS_NORTC = 0), get_fattime() function need to be\r
+/  added to the project to read current time form real-time clock. FF_NORTC_MON,\r
+/  FF_NORTC_MDAY and FF_NORTC_YEAR have no effect.\r
+/  These options have no effect at read-only configuration (FF_FS_READONLY = 1). */\r
+\r
+\r
+#define FF_FS_LOCK             0\r
+/* The option FF_FS_LOCK switches file lock function to control duplicated file open\r
+/  and illegal operation to open objects. This option must be 0 when FF_FS_READONLY\r
+/  is 1.\r
+/\r
+/  0:  Disable file lock function. To avoid volume corruption, application program\r
+/      should avoid illegal open, remove and rename to the open objects.\r
+/  >0: Enable file lock function. The value defines how many files/sub-directories\r
+/      can be opened simultaneously under file lock control. Note that the file\r
+/      lock control is independent of re-entrancy. */\r
+\r
+\r
+#define FF_FS_REENTRANT        0\r
+#define FF_FS_TIMEOUT  1000\r
+#define FF_SYNC_t              HANDLE\r
+/* The option FF_FS_REENTRANT switches the re-entrancy (thread safe) of the FatFs\r
+/  module itself. Note that regardless of this option, file access to different\r
+/  volume is always re-entrant and volume control functions, f_mount(), f_mkfs()\r
+/  and f_fdisk() function, are always not re-entrant. Only file/directory access\r
+/  to the same volume is under control of this function.\r
+/\r
+/   0: Disable re-entrancy. FF_FS_TIMEOUT and FF_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. Samples are available in\r
+/      option/syscall.c.\r
+/\r
+/  The FF_FS_TIMEOUT defines timeout period in unit of time tick.\r
+/  The FF_SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*,\r
+/  SemaphoreHandle_t and etc. A header file for O/S definitions needs to be\r
+/  included somewhere in the scope of ff.h. */\r
+\r
+/* #include <windows.h>        // O/S definitions  */\r
+\r
+\r
+\r
+/*--- End of configuration options ---*/\r