Subversion Repositories DashDisplay

Rev

Rev 61 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
77 mjames 1
/**
2
  ******************************************************************************
3
  * @file    stm32l1xx_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 STM32L1xx_HAL_DAC_H
21
#define STM32L1xx_HAL_DAC_H
22
 
23
#ifdef __cplusplus
24
extern "C" {
25
#endif
26
 
27
/** @addtogroup STM32L1xx_HAL_Driver
28
  * @{
29
  */
30
 
31
/* Includes ------------------------------------------------------------------*/
32
#include "stm32l1xx_hal_def.h"
33
 
34
#if defined(DAC1)
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
 
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
 
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
 
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
 
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
#define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02U    /*!< DAC channel2 DMA underrun error   */
154
#define  HAL_DAC_ERROR_DMA               0x04U    /*!< DMA error                         */
155
#define  HAL_DAC_ERROR_TIMEOUT           0x08U    /*!< Timeout error                     */
156
#if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
157
#define HAL_DAC_ERROR_INVALID_CALLBACK   0x10U    /*!< Invalid callback error            */
158
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
159
 
160
/**
161
  * @}
162
  */
163
 
164
/** @defgroup DAC_trigger_selection DAC trigger selection
165
  * @{
166
  */
167
#define DAC_TRIGGER_NONE                0x00000000UL                                                     /*!< Conversion is automatic once the DAC1_DHRxxxx register has been loaded, and not by external trigger */
168
#define DAC_TRIGGER_T6_TRGO             (DAC_CR_TEN1)                                                    /*!< Conversion started by software trigger for DAC channel */
169
#define DAC_TRIGGER_T7_TRGO             (                 DAC_CR_TSEL1_1                  | DAC_CR_TEN1) /*!< TIM7 TRGO selected as external conversion trigger for DAC channel */
170
#define DAC_TRIGGER_T9_TRGO             (                 DAC_CR_TSEL1_1 | DAC_CR_TSEL1_0 | DAC_CR_TEN1) /*!< TIM9 TRGO selected as external conversion trigger for DAC channel */
171
#define DAC_TRIGGER_T2_TRGO             (DAC_CR_TSEL1_2                                   | DAC_CR_TEN1) /*!< TIM2 TRGO selected as external conversion trigger for DAC channel */
172
#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 */
173
#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 */
174
#define DAC_TRIGGER_SOFTWARE            (DAC_CR_TSEL1                                     | DAC_CR_TEN1) /*!< Conversion started by software trigger for DAC channel */
175
 
176
/**
177
  * @}
178
  */
179
 
180
/** @defgroup DAC_output_buffer DAC output buffer
181
  * @{
182
  */
183
#define DAC_OUTPUTBUFFER_ENABLE            0x00000000U
184
#define DAC_OUTPUTBUFFER_DISABLE           (DAC_CR_BOFF1)
185
 
186
/**
187
  * @}
188
  */
189
 
190
/** @defgroup DAC_Channel_selection DAC Channel selection
191
  * @{
192
  */
193
#define DAC_CHANNEL_1                      0x00000000U
194
 
195
#define DAC_CHANNEL_2                      0x00000010U
196
 
197
/**
198
  * @}
199
  */
200
 
201
/** @defgroup DAC_data_alignment DAC data alignment
202
  * @{
203
  */
204
#define DAC_ALIGN_12B_R                    0x00000000U
205
#define DAC_ALIGN_12B_L                    0x00000004U
206
#define DAC_ALIGN_8B_R                     0x00000008U
207
 
208
/**
209
  * @}
210
  */
211
 
212
/** @defgroup DAC_flags_definition DAC flags definition
213
  * @{
214
  */
215
#define DAC_FLAG_DMAUDR1                   (DAC_SR_DMAUDR1)
216
 
217
#define DAC_FLAG_DMAUDR2                   (DAC_SR_DMAUDR2)
218
 
219
 
220
/**
221
  * @}
222
  */
223
 
224
/** @defgroup DAC_IT_definition  DAC IT definition
225
  * @{
226
  */
227
#define DAC_IT_DMAUDR1                   (DAC_SR_DMAUDR1)
228
 
229
#define DAC_IT_DMAUDR2                   (DAC_SR_DMAUDR2)
230
 
231
 
232
/**
233
  * @}
234
  */
235
 
236
/**
237
  * @}
238
  */
239
 
240
/* Exported macro ------------------------------------------------------------*/
241
 
242
/** @defgroup DAC_Exported_Macros DAC Exported Macros
243
  * @{
244
  */
