stm32h7xx_hal_opamp.h

Go to the documentation of this file.

 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef STM32H7xx_HAL_OPAMP_H
#define STM32H7xx_HAL_OPAMP_H
 
#ifdef __cplusplus
 extern "C" {
#endif
                  
/* Includes ------------------------------------------------------------------*/
#include "stm32h7xx_hal_def.h"
 
/* Exported types ------------------------------------------------------------*/ 
 
typedef struct
{
 
  uint32_t PowerMode;                   
  uint32_t Mode;                        
  uint32_t InvertingInput;              
  uint32_t NonInvertingInput;           
  uint32_t PgaGain;                     
  uint32_t PgaConnect;                  
  uint32_t UserTrimming;                
  uint32_t TrimmingValueP;              
  uint32_t TrimmingValueN;              
  uint32_t TrimmingValuePHighSpeed;      
  uint32_t TrimmingValueNHighSpeed;      
}OPAMP_InitTypeDef;
 
typedef enum
{
  HAL_OPAMP_STATE_RESET               = 0x00000000U, 
  HAL_OPAMP_STATE_READY               = 0x00000001U, 
  HAL_OPAMP_STATE_CALIBBUSY           = 0x00000002U, 
  HAL_OPAMP_STATE_BUSY                = 0x00000004U, 
  HAL_OPAMP_STATE_BUSYLOCKED          = 0x00000005U  
}HAL_OPAMP_StateTypeDef;
 
#if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1)
typedef struct __OPAMP_HandleTypeDef
#else
typedef struct
#endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */
{
  OPAMP_TypeDef                 *Instance;                    
  OPAMP_InitTypeDef              Init;                         
  HAL_StatusTypeDef              Status;                       
  HAL_LockTypeDef                Lock;                         
  __IO HAL_OPAMP_StateTypeDef    State;                        
#if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1)
void (* MspInitCallback)                (struct __OPAMP_HandleTypeDef *hopamp);
void (* MspDeInitCallback)              (struct __OPAMP_HandleTypeDef *hopamp); 
#endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */ 
} OPAMP_HandleTypeDef;
 
typedef  uint32_t HAL_OPAMP_TrimmingValueTypeDef;
 
#if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1)
typedef enum
{
  HAL_OPAMP_MSPINIT_CB_ID                     = 0x01U,  
  HAL_OPAMP_MSPDEINIT_CB_ID                   = 0x02U,  
  HAL_OPAMP_ALL_CB_ID                         = 0x03U   
}HAL_OPAMP_CallbackIDTypeDef;
 
typedef void (*pOPAMP_CallbackTypeDef)(OPAMP_HandleTypeDef *hopamp);
#endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */
/* Exported constants --------------------------------------------------------*/
#define OPAMP_STANDALONE_MODE             0x00000000U                                  
#define OPAMP_PGA_MODE                    OPAMP_CSR_VMSEL_1                            
#define OPAMP_FOLLOWER_MODE               (OPAMP_CSR_VMSEL_1 | OPAMP_CSR_VMSEL_0)      
#define OPAMP_NONINVERTINGINPUT_IO0         0x00000000U                
#define OPAMP_NONINVERTINGINPUT_DAC_CH      OPAMP_CSR_VPSEL_0          
#if defined(DAC2)
#define OPAMP_NONINVERTINGINPUT_DAC2_CH     OPAMP_CSR_VPSEL_1         
#endif /* DAC2 */
 
#define OPAMP_INVERTINGINPUT_IO0               0x00000000U                            
#define OPAMP_INVERTINGINPUT_IO1               OPAMP_CSR_VMSEL_0                      
#define OPAMP_PGA_CONNECT_INVERTINGINPUT_NO                0x00000000U                                
#define OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0               OPAMP_CSR_PGGAIN_2                         
#define OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0_BIAS          OPAMP_CSR_PGGAIN_3                         
#define OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0_IO1_BIAS      (OPAMP_CSR_PGGAIN_2 | OPAMP_CSR_PGGAIN_3)  
#define OPAMP_PGA_GAIN_2_OR_MINUS_1               0x00000000U                                 
#define OPAMP_PGA_GAIN_4_OR_MINUS_3               OPAMP_CSR_PGGAIN_0                          
#define OPAMP_PGA_GAIN_8_OR_MINUS_7               OPAMP_CSR_PGGAIN_1                          
#define OPAMP_PGA_GAIN_16_OR_MINUS_15             (OPAMP_CSR_PGGAIN_0 | OPAMP_CSR_PGGAIN_1)   
#define OPAMP_POWERMODE_NORMAL         0x00000000U
#define OPAMP_POWERMODE_HIGHSPEED      OPAMP_CSR_OPAHSM
 
#define OPAMP_VREF_3VDDA                     0x00000000U                 
#define OPAMP_VREF_10VDDA                    OPAMP_CSR_CALSEL_0          
#define OPAMP_VREF_50VDDA                    OPAMP_CSR_CALSEL_1          
#define OPAMP_VREF_90VDDA                    OPAMP_CSR_CALSEL            
#define OPAMP_TRIMMING_FACTORY         0x00000000U                             
#define OPAMP_TRIMMING_USER            OPAMP_CSR_USERTRIM                      
#define OPAMP_FACTORYTRIMMING_DUMMY    0xFFFFFFFFU                          
#define OPAMP_FACTORYTRIMMING_N        0x00000000U                          
#define OPAMP_FACTORYTRIMMING_P        0x00000001U                          
/* Private constants ---------------------------------------------------------*/
/* NONINVERTING bit position in OTR & HSOTR */
#define OPAMP_INPUT_NONINVERTING           (8U)  
/* Offset trimming time: during calibration, minimum time needed between two  */
/* steps to have 1 mV accuracy.                                               */
/* Refer to datasheet, electrical characteristics: parameter tOFFTRIM Typ=2ms.*/
/* Unit: ms.                                                                  */
#define OPAMP_TRIMMING_DELAY               (2U)
 
/* Exported macros -----------------------------------------------------------*/
#define __HAL_OPAMP_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_OPAMP_STATE_RESET)
 
/* Private macro -------------------------------------------------------------*/
 
#define IS_OPAMP_FUNCTIONAL_NORMALMODE(INPUT) (((INPUT) == OPAMP_STANDALONE_MODE) || \
                                               ((INPUT) == OPAMP_PGA_MODE) || \
                                               ((INPUT) == OPAMP_FOLLOWER_MODE))
 
