mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

targets/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_adc_ex.h@189:f392fc9709a3, 2019-02-20 (annotated)

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /**
<> 144:ef7eb2e8f9f7 2 ******************************************************************************
<> 144:ef7eb2e8f9f7 3 * @file stm32l0xx_hal_adc_ex.h
<> 144:ef7eb2e8f9f7 4 * @author MCD Application Team
Anna Bridge 186:707f6e361f3e 5 * @brief Header file of ADC HAL extended module.
<> 144:ef7eb2e8f9f7 6 ******************************************************************************
<> 144:ef7eb2e8f9f7 7 * @attention
<> 144:ef7eb2e8f9f7 8 *
<> 144:ef7eb2e8f9f7 9 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
<> 144:ef7eb2e8f9f7 10 *
<> 144:ef7eb2e8f9f7 11 * Redistribution and use in source and binary forms, with or without modification,
<> 144:ef7eb2e8f9f7 12 * are permitted provided that the following conditions are met:
<> 144:ef7eb2e8f9f7 13 * 1. Redistributions of source code must retain the above copyright notice,
<> 144:ef7eb2e8f9f7 14 * this list of conditions and the following disclaimer.
<> 144:ef7eb2e8f9f7 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
<> 144:ef7eb2e8f9f7 16 * this list of conditions and the following disclaimer in the documentation
<> 144:ef7eb2e8f9f7 17 * and/or other materials provided with the distribution.
<> 144:ef7eb2e8f9f7 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
<> 144:ef7eb2e8f9f7 19 * may be used to endorse or promote products derived from this software
<> 144:ef7eb2e8f9f7 20 * without specific prior written permission.
<> 144:ef7eb2e8f9f7 21 *
<> 144:ef7eb2e8f9f7 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
<> 144:ef7eb2e8f9f7 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
<> 144:ef7eb2e8f9f7 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 144:ef7eb2e8f9f7 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
<> 144:ef7eb2e8f9f7 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
<> 144:ef7eb2e8f9f7 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
<> 144:ef7eb2e8f9f7 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
<> 144:ef7eb2e8f9f7 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
<> 144:ef7eb2e8f9f7 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
<> 144:ef7eb2e8f9f7 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 144:ef7eb2e8f9f7 32 *
<> 144:ef7eb2e8f9f7 33 ******************************************************************************
<> 144:ef7eb2e8f9f7 34 */
<> 144:ef7eb2e8f9f7 35
<> 144:ef7eb2e8f9f7 36 /* Define to prevent recursive inclusion -------------------------------------*/
Anna Bridge 186:707f6e361f3e 37 #ifndef __STM32L0xx_HAL_ADC_EX_H
Anna Bridge 186:707f6e361f3e 38 #define __STM32L0xx_HAL_ADC_EX_H
<> 144:ef7eb2e8f9f7 39
<> 144:ef7eb2e8f9f7 40 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 41 extern "C" {
<> 144:ef7eb2e8f9f7 42 #endif
<> 144:ef7eb2e8f9f7 43
<> 144:ef7eb2e8f9f7 44 /* Includes ------------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 45 #include "stm32l0xx_hal_def.h"
Anna Bridge 186:707f6e361f3e 46
<> 144:ef7eb2e8f9f7 47 /** @addtogroup STM32L0xx_HAL_Driver
<> 144:ef7eb2e8f9f7 48 * @{
<> 144:ef7eb2e8f9f7 49 */
<> 144:ef7eb2e8f9f7 50
Anna Bridge 186:707f6e361f3e 51 /** @addtogroup ADCEx
<> 144:ef7eb2e8f9f7 52 * @{
<> 144:ef7eb2e8f9f7 53 */
<> 144:ef7eb2e8f9f7 54
<> 144:ef7eb2e8f9f7 55 /* Exported types ------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 56 /* Exported constants --------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 57
Anna Bridge 186:707f6e361f3e 58 /** @defgroup ADCEx_Exported_Constants ADC Extended Exported Constants
<> 144:ef7eb2e8f9f7 59 * @{
<> 144:ef7eb2e8f9f7 60 */
<> 144:ef7eb2e8f9f7 61
<> 144:ef7eb2e8f9f7 62 /** @defgroup ADCEx_Channel_Mode ADC Single Ended
<> 144:ef7eb2e8f9f7 63 * @{
<> 144:ef7eb2e8f9f7 64 */
<> 151:5eaa88a5bcc7 65 #define ADC_SINGLE_ENDED (uint32_t)0x00000000U /* dummy value */
<> 144:ef7eb2e8f9f7 66 /**
<> 144:ef7eb2e8f9f7 67 * @}
<> 144:ef7eb2e8f9f7 68 */
<> 144:ef7eb2e8f9f7 69
Anna Bridge 186:707f6e361f3e 70 /** @defgroup ADC_regular_external_trigger_source ADC External Trigger Source
<> 144:ef7eb2e8f9f7 71 * @{
<> 144:ef7eb2e8f9f7 72 */
<> 151:5eaa88a5bcc7 73 #define ADC_EXTERNALTRIGCONV_T6_TRGO ((uint32_t)0x00000000U)
<> 144:ef7eb2e8f9f7 74 #define ADC_EXTERNALTRIGCONV_T21_CC2 (ADC_CFGR1_EXTSEL_0)
<> 144:ef7eb2e8f9f7 75 #define ADC_EXTERNALTRIGCONV_T2_TRGO (ADC_CFGR1_EXTSEL_1)
<> 144:ef7eb2e8f9f7 76 #define ADC_EXTERNALTRIGCONV_T2_CC4 (ADC_CFGR1_EXTSEL_1 | ADC_CFGR1_EXTSEL_0)
<> 144:ef7eb2e8f9f7 77 #define ADC_EXTERNALTRIGCONV_T22_TRGO (ADC_CFGR1_EXTSEL_2)
<> 144:ef7eb2e8f9f7 78 #define ADC_EXTERNALTRIGCONV_T3_TRGO (ADC_CFGR1_EXTSEL_2 | ADC_CFGR1_EXTSEL_1)
<> 144:ef7eb2e8f9f7 79 #define ADC_EXTERNALTRIGCONV_EXT_IT11 (ADC_CFGR1_EXTSEL_2 | ADC_CFGR1_EXTSEL_1 | ADC_CFGR1_EXTSEL_0)
<> 144:ef7eb2e8f9f7 80 #define ADC_SOFTWARE_START (ADC_CFGR1_EXTSEL + (uint32_t)1)
<> 144:ef7eb2e8f9f7 81
<> 144:ef7eb2e8f9f7 82 /* ADC group regular external trigger TIM21_TRGO available only on */
<> 144:ef7eb2e8f9f7 83 /* STM32L0 devices categories: Cat.2, Cat.3, Cat.5 */
<> 144:ef7eb2e8f9f7 84 #if defined (STM32L031xx) || defined (STM32L041xx) || \
<> 144:ef7eb2e8f9f7 85 defined (STM32L051xx) || defined (STM32L052xx) || defined (STM32L053xx) || \
<> 144:ef7eb2e8f9f7 86 defined (STM32L061xx) || defined (STM32L062xx) || defined (STM32L063xx) || \
<> 144:ef7eb2e8f9f7 87 defined (STM32L071xx) || defined (STM32L072xx) || defined (STM32L073xx) || \
<> 144:ef7eb2e8f9f7 88 defined (STM32L081xx) || defined (STM32L082xx) || defined (STM32L083xx)
<> 144:ef7eb2e8f9f7 89 #define ADC_EXTERNALTRIGCONV_T21_TRGO (ADC_EXTERNALTRIGCONV_T22_TRGO)
<> 144:ef7eb2e8f9f7 90 #endif
<> 144:ef7eb2e8f9f7 91
<> 144:ef7eb2e8f9f7 92 /* ADC group regular external trigger TIM2_CC3 available only on */
<> 144:ef7eb2e8f9f7 93 /* STM32L0 devices categories: Cat.1, Cat.2, Cat.5 */
<> 144:ef7eb2e8f9f7 94 #if defined (STM32L011xx) || defined (STM32L021xx) || \
<> 144:ef7eb2e8f9f7 95 defined (STM32L031xx) || defined (STM32L041xx) || \
<> 144:ef7eb2e8f9f7 96 defined (STM32L071xx) || defined (STM32L072xx) || defined (STM32L073xx) || \
<> 144:ef7eb2e8f9f7 97 defined (STM32L081xx) || defined (STM32L082xx) || defined (STM32L083xx)
<> 144:ef7eb2e8f9f7 98 #define ADC_EXTERNALTRIGCONV_T2_CC3 (ADC_CFGR1_EXTSEL_2 | ADC_CFGR1_EXTSEL_0)
<> 144:ef7eb2e8f9f7 99 #endif
<> 144:ef7eb2e8f9f7 100
<> 144:ef7eb2e8f9f7 101 /**
<> 144:ef7eb2e8f9f7 102 * @}
<> 144:ef7eb2e8f9f7 103 */
<> 144:ef7eb2e8f9f7 104
<> 144:ef7eb2e8f9f7 105 /** @defgroup ADC_SYSCFG_internal_paths_flags_definition ADC SYSCFG internal paths Flags Definition
<> 144:ef7eb2e8f9f7 106 * @{
<> 144:ef7eb2e8f9f7 107 */
<> 151:5eaa88a5bcc7 108 #define ADC_FLAG_SENSOR SYSCFG_CFGR3_VREFINT_RDYF
<> 144:ef7eb2e8f9f7 109 #define ADC_FLAG_VREFINT SYSCFG_VREFINT_ADC_RDYF
<> 144:ef7eb2e8f9f7 110 /**
<> 144:ef7eb2e8f9f7 111 * @}
<> 144:ef7eb2e8f9f7 112 */
<> 144:ef7eb2e8f9f7 113
<> 144:ef7eb2e8f9f7 114 /**
<> 144:ef7eb2e8f9f7 115 * @}
<> 144:ef7eb2e8f9f7 116 */
<> 144:ef7eb2e8f9f7 117
<> 144:ef7eb2e8f9f7 118 /* Private macros ------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 119
<> 144:ef7eb2e8f9f7 120 /** @defgroup ADCEx_Private_Macros ADCEx Private Macros
<> 144:ef7eb2e8f9f7 121 * @{
<> 144:ef7eb2e8f9f7 122 */
<> 144:ef7eb2e8f9f7 123
<> 144:ef7eb2e8f9f7 124 #define IS_ADC_SINGLE_DIFFERENTIAL(SING_DIFF) ((SING_DIFF) == ADC_SINGLE_ENDED)
<> 144:ef7eb2e8f9f7 125
<> 144:ef7eb2e8f9f7 126 /** @defgroup ADCEx_calibration_factor_length_verification ADC Calibration Factor Length Verification
<> 144:ef7eb2e8f9f7 127 * @{
<> 144:ef7eb2e8f9f7 128 */
<> 144:ef7eb2e8f9f7 129 /**
<> 151:5eaa88a5bcc7 130 * @brief Calibration factor length verification (7 bits maximum)
<> 144:ef7eb2e8f9f7 131 * @param _Calibration_Factor_: Calibration factor value
<> 144:ef7eb2e8f9f7 132 * @retval None
<> 144:ef7eb2e8f9f7 133 */
<> 151:5eaa88a5bcc7 134 #define IS_ADC_CALFACT(_Calibration_Factor_) ((_Calibration_Factor_) <= ((uint32_t)0x7FU))
<> 144:ef7eb2e8f9f7 135 /**
<> 144:ef7eb2e8f9f7 136 * @}
<> 144:ef7eb2e8f9f7 137 */
<> 144:ef7eb2e8f9f7 138
<> 144:ef7eb2e8f9f7 139 /** @defgroup ADC_External_trigger_Source ADC External Trigger Source
<> 144:ef7eb2e8f9f7 140 * @{
<> 144:ef7eb2e8f9f7 141 */
<> 144:ef7eb2e8f9f7 142 #if defined (STM32L031xx) || defined (STM32L041xx) || \
<> 144:ef7eb2e8f9f7 143 defined (STM32L071xx) || defined (STM32L072xx) || defined (STM32L073xx) || \
<> 144:ef7eb2e8f9f7 144 defined (STM32L081xx) || defined (STM32L082xx) || defined (STM32L083xx)
<> 144:ef7eb2e8f9f7 145 #define IS_ADC_EXTTRIG(CONV) (((CONV) == ADC_EXTERNALTRIGCONV_T6_TRGO ) || \
<> 144:ef7eb2e8f9f7 146 ((CONV) == ADC_EXTERNALTRIGCONV_T21_CC2 ) || \
<> 144:ef7eb2e8f9f7 147 ((CONV) == ADC_EXTERNALTRIGCONV_T2_TRGO ) || \
<> 144:ef7eb2e8f9f7 148 ((CONV) == ADC_EXTERNALTRIGCONV_T2_CC4 ) || \
<> 144:ef7eb2e8f9f7 149 ((CONV) == ADC_EXTERNALTRIGCONV_T22_TRGO ) || \
<> 144:ef7eb2e8f9f7 150 ((CONV) == ADC_EXTERNALTRIGCONV_T21_TRGO ) || \
<> 144:ef7eb2e8f9f7 151 ((CONV) == ADC_EXTERNALTRIGCONV_T2_CC3 ) || \
<> 144:ef7eb2e8f9f7 152 ((CONV) == ADC_EXTERNALTRIGCONV_T3_TRGO ) || \
<> 144:ef7eb2e8f9f7 153 ((CONV) == ADC_EXTERNALTRIGCONV_EXT_IT11 ) || \
<> 144:ef7eb2e8f9f7 154 ((CONV) == ADC_SOFTWARE_START))
<> 144:ef7eb2e8f9f7 155 #elif defined (STM32L011xx) || defined (STM32L021xx)
<> 144:ef7eb2e8f9f7 156 #define IS_ADC_EXTTRIG(CONV) (((CONV) == ADC_EXTERNALTRIGCONV_T6_TRGO ) || \
<> 144:ef7eb2e8f9f7 157 ((CONV) == ADC_EXTERNALTRIGCONV_T21_CC2 ) || \
<> 144:ef7eb2e8f9f7 158 ((CONV) == ADC_EXTERNALTRIGCONV_T2_TRGO ) || \
<> 144:ef7eb2e8f9f7 159 ((CONV) == ADC_EXTERNALTRIGCONV_T2_CC4 ) || \
<> 144:ef7eb2e8f9f7 160 ((CONV) == ADC_EXTERNALTRIGCONV_T22_TRGO ) || \
<> 144:ef7eb2e8f9f7 161 ((CONV) == ADC_EXTERNALTRIGCONV_T2_CC3 ) || \
<> 144:ef7eb2e8f9f7 162 ((CONV) == ADC_EXTERNALTRIGCONV_T3_TRGO ) || \
<> 144:ef7eb2e8f9f7 163 ((CONV) == ADC_EXTERNALTRIGCONV_EXT_IT11 ) || \
<> 144:ef7eb2e8f9f7 164 ((CONV) == ADC_SOFTWARE_START))
<> 144:ef7eb2e8f9f7 165 #elif defined (STM32L051xx) || defined (STM32L052xx) || defined (STM32L053xx) || \
<> 144:ef7eb2e8f9f7 166 defined (STM32L061xx) || defined (STM32L062xx) || defined (STM32L063xx)
<> 144:ef7eb2e8f9f7 167 #define IS_ADC_EXTTRIG(CONV) (((CONV) == ADC_EXTERNALTRIGCONV_T6_TRGO ) || \
<> 144:ef7eb2e8f9f7 168 ((CONV) == ADC_EXTERNALTRIGCONV_T21_CC2 ) || \
<> 144:ef7eb2e8f9f7 169 ((CONV) == ADC_EXTERNALTRIGCONV_T2_TRGO ) || \
<> 144:ef7eb2e8f9f7 170 ((CONV) == ADC_EXTERNALTRIGCONV_T2_CC4 ) || \
<> 144:ef7eb2e8f9f7 171 ((CONV) == ADC_EXTERNALTRIGCONV_T22_TRGO ) || \
<> 144:ef7eb2e8f9f7 172 ((CONV) == ADC_EXTERNALTRIGCONV_T21_TRGO ) || \
<> 144:ef7eb2e8f9f7 173 ((CONV) == ADC_EXTERNALTRIGCONV_T3_TRGO ) || \
<> 144:ef7eb2e8f9f7 174 ((CONV) == ADC_EXTERNALTRIGCONV_EXT_IT11 ) || \
<> 144:ef7eb2e8f9f7 175 ((CONV) == ADC_SOFTWARE_START))
<> 144:ef7eb2e8f9f7 176 #endif
<> 144:ef7eb2e8f9f7 177 /**
<> 144:ef7eb2e8f9f7 178 * @}
<> 144:ef7eb2e8f9f7 179 */
<> 144:ef7eb2e8f9f7 180
<> 144:ef7eb2e8f9f7 181 /**
<> 144:ef7eb2e8f9f7 182 * @}
<> 144:ef7eb2e8f9f7 183 */
<> 144:ef7eb2e8f9f7 184
Anna Bridge 186:707f6e361f3e 185 /* Exported functions --------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 186 /** @addtogroup ADCEx_Exported_Functions
<> 144:ef7eb2e8f9f7 187 * @{
<> 144:ef7eb2e8f9f7 188 */
<> 144:ef7eb2e8f9f7 189
Anna Bridge 186:707f6e361f3e 190 /** @addtogroup ADCEx_Exported_Functions_Group1
<> 144:ef7eb2e8f9f7 191 * @{
<> 144:ef7eb2e8f9f7 192 */
Anna Bridge 186:707f6e361f3e 193 /* IO operation functions *****************************************************/
Anna Bridge 186:707f6e361f3e 194
Anna Bridge 186:707f6e361f3e 195 /* ADC calibration */
<> 144:ef7eb2e8f9f7 196 HAL_StatusTypeDef HAL_ADCEx_Calibration_Start(ADC_HandleTypeDef* hadc, uint32_t SingleDiff);
<> 144:ef7eb2e8f9f7 197 uint32_t HAL_ADCEx_Calibration_GetValue(ADC_HandleTypeDef* hadc, uint32_t SingleDiff);
<> 144:ef7eb2e8f9f7 198 HAL_StatusTypeDef HAL_ADCEx_Calibration_SetValue(ADC_HandleTypeDef* hadc, uint32_t SingleDiff, uint32_t CalibrationFactor);
Anna Bridge 186:707f6e361f3e 199
Anna Bridge 186:707f6e361f3e 200 /* ADC VrefInt and Temperature sensor functions specific to this STM32 serie */
<> 144:ef7eb2e8f9f7 201 HAL_StatusTypeDef HAL_ADCEx_EnableVREFINT(void);
<> 144:ef7eb2e8f9f7 202 void HAL_ADCEx_DisableVREFINT(void);
<> 144:ef7eb2e8f9f7 203 HAL_StatusTypeDef HAL_ADCEx_EnableVREFINTTempSensor(void);
<> 144:ef7eb2e8f9f7 204 void HAL_ADCEx_DisableVREFINTTempSensor(void);
<> 144:ef7eb2e8f9f7 205 /**
<> 144:ef7eb2e8f9f7 206 * @}
<> 144:ef7eb2e8f9f7 207 */
<> 144:ef7eb2e8f9f7 208
<> 144:ef7eb2e8f9f7 209 /**
<> 144:ef7eb2e8f9f7 210 * @}
<> 144:ef7eb2e8f9f7 211 */
<> 144:ef7eb2e8f9f7 212
Anna Bridge 186:707f6e361f3e 213
<> 144:ef7eb2e8f9f7 214 /**
<> 144:ef7eb2e8f9f7 215 * @}
<> 144:ef7eb2e8f9f7 216 */
<> 144:ef7eb2e8f9f7 217
<> 144:ef7eb2e8f9f7 218 /**
<> 144:ef7eb2e8f9f7 219 * @}
<> 144:ef7eb2e8f9f7 220 */
<> 144:ef7eb2e8f9f7 221
<> 144:ef7eb2e8f9f7 222 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 223 }
<> 144:ef7eb2e8f9f7 224 #endif
<> 144:ef7eb2e8f9f7 225
Anna Bridge 186:707f6e361f3e 226 #endif /*__STM32L0xx_HAL_ADC_EX_H */
<> 144:ef7eb2e8f9f7 227
<> 144:ef7eb2e8f9f7 228
<> 144:ef7eb2e8f9f7 229 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/