245
 
246
/** @brief Reset DAC handle state.
247
  * @param  __HANDLE__ specifies the DAC handle.
248
  * @retval None
249
  */
250
#if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
251
#define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) do {                                                        \
252
                                                      (__HANDLE__)->State             = HAL_DAC_STATE_RESET; \
253
                                                      (__HANDLE__)->MspInitCallback   = NULL;                \
254
                                                      (__HANDLE__)->MspDeInitCallback = NULL;                \
255
                                                     } while(0)
256
#else
257
#define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET)
258
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
259
 
260
/** @brief Enable the DAC channel.
261
  * @param  __HANDLE__ specifies the DAC handle.
262
  * @param  __DAC_Channel__ specifies the DAC channel
263
  * @retval None
264
  */
265
#define __HAL_DAC_ENABLE(__HANDLE__, __DAC_Channel__) \
266
  ((__HANDLE__)->Instance->CR |=  (DAC_CR_EN1 << ((__DAC_Channel__) & 0x10UL)))
267
 
268
/** @brief Disable the DAC channel.
269
  * @param  __HANDLE__ specifies the DAC handle
270
  * @param  __DAC_Channel__ specifies the DAC channel.
271
  * @retval None
272
  */
273
#define __HAL_DAC_DISABLE(__HANDLE__, __DAC_Channel__) \
274
  ((__HANDLE__)->Instance->CR &=  ~(DAC_CR_EN1 << ((__DAC_Channel__) & 0x10UL)))
275
 
276
/** @brief Set DHR12R1 alignment.
277
  * @param  __ALIGNMENT__ specifies the DAC alignment
278
  * @retval None
279
  */
280
#define DAC_DHR12R1_ALIGNMENT(__ALIGNMENT__) (0x00000008UL + (__ALIGNMENT__))
281
 
282
 
283
/** @brief  Set DHR12R2 alignment.
284
  * @param  __ALIGNMENT__ specifies the DAC alignment
285
  * @retval None
286
  */
287
#define DAC_DHR12R2_ALIGNMENT(__ALIGNMENT__) (0x00000014UL + (__ALIGNMENT__))
288
 
289
 
290
/** @brief  Set DHR12RD alignment.
291
  * @param  __ALIGNMENT__ specifies the DAC alignment
292
  * @retval None
293
  */
294
#define DAC_DHR12RD_ALIGNMENT(__ALIGNMENT__) (0x00000020UL + (__ALIGNMENT__))
295
 
296
/** @brief Enable the DAC interrupt.
297
  * @param  __HANDLE__ specifies the DAC handle
298
  * @param  __INTERRUPT__ specifies the DAC interrupt.
299
  *          This parameter can be any combination of the following values:
300
  *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
301
  *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
302
  * @retval None
303
  */
304
#define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
305
 
306
/** @brief Disable the DAC interrupt.
307
  * @param  __HANDLE__ specifies the DAC handle
308
  * @param  __INTERRUPT__ specifies the DAC interrupt.
309
  *          This parameter can be any combination of the following values:
310
  *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
311
  *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
312
  * @retval None
313
  */
314
#define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
315
 
316
/** @brief  Check whether the specified DAC interrupt source is enabled or not.
317
  * @param __HANDLE__ DAC handle
318
  * @param __INTERRUPT__ DAC interrupt source to check
319
  *          This parameter can be any combination of the following values:
320
  *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
321
  *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
322
  * @retval State of interruption (SET or RESET)
323
  */
324
#define __HAL_DAC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR\
325
                                                             & (__INTERRUPT__)) == (__INTERRUPT__))
326
 
327
/** @brief  Get the selected DAC's flag status.
328
  * @param  __HANDLE__ specifies the DAC handle.
329
  * @param  __FLAG__ specifies the DAC flag to get.
330
  *          This parameter can be any combination of the following values:
331
  *            @arg DAC_FLAG_DMAUDR1 DAC channel 1 DMA underrun flag
332
  *            @arg DAC_FLAG_DMAUDR2 DAC channel 2 DMA underrun flag
333
  * @retval None
334
  */
335
#define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
336
 
337
/** @brief  Clear the DAC's flag.
338
  * @param  __HANDLE__ specifies the DAC handle.
339
  * @param  __FLAG__ specifies the DAC flag to clear.
340
  *          This parameter can be any combination of the following values:
341
  *            @arg DAC_FLAG_DMAUDR1 DAC channel 1 DMA underrun flag
342
  *            @arg DAC_FLAG_DMAUDR2 DAC channel 2 DMA underrun flag
343
  * @retval None
344
  */
