stm32l1xx_hal_opamp_ex.h 12 KB

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