1 /**
2   ******************************************************************************
3   * @file    stm32wlxx_hal_dac_ex.h
4   * @author  MCD Application Team
5   * @brief   Header file of DAC HAL Extended module.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2020 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 STM32WLxx_HAL_DAC_EX_H
21 #define STM32WLxx_HAL_DAC_EX_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /** @addtogroup STM32WLxx_HAL_Driver
28   * @{
29   */
30 
31 /* Includes ------------------------------------------------------------------*/
32 #include "stm32wlxx_hal_def.h"
33 
34 #if defined(DAC)
35 
36 /** @addtogroup DACEx
37   * @{
38   */
39 
40 /* Exported types ------------------------------------------------------------*/
41 
42 /**
43   * @brief  HAL State structures definition
44   */
45 
46 /* Exported constants --------------------------------------------------------*/
47 
48 /** @defgroup DACEx_Exported_Constants DACEx Exported Constants
49   * @{
50   */
51 
52 /** @defgroup DACEx_lfsrunmask_triangleamplitude DACEx lfsrunmask triangle amplitude
53   * @{
54   */
55 #define DAC_LFSRUNMASK_BIT0                0x00000000UL                                                        /*!< Unmask DAC channel LFSR bit0 for noise wave generation */
56 #define DAC_LFSRUNMASK_BITS1_0             (                                                   DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[1:0] for noise wave generation */
57 #define DAC_LFSRUNMASK_BITS2_0             (                                  DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[2:0] for noise wave generation */
58 #define DAC_LFSRUNMASK_BITS3_0             (                                  DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[3:0] for noise wave generation */
59 #define DAC_LFSRUNMASK_BITS4_0             (                 DAC_CR_MAMP1_2                                  ) /*!< Unmask DAC channel LFSR bit[4:0] for noise wave generation */
60 #define DAC_LFSRUNMASK_BITS5_0             (                 DAC_CR_MAMP1_2                  | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[5:0] for noise wave generation */
61 #define DAC_LFSRUNMASK_BITS6_0             (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[6:0] for noise wave generation */
62 #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 */
63 #define DAC_LFSRUNMASK_BITS8_0             (DAC_CR_MAMP1_3                                                   ) /*!< Unmask DAC channel LFSR bit[8:0] for noise wave generation */
64 #define DAC_LFSRUNMASK_BITS9_0             (DAC_CR_MAMP1_3                                   | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[9:0] for noise wave generation */
65 #define DAC_LFSRUNMASK_BITS10_0            (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1                 ) /*!< Unmask DAC channel LFSR bit[10:0] for noise wave generation */
66 #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 */
67 #define DAC_TRIANGLEAMPLITUDE_1            0x00000000UL                                                        /*!< Select max triangle amplitude of 1 */
68 #define DAC_TRIANGLEAMPLITUDE_3            (                                                   DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 3 */
69 #define DAC_TRIANGLEAMPLITUDE_7            (                                  DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 7 */
70 #define DAC_TRIANGLEAMPLITUDE_15           (                                  DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 15 */
71 #define DAC_TRIANGLEAMPLITUDE_31           (                 DAC_CR_MAMP1_2                                  ) /*!< Select max triangle amplitude of 31 */
72 #define DAC_TRIANGLEAMPLITUDE_63           (                 DAC_CR_MAMP1_2                  | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 63 */
73 #define DAC_TRIANGLEAMPLITUDE_127          (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 127 */
74 #define DAC_TRIANGLEAMPLITUDE_255          (                 DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 255 */
75 #define DAC_TRIANGLEAMPLITUDE_511          (DAC_CR_MAMP1_3                                                   ) /*!< Select max triangle amplitude of 511 */
76 #define DAC_TRIANGLEAMPLITUDE_1023         (DAC_CR_MAMP1_3                                   | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 1023 */
77 #define DAC_TRIANGLEAMPLITUDE_2047         (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1                 ) /*!< Select max triangle amplitude of 2047 */
78 #define DAC_TRIANGLEAMPLITUDE_4095         (DAC_CR_MAMP1_3                  | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 4095 */
79 
80 /**
81   * @}
82   */
83 
84 
85 /**
86   * @}
87   */
88 
89 /* Exported macro ------------------------------------------------------------*/
90 
91 
92 /* Private macro -------------------------------------------------------------*/
93 
94 /** @defgroup DACEx_Private_Macros DACEx Private Macros
95   * @{
96   */
97 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)       || \
98                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE)   || \
99                                  ((TRIGGER) == DAC_TRIGGER_T1_TRGO)    || \
100                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO)    || \
101                                  ((TRIGGER) == DAC_TRIGGER_LPTIM1_OUT) || \
102                                  ((TRIGGER) == DAC_TRIGGER_LPTIM2_OUT) || \
103                                  ((TRIGGER) == DAC_TRIGGER_LPTIM3_OUT) || \
104                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9))
105 
106 #define IS_DAC_SAMPLETIME(TIME) ((TIME) <= 0x000003FFU)
107 
108 #define IS_DAC_HOLDTIME(TIME)   ((TIME) <= 0x000003FFU)
109 
110 #define IS_DAC_SAMPLEANDHOLD(MODE) (((MODE) == DAC_SAMPLEANDHOLD_DISABLE) || \
111                                     ((MODE) == DAC_SAMPLEANDHOLD_ENABLE))
112 
113 #define IS_DAC_TRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
114 
115 #define IS_DAC_NEWTRIMMINGVALUE(TRIMMINGVALUE) ((TRIMMINGVALUE) <= 0x1FU)
116 
117 #define IS_DAC_CHIP_CONNECTION(CONNECT) (((CONNECT) == DAC_CHIPCONNECT_DISABLE) || \
118                                          ((CONNECT) == DAC_CHIPCONNECT_ENABLE))
119 
120 #define IS_DAC_TRIMMING(TRIMMING) (((TRIMMING) == DAC_TRIMMING_FACTORY) || \
121                                    ((TRIMMING) == DAC_TRIMMING_USER))
122 
123 #define IS_DAC_LFSR_UNMASK_TRIANGLE_AMPLITUDE(VALUE) (((VALUE) == DAC_LFSRUNMASK_BIT0) || \
124                                                       ((VALUE) == DAC_LFSRUNMASK_BITS1_0) || \
125                                                       ((VALUE) == DAC_LFSRUNMASK_BITS2_0) || \
126                                                       ((VALUE) == DAC_LFSRUNMASK_BITS3_0) || \
127                                                       ((VALUE) == DAC_LFSRUNMASK_BITS4_0) || \
128                                                       ((VALUE) == DAC_LFSRUNMASK_BITS5_0) || \
129                                                       ((VALUE) == DAC_LFSRUNMASK_BITS6_0) || \
130                                                       ((VALUE) == DAC_LFSRUNMASK_BITS7_0) || \
131                                                       ((VALUE) == DAC_LFSRUNMASK_BITS8_0) || \
132                                                       ((VALUE) == DAC_LFSRUNMASK_BITS9_0) || \
133                                                       ((VALUE) == DAC_LFSRUNMASK_BITS10_0) || \
134                                                       ((VALUE) == DAC_LFSRUNMASK_BITS11_0) || \
135                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_1) || \
136                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_3) || \
137                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_7) || \
138                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_15) || \
139                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_31) || \
140                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_63) || \
141                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_127) || \
142                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_255) || \
143                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_511) || \
144                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_1023) || \
145                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_2047) || \
146                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_4095))
147 /**
148   * @}
149   */
150 
151 /* Exported functions --------------------------------------------------------*/
152 /* Extended features functions ***********************************************/
153 
154 /** @addtogroup DACEx_Exported_Functions
155   * @{
156   */
157 
158 /** @addtogroup DACEx_Exported_Functions_Group2
159   * @{
160   */
161 /* IO operation functions *****************************************************/
162 
163 HAL_StatusTypeDef HAL_DACEx_TriangleWaveGenerate(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Amplitude);
164 HAL_StatusTypeDef HAL_DACEx_NoiseWaveGenerate(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Amplitude);
165 
166 
167 /**
168   * @}
169   */
170 
171 /** @addtogroup DACEx_Exported_Functions_Group3
172   * @{
173   */
174 /* Peripheral Control functions ***********************************************/
175 
176 HAL_StatusTypeDef HAL_DACEx_SelfCalibrate(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel);
177 HAL_StatusTypeDef HAL_DACEx_SetUserTrimming(DAC_HandleTypeDef *hdac, DAC_ChannelConfTypeDef *sConfig, uint32_t Channel,
178                                             uint32_t NewTrimmingValue);
179 uint32_t HAL_DACEx_GetTrimOffset(const DAC_HandleTypeDef *hdac, uint32_t Channel);
180 
181 /**
182   * @}
183   */
184 
185 /**
186   * @}
187   */
188 
189 /**
190   * @}
191   */
192 
193 #endif /* DAC */
194 
195 /**
196   * @}
197   */
198 
199 #ifdef __cplusplus
200 }
201 #endif
202 
203 #endif /* STM32WLxx_HAL_DAC_EX_H */
204