345
#define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__))
346
 
347
/**
348
  * @}
349
  */
350
 
351
/* Private macro -------------------------------------------------------------*/
352
 
353
/** @defgroup DAC_Private_Macros DAC Private Macros
354
  * @{
355
  */
356
#define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
357
                                           ((STATE) == DAC_OUTPUTBUFFER_DISABLE))
358
 
359
#define IS_DAC_CHANNEL(CHANNEL) (((CHANNEL) == DAC_CHANNEL_1) || \
360
                                 ((CHANNEL) == DAC_CHANNEL_2))
361
 
362
#define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \
363
                             ((ALIGN) == DAC_ALIGN_12B_L) || \
364
                             ((ALIGN) == DAC_ALIGN_8B_R))
365
 
366
#define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0UL)
367
 
368
/**
369
  * @}
370
  */
371
 
372
/* Include DAC HAL Extended module */
373
#include "stm32l1xx_hal_dac_ex.h"
374
 
375
/* Exported functions --------------------------------------------------------*/
376
 
377
/** @addtogroup DAC_Exported_Functions
378
  * @{
379
  */
380
 
381
/** @addtogroup DAC_Exported_Functions_Group1
382
  * @{
383
  */
384
/* Initialization and de-initialization functions *****************************/
385
HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef *hdac);
386
HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef *hdac);
387
void HAL_DAC_MspInit(DAC_HandleTypeDef *hdac);
388
void HAL_DAC_MspDeInit(DAC_HandleTypeDef *hdac);
389
 
390
/**
391
  * @}
392
  */
393
 
394
/** @addtogroup DAC_Exported_Functions_Group2
395
  * @{
396
  */
397
/* IO operation functions *****************************************************/
398
HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef *hdac, uint32_t Channel);
399
HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef *hdac, uint32_t Channel);
400
HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel, const uint32_t *pData, uint32_t Length,
401
                                    uint32_t Alignment);
402
HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel);
403
void HAL_DAC_IRQHandler(DAC_HandleTypeDef *hdac);
404
HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data);
405
 
406
void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef *hdac);
407
void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef *hdac);
408
void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);
409
void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);
410
 
411
#if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
412
/* DAC callback registering/unregistering */
413
HAL_StatusTypeDef     HAL_DAC_RegisterCallback(DAC_HandleTypeDef *hdac, HAL_DAC_CallbackIDTypeDef CallbackID,
414
                                               pDAC_CallbackTypeDef pCallback);
415
HAL_StatusTypeDef     HAL_DAC_UnRegisterCallback(DAC_HandleTypeDef *hdac, HAL_DAC_CallbackIDTypeDef CallbackID);
416
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
417
 
418
/**
419
  * @}
420
  */
421
 
422
/** @addtogroup DAC_Exported_Functions_Group3
423
  * @{
424
  */
425
/* Peripheral Control functions ***********************************************/
426
uint32_t HAL_DAC_GetValue(const DAC_HandleTypeDef *hdac, uint32_t Channel);
427
HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef *hdac,
428
                                        const DAC_ChannelConfTypeDef *sConfig, uint32_t Channel);
429
/**
430
  * @}
431
  */
432
 
433
/** @addtogroup DAC_Exported_Functions_Group4
434
  * @{
435
  */
436
/* Peripheral State and Error functions ***************************************/
437
HAL_DAC_StateTypeDef HAL_DAC_GetState(const DAC_HandleTypeDef *hdac);
438
uint32_t HAL_DAC_GetError(const DAC_HandleTypeDef *hdac);
439
 
440
/**
441
  * @}
442
  */
443
 
444
/**
445
  * @}
446
  */
447
 
448
/** @defgroup DAC_Private_Functions DAC Private Functions
449
  * @{
450
  */
451
void DAC_DMAConvCpltCh1(DMA_HandleTypeDef *hdma);
452
void DAC_DMAErrorCh1(DMA_HandleTypeDef *hdma);
453
void DAC_DMAHalfConvCpltCh1(DMA_HandleTypeDef *hdma);
454
/**
455
  * @}
456
  */
457
 
458
/**
459
  * @}
460
  */
461
 
462
#endif /* DAC1 */
463
 
464
/**
465
  * @}
466
  */
467
 
468
#ifdef __cplusplus
469
}
470
#endif
471
 
472
 
473
#endif /* STM32L1xx_HAL_DAC_H */