mirror of
https://github.com/STMicroelectronics/STM32CubeF7.git
synced 2025-05-09 19:29:34 +08:00
/**
@page FatFs_USBDisk FatFs with USB disk drive application
@verbatim
******************************************************************************
* @file FatFs/FatFs_USBDisk/readme.txt
* @author MCD Application Team
* @brief Description of the FatFs with USB disk drive application
******************************************************************************
*
* Copyright (c) 2016 STMicroelectronics International N.V. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted, provided that the following conditions are met:
*
* 1. Redistribution of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of STMicroelectronics nor the names of other
* contributors to this software may be used to endorse or promote products
* derived from this software without specific written permission.
* 4. This software, including modifications and/or derivative works of this
* software, must execute solely and exclusively on microcontroller or
* microprocessor devices manufactured by or for STMicroelectronics.
* 5. Redistribution and use of this software other than as permitted under
* this license is void and will automatically terminate your rights under
* this license.
*
* THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
* RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
* SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************
@endverbatim
@par Application Description
How to use STM32Cube firmware with FatFs middleware component as a generic FAT
file system module and STM32 USB On-The-Go (OTG) host library, in both Full
Speed (FS) and High Speed (HS) modes. This example develops an application
exploiting FatFs features, with USB disk 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. The user is provided with the SystemClock_Config()
function to configure the system clock (SYSCLK) to run at 216 MHz. The Full Speed (FS) USB module uses
internally a 48-MHz clock which is coming from the main PLL..
In the High Speed (HS) mode the USB clock (60 MHz) is driven by the ULPI.
The application is based on writing a text file to a drive, and it's performed
using FatFs APIs to access the FAT volume as described in the following steps:
- Link the USB Host disk I/O driver;
- Register the file system object (mount) to the FatFs module for the USB drive;
- Create and Open new text file object with write access;
- Write data to the text file;
- Close the open text file;
- Unlink the USB Host 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 USB disk.
It is possible to fine tune needed FatFs features by modifying defines values
in FatFs configuration file <20>ffconf.h<> available under the project includes
directory, in a way to fit the application requirements.
STM32F723E-DISCOVERY's LEDs can be used to monitor the application status:
- LED6 is ON when the application runs successfully.
- LED5 is ON when any error occurs.
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
to have correct HAL operation.
For more details about FatFs implementation on STM32Cube, please refer to UM1721 "Developing Applications
on STM32Cube with FatFs".
@par Keywords
Connectivity, USB Host, FatFS, FAT, File system
@Note<74>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,
<20><><A0><A0><A0>then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
<0A><><A0><A0><A0><A0>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
<0A><><A0><A0><A0> It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
<0A><><A0><A0><A0><A0>In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
<0A><><A0><A0><A0><A0>Even though the user must manage the cache coherence for read accesses.
<0A><><A0><A0><A0><A0>Please refer to the AN4838 <20>Managing memory protection unit (MPU) in STM32 MCUs<55>
<0A><><A0><A0><A0><A0>Please refer to the AN4839 <20>Level 1 cache on STM32F7 Series<65>
@par Directory contents
- FatFs/FatFs_USBDisk/Inc/stm32f7xx_hal_conf.h HAL configuration file
- FatFs/FatFs_USBDisk/Inc/stm32f7xx_it.h Interrupt handlers header file
- FatFs/FatFs_USBDisk/Inc/main.h Main program header file
- FatFs/FatFs_USBDisk/Inc/ffconf.h FAT file system module configuration file
- FatFs/FatFs_USBDisk/Inc/usbh_diskio.h USB host diskio header file
- FatFs/FatFs_USBDisk/Inc/usb_conf.h USB host low level configuration file
- FatFs/FatFs_USBDisk/Src/stm32f7xx_it.c Interrupt handlers
- FatFs/FatFs_USBDisk/Src/main.c Main program
- FatFs/FatFs_USBDisk/Src/system_stm32f7xx.c STM32F7xx system clock configuration file
- FatFs/FatFs_USBDisk/Src/usbh_diskio.c USB host diskio file
- FatFs/FatFs_USBDisk/Src/usb_conf.c USB host low level configuration functions
@par Hardware and Software environment
- This application runs on STM32F723xx devices.
- This application has been tested with STMicroelectronics STM32F723E-Discovery
boards and can be easily tailored to any other supported device.
- STM32F723E-Discovery Set-up
- Plug the USB key into the STM32F723E-Discovery board through 'USB micro A-Male
to A-Female' cable to the connector:
- CN19: to use USB High Speed (HS)
- CN18: to use USB Full Speed (FS)
@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
- In the workspace toolbar select the project configuration:
- STM32F723E-Discovery_USBH-HS: to configure the project for STM32F7xx devices using USB OTG HS peripheral
- STM32F723E-Discovery_USBH-FS: to configure the project for STM32F7xx devices using USB OTG FS peripheral
- Run the application
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
*/