Subversion Repositories DashDisplay

Rev

Rev 61 | Go to most recent revision | Details | Last modification | View Log | RSS feed

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