Mercurial > public > ostc4
view Common/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_ll_wwdg.h @ 771:29d9b5bc7946
Revised automatic setpoint change. The proposed approach is essentially the approach used by most controllers of eCCR ('upshift' on descent, 'downshift' on ascent), so that the OSTC4 when used as a backup computer for eCCR will make the changes at the same time as the eCCR itself.
author | heinrichsweikamp |
---|---|
date | Fri, 21 Apr 2023 09:48:23 +0200 |
parents | c78bcbd5deda |
children |
line wrap: on
line source
/** ****************************************************************************** * @file stm32f4xx_ll_wwdg.h * @author MCD Application Team * @brief Header file of WWDG LL module. ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions 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 its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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 __STM32F4xx_LL_WWDG_H #define __STM32F4xx_LL_WWDG_H #ifdef __cplusplus extern "C" { #endif /* Includes ------------------------------------------------------------------*/ #include "stm32f4xx.h" /** @addtogroup STM32F4xx_LL_Driver * @{ */ #if defined (WWDG) /** @defgroup WWDG_LL WWDG * @{ */ /* Private types -------------------------------------------------------------*/ /* Private variables ---------------------------------------------------------*/ /* Private constants ---------------------------------------------------------*/ /* Private macros ------------------------------------------------------------*/ /* Exported types ------------------------------------------------------------*/ /* Exported constants --------------------------------------------------------*/ /** @defgroup WWDG_LL_Exported_Constants WWDG Exported Constants * @{ */ /** @defgroup WWDG_LL_EC_IT IT Defines * @brief IT defines which can be used with LL_WWDG_ReadReg and LL_WWDG_WriteReg functions * @{ */ #define LL_WWDG_CFR_EWI WWDG_CFR_EWI /** * @} */ /** @defgroup WWDG_LL_EC_PRESCALER PRESCALER * @{ */ #define LL_WWDG_PRESCALER_1 (uint32_t)0x00000000U /*!< WWDG counter clock = (PCLK1/4096)/1 */ #define LL_WWDG_PRESCALER_2 WWDG_CFR_WDGTB_0 /*!< WWDG counter clock = (PCLK1/4096)/2 */ #define LL_WWDG_PRESCALER_4 WWDG_CFR_WDGTB_1 /*!< WWDG counter clock = (PCLK1/4096)/4 */ #define LL_WWDG_PRESCALER_8 (WWDG_CFR_WDGTB_0 | WWDG_CFR_WDGTB_1) /*!< WWDG counter clock = (PCLK1/4096)/8 */ /** * @} */ /** * @} */ /* Exported macro ------------------------------------------------------------*/ /** @defgroup WWDG_LL_Exported_Macros WWDG Exported Macros * @{ */ /** @defgroup WWDG_LL_EM_WRITE_READ Common Write and read registers macros * @{ */ /** * @brief Write a value in WWDG register * @param __INSTANCE__ WWDG Instance * @param __REG__ Register to be written * @param __VALUE__ Value to be written in the register * @retval None */ #define LL_WWDG_WriteReg(__INSTANCE__, __REG__, __VALUE__) WRITE_REG(__INSTANCE__->__REG__, (__VALUE__)) /** * @brief Read a value in WWDG register * @param __INSTANCE__ WWDG Instance * @param __REG__ Register to be read * @retval Register value */ #define LL_WWDG_ReadReg(__INSTANCE__, __REG__) READ_REG(__INSTANCE__->__REG__) /** * @} */ /** * @} */ /* Exported functions --------------------------------------------------------*/ /** @defgroup WWDG_LL_Exported_Functions WWDG Exported Functions * @{ */ /** @defgroup WWDG_LL_EF_Configuration Configuration * @{ */ /** * @brief Enable Window Watchdog. The watchdog is always disabled after a reset. * @note It is enabled by setting the WDGA bit in the WWDG_CR register, * then it cannot be disabled again except by a reset. * This bit is set by software and only cleared by hardware after a reset. * When WDGA = 1, the watchdog can generate a reset. * @rmtoll CR WDGA LL_WWDG_Enable * @param WWDGx WWDG Instance * @retval None */ __STATIC_INLINE void LL_WWDG_Enable(WWDG_TypeDef *WWDGx) { SET_BIT(WWDGx->CR, WWDG_CR_WDGA); } /** * @brief Checks if Window Watchdog is enabled * @rmtoll CR WDGA LL_WWDG_IsEnabled * @param WWDGx WWDG Instance * @retval State of bit (1 or 0). */ __STATIC_INLINE uint32_t LL_WWDG_IsEnabled(WWDG_TypeDef *WWDGx) { return (READ_BIT(WWDGx->CR, WWDG_CR_WDGA) == (WWDG_CR_WDGA)); } /** * @brief Set the Watchdog counter value to provided value (7-bits T[6:0]) * @note When writing to the WWDG_CR register, always write 1 in the MSB b6 to avoid generating an immediate reset * This counter is decremented every (4096 x 2expWDGTB) PCLK cycles * A reset is produced when it rolls over from 0x40 to 0x3F (bit T6 becomes cleared) * Setting the counter lower then 0x40 causes an immediate reset (if WWDG enabled) * @rmtoll CR T LL_WWDG_SetCounter * @param WWDGx WWDG Instance * @param Counter 0..0x7F (7 bit counter value) * @retval None */ __STATIC_INLINE void LL_WWDG_SetCounter(WWDG_TypeDef *WWDGx, uint32_t Counter) { MODIFY_REG(WWDGx->CR, WWDG_CR_T, Counter); } /** * @brief Return current Watchdog Counter Value (7 bits counter value) * @rmtoll CR T LL_WWDG_GetCounter * @param WWDGx WWDG Instance * @retval 7 bit Watchdog Counter value */ __STATIC_INLINE uint32_t LL_WWDG_GetCounter(WWDG_TypeDef *WWDGx) { return (uint32_t)(READ_BIT(WWDGx->CR, WWDG_CR_T)); } /** * @brief Set the time base of the prescaler (WDGTB). * @note Prescaler is used to apply ratio on PCLK clock, so that Watchdog counter * is decremented every (4096 x 2expWDGTB) PCLK cycles * @rmtoll CFR WDGTB LL_WWDG_SetPrescaler * @param WWDGx WWDG Instance * @param Prescaler This parameter can be one of the following values: * @arg @ref LL_WWDG_PRESCALER_1 * @arg @ref LL_WWDG_PRESCALER_2 * @arg @ref LL_WWDG_PRESCALER_4 * @arg @ref LL_WWDG_PRESCALER_8 * @retval None */ __STATIC_INLINE void LL_WWDG_SetPrescaler(WWDG_TypeDef *WWDGx, uint32_t Prescaler) { MODIFY_REG(WWDGx->CFR, WWDG_CFR_WDGTB, Prescaler); } /** * @brief Return current Watchdog Prescaler Value * @rmtoll CFR WDGTB LL_WWDG_GetPrescaler * @param WWDGx WWDG Instance * @retval Returned value can be one of the following values: * @arg @ref LL_WWDG_PRESCALER_1 * @arg @ref LL_WWDG_PRESCALER_2 * @arg @ref LL_WWDG_PRESCALER_4 * @arg @ref LL_WWDG_PRESCALER_8 */ __STATIC_INLINE uint32_t LL_WWDG_GetPrescaler(WWDG_TypeDef *WWDGx) { return (uint32_t)(READ_BIT(WWDGx->CFR, WWDG_CFR_WDGTB)); } /** * @brief Set the Watchdog Window value to be compared to the downcounter (7-bits W[6:0]). * @note This window value defines when write in the WWDG_CR register * to program Watchdog counter is allowed. * Watchdog counter value update must occur only when the counter value * is lower than the Watchdog window register value. * Otherwise, a MCU reset is generated if the 7-bit Watchdog counter value * (in the control register) is refreshed before the downcounter has reached * the watchdog window register value. * Physically is possible to set the Window lower then 0x40 but it is not recommended. * To generate an immediate reset, it is possible to set the Counter lower than 0x40. * @rmtoll CFR W LL_WWDG_SetWindow * @param WWDGx WWDG Instance * @param Window 0x00..0x7F (7 bit Window value) * @retval None */ __STATIC_INLINE void LL_WWDG_SetWindow(WWDG_TypeDef *WWDGx, uint32_t Window) { MODIFY_REG(WWDGx->CFR, WWDG_CFR_W, Window); } /** * @brief Return current Watchdog Window Value (7 bits value) * @rmtoll CFR W LL_WWDG_GetWindow * @param WWDGx WWDG Instance * @retval 7 bit Watchdog Window value */ __STATIC_INLINE uint32_t LL_WWDG_GetWindow(WWDG_TypeDef *WWDGx) { return (uint32_t)(READ_BIT(WWDGx->CFR, WWDG_CFR_W)); } /** * @} */ /** @defgroup WWDG_LL_EF_FLAG_Management FLAG_Management * @{ */ /** * @brief Indicates if the WWDG Early Wakeup Interrupt Flag is set or not. * @note This bit is set by hardware when the counter has reached the value 0x40. * It must be cleared by software by writing 0. * A write of 1 has no effect. This bit is also set if the interrupt is not enabled. * @rmtoll SR EWIF LL_WWDG_IsActiveFlag_EWKUP * @param WWDGx WWDG Instance * @retval State of bit (1 or 0). */ __STATIC_INLINE uint32_t LL_WWDG_IsActiveFlag_EWKUP(WWDG_TypeDef *WWDGx) { return (READ_BIT(WWDGx->SR, WWDG_SR_EWIF) == (WWDG_SR_EWIF)); } /** * @brief Clear WWDG Early Wakeup Interrupt Flag (EWIF) * @rmtoll SR EWIF LL_WWDG_ClearFlag_EWKUP * @param WWDGx WWDG Instance * @retval None */ __STATIC_INLINE void LL_WWDG_ClearFlag_EWKUP(WWDG_TypeDef *WWDGx) { WRITE_REG(WWDGx->SR, ~WWDG_SR_EWIF); } /** * @} */ /** @defgroup WWDG_LL_EF_IT_Management IT_Management * @{ */ /** * @brief Enable the Early Wakeup Interrupt. * @note When set, an interrupt occurs whenever the counter reaches value 0x40. * This interrupt is only cleared by hardware after a reset * @rmtoll CFR EWI LL_WWDG_EnableIT_EWKUP * @param WWDGx WWDG Instance * @retval None */ __STATIC_INLINE void LL_WWDG_EnableIT_EWKUP(WWDG_TypeDef *WWDGx) { SET_BIT(WWDGx->CFR, WWDG_CFR_EWI); } /** * @brief Check if Early Wakeup Interrupt is enabled * @rmtoll CFR EWI LL_WWDG_IsEnabledIT_EWKUP * @param WWDGx WWDG Instance * @retval State of bit (1 or 0). */ __STATIC_INLINE uint32_t LL_WWDG_IsEnabledIT_EWKUP(WWDG_TypeDef *WWDGx) { return (READ_BIT(WWDGx->CFR, WWDG_CFR_EWI) == (WWDG_CFR_EWI)); } /** * @} */ /** * @} */ /** * @} */ #endif /* WWDG */ /** * @} */ #ifdef __cplusplus } #endif #endif /* __STM32F4xx_LL_WWDG_H */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/