wdt.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
/* Define to prevent redundant inclusion */
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_WDT_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_WDT_H_
 
#ifdef __CC_ARM
#pragma diag_suppress 66 // enumeration value is out of int range
#endif
 
/* **** Includes **** */
#include <stdint.h>
#include "mxc_device.h"
#include "wdt_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* **** Definitions **** */
 
typedef enum {
    MXC_WDT_PERIOD_2_31 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW31, 
    MXC_WDT_PERIOD_2_30 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW30, 
    MXC_WDT_PERIOD_2_29 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW29, 
    MXC_WDT_PERIOD_2_28 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW28, 
    MXC_WDT_PERIOD_2_27 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW27, 
    MXC_WDT_PERIOD_2_26 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW26, 
    MXC_WDT_PERIOD_2_25 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW25, 
    MXC_WDT_PERIOD_2_24 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW24, 
    MXC_WDT_PERIOD_2_23 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW23, 
    MXC_WDT_PERIOD_2_22 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW22, 
    MXC_WDT_PERIOD_2_21 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW21, 
    MXC_WDT_PERIOD_2_20 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW20, 
    MXC_WDT_PERIOD_2_19 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW19, 
    MXC_WDT_PERIOD_2_18 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW18, 
    MXC_WDT_PERIOD_2_17 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW17, 
    MXC_WDT_PERIOD_2_16 = MXC_S_WDT_CTRL_INT_LATE_VAL_WDT2POW16, 
} mxc_wdt_period_t;
 
typedef enum {
    MXC_WDT_INT_TOO_LATE = MXC_F_WDT_CTRL_INT_LATE,
    MXC_WDT_INT_TOO_SOON = MXC_F_WDT_CTRL_INT_EARLY,
} mxc_wdt_int_t;
 
typedef enum {
    MXC_WDT_RST_TOO_LATE = MXC_F_WDT_CTRL_RST_LATE,
    MXC_WDT_RST_TOO_SOON = MXC_F_WDT_CTRL_RST_EARLY,
} mxc_wdt_rst_t;
 
typedef enum {
    MXC_WDT_COMPATIBILITY = 0,
    MXC_WDT_WINDOWED = 1,
} mxc_wdt_mode_t;
 
typedef enum {
    MXC_WDT_PCLK = 0,
    MXC_WDT_IPO_CLK,
    MXC_WDT_IBRO_CLK,
    MXC_WDT_INRO_CLK
} mxc_wdt_clock_t;
 
typedef struct {
    mxc_wdt_mode_t mode; 
    mxc_wdt_period_t upperResetPeriod; 
    mxc_wdt_period_t lowerResetPeriod; 
    mxc_wdt_period_t upperIntPeriod; 
    mxc_wdt_period_t lowerIntPeriod; 
} mxc_wdt_cfg_t;
/* **** Function Prototypes **** */
 
int MXC_WDT_Init(mxc_wdt_regs_t *wdt, mxc_wdt_cfg_t *cfg);
 
int MXC_WDT_Shutdown(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_SetIntPeriod(mxc_wdt_regs_t *wdt, mxc_wdt_cfg_t *cfg);
 
void MXC_WDT_SetResetPeriod(mxc_wdt_regs_t *wdt, mxc_wdt_cfg_t *cfg);
 
void MXC_WDT_Enable(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_Disable(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_EnableInt(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_DisableInt(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_EnableReset(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_DisableReset(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_ResetTimer(mxc_wdt_regs_t *wdt);
 
int MXC_WDT_GetResetFlag(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_ClearResetFlag(mxc_wdt_regs_t *wdt);
 
int MXC_WDT_GetIntFlag(mxc_wdt_regs_t *wdt);
 
void MXC_WDT_ClearIntFlag(mxc_wdt_regs_t *wdt);
 
int MXC_WDT_SetClockSource(mxc_wdt_regs_t *wdt, mxc_wdt_clock_t clock_source);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_WDT_H_