Egor Rumjantsev / mbed

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

Fork of mbed by mbed official

TARGET_NUCLEO_F334R8/stm32f3xx_hal_adc.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
92:4fc01daae5a5 
12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 86:04dd9b1680ae 1 /**
bogdanm 86:04dd9b1680ae 2 ******************************************************************************
bogdanm 86:04dd9b1680ae 3 * @file stm32f3xx_hal_adc.h
bogdanm 86:04dd9b1680ae 4 * @author MCD Application Team
bogdanm 92:4fc01daae5a5 5 * @version V1.1.0
bogdanm 92:4fc01daae5a5 6 * @date 12-Sept-2014
bogdanm 86:04dd9b1680ae 7 * @brief Header file containing functions prototypes of ADC HAL library.
bogdanm 86:04dd9b1680ae 8 ******************************************************************************
bogdanm 86:04dd9b1680ae 9 * @attention
bogdanm 86:04dd9b1680ae 10 *
bogdanm 86:04dd9b1680ae 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
bogdanm 86:04dd9b1680ae 12 *
bogdanm 86:04dd9b1680ae 13 * Redistribution and use in source and binary forms, with or without modification,
bogdanm 86:04dd9b1680ae 14 * are permitted provided that the following conditions are met:
bogdanm 86:04dd9b1680ae 15 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 86:04dd9b1680ae 16 * this list of conditions and the following disclaimer.
bogdanm 86:04dd9b1680ae 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 86:04dd9b1680ae 18 * this list of conditions and the following disclaimer in the documentation
bogdanm 86:04dd9b1680ae 19 * and/or other materials provided with the distribution.
bogdanm 86:04dd9b1680ae 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 86:04dd9b1680ae 21 * may be used to endorse or promote products derived from this software
bogdanm 86:04dd9b1680ae 22 * without specific prior written permission.
bogdanm 86:04dd9b1680ae 23 *
bogdanm 86:04dd9b1680ae 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 86:04dd9b1680ae 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 86:04dd9b1680ae 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 86:04dd9b1680ae 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 86:04dd9b1680ae 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 86:04dd9b1680ae 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 86:04dd9b1680ae 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 86:04dd9b1680ae 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 86:04dd9b1680ae 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 86:04dd9b1680ae 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 86:04dd9b1680ae 34 *
bogdanm 86:04dd9b1680ae 35 ******************************************************************************
bogdanm 86:04dd9b1680ae 36 */
bogdanm 86:04dd9b1680ae 37
bogdanm 86:04dd9b1680ae 38 /* Define to prevent recursive inclusion -------------------------------------*/
bogdanm 86:04dd9b1680ae 39 #ifndef __STM32F3xx_ADC_H
bogdanm 86:04dd9b1680ae 40 #define __STM32F3xx_ADC_H
bogdanm 86:04dd9b1680ae 41
bogdanm 86:04dd9b1680ae 42 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 43 extern "C" {
bogdanm 86:04dd9b1680ae 44 #endif
bogdanm 86:04dd9b1680ae 45
bogdanm 86:04dd9b1680ae 46 /* Includes ------------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 47 #include "stm32f3xx_hal_def.h"
bogdanm 86:04dd9b1680ae 48 #include "stm32f3xx_hal_adc_ex.h"
bogdanm 86:04dd9b1680ae 49
bogdanm 86:04dd9b1680ae 50 /** @addtogroup STM32F3xx_HAL_Driver
bogdanm 86:04dd9b1680ae 51 * @{
bogdanm 86:04dd9b1680ae 52 */
bogdanm 86:04dd9b1680ae 53
bogdanm 86:04dd9b1680ae 54 /** @addtogroup ADC
bogdanm 86:04dd9b1680ae 55 * @{
bogdanm 86:04dd9b1680ae 56 */
bogdanm 86:04dd9b1680ae 57
bogdanm 86:04dd9b1680ae 58 /* Exported types ------------------------------------------------------------*/
bogdanm 92:4fc01daae5a5 59 /** @defgroup ADC_Exported_Types ADC Exported Types
bogdanm 92:4fc01daae5a5 60 * @{
bogdanm 92:4fc01daae5a5 61 */
bogdanm 86:04dd9b1680ae 62 /**
bogdanm 86:04dd9b1680ae 63 * @brief HAL ADC state machine: ADC States structure definition
bogdanm 86:04dd9b1680ae 64 */
bogdanm 86:04dd9b1680ae 65 typedef enum
bogdanm 86:04dd9b1680ae 66 {
bogdanm 86:04dd9b1680ae 67 HAL_ADC_STATE_RESET = 0x00, /*!< ADC not yet initialized or disabled */
bogdanm 86:04dd9b1680ae 68 HAL_ADC_STATE_READY = 0x01, /*!< ADC peripheral ready for use */
bogdanm 86:04dd9b1680ae 69 HAL_ADC_STATE_BUSY = 0x02, /*!< An internal process is ongoing */
bogdanm 86:04dd9b1680ae 70 HAL_ADC_STATE_BUSY_REG = 0x12, /*!< Regular conversion is ongoing */
bogdanm 86:04dd9b1680ae 71 HAL_ADC_STATE_BUSY_INJ = 0x22, /*!< Injected conversion is ongoing */
bogdanm 86:04dd9b1680ae 72 HAL_ADC_STATE_BUSY_INJ_REG = 0x32, /*!< Injected and regular conversion are ongoing */
bogdanm 86:04dd9b1680ae 73 HAL_ADC_STATE_TIMEOUT = 0x03, /*!< Timeout state */
bogdanm 86:04dd9b1680ae 74 HAL_ADC_STATE_ERROR = 0x04, /*!< ADC state error */
bogdanm 86:04dd9b1680ae 75 HAL_ADC_STATE_EOC = 0x05, /*!< Conversion is completed */
bogdanm 86:04dd9b1680ae 76 HAL_ADC_STATE_EOC_REG = 0x15, /*!< Regular conversion is completed */
bogdanm 86:04dd9b1680ae 77 HAL_ADC_STATE_EOC_INJ = 0x25, /*!< Injected conversion is completed */
bogdanm 86:04dd9b1680ae 78 HAL_ADC_STATE_EOC_INJ_REG = 0x35, /*!< Injected and regular conversion are completed */
bogdanm 86:04dd9b1680ae 79 HAL_ADC_STATE_AWD = 0x06, /*!< ADC state analog watchdog (main analog watchdog, present on all STM32 devices) */
bogdanm 86:04dd9b1680ae 80 HAL_ADC_STATE_AWD2 = 0x07, /*!< ADC state analog watchdog (additional analog watchdog, present only on STM32F3 devices) */
bogdanm 86:04dd9b1680ae 81 HAL_ADC_STATE_AWD3 = 0x08, /*!< ADC state analog watchdog (additional analog watchdog, present only on STM32F3 devices) */
bogdanm 86:04dd9b1680ae 82 }HAL_ADC_StateTypeDef;
bogdanm 86:04dd9b1680ae 83
bogdanm 86:04dd9b1680ae 84 /**
bogdanm 86:04dd9b1680ae 85 * @brief ADC handle Structure definition
bogdanm 86:04dd9b1680ae 86 */
bogdanm 86:04dd9b1680ae 87 typedef struct __ADC_HandleTypeDef
bogdanm 86:04dd9b1680ae 88 {
bogdanm 86:04dd9b1680ae 89 ADC_TypeDef *Instance; /*!< Register base address */
bogdanm 86:04dd9b1680ae 90
bogdanm 86:04dd9b1680ae 91 ADC_InitTypeDef Init; /*!< ADC required parameters */
bogdanm 86:04dd9b1680ae 92
bogdanm 86:04dd9b1680ae 93 __IO uint32_t NbrOfConversionRank ; /*!< ADC conversion rank counter */
bogdanm 86:04dd9b1680ae 94
bogdanm 86:04dd9b1680ae 95 DMA_HandleTypeDef *DMA_Handle; /*!< Pointer DMA Handler */
bogdanm 86:04dd9b1680ae 96
bogdanm 86:04dd9b1680ae 97 HAL_LockTypeDef Lock; /*!< ADC locking object */
bogdanm 86:04dd9b1680ae 98
bogdanm 86:04dd9b1680ae 99 __IO HAL_ADC_StateTypeDef State; /*!< ADC communication state */
bogdanm 86:04dd9b1680ae 100
bogdanm 86:04dd9b1680ae 101 __IO uint32_t ErrorCode; /*!< ADC Error code */
bogdanm 86:04dd9b1680ae 102 }ADC_HandleTypeDef;
bogdanm 92:4fc01daae5a5 103 /**
bogdanm 92:4fc01daae5a5 104 * @}
bogdanm 92:4fc01daae5a5 105 */
bogdanm 86:04dd9b1680ae 106
bogdanm 86:04dd9b1680ae 107 /* Exported constants --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 108 /* Exported macros -----------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 109
bogdanm 92:4fc01daae5a5 110 /** @defgroup ADC_Exported_Macro ADC Exported Macros
bogdanm 86:04dd9b1680ae 111 * @{
bogdanm 86:04dd9b1680ae 112 */
bogdanm 86:04dd9b1680ae 113 /** @brief Reset ADC handle state
bogdanm 86:04dd9b1680ae 114 * @param __HANDLE__: ADC handle
bogdanm 86:04dd9b1680ae 115 * @retval None
bogdanm 86:04dd9b1680ae 116 */
bogdanm 86:04dd9b1680ae 117 #define __HAL_ADC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_ADC_STATE_RESET)
bogdanm 86:04dd9b1680ae 118
bogdanm 86:04dd9b1680ae 119 /**
bogdanm 86:04dd9b1680ae 120 * @}
bogdanm 86:04dd9b1680ae 121 */
bogdanm 86:04dd9b1680ae 122
bogdanm 86:04dd9b1680ae 123
bogdanm 92:4fc01daae5a5 124 /* Include ADC HAL Extended module */
bogdanm 86:04dd9b1680ae 125 #include "stm32f3xx_hal_adc_ex.h"
bogdanm 86:04dd9b1680ae 126
bogdanm 86:04dd9b1680ae 127 /* Exported functions --------------------------------------------------------*/
bogdanm 92:4fc01daae5a5 128 /** @addtogroup ADC_Exported_Functions ADC Exported Functions
bogdanm 92:4fc01daae5a5 129 * @{
bogdanm 92:4fc01daae5a5 130 */
bogdanm 92:4fc01daae5a5 131
bogdanm 92:4fc01daae5a5 132 /** @addtogroup ADC_Exported_Functions_Group1 Initialization and de-initialization functions
bogdanm 92:4fc01daae5a5 133 * @brief Initialization and Configuration functions
bogdanm 92:4fc01daae5a5 134 * @{
bogdanm 92:4fc01daae5a5 135 */
bogdanm 86:04dd9b1680ae 136 /* Initialization and de-initialization functions **********************************/
bogdanm 86:04dd9b1680ae 137 HAL_StatusTypeDef HAL_ADC_Init(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 138 HAL_StatusTypeDef HAL_ADC_DeInit(ADC_HandleTypeDef *hadc);
bogdanm 86:04dd9b1680ae 139 void HAL_ADC_MspInit(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 140 void HAL_ADC_MspDeInit(ADC_HandleTypeDef* hadc);
bogdanm 92:4fc01daae5a5 141 /**
bogdanm 92:4fc01daae5a5 142 * @}
bogdanm 92:4fc01daae5a5 143 */
bogdanm 86:04dd9b1680ae 144
bogdanm 92:4fc01daae5a5 145 /** @addtogroup ADC_Exported_Functions_Group2 Input and Output operation functions
bogdanm 92:4fc01daae5a5 146 * @brief IO operation functions
bogdanm 92:4fc01daae5a5 147 * @{
bogdanm 92:4fc01daae5a5 148 */
bogdanm 86:04dd9b1680ae 149 /* Blocking mode: Polling */
bogdanm 86:04dd9b1680ae 150 HAL_StatusTypeDef HAL_ADC_Start(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 151 HAL_StatusTypeDef HAL_ADC_Stop(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 152 HAL_StatusTypeDef HAL_ADC_PollForConversion(ADC_HandleTypeDef* hadc, uint32_t Timeout);
bogdanm 86:04dd9b1680ae 153 HAL_StatusTypeDef HAL_ADC_PollForEvent(ADC_HandleTypeDef* hadc, uint32_t EventType, uint32_t Timeout);
bogdanm 86:04dd9b1680ae 154
bogdanm 86:04dd9b1680ae 155 /* Non-blocking mode: Interruption */
bogdanm 86:04dd9b1680ae 156 HAL_StatusTypeDef HAL_ADC_Start_IT(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 157 HAL_StatusTypeDef HAL_ADC_Stop_IT(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 158
bogdanm 86:04dd9b1680ae 159 /* Non-blocking mode: DMA */
bogdanm 86:04dd9b1680ae 160 HAL_StatusTypeDef HAL_ADC_Start_DMA(ADC_HandleTypeDef* hadc, uint32_t* pData, uint32_t Length);
bogdanm 86:04dd9b1680ae 161 HAL_StatusTypeDef HAL_ADC_Stop_DMA(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 162
bogdanm 86:04dd9b1680ae 163 /* ADC retrieve conversion value intended to be used with polling or interruption */
bogdanm 86:04dd9b1680ae 164 uint32_t HAL_ADC_GetValue(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 165
bogdanm 86:04dd9b1680ae 166 /* ADC IRQHandler and Callbacks used in non-blocking modes (Interruption and DMA) */
bogdanm 86:04dd9b1680ae 167 void HAL_ADC_IRQHandler(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 168 void HAL_ADC_ConvCpltCallback(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 169 void HAL_ADC_ConvHalfCpltCallback(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 170 void HAL_ADC_LevelOutOfWindowCallback(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 171 void HAL_ADC_ErrorCallback(ADC_HandleTypeDef *hadc);
bogdanm 92:4fc01daae5a5 172 /**
bogdanm 92:4fc01daae5a5 173 * @}
bogdanm 92:4fc01daae5a5 174 */
bogdanm 86:04dd9b1680ae 175
bogdanm 92:4fc01daae5a5 176 /** @addtogroup ADC_Exported_Functions_Group3 Peripheral Control functions
bogdanm 92:4fc01daae5a5 177 * @brief Peripheral Control functions
bogdanm 92:4fc01daae5a5 178 * @{
bogdanm 92:4fc01daae5a5 179 */
bogdanm 86:04dd9b1680ae 180 /* Peripheral Control functions ***********************************************/
bogdanm 86:04dd9b1680ae 181 HAL_StatusTypeDef HAL_ADC_ConfigChannel(ADC_HandleTypeDef* hadc, ADC_ChannelConfTypeDef* sConfig);
bogdanm 86:04dd9b1680ae 182 HAL_StatusTypeDef HAL_ADC_AnalogWDGConfig(ADC_HandleTypeDef* hadc, ADC_AnalogWDGConfTypeDef* AnalogWDGConfig);
bogdanm 92:4fc01daae5a5 183 /**
bogdanm 92:4fc01daae5a5 184 * @}
bogdanm 92:4fc01daae5a5 185 */
bogdanm 86:04dd9b1680ae 186
bogdanm 92:4fc01daae5a5 187 /** @defgroup ADC_Exported_Functions_Group4 Peripheral State functions
bogdanm 92:4fc01daae5a5 188 * @brief ADC Peripheral State functions
bogdanm 92:4fc01daae5a5 189 * @{
bogdanm 92:4fc01daae5a5 190 */
bogdanm 86:04dd9b1680ae 191 /* Peripheral State functions *************************************************/
bogdanm 86:04dd9b1680ae 192 HAL_ADC_StateTypeDef HAL_ADC_GetState(ADC_HandleTypeDef* hadc);
bogdanm 86:04dd9b1680ae 193 uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc);
bogdanm 92:4fc01daae5a5 194 /**
bogdanm 92:4fc01daae5a5 195 * @}
bogdanm 92:4fc01daae5a5 196 */
bogdanm 86:04dd9b1680ae 197
bogdanm 92:4fc01daae5a5 198 /**
bogdanm 92:4fc01daae5a5 199 * @}
bogdanm 92:4fc01daae5a5 200 */
bogdanm 86:04dd9b1680ae 201
bogdanm 86:04dd9b1680ae 202 /**
bogdanm 86:04dd9b1680ae 203 * @}
bogdanm 86:04dd9b1680ae 204 */
bogdanm 86:04dd9b1680ae 205
bogdanm 86:04dd9b1680ae 206 /**
bogdanm 86:04dd9b1680ae 207 * @}
bogdanm 86:04dd9b1680ae 208 */
bogdanm 86:04dd9b1680ae 209
bogdanm 86:04dd9b1680ae 210 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 211 }
bogdanm 86:04dd9b1680ae 212 #endif
bogdanm 86:04dd9b1680ae 213
bogdanm 86:04dd9b1680ae 214 #endif /*__STM32F3xx_ADC_H */
bogdanm 86:04dd9b1680ae 215
bogdanm 86:04dd9b1680ae 216
bogdanm 86:04dd9b1680ae 217 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/