mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_MAX32630FTHR/TOOLCHAIN_IAR/adc.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /**
AnnaBridge 171:3a7713b1edbc 2 * @file
AnnaBridge 171:3a7713b1edbc 3 * @brief Analog to Digital Converter function prototypes and data types.
AnnaBridge 171:3a7713b1edbc 4 */
AnnaBridge 171:3a7713b1edbc 5
AnnaBridge 171:3a7713b1edbc 6 /* ****************************************************************************
AnnaBridge 171:3a7713b1edbc 7 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 171:3a7713b1edbc 8 *
AnnaBridge 171:3a7713b1edbc 9 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 171:3a7713b1edbc 10 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 171:3a7713b1edbc 11 * to deal in the Software without restriction, including without limitation
AnnaBridge 171:3a7713b1edbc 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 171:3a7713b1edbc 13 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 171:3a7713b1edbc 14 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 171:3a7713b1edbc 15 *
AnnaBridge 171:3a7713b1edbc 16 * The above copyright notice and this permission notice shall be included
AnnaBridge 171:3a7713b1edbc 17 * in all copies or substantial portions of the Software.
AnnaBridge 171:3a7713b1edbc 18 *
AnnaBridge 171:3a7713b1edbc 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 171:3a7713b1edbc 20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 171:3a7713b1edbc 21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 171:3a7713b1edbc 22 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 171:3a7713b1edbc 23 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 171:3a7713b1edbc 24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 171:3a7713b1edbc 25 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 171:3a7713b1edbc 26 *
AnnaBridge 171:3a7713b1edbc 27 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 171:3a7713b1edbc 28 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 171:3a7713b1edbc 29 * Products, Inc. Branding Policy.
AnnaBridge 171:3a7713b1edbc 30 *
AnnaBridge 171:3a7713b1edbc 31 * The mere transfer of this software does not imply any licenses
AnnaBridge 171:3a7713b1edbc 32 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 171:3a7713b1edbc 33 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 171:3a7713b1edbc 34 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 171:3a7713b1edbc 35 * ownership rights.
AnnaBridge 171:3a7713b1edbc 36 *
AnnaBridge 171:3a7713b1edbc 37 * $Date: 2016-10-07 14:53:52 -0500 (Fri, 07 Oct 2016) $
AnnaBridge 171:3a7713b1edbc 38 * $Revision: 24632 $
AnnaBridge 171:3a7713b1edbc 39 *
AnnaBridge 171:3a7713b1edbc 40 *************************************************************************** */
AnnaBridge 171:3a7713b1edbc 41
AnnaBridge 171:3a7713b1edbc 42 /* Define to prevent redundant inclusion */
AnnaBridge 171:3a7713b1edbc 43 #ifndef _ADC_H
AnnaBridge 171:3a7713b1edbc 44 #define _ADC_H
AnnaBridge 171:3a7713b1edbc 45
AnnaBridge 171:3a7713b1edbc 46 /* **** Includes **** */
AnnaBridge 171:3a7713b1edbc 47 #include <stdint.h>
AnnaBridge 171:3a7713b1edbc 48
AnnaBridge 171:3a7713b1edbc 49 /* Doxy group definition for this peripheral module */
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 /**
AnnaBridge 171:3a7713b1edbc 52 * @ingroup periphlibs
AnnaBridge 171:3a7713b1edbc 53 * @defgroup adc Analog to Digital Converter (ADC)
AnnaBridge 171:3a7713b1edbc 54 * @{
AnnaBridge 171:3a7713b1edbc 55 */
AnnaBridge 171:3a7713b1edbc 56
AnnaBridge 171:3a7713b1edbc 57 #include "adc_regs.h"
AnnaBridge 171:3a7713b1edbc 58
AnnaBridge 171:3a7713b1edbc 59 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 60 extern "C" {
AnnaBridge 171:3a7713b1edbc 61 #endif
AnnaBridge 171:3a7713b1edbc 62
AnnaBridge 171:3a7713b1edbc 63 /* **** Definitions **** */
AnnaBridge 171:3a7713b1edbc 64
AnnaBridge 171:3a7713b1edbc 65 /**
AnnaBridge 171:3a7713b1edbc 66 * Enumeration type for ADC Channel Selection. See \ref ADC_CHSEL_values "ADC Channel Select Values" for additional information.
AnnaBridge 171:3a7713b1edbc 67 */
AnnaBridge 171:3a7713b1edbc 68 typedef enum {
AnnaBridge 171:3a7713b1edbc 69 ADC_CH_0 = MXC_V_ADC_CTRL_ADC_CHSEL_AIN0, /**< Channel 0 Select */
AnnaBridge 171:3a7713b1edbc 70 ADC_CH_1 = MXC_V_ADC_CTRL_ADC_CHSEL_AIN1, /**< Channel 1 Select */
AnnaBridge 171:3a7713b1edbc 71 ADC_CH_2 = MXC_V_ADC_CTRL_ADC_CHSEL_AIN2, /**< Channel 2 Select */
AnnaBridge 171:3a7713b1edbc 72 ADC_CH_3 = MXC_V_ADC_CTRL_ADC_CHSEL_AIN3, /**< Channel 3 Select */
AnnaBridge 171:3a7713b1edbc 73 ADC_CH_0_DIV_5 = MXC_V_ADC_CTRL_ADC_CHSEL_AIN0_DIV_5, /**< Channel 0 divided by 5 */
AnnaBridge 171:3a7713b1edbc 74 ADC_CH_1_DIV_5 = MXC_V_ADC_CTRL_ADC_CHSEL_AIN1_DIV_5, /**< Channel 1 divided by 5 */
AnnaBridge 171:3a7713b1edbc 75 ADC_CH_VDDB_DIV_4 = MXC_V_ADC_CTRL_ADC_CHSEL_VDDB_DIV_4, /**< VDDB divided by 4 */
AnnaBridge 171:3a7713b1edbc 76 ADC_CH_VDD18 = MXC_V_ADC_CTRL_ADC_CHSEL_VDD18, /**< VDD18 input select */
AnnaBridge 171:3a7713b1edbc 77 ADC_CH_VDD12 = MXC_V_ADC_CTRL_ADC_CHSEL_VDD12, /**< VDD12 input select */
AnnaBridge 171:3a7713b1edbc 78 ADC_CH_VRTC_DIV_2 = MXC_V_ADC_CTRL_ADC_CHSEL_VRTC_DIV_2, /**< VRTC divided by 2 */
AnnaBridge 171:3a7713b1edbc 79 ADC_CH_TMON = MXC_V_ADC_CTRL_ADC_CHSEL_TMON, /**< TMON input select */
AnnaBridge 171:3a7713b1edbc 80 #if (MXC_ADC_REV > 0)
AnnaBridge 171:3a7713b1edbc 81 ADC_CH_VDDIO_DIV_4 = MXC_V_ADC_CTRL_ADC_CHSEL_VDDIO_DIV_4, /**< VDDIO divided by 4 select */
AnnaBridge 171:3a7713b1edbc 82 ADC_CH_VDDIOH_DIV_4 = MXC_V_ADC_CTRL_ADC_CHSEL_VDDIOH_DIV_4, /**< VDDIOH divided by 4 select */
AnnaBridge 171:3a7713b1edbc 83 #endif
AnnaBridge 171:3a7713b1edbc 84 ADC_CH_MAX /**< Max enum value for channel selection */
AnnaBridge 171:3a7713b1edbc 85 } mxc_adc_chsel_t;
AnnaBridge 171:3a7713b1edbc 86
AnnaBridge 171:3a7713b1edbc 87 /**
AnnaBridge 171:3a7713b1edbc 88 * Enumeration type for the ADC limit register to set
AnnaBridge 171:3a7713b1edbc 89 */
AnnaBridge 171:3a7713b1edbc 90 typedef enum {
AnnaBridge 171:3a7713b1edbc 91 ADC_LIMIT_0 = 0, /**< ADC Limit Register 0 */
AnnaBridge 171:3a7713b1edbc 92 ADC_LIMIT_1 = 1, /**< ADC Limit Register 1 */
AnnaBridge 171:3a7713b1edbc 93 ADC_LIMIT_2 = 2, /**< ADC Limit Register 2 */
AnnaBridge 171:3a7713b1edbc 94 ADC_LIMIT_3 = 3, /**< ADC Limit Register 3 */
AnnaBridge 171:3a7713b1edbc 95 ADC_LIMIT_MAX /**< Number of Limit registers */
AnnaBridge 171:3a7713b1edbc 96 } mxc_adc_limitsel_t;
AnnaBridge 171:3a7713b1edbc 97
AnnaBridge 171:3a7713b1edbc 98 ///@cond
AnnaBridge 171:3a7713b1edbc 99 /**
AnnaBridge 171:3a7713b1edbc 100 * Mask for all Interrupt Flag Fields
AnnaBridge 171:3a7713b1edbc 101 */
AnnaBridge 171:3a7713b1edbc 102 #define ADC_IF_MASK (0xffffffffUL << MXC_F_ADC_INTR_ADC_DONE_IF_POS)
AnnaBridge 171:3a7713b1edbc 103
AnnaBridge 171:3a7713b1edbc 104 /**
AnnaBridge 171:3a7713b1edbc 105 * Mask for all Interrupt Enable Fields
AnnaBridge 171:3a7713b1edbc 106 */
AnnaBridge 171:3a7713b1edbc 107 #define ADC_IE_MASK (0xffffffffUL >> MXC_F_ADC_INTR_ADC_DONE_IF_POS)
AnnaBridge 171:3a7713b1edbc 108 ///@endcond
AnnaBridge 171:3a7713b1edbc 109
AnnaBridge 171:3a7713b1edbc 110 /* **** Function Prototypes **** */
AnnaBridge 171:3a7713b1edbc 111
AnnaBridge 171:3a7713b1edbc 112 /**
AnnaBridge 171:3a7713b1edbc 113 * @brief Initialize the ADC hardware
AnnaBridge 171:3a7713b1edbc 114 *
AnnaBridge 171:3a7713b1edbc 115 * @return #E_NO_ERROR if successful
AnnaBridge 171:3a7713b1edbc 116 */
AnnaBridge 171:3a7713b1edbc 117 int ADC_Init(void);
AnnaBridge 171:3a7713b1edbc 118
AnnaBridge 171:3a7713b1edbc 119 /**
AnnaBridge 171:3a7713b1edbc 120 * @brief Start ADC conversion on the selected channel
AnnaBridge 171:3a7713b1edbc 121 *
AnnaBridge 171:3a7713b1edbc 122 * @param channel Channel select from #mxc_adc_chsel_t
AnnaBridge 171:3a7713b1edbc 123 * @param adc_scale Enable the ADC input scaling mode if non-zero
AnnaBridge 171:3a7713b1edbc 124 * @param bypass Bypass input buffer stage if non-zero
AnnaBridge 171:3a7713b1edbc 125 */
AnnaBridge 171:3a7713b1edbc 126 void ADC_StartConvert(mxc_adc_chsel_t channel, unsigned int adc_scale, unsigned int bypass);
AnnaBridge 171:3a7713b1edbc 127
AnnaBridge 171:3a7713b1edbc 128 /**
AnnaBridge 171:3a7713b1edbc 129 * @brief Gets the result from the previous ADC conversion
AnnaBridge 171:3a7713b1edbc 130 *
AnnaBridge 171:3a7713b1edbc 131 * @param outdata Pointer to store the ADC data conversion
AnnaBridge 171:3a7713b1edbc 132 * result.
AnnaBridge 171:3a7713b1edbc 133 * @return #E_OVERFLOW ADC overflow error
AnnaBridge 171:3a7713b1edbc 134 * @return #E_NO_ERROR Data returned in outdata parameter
AnnaBridge 171:3a7713b1edbc 135 */
AnnaBridge 171:3a7713b1edbc 136 int ADC_GetData(uint16_t *outdata);
AnnaBridge 171:3a7713b1edbc 137
AnnaBridge 171:3a7713b1edbc 138 /**
AnnaBridge 171:3a7713b1edbc 139 * @brief Set the data limits for an ADC channel monitor
AnnaBridge 171:3a7713b1edbc 140 *
AnnaBridge 171:3a7713b1edbc 141 * @param unit Which data limit unit to configure
AnnaBridge 171:3a7713b1edbc 142 * @param channel Channel select from mxc_adc_chsel_t
AnnaBridge 171:3a7713b1edbc 143 * @param low_enable Enable the lower limit on this monitor
AnnaBridge 171:3a7713b1edbc 144 * @param low_limit Value for lower limit monitor
AnnaBridge 171:3a7713b1edbc 145 * @param high_enable Enable the upper limit on this monitor
AnnaBridge 171:3a7713b1edbc 146 * @param high_limit Value for upper limit monitor
AnnaBridge 171:3a7713b1edbc 147 *
AnnaBridge 171:3a7713b1edbc 148 * @return #E_BAD_PARAM ADC limit or channel greater than supported
AnnaBridge 171:3a7713b1edbc 149 * @return #E_NO_ERROR ADC limit set successfully
AnnaBridge 171:3a7713b1edbc 150 */
AnnaBridge 171:3a7713b1edbc 151 int ADC_SetLimit(mxc_adc_limitsel_t unit, mxc_adc_chsel_t channel,
AnnaBridge 171:3a7713b1edbc 152 unsigned int low_enable, unsigned int low_limit,
AnnaBridge 171:3a7713b1edbc 153 unsigned int high_enable, unsigned int high_limit);
AnnaBridge 171:3a7713b1edbc 154
AnnaBridge 171:3a7713b1edbc 155 /**
AnnaBridge 171:3a7713b1edbc 156 * @brief Get interrupt flags
AnnaBridge 171:3a7713b1edbc 157 *
AnnaBridge 171:3a7713b1edbc 158 * @return ADC Interrupt flags bit mask. See the @ref ADC_INTR_IF_Register
AnnaBridge 171:3a7713b1edbc 159 * "ADC_INTR Register" for the interrupt flag masks.
AnnaBridge 171:3a7713b1edbc 160 */
AnnaBridge 171:3a7713b1edbc 161 __STATIC_INLINE uint32_t ADC_GetFlags()
AnnaBridge 171:3a7713b1edbc 162 {
AnnaBridge 171:3a7713b1edbc 163 return (MXC_ADC->intr & ADC_IF_MASK);
AnnaBridge 171:3a7713b1edbc 164 }
AnnaBridge 171:3a7713b1edbc 165
AnnaBridge 171:3a7713b1edbc 166 /**
AnnaBridge 171:3a7713b1edbc 167 * @brief Clear interrupt flag(s) using the mask parameter. All bits set in
AnnaBridge 171:3a7713b1edbc 168 * the parameter will be cleared.
AnnaBridge 171:3a7713b1edbc 169 *
AnnaBridge 171:3a7713b1edbc 170 * @param mask Interrupt flags to clear. See the @ref ADC_INTR_IF_Register
AnnaBridge 171:3a7713b1edbc 171 * "ADC_INTR Register" for the interrupt flag masks.
AnnaBridge 171:3a7713b1edbc 172 */
AnnaBridge 171:3a7713b1edbc 173 __STATIC_INLINE void ADC_ClearFlags(uint32_t mask)
AnnaBridge 171:3a7713b1edbc 174 {
AnnaBridge 171:3a7713b1edbc 175 MXC_ADC->intr = ((MXC_ADC->intr & ADC_IF_MASK) | mask);
AnnaBridge 171:3a7713b1edbc 176 }
AnnaBridge 171:3a7713b1edbc 177
AnnaBridge 171:3a7713b1edbc 178 /**
AnnaBridge 171:3a7713b1edbc 179 * @brief Get the Status of the ADC
AnnaBridge 171:3a7713b1edbc 180 *
AnnaBridge 171:3a7713b1edbc 181 * @return ADC status register. See @ref ADC_STATUS_Register "ADC_STATUS
AnnaBridge 171:3a7713b1edbc 182 * Register" for details.
AnnaBridge 171:3a7713b1edbc 183 */
AnnaBridge 171:3a7713b1edbc 184 __STATIC_INLINE uint32_t ADC_GetStatus()
AnnaBridge 171:3a7713b1edbc 185 {
AnnaBridge 171:3a7713b1edbc 186 return (MXC_ADC->status);
AnnaBridge 171:3a7713b1edbc 187 }
AnnaBridge 171:3a7713b1edbc 188
AnnaBridge 171:3a7713b1edbc 189 /**
AnnaBridge 171:3a7713b1edbc 190 * @brief Enables the ADC interrupts specified by the mask parameter
AnnaBridge 171:3a7713b1edbc 191 *
AnnaBridge 171:3a7713b1edbc 192 * @param mask ADC interrupts to enable. See @ref ADC_INTR_IE_Register
AnnaBridge 171:3a7713b1edbc 193 * "ADC_INTR Register" for the interrupt enable bit masks.
AnnaBridge 171:3a7713b1edbc 194 */
AnnaBridge 171:3a7713b1edbc 195 __STATIC_INLINE void ADC_EnableINT(uint32_t mask)
AnnaBridge 171:3a7713b1edbc 196 {
AnnaBridge 171:3a7713b1edbc 197 MXC_ADC->intr = ((MXC_ADC->intr & ADC_IE_MASK) | mask);
AnnaBridge 171:3a7713b1edbc 198 }
AnnaBridge 171:3a7713b1edbc 199
AnnaBridge 171:3a7713b1edbc 200 /**
AnnaBridge 171:3a7713b1edbc 201 * @brief Disable ADC interrupts based on mask
AnnaBridge 171:3a7713b1edbc 202 *
AnnaBridge 171:3a7713b1edbc 203 * @param mask ADC interrupts to disable. See @ref ADC_INTR_IE_Register
AnnaBridge 171:3a7713b1edbc 204 * "ADC_INTR Register" for the interrupt enable bit masks.
AnnaBridge 171:3a7713b1edbc 205 */
AnnaBridge 171:3a7713b1edbc 206 __STATIC_INLINE void ADC_DisableINT(uint32_t mask)
AnnaBridge 171:3a7713b1edbc 207 {
AnnaBridge 171:3a7713b1edbc 208 MXC_ADC->intr = ((MXC_ADC->intr & ADC_IE_MASK) & ~mask);
AnnaBridge 171:3a7713b1edbc 209 }
AnnaBridge 171:3a7713b1edbc 210
AnnaBridge 171:3a7713b1edbc 211 /**@} end of group adc */
AnnaBridge 171:3a7713b1edbc 212
AnnaBridge 171:3a7713b1edbc 213 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 214 }
AnnaBridge 171:3a7713b1edbc 215 #endif
AnnaBridge 171:3a7713b1edbc 216
AnnaBridge 171:3a7713b1edbc 217 #endif /* _ADC_H */