aboutsummaryrefslogtreecommitdiff
path: root/KSDK_1.2.0/platform/hal/inc/fsl_llwu_hal.h
blob: daf93553f488834ccc1812c1d6d748b7030c6572 (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/*
 * 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.
 */
#if !defined(__FSL_LLWU_HAL_H__)
#define __FSL_LLWU_HAL_H__

#include <stdint.h>
#include <stdbool.h>
#include <assert.h>
#include "fsl_device_registers.h"
#if FSL_FEATURE_SOC_LLWU_COUNT

/*! @addtogroup llwu_hal*/
/*! @{*/

/*! @file fsl_llwu_hal.h */

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

/*! @brief External input pin control modes */
typedef enum _llwu_external_pin_modes {
    kLlwuExternalPinDisabled,          /*!< Pin disabled as wakeup input */
    kLlwuExternalPinRisingEdge,        /*!< Pin enabled with rising edge detection */
    kLlwuExternalPinFallingEdge,       /*!< Pin enabled with falling edge detection */
    kLlwuExternalPinChangeDetect       /*!< Pin enabled with any change detection */
} llwu_external_pin_modes_t;

/*! @brief Digital filter control modes */
typedef enum _llwu_filter_modes {
    kLlwuFilterDisabled,            /*!< Filter disabled  */
    kLlwuFilterPosEdgeDetect,       /*!< Filter positive edge detection */
    kLlwuFilterNegEdgeDetect,       /*!< Filter negative edge detection */
    kLlwuFilterAnyEdgeDetect        /*!< Filter any edge detection */
} llwu_filter_modes_t;

#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN
/*! @brief LLWU external wakeup pin. */
typedef enum _llwu_wakeup_pin {
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN0
    kLlwuWakeupPin0   = 0U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN1
    kLlwuWakeupPin1   = 1U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN2
    kLlwuWakeupPin2   = 2U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN3
    kLlwuWakeupPin3   = 3U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN4
    kLlwuWakeupPin4   = 4U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN5
    kLlwuWakeupPin5   = 5U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN6
    kLlwuWakeupPin6   = 6U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN7
    kLlwuWakeupPin7   = 7U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN8
    kLlwuWakeupPin8   = 8U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN9
    kLlwuWakeupPin9   = 9U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN10
    kLlwuWakeupPin10  = 10U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN11
    kLlwuWakeupPin11  = 11U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN12
    kLlwuWakeupPin12  = 12U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN13
    kLlwuWakeupPin13  = 13U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN14
    kLlwuWakeupPin14  = 14U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN15
    kLlwuWakeupPin15  = 15U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN16
    kLlwuWakeupPin16   = 16U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN17
    kLlwuWakeupPin17   = 17U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN18
    kLlwuWakeupPin18   = 18U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN19
    kLlwuWakeupPin19   = 19U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN20
    kLlwuWakeupPin20   = 20U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN21
    kLlwuWakeupPin21   = 21U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN22
    kLlwuWakeupPin22   = 22U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN23
    kLlwuWakeupPin23   = 23U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN24
    kLlwuWakeupPin24   = 24U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN25
    kLlwuWakeupPin25   = 25U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN26
    kLlwuWakeupPin26   = 26U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN27
    kLlwuWakeupPin27   = 27U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN28
    kLlwuWakeupPin28   = 28U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN29
    kLlwuWakeupPin29   = 29U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN30
    kLlwuWakeupPin30   = 30U,
#endif
#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN31
    kLlwuWakeupPin31   = 31U
#endif
} llwu_wakeup_pin_t;
#endif

#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE
/*! @brief LLWU wakeup module. */
typedef enum _llwu_wakeup_module {
#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE0
    kLlwuWakeupModule0  = 0U,
#endif
#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE1
    kLlwuWakeupModule1  = 1U,
#endif
#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE2
    kLlwuWakeupModule2  = 2U,
#endif
#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE3
    kLlwuWakeupModule3  = 3U,
#endif
#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE4
    kLlwuWakeupModule4  = 4U,
#endif
#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE5
    kLlwuWakeupModule5  = 5U,
#endif
#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE6
    kLlwuWakeupModule6  = 6U,
#endif
#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE7
    kLlwuWakeupModule7  = 7U
#endif
} llwu_wakeup_module_t;
#endif

/*! @brief External input pin filter control structure */
typedef struct _llwu_external_pin_filter_mode {
    llwu_filter_modes_t         filterMode;         /*!< Filter mode */
    llwu_wakeup_pin_t           pinNumber;          /*!< Pin number */
} llwu_external_pin_filter_mode_t;

/*! @brief Reset pin control structure */
typedef struct _llwu_reset_pin_mode {
    bool enable;  /*!< RESET pin is enabled as low-leakage mode exit source. */
    bool filter;  /*!< Digital filter on RESET pin.                          */
} llwu_reset_pin_mode_t;

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

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

/*!
 * @name Low-Leakage Wakeup Unit Control APIs
 * @{
 */

#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN
/*!
 * @brief Sets the external input pin source mode.
 *
 * This function sets the external input pin source mode that is used
 * as a wake up source. 
 *
 * @param base      Register base address of LLWU
 * @param pinMode       pin configuration mode defined in llwu_external_pin_modes_t
 * @param pinNumber     pin number specified
 */
void LLWU_HAL_SetExternalInputPinMode(LLWU_Type * base,
                                      llwu_external_pin_modes_t pinMode,
                                      llwu_wakeup_pin_t pinNumber);

#endif

#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE
/*!
 * @brief Enables/disables the internal module source.
 *
 * This function enables/disables the internal module source mode that is used
 * as a wake up source. 
 *
 * @param base      Register base address of LLWU
 * @param moduleNumber  module number specified
 * @param enable        enable or disable setting
 */
void LLWU_HAL_SetInternalModuleCmd(LLWU_Type * base, llwu_wakeup_module_t moduleNumber, bool enable);
#endif

#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN
/*!
 * @brief Gets the external wakeup source flag.
 *
 * This function checks the external pin flag to detect whether the MCU is
 * woke up by the specific pin.
 *
 * @param base      Register base address of LLWU
 * @param pinNumber     pin number specified
 * @return true if the specific pin is wake up source.
 */
bool LLWU_HAL_GetExternalPinWakeupFlag(LLWU_Type * base, llwu_wakeup_pin_t pinNumber);

/*!
 * @brief Clears the external wakeup source flag.
 *
 * This function clears the external wakeup source flag for a specific pin.
 *
 * @param base      Register base address of LLWU
 * @param pinNumber     pin number specified
 */
void LLWU_HAL_ClearExternalPinWakeupFlag(LLWU_Type * base, llwu_wakeup_pin_t pinNumber);
#endif

#if FSL_FEATURE_LLWU_HAS_INTERNAL_MODULE
/*!
 * @brief Gets the internal module wakeup source flag.
 *
 * This function checks the internal module wake up flag to detect whether the MCU is
 * woke up by the specific internal module.
 *
 * @param base      Register base address of LLWU
 * @param moduleNumber  module number specified
 * @return true if the specific module is wake up source.
 */
bool LLWU_HAL_GetInternalModuleWakeupFlag(LLWU_Type * base, llwu_wakeup_module_t moduleNumber);
#endif

#if FSL_FEATURE_LLWU_HAS_EXTERNAL_PIN
/*!
 * @brief Sets the pin filter configuration.
 *
 * This function sets the pin filter configuration.
 *
 * @param base      Register base address of LLWU
 * @param filterNumber  filter number specified
 * @param pinFilterMode filter mode configuration
 */
void LLWU_HAL_SetPinFilterMode(LLWU_Type * base, uint32_t filterNumber, 
                               llwu_external_pin_filter_mode_t pinFilterMode);

/*!
 * @brief Gets the filter detect flag.
 *
 * This function checks the filter detect flag to detect whether the external
 * pin selected by the specific filter is the wake up source.
 *
 * @param base      Register base address of LLWU
 * @param filterNumber  filter number specified
 * @return true if the the pin is wakeup source
 */
bool LLWU_HAL_GetFilterDetectFlag(LLWU_Type * base, uint32_t filterNumber);

/*!
 * @brief Clears the filter detect flag.
 *
 * This function will clear the filter detect flag.
 *
 * @param base      Register base address of LLWU
 * @param filterNumber  filter number specified
 */
void LLWU_HAL_ClearFilterDetectFlag(LLWU_Type * base, uint32_t filterNumber);
#endif

#if FSL_FEATURE_LLWU_HAS_RESET_ENABLE
/*!
 * @brief Sets the RESET pin mode.
 *
 * This function sets how the RESET pin is used as low leakage mode exit source.
 *
 * @param base         Register base address of LLWU
 * @param resetPinMode RESET pin mode defined in llwu_reset_pin_mode_t
 */
void LLWU_HAL_SetResetPinMode(LLWU_Type * base, llwu_reset_pin_mode_t resetPinMode);

#endif

/*@}*/

#if defined(__cplusplus)
}
#endif

/*! @}*/

#endif
#endif /* __FSL_LLWU_HAL_H__*/
/*******************************************************************************
 * EOF
 ******************************************************************************/