#define IS_OPAMP_INVERTING_INPUT_STANDALONE(INPUT) (((INPUT) == OPAMP_INVERTINGINPUT_IO0) || \
                                                    ((INPUT) == OPAMP_INVERTINGINPUT_IO1))
 
#if defined(DAC2)
#define IS_OPAMP_NONINVERTING_INPUT(INPUT) (((INPUT) == OPAMP_NONINVERTINGINPUT_IO0) || \
                                            ((INPUT) == OPAMP_NONINVERTINGINPUT_DAC_CH) || \
                                            ((INPUT) == OPAMP_NONINVERTINGINPUT_DAC2_CH))
#else 
#define IS_OPAMP_NONINVERTING_INPUT(INPUT) (((INPUT) == OPAMP_NONINVERTINGINPUT_IO0) || \
                                            ((INPUT) == OPAMP_NONINVERTINGINPUT_DAC_CH))
#endif /* DAC2 */
 
#define IS_OPAMP_PGACONNECT(CONNECT) (((CONNECT) == OPAMP_PGA_CONNECT_INVERTINGINPUT_NO)  || \
                                      ((CONNECT) == OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0) || \
                                      ((CONNECT) == OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0_BIAS) || \
                                      ((CONNECT) == OPAMP_PGA_CONNECT_INVERTINGINPUT_IO0_IO1_BIAS))
 
