File content as of revision 172:65be27845400:

/*******************************************************************************
 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Except as contained in this notice, the name of Maxim Integrated
 * Products, Inc. shall not be used except as stated in the Maxim Integrated
 * Products, Inc. Branding Policy.
 *
 * The mere transfer of this software does not imply any licenses
 * of trade secrets, proprietary technology, copyrights, patents,
 * trademarks, maskwork rights, or any other form of intellectual
 * property whatsoever. Maxim Integrated Products, Inc. retains all
 * ownership rights.
 *
 * $Date: 2016-03-21 15:44:11 -0500 (Mon, 21 Mar 2016) $
 * $Revision: 22024 $
 *
 ******************************************************************************/

/**
 * @file wdt2.h
 * @addtogroup wdt WDT
 * @{
 * @brief This is the high level API for the watchdog timer interface module
 *
 */

#ifndef _WDT2_H
#define _WDT2_H

#include "mxc_config.h"
#include "wdt2_regs.h"
#include "mxc_assert.h"

#ifdef __cplusplus
extern "C" {
#endif

#define WDT2_FLAGS_CLEAR_ALL                 (MXC_F_WDT2_FLAGS_TIMEOUT| \
                                            MXC_F_WDT2_FLAGS_RESET_OUT)
/**
 * @enum wdt2_period_t
 * @brief WatchDog Timer 2 Period Settings
 */
typedef enum {
    WDT2_PERIOD_2_25_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_25_NANO_CLKS, /**< 2^25 WDT clocks. */
    WDT2_PERIOD_2_24_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_24_NANO_CLKS, /**< 2^24 WDT clocks. */
    WDT2_PERIOD_2_23_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_23_NANO_CLKS, /**< 2^23 WDT clocks. */
    WDT2_PERIOD_2_22_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_22_NANO_CLKS, /**< 2^22 WDT clocks. */
    WDT2_PERIOD_2_21_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_21_NANO_CLKS, /**< 2^21 WDT clocks. */
    WDT2_PERIOD_2_20_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_20_NANO_CLKS, /**< 2^20 WDT clocks. */
    WDT2_PERIOD_2_19_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_19_NANO_CLKS, /**< 2^19 WDT clocks. */
    WDT2_PERIOD_2_18_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_18_NANO_CLKS, /**< 2^18 WDT clocks. */
    WDT2_PERIOD_2_17_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_17_NANO_CLKS, /**< 2^17 WDT clocks. */
    WDT2_PERIOD_2_16_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_16_NANO_CLKS, /**< 2^16 WDT clocks. */
    WDT2_PERIOD_2_15_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_15_NANO_CLKS, /**< 2^15 WDT clocks. */
    WDT2_PERIOD_2_14_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_14_NANO_CLKS, /**< 2^14 WDT clocks. */
    WDT2_PERIOD_2_13_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_13_NANO_CLKS, /**< 2^13 WDT clocks. */
    WDT2_PERIOD_2_12_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_12_NANO_CLKS, /**< 2^12 WDT clocks. */
    WDT2_PERIOD_2_11_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_11_NANO_CLKS, /**< 2^11 WDT clocks. */
    WDT2_PERIOD_2_10_CLKS  = MXC_V_WDT2_CTRL_INT_PERIOD_2_10_NANO_CLKS, /**< 2^10 WDT clocks. */
    WDT2_PERIOD_MAX                                                     /**< Maximum Period is Max - 1 */
} wdt2_period_t;



/**
 * @brief   Initializes the NanoRing for the watchdog clock and sets watchdog in a known disabled state
 * @param   runInSleep      If non-zero, the WDT2 operates in Sleep Modes for the device,
 *                          0 disables the WDT2 during Sleep Modes.
 * @param   unlock_key      The WDT2 unlock key value, use MXC_V_WDT2_UNLOCK_KEY
 *
 * @retval  E_NO_ERROR      Watchdog Timer initialized as requested
 * @retval  E_BAD_STATE     Invalid unlock_key, WDT failed to unlock.

 */
int WDT2_Init(uint8_t runInSleep, uint8_t unlock_key);

/**
 * @brief   Configures and enables the wake-up timeout for the watchdog specified.
 *
 * @param   int_period  Interrupt period.
 * @param   unlock_key  Key to unlock watchdog.
 *
 * @retval  E_NO_ERROR  WDT2 Interrupt period enabled with the int_period time.
 * @retval  E_INVALID   Requested Period is greater than the maximum supported
 * @retval  E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
 *
 */
int WDT2_EnableWakeUp(wdt2_period_t int_period, uint8_t unlock_key);

/**
 * @brief   Disables the interrupt timeout for the watchdog specified.
 *
 * @param   unlock_key  Key to unlock watchdog.
 *
 * @retval  E_NO_ERROR  Wakeup disabled.
 * @retval  E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
 */
int WDT2_DisableWakeUp(uint8_t unlock_key);

/**
 * @brief Configures and enables the reset timeout for the watchdog specified.
 *
 * @param rst_period    Reset period.
 * @param unlock_key    Key to unlock watchdog.
 *
 * @retval  E_NO_ERROR  Reset timeout enabled with the rst_period time.
 * @retval  E_INVALID   Requested Period is greater than the maximum supported
 * @retval  E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
 */
int WDT2_EnableReset(wdt2_period_t rst_period, uint8_t unlock_key);

/**
 * @brief   Disables the reset timeout for the watchdog specified.
 *
 * @param   unlock_key    Key to unlock watchdog.
 *
 * @retval  E_NO_ERROR  Reset disabled.
 * @retval  E_BAD_STATE Invalid unlock_key, WDT failed to unlock.
 */
int WDT2_DisableReset(uint8_t unlock_key);

/**
 * @brief   Gets the watchdog interrupt flags
 *
 * @retval  0 = flags not set, non-zero = flag is set
 */
__STATIC_INLINE uint32_t WDT2_GetFlags(void)
{
    return (MXC_WDT2->flags);
}

/**
 * @brief   Clears the watchdog interrupt flags based on the mask
 *
 * @param   mask    bits to clear
 *
 */
__STATIC_INLINE void WDT2_ClearFlags(uint32_t mask)
{
    MXC_WDT2->flags = mask;
}

/**
 * @brief Starts the watchdog specified.
 *
 * @param unlock_key    Key to unlock watchdog.
 *
 * @retval E_NO_ERROR if everything is successful, error if unsuccessful.
 * @retval  E_BAD_STATE     Invalid unlock_key, WDT failed to unlock.
 */
int WDT2_Start(uint8_t unlock_key);

/**
 * @brief Feeds the watchdog specified.
 *
 * @retval E_NO_ERROR if everything is successful, error if unsuccessful.
 */
void WDT2_Reset(void);

/**
 * @brief Stops the WatchDog Timer 2.
 *
 * @param unlock_key    Key to unlock watchdog.
 *
 * @retval E_NO_ERROR if everything is successful, error if unsuccessful.
 * @retval E_BAD_STATE     Invalid unlock_key, WDT failed to unlock.
 */
int WDT2_Stop(uint8_t unlock_key);

/**
 * @brief   Determines if the watchdog is running
 *
 * @retval  0 = watchdog timer is off, non-zero = watchdog timer is on
 */
__STATIC_INLINE int WDT2_IsActive(void)
{
    return (!!(MXC_WDT2->ctrl & MXC_F_WDT2_CTRL_EN_TIMER));
}

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif /* _WDT_H */