Subversion Repositories testOled

Rev

Details | Last modification | View Log | RSS feed

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