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