lib/main/STM32G4/Drivers/STM32G4xx_HAL_Driver/Src/stm32g4xx_ll_opamp.c

   1 /**
   2   ******************************************************************************
   3   * @file    stm32g4xx_ll_opamp.c
   4   * @author  MCD Application Team
   5   * @brief   OPAMP LL module driver
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2018 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 #if defined(USE_FULL_LL_DRIVER)
  20
  21 /* Includes ------------------------------------------------------------------*/
  22 #include "stm32g4xx_ll_opamp.h"
  23
  24 #ifdef  USE_FULL_ASSERT
  25 #include "stm32_assert.h"
  26 #else
  27 #define assert_param(expr) ((void)0U)
  28 #endif
  29
  30 /** @addtogroup STM32G4xx_LL_Driver
  31   * @{
  32   */
  33
  34 #if defined (OPAMP1) || defined (OPAMP2) || defined (OPAMP3) || defined (OPAMP4) || defined (OPAMP5) || defined (OPAMP6)
  35
  36 /** @addtogroup OPAMP_LL OPAMP
  37   * @{
  38   */
  39
  40 /* Private types -------------------------------------------------------------*/
  41 /* Private variables ---------------------------------------------------------*/
  42 /* Private constants ---------------------------------------------------------*/
  43 /* Private macros ------------------------------------------------------------*/
  44
  45 /** @addtogroup OPAMP_LL_Private_Macros
  46   * @{
  47   */
  48
  49 /* Check of parameters for configuration of OPAMP hierarchical scope:         */
  50 /* OPAMP instance.                                                            */
  51
  52 #define IS_LL_OPAMP_POWER_MODE(__POWER_MODE__)                                 \
  53   (   ((__POWER_MODE__) == LL_OPAMP_POWERMODE_NORMAL)                          \
  54    || ((__POWER_MODE__) == LL_OPAMP_POWERMODE_HIGHSPEED))
  55
  56 #define IS_LL_OPAMP_FUNCTIONAL_MODE(__FUNCTIONAL_MODE__)                       \
  57   (   ((__FUNCTIONAL_MODE__) == LL_OPAMP_MODE_STANDALONE)                      \
  58    || ((__FUNCTIONAL_MODE__) == LL_OPAMP_MODE_FOLLOWER)                        \
  59    || ((__FUNCTIONAL_MODE__) == LL_OPAMP_MODE_PGA)                             \
  60    || ((__FUNCTIONAL_MODE__) == LL_OPAMP_MODE_PGA_IO0)                         \
  61    || ((__FUNCTIONAL_MODE__) == LL_OPAMP_MODE_PGA_IO0_BIAS)                    \
  62    || ((__FUNCTIONAL_MODE__) == LL_OPAMP_MODE_PGA_IO0_IO1_BIAS)                \
  63   )
  64
  65 #define IS_LL_OPAMP_INPUT_NONINVERTING(__INPUT_NONINVERTING__)                 \
  66   (   ((__INPUT_NONINVERTING__) == LL_OPAMP_INPUT_NONINVERT_IO0)               \
  67    || ((__INPUT_NONINVERTING__) == LL_OPAMP_INPUT_NONINVERT_IO1)               \
  68    || ((__INPUT_NONINVERTING__) == LL_OPAMP_INPUT_NONINVERT_IO2)               \
  69    || ((__INPUT_NONINVERTING__) == LL_OPAMP_INPUT_NONINVERT_IO3)               \
  70    || ((__INPUT_NONINVERTING__) == LL_OPAMP_INPUT_NONINVERT_DAC)               \
  71   )
  72
  73 #define IS_LL_OPAMP_INPUT_INVERTING(__INPUT_INVERTING__)                       \
  74   (   ((__INPUT_INVERTING__) == LL_OPAMP_INPUT_INVERT_IO0)                     \
  75    || ((__INPUT_INVERTING__) == LL_OPAMP_INPUT_INVERT_IO1)                     \
  76    || ((__INPUT_INVERTING__) == LL_OPAMP_INPUT_INVERT_CONNECT_NO)              \
  77   )
  78
  79 /**
  80   * @}
  81   */
  82
  83
  84 /* Private function prototypes -----------------------------------------------*/
  85
  86 /* Exported functions --------------------------------------------------------*/
  87 /** @addtogroup OPAMP_LL_Exported_Functions
  88   * @{
  89   */
  90
  91 /** @addtogroup OPAMP_LL_EF_Init
  92   * @{
  93   */
  94
  95 /**
  96   * @brief  De-initialize registers of the selected OPAMP instance
  97   *         to their default reset values.
  98   * @note   If comparator is locked, de-initialization by software is
  99   *         not possible.
 100   *         The only way to unlock the comparator is a device hardware reset.
 101   * @param  OPAMPx OPAMP instance
 102   * @retval An ErrorStatus enumeration value:
 103   *          - SUCCESS: OPAMP registers are de-initialized
 104   *          - ERROR: OPAMP registers are not de-initialized
 105   */
 106 ErrorStatus LL_OPAMP_DeInit(OPAMP_TypeDef *OPAMPx)
 107 {
 108   ErrorStatus status = SUCCESS;
 109
 110   /* Check the parameters */
 111   assert_param(IS_OPAMP_ALL_INSTANCE(OPAMPx));
 112
 113   /* Note: Hardware constraint (refer to description of this function):       */
 114   /*       OPAMP instance must not be locked.                                 */
 115   if (LL_OPAMP_IsLocked(OPAMPx) == 0UL)
 116   {
 117     LL_OPAMP_WriteReg(OPAMPx, CSR, 0x00000000UL);
 118   }
 119   else
 120   {
 121     /* OPAMP instance is locked: de-initialization by software is              */
 122     /* not possible.                                                           */
 123     /* The only way to unlock the OPAMP is a device hardware reset.            */
 124     status = ERROR;
 125   }
 126
 127   /* Timer controlled mux mode register reset                                  */
 128   if (LL_OPAMP_IsTimerMuxLocked(OPAMPx) == 0UL)
 129   {
 130     LL_OPAMP_WriteReg(OPAMPx, TCMR, 0x00000000UL);
 131   }
 132   else if (LL_OPAMP_ReadReg(OPAMPx, TCMR) != 0x80000000UL)
 133   {
 134     /* OPAMP instance timer controlled mux is locked configured, deinit error  */
 135     /* The only way to unlock the OPAMP is a device hardware reset.            */
 136     status = ERROR;
 137   }
 138   else
 139   {
 140     /* OPAMP instance timer controlled mux is locked unconfigured, deinit OK */
 141   }
 142
 143   return status;
 144 }
 145
 146 /**
 147   * @brief  Initialize some features of OPAMP instance.
 148   * @note   This function reset bit of calibration mode to ensure
 149   *         to be in functional mode, in order to have OPAMP parameters
 150   *         (inputs selection, ...) set with the corresponding OPAMP mode
 151   *         to be effective.
 152   * @param  OPAMPx OPAMP instance
 153   * @param  OPAMP_InitStruct Pointer to a @ref LL_OPAMP_InitTypeDef structure
 154   * @retval An ErrorStatus enumeration value:
 155   *          - SUCCESS: OPAMP registers are initialized
 156   *          - ERROR: OPAMP registers are not initialized
 157   */
 158 ErrorStatus LL_OPAMP_Init(OPAMP_TypeDef *OPAMPx, LL_OPAMP_InitTypeDef *OPAMP_InitStruct)
 159 {
 160   ErrorStatus status = SUCCESS;
 161
 162   /* Check the parameters */
 163   assert_param(IS_OPAMP_ALL_INSTANCE(OPAMPx));
 164   assert_param(IS_LL_OPAMP_POWER_MODE(OPAMP_InitStruct->PowerMode));
 165   assert_param(IS_LL_OPAMP_FUNCTIONAL_MODE(OPAMP_InitStruct->FunctionalMode));
 166   assert_param(IS_LL_OPAMP_INPUT_NONINVERTING(OPAMP_InitStruct->InputNonInverting));
 167
 168   /* Note: OPAMP inverting input can be used with OPAMP in mode standalone    */
 169   /*       or PGA with external capacitors for filtering circuit.             */
 170   /*       Otherwise (OPAMP in mode follower), OPAMP inverting input is       */
 171   /*       not used (not connected to GPIO pin).                              */
 172   if (OPAMP_InitStruct->FunctionalMode != LL_OPAMP_MODE_FOLLOWER)
 173   {
 174     assert_param(IS_LL_OPAMP_INPUT_INVERTING(OPAMP_InitStruct->InputInverting));
 175   }
 176
 177   /* Note: Hardware constraint (refer to description of this function):       */
 178   /*       OPAMP instance must not be locked.                                 */
 179   if (LL_OPAMP_IsLocked(OPAMPx) == 0U)
 180   {
 181     /* Configuration of OPAMP instance :                                      */
 182     /*  - PowerMode                                                             */
 183     /*  - Functional mode                                                     */
 184     /*  - Input non-inverting                                                 */
 185     /*  - Input inverting                                                     */
 186     /* Note: Bit OPAMP_CSR_CALON reset to ensure to be in functional mode.    */
 187     if (OPAMP_InitStruct->FunctionalMode != LL_OPAMP_MODE_FOLLOWER)
 188     {
 189       MODIFY_REG(OPAMPx->CSR,
 190                  OPAMP_CSR_HIGHSPEEDEN
 191                  | OPAMP_CSR_CALON
 192                  | OPAMP_CSR_VMSEL
 193                  | OPAMP_CSR_VPSEL
 194                  | OPAMP_CSR_PGGAIN_4 | OPAMP_CSR_PGGAIN_3
 195                  ,
 196                  OPAMP_InitStruct->PowerMode
 197                  | OPAMP_InitStruct->FunctionalMode
 198                  | OPAMP_InitStruct->InputNonInverting
 199                  | OPAMP_InitStruct->InputInverting
 200                 );
 201     }
 202     else
 203     {
 204       MODIFY_REG(OPAMPx->CSR,
 205                  OPAMP_CSR_HIGHSPEEDEN
 206                  | OPAMP_CSR_CALON
 207                  | OPAMP_CSR_VMSEL
 208                  | OPAMP_CSR_VPSEL
 209                  | OPAMP_CSR_PGGAIN_4 | OPAMP_CSR_PGGAIN_3
 210                  ,
 211                  OPAMP_InitStruct->PowerMode
 212                  | LL_OPAMP_MODE_FOLLOWER
 213                  | OPAMP_InitStruct->InputNonInverting
 214                 );
 215     }
 216   }
 217   else
 218   {
 219     /* Initialization error: OPAMP instance is locked.                        */
 220     status = ERROR;
 221   }
 222
 223   return status;
 224 }
 225
 226 /**
 227   * @brief Set each @ref LL_OPAMP_InitTypeDef field to default value.
 228   * @param OPAMP_InitStruct pointer to a @ref LL_OPAMP_InitTypeDef structure
 229   *                         whose fields will be set to default values.
 230   * @retval None
 231   */
 232 void LL_OPAMP_StructInit(LL_OPAMP_InitTypeDef *OPAMP_InitStruct)
 233 {
 234   /* Set OPAMP_InitStruct fields to default values */
 235   OPAMP_InitStruct->PowerMode         = LL_OPAMP_POWERMODE_NORMAL;
 236   OPAMP_InitStruct->FunctionalMode    = LL_OPAMP_MODE_FOLLOWER;
 237   OPAMP_InitStruct->InputNonInverting = LL_OPAMP_INPUT_NONINVERT_IO0;
 238   /* Note: Parameter discarded if OPAMP in functional mode follower,          */
 239   /*       set anyway to its default value.                                   */
 240   OPAMP_InitStruct->InputInverting    = LL_OPAMP_INPUT_INVERT_CONNECT_NO;
 241 }
 242
 243 /**
 244   * @}
 245   */
 246
 247 /**
 248   * @}
 249   */
 250
 251 /**
 252   * @}
 253   */
 254
 255 #endif /* OPAMP1 || OPAMP2 || OPAMP3 || OPAMP4  || OPAMP5 || OPAMP6 */
 256
 257 /**
 258   * @}
 259   */
 260
 261 #endif /* USE_FULL_LL_DRIVER */
 262
 263 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/