mirror of
https://github.com/STMicroelectronics/STM32CubeF4.git
synced 2025-05-01 22:17:30 +08:00
121 lines
5.7 KiB
Plaintext
121 lines
5.7 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.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© Copyright (c) 2017 STMicroelectronics International N.V.
|
|
* All rights reserved.</center></h2>
|
|
*
|
|
* 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 enter and exit low-power mode with CMSIS RTOS API.
|
|
|
|
This example creates two threads.
|
|
|
|
+ A 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.
|
|
|
|
In this example, not used GPIO's are configured to analog, this help to 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 LED 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".
|
|
|
|
|
|
@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
|
|
|
|
|
|
@par Hardware and Software environment
|
|
|
|
- This example runs on STM32F446xx devices.
|
|
|
|
- This example has been tested with STM32446E-EVAL 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>© COPYRIGHT STMicroelectronics</center></h3>
|
|
*/
|