[#ftl] [#assign s = name] [#assign temp = s?replace(".","__")] [#assign inclusion_protection = temp?upper_case] /* USER CODE BEGIN Header */ /** ****************************************************************************** * FatFs - Generic FAT file system module R0.12c (C)ChaN, 2017 ****************************************************************************** [@common.optinclude name=mxTmpFolder+"/license.tmp"/][#--include License text --] ****************************************************************************** */ /* USER CODE END Header */ #ifndef _FFCONF #define _FFCONF 68300 /* Revision ID */ /*-----------------------------------------------------------------------------/ / Additional user header to be used /-----------------------------------------------------------------------------*/ [#assign usbhInUse = 0] [#assign includeGenericBspForSD = 0] [#assign includeGenericBspForSDRAM = 0] [#assign includeGenericBspForSRAM = 0] [#assign includeBspForUSBH = 0] [#assign customBSPSRAM = 0] [#-- on G4, not need to include bsp_driver_sram.h when custom BSP is chosen --] [#assign customBSPSD = 0] [#-- on L5, not need to include bsp_driver_sd.h when a board is chosen 9will use the BSP of the board --] [#assign cmsisrtosInUse = 0] [#assign useMutex = 0] #include "main.h" #include "${FamilyName?lower_case}xx_hal.h" [#compress] [#list SWIPdatas as SWIP] [#if SWIP.defines??] [#list SWIP.defines as definition] [#if definition.name="_FS_FATFS_SDIO"] [#-- SD Card mode is selected --] [#if definition.value="1"] [#assign includeGenericBspForSD = 1] [/#if] [/#if] [#if definition.name="_FS_FATFS_SDRAM"] [#-- SDRAM mode is selected --] [#if definition.value="1"] [#assign includeGenericBspForSDRAM = 1] [/#if] [/#if] [#if definition.name="_FS_FATFS_SRAM"] [#-- SRAM mode is selected --] [#if definition.value="1"] [#assign includeGenericBspForSRAM = 1] [/#if] [/#if] [#if definition.name="_FS_FATFS_USB"] [#-- USB Disk mode is selected --] [#if definition.value="1"] [#assign usbhInUse = 1] [#assign includeBspForUSBH = 1] [/#if] [/#if] [#if definition.name="SRAM_BSP_CODE"] [#if definition.value="1"] [#-- can occur on G4 --] [#assign customBSPSRAM = 1] [/#if] [/#if] [#if definition.name="SD_BSP_CODE"] [#if definition.value="1"] [#-- can occur on L5 --] [#assign customBSPSD = 1] [/#if] [/#if] [#if definition.name="_FS_REENTRANT"] [#if definition.value="1"] [#assign cmsisrtosInUse = 1] [#-- Should change with FreeRTOS Native mode when it comes --] [/#if] [/#if] [/#list] [/#if] [#if cmsisrtosInUse == 1] #include "cmsis_os.h" /* _FS_REENTRANT set to 1 and CMSIS API chosen */ [/#if] [#if includes??] [#list includes as include] #include "${include}" [/#list] [/#if] [#-- Global variables --] [#if SWIP.variables??] [#list SWIP.variables as variable] [#if variable.name != "HALCompliant"] extern ${variable.value} ${variable.name}; [/#if] [/#list] [/#if] [#-- Global variables --] [#if SWIP.defines??] [#list SWIP.defines as definition] [#if definition.name="_HUSBH"] [#if usbhInUse == 1] /* Handle for USB Host */ #define hUSB_Host ${definition.value} [/#if] [/#if] [#if definition.name=="_FS_TINY"] [#assign valueTiny = definition.value] [/#if] [#if definition.name=="_FS_READONLY"] [#assign valueReadonly = definition.value] [/#if] [#if definition.name=="_FS_MINIMIZE"] [#assign valueMinimize = definition.value] [/#if] [#if definition.name=="_USE_STRFUNC"] [#assign valueUseStrfunc = definition.value] [/#if] [#if definition.name=="_USE_FIND"] [#-- New in R0.11 --] [#assign valueUseFind = definition.value] [/#if] [#if definition.name=="_USE_MKFS"] [#assign valueUseMkfs = definition.value] [/#if] [#if definition.name=="_USE_FASTSEEK"] [#assign valueUseFastseek = definition.value] [/#if] [#if definition.name=="_USE_LABEL"] [#assign valueUseLabel = definition.value] [/#if] [#if definition.name=="_USE_FORWARD"] [#assign valueUseForward = definition.value] [/#if] [#if definition.name=="_CODE_PAGE"] [#assign valueCodePage = definition.value] [/#if] [#if definition.name=="_USE_LFN"] [#assign valueUseLfn = definition.value] [/#if] [#if definition.name=="_MAX_LFN"] [#assign valueMaxLfn = definition.value] [/#if] [#if definition.name=="_LFN_UNICODE"] [#assign valueLfnUnicode = definition.value] [/#if] [#if definition.name=="_STRF_ENCODE"] [#assign valueStrfEncode = definition.value] [/#if] [#if definition.name=="_FS_RPATH"] [#assign valueRpath = definition.value] [/#if] [#if definition.name=="_VOLUMES"] [#assign valueVolumes = definition.value] [/#if] [#if definition.name=="_MULTI_PARTITION"] [#assign valueMultiPartition = definition.value] [/#if] [#if definition.name=="_MAX_SS"] [#assign valueMaxSectorSize = definition.value] [/#if] [#if definition.name=="_MIN_SS"] [#assign valueMinSectorSize = definition.value] [/#if] [#if definition.name=="_USE_TRIM"] [#-- Renamed in R0.11 --] [#assign valueUseTrim = definition.value] [/#if] [#if definition.name=="_FS_NOFSINFO"] [#assign valueNoFsinfo = definition.value] [/#if] [#if definition.name=="_FS_NORTC"] [#-- New in R0.11 --] [#assign valueNoRtc = definition.value] [/#if] [#if definition.name=="_NORTC_YEAR"] [#-- New in R0.11 --] [#assign valueNoRtcYear = definition.value] [/#if] [#if definition.name=="_NORTC_MON"] [#-- New in R0.11 --] [#assign valueNoRtcMonth = definition.value] [/#if] [#if definition.name=="_NORTC_MDAY"] [#-- New in R0.11 --] [#assign valueNoRtcDay = definition.value] [/#if] [#if definition.name=="_FS_REENTRANT"] [#assign valueReentrant = definition.value] [/#if] [#if definition.name=="_FS_TIMEOUT"] [#assign valueTimeout = definition.value] [/#if] [#if definition.name=="_SYNC_t"] [#assign valueSynct = definition.value] [/#if] [#if definition.name=="_FS_LOCK"] [#assign valueLock = definition.value] [/#if] [#if definition.name=="_USE_EXPAND"] [#-- New in R0.12 --] [#assign valueUseExpand = definition.value] [/#if] [#if definition.name=="_USE_CHMOD"] [#-- New in R0.12 --] [#assign valueUseChmod = definition.value] [/#if] [#if definition.name=="_FS_EXFAT"] [#-- New in R0.12 --] [#assign valueExFat = definition.value] [/#if] [#if definition.name=="_USE_MUTEX"] [#assign useMutex = definition.value] [/#if] [/#list] [/#if] [/#list] [/#compress] /*-----------------------------------------------------------------------------/ / Function Configurations /-----------------------------------------------------------------------------*/ #define _FS_READONLY ${valueReadonly} /* 0:Read/Write or 1:Read only */ /* This option switches read-only configuration. (0:Read/Write or 1:Read-only) / Read-only configuration removes writing API functions, f_write(), f_sync(), / f_unlink(), f_mkdir(), f_chmod(), f_rename(), f_truncate(), f_getfree() / and optional writing functions as well. */ #define _FS_MINIMIZE ${valueMinimize} /* 0 to 3 */ /* This option defines minimization level to remove some basic API functions. / / 0: All basic functions are enabled. / 1: f_stat(), f_getfree(), f_unlink(), f_mkdir(), f_truncate() and f_rename() / are removed. / 2: f_opendir(), f_readdir() and f_closedir() are removed in addition to 1. / 3: f_lseek() function is removed in addition to 2. */ #define _USE_STRFUNC ${valueUseStrfunc} /* 0:Disable or 1-2:Enable */ /* This option switches string functions, f_gets(), f_putc(), f_puts() and / f_printf(). / / 0: Disable string functions. / 1: Enable without LF-CRLF conversion. / 2: Enable with LF-CRLF conversion. */ #define _USE_FIND ${valueUseFind} /* This option switches filtered directory read functions, f_findfirst() and / f_findnext(). (0:Disable, 1:Enable 2:Enable with matching altname[] too) */ #define _USE_MKFS ${valueUseMkfs} /* This option switches f_mkfs() function. (0:Disable or 1:Enable) */ #define _USE_FASTSEEK ${valueUseFastseek} /* This option switches fast seek feature. (0:Disable or 1:Enable) */ #define _USE_EXPAND ${valueUseExpand} /* This option switches f_expand function. (0:Disable or 1:Enable) */ #define _USE_CHMOD ${valueUseChmod} /* This option switches attribute manipulation functions, f_chmod() and f_utime(). / (0:Disable or 1:Enable) Also _FS_READONLY needs to be 0 to enable this option. */ #define _USE_LABEL ${valueUseLabel} /* This option switches volume label functions, f_getlabel() and f_setlabel(). / (0:Disable or 1:Enable) */ #define _USE_FORWARD ${valueUseForward} /* This option switches f_forward() function. (0:Disable or 1:Enable) */ /*-----------------------------------------------------------------------------/ / Locale and Namespace Configurations /-----------------------------------------------------------------------------*/ #define _CODE_PAGE ${valueCodePage} /* This option specifies the OEM code page to be used on the target system. / Incorrect setting of the code page can cause a file open failure. / / 1 - ASCII (No extended character. Non-LFN cfg. only) / 437 - U.S. / 720 - Arabic / 737 - Greek / 771 - KBL / 775 - Baltic / 850 - Latin 1 / 852 - Latin 2 / 855 - Cyrillic / 857 - Turkish / 860 - Portuguese / 861 - Icelandic / 862 - Hebrew / 863 - Canadian French / 864 - Arabic / 865 - Nordic / 866 - Russian / 869 - Greek 2 / 932 - Japanese (DBCS) / 936 - Simplified Chinese (DBCS) / 949 - Korean (DBCS) / 950 - Traditional Chinese (DBCS) */ #define _USE_LFN ${valueUseLfn} /* 0 to 3 */ #define _MAX_LFN ${valueMaxLfn} /* Maximum LFN length to handle (12 to 255) */ /* The _USE_LFN switches the support of long file name (LFN). / / 0: Disable support of LFN. _MAX_LFN has no effect. / 1: Enable LFN with static working buffer on the BSS. Always NOT thread-safe. / 2: Enable LFN with dynamic working buffer on the STACK. / 3: Enable LFN with dynamic working buffer on the HEAP. / / To enable the LFN, Unicode handling functions (option/unicode.c) must be added / to the project. The working buffer occupies (_MAX_LFN + 1) * 2 bytes and / additional 608 bytes at exFAT enabled. _MAX_LFN can be in range from 12 to 255. / It should be set 255 to support full featured LFN operations. / When use stack for the working buffer, take care on stack overflow. When use heap / memory for the working buffer, memory management functions, ff_memalloc() and / ff_memfree(), must be added to the project. */ #define _LFN_UNICODE ${valueLfnUnicode} /* 0:ANSI/OEM or 1:Unicode */ /* This option switches character encoding on the API. (0:ANSI/OEM or 1:UTF-16) / To use Unicode string for the path name, enable LFN and set _LFN_UNICODE = 1. / This option also affects behavior of string I/O functions. */ #define _STRF_ENCODE ${valueStrfEncode} /* When _LFN_UNICODE == 1, this option selects the character encoding ON THE FILE to / be read/written via string I/O functions, f_gets(), f_putc(), f_puts and f_printf(). / / 0: ANSI/OEM / 1: UTF-16LE / 2: UTF-16BE / 3: UTF-8 / / This option has no effect when _LFN_UNICODE == 0. */ #define _FS_RPATH ${valueRpath} /* 0 to 2 */ /* This option configures support of relative path. / / 0: Disable relative path and remove related functions. / 1: Enable relative path. f_chdir() and f_chdrive() are available. / 2: f_getcwd() function is available in addition to 1. */ /*---------------------------------------------------------------------------/ / Drive/Volume Configurations /----------------------------------------------------------------------------*/ #define _VOLUMES ${valueVolumes} /* Number of volumes (logical drives) to be used. */ /* USER CODE BEGIN Volumes */ #define _STR_VOLUME_ID 0 /* 0:Use only 0-9 for drive ID, 1:Use strings for drive ID */ #define _VOLUME_STRS "RAM","NAND","CF","SD1","SD2","USB1","USB2","USB3" /* _STR_VOLUME_ID switches string support of volume ID. / When _STR_VOLUME_ID is set to 1, also pre-defined strings can be used as drive / number in the path name. _VOLUME_STRS defines the drive ID strings for each / logical drives. Number of items must be equal to _VOLUMES. Valid characters for / the drive ID strings are: A-Z and 0-9. */ /* USER CODE END Volumes */ #define _MULTI_PARTITION ${valueMultiPartition} /* 0:Single partition, 1:Multiple partition */ /* This option switches support of multi-partition on a physical drive. / By default (0), each logical drive number is bound to the same physical drive / number and only an FAT volume found on the physical drive will be mounted. / When multi-partition is enabled (1), each logical drive number can be bound to / arbitrary physical drive and partition listed in the VolToPart[]. Also f_fdisk() / funciton will be available. */ #define _MIN_SS ${valueMinSectorSize} /* 512, 1024, 2048 or 4096 */ #define _MAX_SS ${valueMaxSectorSize} /* 512, 1024, 2048 or 4096 */ /* These options configure the range of sector size to be supported. (512, 1024, / 2048 or 4096) Always set both 512 for most systems, all type of memory cards and / harddisk. But a larger value may be required for on-board flash memory and some / type of optical media. When _MAX_SS is larger than _MIN_SS, FatFs is configured / to variable sector size and GET_SECTOR_SIZE command must be implemented to the / disk_ioctl() function. */ #define _USE_TRIM ${valueUseTrim} /* This option switches support of ATA-TRIM. (0:Disable or 1:Enable) / To enable Trim function, also CTRL_TRIM command should be implemented to the / disk_ioctl() function. */ #define _FS_NOFSINFO ${valueNoFsinfo} /* 0,1,2 or 3 */ /* If you need to know correct free space on the FAT32 volume, set bit 0 of this / option, and f_getfree() function at first time after volume mount will force / a full FAT scan. Bit 1 controls the use of last allocated cluster number. / / bit0=0: Use free cluster count in the FSINFO if available. / bit0=1: Do not trust free cluster count in the FSINFO. / bit1=0: Use last allocated cluster number in the FSINFO if available. / bit1=1: Do not trust last allocated cluster number in the FSINFO. */ /*---------------------------------------------------------------------------/ / System Configurations /----------------------------------------------------------------------------*/ #define _FS_TINY ${valueTiny} /* 0:Normal or 1:Tiny */ /* This option switches tiny buffer configuration. (0:Normal or 1:Tiny) / At the tiny configuration, size of file object (FIL) is reduced _MAX_SS bytes. / Instead of private sector buffer eliminated from the file object, common sector / buffer in the file system object (FATFS) is used for the file data transfer. */ #define _FS_EXFAT ${valueExFat} /* This option switches support of exFAT file system. (0:Disable or 1:Enable) / When enable exFAT, also LFN needs to be enabled. (_USE_LFN >= 1) / Note that enabling exFAT discards C89 compatibility. */ #define _FS_NORTC ${valueNoRtc} #define _NORTC_MON ${valueNoRtcMonth} #define _NORTC_MDAY ${valueNoRtcDay} #define _NORTC_YEAR ${valueNoRtcYear} /* The option _FS_NORTC switches timestamp functiton. If the system does not have / any RTC function or valid timestamp is not needed, set _FS_NORTC = 1 to disable / the timestamp function. All objects modified by FatFs will have a fixed timestamp / defined by _NORTC_MON, _NORTC_MDAY and _NORTC_YEAR in local time. / To enable timestamp function (_FS_NORTC = 0), get_fattime() function need to be / added to the project to get current time form real-time clock. _NORTC_MON, / _NORTC_MDAY and _NORTC_YEAR have no effect. / These options have no effect at read-only configuration (_FS_READONLY = 1). */ #define _FS_LOCK ${valueLock} /* 0:Disable or >=1:Enable */ /* The option _FS_LOCK switches file lock function to control duplicated file open / and illegal operation to open objects. This option must be 0 when _FS_READONLY / is 1. / / 0: Disable file lock function. To avoid volume corruption, application program / should avoid illegal open, remove and rename to the open objects. / >0: Enable file lock function. The value defines how many files/sub-directories / can be opened simultaneously under file lock control. Note that the file / lock control is independent of re-entrancy. */ #define _FS_REENTRANT ${valueReentrant} /* 0:Disable or 1:Enable */ [#if cmsisrtosInUse == 1] [#-- Generated only if freertos activated --] #define _USE_MUTEX ${useMutex} /* 0:Disable or 1:Enable */ #define _FS_TIMEOUT ${valueTimeout} /* Timeout period in unit of time ticks */ #define _SYNC_t ${valueSynct} [/#if] /* The option _FS_REENTRANT switches the re-entrancy (thread safe) of the FatFs / module itself. Note that regardless of this option, file access to different / volume is always re-entrant and volume control functions, f_mount(), f_mkfs() / and f_fdisk() function, are always not re-entrant. Only file/directory access / to the same volume is under control of this function. / / 0: Disable re-entrancy. _FS_TIMEOUT and _SYNC_t have no effect. / 1: Enable re-entrancy. Also user provided synchronization handlers, / ff_req_grant(), ff_rel_grant(), ff_del_syncobj() and ff_cre_syncobj() / function, must be added to the project. Samples are available in / option/syscall.c. / / The _FS_TIMEOUT defines timeout period in unit of time tick. / The _SYNC_t defines O/S dependent sync object type. e.g. HANDLE, ID, OS_EVENT*, / SemaphoreHandle_t and etc.. A header file for O/S definitions needs to be / included somewhere in the scope of ff.h. */ [#-- In R0.12c, definitions that depend on FreeRTOS state (enabled/disabled) --] [#if cmsisrtosInUse == 1] /* define the ff_malloc ff_free macros as FreeRTOS pvPortMalloc and vPortFree macros */ #if !defined(ff_malloc) && !defined(ff_free) #define ff_malloc pvPortMalloc #define ff_free vPortFree [#else] /* define the ff_malloc ff_free macros as standard malloc free */ #if !defined(ff_malloc) && !defined(ff_free) #include #define ff_malloc malloc #define ff_free free [/#if] #endif #endif /* _FFCONF */