mirror of
https://github.com/STMicroelectronics/STM32CubeF7.git
synced 2025-05-05 19:30:14 +08:00
/** @page FatFs_USBDisk_RTOS FatFs with USB disk drive in RTOS mode application @verbatim ******************** (C) COPYRIGHT 2016 STMicroelectronics ******************* * @file FatFs/FatFs_USBDisk_RTOS/readme.txt * @author MCD Application Team * @brief Description of the FatFs with USB disk drive in RTOS mode application ****************************************************************************** * * Copyright (c) 2017 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, FreeRTOS as an RTOS module based on using CMSIS-OS wrapping layer common APIs, 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 a USB disk drive in RTOS mode 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 a specific output of two PLLs: main PLL or PLL SAI. In the High Speed (HS) mode the USB clock (60 MHz) is driven by the ULPI. The 48 MHz clock for the USB FS can be derived from one of the two following sources: <20> PLL clock (clocked by the HSE): If the USB uses the PLL as clock source, the PLL VCO clock must be programmed to output 336 MHz frequency (USBCLK = PLLVCO/PLLQ). <20> PLLSAI clock (clocked by the HSE): If the USB uses the PLLSAI as clock source, the PLLSAI VCO clock must be programmed to output 384 MHz frequency (USBCLK = PLLSAIVCO/PLLSAIP). The application is based on writing a text file to a drive, it creates a normal priority thread, that executes a Mass Storage Class routine 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; - 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 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. STM32 Eval board's LEDs can be used to monitor the application status: - LED1 is ON when the application runs successfully. - LED3 is ON when any error occurs. @note The FreeRTOS heap size configTOTAL_HEAP_SIZE defined in FreeRTOSConfig.h is set accordingly to the OS resources memory requirements of the application with +10% margin and rounded to the upper Kbyte boundary. @note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds) based on variable incremented in HAL time base ISR. This implies that if HAL_Delay() is called from a peripheral ISR process, then the HAL time base interrupt must have higher priority (numerically lower) than the peripheral interrupt. Otherwise the caller ISR process will be blocked. To change the HAL time base interrupt priority you have to use HAL_NVIC_SetPriority() function. @note The application needs to ensure that the HAL 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, Middleware, USB Host, FatFS, FAT, File system, Full Speed, High Speed, HS-IN-FS, FreeRTOS, RTOS @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_MultipleAccess_RTOS/Inc/stm32f7xx_hal_conf.h HAL configuration file - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Inc/stm32f7xx_it.h Interrupt handlers header file - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Inc/main.h Main program header file - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Inc/usbh_dikio.h FATFS usb host diskio driver header file - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Inc/usb_conf.h USB host low level configuration file - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Inc/ffconf.h FAT file system module configuration file - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Inc/FreeRTOSConfig.h FreeRTOS configuration file - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Src/stm32f7xx_it.c Interrupt handlers - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Src/main.c Main program - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Src/system_stm32f7xx.c STM32F7xx system clock configuration file - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Src/usbh_dikio.c FATFS usb host diskio driver implementation - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Src/usb_conf.c USB host low level configuration functions - FatFs/FatFs_USBDisk_MultipleAccess_RTOS/Src/stm32f7xx_hal_timebase_tim.c HAL TIM timebase functions @par Hardware and Software environment - This application runs on STM32F756xx/STM32F746xx devices. - This application has been tested with STMicroelectronics STM327x6G_EVAL evaluation boards and can be easily tailored to any other supported device and development board. - STM327x6G_EVAL Set-up - Plug the USB key into the STM327x6G_EVAL board through 'USB micro A-Male to A-Female' cable to the connector: - CN8 : to use USB High Speed (HS) with embedded PHY(U8) - CN13: to use USB Full Speed (FS) Please ensure that jumper JP8 is not fitted. - CN14: to use USB HS-IN-FS. Note that some FS signals are shared with the HS ULPI bus, so some PCB rework is needed. For more details, refer to section USB OTG2 HS & FS in STM327x6G_EVAL user manual for details. - Ensure that JP24 is in position 2-3 to use LED1. - Ensure that JP23 is in position 2-3 to use LED3. @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 - STM327x6G_EVAL_USBH-HS: to configure the project for STM32F7xx devices using USB OTG HS peripheral - STM327x6G_EVAL_USBH-FS: to configure the project for STM32F7xx devices using USB OTG FS peripheral - STM327x6G_EVAL_USBH-HS-IN-FS: to configure the project for STM32F7xx devices and use USB OTG HS peripheral In FS (using embedded PHY). - Run the application * <h3><center>© COPYRIGHT STMicroelectronics</center></h3> */