tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32L0/stm32l0xx_hal_dac.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32l0xx_hal_dac.h
   4   * @author  MCD Application Team
   5   * @version V1.2.0
   6   * @date    06-February-2015
   7   * @brief   Header file of DAC HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32L0xx_HAL_DAC_H
  40 #define __STM32L0xx_HAL_DAC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 #if !defined (STM32L031xx) && !defined (STM32L041xx) && !defined (STM32L051xx) && !defined (STM32L061xx) && !defined (STM32L071xx) && !defined (STM32L081xx)
  47
  48 /* Includes ------------------------------------------------------------------*/
  49 #include "stm32l0xx_hal_def.h"
  50
  51 /** @addtogroup STM32L0xx_HAL_Driver
  52   * @{
  53   */
  54
  55 /** @addtogroup DAC
  56   * @{
  57   */
  58
  59 /* Exported types ------------------------------------------------------------*/
  60
  61 /** @defgroup DAC_Exported_Types DAC Exported Types
  62   * @{
  63   */
  64
  65 /**
  66   * @brief  HAL State structures definition
  67   */
  68 typedef enum
  69 {
  70   HAL_DAC_STATE_RESET             = 0x00,  /*!< DAC not yet initialized or disabled  */
  71   HAL_DAC_STATE_READY             = 0x01,  /*!< DAC initialized and ready for use    */
  72   HAL_DAC_STATE_BUSY              = 0x02,  /*!< DAC internal processing is ongoing   */
  73   HAL_DAC_STATE_TIMEOUT           = 0x03,  /*!< DAC timeout state                    */
  74   HAL_DAC_STATE_ERROR             = 0x04   /*!< DAC error state                      */
  75
  76 }HAL_DAC_StateTypeDef;
  77
  78 /**
  79   * @brief  DAC handle Structure definition
  80   */
  81 typedef struct
  82 {
  83   DAC_TypeDef                 *Instance;     /*!< Register base address             */
  84
  85   __IO HAL_DAC_StateTypeDef   State;         /*!< DAC communication state           */
  86
  87   HAL_LockTypeDef             Lock;          /*!< DAC locking object                */
  88
  89   DMA_HandleTypeDef           *DMA_Handle1;  /*!< Pointer DMA handler for channel 1 */
  90
  91 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
  92   DMA_HandleTypeDef           *DMA_Handle2;  /*!< Pointer DMA handler for channel 2 */
  93 #endif
  94
  95   __IO uint32_t               ErrorCode;     /*!< DAC Error code                   */
  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 /**
 113   * @}
 114   */
 115
 116 /* Exported constants --------------------------------------------------------*/
 117
 118 /** @defgroup DAC_Exported_Constants DAC Exported Constants
 119   * @{
 120   */
 121
 122 /** @defgroup DAC_Error_Code DAC Error Code
 123   * @{
 124   */
 125 #define  HAL_DAC_ERROR_NONE              0x00    /*!< No error                          */
 126 #define  HAL_DAC_ERROR_DMAUNDERRUNCH1    0x01    /*!< DAC channel1 DAM underrun error   */
 127 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 128 #define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02    /*!< DAC channel2 DAM underrun error   */
 129 #endif
 130 #define  HAL_DAC_ERROR_DMA               0x04    /*!< DMA error                         */
 131 /**
 132   * @}
 133   */
 134
 135 /** @defgroup DAC_trigger_selection DAC trigger selection
 136   * @{
 137   */
 138 #define DAC_TRIGGER_NONE      ((uint32_t)0x00000000) /*!< Conversion is automatic once the DAC1_DHRxxxx register has been loaded, and not by external trigger */
 139 #define DAC_TRIGGER_T6_TRGO   ((uint32_t)                                                    DAC_CR_TEN1)  /*!< TIM6 TRGO selected as external conversion trigger for DAC channel */
 140 #define DAC_TRIGGER_T21_TRGO  ((uint32_t)(                 DAC_CR_TSEL1_1 | DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM21 TRGO selected as external conversion trigger for DAC channel */
 141 #define DAC_TRIGGER_T2_TRGO   ((uint32_t)(DAC_CR_TSEL1_2 |                                   DAC_CR_TEN1)) /*!< TIM2 TRGO selected as external conversion trigger for DAC channel */
 142 #define DAC_TRIGGER_EXT_IT9   ((uint32_t)(DAC_CR_TSEL1_2 | DAC_CR_TSEL1_1 |                  DAC_CR_TEN1)) /*!< EXTI Line9 event selected as external conversion trigger for DAC channel */
 143 #define DAC_TRIGGER_SOFTWARE  ((uint32_t)(DAC_CR_TSEL1_2 | DAC_CR_TSEL1_1 | DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< Conversion started by software trigger for DAC channel */
 144
 145 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 146 #define DAC_TRIGGER_T3_TRGO   ((uint32_t)(                                  DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM3  TRGO selected as external conversion trigger for DAC channel */
 147 #define DAC_TRIGGER_T7_TRGO   ((uint32_t)(DAC_CR_TSEL1_2 |                  DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM7  TRGO selected as external conversion trigger for DAC channel */
 148 #endif
 149
 150 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 151 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)     || \
 152                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO)  || \
 153                                  ((TRIGGER) == DAC_TRIGGER_T3_TRGO)  || \
 154                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO)  || \
 155                                  ((TRIGGER) == DAC_TRIGGER_T21_TRGO) || \
 156                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO)  || \
 157                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9)  || \
 158                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
 159 #else /* STM32L072xx || STM32L073xx || STM32L082xx || STM32L083xx */
 160 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)     || \
 161                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO)  || \
 162                                  ((TRIGGER) == DAC_TRIGGER_T21_TRGO) || \
 163                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO)  || \
 164                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9)  || \
 165                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
 166 #endif /* STM32L072xx || STM32L073xx || STM32L082xx || STM32L083xx */
 167 /**
 168   * @}
 169   */
 170
 171 /** @defgroup DAC_output_buffer DAC output buffer
 172   * @{
 173   */
 174 #define DAC_OUTPUTBUFFER_ENABLE            ((uint32_t)0x00000000)
 175 #define DAC_OUTPUTBUFFER_DISABLE           ((uint32_t)DAC_CR_BOFF1)
 176
 177 #define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
 178                                            ((STATE) == DAC_OUTPUTBUFFER_DISABLE))
 179 /**
 180   * @}
 181   */
 182
 183 /** @defgroup DAC_Channel_selection DAC Channel selection
 184   * @{
 185   */
 186 #define DAC_CHANNEL_1                      ((uint32_t)0x00000000)
 187 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 188 #define DAC_CHANNEL_2                      ((uint32_t)0x00000010)
 189 #endif
 190
 191 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 192 #define IS_DAC_CHANNEL(CHANNEL) (((CHANNEL) == DAC_CHANNEL_1) || \
 193                                  ((CHANNEL) == DAC_CHANNEL_2))
 194 #else
 195 #define IS_DAC_CHANNEL(CHANNEL) ((CHANNEL) == DAC_CHANNEL_1)
 196 #endif
 197 /**
 198   * @}
 199   */
 200
 201 /** @defgroup DAC_data_alignement DAC data alignement
 202   * @{
 203   */
 204 #define DAC_ALIGN_12B_R                    ((uint32_t)0x00000000)
 205 #define DAC_ALIGN_12B_L                    ((uint32_t)0x00000004)
 206 #define DAC_ALIGN_8B_R                     ((uint32_t)0x00000008)
 207
 208 #define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \
 209                              ((ALIGN) == DAC_ALIGN_12B_L) || \
 210                              ((ALIGN) == DAC_ALIGN_8B_R))
 211 /**
 212   * @}
 213   */
 214
 215 /** @defgroup DAC_data DAC data
 216   * @{
 217   */
 218 #define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0)
 219 /**
 220   * @}
 221   */
 222
 223 /** @defgroup DAC_flags_definition DAC flags definition
 224   * @{
 225   */
 226 #define DAC_FLAG_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
 227 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 228 #define DAC_FLAG_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
 229 #endif
 230
 231 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 232 #define IS_DAC_FLAG(FLAG) (((FLAG) == DAC_FLAG_DMAUDR1) || \
 233                            ((FLAG) == DAC_FLAG_DMAUDR2))
 234 #else
 235 #define IS_DAC_FLAG(FLAG)  ((FLAG) == DAC_FLAG_DMAUDR1)
 236 #endif
 237 /**
 238   * @}
 239   */
 240
 241 /** @defgroup DAC_IT_definition DAC IT definition
 242   * @{
 243   */
 244 #define DAC_IT_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
 245 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 246 #define DAC_IT_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
 247 #endif
 248
 249 #if defined (STM32L072xx) || defined (STM32L073xx) || defined (STM32L082xx) || defined (STM32L083xx)
 250 #define IS_DAC_IT(IT) (((IT) == DAC_IT_DMAUDR1) || \
 251                        ((IT) == DAC_IT_DMAUDR2))
 252 #else
 253 #define IS_DAC_IT(IT) ((IT) == DAC_IT_DMAUDR1)
 254 #endif
 255
 256 /**
 257   * @}
 258   */
 259
 260 /**
 261   * @}
 262   */
 263
 264 /* Exported macro ------------------------------------------------------------*/
 265
 266 /** @defgroup DAC_Exported_Macros DAC Exported Macros
 267   * @{
 268   */
 269
 270 /** @brief Reset DAC handle state
 271   * @param  __HANDLE__: specifies the DAC handle.
 272   * @retval None
 273   */
 274 #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET)
 275
 276 /** @brief Enable the DAC channel
 277   * @param  __HANDLE__: specifies the DAC handle.
 278   * @param  __DAC_CHANNEL__: specifies the DAC channel
 279   * @retval None
 280   */
 281 #define __HAL_DAC_ENABLE(__HANDLE__, __DAC_CHANNEL__) \
 282 SET_BIT((__HANDLE__)->Instance->CR, (DAC_CR_EN1 << (__DAC_CHANNEL__)))
 283
 284 /** @brief Disable the DAC channel
 285   * @param  __HANDLE__: specifies the DAC handle
 286   * @param  __DAC_CHANNEL__: specifies the DAC channel.
 287   * @retval None
 288   */
 289 #define __HAL_DAC_DISABLE(__HANDLE__, __DAC_CHANNEL__) \
 290 CLEAR_BIT((__HANDLE__)->Instance->CR, (DAC_CR_EN1 << (__DAC_CHANNEL__)))
 291
 292 /** @brief Set DHR12R1 alignment
 293   * @param  __ALIGNEMENT__: specifies the DAC alignement
 294   * @retval None
 295   */
 296 #define __DAC_DHR12R1_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000008) + (__ALIGNEMENT__))
 297
 298 /** @brief  Set DHR12R2 alignment
 299   * @param  __ALIGNEMENT__: specifies the DAC alignement
 300   * @retval None
 301   */
 302 #define __DAC_DHR12R2_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000014) + (__ALIGNEMENT__))
 303
 304 /** @brief  Set DHR12RD alignment
 305   * @param  __ALIGNEMENT__: specifies the DAC alignement
 306   * @retval None
 307   */
 308 #define __DAC_DHR12RD_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000020) + (__ALIGNEMENT__))
 309
 310 /** @brief Enable the DAC interrupt
 311   * @param  __HANDLE__: specifies the DAC handle
 312   * @param  __INTERRUPT__: specifies the DAC interrupt.
 313   * @retval None
 314   */
 315 #define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) \
 316 SET_BIT((__HANDLE__)->Instance->CR, __INTERRUPT__)
 317
 318
 319 /** @brief Disable the DAC interrupt
 320   * @param  __HANDLE__: specifies the DAC handle
 321   * @param  __INTERRUPT__: specifies the DAC interrupt.
 322   * @retval None
 323   */
 324 #define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) \
 325 CLEAR_BIT((__HANDLE__)->Instance->CR, __INTERRUPT__)
 326
 327
 328 /** @brief  Get the selected DAC's flag status.
 329   * @param  __HANDLE__: specifies the DAC handle.
 330   * @param  __FLAG__: specifies the FLAG.
 331   * @retval None
 332   */
 333 #define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 334
 335 /** @brief  Clear the DAC's flag.
 336   * @param  __HANDLE__: specifies the DAC handle.
 337   * @param  __FLAG__: specifies the FLAG.
 338   * @retval None
 339   */
 340 #define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__))
 341
 342 /**
 343   * @}
 344   */
 345
 346
 347 /* Include DAC HAL Extension module */
 348 #include "stm32l0xx_hal_dac_ex.h"
 349
 350 /* Exported functions --------------------------------------------------------*/
 351
 352 /** @addtogroup DAC_Exported_Functions
 353   * @{
 354   */
 355
 356 /** @addtogroup DAC_Exported_Functions_Group1
 357   * @{
 358   */
 359 /* Initialization and de-initialization functions *****************************/
 360 HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef* hdac);
 361 HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef* hdac);
 362 void HAL_DAC_MspInit(DAC_HandleTypeDef* hdac);
 363 void HAL_DAC_MspDeInit(DAC_HandleTypeDef* hdac);
 364
 365 /**
 366   * @}
 367   */
 368
 369 /** @addtogroup DAC_Exported_Functions_Group2
 370   * @{
 371   */
 372 /* IO operation functions *****************************************************/
 373 HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef* hdac, uint32_t Channel);
 374 HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef* hdac, uint32_t Channel);
 375 HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t* pData, uint32_t Length, uint32_t Alignment);
 376 HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel);
 377 HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data);
 378 uint32_t HAL_DAC_GetValue(DAC_HandleTypeDef* hdac, uint32_t Channel);
 379
 380 /**
 381   * @}
 382   */
 383
 384 /** @addtogroup DAC_Exported_Functions_Group2
 385   * @{
 386   */
 387 /* Peripheral Control functions ***********************************************/
 388 HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef* hdac, DAC_ChannelConfTypeDef* sConfig, uint32_t Channel);
 389
 390 /**
 391   * @}
 392   */
 393
 394 /** @addtogroup DAC_Exported_Functions_Group2
 395   * @{
 396   */
 397 /* Peripheral State functions ***************************************************/
 398 HAL_DAC_StateTypeDef HAL_DAC_GetState(DAC_HandleTypeDef* hdac);
 399 void HAL_DAC_IRQHandler(DAC_HandleTypeDef* hdac);
 400 uint32_t HAL_DAC_GetError(DAC_HandleTypeDef *hdac);
 401
 402 void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef* hdac);
 403 void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef* hdac);
 404 void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);
 405 void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);
 406
 407 /**
 408   * @}
 409   */
 410
 411 /**
 412   * @}
 413   */
 414
 415
 416 /**
 417   * @}
 418   */
 419
 420 /**
 421   * @}
 422   */
 423
 424 #endif /* STM32L031xx && STM32L041xx && STM32L061xx && STM32L071xx && STM32L081xx*/
 425
 426 #ifdef __cplusplus
 427 }
 428 #endif
 429
 430 #endif /*__STM32L0xx_HAL_DAC_H */
 431
 432 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/