1 /**
2 ******************************************************************************
3 * @file stm32g0xx_ll_comp.c
4 * @author MCD Application Team
5 * @brief COMP LL module driver
6 ******************************************************************************
7 * @attention
8 *
9 * Copyright (c) 2018 STMicroelectronics.
10 * All rights reserved.
11 *
12 * This software is licensed under terms that can be found in the LICENSE file
13 * in the root directory of this software component.
14 * If no LICENSE file comes with this software, it is provided AS-IS.
15 *
16 ******************************************************************************
17 */
18
19 #if defined(USE_FULL_LL_DRIVER)
20
21 /* Includes ------------------------------------------------------------------*/
22 #include "stm32g0xx_ll_comp.h"
23
24 #ifdef USE_FULL_ASSERT
25 #include "stm32_assert.h"
26 #else
27 #define assert_param(expr) ((void)0U)
28 #endif /* USE_FULL_ASSERT */
29
30 /** @addtogroup STM32G0xx_LL_Driver
31 * @{
32 */
33
34 #if defined (COMP1) || defined (COMP2)
35
36 /** @addtogroup COMP_LL COMP
37 * @{
38 */
39
40 /* Private types -------------------------------------------------------------*/
41 /* Private variables ---------------------------------------------------------*/
42 /* Private constants ---------------------------------------------------------*/
43 /* Private macros ------------------------------------------------------------*/
44
45 /** @addtogroup COMP_LL_Private_Macros
46 * @{
47 */
48
49 /* Check of parameters for configuration of COMP hierarchical scope: */
50 /* COMP instance. */
51
52 #define IS_LL_COMP_POWER_MODE(__POWER_MODE__) \
53 (((__POWER_MODE__) == LL_COMP_POWERMODE_HIGHSPEED) \
54 || ((__POWER_MODE__) == LL_COMP_POWERMODE_MEDIUMSPEED) \
55 )
56
57 /* Note: On this STM32 series, comparator input plus parameters are */
58 /* the same on all COMP instances. */
59 /* However, comparator instance kept as macro parameter for */
60 /* compatibility with other STM32 families. */
61 #define IS_LL_COMP_INPUT_PLUS(__COMP_INSTANCE__, __INPUT_PLUS__) \
62 (((__INPUT_PLUS__) == LL_COMP_INPUT_PLUS_IO1) \
63 || ((__INPUT_PLUS__) == LL_COMP_INPUT_PLUS_IO2) \
64 || ((__INPUT_PLUS__) == LL_COMP_INPUT_PLUS_IO3) \
65 )
66
67 /* Note: On this STM32 series, comparator input minus parameters are */
68 /* the same on all COMP instances. */
69 /* However, comparator instance kept as macro parameter for */
70 /* compatibility with other STM32 families. */
71 #define IS_LL_COMP_INPUT_MINUS(__COMP_INSTANCE__, __INPUT_MINUS__) \
72 (((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_1_4VREFINT) \
73 || ((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_1_2VREFINT) \
74 || ((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_3_4VREFINT) \
75 || ((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_VREFINT) \
76 || ((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_DAC1_CH1) \
77 || ((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_DAC1_CH2) \
78 || ((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_IO1) \
79 || ((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_IO2) \
80 || ((__INPUT_MINUS__) == LL_COMP_INPUT_MINUS_IO3) \
81 )
82
83 #define IS_LL_COMP_INPUT_HYSTERESIS(__INPUT_HYSTERESIS__) \
84 (((__INPUT_HYSTERESIS__) == LL_COMP_HYSTERESIS_NONE) \
85 || ((__INPUT_HYSTERESIS__) == LL_COMP_HYSTERESIS_LOW) \
86 || ((__INPUT_HYSTERESIS__) == LL_COMP_HYSTERESIS_MEDIUM) \
87 || ((__INPUT_HYSTERESIS__) == LL_COMP_HYSTERESIS_HIGH) \
88 )
89
90 #define IS_LL_COMP_OUTPUT_POLARITY(__POLARITY__) \
91 (((__POLARITY__) == LL_COMP_OUTPUTPOL_NONINVERTED) \
92 || ((__POLARITY__) == LL_COMP_OUTPUTPOL_INVERTED) \
93 )
94
95 #define IS_LL_COMP_OUTPUT_BLANKING_SOURCE(__OUTPUT_BLANKING_SOURCE__) \
96 (((__OUTPUT_BLANKING_SOURCE__) == LL_COMP_BLANKINGSRC_NONE) \
97 || ((__OUTPUT_BLANKING_SOURCE__) == LL_COMP_BLANKINGSRC_TIM1_OC4) \
98 || ((__OUTPUT_BLANKING_SOURCE__) == LL_COMP_BLANKINGSRC_TIM1_OC5) \
99 || ((__OUTPUT_BLANKING_SOURCE__) == LL_COMP_BLANKINGSRC_TIM2_OC3) \
100 || ((__OUTPUT_BLANKING_SOURCE__) == LL_COMP_BLANKINGSRC_TIM3_OC3) \
101 || ((__OUTPUT_BLANKING_SOURCE__) == LL_COMP_BLANKINGSRC_TIM15_OC2) \
102 )
103
104 /**
105 * @}
106 */
107
108
109 /* Private function prototypes -----------------------------------------------*/
110
111 /* Exported functions --------------------------------------------------------*/
112 /** @addtogroup COMP_LL_Exported_Functions
113 * @{
114 */
115
116 /** @addtogroup COMP_LL_EF_Init
117 * @{
118 */
119
120 /**
121 * @brief De-initialize registers of the selected COMP instance
122 * to their default reset values.
123 * @note If comparator is locked, de-initialization by software is
124 * not possible.
125 * The only way to unlock the comparator is a device hardware reset.
126 * @param COMPx COMP instance
127 * @retval An ErrorStatus enumeration value:
128 * - SUCCESS: COMP registers are de-initialized
129 * - ERROR: COMP registers are not de-initialized
130 */
LL_COMP_DeInit(COMP_TypeDef * COMPx)131 ErrorStatus LL_COMP_DeInit(COMP_TypeDef *COMPx)
132 {
133 ErrorStatus status = SUCCESS;
134
135 /* Check the parameters */
136 assert_param(IS_COMP_ALL_INSTANCE(COMPx));
137
138 /* Note: Hardware constraint (refer to description of this function): */
139 /* COMP instance must not be locked. */
140 if (LL_COMP_IsLocked(COMPx) == 0UL)
141 {
142 LL_COMP_WriteReg(COMPx, CSR, 0x00000000UL);
143
144 }
145 else
146 {
147 /* Comparator instance is locked: de-initialization by software is */
148 /* not possible. */
149 /* The only way to unlock the comparator is a device hardware reset. */
150 status = ERROR;
151 }
152
153 return status;
154 }
155
156 /**
157 * @brief Initialize some features of COMP instance.
158 * @note This function configures features of the selected COMP instance.
159 * Some features are also available at scope COMP common instance
160 * (common to several COMP instances).
161 * Refer to functions having argument "COMPxy_COMMON" as parameter.
162 * @param COMPx COMP instance
163 * @param COMP_InitStruct Pointer to a @ref LL_COMP_InitTypeDef structure
164 * @retval An ErrorStatus enumeration value:
165 * - SUCCESS: COMP registers are initialized
166 * - ERROR: COMP registers are not initialized
167 */
LL_COMP_Init(COMP_TypeDef * COMPx,const LL_COMP_InitTypeDef * COMP_InitStruct)168 ErrorStatus LL_COMP_Init(COMP_TypeDef *COMPx, const LL_COMP_InitTypeDef *COMP_InitStruct)
169 {
170 ErrorStatus status = SUCCESS;
171
172 /* Check the parameters */
173 assert_param(IS_COMP_ALL_INSTANCE(COMPx));
174 assert_param(IS_LL_COMP_POWER_MODE(COMP_InitStruct->PowerMode));
175 assert_param(IS_LL_COMP_INPUT_PLUS(COMPx, COMP_InitStruct->InputPlus));
176 assert_param(IS_LL_COMP_INPUT_MINUS(COMPx, COMP_InitStruct->InputMinus));
177 assert_param(IS_LL_COMP_INPUT_HYSTERESIS(COMP_InitStruct->InputHysteresis));
178 assert_param(IS_LL_COMP_OUTPUT_POLARITY(COMP_InitStruct->OutputPolarity));
179 assert_param(IS_LL_COMP_OUTPUT_BLANKING_SOURCE(COMP_InitStruct->OutputBlankingSource));
180
181 /* Note: Hardware constraint (refer to description of this function) */
182 /* COMP instance must not be locked. */
183 if (LL_COMP_IsLocked(COMPx) == 0UL)
184 {
185 /* Configuration of comparator instance : */
186 /* - PowerMode */
187 /* - InputPlus */
188 /* - InputMinus */
189 /* - InputHysteresis */
190 /* - OutputPolarity */
191 /* - OutputBlankingSource */
192 MODIFY_REG(COMPx->CSR,
193 COMP_CSR_PWRMODE
194 | COMP_CSR_INPSEL
195 | COMP_CSR_INMSEL
196 | COMP_CSR_HYST
197 | COMP_CSR_POLARITY
198 | COMP_CSR_BLANKING
199 ,
200 COMP_InitStruct->PowerMode
201 | COMP_InitStruct->InputPlus
202 | COMP_InitStruct->InputMinus
203 | COMP_InitStruct->InputHysteresis
204 | COMP_InitStruct->OutputPolarity
205 | COMP_InitStruct->OutputBlankingSource
206 );
207
208 }
209 else
210 {
211 /* Initialization error: COMP instance is locked. */
212 status = ERROR;
213 }
214
215 return status;
216 }
217
218 /**
219 * @brief Set each @ref LL_COMP_InitTypeDef field to default value.
220 * @param COMP_InitStruct Pointer to a @ref LL_COMP_InitTypeDef structure
221 * whose fields will be set to default values.
222 * @retval None
223 */
LL_COMP_StructInit(LL_COMP_InitTypeDef * COMP_InitStruct)224 void LL_COMP_StructInit(LL_COMP_InitTypeDef *COMP_InitStruct)
225 {
226 /* Set COMP_InitStruct fields to default values */
227 COMP_InitStruct->PowerMode = LL_COMP_POWERMODE_MEDIUMSPEED;
228 COMP_InitStruct->InputPlus = LL_COMP_INPUT_PLUS_IO1;
229 COMP_InitStruct->InputMinus = LL_COMP_INPUT_MINUS_VREFINT;
230 COMP_InitStruct->InputHysteresis = LL_COMP_HYSTERESIS_NONE;
231 COMP_InitStruct->OutputPolarity = LL_COMP_OUTPUTPOL_NONINVERTED;
232 COMP_InitStruct->OutputBlankingSource = LL_COMP_BLANKINGSRC_NONE;
233 }
234
235 /**
236 * @}
237 */
238
239 /**
240 * @}
241 */
242
243 /**
244 * @}
245 */
246
247 #endif /* COMP1 || COMP2 */
248
249 /**
250 * @}
251 */
252
253 #endif /* USE_FULL_LL_DRIVER */
254
