1 /** 2 ****************************************************************************** 3 * @file stm32wlxx_hal_adc.h 4 * @author MCD Application Team 5 * @brief Header file of ADC HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2020 STMicroelectronics. 10 * All rights reserved. 11 * 12 * This software is licensed under terms that can be found in the LICENSE file 13 * in the root directory of this software component. 14 * If no LICENSE file comes with this software, it is provided AS-IS. 15 * 16 ****************************************************************************** 17 */ 18 19 /* Define to prevent recursive inclusion -------------------------------------*/ 20 #ifndef STM32WLxx_HAL_ADC_H 21 #define STM32WLxx_HAL_ADC_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32wlxx_hal_def.h" 29 30 /* Include low level driver */ 31 #include "stm32wlxx_ll_adc.h" 32 33 /** @addtogroup STM32WLxx_HAL_Driver 34 * @{ 35 */ 36 37 /** @addtogroup ADC 38 * @{ 39 */ 40 41 /* Exported types ------------------------------------------------------------*/ 42 /** @defgroup ADC_Exported_Types ADC Exported Types 43 * @{ 44 */ 45 46 /** 47 * @brief ADC group regular oversampling structure definition 48 */ 49 typedef struct 50 { 51 uint32_t Ratio; /*!< Configures the oversampling ratio. 52 This parameter can be a value of @ref ADC_HAL_EC_OVS_RATIO */ 53 54 uint32_t RightBitShift; /*!< Configures the division coefficient for the Oversampler. 55 This parameter can be a value of @ref ADC_HAL_EC_OVS_SHIFT */ 56 57 uint32_t TriggeredMode; /*!< Selects the regular triggered oversampling mode. 58 This parameter can be a value of @ref ADC_HAL_EC_OVS_DISCONT_MODE */ 59 60 } ADC_OversamplingTypeDef; 61 62 /** 63 * @brief Structure definition of ADC instance and ADC group regular. 64 * @note Parameters of this structure are shared within 2 scopes: 65 * - Scope entire ADC (differentiation done for compatibility with some other STM32 series featuring ADC 66 * groups regular and injected): ClockPrescaler, Resolution, DataAlign, 67 * ScanConvMode, EOCSelection, LowPowerAutoWait. 68 * - Scope ADC group regular: ContinuousConvMode, NbrOfConversion, DiscontinuousConvMode, 69 * ExternalTrigConv, ExternalTrigConvEdge, DMAContinuousRequests, Overrun, OversamplingMode, Oversampling. 70 * @note The setting of these parameters by function HAL_ADC_Init() is conditioned to ADC state. 71 * ADC state can be either: 72 * - For all parameters: ADC disabled 73 * - For all parameters except 'ClockPrescaler' and 'Resolution': ADC enabled without conversion on going on 74 * group regular. 75 * If ADC is not in the appropriate state to modify some parameters, these parameters setting is bypassed 76 * without error reporting (as it can be the expected behavior in case of intended action to update another 77 * parameter (which fulfills the ADC state condition) on the fly). 78 */ 79 typedef struct 80 { 81 uint32_t ClockPrescaler; /*!< Select ADC clock source (synchronous clock derived from APB clock or asynchronous 82 clock derived from system clock or PLL (Refer to reference manual for list of 83 clocks available)) and clock prescaler. 84 This parameter can be a value of @ref ADC_HAL_EC_COMMON_CLOCK_SOURCE. 85 Note: The ADC clock configuration is common to all ADC instances. 86 Note: In case of synchronous clock mode based on HCLK/1, the configuration must 87 be enabled only if the system clock has a 50% duty clock cycle (APB 88 prescaler configured inside RCC must be bypassed and PCLK clock must have 89 50% duty cycle). Refer to reference manual for details. 90 Note: In case of usage of asynchronous clock, the selected clock must be 91 preliminarily enabled at RCC top level. 92 Note: This parameter can be modified only if all ADC instances are disabled. */ 93 94 uint32_t Resolution; /*!< Configure the ADC resolution. 95 This parameter can be a value of @ref ADC_HAL_EC_RESOLUTION */ 96 97 uint32_t DataAlign; /*!< Specify ADC data alignment in conversion data register (right or left). 98 Refer to reference manual for alignments formats versus resolutions. 99 This parameter can be a value of @ref ADC_HAL_EC_DATA_ALIGN */ 100 101 uint32_t ScanConvMode; /*!< Configure the sequencer of ADC group regular. 102 On this STM32 series, ADC group regular sequencer both modes "fully configurable" 103 or "not fully configurable" are available: 104 - sequencer configured to fully configurable: 105 sequencer length and each rank affectation to a channel are configurable. 106 - Sequence length: Set number of ranks in the scan sequence. 107 - Sequence direction: Unless specified in parameters, sequencer 108 scan direction is forward (from rank 1 to rank n). 109 - sequencer configured to not fully configurable: 110 sequencer length and each rank affectation to a channel are fixed by channel 111 HW number. 112 - Sequence length: Number of ranks in the scan sequence is 113 defined by number of channels set in the sequence, 114 rank of each channel is fixed by channel HW number. 115 (channel 0 fixed on rank 0, channel 1 fixed on rank1, ...). 116 - Sequence direction: Unless specified in parameters, sequencer 117 scan direction is forward (from lowest channel number to 118 highest channel number). 119 This parameter can be associated to parameter 'DiscontinuousConvMode' to have 120 main sequence subdivided in successive parts. Sequencer is automatically enabled 121 if several channels are set (sequencer cannot be disabled, as it can be the case 122 on other STM32 devices): 123 If only 1 channel is set: Conversion is performed in single mode. 124 If several channels are set: Conversions are performed in sequence mode. 125 This parameter can be a value of @ref ADC_Scan_mode */ 126 127 uint32_t EOCSelection; /*!< Specify which EOC (End Of Conversion) flag is used for conversion by polling and 128 interruption: end of unitary conversion or end of sequence conversions. 129 This parameter can be a value of @ref ADC_EOCSelection. */ 130 131 FunctionalState LowPowerAutoWait; /*!< Select the dynamic low power Auto Delay: new conversion start only when the 132 previous conversion (for ADC group regular) has been retrieved by user software, 133 using function HAL_ADC_GetValue(). 134 This feature automatically adapts the frequency of ADC conversions triggers to 135 the speed of the system that reads the data. Moreover, this avoids risk of 136 overrun for low frequency applications. 137 This parameter can be set to ENABLE or DISABLE. 138 Note: It is not recommended to use with interruption or DMA (HAL_ADC_Start_IT(), 139 HAL_ADC_Start_DMA()) since these modes have to clear immediately the EOC 140 flag (by CPU to free the IRQ pending event or by DMA). 141 Auto wait will work but fort a very short time, discarding its intended 142 benefit (except specific case of high load of CPU or DMA transfers which 143 can justify usage of auto wait). 144 Do use with polling: 1. Start conversion with HAL_ADC_Start(), 2. Later on, 145 when ADC conversion data is needed: 146 use HAL_ADC_PollForConversion() to ensure that conversion is completed and 147 HAL_ADC_GetValue() to retrieve conversion result and trig another 148 conversion start. */ 149 150 FunctionalState LowPowerAutoPowerOff; /*!< Select the auto-off mode: the ADC automatically powers-off after a 151 conversion and automatically wakes-up when a new conversion is triggered 152 (with startup time between trigger and start of sampling). 153 This feature can be combined with automatic wait mode 154 (parameter 'LowPowerAutoWait'). 155 This parameter can be set to ENABLE or DISABLE. */ 156 157 FunctionalState ContinuousConvMode; /*!< Specify whether the conversion is performed in single mode (one conversion) 158 or continuous mode for ADC group regular, after the first ADC conversion 159 start trigger occurred (software start or external trigger). This parameter 160 can be set to ENABLE or DISABLE. */ 161 162 uint32_t NbrOfConversion; /*!< Specify the number of ranks that will be converted within the regular group 163 sequencer. 164 This parameter is dependent on ScanConvMode: 165 - sequencer configured to fully configurable: 166 Number of ranks in the scan sequence is configurable using this parameter. 167 Note: After the first call of 'HAL_ADC_Init()', each rank corresponding to 168 parameter "NbrOfConversion" must be set using 'HAL_ADC_ConfigChannel()'. 169 Afterwards, when all needed sequencer ranks are set, parameter 170 'NbrOfConversion' can be updated without modifying configuration of 171 sequencer ranks (sequencer ranks above 'NbrOfConversion' are discarded). 172 - sequencer configured to not fully configurable: 173 Number of ranks in the scan sequence is defined by number of channels set in 174 the sequence. This parameter is discarded. 175 This parameter must be a number between Min_Data = 1 and Max_Data = 8. 176 Note: This parameter must be modified when no conversion is on going on regular 177 group (ADC disabled, or ADC enabled without continuous mode or external 178 trigger that could launch a conversion). */ 179 180 FunctionalState DiscontinuousConvMode; /*!< Specify whether the conversions sequence of ADC group regular is performed 181 in Complete-sequence/Discontinuous-sequence (main sequence subdivided in 182 successive parts). 183 Discontinuous mode is used only if sequencer is enabled (parameter 184 'ScanConvMode'). If sequencer is disabled, this parameter is discarded. 185 Discontinuous mode can be enabled only if continuous mode is disabled. 186 If continuous mode is enabled, this parameter setting is discarded. 187 This parameter can be set to ENABLE or DISABLE. 188 Note: On this STM32 series, ADC group regular number of discontinuous 189 ranks increment is fixed to one-by-one. */ 190 191 uint32_t ExternalTrigConv; /*!< Select the external event source used to trigger ADC group regular conversion 192 start. 193 If set to ADC_SOFTWARE_START, external triggers are disabled and software trigger 194 is used instead. 195 This parameter can be a value of @ref ADC_regular_external_trigger_source. 196 Caution: external trigger source is common to all ADC instances. */ 197 198 uint32_t ExternalTrigConvEdge; /*!< Select the external event edge used to trigger ADC group regular conversion start 199 If trigger source is set to ADC_SOFTWARE_START, this parameter is discarded. 200 This parameter can be a value of @ref ADC_regular_external_trigger_edge */ 201 202 FunctionalState DMAContinuousRequests; /*!< Specify whether the DMA requests are performed in one shot mode (DMA 203 transfer stops when number of conversions is reached) or in continuous 204 mode (DMA transfer unlimited, whatever number of conversions). 205 This parameter can be set to ENABLE or DISABLE. 206 Note: In continuous mode, DMA must be configured in circular mode. 207 Otherwise an overrun will be triggered when DMA buffer maximum 208 pointer is reached. */ 209 210 uint32_t Overrun; /*!< Select the behavior in case of overrun: data overwritten or preserved (default). 211 This parameter can be a value of @ref ADC_HAL_EC_REG_OVR_DATA_BEHAVIOR. 212 Note: In case of overrun set to data preserved and usage with programming model 213 with interruption (HAL_Start_IT()): ADC IRQ handler has to clear end of 214 conversion flags, this induces the release of the preserved data. If 215 needed, this data can be saved in function HAL_ADC_ConvCpltCallback(), 216 placed in user program code (called before end of conversion flags clear) 217 Note: Error reporting with respect to the conversion mode: 218 - Usage with ADC conversion by polling for event or interruption: Error is 219 reported only if overrun is set to data preserved. If overrun is set to 220 data overwritten, user can willingly not read all the converted data, 221 this is not considered as an erroneous case. 222 - Usage with ADC conversion by DMA: Error is reported whatever overrun 223 setting (DMA is expected to process all data from data register). */ 224 225 uint32_t SamplingTimeCommon1; /*!< Set sampling time common to a group of channels. 226 Unit: ADC clock cycles 227 Conversion time is the addition of sampling time and processing time 228 (12.5 ADC clock cycles at ADC resolution 12 bits, 229 10.5 cycles at 10 bits, 230 8.5 cycles at 8 bits, 231 6.5 cycles at 6 bits). 232 Note: On this STM32 family, two different sampling time settings are available, 233 each channel can use one of these two settings. On some other STM32 devices 234 this parameter in channel wise and is located into ADC channel 235 initialization structure. 236 This parameter can be a value of @ref ADC_HAL_EC_CHANNEL_SAMPLINGTIME 237 Note: In case of usage of internal measurement channels (VrefInt/Vbat/TempSensor) 238 sampling time constraints must be respected (sampling time can be adjusted 239 in function of ADC clock frequency and sampling time setting) 240 Refer to device datasheet for timings values, parameters TS_vrefint, 241 TS_vbat, TS_temp (values rough order: few tens of microseconds). */ 242 243 uint32_t SamplingTimeCommon2; /*!< Set sampling time common to a group of channels, second common setting possible. 244 Unit: ADC clock cycles 245 Conversion time is the addition of sampling time and processing time 246 (12.5 ADC clock cycles at ADC resolution 12 bits, 247 10.5 cycles at 10 bits, 248 8.5 cycles at 8 bits, 249 6.5 cycles at 6 bits). 250 Note: On this STM32 family, two different sampling time settings are available, 251 each channel can use one of these two settings. On some other STM32 devices 252 this parameter in channel wise and is located into ADC channel 253 initialization structure. 254 This parameter can be a value of @ref ADC_HAL_EC_CHANNEL_SAMPLINGTIME 255 Note: In case of usage of internal measurement channels (VrefInt/Vbat/TempSensor) 256 sampling time constraints must be respected (sampling time can be adjusted 257 in function of ADC clock frequency and sampling time setting) 258 Refer to device datasheet for timings values, parameters TS_vrefint, 259 TS_vbat, TS_temp (values rough order: few tens of microseconds). */ 260 261 FunctionalState OversamplingMode; /*!< Specify whether the oversampling feature is enabled or disabled. 262 This parameter can be set to ENABLE or DISABLE. 263 Note: This parameter can be modified only if there is no conversion is 264 ongoing on ADC group regular. */ 265 266 ADC_OversamplingTypeDef Oversampling; /*!< Specify the Oversampling parameters. 267 Caution: this setting overwrites the previous oversampling configuration 268 if oversampling is already enabled. */ 269 270 uint32_t TriggerFrequencyMode; /*!< Set ADC trigger frequency mode. 271 This parameter can be a value of @ref ADC_HAL_EC_REG_TRIGGER_FREQ. 272 Note: ADC trigger frequency mode must be set to low frequency when 273 a duration is exceeded before ADC conversion start trigger event 274 (between ADC enable and ADC conversion start trigger event 275 or between two ADC conversion start trigger event). 276 Duration value: Refer to device datasheet, parameter "tIdle". 277 Note: When ADC trigger frequency mode is set to low frequency, 278 some rearm cycles are inserted before performing ADC conversion 279 start, inducing a delay of 2 ADC clock cycles. */ 280 281 } ADC_InitTypeDef; 282 283 /** 284 * @brief Structure definition of ADC channel for regular group 285 * @note The setting of these parameters by function HAL_ADC_ConfigChannel() is conditioned to ADC state. 286 * ADC state can be either: 287 * - For all parameters: ADC disabled or enabled without conversion on going on regular group. 288 * If ADC is not in the appropriate state to modify some parameters, these parameters setting is bypassed 289 * without error reporting (as it can be the expected behavior in case of intended action to update another 290 * parameter (which fulfills the ADC state condition) on the fly). 291 */ 292 typedef struct 293 { 294 uint32_t Channel; /*!< Specify the channel to configure into ADC regular group. 295 This parameter can be a value of @ref ADC_HAL_EC_CHANNEL 296 Note: Depending on devices and ADC instances, some channels may not be available 297 on device package pins. Refer to device datasheet for channels 298 availability. */ 299 300 uint32_t Rank; /*!< Add or remove the channel from ADC regular group sequencer and specify its 301 conversion rank. 302 This parameter is dependent on ScanConvMode: 303 - sequencer configured to fully configurable: 304 Channels ordering into each rank of scan sequence: 305 whatever channel can be placed into whatever rank. 306 - sequencer configured to not fully configurable: 307 rank of each channel is fixed by channel HW number. 308 (channel 0 fixed on rank 0, channel 1 fixed on rank1, ...). 309 Despite the channel rank is fixed, this parameter allow an additional 310 possibility: to remove the selected rank (selected channel) from sequencer. 311 This parameter can be a value of @ref ADC_HAL_EC_REG_SEQ_RANKS */ 312 313 uint32_t SamplingTime; /*!< Sampling time value to be set for the selected channel. 314 Unit: ADC clock cycles 315 Conversion time is the addition of sampling time and processing time 316 (12.5 ADC clock cycles at ADC resolution 12 bits, 317 10.5 cycles at 10 bits, 318 8.5 cycles at 8 bits, 319 6.5 cycles at 6 bits). 320 This parameter can be a value of @ref ADC_HAL_EC_SAMPLINGTIME_COMMON 321 Note: On this STM32 family, two different sampling time settings are available 322 (refer to parameters "SamplingTimeCommon1" and "SamplingTimeCommon2"), 323 each channel can use one of these two settings. 324 325 Note: In case of usage of internal measurement channels (VrefInt/Vbat/ 326 TempSensor), sampling time constraints must be respected (sampling time 327 can be adjusted in function of ADC clock frequency and sampling time 328 setting) 329 Refer to device datasheet for timings values. */ 330 331 } ADC_ChannelConfTypeDef; 332 333 /** 334 * @brief Structure definition of ADC analog watchdog 335 * @note The setting of these parameters by function HAL_ADC_AnalogWDGConfig() is conditioned to ADC state. 336 * ADC state can be either: 337 * - For all parameters except 'HighThreshold', 'LowThreshold': ADC disabled or ADC enabled without conversion 338 on going on ADC groups regular. 339 * - For parameters 'HighThreshold', 'LowThreshold': ADC enabled with conversion on going on regular. 340 */ 341 typedef struct 342 { 343 uint32_t WatchdogNumber; /*!< Select which ADC analog watchdog is monitoring the selected channel. 344 For Analog Watchdog 1: Only 1 channel can be monitored (or overall group of channels 345 by setting parameter 'WatchdogMode') 346 For Analog Watchdog 2 and 3: Several channels can be monitored (by successive calls 347 of 'HAL_ADC_AnalogWDGConfig()' for each channel) 348 This parameter can be a value of @ref ADC_HAL_EC_AWD_NUMBER. */ 349 350 uint32_t WatchdogMode; /*!< Configure the ADC analog watchdog mode: single/all/none channels. 351 For Analog Watchdog 1: Configure the ADC analog watchdog mode: single channel or all 352 channels, ADC group regular. 353 For Analog Watchdog 2 and 3: Several channels can be monitored by applying 354 successively the AWD init structure. 355 This parameter can be a value of @ref ADC_analog_watchdog_mode. */ 356 357 uint32_t Channel; /*!< Select which ADC channel to monitor by analog watchdog. 358 For Analog Watchdog 1: this parameter has an effect only if parameter 'WatchdogMode' 359 is configured on single channel (only 1 channel can be 360 monitored). 361 For Analog Watchdog 2 and 3: Several channels can be monitored. To use this feature, 362 call successively the function HAL_ADC_AnalogWDGConfig() 363 for each channel to be added (or removed with value 364 'ADC_ANALOGWATCHDOG_NONE'). 365 This parameter can be a value of @ref ADC_HAL_EC_CHANNEL. */ 366 367 FunctionalState ITMode; /*!< Specify whether the analog watchdog is configured in interrupt or polling mode. 368 This parameter can be set to ENABLE or DISABLE */ 369 370 uint32_t HighThreshold; /*!< Configure the ADC analog watchdog High threshold value. 371 Depending of ADC resolution selected (12, 10, 8 or 6 bits), this parameter must be a 372 number between Min_Data = 0x000 and Max_Data = 0xFFF, 0x3FF, 0xFF or 0x3F 373 respectively. 374 Note: Analog watchdog 2 and 3 are limited to a resolution of 8 bits: if ADC 375 resolution is 12 bits the 4 LSB are ignored, if ADC resolution is 10 bits the 2 376 LSB are ignored. */ 377 /*!< Note: If ADC oversampling is enabled, ADC analog watchdog thresholds are 378 impacted: the comparison of analog watchdog thresholds is done on 379 oversampling final computation (after ratio and shift application): 380 ADC data register bitfield [15:4] (12 most significant bits). */ 381 382 uint32_t LowThreshold; /*!< Configures the ADC analog watchdog Low threshold value. 383 Depending of ADC resolution selected (12, 10, 8 or 6 bits), this parameter must be a 384 number between Min_Data = 0x000 and Max_Data = 0xFFF, 0x3FF, 0xFF or 0x3F 385 respectively. 386 Note: Analog watchdog 2 and 3 are limited to a resolution of 8 bits: if ADC 387 resolution is 12 bits the 4 LSB are ignored, if ADC resolution is 10 bits the 2 388 LSB are ignored.*/ 389 /*!< Note: If ADC oversampling is enabled, ADC analog watchdog thresholds are 390 impacted: the comparison of analog watchdog thresholds is done on 391 oversampling final computation (after ratio and shift application): 392 ADC data register bitfield [15:4] (12 most significant bits).*/ 393 } ADC_AnalogWDGConfTypeDef; 394 395 /** @defgroup ADC_States ADC States 396 * @{ 397 */ 398 399 /** 400 * @brief HAL ADC state machine: ADC states definition (bitfields) 401 * @note ADC state machine is managed by bitfields, state must be compared 402 * with bit by bit. 403 * For example: 404 * " if ((HAL_ADC_GetState(hadc1) & HAL_ADC_STATE_REG_BUSY) != 0UL) " 405 * " if ((HAL_ADC_GetState(hadc1) & HAL_ADC_STATE_AWD1) != 0UL) " 406 */ 407 /* States of ADC global scope */ 408 #define HAL_ADC_STATE_RESET (0x00000000UL) /*!< ADC not yet initialized or disabled */ 409 #define HAL_ADC_STATE_READY (0x00000001UL) /*!< ADC peripheral ready for use */ 410 #define HAL_ADC_STATE_BUSY_INTERNAL (0x00000002UL) /*!< ADC is busy due to internal process (ex : calibration) */ 411 #define HAL_ADC_STATE_TIMEOUT (0x00000004UL) /*!< TimeOut occurrence */ 412 413 /* States of ADC errors */ 414 #define HAL_ADC_STATE_ERROR_INTERNAL (0x00000010UL) /*!< Internal error occurrence */ 415 #define HAL_ADC_STATE_ERROR_CONFIG (0x00000020UL) /*!< Configuration error occurrence */ 416 #define HAL_ADC_STATE_ERROR_DMA (0x00000040UL) /*!< DMA error occurrence */ 417 418 /* States of ADC group regular */ 419 #define HAL_ADC_STATE_REG_BUSY (0x00000100UL) /*!< A conversion on ADC group regular is ongoing or can occur 420 (either by continuous mode, external trigger, low power 421 auto power-on (if feature available), multimode ADC master 422 control (if feature available)) */ 423 #define HAL_ADC_STATE_REG_EOC (0x00000200UL) /*!< Conversion data available on group regular */ 424 #define HAL_ADC_STATE_REG_OVR (0x00000400UL) /*!< Overrun occurrence */ 425 #define HAL_ADC_STATE_REG_EOSMP (0x00000800UL) /*!< Not available on this STM32 series: End Of Sampling flag 426 raised */ 427 428 /* States of ADC group injected */ 429 #define HAL_ADC_STATE_INJ_BUSY (0x00001000UL) /*!< Not available on this STM32 series: A conversion on group 430 injected is ongoing or can occur (either by auto-injection 431 mode, external trigger, low power auto power-on (if feature 432 available), multimode ADC master control (if feature 433 available))*/ 434 #define HAL_ADC_STATE_INJ_EOC (0x00002000UL) /*!< Not available on this STM32 series: Conversion data 435 available on group injected */ 436 #define HAL_ADC_STATE_INJ_JQOVF (0x00004000UL) /*!< Not available on this STM32 series: Injected queue overflow 437 occurrence */ 438 439 /* States of ADC analog watchdogs */ 440 #define HAL_ADC_STATE_AWD1 (0x00010000UL) /*!< Out-of-window occurrence of ADC analog watchdog 1 */ 441 #define HAL_ADC_STATE_AWD2 (0x00020000UL) /*!< Out-of-window occurrence of ADC analog watchdog 2 */ 442 #define HAL_ADC_STATE_AWD3 (0x00040000UL) /*!< Out-of-window occurrence of ADC analog watchdog 3 */ 443 444 /* States of ADC multi-mode */ 445 #define HAL_ADC_STATE_MULTIMODE_SLAVE (0x00100000UL) /*!< Not available on this STM32 series: ADC in multimode slave 446 state, controlled by another ADC master (when feature 447 available) */ 448 449 450 /** 451 * @} 452 */ 453 454 /** 455 * @brief ADC handle Structure definition 456 */ 457 #if (USE_HAL_ADC_REGISTER_CALLBACKS == 1) 458 typedef struct __ADC_HandleTypeDef 459 #else 460 typedef struct 461 #endif /* USE_HAL_ADC_REGISTER_CALLBACKS */ 462 { 463 ADC_TypeDef *Instance; /*!< Register base address */ 464 ADC_InitTypeDef Init; /*!< ADC initialization parameters and regular conversions setting */ 465 DMA_HandleTypeDef *DMA_Handle; /*!< Pointer DMA Handler */ 466 HAL_LockTypeDef Lock; /*!< ADC locking object */ 467 __IO uint32_t State; /*!< ADC communication state (bitmap of ADC states) */ 468 __IO uint32_t ErrorCode; /*!< ADC Error code */ 469 470 uint32_t ADCGroupRegularSequencerRanks; /*!< ADC group regular sequencer memorization of ranks 471 setting, used in mode "fully configurable" (refer to 472 parameter 'ScanConvMode') */ 473 #if (USE_HAL_ADC_REGISTER_CALLBACKS == 1) 474 void (* ConvCpltCallback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC conversion complete callback */ 475 void (* ConvHalfCpltCallback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC conversion DMA half-transfer 476 callback */ 477 void (* LevelOutOfWindowCallback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC analog watchdog 1 callback */ 478 void (* ErrorCallback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC error callback */ 479 void (* LevelOutOfWindow2Callback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC analog watchdog 2 callback */ 480 void (* LevelOutOfWindow3Callback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC analog watchdog 3 callback */ 481 void (* EndOfSamplingCallback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC end of sampling callback */ 482 void (* MspInitCallback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC Msp Init callback */ 483 void (* MspDeInitCallback)(struct __ADC_HandleTypeDef *hadc); /*!< ADC Msp DeInit callback */ 484 #endif /* USE_HAL_ADC_REGISTER_CALLBACKS */ 485 } ADC_HandleTypeDef; 486 487 #if (USE_HAL_ADC_REGISTER_CALLBACKS == 1) 488 /** 489 * @brief HAL ADC Callback ID enumeration definition 490 */ 491 typedef enum 492 { 493 HAL_ADC_CONVERSION_COMPLETE_CB_ID = 0x00U, /*!< ADC conversion complete callback ID */ 494 HAL_ADC_CONVERSION_HALF_CB_ID = 0x01U, /*!< ADC conversion DMA half-transfer callback ID */ 495 HAL_ADC_LEVEL_OUT_OF_WINDOW_1_CB_ID = 0x02U, /*!< ADC analog watchdog 1 callback ID */ 496 HAL_ADC_ERROR_CB_ID = 0x03U, /*!< ADC error callback ID */ 497 HAL_ADC_LEVEL_OUT_OF_WINDOW_2_CB_ID = 0x06U, /*!< ADC analog watchdog 2 callback ID */ 498 HAL_ADC_LEVEL_OUT_OF_WINDOW_3_CB_ID = 0x07U, /*!< ADC analog watchdog 3 callback ID */ 499 HAL_ADC_END_OF_SAMPLING_CB_ID = 0x08U, /*!< ADC end of sampling callback ID */ 500 HAL_ADC_MSPINIT_CB_ID = 0x09U, /*!< ADC Msp Init callback ID */ 501 HAL_ADC_MSPDEINIT_CB_ID = 0x0AU /*!< ADC Msp DeInit callback ID */ 502 } HAL_ADC_CallbackIDTypeDef; 503 504 /** 505 * @brief HAL ADC Callback pointer definition 506 */ 507 typedef void (*pADC_CallbackTypeDef)(ADC_HandleTypeDef *hadc); /*!< pointer to a ADC callback function */ 508 509 #endif /* USE_HAL_ADC_REGISTER_CALLBACKS */ 510 511 /** 512 * @} 513 */ 514 515 516 /* Exported constants --------------------------------------------------------*/ 517 518 /** @defgroup ADC_Exported_Constants ADC Exported Constants 519 * @{ 520 */ 521 522 /** @defgroup ADC_Error_Code ADC Error Code 523 * @{ 524 */ 525 #define HAL_ADC_ERROR_NONE (0x00U) /*!< No error */ 526 #define HAL_ADC_ERROR_INTERNAL (0x01U) /*!< ADC peripheral internal error (problem of clocking, 527 enable/disable, erroneous state, ...) */ 528 #define HAL_ADC_ERROR_OVR (0x02U) /*!< Overrun error */ 529 #define HAL_ADC_ERROR_DMA (0x04U) /*!< DMA transfer error */ 530 #if (USE_HAL_ADC_REGISTER_CALLBACKS == 1) 531 #define HAL_ADC_ERROR_INVALID_CALLBACK (0x10U) /*!< Invalid Callback error */ 532 #endif /* USE_HAL_ADC_REGISTER_CALLBACKS */ 533 /** 534 * @} 535 */ 536 537 /** @defgroup ADC_HAL_EC_COMMON_CLOCK_SOURCE ADC common - Clock source 538 * @{ 539 */ 540 #define ADC_CLOCK_SYNC_PCLK_DIV1 (LL_ADC_CLOCK_SYNC_PCLK_DIV1) /*!< ADC synchronous clock from AHB clock 541 without prescaler. This configuration must be enabled only if PCLK has a 50% duty clock cycle (APB prescaler 542 configured inside the RCC must be bypassed and the system clock must by 50% duty cycle) */ 543 #define ADC_CLOCK_SYNC_PCLK_DIV2 (LL_ADC_CLOCK_SYNC_PCLK_DIV2) /*!< ADC synchronous clock from AHB clock 544 with prescaler division by 2 */ 545 #define ADC_CLOCK_SYNC_PCLK_DIV4 (LL_ADC_CLOCK_SYNC_PCLK_DIV4) /*!< ADC synchronous clock from AHB clock 546 with prescaler division by 4 */ 547 548 #define ADC_CLOCK_ASYNC_DIV1 (LL_ADC_CLOCK_ASYNC_DIV1) /*!< ADC asynchronous clock without 549 prescaler */ 550 #define ADC_CLOCK_ASYNC_DIV2 (LL_ADC_CLOCK_ASYNC_DIV2) /*!< ADC asynchronous clock with prescaler 551 division by 2 */ 552 #define ADC_CLOCK_ASYNC_DIV4 (LL_ADC_CLOCK_ASYNC_DIV4) /*!< ADC asynchronous clock with prescaler 553 division by 4 */ 554 #define ADC_CLOCK_ASYNC_DIV6 (LL_ADC_CLOCK_ASYNC_DIV6) /*!< ADC asynchronous clock with prescaler 555 division by 6 */ 556 #define ADC_CLOCK_ASYNC_DIV8 (LL_ADC_CLOCK_ASYNC_DIV8) /*!< ADC asynchronous clock with prescaler 557 division by 8 */ 558 #define ADC_CLOCK_ASYNC_DIV10 (LL_ADC_CLOCK_ASYNC_DIV10) /*!< ADC asynchronous clock with prescaler 559 division by 10 */ 560 #define ADC_CLOCK_ASYNC_DIV12 (LL_ADC_CLOCK_ASYNC_DIV12) /*!< ADC asynchronous clock with prescaler 561 division by 12 */ 562 #define ADC_CLOCK_ASYNC_DIV16 (LL_ADC_CLOCK_ASYNC_DIV16) /*!< ADC asynchronous clock with prescaler 563 division by 16 */ 564 #define ADC_CLOCK_ASYNC_DIV32 (LL_ADC_CLOCK_ASYNC_DIV32) /*!< ADC asynchronous clock with prescaler 565 division by 32 */ 566 #define ADC_CLOCK_ASYNC_DIV64 (LL_ADC_CLOCK_ASYNC_DIV64) /*!< ADC asynchronous clock with prescaler 567 division by 64 */ 568 #define ADC_CLOCK_ASYNC_DIV128 (LL_ADC_CLOCK_ASYNC_DIV128) /*!< ADC asynchronous clock with prescaler 569 division by 128 */ 570 #define ADC_CLOCK_ASYNC_DIV256 (LL_ADC_CLOCK_ASYNC_DIV256) /*!< ADC asynchronous clock with prescaler 571 division by 256 */ 572 /** 573 * @} 574 */ 575 576 /** @defgroup ADC_HAL_EC_RESOLUTION ADC instance - Resolution 577 * @{ 578 */ 579 #define ADC_RESOLUTION_12B (LL_ADC_RESOLUTION_12B) /*!< ADC resolution 12 bits */ 580 #define ADC_RESOLUTION_10B (LL_ADC_RESOLUTION_10B) /*!< ADC resolution 10 bits */ 581 #define ADC_RESOLUTION_8B (LL_ADC_RESOLUTION_8B) /*!< ADC resolution 8 bits */ 582 #define ADC_RESOLUTION_6B (LL_ADC_RESOLUTION_6B) /*!< ADC resolution 6 bits */ 583 /** 584 * @} 585 */ 586 587 /** @defgroup ADC_HAL_EC_DATA_ALIGN ADC conversion data alignment 588 * @{ 589 */ 590 #define ADC_DATAALIGN_RIGHT (LL_ADC_DATA_ALIGN_RIGHT) /*!< ADC conversion data alignment: right aligned 591 (alignment on data register LSB bit 0)*/ 592 #define ADC_DATAALIGN_LEFT (LL_ADC_DATA_ALIGN_LEFT) /*!< ADC conversion data alignment: left aligned 593 (alignment on data register MSB bit 15)*/ 594 /** 595 * @} 596 */ 597 598 /** @defgroup ADC_Scan_mode ADC sequencer scan mode 599 * @{ 600 */ 601 /* Note: On this STM32 family, ADC group regular sequencer both modes */ 602 /* "fully configurable" or "not fully configurable" are */ 603 /* available. */ 604 /* Scan mode values must be compatible with other STM32 devices having */ 605 /* a configurable sequencer. */ 606 /* Scan direction setting values are defined by taking in account */ 607 /* already defined values for other STM32 devices: */ 608 /* ADC_SCAN_DISABLE (0x00000000UL) */ 609 /* ADC_SCAN_ENABLE (0x00000001UL) */ 610 /* Sequencer fully configurable with only rank 1 enabled is considered */ 611 /* as default setting equivalent to scan enable. */ 612 /* In case of migration from another STM32 device, the user will be */ 613 /* warned of change of setting choices with assert check. */ 614 /* Sequencer set to fully configurable */ 615 #define ADC_SCAN_DISABLE (0x00000000UL) /*!< Sequencer set to fully configurable: 616 only the rank 1 is enabled (no scan sequence on several ranks) */ 617 #define ADC_SCAN_ENABLE (ADC_CFGR1_CHSELRMOD) /*!< Sequencer set to fully configurable: 618 sequencer length and each rank affectation to a channel are configurable. */ 619 620 /* Sequencer set to not fully configurable */ 621 #define ADC_SCAN_SEQ_FIXED (ADC_SCAN_SEQ_FIXED_INT) /*!< Sequencer set to not fully configurable: 622 sequencer length and each rank affectation to a channel are fixed by channel HW number (channel 0 fixed on rank 0, 623 channel 1 fixed on rank1, ...). Scan direction forward: from channel 0 to channel 18 */ 624 #define ADC_SCAN_SEQ_FIXED_BACKWARD (ADC_SCAN_SEQ_FIXED_INT \ 625 | ADC_CFGR1_SCANDIR) /*!< Sequencer set to not fully configurable: 626 sequencer length and each rank affectation to a channel are fixed by channel HW number (channel 0 fixed on rank 0, 627 channel 1 fixed on rank1, ...). Scan direction backward: from channel 18 to channel 0 */ 628 629 #define ADC_SCAN_DIRECTION_FORWARD (ADC_SCAN_SEQ_FIXED) /* For compatibility with other STM32 series */ 630 #define ADC_SCAN_DIRECTION_BACKWARD (ADC_SCAN_SEQ_FIXED_BACKWARD) /* For compatibility with other STM32 series */ 631 /** 632 * @} 633 */ 634 635 /** @defgroup ADC_regular_external_trigger_source ADC group regular trigger source 636 * @{ 637 */ 638 /* ADC group regular trigger sources for all ADC instances */ 639 #define ADC_SOFTWARE_START (LL_ADC_REG_TRIG_SOFTWARE) /*!< Software start. */ 640 /** ADC group regular conversion trigger from external peripheral */ 641 #define ADC_EXTERNALTRIG_T1_TRGO2 (LL_ADC_REG_TRIG_EXT_TIM1_TRGO2) /*!< TIM1 TRGO. Trigger edge set to 642 rising edge (default setting). */ 643 #define ADC_EXTERNALTRIG_T1_CC4 (LL_ADC_REG_TRIG_EXT_TIM1_CH4) /*!< TIM1 channel 4 event (capture 644 compare: input capture or output 645 capture). Trigger edge set to 646 rising edge (default setting). */ 647 #define ADC_EXTERNALTRIG_T2_TRGO (LL_ADC_REG_TRIG_EXT_TIM2_TRGO) /*!< TIM2 TRGO. Trigger edge set to 648 rising edge (default setting). */ 649 #define ADC_EXTERNALTRIG_T2_CC4 (LL_ADC_REG_TRIG_EXT_TIM2_CH4) /*!< TIM2 channel 4 event (capture 650 compare: input capture or output 651 capture). Trigger edge set to 652 rising edge (default setting). */ 653 #define ADC_EXTERNALTRIG_T2_CC3 (LL_ADC_REG_TRIG_EXT_TIM2_CH3) /*!< TIM2 channel 3 event (capture 654 compare: input capture or output 655 capture). Trigger edge set to 656 rising edge (default setting). */ 657 #define ADC_EXTERNALTRIG_EXT_IT11 (LL_ADC_REG_TRIG_EXT_EXTI_LINE11) /*!< External interrupt line 11. Trigger 658 edge set to rising edge (default 659 setting). */ 660 /** 661 * @} 662 */ 663 664 /** @defgroup ADC_regular_external_trigger_edge ADC group regular trigger edge (when external trigger is selected) 665 * @{ 666 */ 667 #define ADC_EXTERNALTRIGCONVEDGE_NONE (0x00000000UL) /*!< ADC group regular trigger 668 detection disabled (SW start)*/ 669 #define ADC_EXTERNALTRIGCONVEDGE_RISING (LL_ADC_REG_TRIG_EXT_RISING) /*!< ADC group regular trigger 670 polarity set to rising edge */ 671 #define ADC_EXTERNALTRIGCONVEDGE_FALLING (LL_ADC_REG_TRIG_EXT_FALLING) /*!< ADC group regular trigger 672 polarity set to falling edge */ 673 #define ADC_EXTERNALTRIGCONVEDGE_RISINGFALLING (LL_ADC_REG_TRIG_EXT_RISINGFALLING) /*!< ADC group regular trigger 674 polarity set to both rising and 675 falling edges */ 676 /** 677 * @} 678 */ 679 680 /** @defgroup ADC_EOCSelection ADC sequencer end of unitary conversion or sequence conversions 681 * @{ 682 */ 683 #define ADC_EOC_SINGLE_CONV (ADC_ISR_EOC) /*!< End of unitary conversion flag */ 684 #define ADC_EOC_SEQ_CONV (ADC_ISR_EOS) /*!< End of sequence conversions flag */ 685 /** 686 * @} 687 */ 688 689 /** @defgroup ADC_HAL_EC_REG_OVR_DATA_BEHAVIOR ADC group regular - Overrun behavior on conversion data 690 * @{ 691 */ 692 /** 693 * @brief ADC group regular behavior in case of overrun 694 */ 695 #define ADC_OVR_DATA_PRESERVED (LL_ADC_REG_OVR_DATA_PRESERVED) /*!< ADC group regular behavior in case of 696 overrun: data preserved */ 697 #define ADC_OVR_DATA_OVERWRITTEN (LL_ADC_REG_OVR_DATA_OVERWRITTEN) /*!< ADC group regular behavior in case of 698 overrun: data overwritten */ 699 /** 700 * @} 701 */ 702 703 /** @defgroup ADC_HAL_EC_REG_SEQ_RANKS ADC group regular - Sequencer ranks 704 * @{ 705 */ 706 #define ADC_RANK_CHANNEL_NUMBER (0x00000001U) /*!< Enable the rank of the selected channels. Number of ranks in 707 the sequence is defined by number of channels enabled, rank 708 of each channel is defined by channel number (channel 0 fixed 709 on rank 0, channel 1 fixed on rank1, ...). 710 Setting relevant if parameter "ScanConvMode" is set to 711 sequencer not fully configurable. */ 712 #define ADC_RANK_NONE (0x00000002U) /*!< Disable the selected rank (selected channel) from sequencer. 713 Setting relevant if parameter "ScanConvMode" is set to 714 sequencer not fully configurable. */ 715 716 #define ADC_REGULAR_RANK_1 (LL_ADC_REG_RANK_1) /*!< ADC group regular sequencer rank 1 */ 717 #define ADC_REGULAR_RANK_2 (LL_ADC_REG_RANK_2) /*!< ADC group regular sequencer rank 2 */ 718 #define ADC_REGULAR_RANK_3 (LL_ADC_REG_RANK_3) /*!< ADC group regular sequencer rank 3 */ 719 #define ADC_REGULAR_RANK_4 (LL_ADC_REG_RANK_4) /*!< ADC group regular sequencer rank 4 */ 720 #define ADC_REGULAR_RANK_5 (LL_ADC_REG_RANK_5) /*!< ADC group regular sequencer rank 5 */ 721 #define ADC_REGULAR_RANK_6 (LL_ADC_REG_RANK_6) /*!< ADC group regular sequencer rank 6 */ 722 #define ADC_REGULAR_RANK_7 (LL_ADC_REG_RANK_7) /*!< ADC group regular sequencer rank 7 */ 723 #define ADC_REGULAR_RANK_8 (LL_ADC_REG_RANK_8) /*!< ADC group regular sequencer rank 8 */ 724 /** 725 * @} 726 */ 727 728 /** @defgroup ADC_HAL_EC_SAMPLINGTIME_COMMON ADC instance - Sampling time common to a group of channels 729 * @{ 730 */ 731 #define ADC_SAMPLINGTIME_COMMON_1 (LL_ADC_SAMPLINGTIME_COMMON_1) /*!< Set sampling time common to a group of 732 channels: sampling time nb 1 */ 733 #define ADC_SAMPLINGTIME_COMMON_2 (LL_ADC_SAMPLINGTIME_COMMON_2) /*!< Set sampling time common to a group of 734 channels: sampling time nb 2 */ 735 /** 736 * @} 737 */ 738 739 /** @defgroup ADC_HAL_EC_CHANNEL_SAMPLINGTIME Channel - Sampling time 740 * @{ 741 */ 742 #define ADC_SAMPLETIME_1CYCLE_5 (LL_ADC_SAMPLINGTIME_1CYCLE_5) /*!< Sampling time 1.5 ADC clock cycle */ 743 #define ADC_SAMPLETIME_3CYCLES_5 (LL_ADC_SAMPLINGTIME_3CYCLES_5) /*!< Sampling time 3.5 ADC clock cycles */ 744 #define ADC_SAMPLETIME_7CYCLES_5 (LL_ADC_SAMPLINGTIME_7CYCLES_5) /*!< Sampling time 7.5 ADC clock cycles */ 745 #define ADC_SAMPLETIME_12CYCLES_5 (LL_ADC_SAMPLINGTIME_12CYCLES_5) /*!< Sampling time 12.5 ADC clock cycles */ 746 #define ADC_SAMPLETIME_19CYCLES_5 (LL_ADC_SAMPLINGTIME_19CYCLES_5) /*!< Sampling time 19.5 ADC clock cycles */ 747 #define ADC_SAMPLETIME_39CYCLES_5 (LL_ADC_SAMPLINGTIME_39CYCLES_5) /*!< Sampling time 39.5 ADC clock cycles */ 748 #define ADC_SAMPLETIME_79CYCLES_5 (LL_ADC_SAMPLINGTIME_79CYCLES_5) /*!< Sampling time 79.5 ADC clock cycles */ 749 #define ADC_SAMPLETIME_160CYCLES_5 (LL_ADC_SAMPLINGTIME_160CYCLES_5) /*!< Sampling time 160.5 ADC clock cycles */ 750 /** 751 * @} 752 */ 753 754 /** @defgroup ADC_HAL_EC_CHANNEL ADC instance - Channel number 755 * @{ 756 */ 757 #define ADC_CHANNEL_0 (LL_ADC_CHANNEL_0) /*!< External channel (GPIO pin) ADCx_IN0 */ 758 #define ADC_CHANNEL_1 (LL_ADC_CHANNEL_1) /*!< External channel (GPIO pin) ADCx_IN1 */ 759 #define ADC_CHANNEL_2 (LL_ADC_CHANNEL_2) /*!< External channel (GPIO pin) ADCx_IN2 */ 760 #define ADC_CHANNEL_3 (LL_ADC_CHANNEL_3) /*!< External channel (GPIO pin) ADCx_IN3 */ 761 #define ADC_CHANNEL_4 (LL_ADC_CHANNEL_4) /*!< External channel (GPIO pin) ADCx_IN4 */ 762 #define ADC_CHANNEL_5 (LL_ADC_CHANNEL_5) /*!< External channel (GPIO pin) ADCx_IN5 */ 763 #define ADC_CHANNEL_6 (LL_ADC_CHANNEL_6) /*!< External channel (GPIO pin) ADCx_IN6 */ 764 #define ADC_CHANNEL_7 (LL_ADC_CHANNEL_7) /*!< External channel (GPIO pin) ADCx_IN7 */ 765 #define ADC_CHANNEL_8 (LL_ADC_CHANNEL_8) /*!< External channel (GPIO pin) ADCx_IN8 */ 766 #define ADC_CHANNEL_9 (LL_ADC_CHANNEL_9) /*!< External channel (GPIO pin) ADCx_IN9 */ 767 #define ADC_CHANNEL_10 (LL_ADC_CHANNEL_10) /*!< External channel (GPIO pin) ADCx_IN10 */ 768 #define ADC_CHANNEL_11 (LL_ADC_CHANNEL_11) /*!< External channel (GPIO pin) ADCx_IN11 */ 769 #define ADC_CHANNEL_12 (LL_ADC_CHANNEL_12) /*!< External channel (GPIO pin) ADCx_IN12 */ 770 #define ADC_CHANNEL_13 (LL_ADC_CHANNEL_13) /*!< External channel (GPIO pin) ADCx_IN13 */ 771 #define ADC_CHANNEL_14 (LL_ADC_CHANNEL_14) /*!< External channel (GPIO pin) ADCx_IN14 */ 772 #define ADC_CHANNEL_15 (LL_ADC_CHANNEL_15) /*!< External channel (GPIO pin) ADCx_IN15 */ 773 #define ADC_CHANNEL_16 (LL_ADC_CHANNEL_16) /*!< External channel (GPIO pin) ADCx_IN16 */ 774 #define ADC_CHANNEL_17 (LL_ADC_CHANNEL_17) /*!< External channel (GPIO pin) ADCx_IN17 */ 775 #define ADC_CHANNEL_VREFINT (LL_ADC_CHANNEL_VREFINT) /*!< Internal channel Internal voltage reference*/ 776 #define ADC_CHANNEL_TEMPSENSOR (LL_ADC_CHANNEL_TEMPSENSOR) /*!< Internal channel Temperature sensor */ 777 #define ADC_CHANNEL_VBAT (LL_ADC_CHANNEL_VBAT) /*!< Internal channel Vbat/3: 778 Vbat voltage through a divider ladder of 779 factor 1/3 to have Vbat always below Vdda. */ 780 #define ADC_CHANNEL_DACCH1 (LL_ADC_CHANNEL_DACCH1) /*!< Internal channel DAC channel 1. */ 781 /** 782 * @} 783 */ 784 785 /** @defgroup ADC_HAL_EC_AWD_NUMBER Analog watchdog - Analog watchdog number 786 * @{ 787 */ 788 #define ADC_ANALOGWATCHDOG_1 (LL_ADC_AWD1) /*!< ADC analog watchdog number 1 */ 789 #define ADC_ANALOGWATCHDOG_2 (LL_ADC_AWD2) /*!< ADC analog watchdog number 2 */ 790 #define ADC_ANALOGWATCHDOG_3 (LL_ADC_AWD3) /*!< ADC analog watchdog number 3 */ 791 /** 792 * @} 793 */ 794 795 /** @defgroup ADC_analog_watchdog_mode ADC Analog Watchdog Mode 796 * @{ 797 */ 798 #define ADC_ANALOGWATCHDOG_NONE (0x00000000UL) /*!< No analog watchdog selected */ 799 #define ADC_ANALOGWATCHDOG_SINGLE_REG (ADC_CFGR1_AWD1SGL | ADC_CFGR1_AWD1EN) /*!< Analog watchdog applied to a 800 regular group, single channel */ 801 #define ADC_ANALOGWATCHDOG_ALL_REG (ADC_CFGR1_AWD1EN) /*!< Analog watchdog applied to 802 regular group, all channels */ 803 /** 804 * @} 805 */ 806 807 /** @defgroup ADC_HAL_EC_OVS_RATIO Oversampling - Ratio 808 * @{ 809 */ 810 /** 811 * @note The oversampling ratio is the number of ADC conversions performed, sum of these conversions data is computed 812 * to result as the ADC oversampling conversion data (before potential shift) 813 */ 814 #define ADC_OVERSAMPLING_RATIO_2 (LL_ADC_OVS_RATIO_2) /*!< ADC oversampling ratio 2 */ 815 #define ADC_OVERSAMPLING_RATIO_4 (LL_ADC_OVS_RATIO_4) /*!< ADC oversampling ratio 4 */ 816 #define ADC_OVERSAMPLING_RATIO_8 (LL_ADC_OVS_RATIO_8) /*!< ADC oversampling ratio 8 */ 817 #define ADC_OVERSAMPLING_RATIO_16 (LL_ADC_OVS_RATIO_16) /*!< ADC oversampling ratio 16 */ 818 #define ADC_OVERSAMPLING_RATIO_32 (LL_ADC_OVS_RATIO_32) /*!< ADC oversampling ratio 32 */ 819 #define ADC_OVERSAMPLING_RATIO_64 (LL_ADC_OVS_RATIO_64) /*!< ADC oversampling ratio 64 */ 820 #define ADC_OVERSAMPLING_RATIO_128 (LL_ADC_OVS_RATIO_128) /*!< ADC oversampling ratio 128 */ 821 #define ADC_OVERSAMPLING_RATIO_256 (LL_ADC_OVS_RATIO_256) /*!< ADC oversampling ratio 256 */ 822 /** 823 * @} 824 */ 825 826 /** @defgroup ADC_HAL_EC_OVS_SHIFT Oversampling - Data shift 827 * @{ 828 */ 829 /** 830 * @note The sum of the ADC conversions data is divided by "Rightbitshift" number to result as the ADC oversampling 831 * conversion data) 832 */ 833 #define ADC_RIGHTBITSHIFT_NONE (LL_ADC_OVS_SHIFT_NONE) /*!< ADC oversampling no shift */ 834 #define ADC_RIGHTBITSHIFT_1 (LL_ADC_OVS_SHIFT_RIGHT_1) /*!< ADC oversampling right shift of 1 ranks */ 835 #define ADC_RIGHTBITSHIFT_2 (LL_ADC_OVS_SHIFT_RIGHT_2) /*!< ADC oversampling right shift of 2 ranks */ 836 #define ADC_RIGHTBITSHIFT_3 (LL_ADC_OVS_SHIFT_RIGHT_3) /*!< ADC oversampling right shift of 3 ranks */ 837 #define ADC_RIGHTBITSHIFT_4 (LL_ADC_OVS_SHIFT_RIGHT_4) /*!< ADC oversampling right shift of 4 ranks */ 838 #define ADC_RIGHTBITSHIFT_5 (LL_ADC_OVS_SHIFT_RIGHT_5) /*!< ADC oversampling right shift of 5 ranks */ 839 #define ADC_RIGHTBITSHIFT_6 (LL_ADC_OVS_SHIFT_RIGHT_6) /*!< ADC oversampling right shift of 6 ranks */ 840 #define ADC_RIGHTBITSHIFT_7 (LL_ADC_OVS_SHIFT_RIGHT_7) /*!< ADC oversampling right shift of 7 ranks */ 841 #define ADC_RIGHTBITSHIFT_8 (LL_ADC_OVS_SHIFT_RIGHT_8) /*!< ADC oversampling right shift of 8 ranks */ 842 /** 843 * @} 844 */ 845 846 /** @defgroup ADC_HAL_EC_OVS_DISCONT_MODE Oversampling - Discontinuous mode 847 * @{ 848 */ 849 #define ADC_TRIGGEREDMODE_SINGLE_TRIGGER (LL_ADC_OVS_REG_CONT) /*!< ADC oversampling discontinuous mode: 850 continuous mode (all conversions of 851 OVS ratio are done from 1 trigger) */ 852 #define ADC_TRIGGEREDMODE_MULTI_TRIGGER (LL_ADC_OVS_REG_DISCONT) /*!< ADC oversampling discontinuous mode: 853 discontinuous mode (each conversion of 854 OVS ratio needs a trigger) */ 855 /** 856 * @} 857 */ 858 859 /** @defgroup ADC_HAL_EC_REG_TRIGGER_FREQ ADC group regular - Trigger frequency mode 860 * @{ 861 */ 862 863 /** 864 * @note ADC trigger frequency mode must be set to low frequency when a duration is exceeded before ADC conversion 865 * start trigger event (between ADC enable and ADC conversion start trigger event or between two ADC conversion 866 * start trigger event). 867 * Duration value: Refer to device datasheet, parameter "tIdle". 868 */ 869 #define ADC_TRIGGER_FREQ_HIGH (LL_ADC_TRIGGER_FREQ_HIGH) /*!< Trigger frequency mode set to high frequency. */ 870 #define ADC_TRIGGER_FREQ_LOW (LL_ADC_TRIGGER_FREQ_LOW) /*!< Trigger frequency mode set to low frequency. */ 871 /** 872 * @} 873 */ 874 875 /** @defgroup ADC_Event_type ADC Event type 876 * @{ 877 */ 878 /** 879 * @note Analog watchdog 1 is available on all stm32 series 880 * Analog watchdog 2 and 3 are not available on all series 881 */ 882 #define ADC_EOSMP_EVENT (ADC_FLAG_EOSMP) /*!< ADC End of Sampling event */ 883 #define ADC_AWD1_EVENT (ADC_FLAG_AWD1) /*!< ADC Analog watchdog 1 event (main analog watchdog) */ 884 #define ADC_AWD2_EVENT (ADC_FLAG_AWD2) /*!< ADC Analog watchdog 2 event (additional analog watchdog) */ 885 #define ADC_AWD3_EVENT (ADC_FLAG_AWD3) /*!< ADC Analog watchdog 3 event (additional analog watchdog) */ 886 #define ADC_OVR_EVENT (ADC_FLAG_OVR) /*!< ADC overrun event */ 887 /** 888 * @} 889 */ 890 #define ADC_AWD_EVENT ADC_AWD1_EVENT /*!< ADC Analog watchdog 1 event: Naming for compatibility 891 with other STM32 devices having only one analog watchdog */ 892 893 /** @defgroup ADC_interrupts_definition ADC interrupts definition 894 * @{ 895 */ 896 #define ADC_IT_RDY ADC_IER_ADRDYIE /*!< ADC Ready interrupt source */ 897 #define ADC_IT_CCRDY ADC_IER_CCRDYIE /*!< ADC channel configuration ready interrupt source */ 898 #define ADC_IT_EOSMP ADC_IER_EOSMPIE /*!< End of sampling interrupt source */ 899 #define ADC_IT_EOC ADC_IER_EOCIE /*!< End of regular conversion interrupt source */ 900 #define ADC_IT_EOS ADC_IER_EOSIE /*!< End of regular sequence of conversions interrupt source */ 901 #define ADC_IT_OVR ADC_IER_OVRIE /*!< overrun interrupt source */ 902 #define ADC_IT_AWD1 ADC_IER_AWD1IE /*!< Analog watchdog 1 interrupt source (main analog watchdog) */ 903 #define ADC_IT_AWD2 ADC_IER_AWD2IE /*!< Analog watchdog 2 interrupt source (additional analog watchdog) */ 904 #define ADC_IT_AWD3 ADC_IER_AWD3IE /*!< Analog watchdog 3 interrupt source (additional analog watchdog) */ 905 /** 906 * @} 907 */ 908 909 /** @defgroup ADC_flags_definition ADC flags definition 910 * @{ 911 */ 912 #define ADC_FLAG_RDY ADC_ISR_ADRDY /*!< ADC Ready flag */ 913 #define ADC_FLAG_CCRDY ADC_ISR_CCRDY /*!< ADC channel configuration ready flag */ 914 #define ADC_FLAG_EOSMP ADC_ISR_EOSMP /*!< ADC End of Sampling flag */ 915 #define ADC_FLAG_EOC ADC_ISR_EOC /*!< ADC End of Regular Conversion flag */ 916 #define ADC_FLAG_EOS ADC_ISR_EOS /*!< ADC End of Regular sequence of Conversions flag */ 917 #define ADC_FLAG_OVR ADC_ISR_OVR /*!< ADC overrun flag */ 918 #define ADC_FLAG_AWD1 ADC_ISR_AWD1 /*!< ADC Analog watchdog 1 flag */ 919 #define ADC_FLAG_AWD2 ADC_ISR_AWD2 /*!< ADC Analog watchdog 2 flag */ 920 #define ADC_FLAG_AWD3 ADC_ISR_AWD3 /*!< ADC Analog watchdog 3 flag */ 921 /** 922 * @} 923 */ 924 925 /** 926 * @} 927 */ 928 929 /* Private macro -------------------------------------------------------------*/ 930 931 /** @defgroup ADC_Private_Macros ADC Private Macros 932 * @{ 933 */ 934 /* Macro reserved for internal HAL driver usage, not intended to be used in */ 935 /* code of final user. */ 936 937 /** 938 * @brief Test if conversion trigger of regular group is software start 939 * or external trigger. 940 * @param __HANDLE__ ADC handle 941 * @retval SET (software start) or RESET (external trigger) 942 */ 943 #define ADC_IS_SOFTWARE_START_REGULAR(__HANDLE__) \ 944 (((__HANDLE__)->Instance->CFGR1 & ADC_CFGR1_EXTEN) == 0UL) 945 946 /** 947 * @brief Return resolution bits in CFGR1 register RES[1:0] field. 948 * @param __HANDLE__ ADC handle 949 * @retval Value of bitfield RES in CFGR1 register. 950 */ 951 #define ADC_GET_RESOLUTION(__HANDLE__) \ 952 (LL_ADC_GetResolution((__HANDLE__)->Instance)) 953 954 /** 955 * @brief Clear ADC error code (set it to no error code "HAL_ADC_ERROR_NONE"). 956 * @param __HANDLE__ ADC handle 957 * @retval None 958 */ 959 #define ADC_CLEAR_ERRORCODE(__HANDLE__) ((__HANDLE__)->ErrorCode = HAL_ADC_ERROR_NONE) 960 961 /** 962 * @brief Simultaneously clear and set specific bits of the handle State. 963 * @note ADC_STATE_CLR_SET() macro is merely aliased to generic macro MODIFY_REG(), 964 * the first parameter is the ADC handle State, the second parameter is the 965 * bit field to clear, the third and last parameter is the bit field to set. 966 * @retval None 967 */ 968 #define ADC_STATE_CLR_SET MODIFY_REG 969 970 /** 971 * @brief Enable ADC discontinuous conversion mode for regular group 972 * @param _REG_DISCONTINUOUS_MODE_: Regular discontinuous mode. 973 * @retval None 974 */ 975 #define ADC_CFGR1_REG_DISCCONTINUOUS(_REG_DISCONTINUOUS_MODE_) \ 976 ((_REG_DISCONTINUOUS_MODE_) << 16U) 977 978 /** 979 * @brief Enable the ADC auto off mode. 980 * @param _AUTOOFF_ Auto off bit enable or disable. 981 * @retval None 982 */ 983 #define ADC_CFGR1_AUTOOFF(_AUTOOFF_) \ 984 ((_AUTOOFF_) << 15U) 985 986 /** 987 * @brief Enable the ADC auto delay mode. 988 * @param _AUTOWAIT_ Auto delay bit enable or disable. 989 * @retval None 990 */ 991 #define ADC_CFGR1_AUTOWAIT(_AUTOWAIT_) \ 992 ((_AUTOWAIT_) << 14U) 993 994 /** 995 * @brief Enable ADC continuous conversion mode. 996 * @param _CONTINUOUS_MODE_ Continuous mode. 997 * @retval None 998 */ 999 #define ADC_CFGR1_CONTINUOUS(_CONTINUOUS_MODE_) \ 1000 ((_CONTINUOUS_MODE_) << 13U) 1001 1002 /** 1003 * @brief Enable ADC overrun mode. 1004 * @param _OVERRUN_MODE_ Overrun mode. 1005 * @retval Overrun bit setting to be programmed into CFGR register 1006 */ 1007 /* Note: Bit ADC_CFGR1_OVRMOD not used directly in constant */ 1008 /* "ADC_OVR_DATA_OVERWRITTEN" to have this case defined to 0x00, to set it */ 1009 /* as the default case to be compliant with other STM32 devices. */ 1010 #define ADC_CFGR1_OVERRUN(_OVERRUN_MODE_) \ 1011 ( ( (_OVERRUN_MODE_) != (ADC_OVR_DATA_PRESERVED) \ 1012 )? (ADC_CFGR1_OVRMOD) : (0x00000000UL) \ 1013 ) 1014 1015 /** 1016 * @brief Set ADC scan mode with differentiation of sequencer setting 1017 * fixed or configurable 1018 * @param _SCAN_MODE_ Scan conversion mode. 1019 * @retval None 1020 */ 1021 /* Note: Scan mode set using this macro (instead of parameter direct set) */ 1022 /* due to different modes on other STM32 devices: */ 1023 /* if scan mode is disabled, sequencer is set to fully configurable */ 1024 /* with setting of only rank 1 enabled afterwards. */ 1025 #define ADC_SCAN_SEQ_MODE(_SCAN_MODE_) \ 1026 ( (((_SCAN_MODE_) & ADC_SCAN_SEQ_FIXED_INT) != 0UL \ 1027 )? \ 1028 ((_SCAN_MODE_) & (~ADC_SCAN_SEQ_FIXED_INT)) \ 1029 : \ 1030 (ADC_CFGR1_CHSELRMOD) \ 1031 ) 1032 1033 /** 1034 * @brief Enable the ADC DMA continuous request. 1035 * @param _DMACONTREQ_MODE_: DMA continuous request mode. 1036 * @retval None 1037 */ 1038 #define ADC_CFGR1_DMACONTREQ(_DMACONTREQ_MODE_) \ 1039 ((_DMACONTREQ_MODE_) << 1U) 1040 1041 /** 1042 * @brief Shift the AWD threshold in function of the selected ADC resolution. 1043 * Thresholds have to be left-aligned on bit 11, the LSB (right bits) are set to 0. 1044 * If resolution 12 bits, no shift. 1045 * If resolution 10 bits, shift of 2 ranks on the left. 1046 * If resolution 8 bits, shift of 4 ranks on the left. 1047 * If resolution 6 bits, shift of 6 ranks on the left. 1048 * therefore, shift = (12 - resolution) = 12 - (12- (((RES[1:0]) >> 3)*2)) 1049 * @param __HANDLE__ ADC handle 1050 * @param _Threshold_ Value to be shifted 1051 * @retval None 1052 */ 1053 #define ADC_AWD1THRESHOLD_SHIFT_RESOLUTION(__HANDLE__, _Threshold_) \ 1054 ((_Threshold_) << ((((__HANDLE__)->Instance->CFGR1 & ADC_CFGR1_RES) >> 3U)*2U)) 1055 1056 #define IS_ADC_CLOCKPRESCALER(ADC_CLOCK) (((ADC_CLOCK) == ADC_CLOCK_SYNC_PCLK_DIV1) ||\ 1057 ((ADC_CLOCK) == ADC_CLOCK_SYNC_PCLK_DIV2) ||\ 1058 ((ADC_CLOCK) == ADC_CLOCK_SYNC_PCLK_DIV4) ||\ 1059 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV1 ) ||\ 1060 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV2 ) ||\ 1061 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV4 ) ||\ 1062 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV6 ) ||\ 1063 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV8 ) ||\ 1064 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV10 ) ||\ 1065 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV12 ) ||\ 1066 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV16 ) ||\ 1067 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV32 ) ||\ 1068 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV64 ) ||\ 1069 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV128 ) ||\ 1070 ((ADC_CLOCK) == ADC_CLOCK_ASYNC_DIV256)) 1071 1072 #define IS_ADC_RESOLUTION(RESOLUTION) (((RESOLUTION) == ADC_RESOLUTION_12B) || \ 1073 ((RESOLUTION) == ADC_RESOLUTION_10B) || \ 1074 ((RESOLUTION) == ADC_RESOLUTION_8B) || \ 1075 ((RESOLUTION) == ADC_RESOLUTION_6B) ) 1076 1077 #define IS_ADC_DATA_ALIGN(ALIGN) (((ALIGN) == ADC_DATAALIGN_RIGHT) || \ 1078 ((ALIGN) == ADC_DATAALIGN_LEFT) ) 1079 1080 #define IS_ADC_SCAN_MODE(SCAN_MODE) (((SCAN_MODE) == ADC_SCAN_DISABLE) || \ 1081 ((SCAN_MODE) == ADC_SCAN_ENABLE) || \ 1082 ((SCAN_MODE) == ADC_SCAN_SEQ_FIXED) || \ 1083 ((SCAN_MODE) == ADC_SCAN_SEQ_FIXED_BACKWARD) ) 1084 1085 #define IS_ADC_EXTTRIG_EDGE(EDGE) (((EDGE) == ADC_EXTERNALTRIGCONVEDGE_NONE) || \ 1086 ((EDGE) == ADC_EXTERNALTRIGCONVEDGE_RISING) || \ 1087 ((EDGE) == ADC_EXTERNALTRIGCONVEDGE_FALLING) || \ 1088 ((EDGE) == ADC_EXTERNALTRIGCONVEDGE_RISINGFALLING) ) 1089 1090 #define IS_ADC_EXTTRIG(REGTRIG) (((REGTRIG) == ADC_EXTERNALTRIG_T1_TRGO2) || \ 1091 ((REGTRIG) == ADC_EXTERNALTRIG_T1_CC4) || \ 1092 ((REGTRIG) == ADC_EXTERNALTRIG_T2_TRGO) || \ 1093 ((REGTRIG) == ADC_EXTERNALTRIG_T2_CC4) || \ 1094 ((REGTRIG) == ADC_EXTERNALTRIG_T2_CC3) || \ 1095 ((REGTRIG) == ADC_EXTERNALTRIG_EXT_IT11) || \ 1096 ((REGTRIG) == ADC_SOFTWARE_START) ) 1097 1098 #define IS_ADC_EOC_SELECTION(EOC_SELECTION) (((EOC_SELECTION) == ADC_EOC_SINGLE_CONV) || \ 1099 ((EOC_SELECTION) == ADC_EOC_SEQ_CONV)) 1100 1101 #define IS_ADC_OVERRUN(OVR) (((OVR) == ADC_OVR_DATA_PRESERVED) || \ 1102 ((OVR) == ADC_OVR_DATA_OVERWRITTEN) ) 1103 1104 #define IS_ADC_REGULAR_RANK_SEQ_FIXED(RANK) (((RANK) == ADC_RANK_CHANNEL_NUMBER) || \ 1105 ((RANK) == ADC_RANK_NONE) ) 1106 1107 #define IS_ADC_REGULAR_RANK(RANK) (((RANK) == ADC_REGULAR_RANK_1 ) || \ 1108 ((RANK) == ADC_REGULAR_RANK_2 ) || \ 1109 ((RANK) == ADC_REGULAR_RANK_3 ) || \ 1110 ((RANK) == ADC_REGULAR_RANK_4 ) || \ 1111 ((RANK) == ADC_REGULAR_RANK_5 ) || \ 1112 ((RANK) == ADC_REGULAR_RANK_6 ) || \ 1113 ((RANK) == ADC_REGULAR_RANK_7 ) || \ 1114 ((RANK) == ADC_REGULAR_RANK_8 ) ) 1115 1116 #define IS_ADC_CHANNEL(CHANNEL) (((CHANNEL) == ADC_CHANNEL_0) || \ 1117 ((CHANNEL) == ADC_CHANNEL_1) || \ 1118 ((CHANNEL) == ADC_CHANNEL_2) || \ 1119 ((CHANNEL) == ADC_CHANNEL_3) || \ 1120 ((CHANNEL) == ADC_CHANNEL_4) || \ 1121 ((CHANNEL) == ADC_CHANNEL_5) || \ 1122 ((CHANNEL) == ADC_CHANNEL_6) || \ 1123 ((CHANNEL) == ADC_CHANNEL_7) || \ 1124 ((CHANNEL) == ADC_CHANNEL_8) || \ 1125 ((CHANNEL) == ADC_CHANNEL_9) || \ 1126 ((CHANNEL) == ADC_CHANNEL_10) || \ 1127 ((CHANNEL) == ADC_CHANNEL_11) || \ 1128 ((CHANNEL) == ADC_CHANNEL_12) || \ 1129 ((CHANNEL) == ADC_CHANNEL_13) || \ 1130 ((CHANNEL) == ADC_CHANNEL_14) || \ 1131 ((CHANNEL) == ADC_CHANNEL_15) || \ 1132 ((CHANNEL) == ADC_CHANNEL_16) || \ 1133 ((CHANNEL) == ADC_CHANNEL_17) || \ 1134 ((CHANNEL) == ADC_CHANNEL_TEMPSENSOR) || \ 1135 ((CHANNEL) == ADC_CHANNEL_VREFINT) || \ 1136 ((CHANNEL) == ADC_CHANNEL_VBAT) || \ 1137 ((CHANNEL) == ADC_CHANNEL_DACCH1) ) 1138 1139 #define IS_ADC_SAMPLING_TIME_COMMON(SAMPLING_TIME_COMMON) (((SAMPLING_TIME_COMMON) == ADC_SAMPLINGTIME_COMMON_1) || \ 1140 ((SAMPLING_TIME_COMMON) == ADC_SAMPLINGTIME_COMMON_2) ) 1141 1142 #define IS_ADC_SAMPLE_TIME(TIME) (((TIME) == ADC_SAMPLETIME_1CYCLE_5) || \ 1143 ((TIME) == ADC_SAMPLETIME_3CYCLES_5) || \ 1144 ((TIME) == ADC_SAMPLETIME_7CYCLES_5) || \ 1145 ((TIME) == ADC_SAMPLETIME_12CYCLES_5) || \ 1146 ((TIME) == ADC_SAMPLETIME_19CYCLES_5) || \ 1147 ((TIME) == ADC_SAMPLETIME_39CYCLES_5) || \ 1148 ((TIME) == ADC_SAMPLETIME_79CYCLES_5) || \ 1149 ((TIME) == ADC_SAMPLETIME_160CYCLES_5) ) 1150 1151 #define IS_ADC_ANALOG_WATCHDOG_NUMBER(WATCHDOG) (((WATCHDOG) == ADC_ANALOGWATCHDOG_1) || \ 1152 ((WATCHDOG) == ADC_ANALOGWATCHDOG_2) || \ 1153 ((WATCHDOG) == ADC_ANALOGWATCHDOG_3) ) 1154 1155 #define IS_ADC_ANALOG_WATCHDOG_MODE(WATCHDOG) (((WATCHDOG) == ADC_ANALOGWATCHDOG_NONE) || \ 1156 ((WATCHDOG) == ADC_ANALOGWATCHDOG_SINGLE_REG) || \ 1157 ((WATCHDOG) == ADC_ANALOGWATCHDOG_ALL_REG) ) 1158 1159 #define IS_ADC_TRIGGER_FREQ(TRIGGER_FREQ) (((TRIGGER_FREQ) == LL_ADC_TRIGGER_FREQ_HIGH) || \ 1160 ((TRIGGER_FREQ) == LL_ADC_TRIGGER_FREQ_LOW) ) 1161 1162 #define IS_ADC_EVENT_TYPE(EVENT) (((EVENT) == ADC_EOSMP_EVENT) || \ 1163 ((EVENT) == ADC_AWD1_EVENT) || \ 1164 ((EVENT) == ADC_AWD2_EVENT) || \ 1165 ((EVENT) == ADC_AWD3_EVENT) || \ 1166 ((EVENT) == ADC_OVR_EVENT) ) 1167 1168 /** 1169 * @brief Verify that a given value is aligned with the ADC resolution range. 1170 * @param __RESOLUTION__ ADC resolution (12, 10, 8 or 6 bits). 1171 * @param __ADC_VALUE__ value checked against the resolution. 1172 * @retval SET (__ADC_VALUE__ in line with __RESOLUTION__) or RESET (__ADC_VALUE__ not in line with __RESOLUTION__) 1173 */ 1174 #define IS_ADC_RANGE(__RESOLUTION__, __ADC_VALUE__) \ 1175 ((__ADC_VALUE__) <= __LL_ADC_DIGITAL_SCALE(__RESOLUTION__)) 1176 1177 /** @defgroup ADC_regular_nb_conv_verification ADC Regular Conversion Number Verification 1178 * @{ 1179 */ 1180 #define IS_ADC_REGULAR_NB_CONV(LENGTH) (((LENGTH) >= 1UL) && ((LENGTH) <= 8UL)) 1181 /** 1182 * @} 1183 */ 1184 1185 1186 /* Private constants ---------------------------------------------------------*/ 1187 1188 /** @defgroup ADC_Private_Constants ADC Private Constants 1189 * @{ 1190 */ 1191 1192 /* Combination of all post-conversion flags bits: EOC/EOS, OVR, AWD */ 1193 #define ADC_FLAG_POSTCONV_ALL (ADC_FLAG_AWD | ADC_FLAG_OVR | ADC_FLAG_EOS | ADC_FLAG_EOC) 1194 1195 /* Internal definition to differentiate sequencer setting fixed or configurable */ 1196 #define ADC_SCAN_SEQ_FIXED_INT 0x80000000U 1197 1198 /** 1199 * @} 1200 */ 1201 1202 /* Exported macro ------------------------------------------------------------*/ 1203 1204 /** @defgroup ADC_Exported_Macros ADC Exported Macros 1205 * @{ 1206 */ 1207 /* Macro for internal HAL driver usage, and possibly can be used into code of */ 1208 /* final user. */ 1209 1210 /** @defgroup ADC_HAL_EM_HANDLE_IT_FLAG HAL ADC macro to manage HAL ADC handle, IT and flags. 1211 * @{ 1212 */ 1213 1214 /** @brief Reset ADC handle state. 1215 * @param __HANDLE__ ADC handle 1216 * @retval None 1217 */ 1218 #if (USE_HAL_ADC_REGISTER_CALLBACKS == 1) 1219 #define __HAL_ADC_RESET_HANDLE_STATE(__HANDLE__) \ 1220 do{ \ 1221 (__HANDLE__)->State = HAL_ADC_STATE_RESET; \ 1222 (__HANDLE__)->MspInitCallback = NULL; \ 1223 (__HANDLE__)->MspDeInitCallback = NULL; \ 1224 } while(0) 1225 #else 1226 #define __HAL_ADC_RESET_HANDLE_STATE(__HANDLE__) \ 1227 ((__HANDLE__)->State = HAL_ADC_STATE_RESET) 1228 #endif /* USE_HAL_ADC_REGISTER_CALLBACKS */ 1229 1230 /** 1231 * @brief Enable ADC interrupt. 1232 * @param __HANDLE__ ADC handle 1233 * @param __INTERRUPT__ ADC Interrupt 1234 * This parameter can be one of the following values: 1235 * @arg @ref ADC_IT_RDY ADC Ready interrupt source 1236 * @arg @ref ADC_IT_CCRDY ADC channel configuration ready interrupt source 1237 * @arg @ref ADC_IT_EOSMP ADC End of Sampling interrupt source 1238 * @arg @ref ADC_IT_EOC ADC End of Regular Conversion interrupt source 1239 * @arg @ref ADC_IT_EOS ADC End of Regular sequence of Conversions interrupt source 1240 * @arg @ref ADC_IT_OVR ADC overrun interrupt source 1241 * @arg @ref ADC_IT_AWD1 ADC Analog watchdog 1 interrupt source (main analog watchdog) 1242 * @arg @ref ADC_IT_AWD2 ADC Analog watchdog 2 interrupt source (additional analog watchdog) 1243 * @arg @ref ADC_IT_AWD3 ADC Analog watchdog 3 interrupt source (additional analog watchdog) 1244 * @retval None 1245 */ 1246 #define __HAL_ADC_ENABLE_IT(__HANDLE__, __INTERRUPT__) \ 1247 (((__HANDLE__)->Instance->IER) |= (__INTERRUPT__)) 1248 1249 /** 1250 * @brief Disable ADC interrupt. 1251 * @param __HANDLE__ ADC handle 1252 * @param __INTERRUPT__ ADC Interrupt 1253 * This parameter can be one of the following values: 1254 * @arg @ref ADC_IT_RDY ADC Ready interrupt source 1255 * @arg @ref ADC_IT_CCRDY ADC channel configuration ready interrupt source 1256 * @arg @ref ADC_IT_EOSMP ADC End of Sampling interrupt source 1257 * @arg @ref ADC_IT_EOC ADC End of Regular Conversion interrupt source 1258 * @arg @ref ADC_IT_EOS ADC End of Regular sequence of Conversions interrupt source 1259 * @arg @ref ADC_IT_OVR ADC overrun interrupt source 1260 * @arg @ref ADC_IT_AWD1 ADC Analog watchdog 1 interrupt source (main analog watchdog) 1261 * @arg @ref ADC_IT_AWD2 ADC Analog watchdog 2 interrupt source (additional analog watchdog) 1262 * @arg @ref ADC_IT_AWD3 ADC Analog watchdog 3 interrupt source (additional analog watchdog) 1263 * @retval None 1264 */ 1265 #define __HAL_ADC_DISABLE_IT(__HANDLE__, __INTERRUPT__) \ 1266 (((__HANDLE__)->Instance->IER) &= ~(__INTERRUPT__)) 1267 1268 /** @brief Checks if the specified ADC interrupt source is enabled or disabled. 1269 * @param __HANDLE__ ADC handle 1270 * @param __INTERRUPT__ ADC interrupt source to check 1271 * This parameter can be one of the following values: 1272 * @arg @ref ADC_IT_RDY ADC Ready interrupt source 1273 * @arg @ref ADC_IT_CCRDY ADC channel configuration ready interrupt source 1274 * @arg @ref ADC_IT_EOSMP ADC End of Sampling interrupt source 1275 * @arg @ref ADC_IT_EOC ADC End of Regular Conversion interrupt source 1276 * @arg @ref ADC_IT_EOS ADC End of Regular sequence of Conversions interrupt source 1277 * @arg @ref ADC_IT_OVR ADC overrun interrupt source 1278 * @arg @ref ADC_IT_AWD1 ADC Analog watchdog 1 interrupt source (main analog watchdog) 1279 * @arg @ref ADC_IT_AWD2 ADC Analog watchdog 2 interrupt source (additional analog watchdog) 1280 * @arg @ref ADC_IT_AWD3 ADC Analog watchdog 3 interrupt source (additional analog watchdog) 1281 * @retval State of interruption (SET or RESET) 1282 */ 1283 #define __HAL_ADC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) \ 1284 (((__HANDLE__)->Instance->IER & (__INTERRUPT__)) == (__INTERRUPT__)) 1285 1286 /** 1287 * @brief Check whether the specified ADC flag is set or not. 1288 * @param __HANDLE__ ADC handle 1289 * @param __FLAG__ ADC flag 1290 * This parameter can be one of the following values: 1291 * @arg @ref ADC_FLAG_RDY ADC Ready flag 1292 * @arg @ref ADC_FLAG_CCRDY ADC channel configuration ready flag 1293 * @arg @ref ADC_FLAG_EOSMP ADC End of Sampling flag 1294 * @arg @ref ADC_FLAG_EOC ADC End of Regular Conversion flag 1295 * @arg @ref ADC_FLAG_EOS ADC End of Regular sequence of Conversions flag 1296 * @arg @ref ADC_FLAG_OVR ADC overrun flag 1297 * @arg @ref ADC_FLAG_AWD1 ADC Analog watchdog 1 flag (main analog watchdog) 1298 * @arg @ref ADC_FLAG_AWD2 ADC Analog watchdog 2 flag (additional analog watchdog) 1299 * @arg @ref ADC_FLAG_AWD3 ADC Analog watchdog 3 flag (additional analog watchdog) 1300 * @retval State of flag (TRUE or FALSE). 1301 */ 1302 #define __HAL_ADC_GET_FLAG(__HANDLE__, __FLAG__) \ 1303 ((((__HANDLE__)->Instance->ISR) & (__FLAG__)) == (__FLAG__)) 1304 1305 /** 1306 * @brief Clear the specified ADC flag. 1307 * @param __HANDLE__ ADC handle 1308 * @param __FLAG__ ADC flag 1309 * This parameter can be one of the following values: 1310 * @arg @ref ADC_FLAG_RDY ADC Ready flag 1311 * @arg @ref ADC_FLAG_CCRDY ADC channel configuration ready flag 1312 * @arg @ref ADC_FLAG_EOSMP ADC End of Sampling flag 1313 * @arg @ref ADC_FLAG_EOC ADC End of Regular Conversion flag 1314 * @arg @ref ADC_FLAG_EOS ADC End of Regular sequence of Conversions flag 1315 * @arg @ref ADC_FLAG_OVR ADC overrun flag 1316 * @arg @ref ADC_FLAG_AWD1 ADC Analog watchdog 1 flag (main analog watchdog) 1317 * @arg @ref ADC_FLAG_AWD2 ADC Analog watchdog 2 flag (additional analog watchdog) 1318 * @arg @ref ADC_FLAG_AWD3 ADC Analog watchdog 3 flag (additional analog watchdog) 1319 * @retval None 1320 */ 1321 /* Note: bit cleared bit by writing 1 (writing 0 has no effect on any bit of register ISR) */ 1322 #define __HAL_ADC_CLEAR_FLAG(__HANDLE__, __FLAG__) \ 1323 (((__HANDLE__)->Instance->ISR) = (__FLAG__)) 1324 1325 /** 1326 * @} 1327 */ 1328 1329 /** @defgroup ADC_HAL_EM_HELPER_MACRO HAL ADC helper macro 1330 * @{ 1331 */ 1332 1333 /** 1334 * @brief Helper macro to get ADC channel number in decimal format 1335 * from literals ADC_CHANNEL_x. 1336 * @note Example: 1337 * __HAL_ADC_CHANNEL_TO_DECIMAL_NB(ADC_CHANNEL_4) 1338 * will return decimal number "4". 1339 * @note The input can be a value from functions where a channel 1340 * number is returned, either defined with number 1341 * or with bitfield (only one bit must be set). 1342 * @param __CHANNEL__ This parameter can be one of the following values: 1343 * @arg @ref ADC_CHANNEL_0 1344 * @arg @ref ADC_CHANNEL_1 1345 * @arg @ref ADC_CHANNEL_2 1346 * @arg @ref ADC_CHANNEL_3 1347 * @arg @ref ADC_CHANNEL_4 1348 * @arg @ref ADC_CHANNEL_5 1349 * @arg @ref ADC_CHANNEL_6 1350 * @arg @ref ADC_CHANNEL_7 1351 * @arg @ref ADC_CHANNEL_8 1352 * @arg @ref ADC_CHANNEL_9 1353 * @arg @ref ADC_CHANNEL_10 1354 * @arg @ref ADC_CHANNEL_11 1355 * @arg @ref ADC_CHANNEL_12 1356 * @arg @ref ADC_CHANNEL_13 1357 * @arg @ref ADC_CHANNEL_14 1358 * @arg @ref ADC_CHANNEL_15 (1) 1359 * @arg @ref ADC_CHANNEL_16 (1) 1360 * @arg @ref ADC_CHANNEL_17 (1) 1361 * @arg @ref ADC_CHANNEL_VREFINT 1362 * @arg @ref ADC_CHANNEL_TEMPSENSOR 1363 * @arg @ref ADC_CHANNEL_VBAT 1364 * 1365 * (1) On STM32WL, parameter can be set in ADC group sequencer 1366 * only if sequencer is set in mode "not fully configurable", 1367 * refer to function @ref LL_ADC_REG_SetSequencerConfigurable(). 1368 * @retval Value between Min_Data=0 and Max_Data=18 1369 */ 1370 #define __HAL_ADC_CHANNEL_TO_DECIMAL_NB(__CHANNEL__) \ 1371 __LL_ADC_CHANNEL_TO_DECIMAL_NB((__CHANNEL__)) 1372 1373 /** 1374 * @brief Helper macro to get ADC channel in literal format ADC_CHANNEL_x 1375 * from number in decimal format. 1376 * @note Example: 1377 * __HAL_ADC_DECIMAL_NB_TO_CHANNEL(4) 1378 * will return a data equivalent to "ADC_CHANNEL_4". 1379 * @param __DECIMAL_NB__ Value between Min_Data=0 and Max_Data=18 1380 * @retval Returned value can be one of the following values: 1381 * @arg @ref ADC_CHANNEL_0 1382 * @arg @ref ADC_CHANNEL_1 1383 * @arg @ref ADC_CHANNEL_2 1384 * @arg @ref ADC_CHANNEL_3 1385 * @arg @ref ADC_CHANNEL_4 1386 * @arg @ref ADC_CHANNEL_5 1387 * @arg @ref ADC_CHANNEL_6 1388 * @arg @ref ADC_CHANNEL_7 1389 * @arg @ref ADC_CHANNEL_8 1390 * @arg @ref ADC_CHANNEL_9 1391 * @arg @ref ADC_CHANNEL_10 1392 * @arg @ref ADC_CHANNEL_11 1393 * @arg @ref ADC_CHANNEL_12 1394 * @arg @ref ADC_CHANNEL_13 1395 * @arg @ref ADC_CHANNEL_14 1396 * @arg @ref ADC_CHANNEL_15 (1) 1397 * @arg @ref ADC_CHANNEL_16 (1) 1398 * @arg @ref ADC_CHANNEL_17 (1) 1399 * @arg @ref ADC_CHANNEL_VREFINT (2) 1400 * @arg @ref ADC_CHANNEL_TEMPSENSOR (2) 1401 * @arg @ref ADC_CHANNEL_VBAT (2) 1402 * 1403 * (1) On STM32WL, parameter can be set in ADC group sequencer 1404 * only if sequencer is set in mode "not fully configurable", 1405 * refer to function @ref LL_ADC_REG_SetSequencerConfigurable().\n 1406 * (2) For ADC channel read back from ADC register, 1407 * comparison with internal channel parameter to be done 1408 * using helper macro @ref __LL_ADC_CHANNEL_INTERNAL_TO_EXTERNAL(). 1409 */ 1410 #define __HAL_ADC_DECIMAL_NB_TO_CHANNEL(__DECIMAL_NB__) \ 1411 __LL_ADC_DECIMAL_NB_TO_CHANNEL((__DECIMAL_NB__)) 1412 1413 /** 1414 * @brief Helper macro to determine whether the selected channel 1415 * corresponds to literal definitions of driver. 1416 * @note The different literal definitions of ADC channels are: 1417 * - ADC internal channel: 1418 * ADC_CHANNEL_VREFINT, ADC_CHANNEL_TEMPSENSOR, ... 1419 * - ADC external channel (channel connected to a GPIO pin): 1420 * ADC_CHANNEL_1, ADC_CHANNEL_2, ... 1421 * @note The channel parameter must be a value defined from literal 1422 * definition of a ADC internal channel (ADC_CHANNEL_VREFINT, 1423 * ADC_CHANNEL_TEMPSENSOR, ...), 1424 * ADC external channel (ADC_CHANNEL_1, ADC_CHANNEL_2, ...), 1425 * must not be a value from functions where a channel number is 1426 * returned from ADC registers, 1427 * because internal and external channels share the same channel 1428 * number in ADC registers. The differentiation is made only with 1429 * parameters definitions of driver. 1430 * @param __CHANNEL__ This parameter can be one of the following values: 1431 * @arg @ref ADC_CHANNEL_0 1432 * @arg @ref ADC_CHANNEL_1 1433 * @arg @ref ADC_CHANNEL_2 1434 * @arg @ref ADC_CHANNEL_3 1435 * @arg @ref ADC_CHANNEL_4 1436 * @arg @ref ADC_CHANNEL_5 1437 * @arg @ref ADC_CHANNEL_6 1438 * @arg @ref ADC_CHANNEL_7 1439 * @arg @ref ADC_CHANNEL_8 1440 * @arg @ref ADC_CHANNEL_9 1441 * @arg @ref ADC_CHANNEL_10 1442 * @arg @ref ADC_CHANNEL_11 1443 * @arg @ref ADC_CHANNEL_12 1444 * @arg @ref ADC_CHANNEL_13 1445 * @arg @ref ADC_CHANNEL_14 1446 * @arg @ref ADC_CHANNEL_15 (1) 1447 * @arg @ref ADC_CHANNEL_16 (1) 1448 * @arg @ref ADC_CHANNEL_17 (1) 1449 * @arg @ref ADC_CHANNEL_VREFINT 1450 * @arg @ref ADC_CHANNEL_TEMPSENSOR 1451 * @arg @ref ADC_CHANNEL_VBAT 1452 * 1453 * (1) On STM32WL, parameter can be set in ADC group sequencer 1454 * only if sequencer is set in mode "not fully configurable", 1455 * refer to function @ref LL_ADC_REG_SetSequencerConfigurable(). 1456 * @retval Value "0" if the channel corresponds to a parameter definition of a ADC external channel 1457 * (channel connected to a GPIO pin). 1458 * Value "1" if the channel corresponds to a parameter definition of a ADC internal channel. 1459 */ 1460 #define __HAL_ADC_IS_CHANNEL_INTERNAL(__CHANNEL__) \ 1461 __LL_ADC_IS_CHANNEL_INTERNAL((__CHANNEL__)) 1462 1463 /** 1464 * @brief Helper macro to convert a channel defined from parameter 1465 * definition of a ADC internal channel (ADC_CHANNEL_VREFINT, 1466 * ADC_CHANNEL_TEMPSENSOR, ...), 1467 * to its equivalent parameter definition of a ADC external channel 1468 * (ADC_CHANNEL_1, ADC_CHANNEL_2, ...). 1469 * @note The channel parameter can be, additionally to a value 1470 * defined from parameter definition of a ADC internal channel 1471 * (ADC_CHANNEL_VREFINT, ADC_CHANNEL_TEMPSENSOR, ...), 1472 * a value defined from parameter definition of 1473 * ADC external channel (ADC_CHANNEL_1, ADC_CHANNEL_2, ...) 1474 * or a value from functions where a channel number is returned 1475 * from ADC registers. 1476 * @param __CHANNEL__ This parameter can be one of the following values: 1477 * @arg @ref ADC_CHANNEL_0 1478 * @arg @ref ADC_CHANNEL_1 1479 * @arg @ref ADC_CHANNEL_2 1480 * @arg @ref ADC_CHANNEL_3 1481 * @arg @ref ADC_CHANNEL_4 1482 * @arg @ref ADC_CHANNEL_5 1483 * @arg @ref ADC_CHANNEL_6 1484 * @arg @ref ADC_CHANNEL_7 1485 * @arg @ref ADC_CHANNEL_8 1486 * @arg @ref ADC_CHANNEL_9 1487 * @arg @ref ADC_CHANNEL_10 1488 * @arg @ref ADC_CHANNEL_11 1489 * @arg @ref ADC_CHANNEL_12 1490 * @arg @ref ADC_CHANNEL_13 1491 * @arg @ref ADC_CHANNEL_14 1492 * @arg @ref ADC_CHANNEL_15 (1) 1493 * @arg @ref ADC_CHANNEL_16 (1) 1494 * @arg @ref ADC_CHANNEL_17 (1) 1495 * @arg @ref ADC_CHANNEL_VREFINT 1496 * @arg @ref ADC_CHANNEL_TEMPSENSOR 1497 * @arg @ref ADC_CHANNEL_VBAT 1498 * 1499 * (1) On STM32WL, parameter can be set in ADC group sequencer 1500 * only if sequencer is set in mode "not fully configurable", 1501 * refer to function @ref LL_ADC_REG_SetSequencerConfigurable(). 1502 * @retval Returned value can be one of the following values: 1503 * @arg @ref ADC_CHANNEL_0 1504 * @arg @ref ADC_CHANNEL_1 1505 * @arg @ref ADC_CHANNEL_2 1506 * @arg @ref ADC_CHANNEL_3 1507 * @arg @ref ADC_CHANNEL_4 1508 * @arg @ref ADC_CHANNEL_5 1509 * @arg @ref ADC_CHANNEL_6 1510 * @arg @ref ADC_CHANNEL_7 1511 * @arg @ref ADC_CHANNEL_8 1512 * @arg @ref ADC_CHANNEL_9 1513 * @arg @ref ADC_CHANNEL_10 1514 * @arg @ref ADC_CHANNEL_11 1515 * @arg @ref ADC_CHANNEL_12 1516 * @arg @ref ADC_CHANNEL_13 1517 * @arg @ref ADC_CHANNEL_14 1518 * @arg @ref ADC_CHANNEL_15 1519 * @arg @ref ADC_CHANNEL_16 1520 * @arg @ref ADC_CHANNEL_17 1521 */ 1522 #define __HAL_ADC_CHANNEL_INTERNAL_TO_EXTERNAL(__CHANNEL__) \ 1523 __LL_ADC_CHANNEL_INTERNAL_TO_EXTERNAL((__CHANNEL__)) 1524 1525 /** 1526 * @brief Helper macro to determine whether the internal channel 1527 * selected is available on the ADC instance selected. 1528 * @note The channel parameter must be a value defined from parameter 1529 * definition of a ADC internal channel (ADC_CHANNEL_VREFINT, 1530 * ADC_CHANNEL_TEMPSENSOR, ...), 1531 * must not be a value defined from parameter definition of 1532 * ADC external channel (ADC_CHANNEL_1, ADC_CHANNEL_2, ...) 1533 * or a value from functions where a channel number is 1534 * returned from ADC registers, 1535 * because internal and external channels share the same channel 1536 * number in ADC registers. The differentiation is made only with 1537 * parameters definitions of driver. 1538 * @param __ADC_INSTANCE__ ADC instance 1539 * @param __CHANNEL__ This parameter can be one of the following values: 1540 * @arg @ref ADC_CHANNEL_VREFINT 1541 * @arg @ref ADC_CHANNEL_TEMPSENSOR 1542 * @arg @ref ADC_CHANNEL_VBAT 1543 * @retval Value "0" if the internal channel selected is not available on the ADC instance selected. 1544 * Value "1" if the internal channel selected is available on the ADC instance selected. 1545 */ 1546 #define __HAL_ADC_IS_CHANNEL_INTERNAL_AVAILABLE(__ADC_INSTANCE__, __CHANNEL__) \ 1547 __LL_ADC_IS_CHANNEL_INTERNAL_AVAILABLE((__ADC_INSTANCE__), (__CHANNEL__)) 1548 1549 /** 1550 * @brief Helper macro to select the ADC common instance 1551 * to which is belonging the selected ADC instance. 1552 * @note ADC common register instance can be used for: 1553 * - Set parameters common to several ADC instances 1554 * - Multimode (for devices with several ADC instances) 1555 * Refer to functions having argument "ADCxy_COMMON" as parameter. 1556 * @param __ADCx__ ADC instance 1557 * @retval ADC common register instance 1558 */ 1559 #define __HAL_ADC_COMMON_INSTANCE(__ADCx__) \ 1560 __LL_ADC_COMMON_INSTANCE((__ADCx__)) 1561 1562 /** 1563 * @brief Helper macro to check if all ADC instances sharing the same 1564 * ADC common instance are disabled. 1565 * @note This check is required by functions with setting conditioned to 1566 * ADC state: 1567 * All ADC instances of the ADC common group must be disabled. 1568 * Refer to functions having argument "ADCxy_COMMON" as parameter. 1569 * @note On devices with only 1 ADC common instance, parameter of this macro 1570 * is useless and can be ignored (parameter kept for compatibility 1571 * with devices featuring several ADC common instances). 1572 * @param __ADCXY_COMMON__ ADC common instance 1573 * (can be set directly from CMSIS definition or by using helper macro @ref __LL_ADC_COMMON_INSTANCE() ) 1574 * @retval Value "0" if all ADC instances sharing the same ADC common instance 1575 * are disabled. 1576 * Value "1" if at least one ADC instance sharing the same ADC common instance 1577 * is enabled. 1578 */ 1579 #define __HAL_ADC_IS_ENABLED_ALL_COMMON_INSTANCE(__ADCXY_COMMON__) \ 1580 __LL_ADC_IS_ENABLED_ALL_COMMON_INSTANCE((__ADCXY_COMMON__)) 1581 1582 /** 1583 * @brief Helper macro to define the ADC conversion data full-scale digital 1584 * value corresponding to the selected ADC resolution. 1585 * @note ADC conversion data full-scale corresponds to voltage range 1586 * determined by analog voltage references Vref+ and Vref- 1587 * (refer to reference manual). 1588 * @param __ADC_RESOLUTION__ This parameter can be one of the following values: 1589 * @arg @ref ADC_RESOLUTION_12B 1590 * @arg @ref ADC_RESOLUTION_10B 1591 * @arg @ref ADC_RESOLUTION_8B 1592 * @arg @ref ADC_RESOLUTION_6B 1593 * @retval ADC conversion data full-scale digital value 1594 */ 1595 #define __HAL_ADC_DIGITAL_SCALE(__ADC_RESOLUTION__) \ 1596 __LL_ADC_DIGITAL_SCALE((__ADC_RESOLUTION__)) 1597 1598 /** 1599 * @brief Helper macro to convert the ADC conversion data from 1600 * a resolution to another resolution. 1601 * @param __DATA__ ADC conversion data to be converted 1602 * @param __ADC_RESOLUTION_CURRENT__ Resolution of to the data to be converted 1603 * This parameter can be one of the following values: 1604 * @arg @ref ADC_RESOLUTION_12B 1605 * @arg @ref ADC_RESOLUTION_10B 1606 * @arg @ref ADC_RESOLUTION_8B 1607 * @arg @ref ADC_RESOLUTION_6B 1608 * @param __ADC_RESOLUTION_TARGET__ Resolution of the data after conversion 1609 * This parameter can be one of the following values: 1610 * @arg @ref ADC_RESOLUTION_12B 1611 * @arg @ref ADC_RESOLUTION_10B 1612 * @arg @ref ADC_RESOLUTION_8B 1613 * @arg @ref ADC_RESOLUTION_6B 1614 * @retval ADC conversion data to the requested resolution 1615 */ 1616 #define __HAL_ADC_CONVERT_DATA_RESOLUTION(__DATA__,\ 1617 __ADC_RESOLUTION_CURRENT__,\ 1618 __ADC_RESOLUTION_TARGET__) \ 1619 __LL_ADC_CONVERT_DATA_RESOLUTION((__DATA__),\ 1620 (__ADC_RESOLUTION_CURRENT__),\ 1621 (__ADC_RESOLUTION_TARGET__)) 1622 1623 /** 1624 * @brief Helper macro to calculate the voltage (unit: mVolt) 1625 * corresponding to a ADC conversion data (unit: digital value). 1626 * @note Analog reference voltage (Vref+) must be either known from 1627 * user board environment or can be calculated using ADC measurement 1628 * and ADC helper macro @ref __LL_ADC_CALC_VREFANALOG_VOLTAGE(). 1629 * @param __VREFANALOG_VOLTAGE__ Analog reference voltage (unit: mV) 1630 * @param __ADC_DATA__ ADC conversion data (resolution 12 bits) 1631 * (unit: digital value). 1632 * @param __ADC_RESOLUTION__ This parameter can be one of the following values: 1633 * @arg @ref ADC_RESOLUTION_12B 1634 * @arg @ref ADC_RESOLUTION_10B 1635 * @arg @ref ADC_RESOLUTION_8B 1636 * @arg @ref ADC_RESOLUTION_6B 1637 * @retval ADC conversion data equivalent voltage value (unit: mVolt) 1638 */ 1639 #define __HAL_ADC_CALC_DATA_TO_VOLTAGE(__VREFANALOG_VOLTAGE__,\ 1640 __ADC_DATA__,\ 1641 __ADC_RESOLUTION__) \ 1642 __LL_ADC_CALC_DATA_TO_VOLTAGE((__VREFANALOG_VOLTAGE__),\ 1643 (__ADC_DATA__),\ 1644 (__ADC_RESOLUTION__)) 1645 1646 /** 1647 * @brief Helper macro to calculate analog reference voltage (Vref+) 1648 * (unit: mVolt) from ADC conversion data of internal voltage 1649 * reference VrefInt. 1650 * @note Computation is using VrefInt calibration value 1651 * stored in system memory for each device during production. 1652 * @note This voltage depends on user board environment: voltage level 1653 * connected to pin Vref+. 1654 * On devices with small package, the pin Vref+ is not present 1655 * and internally bonded to pin Vdda. 1656 * @note On this STM32 series, calibration data of internal voltage reference 1657 * VrefInt corresponds to a resolution of 12 bits, 1658 * this is the recommended ADC resolution to convert voltage of 1659 * internal voltage reference VrefInt. 1660 * Otherwise, this macro performs the processing to scale 1661 * ADC conversion data to 12 bits. 1662 * @param __VREFINT_ADC_DATA__ ADC conversion data (resolution 12 bits) 1663 * of internal voltage reference VrefInt (unit: digital value). 1664 * @param __ADC_RESOLUTION__ This parameter can be one of the following values: 1665 * @arg @ref ADC_RESOLUTION_12B 1666 * @arg @ref ADC_RESOLUTION_10B 1667 * @arg @ref ADC_RESOLUTION_8B 1668 * @arg @ref ADC_RESOLUTION_6B 1669 * @retval Analog reference voltage (unit: mV) 1670 */ 1671 #define __HAL_ADC_CALC_VREFANALOG_VOLTAGE(__VREFINT_ADC_DATA__,\ 1672 __ADC_RESOLUTION__) \ 1673 __LL_ADC_CALC_VREFANALOG_VOLTAGE((__VREFINT_ADC_DATA__),\ 1674 (__ADC_RESOLUTION__)) 1675 1676 /** 1677 * @brief Helper macro to calculate the temperature (unit: degree Celsius) 1678 * from ADC conversion data of internal temperature sensor. 1679 * @note Computation is using temperature sensor calibration values 1680 * stored in system memory for each device during production. 1681 * @note Calculation formula: 1682 * Temperature = ((TS_ADC_DATA - TS_CAL1) 1683 * * (TS_CAL2_TEMP - TS_CAL1_TEMP)) 1684 * / (TS_CAL2 - TS_CAL1) + TS_CAL1_TEMP 1685 * with TS_ADC_DATA = temperature sensor raw data measured by ADC 1686 * Avg_Slope = (TS_CAL2 - TS_CAL1) 1687 * / (TS_CAL2_TEMP - TS_CAL1_TEMP) 1688 * TS_CAL1 = equivalent TS_ADC_DATA at temperature 1689 * TEMP_DEGC_CAL1 (calibrated in factory) 1690 * TS_CAL2 = equivalent TS_ADC_DATA at temperature 1691 * TEMP_DEGC_CAL2 (calibrated in factory) 1692 * Caution: Calculation relevancy under reserve that calibration 1693 * parameters are correct (address and data). 1694 * To calculate temperature using temperature sensor 1695 * datasheet typical values (generic values less, therefore 1696 * less accurate than calibrated values), 1697 * use helper macro @ref __LL_ADC_CALC_TEMPERATURE_TYP_PARAMS(). 1698 * @note As calculation input, the analog reference voltage (Vref+) must be 1699 * defined as it impacts the ADC LSB equivalent voltage. 1700 * @note Analog reference voltage (Vref+) must be either known from 1701 * user board environment or can be calculated using ADC measurement 1702 * and ADC helper macro @ref __LL_ADC_CALC_VREFANALOG_VOLTAGE(). 1703 * @note On this STM32 series, calibration data of temperature sensor 1704 * corresponds to a resolution of 12 bits, 1705 * this is the recommended ADC resolution to convert voltage of 1706 * temperature sensor. 1707 * Otherwise, this macro performs the processing to scale 1708 * ADC conversion data to 12 bits. 1709 * @param __VREFANALOG_VOLTAGE__ Analog reference voltage (unit: mV) 1710 * @param __TEMPSENSOR_ADC_DATA__ ADC conversion data of internal 1711 * temperature sensor (unit: digital value). 1712 * @param __ADC_RESOLUTION__ ADC resolution at which internal temperature 1713 * sensor voltage has been measured. 1714 * This parameter can be one of the following values: 1715 * @arg @ref ADC_RESOLUTION_12B 1716 * @arg @ref ADC_RESOLUTION_10B 1717 * @arg @ref ADC_RESOLUTION_8B 1718 * @arg @ref ADC_RESOLUTION_6B 1719 * @retval Temperature (unit: degree Celsius) 1720 */ 1721 #define __HAL_ADC_CALC_TEMPERATURE(__VREFANALOG_VOLTAGE__,\ 1722 __TEMPSENSOR_ADC_DATA__,\ 1723 __ADC_RESOLUTION__) \ 1724 __LL_ADC_CALC_TEMPERATURE((__VREFANALOG_VOLTAGE__),\ 1725 (__TEMPSENSOR_ADC_DATA__),\ 1726 (__ADC_RESOLUTION__)) 1727 1728 /** 1729 * @brief Helper macro to calculate the temperature (unit: degree Celsius) 1730 * from ADC conversion data of internal temperature sensor. 1731 * @note Computation is using temperature sensor typical values 1732 * (refer to device datasheet). 1733 * @note Calculation formula: 1734 * Temperature = (TS_TYP_CALx_VOLT(uV) - TS_ADC_DATA * Conversion_uV) 1735 * / Avg_Slope + CALx_TEMP 1736 * with TS_ADC_DATA = temperature sensor raw data measured by ADC 1737 * (unit: digital value) 1738 * Avg_Slope = temperature sensor slope 1739 * (unit: uV/Degree Celsius) 1740 * TS_TYP_CALx_VOLT = temperature sensor digital value at 1741 * temperature CALx_TEMP (unit: mV) 1742 * Caution: Calculation relevancy under reserve the temperature sensor 1743 * of the current device has characteristics in line with 1744 * datasheet typical values. 1745 * If temperature sensor calibration values are available on 1746 * on this device (presence of macro __LL_ADC_CALC_TEMPERATURE()), 1747 * temperature calculation will be more accurate using 1748 * helper macro @ref __LL_ADC_CALC_TEMPERATURE(). 1749 * @note As calculation input, the analog reference voltage (Vref+) must be 1750 * defined as it impacts the ADC LSB equivalent voltage. 1751 * @note Analog reference voltage (Vref+) must be either known from 1752 * user board environment or can be calculated using ADC measurement 1753 * and ADC helper macro @ref __LL_ADC_CALC_VREFANALOG_VOLTAGE(). 1754 * @note ADC measurement data must correspond to a resolution of 12bits 1755 * (full scale digital value 4095). If not the case, the data must be 1756 * preliminarily rescaled to an equivalent resolution of 12 bits. 1757 * @param __TEMPSENSOR_TYP_AVGSLOPE__ Device datasheet data: Temperature sensor slope typical value 1758 (unit: uV/DegCelsius). 1759 * On STM32WL, refer to device datasheet parameter "Avg_Slope". 1760 * @param __TEMPSENSOR_TYP_CALX_V__ Device datasheet data: Temperature sensor voltage typical value (at 1761 temperature and Vref+ defined in parameters below) (unit: mV). 1762 * On STM32WL, refer to device datasheet parameter "V30" (corresponding to TS_CAL1). 1763 * @param __TEMPSENSOR_CALX_TEMP__ Device datasheet data: Temperature at which temperature sensor voltage (see 1764 parameter above) is corresponding (unit: mV) 1765 * @param __VREFANALOG_VOLTAGE__ Analog voltage reference (Vref+) voltage (unit: mV) 1766 * @param __TEMPSENSOR_ADC_DATA__ ADC conversion data of internal temperature sensor (unit: digital value). 1767 * @param __ADC_RESOLUTION__ ADC resolution at which internal temperature sensor voltage has been measured. 1768 * This parameter can be one of the following values: 1769 * @arg @ref ADC_RESOLUTION_12B 1770 * @arg @ref ADC_RESOLUTION_10B 1771 * @arg @ref ADC_RESOLUTION_8B 1772 * @arg @ref ADC_RESOLUTION_6B 1773 * @retval Temperature (unit: degree Celsius) 1774 */ 1775 #define __HAL_ADC_CALC_TEMPERATURE_TYP_PARAMS(__TEMPSENSOR_TYP_AVGSLOPE__,\ 1776 __TEMPSENSOR_TYP_CALX_V__,\ 1777 __TEMPSENSOR_CALX_TEMP__,\ 1778 __VREFANALOG_VOLTAGE__,\ 1779 __TEMPSENSOR_ADC_DATA__,\ 1780 __ADC_RESOLUTION__) \ 1781 __LL_ADC_CALC_TEMPERATURE_TYP_PARAMS((__TEMPSENSOR_TYP_AVGSLOPE__),\ 1782 (__TEMPSENSOR_TYP_CALX_V__),\ 1783 (__TEMPSENSOR_CALX_TEMP__),\ 1784 (__VREFANALOG_VOLTAGE__),\ 1785 (__TEMPSENSOR_ADC_DATA__),\ 1786 (__ADC_RESOLUTION__)) 1787 1788 /** 1789 * @} 1790 */ 1791 1792 /** 1793 * @} 1794 */ 1795 1796 /* Include ADC HAL Extended module */ 1797 #include "stm32wlxx_hal_adc_ex.h" 1798 1799 /* Exported functions --------------------------------------------------------*/ 1800 /** @addtogroup ADC_Exported_Functions 1801 * @{ 1802 */ 1803 1804 /** @addtogroup ADC_Exported_Functions_Group1 1805 * @brief Initialization and Configuration functions 1806 * @{ 1807 */ 1808 /* Initialization and de-initialization functions ****************************/ 1809 HAL_StatusTypeDef HAL_ADC_Init(ADC_HandleTypeDef *hadc); 1810 HAL_StatusTypeDef HAL_ADC_DeInit(ADC_HandleTypeDef *hadc); 1811 void HAL_ADC_MspInit(ADC_HandleTypeDef *hadc); 1812 void HAL_ADC_MspDeInit(ADC_HandleTypeDef *hadc); 1813 1814 #if (USE_HAL_ADC_REGISTER_CALLBACKS == 1) 1815 /* Callbacks Register/UnRegister functions ***********************************/ 1816 HAL_StatusTypeDef HAL_ADC_RegisterCallback(ADC_HandleTypeDef *hadc, HAL_ADC_CallbackIDTypeDef CallbackID, 1817 pADC_CallbackTypeDef pCallback); 1818 HAL_StatusTypeDef HAL_ADC_UnRegisterCallback(ADC_HandleTypeDef *hadc, HAL_ADC_CallbackIDTypeDef CallbackID); 1819 #endif /* USE_HAL_ADC_REGISTER_CALLBACKS */ 1820 /** 1821 * @} 1822 */ 1823 1824 /** @addtogroup ADC_Exported_Functions_Group2 1825 * @brief IO operation functions 1826 * @{ 1827 */ 1828 /* IO operation functions *****************************************************/ 1829 1830 /* Blocking mode: Polling */ 1831 HAL_StatusTypeDef HAL_ADC_Start(ADC_HandleTypeDef *hadc); 1832 HAL_StatusTypeDef HAL_ADC_Stop(ADC_HandleTypeDef *hadc); 1833 HAL_StatusTypeDef HAL_ADC_PollForConversion(ADC_HandleTypeDef *hadc, uint32_t Timeout); 1834 HAL_StatusTypeDef HAL_ADC_PollForEvent(ADC_HandleTypeDef *hadc, uint32_t EventType, uint32_t Timeout); 1835 1836 /* Non-blocking mode: Interruption */ 1837 HAL_StatusTypeDef HAL_ADC_Start_IT(ADC_HandleTypeDef *hadc); 1838 HAL_StatusTypeDef HAL_ADC_Stop_IT(ADC_HandleTypeDef *hadc); 1839 1840 /* Non-blocking mode: DMA */ 1841 HAL_StatusTypeDef HAL_ADC_Start_DMA(ADC_HandleTypeDef *hadc, uint32_t *pData, uint32_t Length); 1842 HAL_StatusTypeDef HAL_ADC_Stop_DMA(ADC_HandleTypeDef *hadc); 1843 1844 /* ADC retrieve conversion value intended to be used with polling or interruption */ 1845 uint32_t HAL_ADC_GetValue(ADC_HandleTypeDef *hadc); 1846 1847 /* ADC IRQHandler and Callbacks used in non-blocking modes (Interruption and DMA) */ 1848 void HAL_ADC_IRQHandler(ADC_HandleTypeDef *hadc); 1849 void HAL_ADC_ConvCpltCallback(ADC_HandleTypeDef *hadc); 1850 void HAL_ADC_ConvHalfCpltCallback(ADC_HandleTypeDef *hadc); 1851 void HAL_ADC_LevelOutOfWindowCallback(ADC_HandleTypeDef *hadc); 1852 void HAL_ADC_ErrorCallback(ADC_HandleTypeDef *hadc); 1853 /** 1854 * @} 1855 */ 1856 1857 /** @addtogroup ADC_Exported_Functions_Group3 Peripheral Control functions 1858 * @brief Peripheral Control functions 1859 * @{ 1860 */ 1861 /* Peripheral Control functions ***********************************************/ 1862 HAL_StatusTypeDef HAL_ADC_ConfigChannel(ADC_HandleTypeDef *hadc, ADC_ChannelConfTypeDef *pConfig); 1863 HAL_StatusTypeDef HAL_ADC_AnalogWDGConfig(ADC_HandleTypeDef *hadc, ADC_AnalogWDGConfTypeDef *pAnalogWDGConfig); 1864 1865 /** 1866 * @} 1867 */ 1868 1869 /* Peripheral State functions *************************************************/ 1870 /** @addtogroup ADC_Exported_Functions_Group4 1871 * @{ 1872 */ 1873 uint32_t HAL_ADC_GetState(ADC_HandleTypeDef *hadc); 1874 uint32_t HAL_ADC_GetError(ADC_HandleTypeDef *hadc); 1875 1876 /** 1877 * @} 1878 */ 1879 1880 /** 1881 * @} 1882 */ 1883 1884 /* Private functions ---------------------------------------------------------*/ 1885 HAL_StatusTypeDef ADC_ConversionStop(ADC_HandleTypeDef *hadc); 1886 HAL_StatusTypeDef ADC_Enable(ADC_HandleTypeDef *hadc); 1887 HAL_StatusTypeDef ADC_Disable(ADC_HandleTypeDef *hadc); 1888 1889 /** 1890 * @} 1891 */ 1892 1893 /** 1894 * @} 1895 */ 1896 1897 /** 1898 * @} 1899 */ 1900 1901 #ifdef __cplusplus 1902 } 1903 #endif 1904 1905 1906 #endif /* STM32WLxx_HAL_ADC_H */ 1907
