aboutsummaryrefslogtreecommitdiffstats
path: root/lib/hc32f460/driver/inc/hc32f460_wdt.h
blob: f958639dd0d7b0f6e388a83a84135fb5267ed7a9 (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
/*******************************************************************************
 * Copyright (C) 2020, Huada Semiconductor Co., Ltd. All rights reserved.
 *
 * This software component is licensed by HDSC under BSD 3-Clause license
 * (the "License"); You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at:
 *                    opensource.org/licenses/BSD-3-Clause
 */
/******************************************************************************/
/** \file hc32f460_wdt.h
 **
 ** A detailed description is available at
 ** @link WdtGroup Watchdog Counter description @endlink
 **
 **   - 2018-10-18  CDT  First version for Device Driver Library of WDT.
 **
 ******************************************************************************/
#ifndef __HC32F460_WDT_H__
#define __HC32F460_WDT_H__

/*******************************************************************************
 * Include files
 ******************************************************************************/
#include "hc32_common.h"

/* C binding of definitions if building with C++ compiler */
#ifdef __cplusplus
extern "C"
{
#endif

/**
 *******************************************************************************
 ** \defgroup WdtGroup WatchDog Counter(WDT)
 **
 ******************************************************************************/
//@{

/*******************************************************************************
 * Global type definitions ('typedef')
 ******************************************************************************/
/**
 *******************************************************************************
 ** \brief WDT count cycle enumeration
 ******************************************************************************/
typedef enum en_wdt_count_cycle
{
    WdtCountCycle256   = 0u,                    ///< 256 cycle
    WdtCountCycle4096  = 1u,                    ///< 4096 cycle
    WdtCountCycle16384 = 2u,                    ///< 16384 cycle
    WdtCountCycle65536 = 3u,                    ///< 65536 cycle
} en_wdt_count_cycle_t;

/**
 *******************************************************************************
 ** \brief WDT count clock division enumeration
 ******************************************************************************/
typedef enum en_wdt_clk_div
{
    WdtPclk3Div4    = 2u,                       ///< PCLK3/4
    WdtPclk3Div64   = 6u,                       ///< PCLK3/64
    WdtPclk3Div128  = 7u,                       ///< PCLK3/128
    WdtPclk3Div256  = 8u,                       ///< PCLK3/256
    WdtPclk3Div512  = 9u,                       ///< PCLK3/512
    WdtPclk3Div1024 = 10u,                      ///< PCLK3/1024
    WdtPclk3Div2048 = 11u,                      ///< PCLK3/2048
    WdtPclk3Div8192 = 13u,                      ///< PCLK3/8192
} en_wdt_clk_div_t;

/**
 *******************************************************************************
 ** \brief WDT allow refresh percent range enumeration
 ******************************************************************************/
typedef enum en_wdt_refresh_range
{
    WdtRefresh100Pct                 = 0u,      ///< 100%
    WdtRefresh0To25Pct               = 1u,      ///< 0%~25%
    WdtRefresh25To50Pct              = 2u,      ///< 25%~50%
    WdtRefresh0To50Pct               = 3u,      ///< 0%~50%
    WdtRefresh50To75Pct              = 4u,      ///< 50%~75%
    WdtRefresh0To25PctAnd50To75Pct   = 5u,      ///< 0%~25% & 50%~75%
    WdtRefresh25To75Pct              = 6u,      ///< 25%~75%
    WdtRefresh0To75Pct               = 7u,      ///< 0%~75%
    WdtRefresh75To100Pct             = 8u,      ///< 75%~100%
    WdtRefresh0To25PctAnd75To100Pct  = 9u,      ///< 0%~25% & 75%~100%
    WdtRefresh25To50PctAnd75To100Pct = 10u,     ///< 25%~50% & 75%~100%
    WdtRefresh0To50PctAnd75To100Pct  = 11u,     ///< 0%~50% & 75%~100%
    WdtRefresh50To100Pct             = 12u,     ///< 50%~100%
    WdtRefresh0To25PctAnd50To100Pct  = 13u,     ///< 0%~25% & 50%~100%
    WdtRefresh25To100Pct             = 14u,     ///< 25%~100%
    WdtRefresh0To100Pct              = 15u,     ///< 0%~100%
} en_wdt_refresh_range_t;

/**
 *******************************************************************************
 ** \brief WDT refresh error or count underflow trigger event type enumeration
 ******************************************************************************/
typedef enum en_wdt_event_request_type
{
    WdtTriggerInterruptRequest = 0u,            ///< Interrupt request
    WdtTriggerResetRequest     = 1u,            ///< Reset request
} en_wdt_event_request_type_t;

/**
 *******************************************************************************
 ** \brief WDT flag type enumeration
 ******************************************************************************/
typedef enum en_wdt_flag_type
{
    WdtFlagCountUnderflow = 0u,                 ///< Count underflow flag
    WdtFlagRefreshError   = 1u,                 ///< Refresh error flag
} en_wdt_flag_type_t;

/**
 *******************************************************************************
 ** \brief WDT init structure definition
 ******************************************************************************/
typedef struct stc_wdt_init
{
    en_wdt_count_cycle_t        enCountCycle;           ///< Count cycle
    en_wdt_clk_div_t            enClkDiv;               ///< Count clock division
    en_wdt_refresh_range_t      enRefreshRange;         ///< Allow refresh percent range
    en_functional_state_t       enSleepModeCountEn;     ///< Enable/disable count in the sleep mode
    en_wdt_event_request_type_t enRequestType;          ///< Refresh error or count underflow trigger event type
} stc_wdt_init_t;

/*******************************************************************************
 * Global pre-processor symbols/macros ('#define')
 ******************************************************************************/

/*******************************************************************************
 * Global variable definitions ('extern')
 ******************************************************************************/

/*******************************************************************************
  Global function prototypes (definition in C source)
 ******************************************************************************/
/* Base functions */
en_result_t WDT_Init(const stc_wdt_init_t *pstcWdtInit);
en_result_t WDT_RefreshCounter(void);
uint16_t WDT_GetCountValue(void);

/* Flags functions */
en_flag_status_t WDT_GetFlag(en_wdt_flag_type_t enFlag);
en_result_t WDT_ClearFlag(en_wdt_flag_type_t enFlag);

//@} // WdtGroup

#ifdef __cplusplus
}
#endif

#endif /* __HC32F460_WDT_H__ */

/*******************************************************************************
 * EOF (not truncated)
 ******************************************************************************/