STM32H735xx HAL User Manual
stm32h7xx_hal_dac_ex.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32h7xx_hal_dac_ex.h
00004   * @author  MCD Application Team
00005   * @brief   Header file of DAC HAL Extended module.
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * Copyright (c) 2017 STMicroelectronics.
00010   * All rights reserved.
00011   *
00012   * This software is licensed under terms that can be found in the LICENSE file
00013   * in the root directory of this software component.
00014   * If no LICENSE file comes with this software, it is provided AS-IS.
00015   *
00016   ******************************************************************************
00017   */
00018 
00019 /* Define to prevent recursive inclusion -------------------------------------*/
00020 #ifndef STM32H7xx_HAL_DAC_EX_H
00021 #define STM32H7xx_HAL_DAC_EX_H
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 /** @addtogroup STM32H7xx_HAL_Driver
00028   * @{
00029   */
00030 
00031 /* Includes ------------------------------------------------------------------*/
00032 #include "stm32h7xx_hal_def.h"
00033 
00034 #if defined(DAC1) || defined(DAC2)
00035 
00036 /** @addtogroup DACEx
00037   * @{
00038   */
00039 
00040 /* Exported types ------------------------------------------------------------*/
00041 
00042 /**
00043   * @brief  HAL State structures definition
00044   */
00045 
00046 /* Exported constants --------------------------------------------------------*/
00047 
00048 /** @defgroup DACEx_Exported_Constants DACEx Exported Constants
00049   * @{
00050   */
00051 
00052 /** @defgroup DACEx_lfsrunmask_triangleamplitude DACEx lfsrunmask triangle amplitude
00053   * @{
00054   */
00055 #define DAC_LFSRUNMASK_BIT0                0x00000000UL                                                        /*!< Unmask DAC channel LFSR bit0 for noise wave generation */
00056 #define DAC_LFSRUNMASK_BITS1_0             (                                                   DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[1:0] for noise wave generation */
00057 #define DAC_LFSRUNMASK_BITS2_0             (                                  DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[2:0] for noise wave generation */
00058 #define DAC_LFSRUNMASK_BITS3_0             (                                  DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[3:0] for noise wave generation */
00059 #define DAC_LFSRUNMASK_BITS4_0             (                 DAC_CR_MAMP1_2                                  ) /*!< Unmask DAC channel LFSR bit[4:0] for noise wave generation */
00060 #define DAC_LFSRUNMASK_BITS5_0             (                 DAC_CR_MAMP1_2                  | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[5:0] for noise wave generation */
00061 #define DAC_LFSRUNMASK_BITS6_0             (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[6:0] for noise wave generation */
00062 #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 */
00063 #define DAC_LFSRUNMASK_BITS8_0             (DAC_CR_MAMP1_3                                                   ) /*!< Unmask DAC channel LFSR bit[8:0] for noise wave generation */
00064 #define DAC_LFSRUNMASK_BITS9_0             (DAC_CR_MAMP1_3                                   | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[9:0] for noise wave generation */
00065 #define DAC_LFSRUNMASK_BITS10_0            (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[10:0] for noise wave generation */
00066 #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 */
00067 #define DAC_TRIANGLEAMPLITUDE_1            0x00000000UL                                                        /*!< Select max triangle amplitude of 1 */
00068 #define DAC_TRIANGLEAMPLITUDE_3            (                                                   DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 3 */
00069 #define DAC_TRIANGLEAMPLITUDE_7            (                                  DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 7 */
00070 #define DAC_TRIANGLEAMPLITUDE_15           (                                  DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 15 */
00071 #define DAC_TRIANGLEAMPLITUDE_31           (                 DAC_CR_MAMP1_2                                  ) /*!< Select max triangle amplitude of 31 */
00072 #define DAC_TRIANGLEAMPLITUDE_63           (                 DAC_CR_MAMP1_2                  | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 63 */
00073 #define DAC_TRIANGLEAMPLITUDE_127          (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 127 */
00074 #define DAC_TRIANGLEAMPLITUDE_255          (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 255 */
00075 #define DAC_TRIANGLEAMPLITUDE_511          (DAC_CR_MAMP1_3                                                   ) /*!< Select max triangle amplitude of 511 */
00076 #define DAC_TRIANGLEAMPLITUDE_1023         (DAC_CR_MAMP1_3                                   | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 1023 */
00077 #define DAC_TRIANGLEAMPLITUDE_2047         (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 2047 */
00078 #define DAC_TRIANGLEAMPLITUDE_4095         (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 4095 */
00079 
00080 /**
00081   * @}
00082   */
00083 
00084 /**
00085   * @}
00086   */
00087 
00088 /* Exported macro ------------------------------------------------------------*/
00089 
00090 
00091 /* Private macro -------------------------------------------------------------*/
00092 
00093 /** @defgroup DACEx_Private_Macros DACEx Private Macros
00094   * @{
00095   */
00096 #if defined(HRTIM1)
00097 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)       || \
00098                                  ((TRIGGER) == DAC_TRIGGER_T1_TRGO)    || \
00099                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO)    || \
00100                                  ((TRIGGER) == DAC_TRIGGER_T4_TRGO)    || \
00101                                  ((TRIGGER) == DAC_TRIGGER_T5_TRGO)    || \
00102                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO)    || \
00103                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO)    || \
00104                                  ((TRIGGER) == DAC_TRIGGER_T8_TRGO)    || \
00105                                  ((TRIGGER) == DAC_TRIGGER_T15_TRGO)   || \
00106                                  ((TRIGGER) == DAC_TRIGGER_HR1_TRGO1)  || \
00107                                  ((TRIGGER) == DAC_TRIGGER_HR1_TRGO2)  || \
00108                                  ((TRIGGER) == DAC_TRIGGER_LPTIM1_OUT) || \
00109                                  ((TRIGGER) == DAC_TRIGGER_LPTIM2_OUT) || \
00110                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9)    || \
00111                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
00112 #elif defined(DAC2)
00113 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)       || \
00114                                  ((TRIGGER) == DAC_TRIGGER_T1_TRGO)    || \
00115                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO)    || \
00116                                  ((TRIGGER) == DAC_TRIGGER_T4_TRGO)    || \
00117                                  ((TRIGGER) == DAC_TRIGGER_T5_TRGO)    || \
00118                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO)    || \
00119                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO)    || \
00120                                  ((TRIGGER) == DAC_TRIGGER_T8_TRGO)    || \
00121                                  ((TRIGGER) == DAC_TRIGGER_T15_TRGO)   || \
00122                                  ((TRIGGER) == DAC_TRIGGER_LPTIM1_OUT) || \
00123                                  ((TRIGGER) == DAC_TRIGGER_LPTIM2_OUT) || \
00124                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9)    || \
00125                                  ((TRIGGER) == DAC_TRIGGER_LPTIM3_OUT) || \
00126                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
00127 #else
00128 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)       || \
00129                                  ((TRIGGER) == DAC_TRIGGER_T1_TRGO)    || \
00130                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO)    || \
00131                                  ((TRIGGER) == DAC_TRIGGER_T4_TRGO)    || \
00132                                  ((TRIGGER) == DAC_TRIGGER_T5_TRGO)    || \
00133                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO)    || \
00134                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO)    || \
00135                                  ((TRIGGER) == DAC_TRIGGER_T8_TRGO)    || \
00136                                  ((TRIGGER) == DAC_TRIGGER_T15_TRGO)   || \
00137                                  ((TRIGGER) == DAC_TRIGGER_LPTIM1_OUT) || \
00138                                  ((TRIGGER) == DAC_TRIGGER_LPTIM2_OUT) || \
00139                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9)    || \
00140                                  ((TRIGGER) == DAC_TRIGGER_T23_TRGO)   || \
00141                                  ((TRIGGER) == DAC_TRIGGER_T24_TRGO)   || \
00142                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
00143 #endif
00144 
00145 #define IS_DAC_SAMPLETIME(TIME) ((TIME) <= 0x000003FFU)
00146 
00147 #define IS_DAC_HOLDTIME(TIME)   ((TIME) <= 0x000003FFU)
00148 
00149 #define IS_DAC_SAMPLEANDHOLD(MODE) (((MODE) == DAC_SAMPLEANDHOLD_DISABLE) || \
00150                                     ((MODE) == DAC_SAMPLEANDHOLD_ENABLE))
00151 
00152 #define IS_DAC_TRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
00153 
00154 #define IS_DAC_NEWTRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
00155 
00156 #define IS_DAC_CHIP_CONNECTION(CONNECT) (((CONNECT) == DAC_CHIPCONNECT_EXTERNAL) || \
00157                                          ((CONNECT) == DAC_CHIPCONNECT_INTERNAL) || \
00158                                          ((CONNECT) == DAC_CHIPCONNECT_BOTH))
00159 
00160 #define IS_DAC_TRIMMING(TRIMMING) (((TRIMMING) == DAC_TRIMMING_FACTORY) || \
00161                                    ((TRIMMING) == DAC_TRIMMING_USER))
00162 
00163 #define IS_DAC_LFSR_UNMASK_TRIANGLE_AMPLITUDE(VALUE) (((VALUE) == DAC_LFSRUNMASK_BIT0) || \
00164                                                       ((VALUE) == DAC_LFSRUNMASK_BITS1_0) || \
00165                                                       ((VALUE) == DAC_LFSRUNMASK_BITS2_0) || \
00166                                                       ((VALUE) == DAC_LFSRUNMASK_BITS3_0) || \
00167                                                       ((VALUE) == DAC_LFSRUNMASK_BITS4_0) || \
00168                                                       ((VALUE) == DAC_LFSRUNMASK_BITS5_0) || \
00169                                                       ((VALUE) == DAC_LFSRUNMASK_BITS6_0) || \
00170                                                       ((VALUE) == DAC_LFSRUNMASK_BITS7_0) || \
00171                                                       ((VALUE) == DAC_LFSRUNMASK_BITS8_0) || \
00172                                                       ((VALUE) == DAC_LFSRUNMASK_BITS9_0) || \
00173                                                       ((VALUE) == DAC_LFSRUNMASK_BITS10_0) || \
00174                                                       ((VALUE) == DAC_LFSRUNMASK_BITS11_0) || \
00175                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_1) || \
00176                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_3) || \
00177                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_7) || \
00178                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_15) || \
00179                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_31) || \
00180                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_63) || \
00181                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_127) || \
00182                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_255) || \
00183                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_511) || \
00184                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_1023) || \
00185                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_2047) || \
00186                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_4095))
00187 /**
00188   * @}
00189   */
00190 
00191 /* Exported functions --------------------------------------------------------*/
00192 /* Extended features functions ***********************************************/
00193 
00194 /** @addtogroup DACEx_Exported_Functions
00195   * @{
00196   */
00197 
00198 /** @addtogroup DACEx_Exported_Functions_Group2
00199   * @{
00200   */
00201 /* IO operation functions *****************************************************/
00202 
00203 HAL_StatusTypeDef HAL_DACEx_TriangleWaveGenerate(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Amplitude);
00204 HAL_StatusTypeDef HAL_DACEx_NoiseWaveGenerate(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Amplitude);
00205 
00206 HAL_StatusTypeDef HAL_DACEx_DualStart(DAC_HandleTypeDef *hdac);
00207 HAL_StatusTypeDef HAL_DACEx_DualStop(DAC_HandleTypeDef *hdac);
00208 HAL_StatusTypeDef HAL_DACEx_DualStart_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t *pData, uint32_t Length,
00209                                           uint32_t Alignment);
00210 HAL_StatusTypeDef HAL_DACEx_DualStop_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel);
00211 HAL_StatusTypeDef HAL_DACEx_DualSetValue(DAC_HandleTypeDef *hdac, uint32_t Alignment, uint32_t Data1, uint32_t Data2);
00212 uint32_t HAL_DACEx_DualGetValue(DAC_HandleTypeDef *hdac);
00213 
00214 void HAL_DACEx_ConvCpltCallbackCh2(DAC_HandleTypeDef *hdac);
00215 void HAL_DACEx_ConvHalfCpltCallbackCh2(DAC_HandleTypeDef *hdac);
00216 void HAL_DACEx_ErrorCallbackCh2(DAC_HandleTypeDef *hdac);
00217 void HAL_DACEx_DMAUnderrunCallbackCh2(DAC_HandleTypeDef *hdac);
00218 
00219 
00220 /**
00221   * @}
00222   */
00223 
00224 /** @addtogroup DACEx_Exported_Functions_Group3
00225   * @{
00226   */
00227 /* Peripheral Control functions ***********************************************/
00228 
00229 HAL_StatusTypeDef HAL_DACEx_SelfCalibrate(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel);
00230 HAL_StatusTypeDef HAL_DACEx_SetUserTrimming(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel,
00231                                             uint32_t NewTrimmingValue);
00232 uint32_t HAL_DACEx_GetTrimOffset(DAC_HandleTypeDef *hdac, uint32_t Channel);
00233 
00234 /**
00235   * @}
00236   */
00237 
00238 /**
00239   * @}
00240   */
00241 
00242 /** @addtogroup DACEx_Private_Functions
00243   * @{
00244   */
00245 
00246 /* DAC_DMAConvCpltCh2 / DAC_DMAErrorCh2 / DAC_DMAHalfConvCpltCh2 */
00247 /* are called by HAL_DAC_Start_DMA */
00248 void DAC_DMAConvCpltCh2(DMA_HandleTypeDef *hdma);
00249 void DAC_DMAErrorCh2(DMA_HandleTypeDef *hdma);
00250 void DAC_DMAHalfConvCpltCh2(DMA_HandleTypeDef *hdma);
00251 
00252 /**
00253   * @}
00254   */
00255 
00256 /**
00257   * @}
00258   */
00259 
00260 #endif /* DAC1 || DAC2 */
00261 
00262 /**
00263   * @}
00264   */
00265 
00266 #ifdef __cplusplus
00267 }
00268 #endif
00269 
00270 #endif /* STM32H7xx_HAL_DAC_EX_H */
00271