tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F0/stm32f0xx_hal_dac.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f0xx_hal_dac.h
   4   * @author  MCD Application Team
   5   * @version V1.2.0
   6   * @date    11-December-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 __STM32F0xx_HAL_DAC_H
  40 #define __STM32F0xx_HAL_DAC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 #if defined(STM32F051x8) || defined(STM32F058xx) || \
  47     defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || \
  48     defined(STM32F091xC) || defined(STM32F098xx)
  49
  50 /* Includes ------------------------------------------------------------------*/
  51 #include "stm32f0xx_hal_def.h"
  52
  53 /** @addtogroup STM32F0xx_HAL_Driver
  54   * @{
  55   */
  56
  57 /** @addtogroup DAC
  58   * @{
  59   */
  60
  61 /* Exported types ------------------------------------------------------------*/
  62
  63 /** @defgroup DAC_Exported_Types DAC Exported Types
  64   * @{
  65   */
  66
  67 /**
  68   * @brief  HAL State structures definition
  69   */
  70 typedef enum
  71 {
  72   HAL_DAC_STATE_RESET             = 0x00,  /*!< DAC not yet initialized or disabled  */
  73   HAL_DAC_STATE_READY             = 0x01,  /*!< DAC initialized and ready for use    */
  74   HAL_DAC_STATE_BUSY              = 0x02,  /*!< DAC internal processing is ongoing   */
  75   HAL_DAC_STATE_TIMEOUT           = 0x03,  /*!< DAC timeout state                    */
  76   HAL_DAC_STATE_ERROR             = 0x04   /*!< DAC error state                      */
  77
  78 }HAL_DAC_StateTypeDef;
  79
  80 /**
  81   * @brief  DAC handle Structure definition
  82   */
  83 typedef struct
  84 {
  85   DAC_TypeDef                 *Instance;     /*!< Register base address             */
  86
  87   __IO HAL_DAC_StateTypeDef   State;         /*!< DAC communication state           */
  88
  89   HAL_LockTypeDef             Lock;          /*!< DAC locking object                */
  90
  91   DMA_HandleTypeDef           *DMA_Handle1;  /*!< Pointer DMA handler for channel 1 */
  92
  93   DMA_HandleTypeDef           *DMA_Handle2;  /*!< Pointer DMA handler for channel 2 */
  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 #define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02    /*!< DAC channel2 DAM underrun error   */
 128 #define  HAL_DAC_ERROR_DMA               0x04    /*!< DMA error                         */
 129 /**
 130   * @}
 131   */
 132
 133 /** @defgroup DAC_output_buffer DAC output buffer
 134   * @{
 135   */
 136 #define DAC_OUTPUTBUFFER_ENABLE            ((uint32_t)0x00000000)
 137 #define DAC_OUTPUTBUFFER_DISABLE           ((uint32_t)DAC_CR_BOFF1)
 138
 139 #define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
 140                                            ((STATE) == DAC_OUTPUTBUFFER_DISABLE))
 141 /**
 142   * @}
 143   */
 144
 145 /** @defgroup DAC_data_alignement DAC data alignement
 146   * @{
 147   */
 148 #define DAC_ALIGN_12B_R                    ((uint32_t)0x00000000)
 149 #define DAC_ALIGN_12B_L                    ((uint32_t)0x00000004)
 150 #define DAC_ALIGN_8B_R                     ((uint32_t)0x00000008)
 151
 152 #define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \
 153                              ((ALIGN) == DAC_ALIGN_12B_L) || \
 154                              ((ALIGN) == DAC_ALIGN_8B_R))
 155 /**
 156   * @}
 157   */
 158
 159 /** @defgroup DAC_data DAC data
 160   * @{
 161   */
 162 #define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0)
 163 /**
 164   * @}
 165   */
 166
 167 /** @defgroup DAC_flags_definition DAC flags definition
 168   * @{
 169   */
 170 #define DAC_FLAG_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
 171 #define DAC_FLAG_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
 172 /**
 173   * @}
 174   */
 175
 176 /** @defgroup DAC_IT_definition  DAC IT definition
 177   * @{
 178   */
 179 #define DAC_IT_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
 180 #define DAC_IT_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
 181 /**
 182   * @}
 183   */
 184
 185 /**
 186   * @}
 187   */
 188
 189 /* Exported macro ------------------------------------------------------------*/
 190
 191 /** @defgroup DAC_Exported_Macros DAC Exported Macros
 192   * @{
 193   */
 194
 195 /** @brief Reset DAC handle state
 196   * @param  __HANDLE__: specifies the DAC handle.
 197   * @retval None
 198   */
 199 #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET)
 200
 201 /** @brief Enable the DAC channel
 202   * @param  __HANDLE__: specifies the DAC handle.
 203   * @param  __DAC_Channel__: specifies the DAC channel
 204   * @retval None
 205   */
 206 #define __HAL_DAC_ENABLE(__HANDLE__, __DAC_Channel__) \
 207 ((__HANDLE__)->Instance->CR |=  (DAC_CR_EN1 << (__DAC_Channel__)))
 208
 209 /** @brief Disable the DAC channel
 210   * @param  __HANDLE__: specifies the DAC handle
 211   * @param  __DAC_Channel__: specifies the DAC channel.
 212   * @retval None
 213   */
 214 #define __HAL_DAC_DISABLE(__HANDLE__, __DAC_Channel__) \
 215 ((__HANDLE__)->Instance->CR &=  ~(DAC_CR_EN1 << (__DAC_Channel__)))
 216
 217 /** @brief Set DHR12R1 alignment
 218   * @param  __ALIGNEMENT__: specifies the DAC alignement
 219   * @retval None
 220   */
 221 #define __HAL_DHR12R1_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000008) + (__ALIGNEMENT__))
 222
 223 /** @brief  Set DHR12R2 alignment
 224   * @param  __ALIGNEMENT__: specifies the DAC alignement
 225   * @retval None
 226   */
 227 #define __HAL_DHR12R2_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000014) + (__ALIGNEMENT__))
 228
 229 /** @brief  Set DHR12RD alignment
 230   * @param  __ALIGNEMENT__: specifies the DAC alignement
 231   * @retval None
 232   */
 233 #define __HAL_DHR12RD_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000020) + (__ALIGNEMENT__))
 234
 235 /** @brief Enable the DAC interrupt
 236   * @param  __HANDLE__: specifies the DAC handle
 237   * @param  __INTERRUPT__: specifies the DAC interrupt.
 238   * @retval None
 239   */
 240 #define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
 241
 242 /** @brief Disable the DAC interrupt
 243   * @param  __HANDLE__: specifies the DAC handle
 244   * @param  __INTERRUPT__: specifies the DAC interrupt.
 245   * @retval None
 246   */
 247 #define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
 248
 249 /** @brief  Get the selected DAC's flag status.
 250   * @param  __HANDLE__: specifies the DAC handle.
 251   * @param  __FLAG__: specifies the FLAG.
 252   * @retval None
 253   */
 254 #define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 255
 256 /** @brief  Clear the DAC's flag.
 257   * @param  __HANDLE__: specifies the DAC handle.
 258   * @param  __FLAG__: specifies the FLAG.
 259   * @retval None
 260   */
 261 #define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__))
 262
 263 /**
 264   * @}
 265   */
 266
 267
 268 /* Include DAC HAL Extension module */
 269 #include "stm32f0xx_hal_dac_ex.h"
 270
 271 /* Exported functions --------------------------------------------------------*/
 272
 273 /** @addtogroup DAC_Exported_Functions
 274   * @{
 275   */
 276
 277 /** @addtogroup DAC_Exported_Functions_Group1
 278   * @{
 279   */
 280 /* Initialization and de-initialization functions *****************************/
 281 HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef* hdac);
 282 HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef* hdac);
 283 void HAL_DAC_MspInit(DAC_HandleTypeDef* hdac);
 284 void HAL_DAC_MspDeInit(DAC_HandleTypeDef* hdac);
 285
 286 /**
 287   * @}
 288   */
 289
 290 /** @addtogroup DAC_Exported_Functions_Group2
 291  * @{
 292  */
 293 /* IO operation functions *****************************************************/
 294 HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef* hdac, uint32_t Channel);
 295 HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef* hdac, uint32_t Channel);
 296 HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t* pData, uint32_t Length, uint32_t Alignment);
 297 HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel);
 298
 299 void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef* hdac);
 300 void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef* hdac);
 301 void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);
 302 void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);
 303 /**
 304   * @}
 305   */
 306
 307 /** @addtogroup DAC_Exported_Functions_Group3
 308   * @{
 309   */
 310 /* Peripheral Control functions ***********************************************/
 311 HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef* hdac, DAC_ChannelConfTypeDef* sConfig, uint32_t Channel);
 312 HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data);
 313 uint32_t HAL_DAC_GetValue(DAC_HandleTypeDef* hdac, uint32_t Channel);
 314 /**
 315   * @}
 316   */
 317
 318 /** @addtogroup DAC_Exported_Functions_Group4
 319   * @{
 320   */
 321 /* Peripheral State and Error functions ***************************************/
 322 HAL_DAC_StateTypeDef HAL_DAC_GetState(DAC_HandleTypeDef* hdac);
 323 void HAL_DAC_IRQHandler(DAC_HandleTypeDef* hdac);
 324 uint32_t HAL_DAC_GetError(DAC_HandleTypeDef *hdac);
 325
 326 /**
 327   * @}
 328   */
 329
 330 /**
 331   * @}
 332   */
 333
 334 /**
 335   * @}
 336   */
 337
 338 /**
 339   * @}
 340   */
 341
 342 #endif /* STM32F051x8 || STM32F058xx ||                */
 343        /* STM32F071xB || STM32F072xB || STM32F078xx || */
 344        /* STM32F091xC || STM32F098xx */
 345
 346 #ifdef __cplusplus
 347 }
 348 #endif
 349
 350
 351 #endif /*__STM32F0xx_HAL_DAC_H */
 352
 353 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
 354