Skip to content

Commit

Permalink
Updated: Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SquadQuiz committed Apr 23, 2024
1 parent c4e2e05 commit bfdefe9
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ void MX_SDMMC1_SD_Init(void)
---
## Reference
[STM32CubeF7/Projects/STM32746G-Discovery/Applications/FatFs/FatFs_uSD](https://github.com/STMicroelectronics/STM32CubeF7/tree/master/Projects/STM32746G-Discovery/Applications/FatFs/FatFs_uSD)
[How to create a File System on a SD card using STM32CubeIDE](https://community.st.com/t5/stm32-mcus/how-to-create-a-file-system-on-a-sd-card-using-stm32cubeide/ta-p/49830)
[RM0385 Reference manual](https://www.st.com/resource/en/reference_manual/rm0385-stm32f75xxx-and-stm32f74xxx-advanced-armbased-32bit-mcus-stmicroelectronics.pdf)
[UM1721 User manual Developing applications on STM32Cube™ with FatFs](https://www.st.com/resource/en/user_manual/um1721-developing-applications-on-stm32cube-with-fatfs-stmicroelectronics.pdf)
Expand Down
109 changes: 109 additions & 0 deletions doc/readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
/**
@page FatFs_uSD FatFs with uSD card drive application

@verbatim
******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
* @file FatFs/FatFs_uSD/readme.txt
* @author MCD Application Team
* @brief Description of the FatFs with uSD card drive application.
******************************************************************************
* @attention
*
* Copyright (c) 2016 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
@endverbatim

@par Application Description

This application provides a description on how to use STM32Cube firmware with FatFs
middleware component as a generic FAT file system module, in order to develop an
application exploiting FatFs offered features with microSD drive configuration.

At the beginning of the main program the HAL_Init() function is called to reset
all the peripherals, initialize the Flash interface and the systick.
Then the SystemClock_Config() function is used to configure the system
clock (SYSCLK) to run at 216 MHz.

- Link the uSD disk I/O driver;
- Register the file system object (mount) to the FatFs module for the uSD drive;
- Create a FAT file system (format) on the uSD drive;
- Create and Open new text file object with write access;
- Write data to the text file;
- Close the open text file;
- Open text file object with read access;
- Read back data from the text file;
- Close the open text file;
- Check on read data from text file;
- Unlink the uSD disk I/O driver.

It is worth noting that the application manages any error occurred during the
access to FAT volume, when using FatFs APIs. Otherwise, user can check if the
written text file is available on the uSD card.

It is possible to fine tune needed FatFs features by modifying defines values
in FatFs configuration file �ffconf.h� available under the project includes
directory, in a way to fit the application requirements.

STM32 Discovery board's LEDs can be used to monitor the application status:
- LED1 is ON when the application runs successfully.
- LED1 toggles when any error occurs.

For more details about FatFs implementation on STM32Cube, please refer to UM1721 "Developing Applications
on STM32Cube with FatFs".


@par Keywords

FatFS, SDMMC, SD Card, File system, FAT Volume, Format, Mount, Read, Write,

@Note�If the user code size exceeds the DTCM-RAM size or starts from internal cacheable memories (SRAM1 and SRAM2),that is shared between several processors,
�����then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
������The address and the size of cacheable buffers (shared between CPU and other masters) must be properly updated to be aligned to cache line size (32 bytes).

@Note It is recommended to enable the cache and maintain its coherence, but depending on the use case
����� It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
������In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
������Even though the user must manage the cache coherence for read accesses.
������Please refer to the AN4838 �Managing memory protection unit (MPU) in STM32 MCUs�
������Please refer to the AN4839 �Level 1 cache on STM32F7 Series�

@par Directory contents

- FatFs/FatFs_uSD/Inc/stm32f7xx_hal_conf.h HAL configuration file
- FatFs/FatFs_uSD/Inc/stm32f7xx_it.h Interrupt handlers header file
- FatFs/FatFs_uSD/Inc/main.h Main program header file
- FatFs/FatFs_uSD/Inc/ffconf.h FAT file system module configuration file
- FatFs/FatFs_uSD/Src/sd_diskio.h SD diskio header file
- FatFs/FatFs_uSD/Src/stm32f7xx_it.c Interrupt handlers
- FatFs/FatFs_uSD/Src/main.c Main program
- FatFs/FatFs_uSD/Src/system_stm32f7xx.c STM32F7xx system clock configuration file
- FatFs/FatFs_uSD/Src/sd_diskio.c SD diskio source file


@par Hardware and Software environment

- This application runs on STM32F746xx devices.

- This example has been tested with STMicroelectronics STM32746G-DISCOVERY
boards RevB and can be easily tailored to any other supported device.


- STM32746G-DISCOVERY Set-up
- Connect a uSD Card to the MSD connector (CN3).


@par How to use it ?

In order to make the program work, you must do the following :
- Open your preferred toolchain
- Rebuild all files and load your image into target memory
- Run the example


*/

0 comments on commit bfdefe9

Please sign in to comment.