aboutsummaryrefslogtreecommitdiff
path: root/KSDK_1.2.0/platform/drivers/inc/fsl_wdog_driver.h
blob: bc3975f4abb0c23b0813a7e56ead617dfb5d5ded (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
/*
 * Copyright (c) 2013 - 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 __FSL_WDOG_DRIVER_H__
#define __FSL_WDOG_DRIVER_H__

#include <assert.h>
#include <stdint.h>
#include <stdbool.h>
#include "fsl_wdog_hal.h"
#if FSL_FEATURE_SOC_WDOG_COUNT

/*! 
 * @addtogroup wdog_driver
 * @{
 */
/*******************************************************************************
 * Variables
 ******************************************************************************/

/* Table of base addresses for WDOG instances. */
extern WDOG_Type * const g_wdogBase[];

/* Table to save WDOG IRQ enumeration numbers defined in the CMSIS header file. */
extern const IRQn_Type g_wdogIrqId[WDOG_INSTANCE_COUNT];

/*******************************************************************************
 * Definitions
 *******************************************************************************/

/*! 
 * @brief Data structure for Watchdog initialization
 *
 * This structure is used when initializing the WDOG during the wdog_init function call.
 * It contains all WDOG configurations.
 * @internal gui name="Common configuration" id="wdogCfg"
 */

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

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

/*! 
 * @name Watchdog Driver
 * @{
 */
 

/*!
 * @brief Initializes the Watchdog.
 *
 * This function  initializes the WDOG. When called, the WDOG 
 * runs according to the requirements of the configuration.
 * 
 * @param userConfigPtr Watchdog user configure data structure, see #wdog_user_config_t.
 *
 */
wdog_status_t WDOG_DRV_Init(const wdog_config_t* userConfigPtr);

/*!
 * @brief Shuts down the Watchdog.
 *
 * This function shuts down the WDOG. 
 *
 */
wdog_status_t WDOG_DRV_Deinit(void);

/*!
 * @brief Refreshes the Watchdog.
 *
 *  This function feeds the WDOG. It sets the WDOG timer count to zero and 
 *  should be called before the Watchdog timer times out. Otherwise, a reset is asserted.
 *  Enough time should be allowed for the
 *  refresh sequence to be detected by the Watchdog timer on the Watchdog clock.
 *
 */
void WDOG_DRV_Refresh(void);

/*!
 * @brief Gets the Watchdog running status.
 *
 * This function gets the WDOG running status.
 *
 * @return watchdog running status, false means not running, true means running
 */
bool WDOG_DRV_IsRunning(void);

/*!
 * @brief Resets the MCU by the Watchdog.
 *
 * This function resets the MCU by using the WDOG. 
 *
 */
void WDOG_DRV_ResetSystem(void);

/*@}*/

#if defined(__cplusplus)
}
#endif

/*! @}*/

#endif
#endif /* __FSL_WDOG_H__*/
/*******************************************************************************
 * EOF
 *******************************************************************************/