Diff: Utilities/low_power_manager.h

Revision:

5:53302861bfea

Parent:

0:a0c5877bd360

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Utilities/low_power_manager.h	Mon Jul 16 20:12:42 2018 +0000
@@ -0,0 +1,178 @@
+/**
+******************************************************************************
+* @file    low_power_manager.h
+* @author  MCD Application Team
+* @version V1.1.4
+* @date    08-January-2018
+* @brief   Header for stm32xx_lpm.c module
+******************************************************************************
+* @attention
+*
+* <h2><center>&copy; Copyright (c) 2016 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.
+*
+******************************************************************************
+*/
+
+/* Define to prevent recursive inclusion -------------------------------------*/
+#ifndef __STM32_LPM__H
+#define __STM32_LPM__H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Includes ------------------------------------------------------------------*/
+/*low power manager configuration*/
+typedef enum
+{
+  LPM_APPLI_Id =    (1 << 0),
+  LPM_LIB_Id =      (1 << 1),
+  LPM_RTC_Id =      (1 << 2),
+  LPM_GPS_Id =      (1 << 3),
+  LPM_UART_RX_Id =  (1 << 4),
+  LPM_UART_TX_Id =  (1 << 5),
+} LPM_Id_t;
+
+/**
+ * Low Power Mode selected
+ */
+typedef enum
+{
+  LPM_Enable=0,
+  LPM_Disable,
+} LPM_SetMode_t;
+
+typedef enum
+{
+  LPM_SleepMode,
+  LPM_StopMode,
+  LPM_OffMode,
+} LPM_GetMode_t;
+
+/* Exported constants --------------------------------------------------------*/
+/* External variables --------------------------------------------------------*/
+/* Exported macros -----------------------------------------------------------*/
+/* Exported functions ------------------------------------------------------- */
+/**
+ * @brief  This API returns the Low Power Mode selected that will be applied when the system will enter low power mode
+ *         if there is no update between the time the mode is read with this API and the time the system enters
+ *         low power mode.
+ * @param  None
+ * @retval LPM_ModeSelected_t
+ */
+LPM_GetMode_t LPM_GetMode(void);
+/**
+ * @brief  This API notifies the low power manager if the specified user allows the Off mode or not.
+ *         When the application does not require the system clock, it enters Stop Mode if at least one user disallow
+ *         Off Mode. Otherwise, it enters Off Mode.
+ *         The default mode selection for all users is Off mode enabled
+ * @param  id: process Id
+ * @param  mode: mode selected
+ * @retval None
+ */
+void LPM_SetStopMode(LPM_Id_t id, LPM_SetMode_t mode);
+
+void LPM_SetOffMode(LPM_Id_t id, LPM_SetMode_t mode);
+/**
+ * @brief  This API shall be used by the application when there is no more code to execute so that the system may
+ *         enter low-power mode. The mode selected depends on the information received from LPM_OffModeSelection() and
+ *         LPM_SysclockRequest()
+ *         This function shall be called in critical section
+ * @param  None
+ * @retval None
+ */
+void LPM_EnterLowPower(void);
+
+/**
+ * @brief  This API is called by the low power manager in a critical section (PRIMASK bit set) to allow the
+ *         application to implement dedicated code before entering Sleep Mode
+ * @param  None
+ * @retval None
+ */
+void LPM_EnterSleepMode(void);
+
+/**
+ * @brief  This API is called by the low power manager in a critical section (PRIMASK bit set) to allow the
+ *         application to implement dedicated code before getting out from Sleep Mode
+ * @param  None
+ * @retval None
+ */
+void LPM_ExitSleepMode(void);
+
+/**
+ * @brief  This API is called by the low power manager in a critical section (PRIMASK bit set) to allow the
+ *         application to implement dedicated code before entering Stop Mode
+ * @param  None
+ * @retval None
+ */
+void LPM_EnterStopMode(void);
+
+/**
+ * @brief  This API is called by the low power manager in a critical section (PRIMASK bit set) to allow the
+ *         application to implement dedicated code before getting out from Stop Mode. This is where the application
+ *         should reconfigure the clock tree when needed
+ * @param  None
+ * @retval None
+ */
+void LPM_ExitStopMode(void);
+
+/**
+ * @brief  This API is called by the low power manager in a critical section (PRIMASK bit set) to allow the
+ *         application to implement dedicated code before entering Off mode. This is where the application could save
+ *         data in the retention memory as the RAM memory content will be lost
+ * @param  None
+ * @retval None
+ */
+void LPM_EnterOffMode(void);
+
+
+/**
+ * @brief  This API is called by the low power manager in a critical section (PRIMASK bit set) to allow the
+ *         application to implement dedicated code before getting out from Off mode. This can only happen when the
+ *         Off mode is finally not entered. In that case, the application may reverse some configurations done before
+ *         entering Off mode. When Off mode is successful, the system is reset when getting out from this low-power mode
+ * @param  None
+ * @retval None
+ */
+void LPM_ExitOffMode(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /*__STM32_LPM__H */
+
+/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
+