tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32L1/stm32l1xx_hal_dac.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32l1xx_hal_dac.h
   4   * @author  MCD Application Team
   5   * @version V1.0.0
   6   * @date    5-September-2014
   7   * @brief   Header file of DAC HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 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 __STM32L1xx_HAL_DAC_H
  40 #define __STM32L1xx_HAL_DAC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32l1xx_hal_def.h"
  48
  49 /** @addtogroup STM32L1xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup DAC
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58
  59 /** @defgroup DAC_Exported_Types DAC Exported Types
  60   * @{
  61   */
  62
  63 /**
  64   * @brief  HAL State structures definition
  65   */
  66 typedef enum
  67 {
  68   HAL_DAC_STATE_RESET             = 0x00,  /*!< DAC not yet initialized or disabled  */
  69   HAL_DAC_STATE_READY             = 0x01,  /*!< DAC initialized and ready for use    */
  70   HAL_DAC_STATE_BUSY              = 0x02,  /*!< DAC internal processing is ongoing   */
  71   HAL_DAC_STATE_TIMEOUT           = 0x03,  /*!< DAC timeout state                    */
  72   HAL_DAC_STATE_ERROR             = 0x04   /*!< DAC error state                      */
  73
  74 }HAL_DAC_StateTypeDef;
  75
  76 /**
  77   * @brief  DAC handle Structure definition
  78   */
  79 typedef struct
  80 {
  81   DAC_TypeDef                 *Instance;     /*!< Register base address             */
  82
  83   __IO HAL_DAC_StateTypeDef   State;         /*!< DAC communication state           */
  84
  85   HAL_LockTypeDef             Lock;          /*!< DAC locking object                */
  86
  87   DMA_HandleTypeDef           *DMA_Handle1;  /*!< Pointer DMA handler for channel 1 */
  88
  89   DMA_HandleTypeDef           *DMA_Handle2;  /*!< Pointer DMA handler for channel 2 */
  90
  91   __IO uint32_t               ErrorCode;     /*!< DAC Error code                    */
  92
  93 }DAC_HandleTypeDef;
  94
  95 /**
  96   * @brief   DAC Configuration regular Channel structure definition
  97   */
  98 typedef struct
  99 {
 100   uint32_t DAC_Trigger;       /*!< Specifies the external trigger for the selected DAC channel.
 101                                    This parameter can be a value of @ref DAC_trigger_selection */
 102
 103   uint32_t DAC_OutputBuffer;  /*!< Specifies whether the DAC channel output buffer is enabled or disabled.
 104                                    This parameter can be a value of @ref DAC_output_buffer */
 105
 106 }DAC_ChannelConfTypeDef;
 107
 108 /**
 109   * @}
 110   */
 111
 112 /* Exported constants --------------------------------------------------------*/
 113
 114 /** @defgroup DAC_Exported_Constants DAC Exported Constants
 115   * @{
 116   */
 117
 118 /** @defgroup DAC_Error_Code DAC Error Code
 119   * @{
 120   */
 121 #define  HAL_DAC_ERROR_NONE              0x00    /*!< No error                          */
 122 #define  HAL_DAC_ERROR_DMAUNDERRUNCH1    0x01    /*!< DAC channel1 DAM underrun error   */
 123 #define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02    /*!< DAC channel2 DAM underrun error   */
 124 #define  HAL_DAC_ERROR_DMA               0x04    /*!< DMA error                         */
 125 /**
 126   * @}
 127   */
 128
 129 /** @defgroup DAC_trigger_selection DAC trigger selection
 130   * @{
 131   */
 132 #define DAC_TRIGGER_NONE                   ((uint32_t)0x00000000) /*!< Conversion is automatic once the DAC1_DHRxxxx register
 133                                                                        has been loaded, and not by external trigger */
 134 #define DAC_TRIGGER_T6_TRGO                ((uint32_t)                                                    DAC_CR_TEN1)  /*!< TIM6 TRGO selected as external conversion trigger for DAC channel */
 135 #define DAC_TRIGGER_T7_TRGO                ((uint32_t)(                 DAC_CR_TSEL1_1                  | DAC_CR_TEN1)) /*!< TIM7 TRGO selected as external conversion trigger for DAC channel */
 136 #define DAC_TRIGGER_T9_TRGO                ((uint32_t)(                 DAC_CR_TSEL1_1 | DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM9 TRGO selected as external conversion trigger for DAC channel */
 137 #define DAC_TRIGGER_T2_TRGO                ((uint32_t)(DAC_CR_TSEL1_2                                   | DAC_CR_TEN1)) /*!< TIM2 TRGO selected as external conversion trigger for DAC channel */
 138 #define DAC_TRIGGER_T4_TRGO                ((uint32_t)(DAC_CR_TSEL1_2                  | DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM4 TRGO selected as external conversion trigger for DAC channel */
 139 #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 */
 140 #define DAC_TRIGGER_SOFTWARE               ((uint32_t)(DAC_CR_TSEL1                                     | DAC_CR_TEN1)) /*!< Conversion started by software trigger for DAC channel */
 141
 142 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE)    || \
 143                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO) || \
 144                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO) || \
 145                                  ((TRIGGER) == DAC_TRIGGER_T9_TRGO) || \
 146                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO) || \
 147                                  ((TRIGGER) == DAC_TRIGGER_T4_TRGO) || \
 148                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9) || \
 149                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))
 150 /**
 151   * @}
 152   */
 153
 154 /** @defgroup DAC_output_buffer DAC output buffer
 155   * @{
 156   */
 157 #define DAC_OUTPUTBUFFER_ENABLE            ((uint32_t)0x00000000)
 158 #define DAC_OUTPUTBUFFER_DISABLE           ((uint32_t)DAC_CR_BOFF1)
 159
 160 #define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
 161                                            ((STATE) == DAC_OUTPUTBUFFER_DISABLE))
 162 /**
 163   * @}
 164   */
 165
 166 /** @defgroup DAC_Channel_selection DAC Channel selection
 167   * @{
 168   */
 169 #define DAC_CHANNEL_1                      ((uint32_t)0x00000000)
 170 #define DAC_CHANNEL_2                      ((uint32_t)0x00000010)
 171
 172 #define IS_DAC_CHANNEL(CHANNEL) (((CHANNEL) == DAC_CHANNEL_1) || \
 173                                  ((CHANNEL) == DAC_CHANNEL_2))
 174 /**
 175   * @}
 176   */
 177
 178 /** @defgroup DAC_data_alignement DAC data alignement
 179   * @{
 180   */
 181 #define DAC_ALIGN_12B_R                    ((uint32_t)0x00000000)
 182 #define DAC_ALIGN_12B_L                    ((uint32_t)0x00000004)
 183 #define DAC_ALIGN_8B_R                     ((uint32_t)0x00000008)
 184
 185 #define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \
 186                              ((ALIGN) == DAC_ALIGN_12B_L) || \
 187                              ((ALIGN) == DAC_ALIGN_8B_R))
 188 /**
 189   * @}
 190   */
 191
 192 /** @defgroup DAC_data DAC data
 193   * @{
 194   */
 195 #define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0)
 196 /**
 197   * @}
 198   */
 199
 200 /** @defgroup DAC_flags_definition DAC flags definition
 201   * @{
 202   */
 203 #define DAC_FLAG_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
 204 #define DAC_FLAG_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
 205
 206 /**
 207   * @}
 208   */
 209
 210 /** @defgroup DAC_IT_definition DAC IT definition
 211   * @{
 212   */
 213 #define DAC_IT_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
 214 #define DAC_IT_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
 215
 216 /**
 217   * @}
 218   */
 219
 220 /**
 221   * @}
 222   */
 223
 224 /* Exported macro ------------------------------------------------------------*/
 225
 226 /** @defgroup DAC_Exported_Macros DAC Exported Macros
 227   * @{
 228   */
 229
 230 /** @brief Reset DAC handle state
 231   * @param  __HANDLE__: specifies the DAC handle.
 232   * @retval None
 233   */
 234 #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET)
 235
 236 /** @brief Enable the DAC channel
 237   * @param  __HANDLE__: specifies the DAC handle.
 238   * @param  __DAC_Channel__: specifies the DAC channel
 239   * @retval None
 240   */
 241 #define __HAL_DAC_ENABLE(__HANDLE__, __DAC_Channel__) \
 242 ((__HANDLE__)->Instance->CR |=  (DAC_CR_EN1 << (__DAC_Channel__)))
 243
 244 /** @brief Disable the DAC channel
 245   * @param  __HANDLE__: specifies the DAC handle
 246   * @param  __DAC_Channel__: specifies the DAC channel.
 247   * @retval None
 248   */
 249 #define __HAL_DAC_DISABLE(__HANDLE__, __DAC_Channel__) \
 250 ((__HANDLE__)->Instance->CR &=  ~(DAC_CR_EN1 << (__DAC_Channel__)))
 251
 252 /** @brief Set DHR12R1 alignment
 253   * @param  __ALIGNEMENT__: specifies the DAC alignement
 254   * @retval None
 255   */
 256 #define __HAL_DHR12R1_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000008) + (__ALIGNEMENT__))
 257
 258 /** @brief  Set DHR12R2 alignment
 259   * @param  __ALIGNEMENT__: specifies the DAC alignement
 260   * @retval None
 261   */
 262 #define __HAL_DHR12R2_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000014) + (__ALIGNEMENT__))
 263
 264 /** @brief  Set DHR12RD alignment
 265   * @param  __ALIGNEMENT__: specifies the DAC alignement
 266   * @retval None
 267   */
 268 #define __HAL_DHR12RD_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000020) + (__ALIGNEMENT__))
 269
 270 /** @brief Enable the DAC interrupt
 271   * @param  __HANDLE__: specifies the DAC handle
 272   * @param  __INTERRUPT__: specifies the DAC interrupt.
 273   * @retval None
 274   */
 275 #define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
 276
 277 /** @brief Disable the DAC interrupt
 278   * @param  __HANDLE__: specifies the DAC handle
 279   * @param  __INTERRUPT__: specifies the DAC interrupt.
 280   * @retval None
 281   */
 282 #define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
 283
 284 /** @brief  Get the selected DAC's flag status.
 285   * @param  __HANDLE__: specifies the DAC handle.
 286   * @param  __FLAG__: specifies the FLAG.
 287   * @retval None
 288   */
 289 #define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 290
 291 /** @brief  Clear the DAC's flag.
 292   * @param  __HANDLE__: specifies the DAC handle.
 293   * @param  __FLAG__: specifies the FLAG.
 294   * @retval None
 295   */
 296 #define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__))
 297
 298 /**
 299   * @}
 300   */
 301
 302
 303 /* Include DAC HAL Extension module */
 304 #include "stm32l1xx_hal_dac_ex.h"
 305
 306 /* Exported functions --------------------------------------------------------*/
 307
 308 /** @addtogroup DAC_Exported_Functions
 309   * @{
 310   */
 311
 312 /** @addtogroup DAC_Exported_Functions_Group1
 313   * @{
 314   */
 315 /* Initialization and de-initialization functions *****************************/
 316 HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef* hdac);
 317 HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef* hdac);
 318 void HAL_DAC_MspInit(DAC_HandleTypeDef* hdac);
 319 void HAL_DAC_MspDeInit(DAC_HandleTypeDef* hdac);
 320
 321 /**
 322   * @}
 323   */
 324
 325 /** @addtogroup DAC_Exported_Functions_Group2
 326   * @{
 327   */
 328 /* IO operation functions *****************************************************/
 329 HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef* hdac, uint32_t Channel);
 330 HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef* hdac, uint32_t Channel);
 331 HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t* pData, uint32_t Length, uint32_t Alignment);
 332 HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel);
 333 HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data);
 334 uint32_t HAL_DAC_GetValue(DAC_HandleTypeDef* hdac, uint32_t Channel);
 335
 336 /**
 337   * @}
 338   */
 339
 340 /** @addtogroup DAC_Exported_Functions_Group2
 341   * @{
 342   */
 343 /* Peripheral Control functions ***********************************************/
 344 HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef* hdac, DAC_ChannelConfTypeDef* sConfig, uint32_t Channel);
 345
 346 /**
 347   * @}
 348   */
 349
 350 /** @addtogroup DAC_Exported_Functions_Group2
 351   * @{
 352   */
 353 /* Peripheral State functions ***************************************************/
 354 HAL_DAC_StateTypeDef HAL_DAC_GetState(DAC_HandleTypeDef* hdac);
 355 void HAL_DAC_IRQHandler(DAC_HandleTypeDef* hdac);
 356 uint32_t HAL_DAC_GetError(DAC_HandleTypeDef *hdac);
 357
 358 void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef* hdac);
 359 void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef* hdac);
 360 void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);
 361 void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);
 362
 363 /**
 364   * @}
 365   */
 366
 367 /**
 368   * @}
 369   */
 370
 371 /**
 372   * @}
 373   */
 374
 375 /**
 376   * @}
 377   */
 378
 379 #ifdef __cplusplus
 380 }
 381 #endif
 382
 383 #endif /*__STM32L1xx_HAL_DAC_H */
 384
 385 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/