tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_dac_ex.c

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_dac_ex.c
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    19-June-2014
   7   * @brief   DAC HAL module driver.
   8   *         This file provides firmware functions to manage the following
   9   *         functionalities of DAC extension peripheral:
  10   *           + Extended features functions
  11   *
  12   *
  13   @verbatim
  14   ==============================================================================
  15                       ##### How to use this driver #####
  16   ==============================================================================
  17     [..]
  18       (+) When Dual mode is enabled (i.e DAC Channel1 and Channel2 are used simultaneously) :
  19           Use HAL_DACEx_DualGetValue() to get digital data to be converted and use
  20           HAL_DACEx_DualSetValue() to set digital value to converted simultaneously in Channel 1 and Channel 2.
  21       (+) Use HAL_DACEx_TriangleWaveGenerate() to generate Triangle signal.
  22       (+) Use HAL_DACEx_NoiseWaveGenerate() to generate Noise signal.
  23
  24  @endverbatim
  25   ******************************************************************************
  26   * @attention
  27   *
  28   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  29   *
  30   * Redistribution and use in source and binary forms, with or without modification,
  31   * are permitted provided that the following conditions are met:
  32   *   1. Redistributions of source code must retain the above copyright notice,
  33   *      this list of conditions and the following disclaimer.
  34   *   2. Redistributions in binary form must reproduce the above copyright notice,
  35   *      this list of conditions and the following disclaimer in the documentation
  36   *      and/or other materials provided with the distribution.
  37   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  38   *      may be used to endorse or promote products derived from this software
  39   *      without specific prior written permission.
  40   *
  41   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  42   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  44   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  45   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  47   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  48   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  49   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  50   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  51   *
  52   ******************************************************************************
  53   */
  54
  55
  56 /* Includes ------------------------------------------------------------------*/
  57 #include "stm32f4xx_hal.h"
  58
  59 /** @addtogroup STM32F4xx_HAL_Driver
  60   * @{
  61   */
  62
  63 /** @defgroup DACEx
  64   * @brief DAC driver modules
  65   * @{
  66   */
  67
  68 #ifdef HAL_DAC_MODULE_ENABLED
  69
  70 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
  71
  72 /* Private typedef -----------------------------------------------------------*/
  73 /* Private define ------------------------------------------------------------*/
  74 /* Private macro -------------------------------------------------------------*/
  75 /* Private variables ---------------------------------------------------------*/
  76 /* Private function prototypes -----------------------------------------------*/
  77 /* Private functions ---------------------------------------------------------*/
  78
  79 /** @defgroup DACEx_Private_Functions
  80   * @{
  81   */
  82
  83 /** @defgroup DACEx_Group1 Extended features functions
  84  *  @brief    Extended features functions
  85  *
  86 @verbatim
  87   ==============================================================================
  88                  ##### Extended features functions #####
  89   ==============================================================================
  90     [..]  This section provides functions allowing to:
  91       (+) Start conversion.
  92       (+) Stop conversion.
  93       (+) Start conversion and enable DMA transfer.
  94       (+) Stop conversion and disable DMA transfer.
  95       (+) Get result of conversion.
  96       (+) Get result of dual mode conversion.
  97
  98 @endverbatim
  99   * @{
 100   */
 101
 102 /**
 103   * @brief  Returns the last data output value of the selected DAC channel.
 104   * @param  hdac: pointer to a DAC_HandleTypeDef structure that contains
 105   *         the configuration information for the specified DAC.
 106   * @retval The selected DAC channel data output value.
 107   */
 108 uint32_t HAL_DACEx_DualGetValue(DAC_HandleTypeDef* hdac)
 109 {
 110   uint32_t tmp = 0;
 111
 112   tmp |= hdac->Instance->DOR1;
 113
 114   tmp |= hdac->Instance->DOR2 << 16;
 115
 116   /* Returns the DAC channel data output register value */
 117   return tmp;
 118 }
 119
 120 /**
 121   * @brief  Enables or disables the selected DAC channel wave generation.
 122   * @param  hdac: pointer to a DAC_HandleTypeDef structure that contains
 123   *         the configuration information for the specified DAC.
 124   * @param  Channel: The selected DAC channel.
 125   *          This parameter can be one of the following values:
 126   *            DAC_CHANNEL_1 / DAC_CHANNEL_2
 127   * @param  Amplitude: Select max triangle amplitude.
 128   *          This parameter can be one of the following values:
 129   *            @arg DAC_TRIANGLEAMPLITUDE_1: Select max triangle amplitude of 1
 130   *            @arg DAC_TRIANGLEAMPLITUDE_3: Select max triangle amplitude of 3
 131   *            @arg DAC_TRIANGLEAMPLITUDE_7: Select max triangle amplitude of 7
 132   *            @arg DAC_TRIANGLEAMPLITUDE_15: Select max triangle amplitude of 15
 133   *            @arg DAC_TRIANGLEAMPLITUDE_31: Select max triangle amplitude of 31
 134   *            @arg DAC_TRIANGLEAMPLITUDE_63: Select max triangle amplitude of 63
 135   *            @arg DAC_TRIANGLEAMPLITUDE_127: Select max triangle amplitude of 127
 136   *            @arg DAC_TRIANGLEAMPLITUDE_255: Select max triangle amplitude of 255
 137   *            @arg DAC_TRIANGLEAMPLITUDE_511: Select max triangle amplitude of 511
 138   *            @arg DAC_TRIANGLEAMPLITUDE_1023: Select max triangle amplitude of 1023
 139   *            @arg DAC_TRIANGLEAMPLITUDE_2047: Select max triangle amplitude of 2047
 140   *            @arg DAC_TRIANGLEAMPLITUDE_4095: Select max triangle amplitude of 4095
 141   * @retval HAL status
 142   */
 143 HAL_StatusTypeDef HAL_DACEx_TriangleWaveGenerate(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t Amplitude)
 144 {
 145   /* Check the parameters */
 146   assert_param(IS_DAC_CHANNEL(Channel));
 147   assert_param(IS_DAC_LFSR_UNMASK_TRIANGLE_AMPLITUDE(Amplitude));
 148
 149   /* Process locked */
 150   __HAL_LOCK(hdac);
 151
 152   /* Change DAC state */
 153   hdac->State = HAL_DAC_STATE_BUSY;
 154
 155   /* Enable the selected wave generation for the selected DAC channel */
 156   hdac->Instance->CR |= (DAC_WAVE_TRIANGLE | Amplitude) << Channel;
 157
 158   /* Change DAC state */
 159   hdac->State = HAL_DAC_STATE_READY;
 160
 161   /* Process unlocked */
 162   __HAL_UNLOCK(hdac);
 163
 164   /* Return function status */
 165   return HAL_OK;
 166 }
 167
 168 /**
 169   * @brief  Enables or disables the selected DAC channel wave generation.
 170   * @param  hdac: pointer to a DAC_HandleTypeDef structure that contains
 171   *         the configuration information for the specified DAC.
 172   * @param  Channel: The selected DAC channel.
 173   *          This parameter can be one of the following values:
 174   *            DAC_CHANNEL_1 / DAC_CHANNEL_2
 175   * @param  Amplitude: Unmask DAC channel LFSR for noise wave generation.
 176   *          This parameter can be one of the following values:
 177   *            @arg DAC_LFSRUNMASK_BIT0: Unmask DAC channel LFSR bit0 for noise wave generation
 178   *            @arg DAC_LFSRUNMASK_BITS1_0: Unmask DAC channel LFSR bit[1:0] for noise wave generation
 179   *            @arg DAC_LFSRUNMASK_BITS2_0: Unmask DAC channel LFSR bit[2:0] for noise wave generation
 180   *            @arg DAC_LFSRUNMASK_BITS3_0: Unmask DAC channel LFSR bit[3:0] for noise wave generation
 181   *            @arg DAC_LFSRUNMASK_BITS4_0: Unmask DAC channel LFSR bit[4:0] for noise wave generation
 182   *            @arg DAC_LFSRUNMASK_BITS5_0: Unmask DAC channel LFSR bit[5:0] for noise wave generation
 183   *            @arg DAC_LFSRUNMASK_BITS6_0: Unmask DAC channel LFSR bit[6:0] for noise wave generation
 184   *            @arg DAC_LFSRUNMASK_BITS7_0: Unmask DAC channel LFSR bit[7:0] for noise wave generation
 185   *            @arg DAC_LFSRUNMASK_BITS8_0: Unmask DAC channel LFSR bit[8:0] for noise wave generation
 186   *            @arg DAC_LFSRUNMASK_BITS9_0: Unmask DAC channel LFSR bit[9:0] for noise wave generation
 187   *            @arg DAC_LFSRUNMASK_BITS10_0: Unmask DAC channel LFSR bit[10:0] for noise wave generation
 188   *            @arg DAC_LFSRUNMASK_BITS11_0: Unmask DAC channel LFSR bit[11:0] for noise wave generation
 189   * @retval HAL status
 190   */
 191 HAL_StatusTypeDef HAL_DACEx_NoiseWaveGenerate(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t Amplitude)
 192 {
 193   /* Check the parameters */
 194   assert_param(IS_DAC_CHANNEL(Channel));
 195   assert_param(IS_DAC_LFSR_UNMASK_TRIANGLE_AMPLITUDE(Amplitude));
 196
 197   /* Process locked */
 198   __HAL_LOCK(hdac);
 199
 200   /* Change DAC state */
 201   hdac->State = HAL_DAC_STATE_BUSY;
 202
 203   /* Enable the selected wave generation for the selected DAC channel */
 204   hdac->Instance->CR |= (DAC_WAVE_NOISE | Amplitude) << Channel;
 205
 206   /* Change DAC state */
 207   hdac->State = HAL_DAC_STATE_READY;
 208
 209   /* Process unlocked */
 210   __HAL_UNLOCK(hdac);
 211
 212   /* Return function status */
 213   return HAL_OK;
 214 }
 215
 216 /**
 217   * @brief  Set the specified data holding register value for dual DAC channel.
 218   * @param  hdac: pointer to a DAC_HandleTypeDef structure that contains
 219   *               the configuration information for the specified DAC.
 220   * @param  Alignment: Specifies the data alignment for dual channel DAC.
 221   *          This parameter can be one of the following values:
 222   *            DAC_ALIGN_8B_R: 8bit right data alignment selected
 223   *            DAC_ALIGN_12B_L: 12bit left data alignment selected
 224   *            DAC_ALIGN_12B_R: 12bit right data alignment selected
 225   * @param  Data1: Data for DAC Channel2 to be loaded in the selected data holding register.
 226   * @param  Data2: Data for DAC Channel1 to be loaded in the selected data  holding register.
 227   * @note   In dual mode, a unique register access is required to write in both
 228   *          DAC channels at the same time.
 229   * @retval HAL status
 230   */
 231 HAL_StatusTypeDef HAL_DACEx_DualSetValue(DAC_HandleTypeDef* hdac, uint32_t Alignment, uint32_t Data1, uint32_t Data2)
 232 {
 233   uint32_t data = 0, tmp = 0;
 234
 235   /* Check the parameters */
 236   assert_param(IS_DAC_ALIGN(Alignment));
 237   assert_param(IS_DAC_DATA(Data1));
 238   assert_param(IS_DAC_DATA(Data2));
 239
 240   /* Calculate and set dual DAC data holding register value */
 241   if (Alignment == DAC_ALIGN_8B_R)
 242   {
 243     data = ((uint32_t)Data2 << 8) | Data1;
 244   }
 245   else
 246   {
 247     data = ((uint32_t)Data2 << 16) | Data1;
 248   }
 249
 250   tmp = (uint32_t)hdac->Instance;
 251   tmp += __HAL_DHR12RD_ALIGNEMENT(Alignment);
 252
 253   /* Set the dual DAC selected data holding register */
 254   *(__IO uint32_t *)tmp = data;
 255
 256   /* Return function status */
 257   return HAL_OK;
 258 }
 259
 260 /**
 261   * @}
 262   */
 263
 264 /**
 265   * @brief  Conversion complete callback in non blocking mode for Channel2
 266   * @param  hdac: pointer to a DAC_HandleTypeDef structure that contains
 267   *         the configuration information for the specified DAC.
 268   * @retval None
 269   */
 270 __weak void HAL_DACEx_ConvCpltCallbackCh2(DAC_HandleTypeDef* hdac)
 271 {
 272   /* NOTE : This function Should not be modified, when the callback is needed,
 273             the HAL_DAC_ConvCpltCallback could be implemented in the user file
 274    */
 275 }
 276
 277 /**
 278   * @brief  Conversion half DMA transfer callback in non blocking mode for Channel2
 279   * @param  hdac: pointer to a DAC_HandleTypeDef structure that contains
 280   *         the configuration information for the specified DAC.
 281   * @retval None
 282   */
 283 __weak void HAL_DACEx_ConvHalfCpltCallbackCh2(DAC_HandleTypeDef* hdac)
 284 {
 285   /* NOTE : This function Should not be modified, when the callback is needed,
 286             the HAL_DAC_ConvHalfCpltCallbackCh2 could be implemented in the user file
 287    */
 288 }
 289
 290 /**
 291   * @brief  Error DAC callback for Channel2.
 292   * @param  hdac: pointer to a DAC_HandleTypeDef structure that contains
 293   *         the configuration information for the specified DAC.
 294   * @retval None
 295   */
 296 __weak void HAL_DACEx_ErrorCallbackCh2(DAC_HandleTypeDef *hdac)
 297 {
 298   /* NOTE : This function Should not be modified, when the callback is needed,
 299             the HAL_DAC_ErrorCallback could be implemented in the user file
 300    */
 301 }
 302
 303 /**
 304   * @brief  DMA underrun DAC callback for channel2.
 305   * @param  hdac: pointer to a DAC_HandleTypeDef structure that contains
 306   *         the configuration information for the specified DAC.
 307   * @retval None
 308   */
 309 __weak void HAL_DACEx_DMAUnderrunCallbackCh2(DAC_HandleTypeDef *hdac)
 310 {
 311   /* NOTE : This function Should not be modified, when the callback is needed,
 312             the HAL_DAC_DMAUnderrunCallbackCh2 could be implemented in the user file
 313    */
 314 }
 315
 316 /**
 317   * @brief  DMA conversion complete callback.
 318   * @param  hdma: pointer to a DMA_HandleTypeDef structure that contains
 319   *                the configuration information for the specified DMA module.
 320   * @retval None
 321   */
 322 void DAC_DMAConvCpltCh2(DMA_HandleTypeDef *hdma)
 323 {
 324   DAC_HandleTypeDef* hdac = ( DAC_HandleTypeDef* )((DMA_HandleTypeDef* )hdma)->Parent;
 325
 326   HAL_DACEx_ConvCpltCallbackCh2(hdac);
 327
 328   hdac->State= HAL_DAC_STATE_READY;
 329 }
 330
 331 /**
 332   * @brief  DMA half transfer complete callback.
 333   * @param  hdma: pointer to a DMA_HandleTypeDef structure that contains
 334   *                the configuration information for the specified DMA module.
 335   * @retval None
 336   */
 337 void DAC_DMAHalfConvCpltCh2(DMA_HandleTypeDef *hdma)
 338 {
 339     DAC_HandleTypeDef* hdac = ( DAC_HandleTypeDef* )((DMA_HandleTypeDef* )hdma)->Parent;
 340     /* Conversion complete callback */
 341     HAL_DACEx_ConvHalfCpltCallbackCh2(hdac);
 342 }
 343
 344 /**
 345   * @brief  DMA error callback
 346   * @param  hdma: pointer to a DMA_HandleTypeDef structure that contains
 347   *                the configuration information for the specified DMA module.
 348   * @retval None
 349   */
 350 void DAC_DMAErrorCh2(DMA_HandleTypeDef *hdma)
 351 {
 352   DAC_HandleTypeDef* hdac = ( DAC_HandleTypeDef* )((DMA_HandleTypeDef* )hdma)->Parent;
 353
 354   /* Set DAC error code to DMA error */
 355   hdac->ErrorCode |= HAL_DAC_ERROR_DMA;
 356
 357   HAL_DACEx_ErrorCallbackCh2(hdac);
 358
 359   hdac->State= HAL_DAC_STATE_READY;
 360 }
 361
 362 /**
 363   * @}
 364   */
 365
 366 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
 367
 368 #endif /* HAL_DAC_MODULE_ENABLED */
 369
 370 /**
 371   * @}
 372   */
 373
 374 /**
 375   * @}
 376   */
 377
 378 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/