Subversion Repositories DashDisplay

Rev

Rev 61 | Details | Compare with Previous | 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
61 mjames 67
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
56 mjames 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)
61 mjames 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);
56 mjames 86
 
61 mjames 87
  void (* ConvCpltCallbackCh2)            (struct __DAC_HandleTypeDef *hdac);
88
  void (* ConvHalfCpltCallbackCh2)        (struct __DAC_HandleTypeDef *hdac);
89
  void (* ErrorCallbackCh2)               (struct __DAC_HandleTypeDef *hdac);
90
  void (* DMAUnderrunCallbackCh2)         (struct __DAC_HandleTypeDef *hdac);
91
 
92
 
93
  void (* MspInitCallback)                (struct __DAC_HandleTypeDef *hdac);
94
  void (* MspDeInitCallback)              (struct __DAC_HandleTypeDef *hdac);
56 mjames 95
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
96
 
97
} DAC_HandleTypeDef;
98
 
99
/**
100
  * @brief   DAC Configuration regular Channel structure definition
101
  */
102
typedef struct
103
{
104
  uint32_t DAC_Trigger;                  /*!< Specifies the external trigger for the selected DAC channel.
105
                                              This parameter can be a value of @ref DAC_trigger_selection */
106
 
107
  uint32_t DAC_OutputBuffer;             /*!< Specifies whether the DAC channel output buffer is enabled or disabled.
108
                                               This parameter can be a value of @ref DAC_output_buffer */
109
 
110
} DAC_ChannelConfTypeDef;
111
 
112
#if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
113
/**
114
  * @brief  HAL DAC Callback ID enumeration definition
115
  */
116
typedef enum
117
{
118
  HAL_DAC_CH1_COMPLETE_CB_ID                 = 0x00U,  /*!< DAC CH1 Complete Callback ID      */
119
  HAL_DAC_CH1_HALF_COMPLETE_CB_ID            = 0x01U,  /*!< DAC CH1 half Complete Callback ID */
120
  HAL_DAC_CH1_ERROR_ID                       = 0x02U,  /*!< DAC CH1 error Callback ID         */
121
  HAL_DAC_CH1_UNDERRUN_CB_ID                 = 0x03U,  /*!< DAC CH1 underrun Callback ID      */
61 mjames 122
 
56 mjames 123
  HAL_DAC_CH2_COMPLETE_CB_ID                 = 0x04U,  /*!< DAC CH2 Complete Callback ID      */
124
  HAL_DAC_CH2_HALF_COMPLETE_CB_ID            = 0x05U,  /*!< DAC CH2 half Complete Callback ID */
125
  HAL_DAC_CH2_ERROR_ID                       = 0x06U,  /*!< DAC CH2 error Callback ID         */
126
  HAL_DAC_CH2_UNDERRUN_CB_ID                 = 0x07U,  /*!< DAC CH2 underrun Callback ID      */
61 mjames 127
 
56 mjames 128
  HAL_DAC_MSPINIT_CB_ID                      = 0x08U,  /*!< DAC MspInit Callback ID           */
129
  HAL_DAC_MSPDEINIT_CB_ID                    = 0x09U,  /*!< DAC MspDeInit Callback ID         */
130
  HAL_DAC_ALL_CB_ID                          = 0x0AU   /*!< DAC All ID                        */
131
} HAL_DAC_CallbackIDTypeDef;
132
 
133
/**
134
  * @brief  HAL DAC Callback pointer definition
135
  */
136
typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac);
137
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
138
 
139
/**
140
  * @}
141
  */
142
 
143
/* Exported constants --------------------------------------------------------*/
144
 
145
/** @defgroup DAC_Exported_Constants DAC Exported Constants
146
  * @{
147
  */
148
 
149
/** @defgroup DAC_Error_Code DAC Error Code
150
  * @{
151
  */
