112 lines
5.8 KiB
Plaintext
112 lines
5.8 KiB
Plaintext
/**
|
||
@page MSC_Standalone USB Device Mass Storage (MSC) application
|
||
|
||
@verbatim
|
||
******************************************************************************
|
||
* @file USB_Device/MSC_Standalone/readme.txt
|
||
* @author MCD Application Team
|
||
* @brief Description of the USB Device MSC application.
|
||
******************************************************************************
|
||
*
|
||
* @attention
|
||
*
|
||
* Copyright (c) 2017 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
|
||
|
||
Use of the USB device application based on the Mass Storage Class (MSC).
|
||
|
||
This is a typical application on how to use the STM32F7xx USB OTG Device peripheral to communicate with a PC
|
||
Host using the Bulk Only Transfer (BOT) and Small Computer System Interface (SCSI) transparent commands,
|
||
while the microSD card is used as storage media. The STM32 MCU is enumerated as a MSC device using the
|
||
native PC Host MSC driver to which the STM32F769I-Discovery board is connected.
|
||
|
||
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.
|
||
|
||
When the application is started, the user has just to plug the USB cable into a PC host and the device
|
||
is automatically detected. A new removable drive appears in the system window and write/read/format
|
||
operations can be performed as with any other removable drive.
|
||
|
||
@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 the STM32Cube USB Device library, please refer to UM1734
|
||
"STM32Cube USB Device library".
|
||
|
||
|
||
@par Keywords
|
||
|
||
Connectivity, USB_Device, USB, MSC, Mass Storage, Full Speed, High Speed, BOT, SCSI, SD Card, Removable drive,
|
||
Write, Read, Format
|
||
|
||
@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><><EFBFBD><EFBFBD><EFBFBD>then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>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
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Even though the user must manage the cache coherence for read accesses.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Please refer to the AN4838 <20>Managing memory protection unit (MPU) in STM32 MCUs<55>
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Please refer to the AN4839 <20>Level 1 cache on STM32F7 Series<65>
|
||
|
||
@par Directory contents
|
||
|
||
- USB_Device/MSC_Standalone/Src/main.c Main program
|
||
- USB_Device/MSC_Standalone/Src/system_stm32f7xx.c STM32F7xx system clock configuration file
|
||
- USB_Device/MSC_Standalone/Src/stm32f7xx_it.c Interrupt handlers
|
||
- USB_Device/MSC_Standalone/Src/usbd_conf.c General low level driver configuration
|
||
- USB_Device/MSC_Standalone/Src/usbd_desc.c USB device MSC descriptor
|
||
- USB_Device/MSC_Standalone/Src/ubsd_storage.c Media Interface Layer
|
||
- USB_Device/MSC_Standalone/Inc/main.h Main program header file
|
||
- USB_Device/MSC_Standalone/Inc/stm32f7xx_it.h Interrupt handlers header file
|
||
- USB_Device/MSC_Standalone/Inc/stm32f7xx_hal_conf.h HAL configuration file
|
||
- USB_Device/MSC_Standalone/Inc/usbd_conf.h USB device driver Configuration file
|
||
- USB_Device/MSC_Standalone/Inc/usbd_desc.h USB device MSC descriptor header file
|
||
- USB_Device/MSC_Standalone/Inc/ubsd_storage.h Media Interface Layer header file
|
||
|
||
|
||
@par Hardware and Software environment
|
||
|
||
- This application runs on STM32F767xx/STM32F769xx/STM32F777xx/STM32F779xx devices.
|
||
|
||
- This application has been tested with STMicroelectronics STM32F769I-Discovery
|
||
boards and can be easily tailored to any other supported device
|
||
and development board.
|
||
|
||
- STM32F769I-Discovery Set-up
|
||
- Insert a microSD card into the STM32F769I-Discovery uSD slot (CN5)
|
||
- Connect the STM32F769I-Discovery board to the PC through 'USB micro A-Male
|
||
to A-Male' cable to the connector:
|
||
- CN15 : to use USB High Speed (HS)
|
||
|
||
@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:
|
||
- STM32F769I-Discovery-HS: to configure the project for STM32F7xx devices using USB OTG HS peripheral
|
||
- Run the application
|
||
|
||
|
||
*/
|
||
|