diff options
Diffstat (limited to 'bsps/arm/imxrt/include/fsl_wdog.h')
| -rw-r--r-- | bsps/arm/imxrt/include/fsl_wdog.h | 305 |
1 files changed, 0 insertions, 305 deletions
diff --git a/bsps/arm/imxrt/include/fsl_wdog.h b/bsps/arm/imxrt/include/fsl_wdog.h deleted file mode 100644 index c49b39abe9..0000000000 --- a/bsps/arm/imxrt/include/fsl_wdog.h +++ /dev/null @@ -1,305 +0,0 @@ -/* - * Copyright (c) 2016, Freescale Semiconductor, Inc. - * Copyright 2016-2019 NXP - * All rights reserved. - * - * SPDX-License-Identifier: BSD-3-Clause - */ -#ifndef _FSL_WDOG_H_ -#define _FSL_WDOG_H_ - -#include "fsl_common.h" - -/*! - * @addtogroup wdog - * @{ - */ - -/******************************************************************************* - * Definitions - *******************************************************************************/ -/*! @name Driver version */ -/*@{*/ -/*! @brief Defines WDOG driver version */ -#define FSL_WDOG_DRIVER_VERSION (MAKE_VERSION(2, 1, 1)) -/*@}*/ -/*! @name Refresh sequence */ -/*@{*/ -#define WDOG_REFRESH_KEY (0xAAAA5555U) -/*@}*/ - -/*! @brief Defines WDOG work mode. */ -typedef struct _wdog_work_mode -{ - bool enableWait; /*!< continue or suspend WDOG in wait mode */ - bool enableStop; /*!< continue or suspend WDOG in stop mode */ - bool enableDebug; /*!< continue or suspend WDOG in debug mode */ -} wdog_work_mode_t; - -/*! @brief Describes WDOG configuration structure. */ -typedef struct _wdog_config -{ - bool enableWdog; /*!< Enables or disables WDOG */ - wdog_work_mode_t workMode; /*!< Configures WDOG work mode in debug stop and wait mode */ - bool enableInterrupt; /*!< Enables or disables WDOG interrupt */ - uint16_t timeoutValue; /*!< Timeout value */ - uint16_t interruptTimeValue; /*!< Interrupt count timeout value */ - bool softwareResetExtension; /*!< software reset extension */ - bool enablePowerDown; /*!< power down enable bit */ - bool enableTimeOutAssert; /*!< Enable WDOG_B timeout assertion. */ -} wdog_config_t; - -/*! - * @brief WDOG interrupt configuration structure, default settings all disabled. - * - * This structure contains the settings for all of the WDOG interrupt configurations. - */ -enum _wdog_interrupt_enable -{ - kWDOG_InterruptEnable = WDOG_WICR_WIE_MASK /*!< WDOG timeout generates an interrupt before reset*/ -}; - -/*! - * @brief WDOG status flags. - * - * This structure contains the WDOG status flags for use in the WDOG functions. - */ -enum _wdog_status_flags -{ - kWDOG_RunningFlag = WDOG_WCR_WDE_MASK, /*!< Running flag, set when WDOG is enabled*/ - kWDOG_PowerOnResetFlag = WDOG_WRSR_POR_MASK, /*!< Power On flag, set when reset is the result of a powerOnReset*/ - kWDOG_TimeoutResetFlag = WDOG_WRSR_TOUT_MASK, /*!< Timeout flag, set when reset is the result of a timeout*/ - kWDOG_SoftwareResetFlag = WDOG_WRSR_SFTW_MASK, /*!< Software flag, set when reset is the result of a software*/ - kWDOG_InterruptFlag = WDOG_WICR_WTIS_MASK /*!< interrupt flag,whether interrupt has occurred or not*/ -}; - -/******************************************************************************* - * API - *******************************************************************************/ - -#if defined(__cplusplus) -extern "C" { -#endif /* __cplusplus */ - -/*! - * @name WDOG Initialization and De-initialization. - * @{ - */ - -/*! - * @brief Initializes the WDOG configuration structure. - * - * This function initializes the WDOG configuration structure to default values. The default - * values are as follows. - * @code - * wdogConfig->enableWdog = true; - * wdogConfig->workMode.enableWait = true; - * wdogConfig->workMode.enableStop = false; - * wdogConfig->workMode.enableDebug = false; - * wdogConfig->enableInterrupt = false; - * wdogConfig->enablePowerdown = false; - * wdogConfig->resetExtension = flase; - * wdogConfig->timeoutValue = 0xFFU; - * wdogConfig->interruptTimeValue = 0x04u; - * @endcode - * - * @param config Pointer to the WDOG configuration structure. - * @see wdog_config_t - */ -void WDOG_GetDefaultConfig(wdog_config_t *config); - -/*! - * @brief Initializes the WDOG. - * - * This function initializes the WDOG. When called, the WDOG runs according to the configuration. - * - * This is an example. - * @code - * wdog_config_t config; - * WDOG_GetDefaultConfig(&config); - * config.timeoutValue = 0xffU; - * config->interruptTimeValue = 0x04u; - * WDOG_Init(wdog_base,&config); - * @endcode - * - * @param base WDOG peripheral base address - * @param config The configuration of WDOG - */ -void WDOG_Init(WDOG_Type *base, const wdog_config_t *config); - -/*! - * @brief Shuts down the WDOG. - * - * This function shuts down the WDOG. - * Watchdog Enable bit is a write one once only bit. It is not - * possible to clear this bit by a software write, once the bit is set. - * This bit(WDE) can be set/reset only in debug mode(exception). - */ -void WDOG_Deinit(WDOG_Type *base); - -/*! - * @brief Enables the WDOG module. - * - * This function writes a value into the WDOG_WCR register to enable the WDOG. - * This is a write one once only bit. It is not possible to clear this bit by a software write, - * once the bit is set. only debug mode exception. - * @param base WDOG peripheral base address - */ -static inline void WDOG_Enable(WDOG_Type *base) -{ - base->WCR |= WDOG_WCR_WDE_MASK; -} - -/*! - * @brief Disables the WDOG module. - * - * This function writes a value into the WDOG_WCR register to disable the WDOG. - * This is a write one once only bit. It is not possible to clear this bit by a software write,once the bit is set. - * only debug mode exception - * @param base WDOG peripheral base address - */ -static inline void WDOG_Disable(WDOG_Type *base) -{ - base->WCR &= ~(uint16_t)WDOG_WCR_WDE_MASK; -} - -/*! - * @brief Trigger the system software reset. - * - * This function will write to the WCR[SRS] bit to trigger a software system reset. - * This bit will automatically resets to "1" after it has been asserted to "0". - * Note: Calling this API will reset the system right now, please using it with more attention. - * - * @param base WDOG peripheral base address - */ -static inline void WDOG_TriggerSystemSoftwareReset(WDOG_Type *base) -{ - base->WCR &= ~(uint16_t)WDOG_WCR_SRS_MASK; -} - -/*! - * @brief Trigger an output assertion. - * - * This function will write to the WCR[WDA] bit to trigger WDOG_B signal assertion. - * The WDOG_B signal can be routed to external pin of the chip, the output pin will turn to - * assertion along with WDOG_B signal. - * Note: The WDOG_B signal will remain assert until a power on reset occurred, so, please - * take more attention while calling it. - * - * @param base WDOG peripheral base address - */ -static inline void WDOG_TriggerSoftwareSignal(WDOG_Type *base) -{ - base->WCR &= ~(uint16_t)WDOG_WCR_WDA_MASK; -} - -/*! - * @brief Enables the WDOG interrupt. - * - *This bit is a write once only bit. Once the software does a write access to this bit, it will get - *locked and cannot be reprogrammed until the next system reset assertion - * - * @param base WDOG peripheral base address - * @param mask The interrupts to enable - * The parameter can be combination of the following source if defined. - * @arg kWDOG_InterruptEnable - */ -static inline void WDOG_EnableInterrupts(WDOG_Type *base, uint16_t mask) -{ - base->WICR |= mask; -} - -/*! - * @brief Gets the WDOG all reset status flags. - * - * This function gets all reset status flags. - * - * @code - * uint16_t status; - * status = WDOG_GetStatusFlags (wdog_base); - * @endcode - * @param base WDOG peripheral base address - * @return State of the status flag: asserted (true) or not-asserted (false).@see _wdog_status_flags - * - true: a related status flag has been set. - * - false: a related status flag is not set. - */ -uint16_t WDOG_GetStatusFlags(WDOG_Type *base); - -/*! - * @brief Clears the WDOG flag. - * - * This function clears the WDOG status flag. - * - * This is an example for clearing the interrupt flag. - * @code - * WDOG_ClearStatusFlags(wdog_base,KWDOG_InterruptFlag); - * @endcode - * @param base WDOG peripheral base address - * @param mask The status flags to clear. - * The parameter could be any combination of the following values. - * kWDOG_TimeoutFlag - */ -void WDOG_ClearInterruptStatus(WDOG_Type *base, uint16_t mask); - -/*! - * @brief Sets the WDOG timeout value. - * - * This function sets the timeout value. - * This function writes a value into WCR registers. - * The time-out value can be written at any point of time but it is loaded to the counter at the time - * when WDOG is enabled or after the service routine has been performed. - * - * @param base WDOG peripheral base address - * @param timeoutCount WDOG timeout value; count of WDOG clock tick. - */ -static inline void WDOG_SetTimeoutValue(WDOG_Type *base, uint16_t timeoutCount) -{ - base->WCR = (base->WCR & (uint16_t)~WDOG_WCR_WT_MASK) | WDOG_WCR_WT(timeoutCount); -} - -/*! - * @brief Sets the WDOG interrupt count timeout value. - * - * This function sets the interrupt count timeout value. - * This function writes a value into WIC registers which are wirte-once. - * This field is write once only. Once the software does a write access to this field, it will get locked - * and cannot be reprogrammed until the next system reset assertion. - * @param base WDOG peripheral base address - * @param timeoutCount WDOG timeout value; count of WDOG clock tick. - */ -static inline void WDOG_SetInterrputTimeoutValue(WDOG_Type *base, uint16_t timeoutCount) -{ - base->WICR = (base->WICR & ~(uint16_t)WDOG_WICR_WICT_MASK) | WDOG_WICR_WICT(timeoutCount); -} - -/*! - * @brief Disable the WDOG power down enable bit. - * - * This function disable the WDOG power down enable(PDE). - * This function writes a value into WMCR registers which are wirte-once. - * This field is write once only. Once software sets this bit it cannot be reset until the next system reset. - * @param base WDOG peripheral base address - */ -static inline void WDOG_DisablePowerDownEnable(WDOG_Type *base) -{ - base->WMCR &= ~(uint16_t)WDOG_WMCR_PDE_MASK; -} - -/*! - * @brief Refreshes the WDOG timer. - * - * This function feeds the WDOG. - * This function should be called before the WDOG timer is in timeout. Otherwise, a reset is asserted. - * - * @param base WDOG peripheral base address - */ -void WDOG_Refresh(WDOG_Type *base); -/*@}*/ - -#if defined(__cplusplus) -} -#endif /* __cplusplus */ - -/*! @}*/ - -#endif /* _FSL_WDOG_H_ */ |