lib/main/STM32H7/Drivers/STM32H7xx_HAL_Driver/Src/stm32h7xx_ll_opamp.c

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