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_vref.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_VREF_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_VREF_H_
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #include "fsl_common.h"
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /*!
AnnaBridge 189:f392fc9709a3 37 * @addtogroup vref
AnnaBridge 189:f392fc9709a3 38 * @{
AnnaBridge 189:f392fc9709a3 39 */
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41
AnnaBridge 189:f392fc9709a3 42 /******************************************************************************
AnnaBridge 189:f392fc9709a3 43 * Definitions
AnnaBridge 189:f392fc9709a3 44 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 45
AnnaBridge 189:f392fc9709a3 46 /*! @name Driver version */
AnnaBridge 189:f392fc9709a3 47 /*@{*/
AnnaBridge 189:f392fc9709a3 48 #define FSL_VREF_DRIVER_VERSION (MAKE_VERSION(2, 1, 0)) /*!< Version 2.1.0. */
AnnaBridge 189:f392fc9709a3 49 /*@}*/
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /* Those macros below defined to support SoC family which have VREFL (0.4V) reference */
AnnaBridge 189:f392fc9709a3 52 #if defined(FSL_FEATURE_VREF_HAS_LOW_REFERENCE) && FSL_FEATURE_VREF_HAS_LOW_REFERENCE
AnnaBridge 189:f392fc9709a3 53 #define VREF_SC_MODE_LV VREF_VREFH_SC_MODE_LV
AnnaBridge 189:f392fc9709a3 54 #define VREF_SC_REGEN VREF_VREFH_SC_REGEN
AnnaBridge 189:f392fc9709a3 55 #define VREF_SC_VREFEN VREF_VREFH_SC_VREFEN
AnnaBridge 189:f392fc9709a3 56 #define VREF_SC_ICOMPEN VREF_VREFH_SC_ICOMPEN
AnnaBridge 189:f392fc9709a3 57 #define VREF_SC_REGEN_MASK VREF_VREFH_SC_REGEN_MASK
AnnaBridge 189:f392fc9709a3 58 #define VREF_SC_VREFST_MASK VREF_VREFH_SC_VREFST_MASK
AnnaBridge 189:f392fc9709a3 59 #define VREF_SC_VREFEN_MASK VREF_VREFH_SC_VREFEN_MASK
AnnaBridge 189:f392fc9709a3 60 #define VREF_SC_MODE_LV_MASK VREF_VREFH_SC_MODE_LV_MASK
AnnaBridge 189:f392fc9709a3 61 #define VREF_SC_ICOMPEN_MASK VREF_VREFH_SC_ICOMPEN_MASK
AnnaBridge 189:f392fc9709a3 62 #define TRM VREFH_TRM
AnnaBridge 189:f392fc9709a3 63 #define VREF_TRM_TRIM VREF_VREFH_TRM_TRIM
AnnaBridge 189:f392fc9709a3 64 #define VREF_TRM_CHOPEN_MASK VREF_VREFH_TRM_CHOPEN_MASK
AnnaBridge 189:f392fc9709a3 65 #define VREF_TRM_TRIM_MASK VREF_VREFH_TRM_TRIM_MASK
AnnaBridge 189:f392fc9709a3 66 #define VREF_TRM_CHOPEN_SHIFT VREF_VREFH_TRM_CHOPEN_SHIFT
AnnaBridge 189:f392fc9709a3 67 #define VREF_TRM_TRIM_SHIFT VREF_VREFH_TRM_TRIM_SHIFT
AnnaBridge 189:f392fc9709a3 68 #define VREF_SC_MODE_LV_SHIFT VREF_VREFH_SC_MODE_LV_SHIFT
AnnaBridge 189:f392fc9709a3 69 #define VREF_SC_REGEN_SHIFT VREF_VREFH_SC_REGEN_SHIFT
AnnaBridge 189:f392fc9709a3 70 #define VREF_SC_VREFST_SHIFT VREF_VREFH_SC_VREFST_SHIFT
AnnaBridge 189:f392fc9709a3 71 #define VREF_SC_ICOMPEN_SHIFT VREF_VREFH_SC_ICOMPEN_SHIFT
AnnaBridge 189:f392fc9709a3 72 #endif /* FSL_FEATURE_VREF_HAS_LOW_REFERENCE */
AnnaBridge 189:f392fc9709a3 73
AnnaBridge 189:f392fc9709a3 74 /*!
AnnaBridge 189:f392fc9709a3 75 * @brief VREF modes.
AnnaBridge 189:f392fc9709a3 76 */
AnnaBridge 189:f392fc9709a3 77 typedef enum _vref_buffer_mode
AnnaBridge 189:f392fc9709a3 78 {
AnnaBridge 189:f392fc9709a3 79 kVREF_ModeBandgapOnly = 0U, /*!< Bandgap on only, for stabilization and startup */
AnnaBridge 189:f392fc9709a3 80 #if defined(FSL_FEATURE_VREF_MODE_LV_TYPE) && FSL_FEATURE_VREF_MODE_LV_TYPE
AnnaBridge 189:f392fc9709a3 81 kVREF_ModeHighPowerBuffer = 1U, /*!< High-power buffer mode enabled */
AnnaBridge 189:f392fc9709a3 82 kVREF_ModeLowPowerBuffer = 2U /*!< Low-power buffer mode enabled */
AnnaBridge 189:f392fc9709a3 83 #else
AnnaBridge 189:f392fc9709a3 84 kVREF_ModeTightRegulationBuffer = 2U /*!< Tight regulation buffer enabled */
AnnaBridge 189:f392fc9709a3 85 #endif /* FSL_FEATURE_VREF_MODE_LV_TYPE */
AnnaBridge 189:f392fc9709a3 86 } vref_buffer_mode_t;
AnnaBridge 189:f392fc9709a3 87
AnnaBridge 189:f392fc9709a3 88 /*!
AnnaBridge 189:f392fc9709a3 89 * @brief The description structure for the VREF module.
AnnaBridge 189:f392fc9709a3 90 */
AnnaBridge 189:f392fc9709a3 91 typedef struct _vref_config
AnnaBridge 189:f392fc9709a3 92 {
AnnaBridge 189:f392fc9709a3 93 vref_buffer_mode_t bufferMode; /*!< Buffer mode selection */
AnnaBridge 189:f392fc9709a3 94 #if defined(FSL_FEATURE_VREF_HAS_LOW_REFERENCE) && FSL_FEATURE_VREF_HAS_LOW_REFERENCE
AnnaBridge 189:f392fc9709a3 95 bool enableLowRef; /*!< Set VREFL (0.4 V) reference buffer enable or disable */
AnnaBridge 189:f392fc9709a3 96 bool enableExternalVoltRef; /*!< Select external voltage reference or not (internal) */
AnnaBridge 189:f392fc9709a3 97 #endif /* FSL_FEATURE_VREF_HAS_LOW_REFERENCE */
AnnaBridge 189:f392fc9709a3 98 #if defined(FSL_FEATURE_VREF_HAS_TRM4) && FSL_FEATURE_VREF_HAS_TRM4
AnnaBridge 189:f392fc9709a3 99 bool enable2V1VoltRef; /*!< Enable Internal Voltage Reference (2.1V) */
AnnaBridge 189:f392fc9709a3 100 #endif /* FSL_FEATURE_VREF_HAS_TRM4 */
AnnaBridge 189:f392fc9709a3 101 } vref_config_t;
AnnaBridge 189:f392fc9709a3 102
AnnaBridge 189:f392fc9709a3 103 /******************************************************************************
AnnaBridge 189:f392fc9709a3 104 * API
AnnaBridge 189:f392fc9709a3 105 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 106
AnnaBridge 189:f392fc9709a3 107 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 108 extern "C" {
AnnaBridge 189:f392fc9709a3 109 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 110
AnnaBridge 189:f392fc9709a3 111 /*!
AnnaBridge 189:f392fc9709a3 112 * @name VREF functional operation
AnnaBridge 189:f392fc9709a3 113 * @{
AnnaBridge 189:f392fc9709a3 114 */
AnnaBridge 189:f392fc9709a3 115
AnnaBridge 189:f392fc9709a3 116 /*!
AnnaBridge 189:f392fc9709a3 117 * @brief Enables the clock gate and configures the VREF module according to the configuration structure.
AnnaBridge 189:f392fc9709a3 118 *
AnnaBridge 189:f392fc9709a3 119 * This function must be called before calling all other VREF driver functions,
AnnaBridge 189:f392fc9709a3 120 * read/write registers, and configurations with user-defined settings.
AnnaBridge 189:f392fc9709a3 121 * The example below shows how to set up vref_config_t parameters and
AnnaBridge 189:f392fc9709a3 122 * how to call the VREF_Init function by passing in these parameters.
AnnaBridge 189:f392fc9709a3 123 * This is an example.
AnnaBridge 189:f392fc9709a3 124 * @code
AnnaBridge 189:f392fc9709a3 125 * vref_config_t vrefConfig;
AnnaBridge 189:f392fc9709a3 126 * vrefConfig.bufferMode = kVREF_ModeHighPowerBuffer;
AnnaBridge 189:f392fc9709a3 127 * vrefConfig.enableExternalVoltRef = false;
AnnaBridge 189:f392fc9709a3 128 * vrefConfig.enableLowRef = false;
AnnaBridge 189:f392fc9709a3 129 * VREF_Init(VREF, &vrefConfig);
AnnaBridge 189:f392fc9709a3 130 * @endcode
AnnaBridge 189:f392fc9709a3 131 *
AnnaBridge 189:f392fc9709a3 132 * @param base VREF peripheral address.
AnnaBridge 189:f392fc9709a3 133 * @param config Pointer to the configuration structure.
AnnaBridge 189:f392fc9709a3 134 */
AnnaBridge 189:f392fc9709a3 135 void VREF_Init(VREF_Type *base, const vref_config_t *config);
AnnaBridge 189:f392fc9709a3 136
AnnaBridge 189:f392fc9709a3 137 /*!
AnnaBridge 189:f392fc9709a3 138 * @brief Stops and disables the clock for the VREF module.
AnnaBridge 189:f392fc9709a3 139 *
AnnaBridge 189:f392fc9709a3 140 * This function should be called to shut down the module.
AnnaBridge 189:f392fc9709a3 141 * This is an example.
AnnaBridge 189:f392fc9709a3 142 * @code
AnnaBridge 189:f392fc9709a3 143 * vref_config_t vrefUserConfig;
AnnaBridge 189:f392fc9709a3 144 * VREF_Init(VREF);
AnnaBridge 189:f392fc9709a3 145 * VREF_GetDefaultConfig(&vrefUserConfig);
AnnaBridge 189:f392fc9709a3 146 * ...
AnnaBridge 189:f392fc9709a3 147 * VREF_Deinit(VREF);
AnnaBridge 189:f392fc9709a3 148 * @endcode
AnnaBridge 189:f392fc9709a3 149 *
AnnaBridge 189:f392fc9709a3 150 * @param base VREF peripheral address.
AnnaBridge 189:f392fc9709a3 151 */
AnnaBridge 189:f392fc9709a3 152 void VREF_Deinit(VREF_Type *base);
AnnaBridge 189:f392fc9709a3 153
AnnaBridge 189:f392fc9709a3 154 /*!
AnnaBridge 189:f392fc9709a3 155 * @brief Initializes the VREF configuration structure.
AnnaBridge 189:f392fc9709a3 156 *
AnnaBridge 189:f392fc9709a3 157 * This function initializes the VREF configuration structure to default values.
AnnaBridge 189:f392fc9709a3 158 * This is an example.
AnnaBridge 189:f392fc9709a3 159 * @code
AnnaBridge 189:f392fc9709a3 160 * vrefConfig->bufferMode = kVREF_ModeHighPowerBuffer;
AnnaBridge 189:f392fc9709a3 161 * vrefConfig->enableExternalVoltRef = false;
AnnaBridge 189:f392fc9709a3 162 * vrefConfig->enableLowRef = false;
AnnaBridge 189:f392fc9709a3 163 * @endcode
AnnaBridge 189:f392fc9709a3 164 *
AnnaBridge 189:f392fc9709a3 165 * @param config Pointer to the initialization structure.
AnnaBridge 189:f392fc9709a3 166 */
AnnaBridge 189:f392fc9709a3 167 void VREF_GetDefaultConfig(vref_config_t *config);
AnnaBridge 189:f392fc9709a3 168
AnnaBridge 189:f392fc9709a3 169 /*!
AnnaBridge 189:f392fc9709a3 170 * @brief Sets a TRIM value for the reference voltage.
AnnaBridge 189:f392fc9709a3 171 *
AnnaBridge 189:f392fc9709a3 172 * This function sets a TRIM value for the reference voltage.
AnnaBridge 189:f392fc9709a3 173 * Note that the TRIM value maximum is 0x3F.
AnnaBridge 189:f392fc9709a3 174 *
AnnaBridge 189:f392fc9709a3 175 * @param base VREF peripheral address.
AnnaBridge 189:f392fc9709a3 176 * @param trimValue Value of the trim register to set the output reference voltage (maximum 0x3F (6-bit)).
AnnaBridge 189:f392fc9709a3 177 */
AnnaBridge 189:f392fc9709a3 178 void VREF_SetTrimVal(VREF_Type *base, uint8_t trimValue);
AnnaBridge 189:f392fc9709a3 179
AnnaBridge 189:f392fc9709a3 180 /*!
AnnaBridge 189:f392fc9709a3 181 * @brief Reads the value of the TRIM meaning output voltage.
AnnaBridge 189:f392fc9709a3 182 *
AnnaBridge 189:f392fc9709a3 183 * This function gets the TRIM value from the TRM register.
AnnaBridge 189:f392fc9709a3 184 *
AnnaBridge 189:f392fc9709a3 185 * @param base VREF peripheral address.
AnnaBridge 189:f392fc9709a3 186 * @return Six-bit value of trim setting.
AnnaBridge 189:f392fc9709a3 187 */
AnnaBridge 189:f392fc9709a3 188 static inline uint8_t VREF_GetTrimVal(VREF_Type *base)
AnnaBridge 189:f392fc9709a3 189 {
AnnaBridge 189:f392fc9709a3 190 return (base->TRM & VREF_TRM_TRIM_MASK);
AnnaBridge 189:f392fc9709a3 191 }
AnnaBridge 189:f392fc9709a3 192
AnnaBridge 189:f392fc9709a3 193 #if defined(FSL_FEATURE_VREF_HAS_TRM4) && FSL_FEATURE_VREF_HAS_TRM4
AnnaBridge 189:f392fc9709a3 194 /*!
AnnaBridge 189:f392fc9709a3 195 * @brief Sets a TRIM value for the reference voltage (2V1).
AnnaBridge 189:f392fc9709a3 196 *
AnnaBridge 189:f392fc9709a3 197 * This function sets a TRIM value for the reference voltage (2V1).
AnnaBridge 189:f392fc9709a3 198 * Note that the TRIM value maximum is 0x3F.
AnnaBridge 189:f392fc9709a3 199 *
AnnaBridge 189:f392fc9709a3 200 * @param base VREF peripheral address.
AnnaBridge 189:f392fc9709a3 201 * @param trimValue Value of the trim register to set the output reference voltage (maximum 0x3F (6-bit)).
AnnaBridge 189:f392fc9709a3 202 */
AnnaBridge 189:f392fc9709a3 203 void VREF_SetTrim2V1Val(VREF_Type *base, uint8_t trimValue);
AnnaBridge 189:f392fc9709a3 204
AnnaBridge 189:f392fc9709a3 205 /*!
AnnaBridge 189:f392fc9709a3 206 * @brief Reads the value of the TRIM meaning output voltage (2V1).
AnnaBridge 189:f392fc9709a3 207 *
AnnaBridge 189:f392fc9709a3 208 * This function gets the TRIM value from the VREF_TRM4 register.
AnnaBridge 189:f392fc9709a3 209 *
AnnaBridge 189:f392fc9709a3 210 * @param base VREF peripheral address.
AnnaBridge 189:f392fc9709a3 211 * @return Six-bit value of trim setting.
AnnaBridge 189:f392fc9709a3 212 */
AnnaBridge 189:f392fc9709a3 213 static inline uint8_t VREF_GetTrim2V1Val(VREF_Type *base)
AnnaBridge 189:f392fc9709a3 214 {
AnnaBridge 189:f392fc9709a3 215 return (base->TRM4 & VREF_TRM4_TRIM2V1_MASK);
AnnaBridge 189:f392fc9709a3 216 }
AnnaBridge 189:f392fc9709a3 217 #endif /* FSL_FEATURE_VREF_HAS_TRM4 */
AnnaBridge 189:f392fc9709a3 218
AnnaBridge 189:f392fc9709a3 219 #if defined(FSL_FEATURE_VREF_HAS_LOW_REFERENCE) && FSL_FEATURE_VREF_HAS_LOW_REFERENCE
AnnaBridge 189:f392fc9709a3 220
AnnaBridge 189:f392fc9709a3 221 /*!
AnnaBridge 189:f392fc9709a3 222 * @brief Sets the TRIM value for the low voltage reference.
AnnaBridge 189:f392fc9709a3 223 *
AnnaBridge 189:f392fc9709a3 224 * This function sets the TRIM value for low reference voltage.
AnnaBridge 189:f392fc9709a3 225 * Note the following.
AnnaBridge 189:f392fc9709a3 226 * - The TRIM value maximum is 0x05U
AnnaBridge 189:f392fc9709a3 227 * - The values 111b and 110b are not valid/allowed.
AnnaBridge 189:f392fc9709a3 228 *
AnnaBridge 189:f392fc9709a3 229 * @param base VREF peripheral address.
AnnaBridge 189:f392fc9709a3 230 * @param trimValue Value of the trim register to set output low reference voltage (maximum 0x05U (3-bit)).
AnnaBridge 189:f392fc9709a3 231 */
AnnaBridge 189:f392fc9709a3 232 void VREF_SetLowReferenceTrimVal(VREF_Type *base, uint8_t trimValue);
AnnaBridge 189:f392fc9709a3 233
AnnaBridge 189:f392fc9709a3 234 /*!
AnnaBridge 189:f392fc9709a3 235 * @brief Reads the value of the TRIM meaning output voltage.
AnnaBridge 189:f392fc9709a3 236 *
AnnaBridge 189:f392fc9709a3 237 * This function gets the TRIM value from the VREFL_TRM register.
AnnaBridge 189:f392fc9709a3 238 *
AnnaBridge 189:f392fc9709a3 239 * @param base VREF peripheral address.
AnnaBridge 189:f392fc9709a3 240 * @return Three-bit value of the trim setting.
AnnaBridge 189:f392fc9709a3 241 */
AnnaBridge 189:f392fc9709a3 242 static inline uint8_t VREF_GetLowReferenceTrimVal(VREF_Type *base)
AnnaBridge 189:f392fc9709a3 243 {
AnnaBridge 189:f392fc9709a3 244 return (base->VREFL_TRM & VREF_VREFL_TRM_VREFL_TRIM_MASK);
AnnaBridge 189:f392fc9709a3 245 }
AnnaBridge 189:f392fc9709a3 246 #endif /* FSL_FEATURE_VREF_HAS_LOW_REFERENCE */
AnnaBridge 189:f392fc9709a3 247
AnnaBridge 189:f392fc9709a3 248 /*@}*/
AnnaBridge 189:f392fc9709a3 249
AnnaBridge 189:f392fc9709a3 250 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 251 }
AnnaBridge 189:f392fc9709a3 252 #endif /* __cplusplus */
AnnaBridge 189:f392fc9709a3 253
AnnaBridge 189:f392fc9709a3 254 /*! @}*/
AnnaBridge 189:f392fc9709a3 255
AnnaBridge 189:f392fc9709a3 256 #endif /* _FSL_VREF_H_ */