STM32L443xx HAL User Manual
stm32l4xx_hal_dac_ex.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32l4xx_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 STM32L4xx_HAL_DAC_EX_H
00021 #define STM32L4xx_HAL_DAC_EX_H
00022 
00023 #ifdef __cplusplus
00024  extern "C" {
00025 #endif
00026 
00027 /** @addtogroup STM32L4xx_HAL_Driver
00028   * @{
00029   */
00030 
00031 /* Includes ------------------------------------------------------------------*/
00032 #include "stm32l4xx_hal_def.h"
00033 
00034 #if defined(DAC1)
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                0x00000000U                                                         /*!< 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            0x00000000U                                                         /*!< 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 (STM32L431xx) || defined (STM32L432xx) || defined (STM32L433xx) || defined (STM32L442xx) || defined (STM32L443xx)
00097 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)    || \
00098                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO) || \
00099                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO) || \
00100                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO) || \
00101                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9) || \
00102                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
00103 #endif     /* STM32L431xx STM32L432xx STM32L433xx STM32L442xx STM32L443xx */
00104 
00105 #if defined (STM32L451xx) || defined (STM32L452xx) || defined (STM32L462xx)
00106 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)    || \
00107                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO) || \
00108                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO) || \
00109                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9) || \
00110                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
00111 #endif     /* STM32L451xx STM32L452xx STM32L462xx                         */
00112 
00113 #if defined (STM32L471xx) || defined (STM32L475xx) || defined (STM32L476xx) || defined (STM32L485xx) || defined (STM32L486xx) || defined (STM32L496xx) || defined (STM32L4A6xx)
00114 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)    || \
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_EXT_IT9) || \
00122                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
00123 #endif     /* STM32L471xx STM32L475xx STM32L476xx STM32L485xx STM32L486xx STM32L496xx STM32L4A6xx */
00124 
00125 #if defined (STM32L4P5xx) || defined (STM32L4Q5xx) || defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined(STM32L4S9xx)
00126 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)       || \
00127                                  ((TRIGGER) == DAC_TRIGGER_T1_TRGO)    || \
00128                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO)    || \
00129                                  ((TRIGGER) == DAC_TRIGGER_T4_TRGO)    || \
00130                                  ((TRIGGER) == DAC_TRIGGER_T5_TRGO)    || \
00131                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO)    || \
00132                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO)    || \
00133                                  ((TRIGGER) == DAC_TRIGGER_T8_TRGO)    || \
00134                                  ((TRIGGER) == DAC_TRIGGER_T15_TRGO)   || \
00135                                  ((TRIGGER) == DAC_TRIGGER_LPTIM1_OUT) || \
00136                                  ((TRIGGER) == DAC_TRIGGER_LPTIM2_OUT) || \
00137                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9)    || \
00138                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
00139 
00140 #define  IS_DAC_HIGH_FREQUENCY_MODE(MODE) (((MODE) == DAC_HIGH_FREQUENCY_INTERFACE_MODE_DISABLE)         || \
00141                                            ((MODE) == DAC_HIGH_FREQUENCY_INTERFACE_MODE_ABOVE_80MHZ)     || \
00142                                            ((MODE) == DAC_HIGH_FREQUENCY_INTERFACE_MODE_AUTOMATIC))
00143 
00144 #endif  /* STM32L4P5xx STM32L4Q5xx STM32L4R5xx STM32L4R7xx STM32L4R9xx STM32L4S5xx STM32L4S7xx STM32L4S9xx */
00145 
00146 #define IS_DAC_SAMPLETIME(TIME) ((TIME) <= 0x000003FFU)
00147 
00148 #define IS_DAC_HOLDTIME(TIME)   ((TIME) <= 0x000003FFU)
00149 
00150 #define IS_DAC_SAMPLEANDHOLD(MODE) (((MODE) == DAC_SAMPLEANDHOLD_DISABLE) || \
00151                                     ((MODE) == DAC_SAMPLEANDHOLD_ENABLE))
00152 
00153 #define IS_DAC_TRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
00154 
00155 #define IS_DAC_NEWTRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
00156 
00157 #define IS_DAC_CHIP_CONNECTION(CONNECT) (((CONNECT) == DAC_CHIPCONNECT_DISABLE) || \
00158                                          ((CONNECT) == DAC_CHIPCONNECT_ENABLE))
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 #if defined (STM32L431xx) || defined (STM32L432xx) || defined (STM32L433xx) || defined (STM32L442xx) || defined (STM32L443xx) || \
00207     defined (STM32L471xx) || defined (STM32L475xx) || defined (STM32L476xx) || defined (STM32L485xx) || defined (STM32L486xx) || defined (STM32L496xx) || defined (STM32L4A6xx) || \
00208     defined (STM32L4P5xx) || defined (STM32L4Q5xx) || \
00209     defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined(STM32L4S9xx)
00210 HAL_StatusTypeDef HAL_DACEx_DualSetValue(DAC_HandleTypeDef* hdac, uint32_t Alignment, uint32_t Data1, uint32_t Data2);
00211 uint32_t HAL_DACEx_DualGetValue(DAC_HandleTypeDef* hdac);
00212 #endif  /* STM32L431xx STM32L432xx STM32L433xx STM32L442xx STM32L443xx                         */
00213         /* STM32L471xx STM32L475xx STM32L476xx STM32L485xx STM32L486xx STM32L496xx STM32L4A6xx */
00214         /* STM32L4P5xx STM32L4Q5xx                                                             */
00215         /* STM32L4R5xx STM32L4R7xx STM32L4R9xx STM32L4S5xx STM32L4S7xx STM32L4S9xx             */
00216 #if defined (STM32L431xx) || defined (STM32L432xx) || defined (STM32L433xx) || defined (STM32L442xx) || defined (STM32L443xx) || \
00217     defined (STM32L471xx) || defined (STM32L475xx) || defined (STM32L476xx) || defined (STM32L485xx) || defined (STM32L486xx) || defined (STM32L496xx) || defined (STM32L4A6xx) || \
00218     defined (STM32L4P5xx) || defined (STM32L4Q5xx) || \
00219     defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined(STM32L4S9xx)
00220 void HAL_DACEx_ConvCpltCallbackCh2(DAC_HandleTypeDef* hdac);
00221 void HAL_DACEx_ConvHalfCpltCallbackCh2(DAC_HandleTypeDef* hdac);
00222 void HAL_DACEx_ErrorCallbackCh2(DAC_HandleTypeDef* hdac);
00223 void HAL_DACEx_DMAUnderrunCallbackCh2(DAC_HandleTypeDef* hdac);
00224 #endif  /* STM32L431xx STM32L432xx STM32L433xx STM32L442xx STM32L443xx                         */
00225         /* STM32L471xx STM32L475xx STM32L476xx STM32L485xx STM32L486xx STM32L496xx STM32L4A6xx */
00226         /* STM32L4P5xx STM32L4Q5xx                                                             */
00227         /* STM32L4R5xx STM32L4R7xx STM32L4R9xx STM32L4S5xx STM32L4S7xx STM32L4S9xx             */
00228 
00229 
00230 /**
00231   * @}
00232   */
00233 
00234 /** @addtogroup DACEx_Exported_Functions_Group3
00235   * @{
00236   */
00237 /* Peripheral Control functions ***********************************************/
00238 
00239 HAL_StatusTypeDef HAL_DACEx_SelfCalibrate(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel);
00240 HAL_StatusTypeDef HAL_DACEx_SetUserTrimming(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel, uint32_t NewTrimmingValue);
00241 uint32_t HAL_DACEx_GetTrimOffset (DAC_HandleTypeDef *hdac, uint32_t Channel);
00242 
00243 /**
00244   * @}
00245   */
00246 
00247 /**
00248   * @}
00249   */
00250 
00251 #if defined (STM32L431xx) || defined (STM32L432xx) || defined (STM32L433xx) || defined (STM32L442xx) || defined (STM32L443xx) || \
00252     defined (STM32L471xx) || defined (STM32L475xx) || defined (STM32L476xx) || defined (STM32L485xx) || defined (STM32L486xx) || defined (STM32L496xx) || defined (STM32L4A6xx) || \
00253     defined (STM32L4P5xx) || defined (STM32L4Q5xx) || \
00254     defined (STM32L4R5xx) || defined (STM32L4R7xx) || defined (STM32L4R9xx) || defined (STM32L4S5xx) || defined (STM32L4S7xx) || defined(STM32L4S9xx)
00255 
00256 /** @addtogroup DACEx_Private_Functions
00257   * @{
00258   */
00259 
00260 /* DAC_DMAConvCpltCh2 / DAC_DMAErrorCh2 / DAC_DMAHalfConvCpltCh2 */
00261 /* are called by HAL_DAC_Start_DMA */
00262 void DAC_DMAConvCpltCh2(DMA_HandleTypeDef *hdma);
00263 void DAC_DMAErrorCh2(DMA_HandleTypeDef *hdma);
00264 void DAC_DMAHalfConvCpltCh2(DMA_HandleTypeDef *hdma);
00265 
00266 /**
00267  * @}
00268  */
00269 #endif  /* STM32L431xx STM32L432xx STM32L433xx STM32L442xx STM32L443xx                         */
00270         /* STM32L471xx STM32L475xx STM32L476xx STM32L485xx STM32L486xx STM32L496xx STM32L4A6xx */
00271         /* STM32L4P5xx STM32L4Q5xx                                                             */
00272         /* STM32L4R5xx STM32L4R7xx STM32L4R9xx STM32L4S5xx STM32L4S7xx STM32L4S9xx             */
00273 /**
00274   * @}
00275   */
00276 
00277 #endif /* DAC1 */
00278 
00279 /**
00280   * @}
00281   */
00282 
00283 #ifdef __cplusplus
00284 }
00285 #endif
00286 
00287 #endif /*STM32L4xx_HAL_DAC_EX_H */
00288