1 /**
2   ******************************************************************************
3   * @file    stm32f7xx_hal_dac.h
4   * @author  MCD Application Team
5   * @version V1.0.1
6   * @date    25-June-2015
7   * @brief   Header file of DAC HAL module.
8   ******************************************************************************
9   * @attention
10   *
11   * <h2><center>&copy; COPYRIGHT(c) 2015 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 __STM32F7xx_HAL_DAC_H
40 #define __STM32F7xx_HAL_DAC_H
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f7xx_hal_def.h"
48 
49 /** @addtogroup STM32F7xx_HAL_Driver
50   * @{
51   */
52 
53 /** @addtogroup DAC
54   * @{
55   */
56 
57 /* Exported types ------------------------------------------------------------*/
58 /** @defgroup DAC_Exported_Types DAC Exported Types
59   * @{
60   */
61 
62 /**
63   * @brief HAL State structures definition
64   */
65 typedef enum {
66     HAL_DAC_STATE_RESET             = 0x00,  /*!< DAC not yet initialized or disabled  */
67     HAL_DAC_STATE_READY             = 0x01,  /*!< DAC initialized and ready for use    */
68     HAL_DAC_STATE_BUSY              = 0x02,  /*!< DAC internal processing is ongoing   */
69     HAL_DAC_STATE_TIMEOUT           = 0x03,  /*!< DAC timeout state                    */
70     HAL_DAC_STATE_ERROR             = 0x04   /*!< DAC error state                      */
71 } HAL_DAC_StateTypeDef;
72 
73 /**
74   * @brief DAC handle Structure definition
75   */
76 typedef struct {
77     DAC_TypeDef                 *Instance;     /*!< Register base address             */
78 
79     __IO HAL_DAC_StateTypeDef   State;         /*!< DAC communication state           */
80 
81     HAL_LockTypeDef             Lock;          /*!< DAC locking object                */
82 
83     DMA_HandleTypeDef           *DMA_Handle1;  /*!< Pointer DMA handler for channel 1 */
84 
85     DMA_HandleTypeDef           *DMA_Handle2;  /*!< Pointer DMA handler for channel 2 */
86 
87     __IO uint32_t               ErrorCode;     /*!< DAC Error code                    */
88 
89 } DAC_HandleTypeDef;
90 
91 /**
92   * @brief DAC Configuration regular Channel structure definition
93   */
94 typedef struct {
95     uint32_t DAC_Trigger;       /*!< Specifies the external trigger for the selected DAC channel.
96                                    This parameter can be a value of @ref DAC_trigger_selection */
97 
98     uint32_t DAC_OutputBuffer;  /*!< Specifies whether the DAC channel output buffer is enabled or disabled.
99                                    This parameter can be a value of @ref DAC_output_buffer */
100 } DAC_ChannelConfTypeDef;
101 /**
102   * @}
103   */
104 
105 /* Exported constants --------------------------------------------------------*/
106 /** @defgroup DAC_Exported_Constants DAC Exported Constants
107   * @{
108   */
109 
110 /** @defgroup DAC_Error_Code DAC Error Code
111   * @{
112   */
113 #define  HAL_DAC_ERROR_NONE              0x00    /*!< No error                          */
114 #define  HAL_DAC_ERROR_DMAUNDERRUNCH1    0x01    /*!< DAC channel1 DAM underrun error   */
115 #define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02    /*!< DAC channel2 DAM underrun error   */
116 #define  HAL_DAC_ERROR_DMA               0x04    /*!< DMA error                         */
117 /**
118   * @}
119   */
120 
121 /** @defgroup DAC_trigger_selection DAC Trigger Selection
122   * @{
123   */
124 
125 #define DAC_TRIGGER_NONE                   ((uint32_t)0x00000000) /*!< Conversion is automatic once the DAC1_DHRxxxx register
126                                                                        has been loaded, and not by external trigger */
127 #define DAC_TRIGGER_T2_TRGO                ((uint32_t)(DAC_CR_TSEL1_2 | DAC_CR_TEN1)) /*!< TIM2 TRGO selected as external conversion trigger for DAC channel */
128 #define DAC_TRIGGER_T4_TRGO                ((uint32_t)(DAC_CR_TSEL1_2 | DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM4 TRGO selected as external conversion trigger for DAC channel */
129 #define DAC_TRIGGER_T5_TRGO                ((uint32_t)(DAC_CR_TSEL1_1 | DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM5 TRGO selected as external conversion trigger for DAC channel */
130 #define DAC_TRIGGER_T6_TRGO                ((uint32_t)DAC_CR_TEN1) /*!< TIM6 TRGO selected as external conversion trigger for DAC channel */
131 #define DAC_TRIGGER_T7_TRGO                ((uint32_t)(DAC_CR_TSEL1_1 | DAC_CR_TEN1)) /*!< TIM7 TRGO selected as external conversion trigger for DAC channel */
132 #define DAC_TRIGGER_T8_TRGO                ((uint32_t)(DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM8 TRGO selected as external conversion trigger for DAC channel */
133 
134 #define DAC_TRIGGER_EXT_IT9                ((uint32_t)(DAC_CR_TSEL1_2 | DAC_CR_TSEL1_1 | DAC_CR_TEN1)) /*!< EXTI Line9 event selected as external conversion trigger for DAC channel */
135 #define DAC_TRIGGER_SOFTWARE               ((uint32_t)(DAC_CR_TSEL1 | DAC_CR_TEN1)) /*!< Conversion started by software trigger for DAC channel */
136 /**
137   * @}
138   */
139 
140 /** @defgroup DAC_output_buffer  DAC Output Buffer
141   * @{
142   */
143 #define DAC_OUTPUTBUFFER_ENABLE            ((uint32_t)0x00000000)
144 #define DAC_OUTPUTBUFFER_DISABLE           ((uint32_t)DAC_CR_BOFF1)
145 /**
146   * @}
147   */
148 
149 /** @defgroup DAC_Channel_selection DAC Channel Selection
150   * @{
151   */
152 #define DAC_CHANNEL_1                      ((uint32_t)0x00000000)
153 #define DAC_CHANNEL_2                      ((uint32_t)0x00000010)
154 /**
155   * @}
156   */
157 
158 /** @defgroup DAC_data_alignment DAC Data Alignment
159   * @{
160   */
161 #define DAC_ALIGN_12B_R                    ((uint32_t)0x00000000)
162 #define DAC_ALIGN_12B_L                    ((uint32_t)0x00000004)
163 #define DAC_ALIGN_8B_R                     ((uint32_t)0x00000008)
164 /**
165   * @}
166   */
167 
168 /** @defgroup DAC_flags_definition DAC Flags Definition
169   * @{
170   */
171 #define DAC_FLAG_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
172 #define DAC_FLAG_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
173 /**
174   * @}
175   */
176 
177 /** @defgroup DAC_IT_definition DAC IT Definition
178   * @{
179   */
180 #define DAC_IT_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
181 #define DAC_IT_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
182 /**
183   * @}
184   */
185 
186 /**
187   * @}
188   */
189 
190 /* Exported macro ------------------------------------------------------------*/
191 /** @defgroup DAC_Exported_Macros DAC Exported Macros
192   * @{
193   */
194 
195 /** @brief Reset DAC handle state
196   * @param  __HANDLE__: specifies the DAC handle.
197   * @retval None
198   */
199 #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET)
200 
201 /** @brief Enable the DAC channel
202   * @param  __HANDLE__: specifies the DAC handle.
203   * @param  __DAC_CHANNEL__: specifies the DAC channel
204   * @retval None
205   */
206 #define __HAL_DAC_ENABLE(__HANDLE__, __DAC_CHANNEL__) \
207 ((__HANDLE__)->Instance->CR |=  (DAC_CR_EN1 << (__DAC_CHANNEL__)))
208 
209 /** @brief Disable the DAC channel
210   * @param  __HANDLE__: specifies the DAC handle
211   * @param  __DAC_CHANNEL__: specifies the DAC channel.
212   * @retval None
213   */
214 #define __HAL_DAC_DISABLE(__HANDLE__, __DAC_CHANNEL__) \
215 ((__HANDLE__)->Instance->CR &=  ~(DAC_CR_EN1 << (__DAC_CHANNEL__)))
216 
217 
218 /** @brief Enable the DAC interrupt
219   * @param  __HANDLE__: specifies the DAC handle
220   * @param  __INTERRUPT__: specifies the DAC interrupt.
221   * @retval None
222   */
223 #define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
224 
225 /** @brief Disable the DAC interrupt
226   * @param  __HANDLE__: specifies the DAC handle
227   * @param  __INTERRUPT__: specifies the DAC interrupt.
228   * @retval None
229   */
230 #define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
231 
232 /** @brief  Checks if the specified DAC interrupt source is enabled or disabled.
233   * @param __HANDLE__: DAC handle
234   * @param __INTERRUPT__: DAC interrupt source to check
235   *          This parameter can be any combination of the following values:
236   *            @arg DAC_IT_DMAUDR1: DAC channel 1 DMA underrun interrupt
237   *            @arg DAC_IT_DMAUDR2: DAC channel 2 DMA underrun interrupt
238   * @retval State of interruption (SET or RESET)
239   */
240 #define __HAL_DAC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR & (__INTERRUPT__)) == (__INTERRUPT__))
241 
242 /** @brief  Get the selected DAC's flag status.
243   * @param  __HANDLE__: specifies the DAC handle.
244   * @param  __FLAG__: specifies the flag to clear.
245   *         This parameter can be any combination of the following values:
246   *            @arg DAC_FLAG_DMAUDR1: DMA underrun 1 flag
247   *            @arg DAC_FLAG_DMAUDR2: DMA underrun 2 flag
248   * @retval None
249   */
250 #define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
251 
252 /** @brief  Clear the DAC's flag.
253   * @param  __HANDLE__: specifies the DAC handle.
254   * @param  __FLAG__: specifies the flag to clear.
255   *         This parameter can be any combination of the following values:
256   *            @arg DAC_FLAG_DMAUDR1: DMA underrun 1 flag
257   *            @arg DAC_FLAG_DMAUDR2: DMA underrun 2 flag
258   * @retval None
259   */
260 #define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__))
261 /**
262   * @}
263   */
264 
265 /* Include DAC HAL Extension module */
266 #include "stm32f7xx_hal_dac_ex.h"
267 
268 /* Exported functions --------------------------------------------------------*/
269 /** @addtogroup DAC_Exported_Functions
270   * @{
271   */
272 
273 /** @addtogroup DAC_Exported_Functions_Group1
274   * @{
275   */
276 /* Initialization/de-initialization functions *********************************/
277 HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef* hdac);
278 HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef* hdac);
279 void HAL_DAC_MspInit(DAC_HandleTypeDef* hdac);
280 void HAL_DAC_MspDeInit(DAC_HandleTypeDef* hdac);
281 /**
282   * @}
283   */
284 
285 /** @addtogroup DAC_Exported_Functions_Group2
286   * @{
287   */
288 /* I/O operation functions ****************************************************/
289 HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef* hdac, uint32_t Channel);
290 HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef* hdac, uint32_t Channel);
291 HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t* pData, uint32_t Length, uint32_t Alignment);
292 HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel);
293 uint32_t HAL_DAC_GetValue(DAC_HandleTypeDef* hdac, uint32_t Channel);
294 /**
295   * @}
296   */
297 
298 /** @addtogroup DAC_Exported_Functions_Group3
299   * @{
300   */
301 /* Peripheral Control functions ***********************************************/
302 HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef* hdac, DAC_ChannelConfTypeDef* sConfig, uint32_t Channel);
303 HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data);
304 /**
305   * @}
306   */
307 
308 /** @addtogroup DAC_Exported_Functions_Group4
309   * @{
310   */
311 /* Peripheral State functions *************************************************/
312 HAL_DAC_StateTypeDef HAL_DAC_GetState(DAC_HandleTypeDef* hdac);
313 void HAL_DAC_IRQHandler(DAC_HandleTypeDef* hdac);
314 uint32_t HAL_DAC_GetError(DAC_HandleTypeDef *hdac);
315 
316 void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef* hdac);
317 void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef* hdac);
318 void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);
319 void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);
320 /**
321   * @}
322   */
323 
324 /**
325   * @}
326   */
327 /* Private types -------------------------------------------------------------*/
328 /* Private variables ---------------------------------------------------------*/
329 /* Private constants ---------------------------------------------------------*/
330 /** @defgroup DAC_Private_Constants DAC Private Constants
331   * @{
332   */
333 
334 /**
335   * @}
336   */
337 
338 /* Private macros ------------------------------------------------------------*/
339 /** @defgroup DAC_Private_Macros DAC Private Macros
340   * @{
341   */
342 #define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0)
343 #define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \
344                              ((ALIGN) == DAC_ALIGN_12B_L) || \
345                              ((ALIGN) == DAC_ALIGN_8B_R))
346 #define IS_DAC_CHANNEL(CHANNEL) (((CHANNEL) == DAC_CHANNEL_1) || \
347                                  ((CHANNEL) == DAC_CHANNEL_2))
348 #define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
349                                            ((STATE) == DAC_OUTPUTBUFFER_DISABLE))
350 
351 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE) || \
352                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO) || \
353                                  ((TRIGGER) == DAC_TRIGGER_T8_TRGO) || \
354                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO) || \
355                                  ((TRIGGER) == DAC_TRIGGER_T5_TRGO) || \
356                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO) || \
357                                  ((TRIGGER) == DAC_TRIGGER_T4_TRGO) || \
358                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9) || \
359                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
360 
361 /** @brief Set DHR12R1 alignment
362   * @param  __ALIGNMENT__: specifies the DAC alignment
363   * @retval None
364   */
365 #define DAC_DHR12R1_ALIGNMENT(__ALIGNMENT__) (((uint32_t)0x00000008) + (__ALIGNMENT__))
366 
367 /** @brief  Set DHR12R2 alignment
368   * @param  __ALIGNMENT__: specifies the DAC alignment
369   * @retval None
370   */
371 #define DAC_DHR12R2_ALIGNMENT(__ALIGNMENT__) (((uint32_t)0x00000014) + (__ALIGNMENT__))
372 
373 /** @brief  Set DHR12RD alignment
374   * @param  __ALIGNMENT__: specifies the DAC alignment
375   * @retval None
376   */
377 #define DAC_DHR12RD_ALIGNMENT(__ALIGNMENT__) (((uint32_t)0x00000020) + (__ALIGNMENT__))
378 
379 /**
380   * @}
381   */
382 
383 /* Private functions ---------------------------------------------------------*/
384 /** @defgroup DAC_Private_Functions DAC Private Functions
385   * @{
386   */
387 /**
388   * @}
389   */
390 
391 /**
392   * @}
393   */
394 
395 /**
396   * @}
397   */
398 
399 #ifdef __cplusplus
400 }
401 #endif
402 
403 #endif /*__STM32F7xx_HAL_DAC_H */
404 
405 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
406