1 /** 2 ****************************************************************************** 3 * @file stm32l4xx_hal_opamp.h 4 * @author MCD Application Team 5 * @brief Header file of OPAMP HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * <h2><center>© Copyright (c) 2017 STMicroelectronics. 10 * All rights reserved.</center></h2> 11 * 12 * This software component is licensed by ST under BSD 3-Clause license, 13 * the "License"; You may not use this file except in compliance with the 14 * License. You may obtain a copy of the License at: 15 * opensource.org/licenses/BSD-3-Clause 16 * 17 ****************************************************************************** 18 */ 19 20 /* Define to prevent recursive inclusion -------------------------------------*/ 21 #ifndef STM32L4xx_HAL_OPAMP_H 22 #define STM32L4xx_HAL_OPAMP_H 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 /* Includes ------------------------------------------------------------------*/ 29 #include "stm32l4xx_hal_def.h" 30 31 /** @addtogroup STM32L4xx_HAL_Driver 32 * @{ 33 */ 34 35 /** @addtogroup OPAMP 36 * @{ 37 */ 38 39 /* Exported types ------------------------------------------------------------*/ 40 41 /** @defgroup OPAMP_Exported_Types OPAMP Exported Types 42 * @{ 43 */ 44 45 /** 46 * @brief OPAMP Init structure definition 47 */ 48 49 typedef struct 50 { 51 uint32_t PowerSupplyRange; /*!< Specifies the power supply range: above or under 2.4V. 52 This parameter must be a value of @ref OPAMP_PowerSupplyRange 53 Caution: This parameter is common to all OPAMP instances: a modification of this parameter for the selected OPAMP impacts the other OPAMP instances. */ 54 55 uint32_t PowerMode; /*!< Specifies the power mode Normal or Low-Power. 56 This parameter must be a value of @ref OPAMP_PowerMode */ 57 58 uint32_t Mode; /*!< Specifies the OPAMP mode 59 This parameter must be a value of @ref OPAMP_Mode 60 mode is either Standalone, - Follower or PGA */ 61 62 uint32_t InvertingInput; /*!< Specifies the inverting input in Standalone & PGA modes 63 - In Standalone mode: i.e. when mode is OPAMP_STANDALONE_MODE 64 & PGA mode: i.e. when mode is OPAMP_PGA_MODE 65 This parameter must be a value of @ref OPAMP_InvertingInput 66 - In Follower mode i.e. when mode is OPAMP_FOLLOWER_MODE 67 This parameter is Not Applicable */ 68 69 uint32_t NonInvertingInput; /*!< Specifies the non inverting input of the opamp: 70 This parameter must be a value of @ref OPAMP_NonInvertingInput */ 71 72 uint32_t PgaGain; /*!< Specifies the gain in PGA mode 73 i.e. when mode is OPAMP_PGA_MODE. 74 This parameter must be a value of @ref OPAMP_PgaGain (2, 4, 8 or 16 ) */ 75 76 uint32_t UserTrimming; /*!< Specifies the trimming mode 77 This parameter must be a value of @ref OPAMP_UserTrimming 78 UserTrimming is either factory or user trimming.*/ 79 80 uint32_t TrimmingValueP; /*!< Specifies the offset trimming value (PMOS) 81 i.e. when UserTrimming is OPAMP_TRIMMING_USER. 82 This parameter must be a number between Min_Data = 0 and Max_Data = 31 83 16 is typical default value */ 84 85 uint32_t TrimmingValueN; /*!< Specifies the offset trimming value (NMOS) 86 i.e. when UserTrimming is OPAMP_TRIMMING_USER. 87 This parameter must be a number between Min_Data = 0 and Max_Data = 31 88 16 is typical default value */ 89 90 uint32_t TrimmingValuePLowPower; /*!< Specifies the offset trimming value (PMOS) 91 i.e. when UserTrimming is OPAMP_TRIMMING_USER. 92 This parameter must be a number between Min_Data = 0 and Max_Data = 31 93 16 is typical default value */ 94 95 uint32_t TrimmingValueNLowPower; /*!< Specifies the offset trimming value (NMOS) 96 i.e. when UserTrimming is OPAMP_TRIMMING_USER. 97 This parameter must be a number between Min_Data = 0 and Max_Data = 31 98 16 is typical default value */ 99 100 }OPAMP_InitTypeDef; 101 102 /** 103 * @brief HAL State structures definition 104 */ 105 106 typedef enum 107 { 108 HAL_OPAMP_STATE_RESET = 0x00000000, /*!< OPAMP is not yet Initialized */ 109 110 HAL_OPAMP_STATE_READY = 0x00000001, /*!< OPAMP is initialized and ready for use */ 111 HAL_OPAMP_STATE_CALIBBUSY = 0x00000002, /*!< OPAMP is enabled in auto calibration mode */ 112 113 HAL_OPAMP_STATE_BUSY = 0x00000004, /*!< OPAMP is enabled and running in normal mode */ 114 HAL_OPAMP_STATE_BUSYLOCKED = 0x00000005 /*!< OPAMP is locked 115 only system reset allows reconfiguring the opamp. */ 116 117 }HAL_OPAMP_StateTypeDef; 118 119 /** 120 * @brief OPAMP Handle Structure definition 121 */ 122 123 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1) 124 typedef struct __OPAMP_HandleTypeDef 125 #else 126 typedef struct 127 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */ 128 { 129 OPAMP_TypeDef *Instance; /*!< OPAMP instance's registers base address */ 130 OPAMP_InitTypeDef Init; /*!< OPAMP required parameters */ 131 HAL_StatusTypeDef Status; /*!< OPAMP peripheral status */ 132 HAL_LockTypeDef Lock; /*!< Locking object */ 133 __IO HAL_OPAMP_StateTypeDef State; /*!< OPAMP communication state */ 134 135 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1) 136 void (* MspInitCallback) (struct __OPAMP_HandleTypeDef *hopamp); 137 void (* MspDeInitCallback) (struct __OPAMP_HandleTypeDef *hopamp); 138 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */ 139 140 }OPAMP_HandleTypeDef; 141 142 /** 143 * @brief HAl_OPAMP_TrimmingValueTypeDef definition 144 */ 145 146 typedef uint32_t HAL_OPAMP_TrimmingValueTypeDef; 147 148 /** 149 * @} 150 */ 151 152 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1) 153 /** 154 * @brief HAL OPAMP Callback ID enumeration definition 155 */ 156 typedef enum 157 { 158 HAL_OPAMP_MSPINIT_CB_ID = 0x01U, /*!< OPAMP MspInit Callback ID */ 159 HAL_OPAMP_MSPDEINIT_CB_ID = 0x02U, /*!< OPAMP MspDeInit Callback ID */ 160 HAL_OPAMP_ALL_CB_ID = 0x03U /*!< OPAMP All ID */ 161 }HAL_OPAMP_CallbackIDTypeDef; 162 163 /** 164 * @brief HAL OPAMP Callback pointer definition 165 */ 166 typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp); 167 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */ 168 169 170 /* Exported constants --------------------------------------------------------*/ 171 172 /** @defgroup OPAMP_Exported_Constants OPAMP Exported Constants 173 * @{ 174 */ 175 176 /** @defgroup OPAMP_Mode OPAMP Mode 177 * @{ 178 */ 179 #define OPAMP_STANDALONE_MODE 0x00000000U /*!< standalone mode */ 180 #define OPAMP_PGA_MODE OPAMP_CSR_OPAMODE_1 /*!< PGA mode */ 181 #define OPAMP_FOLLOWER_MODE OPAMP_CSR_OPAMODE /*!< follower mode */ 182 183 /** 184 * @} 185 */ 186 187 /** @defgroup OPAMP_NonInvertingInput OPAMP Non Inverting Input 188 * @{ 189 */ 190 191 #define OPAMP_NONINVERTINGINPUT_IO0 0x00000000U /*!< OPAMP non-inverting input connected to dedicated IO pin */ 192 #define OPAMP_NONINVERTINGINPUT_DAC_CH OPAMP_CSR_VPSEL /*!< OPAMP non-inverting input connected internally to DAC channel */ 193 194 /** 195 * @} 196 */ 197 198 /** @defgroup OPAMP_InvertingInput OPAMP Inverting Input 199 * @{ 200 */ 201 202 #define OPAMP_INVERTINGINPUT_IO0 0x00000000U /*!< OPAMP inverting input connected to dedicated IO pin low-leakage */ 203 #define OPAMP_INVERTINGINPUT_IO1 OPAMP_CSR_VMSEL_0 /*!< OPAMP inverting input connected to alternative IO pin available on some device packages */ 204 #define OPAMP_INVERTINGINPUT_CONNECT_NO OPAMP_CSR_VMSEL_1 /*!< OPAMP inverting input not connected externally (PGA mode only) */ 205 206 /** 207 * @} 208 */ 209 210 /** @defgroup OPAMP_PgaGain OPAMP Pga Gain 211 * @{ 212 */ 213 214 #define OPAMP_PGA_GAIN_2 0x00000000U /*!< PGA gain = 2 */ 215 #define OPAMP_PGA_GAIN_4 OPAMP_CSR_PGGAIN_0 /*!< PGA gain = 4 */ 216 #define OPAMP_PGA_GAIN_8 OPAMP_CSR_PGGAIN_1 /*!< PGA gain = 8 */ 217 #define OPAMP_PGA_GAIN_16 (OPAMP_CSR_PGGAIN_0 | OPAMP_CSR_PGGAIN_1) /*!< PGA gain = 16 */ 218 219 /** 220 * @} 221 */ 222 223 /** @defgroup OPAMP_PowerMode OPAMP PowerMode 224 * @{ 225 */ 226 #define OPAMP_POWERMODE_NORMAL 0x00000000U 227 #define OPAMP_POWERMODE_LOWPOWER OPAMP_CSR_OPALPM 228 229 /** 230 * @} 231 */ 232 233 /** @defgroup OPAMP_PowerSupplyRange OPAMP PowerSupplyRange 234 * @{ 235 */ 236 #define OPAMP_POWERSUPPLY_LOW 0x00000000U /*!< Power supply range low (VDDA lower than 2.4V) */ 237 #define OPAMP_POWERSUPPLY_HIGH OPAMP1_CSR_OPARANGE /*!< Power supply range high (VDDA higher than 2.4V) */ 238 239 /** 240 * @} 241 */ 242 243 /** @defgroup OPAMP_UserTrimming OPAMP User Trimming 244 * @{ 245 */ 246 #define OPAMP_TRIMMING_FACTORY 0x00000000U /*!< Factory trimming */ 247 #define OPAMP_TRIMMING_USER OPAMP_CSR_USERTRIM /*!< User trimming */ 248 249 /** 250 * @} 251 */ 252 253 /** @defgroup OPAMP_FactoryTrimming OPAMP Factory Trimming 254 * @{ 255 */ 256 #define OPAMP_FACTORYTRIMMING_DUMMY 0xFFFFFFFFU /*!< Dummy value if trimming value could not be retrieved */ 257 #define OPAMP_FACTORYTRIMMING_N 0U /*!< Offset trimming N */ 258 #define OPAMP_FACTORYTRIMMING_P 1U /*!< Offset trimming P */ 259 260 /** 261 * @} 262 */ 263 264 /** 265 * @} 266 */ 267 268 /* Private constants ---------------------------------------------------------*/ 269 /** @defgroup OPAMP_Private_Constants OPAMP Private Constants 270 * @brief OPAMP Private constants and defines 271 * @{ 272 */ 273 274 /* NONINVERTING bit position in OTR & LPOTR */ 275 #define OPAMP_INPUT_NONINVERTING ((uint32_t) 8) /*!< Non inverting input */ 276 277 /* Offset trimming time: during calibration, minimum time needed between two */ 278 /* steps to have 1 mV accuracy. */ 279 /* Refer to datasheet, electrical characteristics: parameter tOFFTRIM Typ=1ms.*/ 280 /* Unit: ms. */ 281 #define OPAMP_TRIMMING_DELAY ((uint32_t) 1) 282 283 /** 284 * @} 285 */ 286 287 /* Exported macros -----------------------------------------------------------*/ 288 /** @defgroup OPAMP_Exported_Macros OPAMP Exported Macros 289 * @{ 290 */ 291 292 /** @brief Reset OPAMP handle state. 293 * @param __HANDLE__ OPAMP handle. 294 * @retval None 295 */ 296 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1) 297 #define __HAL_OPAMP_RESET_HANDLE_STATE(__HANDLE__) do { \ 298 (__HANDLE__)->State = HAL_OPAMP_STATE_RESET; \ 299 (__HANDLE__)->MspInitCallback = NULL; \ 300 (__HANDLE__)->MspDeInitCallback = NULL; \ 301 } while(0) 302 #else 303 #define __HAL_OPAMP_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_OPAMP_STATE_RESET) 304 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */ 305 306 307 308 /** 309 * @} 310 */ 311 312 /* Private macro -------------------------------------------------------------*/ 313 314 /** @defgroup OPAMP_Private_Macros OPAMP Private Macros 315 * @{ 316 */ 317 318 #define IS_OPAMP_FUNCTIONAL_NORMALMODE(INPUT) (((INPUT) == OPAMP_STANDALONE_MODE) || \ 319 ((INPUT) == OPAMP_PGA_MODE) || \ 320 ((INPUT) == OPAMP_FOLLOWER_MODE)) 321 322 #if defined (STM32L471xx) || defined (STM32L475xx) || defined (STM32L476xx) || defined (STM32L485xx) || defined (STM32L486xx) || \ 323 defined (STM32L496xx) || defined (STM32L4A6xx) || \ 324 defined (STM32L4P5xx) || defined (STM32L4Q5xx) || \ 325 defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined(STM32L4S9xx) 326 #define IS_OPAMP_INVERTING_INPUT_STANDALONE(INPUT) (((INPUT) == OPAMP_INVERTINGINPUT_IO0) || \ 327 ((INPUT) == OPAMP_INVERTINGINPUT_IO1)) 328 #endif /* STM32L471xx STM32L475xx STM32L476xx STM32L485xx STM32L486xx */ 329 /* STM32L496xx STM32L4A6xx */ 330 /* STM32L4P5xx STM32L4Q5xx */ 331 /* STM32L4R5xx STM32L4R7xx STM32L4R9xx STM32L4S5xx STM32L4S7xx STM32L4S9xx */ 332 333 #if defined (STM32L412xx) || defined (STM32L422xx) || \ 334 defined (STM32L431xx) || defined (STM32L432xx) || defined (STM32L433xx) || defined (STM32L442xx) || defined (STM32L443xx) || \ 335 defined (STM32L451xx) || defined (STM32L452xx) || defined (STM32L462xx) 336 #define IS_OPAMP_INVERTING_INPUT_STANDALONE(INPUT) ((INPUT) == OPAMP_INVERTINGINPUT_IO0) 337 #endif /* STM32L412xx STM32L422xx */ 338 /* STM32L431xx STM32L432xx STM32L433xx STM32L442xx STM32L443xx */ 339 /* STM32L451xx STM32L452xx STM32L462xx */ 340 341 #if defined (STM32L412xx) || defined (STM32L422xx) 342 #define IS_OPAMP_NONINVERTING_INPUT(INPUT) ((INPUT) == OPAMP_NONINVERTINGINPUT_IO0) 343 #endif /* STM32L412xx STM32L422xx */ 344 345 #if defined (STM32L431xx) || defined (STM32L432xx) || defined (STM32L433xx) || defined (STM32L442xx) || defined (STM32L443xx) || \ 346 defined (STM32L451xx) || defined (STM32L452xx) || defined (STM32L462xx) || \ 347 defined (STM32L471xx) || defined (STM32L475xx) || defined (STM32L476xx) || defined (STM32L485xx) || defined (STM32L486xx) || \ 348 defined (STM32L496xx) || defined (STM32L4A6xx) || \ 349 defined (STM32L4P5xx) || defined (STM32L4Q5xx) || \ 350 defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined(STM32L4S9xx) 351 #define IS_OPAMP_NONINVERTING_INPUT(INPUT) (((INPUT) == OPAMP_NONINVERTINGINPUT_IO0) || \ 352 ((INPUT) == OPAMP_NONINVERTINGINPUT_DAC_CH)) 353 #endif /* STM32L431xx STM32L432xx STM32L433xx STM32L442xx STM32L443xx */ 354 /* STM32L451xx STM32L452xx STM32L462xx */ 355 /* STM32L471xx STM32L475xx STM32L476xx STM32L485xx STM32L486xx */ 356 /* STM32L496xx STM32L4A6xx */ 357 /* STM32L4P5xx STM32L4Q5xx */ 358 /* STM32L4R5xx STM32L4R7xx STM32L4R9xx STM32L4S5xx STM32L4S7xx STM32L4S9xx */ 359 360 #if defined (STM32L471xx) || defined (STM32L475xx) || defined (STM32L476xx) || defined (STM32L485xx) || defined (STM32L486xx) || \ 361 defined (STM32L496xx) || defined (STM32L4A6xx) || \ 362 defined (STM32L4P5xx) || defined (STM32L4Q5xx) || \ 363 defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined(STM32L4S9xx) 364 #define IS_OPAMP_INVERTING_INPUT_PGA(INPUT) (((INPUT) == OPAMP_INVERTINGINPUT_IO0) || \ 365 ((INPUT) == OPAMP_INVERTINGINPUT_IO1) || \ 366 ((INPUT) == OPAMP_INVERTINGINPUT_CONNECT_NO)) 367 #endif /* STM32L471xx STM32L475xx STM32L476xx STM32L485xx STM32L486xx */ 368 /* STM32L496xx STM32L4A6xx */ 369 /* STM32L4P5xx STM32L4Q5xx */ 370 /* STM32L4R5xx STM32L4R7xx STM32L4R9xx STM32L4S5xx STM32L4S7xx STM32L4S9xx */ 371 372 #if defined (STM32L412xx) || defined (STM32L422xx) || \ 373 defined (STM32L431xx) || defined (STM32L432xx) || defined (STM32L433xx) || defined (STM32L442xx) || defined (STM32L443xx) || \ 374 defined (STM32L451xx) || defined (STM32L452xx) || defined (STM32L462xx) 375 #define IS_OPAMP_INVERTING_INPUT_PGA(INPUT) (((INPUT) == OPAMP_INVERTINGINPUT_IO0) || \ 376 ((INPUT) == OPAMP_INVERTINGINPUT_CONNECT_NO)) 377 #endif /* STM32L412xx STM32L422xx */ 378 /* STM32L431xx STM32L432xx STM32L433xx STM32L442xx STM32L443xx */ 379 /* STM32L451xx STM32L452xx STM32L462xx */ 380 381 #define IS_OPAMP_PGA_GAIN(GAIN) (((GAIN) == OPAMP_PGA_GAIN_2) || \ 382 ((GAIN) == OPAMP_PGA_GAIN_4) || \ 383 ((GAIN) == OPAMP_PGA_GAIN_8) || \ 384 ((GAIN) == OPAMP_PGA_GAIN_16)) 385 386 #define IS_OPAMP_POWERMODE(TRIMMING) (((TRIMMING) == OPAMP_POWERMODE_NORMAL) || \ 387 ((TRIMMING) == OPAMP_POWERMODE_LOWPOWER) ) 388 389 #define IS_OPAMP_POWER_SUPPLY_RANGE(RANGE) (((RANGE) == OPAMP_POWERSUPPLY_LOW) || \ 390 ((RANGE) == OPAMP_POWERSUPPLY_HIGH) ) 391 392 #define IS_OPAMP_TRIMMING(TRIMMING) (((TRIMMING) == OPAMP_TRIMMING_FACTORY) || \ 393 ((TRIMMING) == OPAMP_TRIMMING_USER)) 394 395 396 #define IS_OPAMP_TRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 31U) 397 398 #define IS_OPAMP_FACTORYTRIMMING(TRIMMING) (((TRIMMING) == OPAMP_FACTORYTRIMMING_N) || \ 399 ((TRIMMING) == OPAMP_FACTORYTRIMMING_P)) 400 401 /** 402 * @} 403 */ 404 405 /* Include OPAMP HAL Extended module */ 406 #include "stm32l4xx_hal_opamp_ex.h" 407 408 /* Exported functions --------------------------------------------------------*/ 409 /** @addtogroup OPAMP_Exported_Functions 410 * @{ 411 */ 412 413 /** @addtogroup OPAMP_Exported_Functions_Group1 414 * @{ 415 */ 416 /* Initialization/de-initialization functions **********************************/ 417 HAL_StatusTypeDef HAL_OPAMP_Init(OPAMP_HandleTypeDef *hopamp); 418 HAL_StatusTypeDef HAL_OPAMP_DeInit (OPAMP_HandleTypeDef *hopamp); 419 void HAL_OPAMP_MspInit(OPAMP_HandleTypeDef *hopamp); 420 void HAL_OPAMP_MspDeInit(OPAMP_HandleTypeDef *hopamp); 421 /** 422 * @} 423 */ 424 425 /** @addtogroup OPAMP_Exported_Functions_Group2 426 * @{ 427 */ 428 429 /* I/O operation functions *****************************************************/ 430 HAL_StatusTypeDef HAL_OPAMP_Start(OPAMP_HandleTypeDef *hopamp); 431 HAL_StatusTypeDef HAL_OPAMP_Stop(OPAMP_HandleTypeDef *hopamp); 432 HAL_StatusTypeDef HAL_OPAMP_SelfCalibrate(OPAMP_HandleTypeDef *hopamp); 433 434 /** 435 * @} 436 */ 437 438 /** @addtogroup OPAMP_Exported_Functions_Group3 439 * @{ 440 */ 441 442 /* Peripheral Control functions ************************************************/ 443 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1) 444 /* OPAMP callback registering/unregistering */ 445 HAL_StatusTypeDef HAL_OPAMP_RegisterCallback (OPAMP_HandleTypeDef *hopamp, HAL_OPAMP_CallbackIDTypeDef CallbackID, pOPAMP_CallbackTypeDef pCallback); 446 HAL_StatusTypeDef HAL_OPAMP_UnRegisterCallback (OPAMP_HandleTypeDef *hopamp, HAL_OPAMP_CallbackIDTypeDef CallbackID); 447 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */ 448 449 HAL_StatusTypeDef HAL_OPAMP_Lock(OPAMP_HandleTypeDef *hopamp); 450 HAL_OPAMP_TrimmingValueTypeDef HAL_OPAMP_GetTrimOffset (OPAMP_HandleTypeDef *hopamp, uint32_t trimmingoffset); 451 452 /** 453 * @} 454 */ 455 456 /** @addtogroup OPAMP_Exported_Functions_Group4 457 * @{ 458 */ 459 460 /* Peripheral State functions **************************************************/ 461 HAL_OPAMP_StateTypeDef HAL_OPAMP_GetState(OPAMP_HandleTypeDef *hopamp); 462 463 /** 464 * @} 465 */ 466 467 /** 468 * @} 469 */ 470 471 /** 472 * @} 473 */ 474 475 /** 476 * @} 477 */ 478 479 #ifdef __cplusplus 480 } 481 #endif 482 483 #endif /* STM32L4xx_HAL_OPAMP_H */ 484 485 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 486