mbed official / mbed

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.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_DISCO_F334C8/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_adc.h@168:b9e159c1930a, 2018-05-24 (annotated)

Committer:
AnnaBridge
Date:
Thu May 24 15:35:55 2018 +0100
Revision:
168:b9e159c1930a
Parent:
156:ff21514d8981
Child:
169:a7c7b631e539
mbed library. Release version 162

Who changed what in which revision?

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