1 /**
2   ******************************************************************************
3   * @file    stm32u5xx_hal_dac_ex.h
4   * @author  MCD Application Team
5   * @brief   Header file of DAC HAL Extended module.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2021 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 /* Define to prevent recursive inclusion -------------------------------------*/
20 #ifndef STM32U5xx_HAL_DAC_EX_H
21 #define STM32U5xx_HAL_DAC_EX_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /** @addtogroup STM32U5xx_HAL_Driver
28   * @{
29   */
30 
31 /* Includes ------------------------------------------------------------------*/
32 #include "stm32u5xx_hal_def.h"
33 
34 #if defined(DAC1)
35 
36 /** @addtogroup DACEx
37   * @{
38   */
39 
40 /* Exported types ------------------------------------------------------------*/
41 
42 /**
43   * @brief  DAC Autonomous Mode Configuration structure definition
44   */
45 typedef struct
46 {
47   uint32_t AutonomousModeState;    /*!< Specifies the autonomous mode state.
48                                         This parameter can be a value of @ref DAC_AutonomousMode */
49 
50 } DAC_AutonomousModeConfTypeDef;
51 
52 /**
53   * @brief  HAL State structures definition
54   */
55 
56 /* Exported constants --------------------------------------------------------*/
57 
58 /** @defgroup DACEx_Exported_Constants DACEx Exported Constants
59   * @{
60   */
61 
62 /** @defgroup DACEx_lfsrunmask_triangleamplitude DACEx lfsrunmask triangle amplitude
63   * @{
64   */
65 #define DAC_LFSRUNMASK_BIT0                0x00000000UL                                                        /*!< Unmask DAC channel LFSR bit0 for noise wave generation */
66 #define DAC_LFSRUNMASK_BITS1_0             (                                                   DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[1:0] for noise wave generation */
67 #define DAC_LFSRUNMASK_BITS2_0             (                                  DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[2:0] for noise wave generation */
68 #define DAC_LFSRUNMASK_BITS3_0             (                                  DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[3:0] for noise wave generation */
69 #define DAC_LFSRUNMASK_BITS4_0             (                 DAC_CR_MAMP1_2                                  ) /*!< Unmask DAC channel LFSR bit[4:0] for noise wave generation */
70 #define DAC_LFSRUNMASK_BITS5_0             (                 DAC_CR_MAMP1_2                  | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[5:0] for noise wave generation */
71 #define DAC_LFSRUNMASK_BITS6_0             (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[6:0] for noise wave generation */
72 #define DAC_LFSRUNMASK_BITS7_0             (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[7:0] for noise wave generation */
73 #define DAC_LFSRUNMASK_BITS8_0             (DAC_CR_MAMP1_3                                                   ) /*!< Unmask DAC channel LFSR bit[8:0] for noise wave generation */
74 #define DAC_LFSRUNMASK_BITS9_0             (DAC_CR_MAMP1_3                                   | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[9:0] for noise wave generation */
75 #define DAC_LFSRUNMASK_BITS10_0            (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[10:0] for noise wave generation */
76 #define DAC_LFSRUNMASK_BITS11_0            (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[11:0] for noise wave generation */
77 #define DAC_TRIANGLEAMPLITUDE_1            0x00000000UL                                                        /*!< Select max triangle amplitude of 1 */
78 #define DAC_TRIANGLEAMPLITUDE_3            (                                                   DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 3 */
79 #define DAC_TRIANGLEAMPLITUDE_7            (                                  DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 7 */
80 #define DAC_TRIANGLEAMPLITUDE_15           (                                  DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 15 */
81 #define DAC_TRIANGLEAMPLITUDE_31           (                 DAC_CR_MAMP1_2                                  ) /*!< Select max triangle amplitude of 31 */
82 #define DAC_TRIANGLEAMPLITUDE_63           (                 DAC_CR_MAMP1_2                  | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 63 */
83 #define DAC_TRIANGLEAMPLITUDE_127          (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 127 */
84 #define DAC_TRIANGLEAMPLITUDE_255          (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 255 */
85 #define DAC_TRIANGLEAMPLITUDE_511          (DAC_CR_MAMP1_3                                                   ) /*!< Select max triangle amplitude of 511 */
86 #define DAC_TRIANGLEAMPLITUDE_1023         (DAC_CR_MAMP1_3                                   | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 1023 */
87 #define DAC_TRIANGLEAMPLITUDE_2047         (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 2047 */
88 #define DAC_TRIANGLEAMPLITUDE_4095         (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 4095 */
89 
90 /**
91   * @}
92   */
93 
94 
95 /**
96   * @}
97   */
98 
99 /* Exported macro ------------------------------------------------------------*/
100 
101 
102 /* Private macro -------------------------------------------------------------*/
103 
104 /** @defgroup DACEx_Private_Macros DACEx Private Macros
105   * @{
106   */
107 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)            || \
108                                  ((TRIGGER) == DAC_TRIGGER_T1_TRGO)         || \
109                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO)         || \
110                                  ((TRIGGER) == DAC_TRIGGER_T4_TRGO)         || \
111                                  ((TRIGGER) == DAC_TRIGGER_T5_TRGO)         || \
112                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO)         || \
113                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO)         || \
114                                  ((TRIGGER) == DAC_TRIGGER_T8_TRGO)         || \
115                                  ((TRIGGER) == DAC_TRIGGER_T15_TRGO)        || \
116                                  ((TRIGGER) == DAC_TRIGGER_LPTIM1_CH1)      || \
117                                  ((TRIGGER) == DAC_TRIGGER_LPTIM3_CH1)      || \
118                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9)         || \
119                                  ((TRIGGER) == DAC_TRIGGER_STOP_LPTIM1_CH1) || \
120                                  ((TRIGGER) == DAC_TRIGGER_STOP_LPTIM3_CH1) || \
121                                  ((TRIGGER) == DAC_TRIGGER_STOP_EXT_IT9)    || \
122                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
123 
124 #define  IS_DAC_HIGH_FREQUENCY_MODE(MODE) (((MODE) == DAC_HIGH_FREQUENCY_INTERFACE_MODE_DISABLE)         || \
125                                            ((MODE) == DAC_HIGH_FREQUENCY_INTERFACE_MODE_ABOVE_80MHZ)     || \
126                                            ((MODE) == DAC_HIGH_FREQUENCY_INTERFACE_MODE_ABOVE_160MHZ)    || \
127                                            ((MODE) == DAC_HIGH_FREQUENCY_INTERFACE_MODE_AUTOMATIC))
128 
129 #define IS_DAC_SAMPLETIME(TIME) ((TIME) <= 0x000003FFU)
130 
131 #define IS_DAC_HOLDTIME(TIME)   ((TIME) <= 0x000003FFU)
132 
133 #define IS_DAC_SAMPLEANDHOLD(MODE) (((MODE) == DAC_SAMPLEANDHOLD_DISABLE) || \
134                                     ((MODE) == DAC_SAMPLEANDHOLD_ENABLE))
135 
136 #define IS_DAC_TRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
137 
138 #define IS_DAC_NEWTRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
139 
140 #define IS_DAC_CHIP_CONNECTION(CONNECT) (((CONNECT) == DAC_CHIPCONNECT_EXTERNAL) || \
141                                          ((CONNECT) == DAC_CHIPCONNECT_INTERNAL) || \
142                                          ((CONNECT) == DAC_CHIPCONNECT_BOTH))
143 
144 #define IS_DAC_TRIMMING(TRIMMING) (((TRIMMING) == DAC_TRIMMING_FACTORY) || \
145                                    ((TRIMMING) == DAC_TRIMMING_USER))
146 
147 #define IS_DAC_LFSR_UNMASK_TRIANGLE_AMPLITUDE(VALUE) (((VALUE) == DAC_LFSRUNMASK_BIT0) || \
148                                                       ((VALUE) == DAC_LFSRUNMASK_BITS1_0) || \
149                                                       ((VALUE) == DAC_LFSRUNMASK_BITS2_0) || \
150                                                       ((VALUE) == DAC_LFSRUNMASK_BITS3_0) || \
151                                                       ((VALUE) == DAC_LFSRUNMASK_BITS4_0) || \
152                                                       ((VALUE) == DAC_LFSRUNMASK_BITS5_0) || \
153                                                       ((VALUE) == DAC_LFSRUNMASK_BITS6_0) || \
154                                                       ((VALUE) == DAC_LFSRUNMASK_BITS7_0) || \
155                                                       ((VALUE) == DAC_LFSRUNMASK_BITS8_0) || \
156                                                       ((VALUE) == DAC_LFSRUNMASK_BITS9_0) || \
157                                                       ((VALUE) == DAC_LFSRUNMASK_BITS10_0) || \
158                                                       ((VALUE) == DAC_LFSRUNMASK_BITS11_0) || \
159                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_1) || \
160                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_3) || \
161                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_7) || \
162                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_15) || \
163                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_31) || \
164                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_63) || \
165                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_127) || \
166                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_255) || \
167                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_511) || \
168                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_1023) || \
169                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_2047) || \
170                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_4095))
171 
172 #define IS_DAC_AUTONOMOUS(AUTONOMOUS) (((AUTONOMOUS) == DAC_AUTONOMOUS_MODE_DISABLE) || \
173                                        ((AUTONOMOUS) == DAC_AUTONOMOUS_MODE_ENABLE))
174 /**
175   * @}
176   */
177 
178 /* Exported functions --------------------------------------------------------*/
179 /* Extended features functions ***********************************************/
180 
181 /** @addtogroup DACEx_Exported_Functions
182   * @{
183   */
184 
185 /** @addtogroup DACEx_Exported_Functions_Group2
186   * @{
187   */
188 /* IO operation functions *****************************************************/
189 
190 HAL_StatusTypeDef HAL_DACEx_TriangleWaveGenerate(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Amplitude);
191 HAL_StatusTypeDef HAL_DACEx_NoiseWaveGenerate(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Amplitude);
192 
193 HAL_StatusTypeDef HAL_DACEx_DualStart(DAC_HandleTypeDef *hdac);
194 HAL_StatusTypeDef HAL_DACEx_DualStop(DAC_HandleTypeDef *hdac);
195 HAL_StatusTypeDef HAL_DACEx_DualStart_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel,
196                                           const uint32_t *pData, uint32_t Length, uint32_t Alignment);
197 HAL_StatusTypeDef HAL_DACEx_DualStop_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel);
198 HAL_StatusTypeDef HAL_DACEx_DualSetValue(DAC_HandleTypeDef *hdac, uint32_t Alignment, uint32_t Data1, uint32_t Data2);
199 uint32_t HAL_DACEx_DualGetValue(const DAC_HandleTypeDef *hdac);
200 
201 void HAL_DACEx_ConvCpltCallbackCh2(DAC_HandleTypeDef *hdac);
202 void HAL_DACEx_ConvHalfCpltCallbackCh2(DAC_HandleTypeDef *hdac);
203 void HAL_DACEx_ErrorCallbackCh2(DAC_HandleTypeDef *hdac);
204 void HAL_DACEx_DMAUnderrunCallbackCh2(DAC_HandleTypeDef *hdac);
205 
206 
207 /**
208   * @}
209   */
210 
211 /** @addtogroup DACEx_Exported_Functions_Group3
212   * @{
213   */
214 /* Peripheral Control functions ***********************************************/
215 
216 HAL_StatusTypeDef HAL_DACEx_SelfCalibrate(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel);
217 HAL_StatusTypeDef HAL_DACEx_SetUserTrimming(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel,
218                                             uint32_t NewTrimmingValue);
219 uint32_t HAL_DACEx_GetTrimOffset(const DAC_HandleTypeDef *hdac, uint32_t Channel);
220 
221 /* Autonomous Mode Control functions  **********************************************/
222 HAL_StatusTypeDef HAL_DACEx_SetConfigAutonomousMode(DAC_HandleTypeDef *hdac,
223                                                     const DAC_AutonomousModeConfTypeDef *sConfig);
224 HAL_StatusTypeDef HAL_DACEx_GetConfigAutonomousMode(const DAC_HandleTypeDef *hdac,
225                                                     DAC_AutonomousModeConfTypeDef *sConfig);
226 HAL_StatusTypeDef HAL_DACEx_ClearConfigAutonomousMode(DAC_HandleTypeDef *hdac);
227 
228 /**
229   * @}
230   */
231 
232 /**
233   * @}
234   */
235 
236 /** @addtogroup DACEx_Private_Functions
237   * @{
238   */
239 
240 /* DAC_DMAConvCpltCh2 / DAC_DMAErrorCh2 / DAC_DMAHalfConvCpltCh2 */
241 /* are called by HAL_DAC_Start_DMA */
242 void DAC_DMAConvCpltCh2(DMA_HandleTypeDef *hdma);
243 void DAC_DMAErrorCh2(DMA_HandleTypeDef *hdma);
244 void DAC_DMAHalfConvCpltCh2(DMA_HandleTypeDef *hdma);
245 
246 /**
247   * @}
248   */
249 
250 /**
251   * @}
252   */
253 
254 #endif /* DAC1 */
255 
256 /**
257   * @}
258   */
259 
260 #ifdef __cplusplus
261 }
262 #endif
263 
264 #endif /* STM32U5xx_HAL_DAC_EX_H */
265