summaryrefslogtreecommitdiff
path: root/platform/drivers/inc/wdog_imx.h
blob: 42b982eb7bbfccca7caed5d9a791e22a9a1f4e53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*
 * Copyright (c) 2015, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o Redistributions in binary form 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.
 *
 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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 __WDOG_IMX_H__
#define __WDOG_IMX_H__

#include <stdint.h>
#include <stdbool.h>
#include <assert.h>
#include "device_imx.h"

/*!
 * @addtogroup wdog_imx_driver
 * @{
 */

/*******************************************************************************
 * Definitions
 ******************************************************************************/
/*!
 * @brief Structure to configure the running mode.
 */
typedef struct WdogModeConfig
{
    bool wdw;     /*!< true: suspend in low power wait, false: not suspend */
    bool wdt;     /*!< true: assert WDOG_B when timeout, false: not assert WDOG_B */
    bool wdbg;    /*!< true: suspend in debug mode, false: not suspend */
    bool wdzst;   /*!< true: suspend in doze and stop mode, false: not suspend */
} wdog_mode_config_t;

/*******************************************************************************
 * API
 ******************************************************************************/

#if defined(__cplusplus)
extern "C" {
#endif

/*!
 * @name WDOG State Control
 * @{
 */

/*!
 * @brief Configure WDOG funtions, call once only
 *
 * @param base WDOG base pointer.
 * @param config WDOG mode configuration
 */
static inline void WDOG_Init(WDOG_Type *base, wdog_mode_config_t *config)
{
    base->WCR |= config->wdw   ? WDOG_WCR_WDW_MASK   : 0 |
                 config->wdt   ? WDOG_WCR_WDT_MASK   : 0 |
                 config->wdbg  ? WDOG_WCR_WDBG_MASK  : 0 |
                 config->wdzst ? WDOG_WCR_WDZST_MASK : 0;
}

/*!
 * @brief Enable WDOG with timeout, call once only
 *
 * @param base WDOG base pointer.
 * @param timeout WDOG timeout ((n+1)/2 second)
 */
void WDOG_Enable(WDOG_Type *base, uint8_t timeout);

/*!
 * @brief Assert WDOG software reset signal
 *
 * @param base WDOG base pointer.
 * @param wda WDOG reset (true: assert WDOG_B, false: no impact on WDOG_B)
 * @param srs System reset (true: assert system reset WDOG_RESET_B_DEB, false: no impact on system reset)
 */
void WDOG_Reset(WDOG_Type *base, bool wda, bool srs);

/*!
 * @brief Refresh the WDOG to prevent timeout
 *
 * @param base WDOG base pointer.
 */
void WDOG_Refresh(WDOG_Type *base);

/*!
 * @brief Disable WDOG power down counter
 *
 * @param base WDOG base pointer.
 */
static inline void WDOG_DisablePowerdown(WDOG_Type *base)
{
    base->WMCR &= ~WDOG_WMCR_PDE_MASK;
}

/*@}*/

/*!
 * @name WDOG Interrupt Control
 * @{
 */

/*!
 * @brief Enable WDOG interrupt
 *
 * @param base WDOG base pointer.
 * @param time how long before the timeout must the interrupt occur (n/2 seconds).
 */
static inline void WDOG_EnableInt(WDOG_Type *base, uint8_t time)
{
    base->WICR = WDOG_WICR_WIE_MASK | WDOG_WICR_WICT(time);
}

/*!
 * @brief Check whether WDOG interrupt is pending
 *
 * @param base WDOG base pointer.
 * @return WDOG interrupt status (true: pending, false: not pending)
 */
static inline bool WDOG_IsIntPending(WDOG_Type *base)
{
    return (bool)(base->WICR & WDOG_WICR_WTIS_MASK);
}

/*!
 * @brief Clear WDOG interrupt status
 *
 * @param base WDOG base pointer.
 */
static inline void WDOG_ClearStatusFlag(WDOG_Type *base)
{
    base->WICR |= WDOG_WICR_WTIS_MASK;
}

/*@}*/

#if defined(__cplusplus)
}
#endif

/*! @}*/

#endif /* __WDOG_IMX_H__ */
/*******************************************************************************
 * EOF
 ******************************************************************************/