This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
@page FWupgrade_Standalone USB Host Firmware Upgrade application
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file USB_Host/FWupgrade_Standalone/readme.txt
* @author MCD Application Team
* @brief Description of the USB Host Firmware Upgrade 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
The firmware upgrade application or In-Application programming (IAP) is a
feature that allows a user application to erase and write to on-chip flash
memory.
This is a typical application on how to use the STM32F469xx USB OTG Host peripheral for firmware upgrade
application or IAP, allowing user to erase and write to on-chip flash memory.
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 180 MHz. The Full Speed (FS) USB module uses
internally a 48-MHz clock which is coming from a specific output of two PLLs 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:
– PLL clock (clocked by the HSE): If the USB uses the PLL as clock source, the PLL clock must be programmed
to output 48 MHz frequency (USBCLK = PLLVCO/PLLQ).
– PLLSAI clock (clocked by the HSE): If the USB uses the PLLSAI as clock source, the PLLSAI clock must be programmed
to output 48 MHz frequency (USBCLK = PLLSAIVCO/PLLSAIP).
This application uses the USB Host to:
- DOWNLOAD: Reads the defined image (.bin) file “DOWNLOAD_FILENAME” from the thumb drive and writes it
to the embedded Flash memory.
- UPLOAD: Reads the entire embedded Flash memory and saves the contents to the defined file name
“UPLOAD_FILENAME” in the thumb drive.
- JUMP: Executes the user code at the defined user application start address “APPLICATION_ADDRESS”.
Image which must be defined from this flash address: 0x08008000
@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 Host library, please refer to UM1720
"STM32Cube USB Host library".
@par USB Library Configuration
The user application (binary file) to be loaded into the Flash memory using the firmware upgrade
application is built by the following configuration settings:
- Set the program load address to APPLICATION_ADDRESS in the toolchain linker file.
- Relocate the vector table to address APPLICATION_ADDRESS using the VECT_TAB_OFFSET definition
inside the system_stm32f4xx.c file.
@note The connection of the LCD reset pin to a dedicated GPIO PH7 instead of the STM32F469 NRST pin may cause residual display on LCD with applications/examples that do not require display.
The LCD clear can be ensured by hardware through the boards power off/power on or by software calling the BSP_LCD_Reset() function.
@par Keywords
Connectivity, USB_Host, Firmware upgrade, IAP, Binary
@par Directory contents
- USB_Host/FWupgrade_Standalone/Src/main.c Main program
- USB_Host/FWupgrade_Standalone/Src/usbh_diskio_dma.c FatFS usbh diskio driver implementation
- USB_Host/FWupgrade_Standalone/Src/system_stm32f4xx.c STM32F4xx system clock configuration file
- USB_Host/FWupgrade_Standalone/Src/stm32f4xx_it.c Interrupt handlers
- USB_Host/FWupgrade_Standalone/Src/iap_menu.c IAP State Machine
- USB_Host/FWupgrade_Standalone/Src/usbh_conf.c General low level driver configuration
- USB_Host/FWupgrade_Standalone/Src/command.c IAP command functions
- USB_Host/FWupgrade_Standalone/Src/flash_if.c Flash layer functions
- USB_Host/FWupgrade_Standalone/Src/usbh_diskio.c USB diskio interface for FatFs
- USB_Host/FWupgrade_Standalone/Inc/main.h Main program header file
- USB_Host/FWupgrade_Standalone/Inc/usbh_diskio_dma.h FatFS usbh diskio driver header file
- USB_Host/FWupgrade_Standalone/Inc/stm32f4xx_it.h Interrupt handlers header file
- USB_Host/FWupgrade_Standalone/Inc/command.h IAP command functions header file
- USB_Host/FWupgrade_Standalone/Inc/flash_if.h Flash layer functions header file
- USB_Host/FWupgrade_Standalone/Inc/stm32f4xx_hal_conf.h HAL configuration file
- USB_Host/FWupgrade_Standalone/Inc/usbh_conf.h USB Host driver Configuration file
- USB_Host/FWupgrade_Standalone/Inc/ffconf.h FatFs Module Configuration file
- USB_Host/FWupgrade_Standalone/Binary/
This folder contains images that can be loaded and executed by the FW upgrade application:
- "STM32469I_DISCOVERY_SysTick_0x08008000.bin
@par Hardware and Software environment
- This application runs on STM32F469xx devices.
- This application has been tested with STMicroelectronics STM32469I-Discovery
boards and can be easily tailored to any other supported device
and development board.
- STM32469I-Discovery Set-up
- Plug the USB key into the STM327x6G-EVAL board through 'USB micro A-Male
to A-Female' cable to the connector:
- CN13: 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
- Run the application
- To run the application, proceed as follows:
1. Load the binary image of the user program to the root directory of a USB key. You can use the
provided binary images under the USB_Host/FWupgrade_Standalone/Binary folder.
The binary should be renamed to “image.bin”.
2. Program the firmware upgrade application into the internal Flash memory.
a. Open the project (under USB_Host/FWupgrade_Standalone) with your preferred toolchain.
b. Compile and load the project into the target memory and run the project.
After the board reset and depending on the Key button state:
1. Key button pressed: The firmware upgrade application is executed.
2. Key button not pressed: A test on the user application start address will be performed and one of
the below processes is executed:
– User vector table available: User application is executed.
– User vector table not available: firmware upgrade application is executed.
During the firmware upgrade application execution, there is a continuous check on the Key button pressed
state time. Depending on the state time of the Key button, one of the following processes is executed:
- If Key Button is pressed for more than > 3 seconds at firmware startup:
UPLOAD command will be executed immediately after completed execution of the DOWNLOAD command
- If Key Button is pressed for less than< 3 seconds at firmware startup:
Only the DOWNLOAD command is executed.
STM32 Discovery boards LEDs can be used to monitor the application status:
- Red LED blinks in infinite loop
–> Error: USB key disconnected.
- Red LED blinks in infinite loop and Orange/Blue LEDs are ON
–> Error: Flash programming error.
- Red LED blinks in infinite loop and Green LED is ON
–> Error: Download done and USB key disconnected.
- Red LED blinks in infinite loop and Blue/Orange/Green LEDs are ON
–> Error: Binary file not available
- Red/Blue/Orange LEDs blink in infinite loop
–> Error: Buffer size limit, Exceed 32Kbyte
- Red LED blinks in infinite loop and Blue LED is ON
–> Error: No available Flash memory size to load the binary file.
- Red/Orange LEDs blink in infinite loop
–> Error: Flash erase error.
- Red/Blue LEDs are ON
–> UPLOAD condition verified and the user should release the Key button.
- Blue LED is ON
–> DOWNLOAD ongoing.
- Orange/Red LEDs are ON
–> DOWNLOAD done and UPLOAD is ongoing.
- Orange/Blue LEDs are ON
–> UPLOAD is ongoing.
- Red LED blinks in infinite loop and Orange LED is ON
–> USB key read out protection ON.
- Green LED is ON
–> DOWNLOAD and UPLOAD done with success; and the MCU waiting until you press the Key button before
executing the JUMP command.
*/
3d6be4bd40