lib/main/STM32H7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_opamp.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32h7xx_hal_opamp.h
   4   * @author  MCD Application Team
   5   * @brief   Header file of OPAMP HAL module.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; 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 STM32H7xx_HAL_OPAMP_H
  22 #define STM32H7xx_HAL_OPAMP_H
  23
  24 #ifdef __cplusplus
  25  extern "C" {
  26 #endif
  27
  28 /* Includes ------------------------------------------------------------------*/
  29 #include "stm32h7xx_hal_def.h"
  30
  31 /** @addtogroup STM32H7xx_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
  52   uint32_t PowerMode;                   /*!< Specifies the power mode Normal or High Speed.
  53                                              This parameter must be a value of @ref OPAMP_PowerMode */
  54
  55   uint32_t Mode;                        /*!< Specifies the OPAMP mode
  56                                              This parameter must be a value of @ref OPAMP_Mode
  57                                              mode is either Standalone, - Follower or PGA */
  58
  59   uint32_t InvertingInput;              /*!< Specifies the inverting input in Standalone & PGA modes
  60                                              - In Standalone mode i.e when mode is OPAMP_STANDALONE_MODE
  61                                                  This parameter must be a value of @ref OPAMP_InvertingInput
  62                                              - In Follower mode i.e when mode is OPAMP_FOLLOWER_MODE
  63                                            & In PGA mode i.e when mode is OPAMP_PGA_MODE
  64                                                  This parameter is Not Applicable */
  65
  66   uint32_t NonInvertingInput;           /*!< Specifies the non inverting input of the opamp:
  67                                              This parameter must be a value of @ref OPAMP_NonInvertingInput */
  68
  69   uint32_t PgaGain;                     /*!< Specifies the gain in PGA mode
  70                                              i.e. when mode is OPAMP_PGA_MODE.
  71                                              This parameter must be a value of @ref OPAMP_PgaGain */
  72
  73   uint32_t PgaConnect;                  /*!< Specifies the inverting pin in PGA mode
  74                                              i.e. when mode is OPAMP_PGA_MODE
  75                                              This parameter must be a value of @ref OPAMP_PgaConnect
  76                                              Either: not connected, connected to VINM0, connected to VINM1
  77                                              (VINM0 or VINM1 are typically used for external filtering) */
  78
  79   uint32_t UserTrimming;                /*!< Specifies the trimming mode
  80                                              This parameter must be a value of @ref OPAMP_UserTrimming
  81                                              UserTrimming is either factory or user trimming.*/
  82
  83   uint32_t TrimmingValueP;              /*!< Specifies the offset trimming value (PMOS) in Normal Mode
  84                                              i.e. when UserTrimming is OPAMP_TRIMMING_USER.
  85                                              This parameter must be a number between Min_Data = 0 and Max_Data = 31.
  86                                              16 is typical default value */
  87
  88   uint32_t TrimmingValueN;              /*!< Specifies the offset trimming value (NMOS) in Normal Mode
  89                                              i.e. when UserTrimming is OPAMP_TRIMMING_USER.
  90                                              This parameter must be a number between Min_Data = 0 and Max_Data = 31.
  91                                              16 is typical default value */
  92
  93   uint32_t TrimmingValuePHighSpeed;      /*!< Specifies the offset trimming value (PMOS) in High Speed Mode
  94                                              i.e. when UserTrimming is OPAMP_TRIMMING_USER.
  95                                              This parameter must be a number between Min_Data = 0 and Max_Data = 31.
  96                                              16 is typical default value */
  97
  98   uint32_t TrimmingValueNHighSpeed;      /*!< Specifies the offset trimming value (NMOS) in High Speed Mode
  99                                              i.e. when UserTrimming is OPAMP_TRIMMING_USER.
 100                                              This parameter must be a number between Min_Data = 0 and Max_Data = 31.
 101                                              16 is typical default value */
 102
 103 }OPAMP_InitTypeDef;
 104
 105 /**
 106   * @brief  HAL State structures definition
 107   */
 108
 109 typedef enum
 110 {
 111   HAL_OPAMP_STATE_RESET               = 0x00000000U, /*!< OPAMP is not yet Initialized          */
 112
 113   HAL_OPAMP_STATE_READY               = 0x00000001U, /*!< OPAMP is initialized and ready for use */
 114   HAL_OPAMP_STATE_CALIBBUSY           = 0x00000002U, /*!< OPAMP is enabled in auto calibration mode */
 115
 116   HAL_OPAMP_STATE_BUSY                = 0x00000004U, /*!< OPAMP is enabled and running in normal mode */
 117   HAL_OPAMP_STATE_BUSYLOCKED          = 0x00000005U  /*!< OPAMP is locked
 118                                                          only system reset allows reconfiguring the opamp. */
 119
 120 }HAL_OPAMP_StateTypeDef;
 121
 122 /**
 123   * @brief OPAMP Handle Structure definition
 124   */
 125 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1)
 126 typedef struct __OPAMP_HandleTypeDef
 127 #else
 128 typedef struct
 129 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */
 130 {
 131   OPAMP_TypeDef                 *Instance;                    /*!< OPAMP instance's registers base address */
 132   OPAMP_InitTypeDef              Init;                         /*!< OPAMP required parameters */
 133   HAL_StatusTypeDef              Status;                       /*!< OPAMP peripheral status   */
 134   HAL_LockTypeDef                Lock;                         /*!< Locking object          */
 135   __IO HAL_OPAMP_StateTypeDef    State;                        /*!< OPAMP communication state */
 136
 137 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1)
 138 void (* MspInitCallback)                (struct __OPAMP_HandleTypeDef *hopamp);
 139 void (* MspDeInitCallback)              (struct __OPAMP_HandleTypeDef *hopamp);
 140 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */
 141 } OPAMP_HandleTypeDef;
 142
 143 /**
 144   * @brief HAl_OPAMP_TrimmingValueTypeDef definition
 145   */
 146
 147 typedef  uint32_t HAL_OPAMP_TrimmingValueTypeDef;
 148
 149 /**
 150   * @}
 151   */
 152
 153 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1)
 154 /**
 155   * @brief  HAL OPAMP Callback ID enumeration definition
 156   */
 157 typedef enum
 158 {
 159   HAL_OPAMP_MSPINIT_CB_ID                     = 0x01U,  /*!< OPAMP MspInit Callback ID           */
 160   HAL_OPAMP_MSPDEINIT_CB_ID                   = 0x02U,  /*!< OPAMP MspDeInit Callback ID         */
 161   HAL_OPAMP_ALL_CB_ID                         = 0x03U   /*!< OPAMP All ID                        */
 162 }HAL_OPAMP_CallbackIDTypeDef;
 163
 164 /**
 165   * @brief  HAL OPAMP Callback pointer definition
 166   */
 167 typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp);
 168 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */
 169
 170
 171 /* Exported constants --------------------------------------------------------*/
 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_VMSEL_1                            /*!< PGA mode */
 181 #define OPAMP_FOLLOWER_MODE               (OPAMP_CSR_VMSEL_1 | OPAMP_CSR_VMSEL_0)      /*!< 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_0          /*!< OPAMP non-inverting input connected internally to DAC channel */
 193 #if defined(DAC2)
 194 #define OPAMP_NONINVERTINGINPUT_DAC2_CH     OPAMP_CSR_VPSEL_1         /*!< Only OPAMP2 non-inverting input connected internally to DAC2 channel */
 195 #endif /* DAC2 */
 196
 197 /**
 198   * @}
 199   */
 200
 201 /** @defgroup OPAMP_InvertingInput OPAMP Inverting Input
 202   * @{
 203   */
 204
 205 #define OPAMP_INVERTINGINPUT_IO0               0x00000000U                            /*!< OPAMP inverting input connected to dedicated IO pin */
 206 #define OPAMP_INVERTINGINPUT_IO1               OPAMP_CSR_VMSEL_0                      /*!< OPAMP inverting input connected to dedicated IO pin */
 207
 208 /**
 209   * @}
 210   */
 211
 212 /** @defgroup OPAMP_PgaConnect OPAMP Pga Connect
 213   * @{
 214   */
 215
 216 #define OPAMP_PGA_CONNECT_INVERTINGINPUT_NO                0x00000000U                                /*!< In PGA mode, the inverting input is not connected */
 217 #define OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0               OPAMP_CSR_PGGAIN_2                         /*!< In PGA mode, the inverting input is connected to VINM0 */
 218 #define OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0_BIAS          OPAMP_CSR_PGGAIN_3                         /*!< In PGA mode, the inverting input is connected to VINM0 or bias */
 219 #define OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0_IO1_BIAS      (OPAMP_CSR_PGGAIN_2 | OPAMP_CSR_PGGAIN_3)  /*!< In PGA mode, the inverting input is connected to VINM0 or bias , VINM1 connected for filtering */
 220
 221
 222 /**
 223   * @}
 224   */
 225
 226 /** @defgroup OPAMP_PgaGain OPAMP Pga Gain
 227   * @{
 228   */
 229
 230 #define OPAMP_PGA_GAIN_2_OR_MINUS_1               0x00000000U                                 /*!< PGA gain could be 2 or -1   */
 231 #define OPAMP_PGA_GAIN_4_OR_MINUS_3               OPAMP_CSR_PGGAIN_0                          /*!< PGA gain could be 4 or -3   */
 232 #define OPAMP_PGA_GAIN_8_OR_MINUS_7               OPAMP_CSR_PGGAIN_1                          /*!< PGA gain could be 8 or -7   */
 233 #define OPAMP_PGA_GAIN_16_OR_MINUS_15             (OPAMP_CSR_PGGAIN_0 | OPAMP_CSR_PGGAIN_1)   /*!< PGA gain could be 16 or -15 */
 234
 235 /**
 236   * @}
 237   */
 238
 239 /** @defgroup OPAMP_PowerMode OPAMP PowerMode
 240   * @{
 241   */
 242 #define OPAMP_POWERMODE_NORMAL         0x00000000U
 243 #define OPAMP_POWERMODE_HIGHSPEED      OPAMP_CSR_OPAHSM
 244
 245 /**
 246   * @}
 247   */
 248
 249
 250 /** @defgroup OPAMP_VREF OPAMP VREF
 251   * @{
 252   */
 253
 254 #define OPAMP_VREF_3VDDA                     0x00000000U                 /*!< OPAMP Vref = 3.3% VDDA */
 255 #define OPAMP_VREF_10VDDA                    OPAMP_CSR_CALSEL_0          /*!< OPAMP Vref = 10% VDDA  */
 256 #define OPAMP_VREF_50VDDA                    OPAMP_CSR_CALSEL_1          /*!< OPAMP Vref = 50% VDDA  */
 257 #define OPAMP_VREF_90VDDA                    OPAMP_CSR_CALSEL            /*!< OPAMP Vref = 90% VDDA  */
 258
 259 /**
 260   * @}
 261   */
 262
 263 /** @defgroup OPAMP_UserTrimming OPAMP User Trimming
 264   * @{
 265   */
 266 #define OPAMP_TRIMMING_FACTORY         0x00000000U                             /*!< Factory trimming */
 267 #define OPAMP_TRIMMING_USER            OPAMP_CSR_USERTRIM                      /*!< User trimming */
 268
 269
 270 /**
 271   * @}
 272   */
 273
 274 /** @defgroup OPAMP_FactoryTrimming OPAMP Factory Trimming
 275   * @{
 276   */
 277 #define OPAMP_FACTORYTRIMMING_DUMMY    0xFFFFFFFFU                          /*!< Dummy value if trimming value could not be retrieved */
 278
 279 #define OPAMP_FACTORYTRIMMING_N        0x00000000U                          /*!< Offset trimming N */
 280 #define OPAMP_FACTORYTRIMMING_P        0x00000001U                          /*!< Offset trimming P */
 281
 282 /**
 283   * @}
 284   */
 285
 286  /**
 287   * @}
 288   */
 289
 290 /* Private constants ---------------------------------------------------------*/
 291 /** @defgroup OPAMP_Private_Constants OPAMP Private Constants
 292   * @brief   OPAMP Private constants and defines
 293   * @{
 294   */
 295
 296 /* NONINVERTING bit position in OTR & HSOTR */
 297 #define OPAMP_INPUT_NONINVERTING           (8U)  /*!< Non inverting input */
 298
 299 /* Offset trimming time: during calibration, minimum time needed between two  */
 300 /* steps to have 1 mV accuracy.                                               */
 301 /* Refer to datasheet, electrical characteristics: parameter tOFFTRIM Typ=2ms.*/
 302 /* Unit: ms.                                                                  */
 303 #define OPAMP_TRIMMING_DELAY               (2U)
 304
 305 /**
 306   * @}
 307   */
 308
 309 /* Exported macros -----------------------------------------------------------*/
 310 /** @defgroup OPAMP_Exported_Macros OPAMP Exported Macros
 311   * @{
 312   */
 313
 314 /** @brief Reset OPAMP handle state.
 315   * @param  __HANDLE__: OPAMP handle.
 316   * @retval None
 317   */
 318 #define __HAL_OPAMP_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_OPAMP_STATE_RESET)
 319
 320 /**
 321   * @}
 322   */
 323
 324 /* Private macro -------------------------------------------------------------*/
 325
 326 /** @defgroup OPAMP_Private_Macros OPAMP Private Macros
 327   * @{
 328   */
 329
 330 #define IS_OPAMP_FUNCTIONAL_NORMALMODE(INPUT) (((INPUT) == OPAMP_STANDALONE_MODE) || \
 331                                                ((INPUT) == OPAMP_PGA_MODE) || \
 332                                                ((INPUT) == OPAMP_FOLLOWER_MODE))
 333
 334 #define IS_OPAMP_INVERTING_INPUT_STANDALONE(INPUT) (((INPUT) == OPAMP_INVERTINGINPUT_IO0) || \
 335                                                     ((INPUT) == OPAMP_INVERTINGINPUT_IO1))
 336
 337 #if defined(DAC2)
 338 #define IS_OPAMP_NONINVERTING_INPUT(INPUT) (((INPUT) == OPAMP_NONINVERTINGINPUT_IO0) || \
 339                                             ((INPUT) == OPAMP_NONINVERTINGINPUT_DAC_CH) || \
 340                                             ((INPUT) == OPAMP_NONINVERTINGINPUT_DAC2_CH))
 341 #else
 342 #define IS_OPAMP_NONINVERTING_INPUT(INPUT) (((INPUT) == OPAMP_NONINVERTINGINPUT_IO0) || \
 343                                             ((INPUT) == OPAMP_NONINVERTINGINPUT_DAC_CH))
 344 #endif /* DAC2 */
 345
 346 #define IS_OPAMP_PGACONNECT(CONNECT) (((CONNECT) == OPAMP_PGA_CONNECT_INVERTINGINPUT_NO)  || \
 347                                       ((CONNECT) == OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0) || \
 348                                       ((CONNECT) == OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0_BIAS) || \
 349                                       ((CONNECT) == OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0_IO1_BIAS))
 350
 351 #define IS_OPAMP_PGA_GAIN(GAIN) (((GAIN) == OPAMP_PGA_GAIN_2_OR_MINUS_1) || \
 352                                  ((GAIN) == OPAMP_PGA_GAIN_4_OR_MINUS_3) || \
 353                                  ((GAIN) == OPAMP_PGA_GAIN_8_OR_MINUS_7) || \
 354                                  ((GAIN) == OPAMP_PGA_GAIN_16_OR_MINUS_15))
 355
 356
 357 #define IS_OPAMP_VREF(VREF) (((VREF) == OPAMP_VREF_3VDDA)  || \
 358                              ((VREF) == OPAMP_VREF_10VDDA) || \
 359                              ((VREF) == OPAMP_VREF_50VDDA) || \
 360                              ((VREF) == OPAMP_VREF_90VDDA))
 361
 362 #define IS_OPAMP_POWERMODE(TRIMMING) (((TRIMMING) == OPAMP_POWERMODE_NORMAL) || \
 363                                       ((TRIMMING) == OPAMP_POWERMODE_HIGHSPEED) )
 364
 365
 366 #define IS_OPAMP_TRIMMING(TRIMMING) (((TRIMMING) == OPAMP_TRIMMING_FACTORY) || \
 367                                      ((TRIMMING) == OPAMP_TRIMMING_USER))
 368
 369
 370 #define IS_OPAMP_TRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
 371
 372 #define IS_OPAMP_FACTORYTRIMMING(TRIMMING) (((TRIMMING) == OPAMP_FACTORYTRIMMING_N) || \
 373                                              ((TRIMMING) == OPAMP_FACTORYTRIMMING_P))
 374
 375 /**
 376   * @}
 377   */
 378
 379 /* Include OPAMP HAL Extended module */
 380 #include "stm32h7xx_hal_opamp_ex.h"
 381
 382 /* Exported functions --------------------------------------------------------*/
 383 /** @addtogroup OPAMP_Exported_Functions
 384   * @{
 385   */
 386
 387 /** @addtogroup OPAMP_Exported_Functions_Group1
 388   * @{
 389   */
 390 /* Initialization/de-initialization functions  **********************************/
 391 HAL_StatusTypeDef HAL_OPAMP_Init(OPAMP_HandleTypeDef *hopamp);
 392 HAL_StatusTypeDef HAL_OPAMP_DeInit (OPAMP_HandleTypeDef *hopamp);
 393 void HAL_OPAMP_MspInit(OPAMP_HandleTypeDef *hopamp);
 394 void HAL_OPAMP_MspDeInit(OPAMP_HandleTypeDef *hopamp);
 395 /**
 396   * @}
 397   */
 398
 399 /** @addtogroup OPAMP_Exported_Functions_Group2
 400   * @{
 401   */
 402
 403 /* I/O operation functions  *****************************************************/
 404 HAL_StatusTypeDef HAL_OPAMP_Start(OPAMP_HandleTypeDef *hopamp);
 405 HAL_StatusTypeDef HAL_OPAMP_Stop(OPAMP_HandleTypeDef *hopamp);
 406 HAL_StatusTypeDef HAL_OPAMP_SelfCalibrate(OPAMP_HandleTypeDef *hopamp);
 407
 408 /**
 409   * @}
 410   */
 411
 412 /** @addtogroup OPAMP_Exported_Functions_Group3
 413   * @{
 414   */
 415
 416 /* Peripheral Control functions  ************************************************/
 417 #if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1)
 418 /* OPAMP callback registering/unregistering */
 419 HAL_StatusTypeDef HAL_OPAMP_RegisterCallback (OPAMP_HandleTypeDef *hopamp, HAL_OPAMP_CallbackIDTypeDef CallbackId, pOPAMP_CallbackTypeDef pCallback);
 420 HAL_StatusTypeDef HAL_OPAMP_UnRegisterCallback (OPAMP_HandleTypeDef *hopamp, HAL_OPAMP_CallbackIDTypeDef CallbackId);
 421 #endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */
 422 HAL_StatusTypeDef HAL_OPAMP_Lock(OPAMP_HandleTypeDef *hopamp);
 423 HAL_OPAMP_TrimmingValueTypeDef HAL_OPAMP_GetTrimOffset (OPAMP_HandleTypeDef *hopamp, uint32_t trimmingoffset);
 424
 425 /**
 426   * @}
 427   */
 428
 429 /** @addtogroup OPAMP_Exported_Functions_Group4
 430   * @{
 431   */
 432
 433 /* Peripheral State functions  **************************************************/
 434 HAL_OPAMP_StateTypeDef HAL_OPAMP_GetState(OPAMP_HandleTypeDef *hopamp);
 435
 436 /**
 437   * @}
 438   */
 439
 440 /**
 441   * @}
 442   */
 443
 444 /**
 445   * @}
 446   */
 447
 448 /**
 449   * @}
 450   */
 451
 452 #ifdef __cplusplus
 453 }
 454 #endif
 455
 456 #endif /* STM32H7xx_HAL_OPAMP_H */
 457
 458 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/