tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32L1/stm32l1xx_hal_opamp_ex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32l1xx_hal_opamp_ex.h
   4   * @author  MCD Application Team
   5   * @version V1.0.0
   6   * @date    5-September-2014
   7   * @brief   Header file of OPAMP HAL Extension module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32L1xx_HAL_OPAMP_EX_H
  40 #define __STM32L1xx_HAL_OPAMP_EX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 #if defined (STM32L151xCA) || defined (STM32L151xD) || defined (STM32L152xCA) || defined (STM32L152xD) || defined (STM32L162xCA) || defined (STM32L162xD) || defined (STM32L151xE) || defined (STM32L152xE) || defined (STM32L162xE) || defined (STM32L162xC) || defined (STM32L152xC) || defined (STM32L151xC)
  47
  48 /* Includes ------------------------------------------------------------------*/
  49 #include "stm32l1xx_hal_def.h"
  50
  51 /** @addtogroup STM32L1xx_HAL_Driver
  52   * @{
  53   */
  54
  55 /** @addtogroup OPAMPEx
  56   * @{
  57   */
  58
  59
  60
  61 /* Exported types ------------------------------------------------------------*/
  62 /* Exported constants ---------------------------------------------------------*/
  63 /** @defgroup OPAMPEx_Exported_Constants OPAMPEx Exported Constants
  64   * @{
  65   */
  66 #if defined (STM32L151xD) || defined (STM32L152xD) || defined (STM32L162xD)
  67 #define OPAMP_CSR_OPAXPD_ALL                                                   \
  68   (OPAMP_CSR_OPA1PD | OPAMP_CSR_OPA2PD | OPAMP_CSR_OPA3PD)
  69
  70 #define OPAMP_CSR_OPAXCAL_L_ALL                                                \
  71   (OPAMP_CSR_OPA1CAL_L | OPAMP_CSR_OPA2CAL_L | OPAMP_CSR_OPA3CAL_L)
  72
  73 #define OPAMP_CSR_OPAXCAL_H_ALL                                                \
  74   (OPAMP_CSR_OPA1CAL_H | OPAMP_CSR_OPA2CAL_H | OPAMP_CSR_OPA3CAL_H)
  75
  76 #define OPAMP_CSR_ALL_SWITCHES_ALL_OPAMPS                                      \
  77   (OPAMP_CSR_S3SEL1 | OPAMP_CSR_S4SEL1 | OPAMP_CSR_S5SEL1 | OPAMP_CSR_S6SEL1 | \
  78    OPAMP_CSR_ANAWSEL1                                                        | \
  79    OPAMP_CSR_S3SEL2 | OPAMP_CSR_S4SEL2 | OPAMP_CSR_S5SEL2 | OPAMP_CSR_S6SEL2 | \
  80    OPAMP_CSR_ANAWSEL2 | OPAMP_CSR_S7SEL2                                     | \
  81    OPAMP_CSR_S3SEL3 | OPAMP_CSR_S4SEL3 | OPAMP_CSR_S5SEL3 | OPAMP_CSR_S6SEL3 | \
  82    OPAMP_CSR_ANAWSEL3                                                         )
  83 #else
  84 #define OPAMP_CSR_OPAXPD_ALL                                                   \
  85   (OPAMP_CSR_OPA1PD | OPAMP_CSR_OPA2PD)
  86
  87 #define OPAMP_CSR_OPAXCAL_L_ALL                                                \
  88   (OPAMP_CSR_OPA1CAL_L | OPAMP_CSR_OPA2CAL_L)
  89
  90 #define OPAMP_CSR_OPAXCAL_H_ALL                                                \
  91   (OPAMP_CSR_OPA1CAL_H | OPAMP_CSR_OPA2CAL_H)
  92
  93 #define OPAMP_CSR_ALL_SWITCHES_ALL_OPAMPS                                      \
  94   (OPAMP_CSR_S3SEL1 | OPAMP_CSR_S4SEL1 | OPAMP_CSR_S5SEL1 | OPAMP_CSR_S6SEL1 | \
  95    OPAMP_CSR_ANAWSEL1                                                        | \
  96    OPAMP_CSR_S3SEL2 | OPAMP_CSR_S4SEL2 | OPAMP_CSR_S5SEL2 | OPAMP_CSR_S6SEL2 | \
  97    OPAMP_CSR_ANAWSEL2 | OPAMP_CSR_S7SEL2                                      )
  98 #endif /* STM32L151xD || STM32L152xD || STM32L162xD */
  99
 100 /**
 101   * @}
 102   */
 103
 104 /* Exported macro ------------------------------------------------------------*/
 105
 106 /** @defgroup OPAMPEx_Exported_Macro OPAMPEx Exported Macro
 107   * @{
 108   */
 109
 110 #if defined (STM32L151xD) || defined (STM32L152xD) || defined (STM32L162xD)
 111 /**
 112   * @brief Enable internal analog switch SW1 to connect OPAMP3 ouput to ADC
 113   * switch matrix (ADC channel VCOMP, channel 26) and COMP1 non-inverting input
 114   * (OPAMP3 available on STM32L1 devices Cat.4 only).
 115   * @retval None
 116   */
 117 #define __HAL_OPAMP_OPAMP3OUT_CONNECT_ADC_COMP1()    __HAL_RI_SWITCH_COMP1_SW1_CLOSE()
 118
 119 /**
 120   * @brief Disable internal analog switch SW1 to disconnect OPAMP3 ouput from
 121   * ADC switch matrix (ADC channel VCOMP, channel 26) and COMP1 non-inverting
 122   * input.
 123   * @retval None
 124   */
 125 #define __HAL_OPAMP_OPAMP3OUT_DISCONNECT_ADC_COMP1() __HAL_RI_SWITCH_COMP1_SW1_OPEN()
 126 #endif /* STM32L151xD || STM32L152xD || STM32L162xD */
 127
 128 /**
 129   * @}
 130   */
 131
 132 /* Private macro -------------------------------------------------------------*/
 133
 134 /** @defgroup OPAMPEx_Private_Macro OPAMPEx Private Macro
 135   * @{
 136   */
 137
 138 #if defined (STM32L151xD) || defined (STM32L152xD) || defined (STM32L162xD)
 139 /**
 140   * @brief Get the OPAMP instance in decimal number for further
 141   * processing needs by HAL OPAMP driver functions.
 142   * @param __HANDLE__: OPAMP handle
 143   * @retval "0" for OPAMP1, "1" for OPAMP2, "2" for OPAMP3
 144   */
 145 #define __OPAMP_INSTANCE_DECIMAL__(__HANDLE__)                                 \
 146   ( ( ((__HANDLE__)->Instance == OPAMP1)                                       \
 147     )?                                                                         \
 148      ((uint32_t)0)                                                             \
 149      :                                                                         \
 150      ( ( ((__HANDLE__)->Instance == OPAMP2)                                    \
 151        )?                                                                      \
 152         ((uint32_t)1)                                                          \
 153         :                                                                      \
 154         ((uint32_t)2)                                                          \
 155      )                                                                         \
 156   )
 157 #else
 158 /**
 159   * @brief Get the OPAMP instance in decimal number for further
 160   * processing needs by HAL OPAMP driver functions.
 161   * @param __HANDLE__: OPAMP handle
 162   * @retval "0" for OPAMP1, "1" for OPAMP2
 163   */
 164 #define __OPAMP_INSTANCE_DECIMAL__(__HANDLE__)                                 \
 165   ( ( ((__HANDLE__)->Instance == OPAMP1)                                       \
 166     )?                                                                         \
 167      ((uint32_t)0)                                                             \
 168      :                                                                         \
 169      ((uint32_t)1)                                                             \
 170   )
 171 #endif /* STM32L151xD || STM32L152xD || STM32L162xD */
 172
 173 /**
 174   * @}
 175   */
 176
 177 /* Exported functions --------------------------------------------------------*/
 178 /** @addtogroup OPAMPEx_Exported_Functions
 179   * @{
 180   */
 181
 182 /* I/O operation functions  *****************************************************/
 183 /** @defgroup OPAMPEx_Exported_Functions_Group1 Extended IO operation functions
 184   * @{
 185   */
 186 #if defined (STM32L151xD) || defined (STM32L152xD) || defined (STM32L162xD)
 187 HAL_StatusTypeDef HAL_OPAMPEx_SelfCalibrateAll(OPAMP_HandleTypeDef *hopamp1, OPAMP_HandleTypeDef *hopamp2, OPAMP_HandleTypeDef *hopamp3);
 188 #else
 189 HAL_StatusTypeDef HAL_OPAMPEx_SelfCalibrateAll(OPAMP_HandleTypeDef *hopamp1, OPAMP_HandleTypeDef *hopamp2);
 190 #endif /* STM32L151xD || STM32L152xD || STM32L162xD */
 191 /**
 192   * @}
 193   */
 194 /* Peripheral Control functions  ************************************************/
 195 /** @addtogroup OPAMPEx_Exported_Functions_Group2
 196   * @{
 197   */
 198 HAL_StatusTypeDef HAL_OPAMPEx_Unlock(OPAMP_HandleTypeDef *hopamp);
 199
 200 /**
 201   * @}
 202   */
 203
 204 /**
 205   * @}
 206   */
 207
 208 /**
 209   * @}
 210   */
 211
 212 /**
 213   * @}
 214   */
 215
 216 #endif /* STM32L151xCA || STM32L151xD || STM32L152xCA || STM32L152xD || STM32L162xCA || STM32L162xD || STM32L151xE || STM32L152xE || STM32L162xE || STM32L162xC || STM32L152xC || STM32L151xC */
 217
 218 #ifdef __cplusplus
 219 }
 220 #endif
 221
 222
 223 #endif /* __STM32L1xx_HAL_OPAMP_EX_H */
 224
 225 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/