summaryrefslogtreecommitdiff
path: root/tool/mbed/mbed-sdk/libraries/mbed/targets/hal/TARGET_Freescale/TARGET_KPSDK_MCUS/TARGET_KPSDK_CODE/hal/rcm/fsl_rcm_hal.h
blob: 08021fbc580ce01397b5471af47f8bda131986ec (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
/*
 * Copyright (c) 2013 - 2014, 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_RCM_HAL_H__)
#define __FSL_RCM_HAL_H__

#include <stdint.h>
#include <stdbool.h>
#include <assert.h>
#include "fsl_device_registers.h"
#include "fsl_rcm_features.h"

/*! @addtogroup rcm_hal*/
/*! @{*/

/*! @file fsl_rcm_hal.h */

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

/*! @brief System Reset Source Name definitions */
typedef enum _rcm_source_names {
    kRcmWakeup,                     /* low-leakage wakeup reset */
    kRcmLowVoltDetect,              /* low voltage detect reset */
    kRcmLossOfClk,                  /* loss of clock reset */
    kRcmLossOfLock,                 /* loss of lock reset */
    kRcmWatchDog,                   /* watch dog reset */
    kRcmExternalPin,                /* external pin reset */
    kRcmPowerOn,                    /* power on reset */
    kRcmJtag,                       /* JTAG generated reset */
    kRcmCoreLockup,                 /* core lockup reset */
    kRcmSoftware,                   /* software reset */
    kRcmSystem,                     /* system reset request bit set reset */
    kRcmEzport,                     /* EzPort reset */
    kRcmStopModeAckErr,             /* stop mode ack error reset */
    kRcmSrcNameMax
} rcm_source_names_t;

/*! @brief Reset pin filter select in Run and Wait modes */
typedef enum _rcm_filter_run_wait_modes {
    kRcmFilterDisabled,          /* all filtering disabled */
    kRcmFilterBusClk,            /* Bus clock filter enabled */
    kRcmFilterLpoClk,            /* LPO clock filter enabled */
    kRcmFilterReserverd          /* reserved setting */
} rcm_filter_run_wait_modes_t;

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

/*!
 * @brief Gets the reset source status.
 *
 * This function gets the current reset source status for a specified source.
 *
 * @param baseAddr     Register base address of RCM
 * @param srcName      reset source name
 * @return status      true or false for specified reset source
 */
bool RCM_HAL_GetSrcStatusCmd(uint32_t baseAddr, rcm_source_names_t srcName);

/*!
 * @brief Sets the reset pin filter in stop mode.
 *
 * This function  sets the reset pin filter enable setting in stop mode.
 *
 * @param baseAddr     Register base address of RCM
 * @param enable      enable or disable the filter in stop mode
 */
static inline void RCM_HAL_SetFilterStopModeCmd(uint32_t baseAddr, bool enable)
{
    BW_RCM_RPFC_RSTFLTSS(baseAddr, enable);
}

/*!
 * @brief Gets the reset pin filter in stop mode.
 *
 * This function gets the reset pin filter enable setting in stop mode.
 *
 * @param baseAddr     Register base address of RCM
 * @return enable      true/false to enable or disable the filter in stop mode
 */
static inline bool RCM_HAL_GetFilterStopModeCmd(uint32_t baseAddr)
{
    return (bool)BR_RCM_RPFC_RSTFLTSS(baseAddr);
}

/*!
 * @brief Sets the reset pin filter in run and wait mode.
 *
 * This function sets the reset pin filter enable setting in run/wait mode.
 *
 * @param baseAddr     Register base address of RCM
 * @param mode  to be set for reset filter in run/wait mode
 */
static inline void RCM_HAL_SetFilterRunWaitMode(uint32_t baseAddr, rcm_filter_run_wait_modes_t mode)
{
    BW_RCM_RPFC_RSTFLTSRW(baseAddr, mode);
}

/*!
 * @brief Gets the reset pin filter for stop mode.
 *
 * This function gets the reset pin filter enable setting for stop mode.
 *
 * @param baseAddr     Register base address of RCM
 * @return mode  for reset filter in run/wait mode
 */
static inline rcm_filter_run_wait_modes_t RCM_HAL_GetFilterRunWaitMode(uint32_t baseAddr)
{
    return (rcm_filter_run_wait_modes_t)BR_RCM_RPFC_RSTFLTSRW(baseAddr);
}

/*!
 * @brief Sets the reset pin filter width.
 *
 * This function sets the reset pin filter width.
 *
 * @param baseAddr     Register base address of RCM
 * @param width  to be set for reset filter width
 */
static inline void RCM_HAL_SetFilterWidth(uint32_t baseAddr, uint32_t width)
{
    BW_RCM_RPFW_RSTFLTSEL(baseAddr, width);
}

/*!
 * @brief Gets the reset pin filter for stop mode.
 *
 * This function gets the reset pin filter width.
 *
 * @param baseAddr     Register base address of RCM
 * @return width reset filter width
 */
static inline uint32_t RCM_HAL_GetFilterWidth(uint32_t baseAddr)
{
    return (uint32_t)BR_RCM_RPFW_RSTFLTSEL(baseAddr);
}

/*!
 * @brief Gets the EZP_MS_B pin assert status.
 *
 * This function gets the easy port mode status (EZP_MS_B) pin assert status.
 *
 * @param baseAddr     Register base address of RCM
 * @return status  true - asserted, false - reasserted
 */
static inline bool RCM_HAL_GetEasyPortModeStatusCmd(uint32_t baseAddr)
{
    return (bool)BR_RCM_MR_EZP_MS(baseAddr);
}

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

/*! @name Reset Control Module APIs*/
/*@{*/

/*@}*/

#if defined(__cplusplus)
}
#endif /* __cplusplus*/

/*! @}*/

#endif /* __FSL_RCM_HAL_H__*/
/*******************************************************************************
 * EOF
 ******************************************************************************/