Kevin Kadooka / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

targets/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_K82F/drivers/fsl_vref.h@154:37f96f9d4de2, 2017-01-04 (annotated)

Committer:
<>
Date:
Wed Jan 04 16:58:05 2017 +0000
Revision:
154:37f96f9d4de2
This updates the lib to the mbed lib v133

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 154:37f96f9d4de2 1 /*
<> 154:37f96f9d4de2 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
<> 154:37f96f9d4de2 3 * All rights reserved.
<> 154:37f96f9d4de2 4 *
<> 154:37f96f9d4de2 5 * Redistribution and use in source and binary forms, with or without modification,
<> 154:37f96f9d4de2 6 * are permitted provided that the following conditions are met:
<> 154:37f96f9d4de2 7 *
<> 154:37f96f9d4de2 8 * o Redistributions of source code must retain the above copyright notice, this list
<> 154:37f96f9d4de2 9 * of conditions and the following disclaimer.
<> 154:37f96f9d4de2 10 *
<> 154:37f96f9d4de2 11 * o Redistributions in binary form must reproduce the above copyright notice, this
<> 154:37f96f9d4de2 12 * list of conditions and the following disclaimer in the documentation and/or
<> 154:37f96f9d4de2 13 * other materials provided with the distribution.
<> 154:37f96f9d4de2 14 *
<> 154:37f96f9d4de2 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
<> 154:37f96f9d4de2 16 * contributors may be used to endorse or promote products derived from this
<> 154:37f96f9d4de2 17 * software without specific prior written permission.
<> 154:37f96f9d4de2 18 *
<> 154:37f96f9d4de2 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
<> 154:37f96f9d4de2 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
<> 154:37f96f9d4de2 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 154:37f96f9d4de2 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
<> 154:37f96f9d4de2 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
<> 154:37f96f9d4de2 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
<> 154:37f96f9d4de2 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
<> 154:37f96f9d4de2 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
<> 154:37f96f9d4de2 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
<> 154:37f96f9d4de2 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 154:37f96f9d4de2 29 */
<> 154:37f96f9d4de2 30
<> 154:37f96f9d4de2 31 #ifndef _FSL_VREF_H_
<> 154:37f96f9d4de2 32 #define _FSL_VREF_H_
<> 154:37f96f9d4de2 33
<> 154:37f96f9d4de2 34 #include "fsl_common.h"
<> 154:37f96f9d4de2 35
<> 154:37f96f9d4de2 36 /*!
<> 154:37f96f9d4de2 37 * @addtogroup vref
<> 154:37f96f9d4de2 38 * @{
<> 154:37f96f9d4de2 39 */
<> 154:37f96f9d4de2 40
<> 154:37f96f9d4de2 41
<> 154:37f96f9d4de2 42 /******************************************************************************
<> 154:37f96f9d4de2 43 * Definitions
<> 154:37f96f9d4de2 44 ******************************************************************************/
<> 154:37f96f9d4de2 45
<> 154:37f96f9d4de2 46 /*! @name Driver version */
<> 154:37f96f9d4de2 47 /*@{*/
<> 154:37f96f9d4de2 48 #define FSL_VREF_DRIVER_VERSION (MAKE_VERSION(2, 1, 0)) /*!< Version 2.1.0. */
<> 154:37f96f9d4de2 49 /*@}*/
<> 154:37f96f9d4de2 50
<> 154:37f96f9d4de2 51 /* Those macros below defined to support SoC family which have VREFL (0.4V) reference */
<> 154:37f96f9d4de2 52 #if defined(FSL_FEATURE_VREF_HAS_LOW_REFERENCE) && FSL_FEATURE_VREF_HAS_LOW_REFERENCE
<> 154:37f96f9d4de2 53 #define VREF_SC_MODE_LV VREF_VREFH_SC_MODE_LV
<> 154:37f96f9d4de2 54 #define VREF_SC_REGEN VREF_VREFH_SC_REGEN
<> 154:37f96f9d4de2 55 #define VREF_SC_VREFEN VREF_VREFH_SC_VREFEN
<> 154:37f96f9d4de2 56 #define VREF_SC_ICOMPEN VREF_VREFH_SC_ICOMPEN
<> 154:37f96f9d4de2 57 #define VREF_SC_REGEN_MASK VREF_VREFH_SC_REGEN_MASK
<> 154:37f96f9d4de2 58 #define VREF_SC_VREFST_MASK VREF_VREFH_SC_VREFST_MASK
<> 154:37f96f9d4de2 59 #define VREF_SC_VREFEN_MASK VREF_VREFH_SC_VREFEN_MASK
<> 154:37f96f9d4de2 60 #define VREF_SC_MODE_LV_MASK VREF_VREFH_SC_MODE_LV_MASK
<> 154:37f96f9d4de2 61 #define VREF_SC_ICOMPEN_MASK VREF_VREFH_SC_ICOMPEN_MASK
<> 154:37f96f9d4de2 62 #define TRM VREFH_TRM
<> 154:37f96f9d4de2 63 #define VREF_TRM_TRIM VREF_VREFH_TRM_TRIM
<> 154:37f96f9d4de2 64 #define VREF_TRM_CHOPEN_MASK VREF_VREFH_TRM_CHOPEN_MASK
<> 154:37f96f9d4de2 65 #define VREF_TRM_TRIM_MASK VREF_VREFH_TRM_TRIM_MASK
<> 154:37f96f9d4de2 66 #define VREF_TRM_CHOPEN_SHIFT VREF_VREFH_TRM_CHOPEN_SHIFT
<> 154:37f96f9d4de2 67 #define VREF_TRM_TRIM_SHIFT VREF_VREFH_TRM_TRIM_SHIFT
<> 154:37f96f9d4de2 68 #define VREF_SC_MODE_LV_SHIFT VREF_VREFH_SC_MODE_LV_SHIFT
<> 154:37f96f9d4de2 69 #define VREF_SC_REGEN_SHIFT VREF_VREFH_SC_REGEN_SHIFT
<> 154:37f96f9d4de2 70 #define VREF_SC_VREFST_SHIFT VREF_VREFH_SC_VREFST_SHIFT
<> 154:37f96f9d4de2 71 #define VREF_SC_ICOMPEN_SHIFT VREF_VREFH_SC_ICOMPEN_SHIFT
<> 154:37f96f9d4de2 72 #endif /* FSL_FEATURE_VREF_HAS_LOW_REFERENCE */
<> 154:37f96f9d4de2 73
<> 154:37f96f9d4de2 74 /*!
<> 154:37f96f9d4de2 75 * @brief VREF modes.
<> 154:37f96f9d4de2 76 */
<> 154:37f96f9d4de2 77 typedef enum _vref_buffer_mode
<> 154:37f96f9d4de2 78 {
<> 154:37f96f9d4de2 79 kVREF_ModeBandgapOnly = 0U, /*!< Bandgap on only, for stabilization and startup */
<> 154:37f96f9d4de2 80 #if defined(FSL_FEATURE_VREF_MODE_LV_TYPE) && FSL_FEATURE_VREF_MODE_LV_TYPE
<> 154:37f96f9d4de2 81 kVREF_ModeHighPowerBuffer = 1U, /*!< High-power buffer mode enabled */
<> 154:37f96f9d4de2 82 kVREF_ModeLowPowerBuffer = 2U /*!< Low-power buffer mode enabled */
<> 154:37f96f9d4de2 83 #else
<> 154:37f96f9d4de2 84 kVREF_ModeTightRegulationBuffer = 2U /*!< Tight regulation buffer enabled */
<> 154:37f96f9d4de2 85 #endif /* FSL_FEATURE_VREF_MODE_LV_TYPE */
<> 154:37f96f9d4de2 86 } vref_buffer_mode_t;
<> 154:37f96f9d4de2 87
<> 154:37f96f9d4de2 88 /*!
<> 154:37f96f9d4de2 89 * @brief The description structure for the VREF module.
<> 154:37f96f9d4de2 90 */
<> 154:37f96f9d4de2 91 typedef struct _vref_config
<> 154:37f96f9d4de2 92 {
<> 154:37f96f9d4de2 93 vref_buffer_mode_t bufferMode; /*!< Buffer mode selection */
<> 154:37f96f9d4de2 94 #if defined(FSL_FEATURE_VREF_HAS_LOW_REFERENCE) && FSL_FEATURE_VREF_HAS_LOW_REFERENCE
<> 154:37f96f9d4de2 95 bool enableLowRef; /*!< Set VREFL (0.4 V) reference buffer enable or disable */
<> 154:37f96f9d4de2 96 bool enableExternalVoltRef; /*!< Select external voltage reference or not (internal) */
<> 154:37f96f9d4de2 97 #endif /* FSL_FEATURE_VREF_HAS_LOW_REFERENCE */
<> 154:37f96f9d4de2 98 #if defined(FSL_FEATURE_VREF_HAS_TRM4) && FSL_FEATURE_VREF_HAS_TRM4
<> 154:37f96f9d4de2 99 bool enable2V1VoltRef; /*!< Enable Internal Voltage Reference (2.1V) */
<> 154:37f96f9d4de2 100 #endif /* FSL_FEATURE_VREF_HAS_TRM4 */
<> 154:37f96f9d4de2 101 } vref_config_t;
<> 154:37f96f9d4de2 102
<> 154:37f96f9d4de2 103 /******************************************************************************
<> 154:37f96f9d4de2 104 * API
<> 154:37f96f9d4de2 105 ******************************************************************************/
<> 154:37f96f9d4de2 106
<> 154:37f96f9d4de2 107 #if defined(__cplusplus)
<> 154:37f96f9d4de2 108 extern "C" {
<> 154:37f96f9d4de2 109 #endif /* __cplusplus */
<> 154:37f96f9d4de2 110
<> 154:37f96f9d4de2 111 /*!
<> 154:37f96f9d4de2 112 * @name VREF functional operation
<> 154:37f96f9d4de2 113 * @{
<> 154:37f96f9d4de2 114 */
<> 154:37f96f9d4de2 115
<> 154:37f96f9d4de2 116 /*!
<> 154:37f96f9d4de2 117 * @brief Enables the clock gate and configures the VREF module according to the configuration structure.
<> 154:37f96f9d4de2 118 *
<> 154:37f96f9d4de2 119 * This function must be called before calling all other VREF driver functions,
<> 154:37f96f9d4de2 120 * read/write registers, and configurations with user-defined settings.
<> 154:37f96f9d4de2 121 * The example below shows how to set up vref_config_t parameters and
<> 154:37f96f9d4de2 122 * how to call the VREF_Init function by passing in these parameters.
<> 154:37f96f9d4de2 123 * This is an example.
<> 154:37f96f9d4de2 124 * @code
<> 154:37f96f9d4de2 125 * vref_config_t vrefConfig;
<> 154:37f96f9d4de2 126 * vrefConfig.bufferMode = kVREF_ModeHighPowerBuffer;
<> 154:37f96f9d4de2 127 * vrefConfig.enableExternalVoltRef = false;
<> 154:37f96f9d4de2 128 * vrefConfig.enableLowRef = false;
<> 154:37f96f9d4de2 129 * VREF_Init(VREF, &vrefConfig);
<> 154:37f96f9d4de2 130 * @endcode
<> 154:37f96f9d4de2 131 *
<> 154:37f96f9d4de2 132 * @param base VREF peripheral address.
<> 154:37f96f9d4de2 133 * @param config Pointer to the configuration structure.
<> 154:37f96f9d4de2 134 */
<> 154:37f96f9d4de2 135 void VREF_Init(VREF_Type *base, const vref_config_t *config);
<> 154:37f96f9d4de2 136
<> 154:37f96f9d4de2 137 /*!
<> 154:37f96f9d4de2 138 * @brief Stops and disables the clock for the VREF module.
<> 154:37f96f9d4de2 139 *
<> 154:37f96f9d4de2 140 * This function should be called to shut down the module.
<> 154:37f96f9d4de2 141 * This is an example.
<> 154:37f96f9d4de2 142 * @code
<> 154:37f96f9d4de2 143 * vref_config_t vrefUserConfig;
<> 154:37f96f9d4de2 144 * VREF_Init(VREF);
<> 154:37f96f9d4de2 145 * VREF_GetDefaultConfig(&vrefUserConfig);
<> 154:37f96f9d4de2 146 * ...
<> 154:37f96f9d4de2 147 * VREF_Deinit(VREF);
<> 154:37f96f9d4de2 148 * @endcode
<> 154:37f96f9d4de2 149 *
<> 154:37f96f9d4de2 150 * @param base VREF peripheral address.
<> 154:37f96f9d4de2 151 */
<> 154:37f96f9d4de2 152 void VREF_Deinit(VREF_Type *base);
<> 154:37f96f9d4de2 153
<> 154:37f96f9d4de2 154 /*!
<> 154:37f96f9d4de2 155 * @brief Initializes the VREF configuration structure.
<> 154:37f96f9d4de2 156 *
<> 154:37f96f9d4de2 157 * This function initializes the VREF configuration structure to default values.
<> 154:37f96f9d4de2 158 * This is an example.
<> 154:37f96f9d4de2 159 * @code
<> 154:37f96f9d4de2 160 * vrefConfig->bufferMode = kVREF_ModeHighPowerBuffer;
<> 154:37f96f9d4de2 161 * vrefConfig->enableExternalVoltRef = false;
<> 154:37f96f9d4de2 162 * vrefConfig->enableLowRef = false;
<> 154:37f96f9d4de2 163 * @endcode
<> 154:37f96f9d4de2 164 *
<> 154:37f96f9d4de2 165 * @param config Pointer to the initialization structure.
<> 154:37f96f9d4de2 166 */
<> 154:37f96f9d4de2 167 void VREF_GetDefaultConfig(vref_config_t *config);
<> 154:37f96f9d4de2 168
<> 154:37f96f9d4de2 169 /*!
<> 154:37f96f9d4de2 170 * @brief Sets a TRIM value for the reference voltage.
<> 154:37f96f9d4de2 171 *
<> 154:37f96f9d4de2 172 * This function sets a TRIM value for the reference voltage.
<> 154:37f96f9d4de2 173 * Note that the TRIM value maximum is 0x3F.
<> 154:37f96f9d4de2 174 *
<> 154:37f96f9d4de2 175 * @param base VREF peripheral address.
<> 154:37f96f9d4de2 176 * @param trimValue Value of the trim register to set the output reference voltage (maximum 0x3F (6-bit)).
<> 154:37f96f9d4de2 177 */
<> 154:37f96f9d4de2 178 void VREF_SetTrimVal(VREF_Type *base, uint8_t trimValue);
<> 154:37f96f9d4de2 179
<> 154:37f96f9d4de2 180 /*!
<> 154:37f96f9d4de2 181 * @brief Reads the value of the TRIM meaning output voltage.
<> 154:37f96f9d4de2 182 *
<> 154:37f96f9d4de2 183 * This function gets the TRIM value from the TRM register.
<> 154:37f96f9d4de2 184 *
<> 154:37f96f9d4de2 185 * @param base VREF peripheral address.
<> 154:37f96f9d4de2 186 * @return Six-bit value of trim setting.
<> 154:37f96f9d4de2 187 */
<> 154:37f96f9d4de2 188 static inline uint8_t VREF_GetTrimVal(VREF_Type *base)
<> 154:37f96f9d4de2 189 {
<> 154:37f96f9d4de2 190 return (base->TRM & VREF_TRM_TRIM_MASK);
<> 154:37f96f9d4de2 191 }
<> 154:37f96f9d4de2 192
<> 154:37f96f9d4de2 193 #if defined(FSL_FEATURE_VREF_HAS_TRM4) && FSL_FEATURE_VREF_HAS_TRM4
<> 154:37f96f9d4de2 194 /*!
<> 154:37f96f9d4de2 195 * @brief Sets a TRIM value for the reference voltage (2V1).
<> 154:37f96f9d4de2 196 *
<> 154:37f96f9d4de2 197 * This function sets a TRIM value for the reference voltage (2V1).
<> 154:37f96f9d4de2 198 * Note that the TRIM value maximum is 0x3F.
<> 154:37f96f9d4de2 199 *
<> 154:37f96f9d4de2 200 * @param base VREF peripheral address.
<> 154:37f96f9d4de2 201 * @param trimValue Value of the trim register to set the output reference voltage (maximum 0x3F (6-bit)).
<> 154:37f96f9d4de2 202 */
<> 154:37f96f9d4de2 203 void VREF_SetTrim2V1Val(VREF_Type *base, uint8_t trimValue);
<> 154:37f96f9d4de2 204
<> 154:37f96f9d4de2 205 /*!
<> 154:37f96f9d4de2 206 * @brief Reads the value of the TRIM meaning output voltage (2V1).
<> 154:37f96f9d4de2 207 *
<> 154:37f96f9d4de2 208 * This function gets the TRIM value from the VREF_TRM4 register.
<> 154:37f96f9d4de2 209 *
<> 154:37f96f9d4de2 210 * @param base VREF peripheral address.
<> 154:37f96f9d4de2 211 * @return Six-bit value of trim setting.
<> 154:37f96f9d4de2 212 */
<> 154:37f96f9d4de2 213 static inline uint8_t VREF_GetTrim2V1Val(VREF_Type *base)
<> 154:37f96f9d4de2 214 {
<> 154:37f96f9d4de2 215 return (base->TRM4 & VREF_TRM4_TRIM2V1_MASK);
<> 154:37f96f9d4de2 216 }
<> 154:37f96f9d4de2 217 #endif /* FSL_FEATURE_VREF_HAS_TRM4 */
<> 154:37f96f9d4de2 218
<> 154:37f96f9d4de2 219 #if defined(FSL_FEATURE_VREF_HAS_LOW_REFERENCE) && FSL_FEATURE_VREF_HAS_LOW_REFERENCE
<> 154:37f96f9d4de2 220
<> 154:37f96f9d4de2 221 /*!
<> 154:37f96f9d4de2 222 * @brief Sets the TRIM value for the low voltage reference.
<> 154:37f96f9d4de2 223 *
<> 154:37f96f9d4de2 224 * This function sets the TRIM value for low reference voltage.
<> 154:37f96f9d4de2 225 * Note the following.
<> 154:37f96f9d4de2 226 * - The TRIM value maximum is 0x05U
<> 154:37f96f9d4de2 227 * - The values 111b and 110b are not valid/allowed.
<> 154:37f96f9d4de2 228 *
<> 154:37f96f9d4de2 229 * @param base VREF peripheral address.
<> 154:37f96f9d4de2 230 * @param trimValue Value of the trim register to set output low reference voltage (maximum 0x05U (3-bit)).
<> 154:37f96f9d4de2 231 */
<> 154:37f96f9d4de2 232 void VREF_SetLowReferenceTrimVal(VREF_Type *base, uint8_t trimValue);
<> 154:37f96f9d4de2 233
<> 154:37f96f9d4de2 234 /*!
<> 154:37f96f9d4de2 235 * @brief Reads the value of the TRIM meaning output voltage.
<> 154:37f96f9d4de2 236 *
<> 154:37f96f9d4de2 237 * This function gets the TRIM value from the VREFL_TRM register.
<> 154:37f96f9d4de2 238 *
<> 154:37f96f9d4de2 239 * @param base VREF peripheral address.
<> 154:37f96f9d4de2 240 * @return Three-bit value of the trim setting.
<> 154:37f96f9d4de2 241 */
<> 154:37f96f9d4de2 242 static inline uint8_t VREF_GetLowReferenceTrimVal(VREF_Type *base)
<> 154:37f96f9d4de2 243 {
<> 154:37f96f9d4de2 244 return (base->VREFL_TRM & VREF_VREFL_TRM_VREFL_TRIM_MASK);
<> 154:37f96f9d4de2 245 }
<> 154:37f96f9d4de2 246 #endif /* FSL_FEATURE_VREF_HAS_LOW_REFERENCE */
<> 154:37f96f9d4de2 247
<> 154:37f96f9d4de2 248 /*@}*/
<> 154:37f96f9d4de2 249
<> 154:37f96f9d4de2 250 #if defined(__cplusplus)
<> 154:37f96f9d4de2 251 }
<> 154:37f96f9d4de2 252 #endif /* __cplusplus */
<> 154:37f96f9d4de2 253
<> 154:37f96f9d4de2 254 /*! @}*/
<> 154:37f96f9d4de2 255
<> 154:37f96f9d4de2 256 #endif /* _FSL_VREF_H_ */