#define IS_OPAMP_PGA_GAIN(GAIN) (((GAIN) == OPAMP_PGA_GAIN_2_OR_MINUS_1) || \
                                 ((GAIN) == OPAMP_PGA_GAIN_4_OR_MINUS_3) || \
                                 ((GAIN) == OPAMP_PGA_GAIN_8_OR_MINUS_7) || \
                                 ((GAIN) == OPAMP_PGA_GAIN_16_OR_MINUS_15))
 
 
#define IS_OPAMP_VREF(VREF) (((VREF) == OPAMP_VREF_3VDDA)  || \
                             ((VREF) == OPAMP_VREF_10VDDA) || \
                             ((VREF) == OPAMP_VREF_50VDDA) || \
                             ((VREF) == OPAMP_VREF_90VDDA))
 
#define IS_OPAMP_POWERMODE(TRIMMING) (((TRIMMING) == OPAMP_POWERMODE_NORMAL) || \
                                      ((TRIMMING) == OPAMP_POWERMODE_HIGHSPEED) )
 
 
#define IS_OPAMP_TRIMMING(TRIMMING) (((TRIMMING) == OPAMP_TRIMMING_FACTORY) || \
                                     ((TRIMMING) == OPAMP_TRIMMING_USER))
 
 
#define IS_OPAMP_TRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
 
#define IS_OPAMP_FACTORYTRIMMING(TRIMMING) (((TRIMMING) == OPAMP_FACTORYTRIMMING_N) || \
                                             ((TRIMMING) == OPAMP_FACTORYTRIMMING_P))
 
/* Include OPAMP HAL Extended module */
#include "stm32h7xx_hal_opamp_ex.h"
 
/* Exported functions --------------------------------------------------------*/
/* Initialization/de-initialization functions  **********************************/
HAL_StatusTypeDef HAL_OPAMP_Init(OPAMP_HandleTypeDef *hopamp);
HAL_StatusTypeDef HAL_OPAMP_DeInit (OPAMP_HandleTypeDef *hopamp);
void HAL_OPAMP_MspInit(OPAMP_HandleTypeDef *hopamp);
void HAL_OPAMP_MspDeInit(OPAMP_HandleTypeDef *hopamp);
/* I/O operation functions  *****************************************************/
HAL_StatusTypeDef HAL_OPAMP_Start(OPAMP_HandleTypeDef *hopamp);
HAL_StatusTypeDef HAL_OPAMP_Stop(OPAMP_HandleTypeDef *hopamp);
HAL_StatusTypeDef HAL_OPAMP_SelfCalibrate(OPAMP_HandleTypeDef *hopamp); 
 
/* Peripheral Control functions  ************************************************/
#if (USE_HAL_OPAMP_REGISTER_CALLBACKS == 1)
/* OPAMP callback registering/unregistering */
HAL_StatusTypeDef HAL_OPAMP_RegisterCallback (OPAMP_HandleTypeDef *hopamp, HAL_OPAMP_CallbackIDTypeDef CallbackId, pOPAMP_CallbackTypeDef pCallback);
HAL_StatusTypeDef HAL_OPAMP_UnRegisterCallback (OPAMP_HandleTypeDef *hopamp, HAL_OPAMP_CallbackIDTypeDef CallbackId);
#endif /* USE_HAL_OPAMP_REGISTER_CALLBACKS */
HAL_StatusTypeDef HAL_OPAMP_Lock(OPAMP_HandleTypeDef *hopamp);
HAL_OPAMP_TrimmingValueTypeDef HAL_OPAMP_GetTrimOffset (OPAMP_HandleTypeDef *hopamp, uint32_t trimmingoffset);
 
/* Peripheral State functions  **************************************************/
HAL_OPAMP_StateTypeDef HAL_OPAMP_GetState(OPAMP_HandleTypeDef *hopamp);
 
#ifdef __cplusplus
}
#endif
 
#endif /* STM32H7xx_HAL_OPAMP_H */