152
#define  HAL_DAC_ERROR_NONE              0x00U    /*!< No error                          */
153
#define  HAL_DAC_ERROR_DMAUNDERRUNCH1    0x01U    /*!< DAC channel1 DMA underrun error   */
154
#define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02U    /*!< DAC channel2 DMA underrun error   */
155
#define  HAL_DAC_ERROR_DMA               0x04U    /*!< DMA error                         */
156
#define  HAL_DAC_ERROR_TIMEOUT           0x08U    /*!< Timeout error                     */
157
#if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
158
#define HAL_DAC_ERROR_INVALID_CALLBACK   0x10U    /*!< Invalid callback error            */
159
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
160
 
161
/**
162
  * @}
163
  */
164
 
165
/** @defgroup DAC_trigger_selection DAC trigger selection
166
  * @{
167
  */
61 mjames 168
#define DAC_TRIGGER_NONE                0x00000000UL                                                     /*!< Conversion is automatic once the DAC1_DHRxxxx register has been loaded, and not by external trigger */
56 mjames 169
#define DAC_TRIGGER_T6_TRGO             (DAC_CR_TEN1)                                                    /*!< Conversion started by software trigger for DAC channel */
170
#define DAC_TRIGGER_T7_TRGO             (                 DAC_CR_TSEL1_1                  | DAC_CR_TEN1) /*!< TIM7 TRGO selected as external conversion trigger for DAC channel */
171
#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 */
172
#define DAC_TRIGGER_T2_TRGO             (DAC_CR_TSEL1_2                                   | DAC_CR_TEN1) /*!< TIM2 TRGO selected as external conversion trigger for DAC channel */
173
#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 */
174
#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 */
175
#define DAC_TRIGGER_SOFTWARE            (DAC_CR_TSEL1                                     | DAC_CR_TEN1) /*!< Conversion started by software trigger for DAC channel */
176
 
177
/**
178
  * @}
179
  */
180
 
181
/** @defgroup DAC_output_buffer DAC output buffer
182
  * @{
183
  */
184
#define DAC_OUTPUTBUFFER_ENABLE            0x00000000U
185
#define DAC_OUTPUTBUFFER_DISABLE           (DAC_CR_BOFF1)
186
 
187
/**
188
  * @}
189
  */
190
 
191
/** @defgroup DAC_Channel_selection DAC Channel selection
192
  * @{
193
  */
194
#define DAC_CHANNEL_1                      0x00000000U
61 mjames 195
 
56 mjames 196
#define DAC_CHANNEL_2                      0x00000010U
61 mjames 197
 
56 mjames 198
/**
199
  * @}
200
  */
201
 
202
/** @defgroup DAC_data_alignment DAC data alignment
203
  * @{
204
  */
205
#define DAC_ALIGN_12B_R                    0x00000000U
206
#define DAC_ALIGN_12B_L                    0x00000004U
207
#define DAC_ALIGN_8B_R                     0x00000008U
208
 
209
/**
210
  * @}
211
  */
212
 
213
/** @defgroup DAC_flags_definition DAC flags definition
214
  * @{
215
  */
216
#define DAC_FLAG_DMAUDR1                   (DAC_SR_DMAUDR1)
61 mjames 217
 
56 mjames 218
#define DAC_FLAG_DMAUDR2                   (DAC_SR_DMAUDR2)
219
 
61 mjames 220
 
56 mjames 221
/**
222
  * @}
223
  */
224
 
225
/** @defgroup DAC_IT_definition  DAC IT definition
226
  * @{
227
  */
228
#define DAC_IT_DMAUDR1                   (DAC_SR_DMAUDR1)
61 mjames 229
 
56 mjames 230
#define DAC_IT_DMAUDR2                   (DAC_SR_DMAUDR2)
231
 
61 mjames 232
 
56 mjames 233
/**
234
  * @}
235
  */
236
 
237
/**
238
  * @}
239
  */
240
 
241
/* Exported macro ------------------------------------------------------------*/
242
 
243
/** @defgroup DAC_Exported_Macros DAC Exported Macros
244
  * @{
245
  */
246
 
247
/** @brief Reset DAC handle state.
248
  * @param  __HANDLE__ specifies the DAC handle.
249
  * @retval None
250
  */
