1 /** 2 ****************************************************************************** 3 * @file stm32f4xx_hal_dac.h 4 * @author MCD Application Team 5 * @brief Header file of DAC HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2016 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 STM32F4xx_HAL_DAC_H 21 #define STM32F4xx_HAL_DAC_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /** @addtogroup STM32F4xx_HAL_Driver 28 * @{ 29 */ 30 31 /* Includes ------------------------------------------------------------------*/ 32 #include "stm32f4xx_hal_def.h" 33 34 #if defined(DAC) 35 36 /** @addtogroup DAC 37 * @{ 38 */ 39 40 /* Exported types ------------------------------------------------------------*/ 41 42 /** @defgroup DAC_Exported_Types DAC Exported Types 43 * @{ 44 */ 45 46 /** 47 * @brief HAL State structures definition 48 */ 49 typedef enum 50 { 51 HAL_DAC_STATE_RESET = 0x00U, /*!< DAC not yet initialized or disabled */ 52 HAL_DAC_STATE_READY = 0x01U, /*!< DAC initialized and ready for use */ 53 HAL_DAC_STATE_BUSY = 0x02U, /*!< DAC internal processing is ongoing */ 54 HAL_DAC_STATE_TIMEOUT = 0x03U, /*!< DAC timeout state */ 55 HAL_DAC_STATE_ERROR = 0x04U /*!< DAC error state */ 56 57 } HAL_DAC_StateTypeDef; 58 59 /** 60 * @brief DAC handle Structure definition 61 */ 62 #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1) 63 typedef struct __DAC_HandleTypeDef 64 #else 65 typedef struct 66 #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */ 67 { 68 DAC_TypeDef *Instance; /*!< Register base address */ 69 70 __IO HAL_DAC_StateTypeDef State; /*!< DAC communication state */ 71 72 HAL_LockTypeDef Lock; /*!< DAC locking object */ 73 74 DMA_HandleTypeDef *DMA_Handle1; /*!< Pointer DMA handler for channel 1 */ 75 76 DMA_HandleTypeDef *DMA_Handle2; /*!< Pointer DMA handler for channel 2 */ 77 78 __IO uint32_t ErrorCode; /*!< DAC Error code */ 79 80 #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1) 81 void (* ConvCpltCallbackCh1) (struct __DAC_HandleTypeDef *hdac); 82 void (* ConvHalfCpltCallbackCh1) (struct __DAC_HandleTypeDef *hdac); 83 void (* ErrorCallbackCh1) (struct __DAC_HandleTypeDef *hdac); 84 void (* DMAUnderrunCallbackCh1) (struct __DAC_HandleTypeDef *hdac); 85 #if defined(DAC_CHANNEL2_SUPPORT) 86 void (* ConvCpltCallbackCh2) (struct __DAC_HandleTypeDef *hdac); 87 void (* ConvHalfCpltCallbackCh2) (struct __DAC_HandleTypeDef *hdac); 88 void (* ErrorCallbackCh2) (struct __DAC_HandleTypeDef *hdac); 89 void (* DMAUnderrunCallbackCh2) (struct __DAC_HandleTypeDef *hdac); 90 #endif /* DAC_CHANNEL2_SUPPORT */ 91 92 void (* MspInitCallback) (struct __DAC_HandleTypeDef *hdac); 93 void (* MspDeInitCallback) (struct __DAC_HandleTypeDef *hdac); 94 #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */ 95 96 } DAC_HandleTypeDef; 97 98 /** 99 * @brief DAC Configuration regular Channel structure definition 100 */ 101 typedef struct 102 { 103 uint32_t DAC_Trigger; /*!< Specifies the external trigger for the selected DAC channel. 104 This parameter can be a value of @ref DAC_trigger_selection */ 105 106 uint32_t DAC_OutputBuffer; /*!< Specifies whether the DAC channel output buffer is enabled or disabled. 107 This parameter can be a value of @ref DAC_output_buffer */ 108 109 } DAC_ChannelConfTypeDef; 110 111 #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1) 112 /** 113 * @brief HAL DAC Callback ID enumeration definition 114 */ 115 typedef enum 116 { 117 HAL_DAC_CH1_COMPLETE_CB_ID = 0x00U, /*!< DAC CH1 Complete Callback ID */ 118 HAL_DAC_CH1_HALF_COMPLETE_CB_ID = 0x01U, /*!< DAC CH1 half Complete Callback ID */ 119 HAL_DAC_CH1_ERROR_ID = 0x02U, /*!< DAC CH1 error Callback ID */ 120 HAL_DAC_CH1_UNDERRUN_CB_ID = 0x03U, /*!< DAC CH1 underrun Callback ID */ 121 #if defined(DAC_CHANNEL2_SUPPORT) 122 HAL_DAC_CH2_COMPLETE_CB_ID = 0x04U, /*!< DAC CH2 Complete Callback ID */ 123 HAL_DAC_CH2_HALF_COMPLETE_CB_ID = 0x05U, /*!< DAC CH2 half Complete Callback ID */ 124 HAL_DAC_CH2_ERROR_ID = 0x06U, /*!< DAC CH2 error Callback ID */ 125 HAL_DAC_CH2_UNDERRUN_CB_ID = 0x07U, /*!< DAC CH2 underrun Callback ID */ 126 #endif /* DAC_CHANNEL2_SUPPORT */ 127 HAL_DAC_MSPINIT_CB_ID = 0x08U, /*!< DAC MspInit Callback ID */ 128 HAL_DAC_MSPDEINIT_CB_ID = 0x09U, /*!< DAC MspDeInit Callback ID */ 129 HAL_DAC_ALL_CB_ID = 0x0AU /*!< DAC All ID */ 130 } HAL_DAC_CallbackIDTypeDef; 131 132 /** 133 * @brief HAL DAC Callback pointer definition 134 */ 135 typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac); 136 #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */ 137 138 /** 139 * @} 140 */ 141 142 /* Exported constants --------------------------------------------------------*/ 143 144 /** @defgroup DAC_Exported_Constants DAC Exported Constants 145 * @{ 146 */ 147 148 /** @defgroup DAC_Error_Code DAC Error Code 149 * @{ 150 */ 151 #define HAL_DAC_ERROR_NONE 0x00U /*!< No error */ 152 #define HAL_DAC_ERROR_DMAUNDERRUNCH1 0x01U /*!< DAC channel1 DMA underrun error */ 153 #if defined(DAC_CHANNEL2_SUPPORT) 154 #define HAL_DAC_ERROR_DMAUNDERRUNCH2 0x02U /*!< DAC channel2 DMA underrun error */ 155 #endif /* DAC_CHANNEL2_SUPPORT */ 156 #define HAL_DAC_ERROR_DMA 0x04U /*!< DMA error */ 157 #define HAL_DAC_ERROR_TIMEOUT 0x08U /*!< Timeout error */ 158 #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1) 159 #define HAL_DAC_ERROR_INVALID_CALLBACK 0x10U /*!< Invalid callback error */ 160 #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */ 161 162 /** 163 * @} 164 */ 165 166 /** @defgroup DAC_trigger_selection DAC trigger selection 167 * @{ 168 */ 169 #define DAC_TRIGGER_NONE 0x00000000UL /*!< Conversion is automatic once the DAC1_DHRxxxx register has been loaded, and not by external trigger */ 170 #define DAC_TRIGGER_T2_TRGO (DAC_CR_TSEL1_2 | DAC_CR_TEN1) /*!< TIM2 TRGO selected as external conversion trigger for DAC channel */ 171 #define DAC_TRIGGER_T4_TRGO (DAC_CR_TSEL1_2 | DAC_CR_TSEL1_0 | DAC_CR_TEN1) /*!< TIM4 TRGO selected as external conversion trigger for DAC channel */ 172 #define DAC_TRIGGER_T5_TRGO ( DAC_CR_TSEL1_1 | DAC_CR_TSEL1_0 | DAC_CR_TEN1) /*!< TIM3 TRGO selected as external conversion trigger for DAC channel */ 173 #define DAC_TRIGGER_T6_TRGO ( DAC_CR_TEN1) /*!< Conversion started by software trigger for DAC channel */ 174 #define DAC_TRIGGER_T7_TRGO ( DAC_CR_TSEL1_1 | DAC_CR_TEN1) /*!< TIM7 TRGO selected as external conversion trigger for DAC channel */ 175 #define DAC_TRIGGER_T8_TRGO ( DAC_CR_TSEL1_0 | DAC_CR_TEN1) /*!< TIM8 TRGO selected as external conversion trigger for DAC channel */ 176 #define DAC_TRIGGER_EXT_IT9 (DAC_CR_TSEL1_2 | DAC_CR_TSEL1_1 | DAC_CR_TEN1) /*!< EXTI Line9 event selected as external conversion trigger for DAC channel */ 177 #define DAC_TRIGGER_SOFTWARE (DAC_CR_TSEL1 | DAC_CR_TEN1) /*!< Conversion started by software trigger for DAC channel */ 178 179 /** 180 * @} 181 */ 182 183 /** @defgroup DAC_output_buffer DAC output buffer 184 * @{ 185 */ 186 #define DAC_OUTPUTBUFFER_ENABLE 0x00000000U 187 #define DAC_OUTPUTBUFFER_DISABLE (DAC_CR_BOFF1) 188 189 /** 190 * @} 191 */ 192 193 /** @defgroup DAC_Channel_selection DAC Channel selection 194 * @{ 195 */ 196 #define DAC_CHANNEL_1 0x00000000U 197 #if defined(DAC_CHANNEL2_SUPPORT) 198 #define DAC_CHANNEL_2 0x00000010U 199 #endif /* DAC_CHANNEL2_SUPPORT */ 200 /** 201 * @} 202 */ 203 204 /** @defgroup DAC_data_alignment DAC data alignment 205 * @{ 206 */ 207 #define DAC_ALIGN_12B_R 0x00000000U 208 #define DAC_ALIGN_12B_L 0x00000004U 209 #define DAC_ALIGN_8B_R 0x00000008U 210 211 /** 212 * @} 213 */ 214 215 /** @defgroup DAC_flags_definition DAC flags definition 216 * @{ 217 */ 218 #define DAC_FLAG_DMAUDR1 (DAC_SR_DMAUDR1) 219 #if defined(DAC_CHANNEL2_SUPPORT) 220 #define DAC_FLAG_DMAUDR2 (DAC_SR_DMAUDR2) 221 #endif /* DAC_CHANNEL2_SUPPORT */ 222 223 /** 224 * @} 225 */ 226 227 /** @defgroup DAC_IT_definition DAC IT definition 228 * @{ 229 */ 230 #define DAC_IT_DMAUDR1 (DAC_SR_DMAUDR1) 231 #if defined(DAC_CHANNEL2_SUPPORT) 232 #define DAC_IT_DMAUDR2 (DAC_SR_DMAUDR2) 233 #endif /* DAC_CHANNEL2_SUPPORT */ 234 235 /** 236 * @} 237 */ 238 239 /** 240 * @} 241 */ 242 243 /* Exported macro ------------------------------------------------------------*/ 244 245 /** @defgroup DAC_Exported_Macros DAC Exported Macros 246 * @{ 247 */ 248 249 /** @brief Reset DAC handle state. 250 * @param __HANDLE__ specifies the DAC handle. 251 * @retval None 252 */ 253 #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1) 254 #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) do { \ 255 (__HANDLE__)->State = HAL_DAC_STATE_RESET; \ 256 (__HANDLE__)->MspInitCallback = NULL; \ 257 (__HANDLE__)->MspDeInitCallback = NULL; \ 258 } while(0) 259 #else 260 #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET) 261 #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */ 262 263 /** @brief Enable the DAC channel. 264 * @param __HANDLE__ specifies the DAC handle. 265 * @param __DAC_Channel__ specifies the DAC channel 266 * @retval None 267 */ 268 #define __HAL_DAC_ENABLE(__HANDLE__, __DAC_Channel__) \ 269 ((__HANDLE__)->Instance->CR |= (DAC_CR_EN1 << ((__DAC_Channel__) & 0x10UL))) 270 271 /** @brief Disable the DAC channel. 272 * @param __HANDLE__ specifies the DAC handle 273 * @param __DAC_Channel__ specifies the DAC channel. 274 * @retval None 275 */ 276 #define __HAL_DAC_DISABLE(__HANDLE__, __DAC_Channel__) \ 277 ((__HANDLE__)->Instance->CR &= ~(DAC_CR_EN1 << ((__DAC_Channel__) & 0x10UL))) 278 279 /** @brief Set DHR12R1 alignment. 280 * @param __ALIGNMENT__ specifies the DAC alignment 281 * @retval None 282 */ 283 #define DAC_DHR12R1_ALIGNMENT(__ALIGNMENT__) (0x00000008UL + (__ALIGNMENT__)) 284 285 #if defined(DAC_CHANNEL2_SUPPORT) 286 /** @brief Set DHR12R2 alignment. 287 * @param __ALIGNMENT__ specifies the DAC alignment 288 * @retval None 289 */ 290 #define DAC_DHR12R2_ALIGNMENT(__ALIGNMENT__) (0x00000014UL + (__ALIGNMENT__)) 291 #endif /* DAC_CHANNEL2_SUPPORT */ 292 293 /** @brief Set DHR12RD alignment. 294 * @param __ALIGNMENT__ specifies the DAC alignment 295 * @retval None 296 */ 297 #define DAC_DHR12RD_ALIGNMENT(__ALIGNMENT__) (0x00000020UL + (__ALIGNMENT__)) 298 299 /** @brief Enable the DAC interrupt. 300 * @param __HANDLE__ specifies the DAC handle 301 * @param __INTERRUPT__ specifies the DAC interrupt. 302 * This parameter can be any combination of the following values: 303 * @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt 304 * @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt 305 * @retval None 306 */ 307 #define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__)) 308 309 /** @brief Disable the DAC interrupt. 310 * @param __HANDLE__ specifies the DAC handle 311 * @param __INTERRUPT__ specifies the DAC interrupt. 312 * This parameter can be any combination of the following values: 313 * @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt 314 * @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt 315 * @retval None 316 */ 317 #define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__)) 318 319 /** @brief Check whether the specified DAC interrupt source is enabled or not. 320 * @param __HANDLE__ DAC handle 321 * @param __INTERRUPT__ DAC interrupt source to check 322 * This parameter can be any combination of the following values: 323 * @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt 324 * @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt 325 * @retval State of interruption (SET or RESET) 326 */ 327 #define __HAL_DAC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR\ 328 & (__INTERRUPT__)) == (__INTERRUPT__)) 329 330 /** @brief Get the selected DAC's flag status. 331 * @param __HANDLE__ specifies the DAC handle. 332 * @param __FLAG__ specifies the DAC flag to get. 333 * This parameter can be any combination of the following values: 334 * @arg DAC_FLAG_DMAUDR1 DAC channel 1 DMA underrun flag 335 * @arg DAC_FLAG_DMAUDR2 DAC channel 2 DMA underrun flag 336 * @retval None 337 */ 338 #define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__)) 339 340 /** @brief Clear the DAC's flag. 341 * @param __HANDLE__ specifies the DAC handle. 342 * @param __FLAG__ specifies the DAC flag to clear. 343 * This parameter can be any combination of the following values: 344 * @arg DAC_FLAG_DMAUDR1 DAC channel 1 DMA underrun flag 345 * @arg DAC_FLAG_DMAUDR2 DAC channel 2 DMA underrun flag 346 * @retval None 347 */ 348 #define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__)) 349 350 /** 351 * @} 352 */ 353 354 /* Private macro -------------------------------------------------------------*/ 355 356 /** @defgroup DAC_Private_Macros DAC Private Macros 357 * @{ 358 */ 359 #define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \ 360 ((STATE) == DAC_OUTPUTBUFFER_DISABLE)) 361 362 #if defined(DAC_CHANNEL2_SUPPORT) 363 #define IS_DAC_CHANNEL(CHANNEL) (((CHANNEL) == DAC_CHANNEL_1) || \ 364 ((CHANNEL) == DAC_CHANNEL_2)) 365 #else 366 #define IS_DAC_CHANNEL(CHANNEL) ((CHANNEL) == DAC_CHANNEL_1) 367 #endif /* DAC_CHANNEL2_SUPPORT */ 368 369 #define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \ 370 ((ALIGN) == DAC_ALIGN_12B_L) || \ 371 ((ALIGN) == DAC_ALIGN_8B_R)) 372 373 #define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0UL) 374 375 /** 376 * @} 377 */ 378 379 /* Include DAC HAL Extended module */ 380 #include "stm32f4xx_hal_dac_ex.h" 381 382 /* Exported functions --------------------------------------------------------*/ 383 384 /** @addtogroup DAC_Exported_Functions 385 * @{ 386 */ 387 388 /** @addtogroup DAC_Exported_Functions_Group1 389 * @{ 390 */ 391 /* Initialization and de-initialization functions *****************************/ 392 HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef *hdac); 393 HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef *hdac); 394 void HAL_DAC_MspInit(DAC_HandleTypeDef *hdac); 395 void HAL_DAC_MspDeInit(DAC_HandleTypeDef *hdac); 396 397 /** 398 * @} 399 */ 400 401 /** @addtogroup DAC_Exported_Functions_Group2 402 * @{ 403 */ 404 /* IO operation functions *****************************************************/ 405 HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef *hdac, uint32_t Channel); 406 HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef *hdac, uint32_t Channel); 407 HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t *pData, uint32_t Length, 408 uint32_t Alignment); 409 HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel); 410 void HAL_DAC_IRQHandler(DAC_HandleTypeDef *hdac); 411 HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data); 412 413 void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef *hdac); 414 void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef *hdac); 415 void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac); 416 void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac); 417 418 #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1) 419 /* DAC callback registering/unregistering */ 420 HAL_StatusTypeDef HAL_DAC_RegisterCallback(DAC_HandleTypeDef *hdac, HAL_DAC_CallbackIDTypeDef CallbackID, 421 pDAC_CallbackTypeDef pCallback); 422 HAL_StatusTypeDef HAL_DAC_UnRegisterCallback(DAC_HandleTypeDef *hdac, HAL_DAC_CallbackIDTypeDef CallbackID); 423 #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */ 424 425 /** 426 * @} 427 */ 428 429 /** @addtogroup DAC_Exported_Functions_Group3 430 * @{ 431 */ 432 /* Peripheral Control functions ***********************************************/ 433 uint32_t HAL_DAC_GetValue(DAC_HandleTypeDef *hdac, uint32_t Channel); 434 HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel); 435 /** 436 * @} 437 */ 438 439 /** @addtogroup DAC_Exported_Functions_Group4 440 * @{ 441 */ 442 /* Peripheral State and Error functions ***************************************/ 443 HAL_DAC_StateTypeDef HAL_DAC_GetState(DAC_HandleTypeDef *hdac); 444 uint32_t HAL_DAC_GetError(DAC_HandleTypeDef *hdac); 445 446 /** 447 * @} 448 */ 449 450 /** 451 * @} 452 */ 453 454 /** @defgroup DAC_Private_Functions DAC Private Functions 455 * @{ 456 */ 457 void DAC_DMAConvCpltCh1(DMA_HandleTypeDef *hdma); 458 void DAC_DMAErrorCh1(DMA_HandleTypeDef *hdma); 459 void DAC_DMAHalfConvCpltCh1(DMA_HandleTypeDef *hdma); 460 /** 461 * @} 462 */ 463 464 /** 465 * @} 466 */ 467 468 #endif /* DAC */ 469 470 /** 471 * @} 472 */ 473 474 #ifdef __cplusplus 475 } 476 #endif 477 478 479 #endif /* STM32F4xx_HAL_DAC_H */ 480 481
