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_NUCLEO_F303RE/TOOLCHAIN_ARM_MICRO/stm32f3xx_hal_adc.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_DISCO_F303VC/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_adc.h@169:a7c7b631e539 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 163:e59c8e839560 1 /**
AnnaBridge 163:e59c8e839560 2 ******************************************************************************
AnnaBridge 163:e59c8e839560 3 * @file stm32f3xx_hal_adc.h
AnnaBridge 163:e59c8e839560 4 * @author MCD Application Team
AnnaBridge 163:e59c8e839560 5 * @brief Header file containing functions prototypes of ADC HAL library.
AnnaBridge 163:e59c8e839560 6 ******************************************************************************
AnnaBridge 163:e59c8e839560 7 * @attention
AnnaBridge 163:e59c8e839560 8 *
AnnaBridge 163:e59c8e839560 9 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
AnnaBridge 163:e59c8e839560 10 *
AnnaBridge 163:e59c8e839560 11 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 163:e59c8e839560 12 * are permitted provided that the following conditions are met:
AnnaBridge 163:e59c8e839560 13 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 163:e59c8e839560 14 * this list of conditions and the following disclaimer.
AnnaBridge 163:e59c8e839560 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 163:e59c8e839560 16 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 163:e59c8e839560 17 * and/or other materials provided with the distribution.
AnnaBridge 163:e59c8e839560 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 163:e59c8e839560 19 * may be used to endorse or promote products derived from this software
AnnaBridge 163:e59c8e839560 20 * without specific prior written permission.
AnnaBridge 163:e59c8e839560 21 *
AnnaBridge 163:e59c8e839560 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 163:e59c8e839560 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 163:e59c8e839560 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 163:e59c8e839560 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 163:e59c8e839560 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 163:e59c8e839560 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 163:e59c8e839560 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 163:e59c8e839560 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 163:e59c8e839560 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 163:e59c8e839560 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 163:e59c8e839560 32 *
AnnaBridge 163:e59c8e839560 33 ******************************************************************************
AnnaBridge 163:e59c8e839560 34 */
AnnaBridge 163:e59c8e839560 35
AnnaBridge 163:e59c8e839560 36 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 163:e59c8e839560 37 #ifndef __STM32F3xx_ADC_H
AnnaBridge 163:e59c8e839560 38 #define __STM32F3xx_ADC_H
AnnaBridge 163:e59c8e839560 39
AnnaBridge 163:e59c8e839560 40 #ifdef __cplusplus
AnnaBridge 163:e59c8e839560 41 extern "C" {
AnnaBridge 163:e59c8e839560 42 #endif
AnnaBridge 163:e59c8e839560 43
AnnaBridge 163:e59c8e839560 44 /* Includes ------------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 45 #include "stm32f3xx_hal_def.h"
AnnaBridge 163:e59c8e839560 46
AnnaBridge 163:e59c8e839560 47 /* Include ADC HAL Extended module */
AnnaBridge 163:e59c8e839560 48 /* (include on top of file since ADC structures are defined in extended file) */
AnnaBridge 163:e59c8e839560 49 #include "stm32f3xx_hal_adc_ex.h"
Anna Bridge 169:a7c7b631e539 50
Anna Bridge 169:a7c7b631e539 51 /* Include low level driver */
Anna Bridge 169:a7c7b631e539 52 #include "stm32f3xx_ll_adc.h"
Anna Bridge 169:a7c7b631e539 53
AnnaBridge 163:e59c8e839560 54 /** @addtogroup STM32F3xx_HAL_Driver
AnnaBridge 163:e59c8e839560 55 * @{
AnnaBridge 163:e59c8e839560 56 */
AnnaBridge 163:e59c8e839560 57
AnnaBridge 163:e59c8e839560 58 /** @addtogroup ADC
AnnaBridge 163:e59c8e839560 59 * @{
AnnaBridge 163:e59c8e839560 60 */
AnnaBridge 163:e59c8e839560 61
AnnaBridge 163:e59c8e839560 62 /* Exported types ------------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 63 /** @defgroup ADC_Exported_Types ADC Exported Types
AnnaBridge 163:e59c8e839560 64 * @{
AnnaBridge 163:e59c8e839560 65 */
AnnaBridge 163:e59c8e839560 66 /**
AnnaBridge 163:e59c8e839560 67 * @brief HAL ADC state machine: ADC states definition (bitfields)
AnnaBridge 163:e59c8e839560 68 * @note ADC state machine is managed by bitfields, state must be compared
AnnaBridge 163:e59c8e839560 69 * with bit by bit.
AnnaBridge 163:e59c8e839560 70 * For example:
AnnaBridge 163:e59c8e839560 71 * " if (HAL_IS_BIT_SET(HAL_ADC_GetState(hadc1), HAL_ADC_STATE_REG_BUSY)) "
AnnaBridge 163:e59c8e839560 72 * " if (HAL_IS_BIT_SET(HAL_ADC_GetState(hadc1), HAL_ADC_STATE_AWD1) ) "
AnnaBridge 163:e59c8e839560 73 */
AnnaBridge 163:e59c8e839560 74 /* States of ADC global scope */
AnnaBridge 163:e59c8e839560 75 #define HAL_ADC_STATE_RESET (0x00000000U) /*!< ADC not yet initialized or disabled */
AnnaBridge 163:e59c8e839560 76 #define HAL_ADC_STATE_READY (0x00000001U) /*!< ADC peripheral ready for use */
AnnaBridge 163:e59c8e839560 77 #define HAL_ADC_STATE_BUSY_INTERNAL (0x00000002U) /*!< ADC is busy to internal process (initialization, calibration) */
AnnaBridge 163:e59c8e839560 78 #define HAL_ADC_STATE_TIMEOUT (0x00000004U) /*!< TimeOut occurrence */
AnnaBridge 163:e59c8e839560 79
AnnaBridge 163:e59c8e839560 80 /* States of ADC errors */
AnnaBridge 163:e59c8e839560 81 #define HAL_ADC_STATE_ERROR_INTERNAL (0x00000010U) /*!< Internal error occurrence */
AnnaBridge 163:e59c8e839560 82 #define HAL_ADC_STATE_ERROR_CONFIG (0x00000020U) /*!< Configuration error occurrence */
AnnaBridge 163:e59c8e839560 83 #define HAL_ADC_STATE_ERROR_DMA (0x00000040U) /*!< DMA error occurrence */
AnnaBridge 163:e59c8e839560 84
AnnaBridge 163:e59c8e839560 85 /* States of ADC group regular */
AnnaBridge 163:e59c8e839560 86 #define HAL_ADC_STATE_REG_BUSY (0x00000100U) /*!< A conversion on group regular is ongoing or can occur (either by continuous mode,
AnnaBridge 163:e59c8e839560 87 external trigger, low power auto power-on, multimode ADC master control) */
AnnaBridge 163:e59c8e839560 88 #define HAL_ADC_STATE_REG_EOC (0x00000200U) /*!< Conversion data available on group regular */
AnnaBridge 163:e59c8e839560 89 #define HAL_ADC_STATE_REG_OVR (0x00000400U) /*!< Overrun occurrence */
AnnaBridge 163:e59c8e839560 90 #define HAL_ADC_STATE_REG_EOSMP (0x00000800U) /*!< End Of Sampling flag raised */
AnnaBridge 163:e59c8e839560 91
AnnaBridge 163:e59c8e839560 92 /* States of ADC group injected */
AnnaBridge 163:e59c8e839560 93 #define HAL_ADC_STATE_INJ_BUSY (0x00001000U) /*!< A conversion on group injected is ongoing or can occur (either by auto-injection mode,
AnnaBridge 163:e59c8e839560 94 external trigger, low power auto power-on, multimode ADC master control) */
AnnaBridge 163:e59c8e839560 95 #define HAL_ADC_STATE_INJ_EOC (0x00002000U) /*!< Conversion data available on group injected */
AnnaBridge 163:e59c8e839560 96 #define HAL_ADC_STATE_INJ_JQOVF (0x00004000U) /*!< Injected queue overflow occurrence */
AnnaBridge 163:e59c8e839560 97
AnnaBridge 163:e59c8e839560 98 /* States of ADC analog watchdogs */
AnnaBridge 163:e59c8e839560 99 #define HAL_ADC_STATE_AWD1 (0x00010000U) /*!< Out-of-window occurrence of analog watchdog 1 */
AnnaBridge 163:e59c8e839560 100 #define HAL_ADC_STATE_AWD2 (0x00020000U) /*!< Out-of-window occurrence of analog watchdog 2 */
AnnaBridge 163:e59c8e839560 101 #define HAL_ADC_STATE_AWD3 (0x00040000U) /*!< Out-of-window occurrence of analog watchdog 3 */
AnnaBridge 163:e59c8e839560 102
AnnaBridge 163:e59c8e839560 103 /* States of ADC multi-mode */
AnnaBridge 163:e59c8e839560 104 #define HAL_ADC_STATE_MULTIMODE_SLAVE (0x00100000U) /*!< ADC in multimode slave state, controlled by another ADC master ( */
AnnaBridge 163:e59c8e839560 105
AnnaBridge 163:e59c8e839560 106
AnnaBridge 163:e59c8e839560 107 /**
AnnaBridge 163:e59c8e839560 108 * @brief ADC handle Structure definition
AnnaBridge 163:e59c8e839560 109 */
AnnaBridge 163:e59c8e839560 110 typedef struct __ADC_HandleTypeDef
AnnaBridge 163:e59c8e839560 111 {
AnnaBridge 163:e59c8e839560 112 ADC_TypeDef *Instance; /*!< Register base address */
AnnaBridge 163:e59c8e839560 113
AnnaBridge 163:e59c8e839560 114 ADC_InitTypeDef Init; /*!< ADC required parameters */
AnnaBridge 163:e59c8e839560 115
AnnaBridge 163:e59c8e839560 116 DMA_HandleTypeDef *DMA_Handle; /*!< Pointer DMA Handler */
AnnaBridge 163:e59c8e839560 117
AnnaBridge 163:e59c8e839560 118 HAL_LockTypeDef Lock; /*!< ADC locking object */
AnnaBridge 163:e59c8e839560 119
AnnaBridge 163:e59c8e839560 120 __IO uint32_t State; /*!< ADC communication state (bitmap of ADC states) */
AnnaBridge 163:e59c8e839560 121
AnnaBridge 163:e59c8e839560 122 __IO uint32_t ErrorCode; /*!< ADC Error code */
AnnaBridge 163:e59c8e839560 123
AnnaBridge 163:e59c8e839560 124 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \
AnnaBridge 163:e59c8e839560 125 defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
AnnaBridge 163:e59c8e839560 126 defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx) || \
AnnaBridge 163:e59c8e839560 127 defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx)
AnnaBridge 163:e59c8e839560 128 ADC_InjectionConfigTypeDef InjectionConfig ; /*!< ADC injected channel configuration build-up structure */
AnnaBridge 163:e59c8e839560 129 #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */
AnnaBridge 163:e59c8e839560 130 /* STM32F302xC || STM32F303xC || STM32F358xx || */
AnnaBridge 163:e59c8e839560 131 /* STM32F303x8 || STM32F334x8 || STM32F328xx || */
AnnaBridge 163:e59c8e839560 132 /* STM32F301x8 || STM32F302x8 || STM32F318xx */
AnnaBridge 163:e59c8e839560 133
AnnaBridge 163:e59c8e839560 134 }ADC_HandleTypeDef;
AnnaBridge 163:e59c8e839560 135 /**
AnnaBridge 163:e59c8e839560 136 * @}
AnnaBridge 163:e59c8e839560 137 */
AnnaBridge 163:e59c8e839560 138
AnnaBridge 163:e59c8e839560 139 /* Exported constants --------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 140 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 141
AnnaBridge 163:e59c8e839560 142 /** @defgroup ADC_Exported_Macro ADC Exported Macros
AnnaBridge 163:e59c8e839560 143 * @{
AnnaBridge 163:e59c8e839560 144 */
AnnaBridge 163:e59c8e839560 145 /** @brief Reset ADC handle state
AnnaBridge 168:b9e159c1930a 146 * @param __HANDLE__ ADC handle
AnnaBridge 163:e59c8e839560 147 * @retval None
AnnaBridge 163:e59c8e839560 148 */
AnnaBridge 163:e59c8e839560 149 #define __HAL_ADC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_ADC_STATE_RESET)
AnnaBridge 163:e59c8e839560 150
AnnaBridge 163:e59c8e839560 151 /**
AnnaBridge 163:e59c8e839560 152 * @}
AnnaBridge 163:e59c8e839560 153 */
AnnaBridge 163:e59c8e839560 154
AnnaBridge 163:e59c8e839560 155
AnnaBridge 163:e59c8e839560 156
AnnaBridge 163:e59c8e839560 157 /* Exported functions --------------------------------------------------------*/
AnnaBridge 163:e59c8e839560 158 /** @addtogroup ADC_Exported_Functions ADC Exported Functions
AnnaBridge 163:e59c8e839560 159 * @{
AnnaBridge 163:e59c8e839560 160 */
AnnaBridge 163:e59c8e839560 161
AnnaBridge 163:e59c8e839560 162 /** @addtogroup ADC_Exported_Functions_Group1 Initialization and de-initialization functions
AnnaBridge 163:e59c8e839560 163 * @{
AnnaBridge 163:e59c8e839560 164 */
AnnaBridge 163:e59c8e839560 165 /* Initialization and de-initialization functions **********************************/
AnnaBridge 163:e59c8e839560 166 HAL_StatusTypeDef HAL_ADC_Init(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 167 HAL_StatusTypeDef HAL_ADC_DeInit(ADC_HandleTypeDef *hadc);
AnnaBridge 163:e59c8e839560 168 void HAL_ADC_MspInit(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 169 void HAL_ADC_MspDeInit(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 170 /**
AnnaBridge 163:e59c8e839560 171 * @}
AnnaBridge 163:e59c8e839560 172 */
AnnaBridge 163:e59c8e839560 173
AnnaBridge 163:e59c8e839560 174 /** @addtogroup ADC_Exported_Functions_Group2 Input and Output operation functions
AnnaBridge 163:e59c8e839560 175 * @{
AnnaBridge 163:e59c8e839560 176 */
AnnaBridge 163:e59c8e839560 177 /* Blocking mode: Polling */
AnnaBridge 163:e59c8e839560 178 HAL_StatusTypeDef HAL_ADC_Start(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 179 HAL_StatusTypeDef HAL_ADC_Stop(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 180 HAL_StatusTypeDef HAL_ADC_PollForConversion(ADC_HandleTypeDef* hadc, uint32_t Timeout);
AnnaBridge 163:e59c8e839560 181 HAL_StatusTypeDef HAL_ADC_PollForEvent(ADC_HandleTypeDef* hadc, uint32_t EventType, uint32_t Timeout);
AnnaBridge 163:e59c8e839560 182
AnnaBridge 163:e59c8e839560 183 /* Non-blocking mode: Interruption */
AnnaBridge 163:e59c8e839560 184 HAL_StatusTypeDef HAL_ADC_Start_IT(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 185 HAL_StatusTypeDef HAL_ADC_Stop_IT(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 186
AnnaBridge 163:e59c8e839560 187 /* Non-blocking mode: DMA */
AnnaBridge 163:e59c8e839560 188 HAL_StatusTypeDef HAL_ADC_Start_DMA(ADC_HandleTypeDef* hadc, uint32_t* pData, uint32_t Length);
AnnaBridge 163:e59c8e839560 189 HAL_StatusTypeDef HAL_ADC_Stop_DMA(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 190
AnnaBridge 163:e59c8e839560 191 /* ADC retrieve conversion value intended to be used with polling or interruption */
AnnaBridge 163:e59c8e839560 192 uint32_t HAL_ADC_GetValue(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 193
AnnaBridge 163:e59c8e839560 194 /* ADC IRQHandler and Callbacks used in non-blocking modes (Interruption and DMA) */
AnnaBridge 163:e59c8e839560 195 void HAL_ADC_IRQHandler(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 196 void HAL_ADC_ConvCpltCallback(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 197 void HAL_ADC_ConvHalfCpltCallback(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 198 void HAL_ADC_LevelOutOfWindowCallback(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 199 void HAL_ADC_ErrorCallback(ADC_HandleTypeDef *hadc);
AnnaBridge 163:e59c8e839560 200 /**
AnnaBridge 163:e59c8e839560 201 * @}
AnnaBridge 163:e59c8e839560 202 */
AnnaBridge 163:e59c8e839560 203
AnnaBridge 163:e59c8e839560 204 /** @addtogroup ADC_Exported_Functions_Group3 Peripheral Control functions
AnnaBridge 163:e59c8e839560 205 * @{
AnnaBridge 163:e59c8e839560 206 */
AnnaBridge 163:e59c8e839560 207 /* Peripheral Control functions ***********************************************/
AnnaBridge 163:e59c8e839560 208 HAL_StatusTypeDef HAL_ADC_ConfigChannel(ADC_HandleTypeDef* hadc, ADC_ChannelConfTypeDef* sConfig);
AnnaBridge 163:e59c8e839560 209 HAL_StatusTypeDef HAL_ADC_AnalogWDGConfig(ADC_HandleTypeDef* hadc, ADC_AnalogWDGConfTypeDef* AnalogWDGConfig);
AnnaBridge 163:e59c8e839560 210 /**
AnnaBridge 163:e59c8e839560 211 * @}
AnnaBridge 163:e59c8e839560 212 */
AnnaBridge 163:e59c8e839560 213
AnnaBridge 163:e59c8e839560 214 /** @defgroup ADC_Exported_Functions_Group4 Peripheral State functions
AnnaBridge 163:e59c8e839560 215 * @brief ADC Peripheral State functions
AnnaBridge 163:e59c8e839560 216 * @{
AnnaBridge 163:e59c8e839560 217 */
AnnaBridge 163:e59c8e839560 218 /* Peripheral State functions *************************************************/
AnnaBridge 163:e59c8e839560 219 uint32_t HAL_ADC_GetState(ADC_HandleTypeDef* hadc);
AnnaBridge 163:e59c8e839560 220 uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
AnnaBridge 163:e59c8e839560 221 /**
AnnaBridge 163:e59c8e839560 222 * @}
AnnaBridge 163:e59c8e839560 223 */
AnnaBridge 163:e59c8e839560 224
AnnaBridge 163:e59c8e839560 225 /**
AnnaBridge 163:e59c8e839560 226 * @}
AnnaBridge 163:e59c8e839560 227 */
AnnaBridge 163:e59c8e839560 228
AnnaBridge 163:e59c8e839560 229 /**
AnnaBridge 163:e59c8e839560 230 * @}
AnnaBridge 163:e59c8e839560 231 */
AnnaBridge 163:e59c8e839560 232
AnnaBridge 163:e59c8e839560 233 /**
AnnaBridge 163:e59c8e839560 234 * @}
AnnaBridge 163:e59c8e839560 235 */
AnnaBridge 163:e59c8e839560 236
AnnaBridge 163:e59c8e839560 237 #ifdef __cplusplus
AnnaBridge 163:e59c8e839560 238 }
AnnaBridge 163:e59c8e839560 239 #endif
AnnaBridge 163:e59c8e839560 240
AnnaBridge 163:e59c8e839560 241 #endif /*__STM32F3xx_ADC_H */
AnnaBridge 163:e59c8e839560 242
AnnaBridge 163:e59c8e839560 243
AnnaBridge 163:e59c8e839560 244 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/