/*
|
* Copyright (c) 2019-2023 Beijing Hanwei Innovation Technology Ltd. Co. and
|
* its subsidiaries and affiliates (collectly called MKSEMI).
|
*
|
* All rights reserved.
|
*
|
* 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, except as embedded into an MKSEMI
|
* integrated circuit in a product or a software update for such product,
|
* 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 MKSEMI nor the names of its contributors may be used
|
* to endorse or promote products derived from this software without
|
* specific prior written permission.
|
*
|
* 4. This software, with or without modification, must only be used with a
|
* MKSEMI integrated circuit.
|
*
|
* 5. Any software provided in binary form under this license must not be
|
* reverse engineered, decompiled, modified and/or disassembled.
|
*
|
* THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
* MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
* DISCLAIMED. IN NO EVENT SHALL MKSEMI 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.
|
*/
|
|
#ifndef MK_WDT_H_
|
#define MK_WDT_H_
|
#include "mk_common.h"
|
|
/**
|
* @addtogroup MK8000_WDT
|
* @{
|
*/
|
|
/**
|
* @brief WDT device IDs enumeration
|
*/
|
enum WDT_DEV_T
|
{
|
WDT_ID0 = 0,
|
WDT_MAX_NUM
|
};
|
|
/**
|
* @brief WDT config structure
|
*/
|
struct WDT_CFG_T
|
{
|
uint32_t timeout; /*!< Specifies the load value of the decrement counter. */
|
uint8_t rst_en; /*!< Specifies whether the reset is enabled or disabled. \n
|
This parameter shoule be one of the following values:
|
@arg true is enable
|
@arg false is disable
|
*/
|
uint8_t int_en; /*!< Specifies whether the interupt is enabled or disabled. \n
|
This parameter shoule be one of the following values:
|
@arg true is enable
|
@arg false is disable
|
*/
|
uint8_t reserved[2]; /*!< reserved */
|
drv_callback_t callback; /*!< Specifies the pointer to WDT Callback function */
|
};
|
|
/**
|
* @brief WDT handle Structure
|
*/
|
struct WDT_HANDLE_T
|
{
|
WDT_TypeDef *const base; /*!< WDT registers base address */
|
const IRQn_Type irq; /*!< WDT interupt number */
|
uint8_t wdt_started; /*!< WDT start flag */
|
uint8_t rst_en; /*!< WDT reset output switch */
|
uint8_t int_en; /*!< WDT interupt switch */
|
uint8_t reserved[1]; /*!< reserved */
|
drv_callback_t callback; /*!< Pointer to WDT Callback function */
|
};
|
|
#ifdef __cplusplus
|
extern "C" {
|
#endif
|
|
/**
|
* @brief open WDT
|
* @note both rst_en and int_en in cfg should be set to true
|
* @param[in] id WDT device ID. \n
|
* This parameter should be one of the WDT_DEV_T enum values as below
|
* @arg WDT_ID0 wdt0
|
* @param[in] config pointer to a WDT_CFG_T structure that contains the configuration information for WDT. \n
|
* @return
|
* @arg DRV_ERROR open failed
|
* @arg DEV_OK open succeed
|
*/
|
int wdt_open(enum WDT_DEV_T id, struct WDT_CFG_T *config);
|
|
/**
|
* @brief reload WDT counter
|
* @param[in] id WDT device ID. \n
|
* This parameter should be one of the WDT_DEV_T enum values as below
|
* @arg WDT_ID0 wdt0
|
* @return
|
* @arg DRV_ERROR error id
|
* @arg DEV_OK open succeed
|
*/
|
int wdt_ping(enum WDT_DEV_T id);
|
|
/**
|
* @brief close WDT
|
* @param[in] id WDT device ID. \n
|
* This parameter should be one of the WDT_DEV_T enum values as below
|
* @arg WDT_ID0 wdt0
|
* @return
|
* @arg DRV_ERROR error id
|
* @arg DEV_OK open succeed
|
*/
|
int wdt_close(enum WDT_DEV_T id);
|
|
/**
|
* @brief set WDT load value of the decrement counter
|
* @note this function will clear interupt and reload decrement counter
|
* @param[in] id WDT device ID. \n
|
* This parameter should be one of the WDT_DEV_T enum values as below
|
* @arg WDT_ID0 wdt0
|
* @param[in] time load value.
|
* @return
|
* @arg DRV_ERROR error id or WDT is not opened
|
* @arg DEV_OK open succeed
|
*/
|
int wdt_set_time(enum WDT_DEV_T id, uint32_t time);
|
|
/**
|
* @brief get WDT current value of the decrement counter
|
* @param[in] id WDT device ID. \n
|
* This parameter should be one of the WDT_DEV_T enum values as below
|
* @arg WDT_ID0 wdt0
|
* @param[out] time Pointer to timeleft.
|
* @return
|
* @arg DRV_ERROR error id or WDT is not opened
|
* @arg DEV_OK open succeed
|
*/
|
int wdt_time_left(enum WDT_DEV_T id, uint32_t *time);
|
|
/**
|
* @brief This function handles WDT interrupt.
|
*/
|
void WDT_IRQHandler(void);
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
/**
|
* @}
|
*/
|
|
#endif /* MK_WDT_H_ */
|