251
#if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
252
#define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) do {                                                        \
253
                                                      (__HANDLE__)->State             = HAL_DAC_STATE_RESET; \
61 mjames 254
                                                      (__HANDLE__)->MspInitCallback   = NULL;                \
255
                                                      (__HANDLE__)->MspDeInitCallback = NULL;                \
56 mjames 256
                                                     } while(0)
257
#else
258
#define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET)
259
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
260
 
261
/** @brief Enable the DAC channel.
262
  * @param  __HANDLE__ specifies the DAC handle.
263
  * @param  __DAC_Channel__ specifies the DAC channel
264
  * @retval None
265
  */
266
#define __HAL_DAC_ENABLE(__HANDLE__, __DAC_Channel__) \
267
  ((__HANDLE__)->Instance->CR |=  (DAC_CR_EN1 << ((__DAC_Channel__) & 0x10UL)))
268
 
269
/** @brief Disable the DAC channel.
270
  * @param  __HANDLE__ specifies the DAC handle
271
  * @param  __DAC_Channel__ specifies the DAC channel.
272
  * @retval None
273
  */
274
#define __HAL_DAC_DISABLE(__HANDLE__, __DAC_Channel__) \
275
  ((__HANDLE__)->Instance->CR &=  ~(DAC_CR_EN1 << ((__DAC_Channel__) & 0x10UL)))
276
 
277
/** @brief Set DHR12R1 alignment.
278
  * @param  __ALIGNMENT__ specifies the DAC alignment
279
  * @retval None
280
  */
61 mjames 281
#define DAC_DHR12R1_ALIGNMENT(__ALIGNMENT__) (0x00000008UL + (__ALIGNMENT__))
56 mjames 282
 
61 mjames 283
 
56 mjames 284
/** @brief  Set DHR12R2 alignment.
285
  * @param  __ALIGNMENT__ specifies the DAC alignment
286
  * @retval None
287
  */
61 mjames 288
#define DAC_DHR12R2_ALIGNMENT(__ALIGNMENT__) (0x00000014UL + (__ALIGNMENT__))
56 mjames 289
 
61 mjames 290
 
56 mjames 291
/** @brief  Set DHR12RD alignment.
292
  * @param  __ALIGNMENT__ specifies the DAC alignment
293
  * @retval None
294
  */
61 mjames 295
#define DAC_DHR12RD_ALIGNMENT(__ALIGNMENT__) (0x00000020UL + (__ALIGNMENT__))
56 mjames 296
 
297
/** @brief Enable the DAC interrupt.
298
  * @param  __HANDLE__ specifies the DAC handle
299
  * @param  __INTERRUPT__ specifies the DAC interrupt.
300
  *          This parameter can be any combination of the following values:
61 mjames 301
  *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
302
  *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
56 mjames 303
  * @retval None
304
  */
305
#define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
306
 
307
/** @brief Disable the DAC interrupt.
308
  * @param  __HANDLE__ specifies the DAC handle
309
  * @param  __INTERRUPT__ specifies the DAC interrupt.
310
  *          This parameter can be any combination of the following values:
61 mjames 311
  *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
312
  *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
56 mjames 313
  * @retval None
314
  */
315
#define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
316
 
317
/** @brief  Check whether the specified DAC interrupt source is enabled or not.
318
  * @param __HANDLE__ DAC handle
319
  * @param __INTERRUPT__ DAC interrupt source to check
320
  *          This parameter can be any combination of the following values:
61 mjames 321
  *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
322
  *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
56 mjames 323
  * @retval State of interruption (SET or RESET)
324
  */
61 mjames 325
#define __HAL_DAC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR\
326
                                                             & (__INTERRUPT__)) == (__INTERRUPT__))
56 mjames 327
 
328
/** @brief  Get the selected DAC's flag status.
329
  * @param  __HANDLE__ specifies the DAC handle.
330
  * @param  __FLAG__ specifies the DAC flag to get.
331
  *          This parameter can be any combination of the following values:
61 mjames 332
  *            @arg DAC_FLAG_DMAUDR1 DAC channel 1 DMA underrun flag
333
  *            @arg DAC_FLAG_DMAUDR2 DAC channel 2 DMA underrun flag
56 mjames 334
  * @retval None
335
  */
