| 1 | @verbatim
|
|---|
| 2 | ******************************************************************************
|
|---|
| 3 | * @file st_readme.txt
|
|---|
| 4 | * @author MCD Application Team
|
|---|
| 5 | * @brief This file lists the main modification done by STMicroelectronics on
|
|---|
| 6 | * FatFs for integration with STM32Cube solution.
|
|---|
| 7 | * For more details on FatFs implementation on STM32Cube, please refer
|
|---|
| 8 | * to UM1721 "Developing Applications on STM32Cube with FatFs"
|
|---|
| 9 | ******************************************************************************
|
|---|
| 10 | * @attention
|
|---|
| 11 | *
|
|---|
| 12 | * Copyright (c) 2017 STMicroelectronics. All rights reserved.
|
|---|
| 13 | *
|
|---|
| 14 | * This software component is licensed by ST under BSD 3-Clause license,
|
|---|
| 15 | * the "License"; You may not use this file except in compliance with the
|
|---|
| 16 | * License. You may obtain a copy of the License at:
|
|---|
| 17 | * opensource.org/licenses/BSD-3-Clause
|
|---|
| 18 | *
|
|---|
| 19 | ******************************************************************************
|
|---|
| 20 | @endverbatim
|
|---|
| 21 |
|
|---|
| 22 | ### V2.1.4/18-10-2019 ###
|
|---|
| 23 | ============================
|
|---|
| 24 | + Fix wrong usage of the "memcpy" in the SD_Write() function
|
|---|
| 25 | - drivers/sd_diskio_dma_template_bspv1.c
|
|---|
| 26 | - drivers/sd_diskio_dma_template_bspv2.c
|
|---|
| 27 | - drivers/sd_diskio_dma_rtos_template_bspv1.c
|
|---|
| 28 | - drivers/sd_diskio_dma_rtos_template_bspv2.c
|
|---|
| 29 |
|
|---|
| 30 | + correct the usage of the "_USE_MUTEX" config flag
|
|---|
| 31 | - syscall.c
|
|---|
| 32 |
|
|---|
| 33 | ### V2.1.3/26-07-2019 ###
|
|---|
| 34 | ============================
|
|---|
| 35 | + add new BSPv2 templates:
|
|---|
| 36 | - drivers/sd_diskio_dma_rtos_template_bspv2.c
|
|---|
| 37 | - drivers/sd_diskio_dma_template_bspv2.c
|
|---|
| 38 | - drivers/sd_diskio_template_bspv2.c
|
|---|
| 39 | - drivers/sdram_diskio_template_bspv2.c
|
|---|
| 40 |
|
|---|
| 41 | + rename old template to "xxxx_diskio_template_bspv1.c":
|
|---|
| 42 | - drivers/sd_diskio_dma_rtos_template_bspv1.c
|
|---|
| 43 | - drivers/sd_diskio_dma_template_bspv1.c
|
|---|
| 44 | - drivers/sd_diskio_template_bspv1.c
|
|---|
| 45 | - drivers/sdram_diskio_template_bspv1.c
|
|---|
| 46 |
|
|---|
| 47 | + Add CMSIS-OSv2 support in templates, syscall.c and ff_conf_template.h
|
|---|
| 48 | - syscall.c
|
|---|
| 49 | - ff_conf_template.h
|
|---|
| 50 | - drivers/sd_diskio_dma_rtos_template_bspv2.c
|
|---|
| 51 |
|
|---|
| 52 | + support usage of "osMutex" alongside "osSemaphore" as _SYNC_t type in fatfs
|
|---|
| 53 | - syscall.c
|
|---|
| 54 | - ff_conf_template.h
|
|---|
| 55 |
|
|---|
| 56 |
|
|---|
| 57 | ### V2.1.2/29-03-2019 ###
|
|---|
| 58 | ============================
|
|---|
| 59 | + add st_license.txt in the root directory
|
|---|
| 60 | + src/drivers/xxx_diskio_template.[c/h], src/ff_gen_drv.[c/h], src/option/syscall.c: update the license terms to BSD-3-Clause
|
|---|
| 61 |
|
|---|
| 62 | ### V2.1.1/25-01-2019 ###
|
|---|
| 63 | ============================
|
|---|
| 64 | + sd_diskio_dma_rtos_template.c
|
|---|
| 65 | - Fix memory leak in the SD_Initialize()
|
|---|
| 66 | - Disable the ENABLE_SD_DMA_CACHE_MAINTENANCE flag by default to fix a build error for CM4
|
|---|
| 67 | - include correct diskio header file
|
|---|
| 68 |
|
|---|
| 69 | + sd_diskio_dma_template.c
|
|---|
| 70 | - Correct the SD_read() function when enabling the ENABLE_SCRATCH_BUFFER flag
|
|---|
| 71 |
|
|---|
| 72 | + sd_diskio_dma_rtos_template.c sd_diskio_dma_template.c
|
|---|
| 73 | - fix potential overflow when using SysTick.
|
|---|
| 74 |
|
|---|
| 75 |
|
|---|
| 76 | ### V2.1.0/21-09-2018 ###
|
|---|
| 77 | ============================
|
|---|
| 78 | + ff.c
|
|---|
| 79 | - back-port a fix from 0.13, to correct an issue when using multi-threading
|
|---|
| 80 | access in the same device due to a missing semaphore lock when calling
|
|---|
| 81 | disk_status() API.
|
|---|
| 82 |
|
|---|
| 83 | + sd_diskio_dma_rtos_template.c
|
|---|
| 84 | - Add support to CMSIS-RTOS V2 API
|
|---|
| 85 |
|
|---|
| 86 | + sd_diskio_dma_rtos_template.c sd_diskio_dma_template.c
|
|---|
| 87 | - Add a compile flag "ENABLE_SCRATCH_BUFFER" to avoid misaligned access
|
|---|
| 88 | caused buffer alignment constraint in some DMA versions.
|
|---|
| 89 | - Add BSP_SD_ErrorCallback() and BSP_SD_AbortCallback() template functions.
|
|---|
| 90 |
|
|---|
| 91 | ### V2.0.2/17-November-2017 ###
|
|---|
| 92 | ============================
|
|---|
| 93 | + sdram_diskio_template.c sram_diskio_template.c
|
|---|
| 94 | Fix wrong buffer size in the (SRAM/SDRAM)DISK_read(), (SRAM/SDRAM)DISK_write()
|
|---|
| 95 |
|
|---|
| 96 | + sd_diskio_template.c
|
|---|
| 97 | - define a generic 'SD_TIMEOUT' based on the BSP drivers defines. This fixes
|
|---|
| 98 | a build issue when using this driver with the Adafruit shield.
|
|---|
| 99 |
|
|---|
| 100 | + sd_diskio_dma_rtos_template.c
|
|---|
| 101 | - add a check via osKernelRunning(), to avoid runtime errors due to
|
|---|
| 102 | osMessageXXX calls that needs the "osKernelStart()" call done first.
|
|---|
| 103 |
|
|---|
| 104 | + sd_diskio_dma_template.c, sd_diskio_dma_rtos_template.c
|
|---|
| 105 | - fix wrong address alignment when calling SCB_InvalidateDCache_by_Addr() and
|
|---|
| 106 | SCB_CleanDCache_by_Addr(), the address has to be 32-Byte and not
|
|---|
| 107 | 32-bit aligned.
|
|---|
| 108 |
|
|---|
| 109 | - fix BSP_SD_ReadCpltCallback() and BSP_SD_WriteCpltCallback() prototypes by
|
|---|
| 110 | adding 'void' as argument to avoid IAR compiler errors
|
|---|
| 111 |
|
|---|
| 112 |
|
|---|
| 113 | + sd_diskio_template.c sd_diskio_dma_template.c, sd_diskio_dma_rtos_template.c
|
|---|
| 114 | - add the flag "DISABLE_SD_INIT" to give the user the choice to initialize the SD
|
|---|
| 115 | either in the application or in the FatFs diskio driver.
|
|---|
| 116 |
|
|---|
| 117 | + all xxx_diskio_template.c
|
|---|
| 118 | - fix GET_BLOCK_SIZE ioctl call; the return value is in unit of sectors.
|
|---|
| 119 |
|
|---|
| 120 |
|
|---|
| 121 | ### V2.0.1/10-July-2017 ###
|
|---|
| 122 | ============================
|
|---|
| 123 | + sd_diskio_dma_template.c, sd_diskio_dma_rtos_template.c
|
|---|
| 124 | - add the flag "ENABLE_SD_DMA_CACHE_MAINTENANCE", to enable cache maintenance at each read write operation.
|
|---|
| 125 | This is useful for STM32F7/STM32H7 based platforms when using a cachable memory region.
|
|---|
| 126 | - add timeout checks in SD_Read() and SD_Write() to give the control back to the application to decide in case of errors.
|
|---|
| 127 |
|
|---|
| 128 | + ff_gen_drv.c: fix a wrong check that causes an out of bound array access.
|
|---|
| 129 |
|
|---|
| 130 |
|
|---|
| 131 | ### V2.0.0/07-March-2017 ###
|
|---|
| 132 | ============================
|
|---|
| 133 | + Upgrade to use FatFS R0.12c. The R0.12c breaks the API compatibility with R0.11b.
|
|---|
| 134 | - f_mkfs() API has a new signature.
|
|---|
| 135 | - The _CODE_PAGE got new values.
|
|---|
| 136 | - For more details check the files (doc/updates.txt) and the following urls:
|
|---|
| 137 | http://elm-chan.org/fsw/ff/en/mkfs.html
|
|---|
| 138 | http://elm-chan.org/fsw/ff/en/config.html
|
|---|
| 139 |
|
|---|
| 140 | + Add USB, RAMDISK and uSD template drivers under src/drivers.
|
|---|
| 141 | - The diskio drivers aren't part of fatfs anymore, they are just templates instead.
|
|---|
| 142 | - User has to copy the suitable template .c/.h file under the project, rename them by
|
|---|
| 143 | removing the "_template" suffix then link them into the final application.
|
|---|
| 144 | - The diskio driver .c/.h files have to be edited according to the used platform.
|
|---|
| 145 |
|
|---|
| 146 | + Define the macros "ff_malloc" and "ff_free" in the ff_conf_template.h and use
|
|---|
| 147 | them in the syscall.c instead of direct calls to stdlib malloc and free functions.
|
|---|
| 148 | + Define the "__weak" attribute in diskio.c for the GNU GCC compiler
|
|---|
| 149 |
|
|---|
| 150 |
|
|---|
| 151 | ### V1.4.0/09-September-2016 ###
|
|---|
| 152 | ================================
|
|---|
| 153 | + Upgrade to use FatFs R0.12b.
|
|---|
| 154 | + ff_conf.h: remove the use of define "_USE_BUFF_WO_ALIGNMENT".
|
|---|
| 155 |
|
|---|
| 156 |
|
|---|
| 157 | ### V1.3.0/08-May-2015 ###
|
|---|
| 158 | ==========================
|
|---|
| 159 | + Upgrade to use FatFs R0.11.
|
|---|
| 160 | + Add new APIs FATFS_LinkDriverEx() and FATFS_UnLinkDriverEx() to manage USB Key Disk having
|
|---|
| 161 | multi-lun capability. These APIs are equivalent to FATFS_LinkDriver() and FATFS_UnLinkDriver()
|
|---|
| 162 | with "lun" parameter set to 0.
|
|---|
| 163 | + ff_conf.h: add new define "_USE_BUFF_WO_ALIGNMENT".
|
|---|
| 164 | This option is available only for usbh diskio interface and allow to disable
|
|---|
| 165 | the management of the unaligned buffer.
|
|---|
| 166 | When STM32 USB OTG HS or FS IP is used with internal DMA enabled, this define
|
|---|
| 167 | must be set to 0 to align data into 32bits through an internal scratch buffer
|
|---|
| 168 | before being processed by the DMA . Otherwise (DMA not used), this define must
|
|---|
| 169 | be set to 1 to avoid Data alignment and improve the performance.
|
|---|
| 170 | Please note that if _USE_BUFF_WO_ALIGNMENT is set to 1 and an unaligned 32bits
|
|---|
| 171 | buffer is forwarded to the FatFs Write/Read functions, an error will be returned.
|
|---|
| 172 | (0: default value or 1: unaligned buffer return an error).
|
|---|
| 173 |
|
|---|
| 174 |
|
|---|
| 175 | + Important note:
|
|---|
| 176 | For application code based on previous FatFs version; when moving to R0.11
|
|---|
| 177 | the changes that need to be done is to update ffconf.h file, taking
|
|---|
| 178 | ffconf_template.h file as reference.
|
|---|
| 179 |
|
|---|
| 180 |
|
|---|
| 181 | ### V1.2.1/20-November-2014 ###
|
|---|
| 182 | ===============================
|
|---|
| 183 | + Disk I/O drivers; change count argument type from BYTE to UINT
|
|---|
| 184 |
|
|---|
| 185 | + Important note:
|
|---|
| 186 | For application code based on previous FatFs version; when moving to R0.10b
|
|---|
| 187 | the only change that need to be done is to update ffconf.h file, taking
|
|---|
| 188 | ffconf_template.h file as reference.
|
|---|
| 189 |
|
|---|
| 190 |
|
|---|
| 191 | ### V1.2.0/04-November-2014 ###
|
|---|
| 192 | ===============================
|
|---|
| 193 | + Upgrade to use FatFs R0.10b.
|
|---|
| 194 | + diskio.c: update disk_read() and disk_write() argument's type.
|
|---|
| 195 |
|
|---|
| 196 | + Important note:
|
|---|
| 197 | For application code based on previous FatFs version; when moving to R0.10b
|
|---|
| 198 | the only change that need to be done is to update ffconf.h file, taking
|
|---|
| 199 | ffconf_template.h file as reference.
|
|---|
| 200 |
|
|---|
| 201 |
|
|---|
| 202 | ### V1.1.1/12-September-2014 ###
|
|---|
| 203 | ================================
|
|---|
| 204 | + ff_gen_drv.c: Update the Disk_drvTypeDef disk variable initialization to avoid
|
|---|
| 205 | warnings detected with Atollic TrueSTUDIO Complier.
|
|---|
| 206 |
|
|---|
| 207 |
|
|---|
| 208 | ### V1.1.0/22-April-2014 ###
|
|---|
| 209 | ============================
|
|---|
| 210 | + Update sd_diskio to use SD BSP in polling mode instead of DMA mode (the scratch
|
|---|
| 211 | buffer needed for DMA alignment is removed as well).
|
|---|
| 212 | + diskio.c and ff_gen_drv.c/.h: update to prevent multiple initialization.
|
|---|
| 213 |
|
|---|
| 214 |
|
|---|
| 215 | ### V1.0.0/18-February-2014 ###
|
|---|
| 216 | ===============================
|
|---|
| 217 | + First R0.10 customized version for STM32Cube solution.
|
|---|
| 218 |
|
|---|
| 219 |
|
|---|
| 220 | * <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
|
|---|
| 221 | */
|
|---|
