Shruti Rawool / pir-motion-sensor

Dependencies:   mbed

Committer:
skrawool
Date:
Mon Dec 05 16:39:27 2016 +0000
Revision:
0:3954a906acc2
PIR grove sensor that sends the sensed data to thingspeak through the wifi module ESP 8266

Who changed what in which revision?

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