336
#define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
337
 
338
/** @brief  Clear the DAC's flag.
339
  * @param  __HANDLE__ specifies the DAC handle.
340
  * @param  __FLAG__ specifies the DAC flag to clear.
341
  *          This parameter can be any combination of the following values:
61 mjames 342
  *            @arg DAC_FLAG_DMAUDR1 DAC channel 1 DMA underrun flag
343
  *            @arg DAC_FLAG_DMAUDR2 DAC channel 2 DMA underrun flag
56 mjames 344
  * @retval None
345
  */
346
#define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__))
347
 
348
/**
349
  * @}
350
  */
351
 
352
/* Private macro -------------------------------------------------------------*/
353
 
354
/** @defgroup DAC_Private_Macros DAC Private Macros
355
  * @{
356
  */
357
#define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
358
                                           ((STATE) == DAC_OUTPUTBUFFER_DISABLE))
359
 
360
#define IS_DAC_CHANNEL(CHANNEL) (((CHANNEL) == DAC_CHANNEL_1) || \
361
                                 ((CHANNEL) == DAC_CHANNEL_2))
362
 
363
#define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \
364
                             ((ALIGN) == DAC_ALIGN_12B_L) || \
365
                             ((ALIGN) == DAC_ALIGN_8B_R))
366
 
61 mjames 367
#define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0UL)
56 mjames 368
 
369
/**
370
  * @}
371
  */
372
 
373
/* Include DAC HAL Extended module */
374
#include "stm32l1xx_hal_dac_ex.h"
375
 
376
/* Exported functions --------------------------------------------------------*/
377
 
378
/** @addtogroup DAC_Exported_Functions
379
  * @{
380
  */
381
 
382
/** @addtogroup DAC_Exported_Functions_Group1
383
  * @{
384
  */
385
/* Initialization and de-initialization functions *****************************/
386
HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef *hdac);
387
HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef *hdac);
388
void HAL_DAC_MspInit(DAC_HandleTypeDef *hdac);
389
void HAL_DAC_MspDeInit(DAC_HandleTypeDef *hdac);
390
 
391
/**
392
  * @}
393
  */
394
 
395
/** @addtogroup DAC_Exported_Functions_Group2
396
  * @{
397
  */
398
/* IO operation functions *****************************************************/
399
HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef *hdac, uint32_t Channel);
400
HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef *hdac, uint32_t Channel);
401
HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t *pData, uint32_t Length,
402
                                    uint32_t Alignment);
403
HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel);
404
void HAL_DAC_IRQHandler(DAC_HandleTypeDef *hdac);
405
HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data);
406
 
407
void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef *hdac);
408
void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef *hdac);
409
void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);
410
void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);
411
 
412
#if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
413
/* DAC callback registering/unregistering */
414
HAL_StatusTypeDef     HAL_DAC_RegisterCallback(DAC_HandleTypeDef *hdac, HAL_DAC_CallbackIDTypeDef CallbackID,
415
                                               pDAC_CallbackTypeDef pCallback);
416
HAL_StatusTypeDef     HAL_DAC_UnRegisterCallback(DAC_HandleTypeDef *hdac, HAL_DAC_CallbackIDTypeDef CallbackID);
417
#endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
418
 
419
/**
420
  * @}
421
  */
422
 
423
/** @addtogroup DAC_Exported_Functions_Group3
424
  * @{
425
  */
426
/* Peripheral Control functions ***********************************************/
427
uint32_t HAL_DAC_GetValue(DAC_HandleTypeDef *hdac, uint32_t Channel);
428
HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef *hdac, 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(DAC_HandleTypeDef *hdac);
438
uint32_t HAL_DAC_GetError(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
 
61 mjames 473
#endif /* STM32L1xx_HAL_DAC_H */
56 mjames 474
 
475
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/