mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_smc.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31 #ifndef _FSL_SMC_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_SMC_H_
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #include "fsl_common.h"
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /*! @addtogroup smc */
AnnaBridge 189:f392fc9709a3 37 /*! @{ */
AnnaBridge 189:f392fc9709a3 38
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 41 * Definitions
AnnaBridge 189:f392fc9709a3 42 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 43
AnnaBridge 189:f392fc9709a3 44 /*! @name Driver version */
AnnaBridge 189:f392fc9709a3 45 /*@{*/
AnnaBridge 189:f392fc9709a3 46 /*! @brief SMC driver version 2.0.3. */
AnnaBridge 189:f392fc9709a3 47 #define FSL_SMC_DRIVER_VERSION (MAKE_VERSION(2, 0, 3))
AnnaBridge 189:f392fc9709a3 48 /*@}*/
AnnaBridge 189:f392fc9709a3 49
AnnaBridge 189:f392fc9709a3 50 /*!
AnnaBridge 189:f392fc9709a3 51 * @brief Power Modes Protection
AnnaBridge 189:f392fc9709a3 52 */
AnnaBridge 189:f392fc9709a3 53 typedef enum _smc_power_mode_protection
AnnaBridge 189:f392fc9709a3 54 {
AnnaBridge 189:f392fc9709a3 55 #if (defined(FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 56 kSMC_AllowPowerModeVlls = SMC_PMPROT_AVLLS_MASK, /*!< Allow Very-low-leakage Stop Mode. */
AnnaBridge 189:f392fc9709a3 57 #endif
AnnaBridge 189:f392fc9709a3 58 #if (defined(FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 59 kSMC_AllowPowerModeLls = SMC_PMPROT_ALLS_MASK, /*!< Allow Low-leakage Stop Mode. */
AnnaBridge 189:f392fc9709a3 60 #endif /* FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE */
AnnaBridge 189:f392fc9709a3 61 kSMC_AllowPowerModeVlp = SMC_PMPROT_AVLP_MASK, /*!< Allow Very-Low-power Mode. */
AnnaBridge 189:f392fc9709a3 62 #if (defined(FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE) && FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE)
AnnaBridge 189:f392fc9709a3 63 kSMC_AllowPowerModeHsrun = SMC_PMPROT_AHSRUN_MASK, /*!< Allow High-speed Run mode. */
AnnaBridge 189:f392fc9709a3 64 #endif /* FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE */
AnnaBridge 189:f392fc9709a3 65 kSMC_AllowPowerModeAll = (0U
AnnaBridge 189:f392fc9709a3 66 #if (defined(FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 67 |
AnnaBridge 189:f392fc9709a3 68 SMC_PMPROT_AVLLS_MASK
AnnaBridge 189:f392fc9709a3 69 #endif
AnnaBridge 189:f392fc9709a3 70 #if (defined(FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 71 |
AnnaBridge 189:f392fc9709a3 72 SMC_PMPROT_ALLS_MASK
AnnaBridge 189:f392fc9709a3 73 #endif /* FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE */
AnnaBridge 189:f392fc9709a3 74 |
AnnaBridge 189:f392fc9709a3 75 SMC_PMPROT_AVLP_MASK
AnnaBridge 189:f392fc9709a3 76 #if (defined(FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE) && FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE)
AnnaBridge 189:f392fc9709a3 77 |
AnnaBridge 189:f392fc9709a3 78 kSMC_AllowPowerModeHsrun
AnnaBridge 189:f392fc9709a3 79 #endif /* FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE */
AnnaBridge 189:f392fc9709a3 80 ) /*!< Allow all power mode. */
AnnaBridge 189:f392fc9709a3 81 } smc_power_mode_protection_t;
AnnaBridge 189:f392fc9709a3 82
AnnaBridge 189:f392fc9709a3 83 /*!
AnnaBridge 189:f392fc9709a3 84 * @brief Power Modes in PMSTAT
AnnaBridge 189:f392fc9709a3 85 */
AnnaBridge 189:f392fc9709a3 86 typedef enum _smc_power_state
AnnaBridge 189:f392fc9709a3 87 {
AnnaBridge 189:f392fc9709a3 88 kSMC_PowerStateRun = 0x01U << 0U, /*!< 0000_0001 - Current power mode is RUN */
AnnaBridge 189:f392fc9709a3 89 kSMC_PowerStateStop = 0x01U << 1U, /*!< 0000_0010 - Current power mode is STOP */
AnnaBridge 189:f392fc9709a3 90 kSMC_PowerStateVlpr = 0x01U << 2U, /*!< 0000_0100 - Current power mode is VLPR */
AnnaBridge 189:f392fc9709a3 91 kSMC_PowerStateVlpw = 0x01U << 3U, /*!< 0000_1000 - Current power mode is VLPW */
AnnaBridge 189:f392fc9709a3 92 kSMC_PowerStateVlps = 0x01U << 4U, /*!< 0001_0000 - Current power mode is VLPS */
AnnaBridge 189:f392fc9709a3 93 #if (defined(FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 94 kSMC_PowerStateLls = 0x01U << 5U, /*!< 0010_0000 - Current power mode is LLS */
AnnaBridge 189:f392fc9709a3 95 #endif /* FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE */
AnnaBridge 189:f392fc9709a3 96 #if (defined(FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 97 kSMC_PowerStateVlls = 0x01U << 6U, /*!< 0100_0000 - Current power mode is VLLS */
AnnaBridge 189:f392fc9709a3 98 #endif
AnnaBridge 189:f392fc9709a3 99 #if (defined(FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE) && FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE)
AnnaBridge 189:f392fc9709a3 100 kSMC_PowerStateHsrun = 0x01U << 7U /*!< 1000_0000 - Current power mode is HSRUN */
AnnaBridge 189:f392fc9709a3 101 #endif /* FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE */
AnnaBridge 189:f392fc9709a3 102 } smc_power_state_t;
AnnaBridge 189:f392fc9709a3 103
AnnaBridge 189:f392fc9709a3 104 /*!
AnnaBridge 189:f392fc9709a3 105 * @brief Run mode definition
AnnaBridge 189:f392fc9709a3 106 */
AnnaBridge 189:f392fc9709a3 107 typedef enum _smc_run_mode
AnnaBridge 189:f392fc9709a3 108 {
AnnaBridge 189:f392fc9709a3 109 kSMC_RunNormal = 0U, /*!< Normal RUN mode. */
AnnaBridge 189:f392fc9709a3 110 kSMC_RunVlpr = 2U, /*!< Very-low-power RUN mode. */
AnnaBridge 189:f392fc9709a3 111 #if (defined(FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE) && FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE)
AnnaBridge 189:f392fc9709a3 112 kSMC_Hsrun = 3U /*!< High-speed Run mode (HSRUN). */
AnnaBridge 189:f392fc9709a3 113 #endif /* FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE */
AnnaBridge 189:f392fc9709a3 114 } smc_run_mode_t;
AnnaBridge 189:f392fc9709a3 115
AnnaBridge 189:f392fc9709a3 116 /*!
AnnaBridge 189:f392fc9709a3 117 * @brief Stop mode definition
AnnaBridge 189:f392fc9709a3 118 */
AnnaBridge 189:f392fc9709a3 119 typedef enum _smc_stop_mode
AnnaBridge 189:f392fc9709a3 120 {
AnnaBridge 189:f392fc9709a3 121 kSMC_StopNormal = 0U, /*!< Normal STOP mode. */
AnnaBridge 189:f392fc9709a3 122 kSMC_StopVlps = 2U, /*!< Very-low-power STOP mode. */
AnnaBridge 189:f392fc9709a3 123 #if (defined(FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 124 kSMC_StopLls = 3U, /*!< Low-leakage Stop mode. */
AnnaBridge 189:f392fc9709a3 125 #endif /* FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE */
AnnaBridge 189:f392fc9709a3 126 #if (defined(FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 127 kSMC_StopVlls = 4U /*!< Very-low-leakage Stop mode. */
AnnaBridge 189:f392fc9709a3 128 #endif
AnnaBridge 189:f392fc9709a3 129 } smc_stop_mode_t;
AnnaBridge 189:f392fc9709a3 130
AnnaBridge 189:f392fc9709a3 131 #if (defined(FSL_FEATURE_SMC_USE_VLLSCTRL_REG) && FSL_FEATURE_SMC_USE_VLLSCTRL_REG) || \
AnnaBridge 189:f392fc9709a3 132 (defined(FSL_FEATURE_SMC_USE_STOPCTRL_VLLSM) && FSL_FEATURE_SMC_USE_STOPCTRL_VLLSM) || \
AnnaBridge 189:f392fc9709a3 133 (defined(FSL_FEATURE_SMC_HAS_LLS_SUBMODE) && FSL_FEATURE_SMC_HAS_LLS_SUBMODE)
AnnaBridge 189:f392fc9709a3 134 /*!
AnnaBridge 189:f392fc9709a3 135 * @brief VLLS/LLS stop sub mode definition
AnnaBridge 189:f392fc9709a3 136 */
AnnaBridge 189:f392fc9709a3 137 typedef enum _smc_stop_submode
AnnaBridge 189:f392fc9709a3 138 {
AnnaBridge 189:f392fc9709a3 139 kSMC_StopSub0 = 0U, /*!< Stop submode 0, for VLLS0/LLS0. */
AnnaBridge 189:f392fc9709a3 140 kSMC_StopSub1 = 1U, /*!< Stop submode 1, for VLLS1/LLS1. */
AnnaBridge 189:f392fc9709a3 141 kSMC_StopSub2 = 2U, /*!< Stop submode 2, for VLLS2/LLS2. */
AnnaBridge 189:f392fc9709a3 142 kSMC_StopSub3 = 3U /*!< Stop submode 3, for VLLS3/LLS3. */
AnnaBridge 189:f392fc9709a3 143 } smc_stop_submode_t;
AnnaBridge 189:f392fc9709a3 144 #endif
AnnaBridge 189:f392fc9709a3 145
AnnaBridge 189:f392fc9709a3 146 /*!
AnnaBridge 189:f392fc9709a3 147 * @brief Partial STOP option
AnnaBridge 189:f392fc9709a3 148 */
AnnaBridge 189:f392fc9709a3 149 typedef enum _smc_partial_stop_mode
AnnaBridge 189:f392fc9709a3 150 {
AnnaBridge 189:f392fc9709a3 151 kSMC_PartialStop = 0U, /*!< STOP - Normal Stop mode*/
AnnaBridge 189:f392fc9709a3 152 kSMC_PartialStop1 = 1U, /*!< Partial Stop with both system and bus clocks disabled*/
AnnaBridge 189:f392fc9709a3 153 kSMC_PartialStop2 = 2U, /*!< Partial Stop with system clock disabled and bus clock enabled*/
AnnaBridge 189:f392fc9709a3 154 } smc_partial_stop_option_t;
AnnaBridge 189:f392fc9709a3 155
AnnaBridge 189:f392fc9709a3 156 /*!
AnnaBridge 189:f392fc9709a3 157 * @brief SMC configuration status.
AnnaBridge 189:f392fc9709a3 158 */
AnnaBridge 189:f392fc9709a3 159 enum _smc_status
AnnaBridge 189:f392fc9709a3 160 {
AnnaBridge 189:f392fc9709a3 161 kStatus_SMC_StopAbort = MAKE_STATUS(kStatusGroup_POWER, 0) /*!< Entering Stop mode is abort*/
AnnaBridge 189:f392fc9709a3 162 };
AnnaBridge 189:f392fc9709a3 163
AnnaBridge 189:f392fc9709a3 164 #if (defined(FSL_FEATURE_SMC_HAS_VERID) && FSL_FEATURE_SMC_HAS_VERID)
AnnaBridge 189:f392fc9709a3 165 /*!
AnnaBridge 189:f392fc9709a3 166 * @brief IP version ID definition.
AnnaBridge 189:f392fc9709a3 167 */
AnnaBridge 189:f392fc9709a3 168 typedef struct _smc_version_id
AnnaBridge 189:f392fc9709a3 169 {
AnnaBridge 189:f392fc9709a3 170 uint16_t feature; /*!< Feature Specification Number. */
AnnaBridge 189:f392fc9709a3 171 uint8_t minor; /*!< Minor version number. */
AnnaBridge 189:f392fc9709a3 172 uint8_t major; /*!< Major version number. */
AnnaBridge 189:f392fc9709a3 173 } smc_version_id_t;
AnnaBridge 189:f392fc9709a3 174 #endif /* FSL_FEATURE_SMC_HAS_VERID */
AnnaBridge 189:f392fc9709a3 175
AnnaBridge 189:f392fc9709a3 176 #if (defined(FSL_FEATURE_SMC_HAS_PARAM) && FSL_FEATURE_SMC_HAS_PARAM)
AnnaBridge 189:f392fc9709a3 177 /*!
AnnaBridge 189:f392fc9709a3 178 * @brief IP parameter definition.
AnnaBridge 189:f392fc9709a3 179 */
AnnaBridge 189:f392fc9709a3 180 typedef struct _smc_param
AnnaBridge 189:f392fc9709a3 181 {
AnnaBridge 189:f392fc9709a3 182 bool hsrunEnable; /*!< HSRUN mode enable. */
AnnaBridge 189:f392fc9709a3 183 bool llsEnable; /*!< LLS mode enable. */
AnnaBridge 189:f392fc9709a3 184 bool lls2Enable; /*!< LLS2 mode enable. */
AnnaBridge 189:f392fc9709a3 185 bool vlls0Enable; /*!< VLLS0 mode enable. */
AnnaBridge 189:f392fc9709a3 186 } smc_param_t;
AnnaBridge 189:f392fc9709a3 187 #endif /* FSL_FEATURE_SMC_HAS_PARAM */
AnnaBridge 189:f392fc9709a3 188
AnnaBridge 189:f392fc9709a3 189 #if (defined(FSL_FEATURE_SMC_HAS_LLS_SUBMODE) && FSL_FEATURE_SMC_HAS_LLS_SUBMODE) || \
AnnaBridge 189:f392fc9709a3 190 (defined(FSL_FEATURE_SMC_HAS_LPOPO) && FSL_FEATURE_SMC_HAS_LPOPO)
AnnaBridge 189:f392fc9709a3 191 /*!
AnnaBridge 189:f392fc9709a3 192 * @brief SMC Low-Leakage Stop power mode configuration.
AnnaBridge 189:f392fc9709a3 193 */
AnnaBridge 189:f392fc9709a3 194 typedef struct _smc_power_mode_lls_config
AnnaBridge 189:f392fc9709a3 195 {
AnnaBridge 189:f392fc9709a3 196 #if (defined(FSL_FEATURE_SMC_HAS_LLS_SUBMODE) && FSL_FEATURE_SMC_HAS_LLS_SUBMODE)
AnnaBridge 189:f392fc9709a3 197 smc_stop_submode_t subMode; /*!< Low-leakage Stop sub-mode */
AnnaBridge 189:f392fc9709a3 198 #endif
AnnaBridge 189:f392fc9709a3 199 #if (defined(FSL_FEATURE_SMC_HAS_LPOPO) && FSL_FEATURE_SMC_HAS_LPOPO)
AnnaBridge 189:f392fc9709a3 200 bool enableLpoClock; /*!< Enable LPO clock in LLS mode */
AnnaBridge 189:f392fc9709a3 201 #endif
AnnaBridge 189:f392fc9709a3 202 } smc_power_mode_lls_config_t;
AnnaBridge 189:f392fc9709a3 203 #endif /* (FSL_FEATURE_SMC_HAS_LLS_SUBMODE || FSL_FEATURE_SMC_HAS_LPOPO) */
AnnaBridge 189:f392fc9709a3 204
AnnaBridge 189:f392fc9709a3 205 #if (defined(FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 206 /*!
AnnaBridge 189:f392fc9709a3 207 * @brief SMC Very Low-Leakage Stop power mode configuration.
AnnaBridge 189:f392fc9709a3 208 */
AnnaBridge 189:f392fc9709a3 209 typedef struct _smc_power_mode_vlls_config
AnnaBridge 189:f392fc9709a3 210 {
AnnaBridge 189:f392fc9709a3 211 #if (defined(FSL_FEATURE_SMC_USE_VLLSCTRL_REG) && FSL_FEATURE_SMC_USE_VLLSCTRL_REG) || \
AnnaBridge 189:f392fc9709a3 212 (defined(FSL_FEATURE_SMC_USE_STOPCTRL_VLLSM) && FSL_FEATURE_SMC_USE_STOPCTRL_VLLSM) || \
AnnaBridge 189:f392fc9709a3 213 (defined(FSL_FEATURE_SMC_HAS_LLS_SUBMODE) && FSL_FEATURE_SMC_HAS_LLS_SUBMODE)
AnnaBridge 189:f392fc9709a3 214 smc_stop_submode_t subMode; /*!< Very Low-leakage Stop sub-mode */
AnnaBridge 189:f392fc9709a3 215 #endif
AnnaBridge 189:f392fc9709a3 216 #if (defined(FSL_FEATURE_SMC_HAS_PORPO) && FSL_FEATURE_SMC_HAS_PORPO)
AnnaBridge 189:f392fc9709a3 217 bool enablePorDetectInVlls0; /*!< Enable Power on reset detect in VLLS mode */
AnnaBridge 189:f392fc9709a3 218 #endif
AnnaBridge 189:f392fc9709a3 219 #if (defined(FSL_FEATURE_SMC_HAS_RAM2_POWER_OPTION) && FSL_FEATURE_SMC_HAS_RAM2_POWER_OPTION)
AnnaBridge 189:f392fc9709a3 220 bool enableRam2InVlls2; /*!< Enable RAM2 power in VLLS2 */
AnnaBridge 189:f392fc9709a3 221 #endif
AnnaBridge 189:f392fc9709a3 222 #if (defined(FSL_FEATURE_SMC_HAS_LPOPO) && FSL_FEATURE_SMC_HAS_LPOPO)
AnnaBridge 189:f392fc9709a3 223 bool enableLpoClock; /*!< Enable LPO clock in VLLS mode */
AnnaBridge 189:f392fc9709a3 224 #endif
AnnaBridge 189:f392fc9709a3 225 } smc_power_mode_vlls_config_t;
AnnaBridge 189:f392fc9709a3 226 #endif
AnnaBridge 189:f392fc9709a3 227
AnnaBridge 189:f392fc9709a3 228 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 229 * API
AnnaBridge 189:f392fc9709a3 230 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 231
AnnaBridge 189:f392fc9709a3 232 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 233 extern "C" {
AnnaBridge 189:f392fc9709a3 234 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 235
AnnaBridge 189:f392fc9709a3 236 /*! @name System mode controller APIs*/
AnnaBridge 189:f392fc9709a3 237 /*@{*/
AnnaBridge 189:f392fc9709a3 238
AnnaBridge 189:f392fc9709a3 239 #if (defined(FSL_FEATURE_SMC_HAS_VERID) && FSL_FEATURE_SMC_HAS_VERID)
AnnaBridge 189:f392fc9709a3 240 /*!
AnnaBridge 189:f392fc9709a3 241 * @brief Gets the SMC version ID.
AnnaBridge 189:f392fc9709a3 242 *
AnnaBridge 189:f392fc9709a3 243 * This function gets the SMC version ID, including major version number,
AnnaBridge 189:f392fc9709a3 244 * minor version number, and feature specification number.
AnnaBridge 189:f392fc9709a3 245 *
AnnaBridge 189:f392fc9709a3 246 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 247 * @param versionId Pointer to the version ID structure.
AnnaBridge 189:f392fc9709a3 248 */
AnnaBridge 189:f392fc9709a3 249 static inline void SMC_GetVersionId(SMC_Type *base, smc_version_id_t *versionId)
AnnaBridge 189:f392fc9709a3 250 {
AnnaBridge 189:f392fc9709a3 251 *((uint32_t *)versionId) = base->VERID;
AnnaBridge 189:f392fc9709a3 252 }
AnnaBridge 189:f392fc9709a3 253 #endif /* FSL_FEATURE_SMC_HAS_VERID */
AnnaBridge 189:f392fc9709a3 254
AnnaBridge 189:f392fc9709a3 255 #if (defined(FSL_FEATURE_SMC_HAS_PARAM) && FSL_FEATURE_SMC_HAS_PARAM)
AnnaBridge 189:f392fc9709a3 256 /*!
AnnaBridge 189:f392fc9709a3 257 * @brief Gets the SMC parameter.
AnnaBridge 189:f392fc9709a3 258 *
AnnaBridge 189:f392fc9709a3 259 * This function gets the SMC parameter including the enabled power mdoes.
AnnaBridge 189:f392fc9709a3 260 *
AnnaBridge 189:f392fc9709a3 261 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 262 * @param param Pointer to the SMC param structure.
AnnaBridge 189:f392fc9709a3 263 */
AnnaBridge 189:f392fc9709a3 264 void SMC_GetParam(SMC_Type *base, smc_param_t *param);
AnnaBridge 189:f392fc9709a3 265 #endif
AnnaBridge 189:f392fc9709a3 266
AnnaBridge 189:f392fc9709a3 267 /*!
AnnaBridge 189:f392fc9709a3 268 * @brief Configures all power mode protection settings.
AnnaBridge 189:f392fc9709a3 269 *
AnnaBridge 189:f392fc9709a3 270 * This function configures the power mode protection settings for
AnnaBridge 189:f392fc9709a3 271 * supported power modes in the specified chip family. The available power modes
AnnaBridge 189:f392fc9709a3 272 * are defined in the smc_power_mode_protection_t. This should be done at an early
AnnaBridge 189:f392fc9709a3 273 * system level initialization stage. See the reference manual for details.
AnnaBridge 189:f392fc9709a3 274 * This register can only write once after the power reset.
AnnaBridge 189:f392fc9709a3 275 *
AnnaBridge 189:f392fc9709a3 276 * The allowed modes are passed as bit map. For example, to allow LLS and VLLS,
AnnaBridge 189:f392fc9709a3 277 * use SMC_SetPowerModeProtection(kSMC_AllowPowerModeVlls | kSMC_AllowPowerModeVlps).
AnnaBridge 189:f392fc9709a3 278 * To allow all modes, use SMC_SetPowerModeProtection(kSMC_AllowPowerModeAll).
AnnaBridge 189:f392fc9709a3 279 *
AnnaBridge 189:f392fc9709a3 280 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 281 * @param allowedModes Bitmap of the allowed power modes.
AnnaBridge 189:f392fc9709a3 282 */
AnnaBridge 189:f392fc9709a3 283 static inline void SMC_SetPowerModeProtection(SMC_Type *base, uint8_t allowedModes)
AnnaBridge 189:f392fc9709a3 284 {
AnnaBridge 189:f392fc9709a3 285 base->PMPROT = allowedModes;
AnnaBridge 189:f392fc9709a3 286 }
AnnaBridge 189:f392fc9709a3 287
AnnaBridge 189:f392fc9709a3 288 /*!
AnnaBridge 189:f392fc9709a3 289 * @brief Gets the current power mode status.
AnnaBridge 189:f392fc9709a3 290 *
AnnaBridge 189:f392fc9709a3 291 * This function returns the current power mode status. After the application
AnnaBridge 189:f392fc9709a3 292 * switches the power mode, it should always check the status to check whether it
AnnaBridge 189:f392fc9709a3 293 * runs into the specified mode or not. The application should check
AnnaBridge 189:f392fc9709a3 294 * this mode before switching to a different mode. The system requires that
AnnaBridge 189:f392fc9709a3 295 * only certain modes can switch to other specific modes. See the
AnnaBridge 189:f392fc9709a3 296 * reference manual for details and the smc_power_state_t for information about
AnnaBridge 189:f392fc9709a3 297 * the power status.
AnnaBridge 189:f392fc9709a3 298 *
AnnaBridge 189:f392fc9709a3 299 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 300 * @return Current power mode status.
AnnaBridge 189:f392fc9709a3 301 */
AnnaBridge 189:f392fc9709a3 302 static inline smc_power_state_t SMC_GetPowerModeState(SMC_Type *base)
AnnaBridge 189:f392fc9709a3 303 {
AnnaBridge 189:f392fc9709a3 304 return (smc_power_state_t)base->PMSTAT;
AnnaBridge 189:f392fc9709a3 305 }
AnnaBridge 189:f392fc9709a3 306
AnnaBridge 189:f392fc9709a3 307 /*!
AnnaBridge 189:f392fc9709a3 308 * @brief Prepares to enter stop modes.
AnnaBridge 189:f392fc9709a3 309 *
AnnaBridge 189:f392fc9709a3 310 * This function should be called before entering STOP/VLPS/LLS/VLLS modes.
AnnaBridge 189:f392fc9709a3 311 */
AnnaBridge 189:f392fc9709a3 312 void SMC_PreEnterStopModes(void);
AnnaBridge 189:f392fc9709a3 313
AnnaBridge 189:f392fc9709a3 314 /*!
AnnaBridge 189:f392fc9709a3 315 * @brief Recovers after wake up from stop modes.
AnnaBridge 189:f392fc9709a3 316 *
AnnaBridge 189:f392fc9709a3 317 * This function should be called after wake up from STOP/VLPS/LLS/VLLS modes.
AnnaBridge 189:f392fc9709a3 318 * It is used with @ref SMC_PreEnterStopModes.
AnnaBridge 189:f392fc9709a3 319 */
AnnaBridge 189:f392fc9709a3 320 void SMC_PostExitStopModes(void);
AnnaBridge 189:f392fc9709a3 321
AnnaBridge 189:f392fc9709a3 322 /*!
AnnaBridge 189:f392fc9709a3 323 * @brief Prepares to enter wait modes.
AnnaBridge 189:f392fc9709a3 324 *
AnnaBridge 189:f392fc9709a3 325 * This function should be called before entering WAIT/VLPW modes.
AnnaBridge 189:f392fc9709a3 326 */
AnnaBridge 189:f392fc9709a3 327 static inline void SMC_PreEnterWaitModes(void)
AnnaBridge 189:f392fc9709a3 328 {
AnnaBridge 189:f392fc9709a3 329 __disable_irq();
AnnaBridge 189:f392fc9709a3 330 __ISB();
AnnaBridge 189:f392fc9709a3 331 }
AnnaBridge 189:f392fc9709a3 332
AnnaBridge 189:f392fc9709a3 333 /*!
AnnaBridge 189:f392fc9709a3 334 * @brief Recovers after wake up from stop modes.
AnnaBridge 189:f392fc9709a3 335 *
AnnaBridge 189:f392fc9709a3 336 * This function should be called after wake up from WAIT/VLPW modes.
AnnaBridge 189:f392fc9709a3 337 * It is used with @ref SMC_PreEnterWaitModes.
AnnaBridge 189:f392fc9709a3 338 */
AnnaBridge 189:f392fc9709a3 339 static inline void SMC_PostExitWaitModes(void)
AnnaBridge 189:f392fc9709a3 340 {
AnnaBridge 189:f392fc9709a3 341 __enable_irq();
AnnaBridge 189:f392fc9709a3 342 __ISB();
AnnaBridge 189:f392fc9709a3 343 }
AnnaBridge 189:f392fc9709a3 344
AnnaBridge 189:f392fc9709a3 345 /*!
AnnaBridge 189:f392fc9709a3 346 * @brief Configures the system to RUN power mode.
AnnaBridge 189:f392fc9709a3 347 *
AnnaBridge 189:f392fc9709a3 348 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 349 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 350 */
AnnaBridge 189:f392fc9709a3 351 status_t SMC_SetPowerModeRun(SMC_Type *base);
AnnaBridge 189:f392fc9709a3 352
AnnaBridge 189:f392fc9709a3 353 #if (defined(FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE) && FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE)
AnnaBridge 189:f392fc9709a3 354 /*!
AnnaBridge 189:f392fc9709a3 355 * @brief Configures the system to HSRUN power mode.
AnnaBridge 189:f392fc9709a3 356 *
AnnaBridge 189:f392fc9709a3 357 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 358 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 359 */
AnnaBridge 189:f392fc9709a3 360 status_t SMC_SetPowerModeHsrun(SMC_Type *base);
AnnaBridge 189:f392fc9709a3 361 #endif /* FSL_FEATURE_SMC_HAS_HIGH_SPEED_RUN_MODE */
AnnaBridge 189:f392fc9709a3 362
AnnaBridge 189:f392fc9709a3 363 /*!
AnnaBridge 189:f392fc9709a3 364 * @brief Configures the system to WAIT power mode.
AnnaBridge 189:f392fc9709a3 365 *
AnnaBridge 189:f392fc9709a3 366 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 367 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 368 */
AnnaBridge 189:f392fc9709a3 369 status_t SMC_SetPowerModeWait(SMC_Type *base);
AnnaBridge 189:f392fc9709a3 370
AnnaBridge 189:f392fc9709a3 371 /*!
AnnaBridge 189:f392fc9709a3 372 * @brief Configures the system to Stop power mode.
AnnaBridge 189:f392fc9709a3 373 *
AnnaBridge 189:f392fc9709a3 374 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 375 * @param option Partial Stop mode option.
AnnaBridge 189:f392fc9709a3 376 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 377 */
AnnaBridge 189:f392fc9709a3 378 status_t SMC_SetPowerModeStop(SMC_Type *base, smc_partial_stop_option_t option);
AnnaBridge 189:f392fc9709a3 379
AnnaBridge 189:f392fc9709a3 380 #if (defined(FSL_FEATURE_SMC_HAS_LPWUI) && FSL_FEATURE_SMC_HAS_LPWUI)
AnnaBridge 189:f392fc9709a3 381 /*!
AnnaBridge 189:f392fc9709a3 382 * @brief Configures the system to VLPR power mode.
AnnaBridge 189:f392fc9709a3 383 *
AnnaBridge 189:f392fc9709a3 384 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 385 * @param wakeupMode Enter Normal Run mode if true, else stay in VLPR mode.
AnnaBridge 189:f392fc9709a3 386 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 387 */
AnnaBridge 189:f392fc9709a3 388 status_t SMC_SetPowerModeVlpr(SMC_Type *base, bool wakeupMode);
AnnaBridge 189:f392fc9709a3 389 #else
AnnaBridge 189:f392fc9709a3 390 /*!
AnnaBridge 189:f392fc9709a3 391 * @brief Configures the system to VLPR power mode.
AnnaBridge 189:f392fc9709a3 392 *
AnnaBridge 189:f392fc9709a3 393 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 394 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 395 */
AnnaBridge 189:f392fc9709a3 396 status_t SMC_SetPowerModeVlpr(SMC_Type *base);
AnnaBridge 189:f392fc9709a3 397 #endif /* FSL_FEATURE_SMC_HAS_LPWUI */
AnnaBridge 189:f392fc9709a3 398
AnnaBridge 189:f392fc9709a3 399 /*!
AnnaBridge 189:f392fc9709a3 400 * @brief Configures the system to VLPW power mode.
AnnaBridge 189:f392fc9709a3 401 *
AnnaBridge 189:f392fc9709a3 402 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 403 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 404 */
AnnaBridge 189:f392fc9709a3 405 status_t SMC_SetPowerModeVlpw(SMC_Type *base);
AnnaBridge 189:f392fc9709a3 406
AnnaBridge 189:f392fc9709a3 407 /*!
AnnaBridge 189:f392fc9709a3 408 * @brief Configures the system to VLPS power mode.
AnnaBridge 189:f392fc9709a3 409 *
AnnaBridge 189:f392fc9709a3 410 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 411 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 412 */
AnnaBridge 189:f392fc9709a3 413 status_t SMC_SetPowerModeVlps(SMC_Type *base);
AnnaBridge 189:f392fc9709a3 414
AnnaBridge 189:f392fc9709a3 415 #if (defined(FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 416 #if ((defined(FSL_FEATURE_SMC_HAS_LLS_SUBMODE) && FSL_FEATURE_SMC_HAS_LLS_SUBMODE) || \
AnnaBridge 189:f392fc9709a3 417 (defined(FSL_FEATURE_SMC_HAS_LPOPO) && FSL_FEATURE_SMC_HAS_LPOPO))
AnnaBridge 189:f392fc9709a3 418 /*!
AnnaBridge 189:f392fc9709a3 419 * @brief Configures the system to LLS power mode.
AnnaBridge 189:f392fc9709a3 420 *
AnnaBridge 189:f392fc9709a3 421 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 422 * @param config The LLS power mode configuration structure
AnnaBridge 189:f392fc9709a3 423 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 424 */
AnnaBridge 189:f392fc9709a3 425 status_t SMC_SetPowerModeLls(SMC_Type *base, const smc_power_mode_lls_config_t *config);
AnnaBridge 189:f392fc9709a3 426 #else
AnnaBridge 189:f392fc9709a3 427 /*!
AnnaBridge 189:f392fc9709a3 428 * @brief Configures the system to LLS power mode.
AnnaBridge 189:f392fc9709a3 429 *
AnnaBridge 189:f392fc9709a3 430 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 431 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 432 */
AnnaBridge 189:f392fc9709a3 433 status_t SMC_SetPowerModeLls(SMC_Type *base);
AnnaBridge 189:f392fc9709a3 434 #endif
AnnaBridge 189:f392fc9709a3 435 #endif /* FSL_FEATURE_SMC_HAS_LOW_LEAKAGE_STOP_MODE */
AnnaBridge 189:f392fc9709a3 436
AnnaBridge 189:f392fc9709a3 437 #if (defined(FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE) && FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE)
AnnaBridge 189:f392fc9709a3 438 /*!
AnnaBridge 189:f392fc9709a3 439 * @brief Configures the system to VLLS power mode.
AnnaBridge 189:f392fc9709a3 440 *
AnnaBridge 189:f392fc9709a3 441 * @param base SMC peripheral base address.
AnnaBridge 189:f392fc9709a3 442 * @param config The VLLS power mode configuration structure.
AnnaBridge 189:f392fc9709a3 443 * @return SMC configuration error code.
AnnaBridge 189:f392fc9709a3 444 */
AnnaBridge 189:f392fc9709a3 445 status_t SMC_SetPowerModeVlls(SMC_Type *base, const smc_power_mode_vlls_config_t *config);
AnnaBridge 189:f392fc9709a3 446 #endif /* FSL_FEATURE_SMC_HAS_VERY_LOW_LEAKAGE_STOP_MODE */
AnnaBridge 189:f392fc9709a3 447
AnnaBridge 189:f392fc9709a3 448 /*@}*/
AnnaBridge 189:f392fc9709a3 449
AnnaBridge 189:f392fc9709a3 450 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 451 }
AnnaBridge 189:f392fc9709a3 452 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 453
AnnaBridge 189:f392fc9709a3 454 /*! @}*/
AnnaBridge 189:f392fc9709a3 455
AnnaBridge 189:f392fc9709a3 456 #endif /* _FSL_SMC_H_ */