1 /******************************************************************************
2  *
3  * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by
4  * Analog Devices, Inc.),
5  * Copyright (C) 2023-2024 Analog Devices, Inc.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *     http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  ******************************************************************************/
20 
21 #ifndef LIBRARIES_PERIPHDRIVERS_SOURCE_WDT_WDT_REVB_H_
22 #define LIBRARIES_PERIPHDRIVERS_SOURCE_WDT_WDT_REVB_H_
23 
24 /* **** Includes **** */
25 #include "mxc_device.h"
26 #include "mxc_errors.h"
27 #include "mxc_assert.h"
28 #include "mxc_sys.h"
29 #include "wdt_revb_regs.h"
30 
31 /* **** Definitions **** */
32 typedef enum {
33     MXC_WDT_REVB_PERIOD_2_31 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW31, ///< Period 2^31
34     MXC_WDT_REVB_PERIOD_2_30 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW30, ///< Period 2^30
35     MXC_WDT_REVB_PERIOD_2_29 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW29, ///< Period 2^29
36     MXC_WDT_REVB_PERIOD_2_28 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW28, ///< Period 2^28
37     MXC_WDT_REVB_PERIOD_2_27 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW27, ///< Period 2^27
38     MXC_WDT_REVB_PERIOD_2_26 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW26, ///< Period 2^26
39     MXC_WDT_REVB_PERIOD_2_25 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW25, ///< Period 2^25
40     MXC_WDT_REVB_PERIOD_2_24 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW24, ///< Period 2^24
41     MXC_WDT_REVB_PERIOD_2_23 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW23, ///< Period 2^23
42     MXC_WDT_REVB_PERIOD_2_22 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW22, ///< Period 2^22
43     MXC_WDT_REVB_PERIOD_2_21 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW21, ///< Period 2^21
44     MXC_WDT_REVB_PERIOD_2_20 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW20, ///< Period 2^20
45     MXC_WDT_REVB_PERIOD_2_19 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW19, ///< Period 2^19
46     MXC_WDT_REVB_PERIOD_2_18 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW18, ///< Period 2^18
47     MXC_WDT_REVB_PERIOD_2_17 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW17, ///< Period 2^17
48     MXC_WDT_REVB_PERIOD_2_16 = MXC_S_WDT_REVB_CTRL_INT_LATE_VAL_WDT2POW16, ///< Period 2^16
49 } mxc_wdt_revb_period_t;
50 
51 typedef enum {
52     MXC_WDT_REVB_COMPATIBILITY = 0,
53     MXC_WDT_REVB_WINDOWED = 1,
54 } mxc_wdt_revb_mode_t;
55 
56 typedef enum {
57     MXC_WDT_REVB_DISABLE = 0,
58     MXC_WDT_REVB_ENABLE = 1,
59 } mxc_wdt_revb_en_t;
60 
61 typedef struct {
62     mxc_wdt_revb_mode_t mode; ///< WDT mode
63     mxc_wdt_revb_period_t upperResetPeriod; ///< Reset upper limit
64     mxc_wdt_revb_period_t lowerResetPeriod; ///< Reset lower limit
65     mxc_wdt_revb_period_t upperIntPeriod; ///< Interrupt upper limit
66     mxc_wdt_revb_period_t lowerIntPeriod; ///< Interrupt lower limit
67 } mxc_wdt_revb_cfg_t;
68 
69 /* **** Functions **** */
70 int MXC_WDT_RevB_Init(mxc_wdt_revb_regs_t *wdt, mxc_wdt_revb_cfg_t *cfg);
71 void MXC_WDT_RevB_SetIntPeriod(mxc_wdt_revb_regs_t *wdt, mxc_wdt_revb_cfg_t *cfg);
72 void MXC_WDT_RevB_SetResetPeriod(mxc_wdt_revb_regs_t *wdt, mxc_wdt_revb_cfg_t *cfg);
73 void MXC_WDT_RevB_Enable(mxc_wdt_revb_regs_t *wdt);
74 void MXC_WDT_RevB_Disable(mxc_wdt_revb_regs_t *wdt);
75 void MXC_WDT_RevB_EnableInt(mxc_wdt_revb_regs_t *wdt, mxc_wdt_revb_en_t enable);
76 void MXC_WDT_RevB_EnableReset(mxc_wdt_revb_regs_t *wdt, mxc_wdt_revb_en_t enable);
77 void MXC_WDT_RevB_ResetTimer(mxc_wdt_revb_regs_t *wdt);
78 int MXC_WDT_RevB_GetResetFlag(mxc_wdt_revb_regs_t *wdt);
79 void MXC_WDT_RevB_ClearResetFlag(mxc_wdt_revb_regs_t *wdt);
80 int MXC_WDT_RevB_GetIntFlag(mxc_wdt_revb_regs_t *wdt);
81 void MXC_WDT_RevB_ClearIntFlag(mxc_wdt_revb_regs_t *wdt);
82 void MXC_WDT_RevB_SetClockSource(mxc_wdt_revb_regs_t *wdt, int clock_source);
83 
84 #endif // LIBRARIES_PERIPHDRIVERS_SOURCE_WDT_WDT_REVB_H_
85