2021-03-03 14:55:52 +01:00

102 lines
4.5 KiB
Plaintext

/**
@page FreeRTOS_LowPower FreeRTOS Low Power example
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file FreeRTOS/FreeRTOS_LowPower/readme.txt
* @author MCD Application Team
* @brief Description of the FreeRTOS Low Power example.
******************************************************************************
*
* Copyright (c) 2017 STMicroelectronics. All rights reserved.
*
* This software component is licensed by ST under Ultimate Liberty license
* SLA0044, the "License"; You may not use this file except in compliance with
* the License. You may obtain a copy of the License at:
* www.st.com/SLA0044
*
******************************************************************************
@endverbatim
@par Application Description
How to enter and exit low-power mode with CMSIS RTOS API.
This application creates two threads.
+ An Rx thread that blocks on a queue to wait for data, blinking LED each
time data is received (turning it on and then off again) before returning
to block on the queue once more.
+ A Tx thread that repeatedly enters the Blocked state for 500ms.
On exiting the blocked state, the Tx thread sends a value through the queue
to the Rx thread (causing the Rx thread to exit the blocked state and blink
the LED).
Blocking for a finite period allows the kernel to stop the tick interrupt
and place the STM32 into sleep mode - the lowest power mode possible
that allows the CPU registers and RAM to retain their state.
In this application, not used GPIOs are configured to analog. This helps reduce
the power consumption of the device.
Observed behaviour:
Every 500ms the MCU will come out of the low power state to turn the LED1 on,
then return to the low power state for 20ms before leaving the low power
state again to turn the LED1 off. This will be observed as a fast blinking
on the LED1.
The RTOS tick is suppressed while the MCU is in its low power state.
@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.
@note The FreeRTOS heap size configTOTAL_HEAP_SIZE defined in FreeRTOSConfig.h is set according to the OS resources memory requirements of the application with +10% margin and rounded to the upper Kbyte boundary.
For more details about FreeRTOS implementation on STM32Cube, please refer to UM1722 "Developing Applications
on STM32Cube with RTOS".
@note The connection of the LCD reset pin to a dedicated GPIO PK7 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 board's power off/power on or by software calling the BSP_LCD_Reset() function.
@par Keywords
RTOS, FreeRTOS, Low power, MPU
@par Directory contents
- FreeRTOS/FreeRTOS_LowPower/Inc/main.h Main program header file
- FreeRTOS/FreeRTOS_LowPower/Inc/stm32f4xx_hal_conf.h HAL Library Configuration file
- FreeRTOS/FreeRTOS_LowPower/Inc/stm32f4xx_it.h Interrupt handlers header file
- FreeRTOS/FreeRTOS_LowPower/Inc/FreeRTOSConfig.h FreeRTOS Configuration file
- FreeRTOS/FreeRTOS_LowPower/Src/main.c Main program
- FreeRTOS/FreeRTOS_LowPower/Src/stm32f4xx_it.c Interrupt handlers
- FreeRTOS/FreeRTOS_LowPower/Src/system_stm32f4xx.c STM32F4xx system clock configuration file
@par Hardware and Software environment
- This example runs on STM32F469xx and STM32F479xx devices.
- This example has been tested with STM32469I-EVAL RevC board and can be
easily tailored to any other supported device and development board.
@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
* <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
*/