Mercurial > public > ostc4

comparison Common/Drivers/STM32F4xx_HAL_DRIVER_v120/Inc/stm32f4xx_hal_dac.h @ 38:5f11787b4f42

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