tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_dac.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_dac.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    12-Sept-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 __STM32F3xx_HAL_DAC_H
  40 #define __STM32F3xx_HAL_DAC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f3xx_hal_def.h"
  48
  49 /** @addtogroup STM32F3xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup DAC DAC HAL module driver
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /** @defgroup DAC_Exported_Types DAC Exported Types
  59   * @{
  60   */
  61
  62 /**
  63   * @brief  HAL State structures definition
  64   */
  65 typedef enum
  66 {
  67   HAL_DAC_STATE_RESET             = 0x00,  /*!< DAC not yet initialized or disabled  */
  68   HAL_DAC_STATE_READY             = 0x01,  /*!< DAC initialized and ready for use    */
  69   HAL_DAC_STATE_BUSY              = 0x02,  /*!< DAC internal processing is ongoing   */
  70   HAL_DAC_STATE_TIMEOUT           = 0x03,  /*!< DAC timeout state                    */
  71   HAL_DAC_STATE_ERROR             = 0x04   /*!< DAC error state                      */
  72
  73 }HAL_DAC_StateTypeDef;
  74
  75
  76 /**
  77   * @brief   DAC Configuration regular Channel structure definition
  78   */
  79 typedef struct
  80 {
  81   uint32_t DAC_Trigger;                 /*!< Specifies the external trigger for the selected DAC channel.
  82                                         This parameter can be a value of @ref DACEx_trigger_selection */
  83
  84   uint32_t DAC_OutputBuffer;            /*!< Specifies whether the DAC channel output buffer is enabled or disabled.
  85                                         This parameter can be a value of @ref DAC_output_buffer */
  86
  87 }DAC_ChannelConfTypeDef;
  88
  89 /**
  90   * @brief  DAC handle Structure definition
  91   */
  92 typedef struct __DAC_HandleTypeDef
  93 {
  94   DAC_TypeDef                 *Instance;      /*!< Register base address             */
  95
  96   __IO HAL_DAC_StateTypeDef   State;          /*!< DAC communication state           */
  97
  98   HAL_LockTypeDef             Lock;          /*!< DAC locking object                */
  99
 100   DMA_HandleTypeDef           *DMA_Handle1;  /*!< Pointer DMA handler for channel 1 */
 101
 102   DMA_HandleTypeDef           *DMA_Handle2;  /*!< Pointer DMA handler for channel 2 */
 103
 104   __IO uint32_t               ErrorCode;     /*!< DAC Error code                    */
 105
 106 }DAC_HandleTypeDef;
 107 /**
 108   * @}
 109   */
 110
 111 /* Exported constants --------------------------------------------------------*/
 112 /** @defgroup DAC_Exported_Constants DAC Exported Contants
 113   * @{
 114   */
 115
 116 /** @defgroup DAC_Error_Code DAC Error Code
 117   * @{
 118   */
 119 #define  HAL_DAC_ERROR_NONE              0x00    /*!< No error                          */
 120 #define  HAL_DAC_ERROR_DMAUNDERRUNCH1    0x01    /*!< DAC channel1 DMA underrun error   */
 121 #define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02    /*!< DAC channel2 DMA underrun error   */
 122 #define  HAL_DAC_ERROR_DMA               0x04    /*!< DMA error                         */
 123 /**
 124   * @}
 125   */
 126
 127 /** @defgroup DAC_wave_generation DAC wave generation
 128   * @{
 129   */
 130 #define DAC_WAVEGENERATION_NONE            ((uint32_t)0x00000000)
 131 #define DAC_WAVEGENERATION_NOISE           ((uint32_t)DAC_CR_WAVE1_0)
 132 #define DAC_WAVEGENERATION_TRIANGLE        ((uint32_t)DAC_CR_WAVE1_1)
 133
 134 #define IS_DAC_GENERATE_WAVE(WAVE) (((WAVE) == DAC_WAVEGENERATION_NONE) || \
 135                                     ((WAVE) == DAC_WAVEGENERATION_NOISE) || \
 136                                     ((WAVE) == DAC_WAVEGENERATION_TRIANGLE))
 137 /**
 138   * @}
 139   */
 140
 141 /** @defgroup DAC_lfsrunmask_triangleamplitude DAC lfsrunmask triangleamplitude
 142   * @{
 143   */
 144 #define DAC_LFSRUNMASK_BIT0                ((uint32_t)0x00000000) /*!< Unmask DAC channel LFSR bit0 for noise wave generation */
 145 #define DAC_LFSRUNMASK_BITS1_0             ((uint32_t)DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[1:0] for noise wave generation */
 146 #define DAC_LFSRUNMASK_BITS2_0             ((uint32_t)DAC_CR_MAMP1_1) /*!< Unmask DAC channel LFSR bit[2:0] for noise wave generation */
 147 #define DAC_LFSRUNMASK_BITS3_0             ((uint32_t)DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0)/*!< Unmask DAC channel LFSR bit[3:0] for noise wave generation */
 148 #define DAC_LFSRUNMASK_BITS4_0             ((uint32_t)DAC_CR_MAMP1_2) /*!< Unmask DAC channel LFSR bit[4:0] for noise wave generation */
 149 #define DAC_LFSRUNMASK_BITS5_0             ((uint32_t)DAC_CR_MAMP1_2 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[5:0] for noise wave generation */
 150 #define DAC_LFSRUNMASK_BITS6_0             ((uint32_t)DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1) /*!< Unmask DAC channel LFSR bit[6:0] for noise wave generation */
 151 #define DAC_LFSRUNMASK_BITS7_0             ((uint32_t)DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[7:0] for noise wave generation */
 152 #define DAC_LFSRUNMASK_BITS8_0             ((uint32_t)DAC_CR_MAMP1_3) /*!< Unmask DAC channel LFSR bit[8:0] for noise wave generation */
 153 #define DAC_LFSRUNMASK_BITS9_0             ((uint32_t)DAC_CR_MAMP1_3 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[9:0] for noise wave generation */
 154 #define DAC_LFSRUNMASK_BITS10_0            ((uint32_t)DAC_CR_MAMP1_3 | DAC_CR_MAMP1_1) /*!< Unmask DAC channel LFSR bit[10:0] for noise wave generation */
 155 #define DAC_LFSRUNMASK_BITS11_0            ((uint32_t)DAC_CR_MAMP1_3 | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Unmask DAC channel LFSR bit[11:0] for noise wave generation */
 156 #define DAC_TRIANGLEAMPLITUDE_1            ((uint32_t)0x00000000) /*!< Select max triangle amplitude of 1 */
 157 #define DAC_TRIANGLEAMPLITUDE_3            ((uint32_t)DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 3 */
 158 #define DAC_TRIANGLEAMPLITUDE_7            ((uint32_t)DAC_CR_MAMP1_1) /*!< Select max triangle amplitude of 7 */
 159 #define DAC_TRIANGLEAMPLITUDE_15           ((uint32_t)DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 15 */
 160 #define DAC_TRIANGLEAMPLITUDE_31           ((uint32_t)DAC_CR_MAMP1_2) /*!< Select max triangle amplitude of 31 */
 161 #define DAC_TRIANGLEAMPLITUDE_63           ((uint32_t)DAC_CR_MAMP1_2 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 63 */
 162 #define DAC_TRIANGLEAMPLITUDE_127          ((uint32_t)DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1) /*!< Select max triangle amplitude of 127 */
 163 #define DAC_TRIANGLEAMPLITUDE_255          ((uint32_t)DAC_CR_MAMP1_2 | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 255 */
 164 #define DAC_TRIANGLEAMPLITUDE_511          ((uint32_t)DAC_CR_MAMP1_3) /*!< Select max triangle amplitude of 511 */
 165 #define DAC_TRIANGLEAMPLITUDE_1023         ((uint32_t)DAC_CR_MAMP1_3 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 1023 */
 166 #define DAC_TRIANGLEAMPLITUDE_2047         ((uint32_t)DAC_CR_MAMP1_3 | DAC_CR_MAMP1_1) /*!< Select max triangle amplitude of 2047 */
 167 #define DAC_TRIANGLEAMPLITUDE_4095         ((uint32_t)DAC_CR_MAMP1_3 | DAC_CR_MAMP1_1 | DAC_CR_MAMP1_0) /*!< Select max triangle amplitude of 4095 */
 168
 169 #define IS_DAC_LFSR_UNMASK_TRIANGLE_AMPLITUDE(VALUE) (((VALUE) == DAC_LFSRUNMASK_BIT0) || \
 170                                                       ((VALUE) == DAC_LFSRUNMASK_BITS1_0) || \
 171                                                       ((VALUE) == DAC_LFSRUNMASK_BITS2_0) || \
 172                                                       ((VALUE) == DAC_LFSRUNMASK_BITS3_0) || \
 173                                                       ((VALUE) == DAC_LFSRUNMASK_BITS4_0) || \
 174                                                       ((VALUE) == DAC_LFSRUNMASK_BITS5_0) || \
 175                                                       ((VALUE) == DAC_LFSRUNMASK_BITS6_0) || \
 176                                                       ((VALUE) == DAC_LFSRUNMASK_BITS7_0) || \
 177                                                       ((VALUE) == DAC_LFSRUNMASK_BITS8_0) || \
 178                                                       ((VALUE) == DAC_LFSRUNMASK_BITS9_0) || \
 179                                                       ((VALUE) == DAC_LFSRUNMASK_BITS10_0) || \
 180                                                       ((VALUE) == DAC_LFSRUNMASK_BITS11_0) || \
 181                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_1) || \
 182                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_3) || \
 183                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_7) || \
 184                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_15) || \
 185                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_31) || \
 186                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_63) || \
 187                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_127) || \
 188                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_255) || \
 189                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_511) || \
 190                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_1023) || \
 191                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_2047) || \
 192                                                       ((VALUE) == DAC_TRIANGLEAMPLITUDE_4095))
 193 /**
 194   * @}
 195   */
 196
 197 /** @defgroup DAC_output_buffer DAC output buffer
 198   * @{
 199   */
 200 #define DAC_OUTPUTBUFFER_ENABLE            ((uint32_t)0x00000000)
 201 #define DAC_OUTPUTBUFFER_DISABLE           ((uint32_t)DAC_CR_BOFF1)
 202
 203 #define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
 204                                            ((STATE) == DAC_OUTPUTBUFFER_DISABLE))
 205 /**
 206   * @}
 207   */
 208
 209 /** @defgroup DAC_data_alignement DAC data alignement
 210   * @{
 211   */
 212 #define DAC_ALIGN_12B_R                    ((uint32_t)0x00000000)
 213 #define DAC_ALIGN_12B_L                    ((uint32_t)0x00000004)
 214 #define DAC_ALIGN_8B_R                     ((uint32_t)0x00000008)
 215
 216 #define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \
 217                              ((ALIGN) == DAC_ALIGN_12B_L) || \
 218                              ((ALIGN) == DAC_ALIGN_8B_R))
 219 /**
 220   * @}
 221   */
 222
 223 /** @defgroup DAC_wave_generation DAC wave generation
 224   * @{
 225   */
 226 #define DAC_WAVE_NOISE                     ((uint32_t)DAC_CR_WAVE1_0)
 227 #define DAC_WAVE_TRIANGLE                  ((uint32_t)DAC_CR_WAVE1_1)
 228
 229 #define IS_DAC_WAVE(WAVE) (((WAVE) == DAC_WAVE_NOISE) || \
 230                            ((WAVE) == DAC_WAVE_TRIANGLE))
 231 /**
 232   * @}
 233   */
 234
 235 /** @defgroup DAC_data DAC data
 236   * @{
 237   */
 238 #define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0)
 239 /**
 240   * @}
 241   */
 242
 243 /** @defgroup DAC_flags_definition DAC flags definition
 244   * @{
 245   */
 246 #define DAC_FLAG_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)
 247 #define DAC_FLAG_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)
 248
 249 #define IS_DAC_FLAG(FLAG) (((FLAG) == DAC_FLAG_DMAUDR1) || \
 250                            ((FLAG) == DAC_FLAG_DMAUDR2))
 251 /**
 252   * @}
 253   */
 254
 255 /** @defgroup DAC_interrupts_definition DAC interrupts definition
 256   * @{
 257   */
 258 #define DAC_IT_DMAUDR1                   ((uint32_t)DAC_CR_DMAUDRIE1)
 259 #define DAC_IT_DMAUDR2                   ((uint32_t)DAC_CR_DMAUDRIE2)
 260
 261
 262 #define IS_DAC_IT(IT) (((IT) == DAC_IT_DMAUDR1) || \
 263                        ((IT) == DAC_IT_DMAUDR2))
 264
 265 /**
 266   * @}
 267   */
 268
 269 /**
 270   * @}
 271   */
 272
 273 /* Exported macros -----------------------------------------------------------*/
 274 /** @defgroup DAC_Exported_Macros DAC Exported Macros
 275   * @{
 276   */
 277
 278 /** @brief Reset DAC handle state
 279   * @param  __HANDLE__: DAC handle.
 280   * @retval None
 281   */
 282 #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET)
 283
 284 /* Enable the DAC peripheral */
 285 #define __HAL_DAC_ENABLE(__HANDLE__, __DAC_Channel__) \
 286 ((__HANDLE__)->Instance->CR |=  (DAC_CR_EN1 << (__DAC_Channel__)))
 287
 288 /* Disable the DAC peripheral */
 289 #define __HAL_DAC_DISABLE(__HANDLE__, __DAC_Channel__) \
 290 ((__HANDLE__)->Instance->CR &=  ~(DAC_CR_EN1 << (__DAC_Channel__)))
 291
 292 /* Set DHR12R1 alignment */
 293 #define __HAL_DHR12R1_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000008) + (__ALIGNEMENT__))
 294
 295 /* Set DHR12R2 alignment */
 296 #define __HAL_DHR12R2_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000014) + (__ALIGNEMENT__))
 297
 298 /* Set DHR12RD alignment */
 299 #define __HAL_DHR12RD_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000020) + (__ALIGNEMENT__))
 300
 301 /* Enable the DAC interrupt */
 302 #define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
 303
 304 /* Disable the DAC interrupt */
 305 #define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
 306
 307 /* Get the selected DAC's flag status */
 308 #define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
 309
 310 /* Clear the DAC's flag */
 311 #define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__))
 312
 313 /**
 314   * @}
 315   */
 316
 317 /* Include DAC HAL Extended module */
 318 #include "stm32f3xx_hal_dac_ex.h"
 319
 320 /* Exported functions --------------------------------------------------------*/
 321 /** @addtogroup DAC_Exported_Functions DAC Exported Functions
 322   * @{
 323   */
 324
 325 /** @addtogroup DAC_Exported_Functions_Group1 Initialization and de-initialization functions
 326   * @{
 327   */
 328 /* Initialization and de-initialization functions *****************************/
 329 HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef* hdac);
 330 HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef* hdac);
 331 void HAL_DAC_MspInit(DAC_HandleTypeDef* hdac);
 332 void HAL_DAC_MspDeInit(DAC_HandleTypeDef* hdac);
 333
 334 /**
 335   * @}
 336   */
 337
 338 /** @addtogroup DAC_Exported_Functions_Group2 Input and Output operation functions
 339   * @{
 340   */
 341 /* IO operation functions *****************************************************/
 342 HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef* hdac, uint32_t channel);
 343 HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef* hdac, uint32_t channel);
 344 HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef* hdac, uint32_t channel, uint32_t* pData, uint32_t Length, uint32_t alignment);
 345 HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef* hdac, uint32_t channel);
 346 uint32_t HAL_DAC_GetValue(DAC_HandleTypeDef* hdac, uint32_t channel);
 347 void HAL_DAC_IRQHandler(DAC_HandleTypeDef* hdac);
 348 void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef* hdac);
 349 void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef* hdac);
 350 void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);
 351 void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);
 352
 353 /**
 354   * @}
 355   */
 356
 357 /** @addtogroup DAC_Exported_Functions_Group3 Peripheral Control functions
 358   * @{
 359   */
 360 /* Peripheral Control functions ***********************************************/
 361 HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef* hdac, DAC_ChannelConfTypeDef* sConfig, uint32_t channel);
 362 HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef* hdac, uint32_t channel, uint32_t alignment, uint32_t data);
 363
 364 /**
 365   * @}
 366   */
 367
 368 /** @addtogroup DAC_Exported_Functions_Group4 Peripheral State and Error functions
 369   * @{
 370   */
 371 /* Peripheral State and Error functions ***************************************/
 372 HAL_DAC_StateTypeDef HAL_DAC_GetState(DAC_HandleTypeDef* hdac);
 373 uint32_t HAL_DAC_GetError(DAC_HandleTypeDef *hdac);
 374
 375 /**
 376   * @}
 377   */
 378
 379 /**
 380   * @}
 381   */
 382
 383 /**
 384   * @}
 385   */
 386
 387 /**
 388   * @}
 389   */
 390
 391 #ifdef __cplusplus
 392 }
 393 #endif
 394
 395 #endif /*__STM32F3xx_HAL_DAC_H */
 396
 397 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/