demos/stm32f429_disco/stm/stm32f4_spl/inc/stm32f4xx_hal_dac.h

   1 /**\r
   2   ******************************************************************************\r
   3   * @file    stm32f4xx_hal_dac.h\r
   4   * @author  MCD Application Team\r
   5   * @version V1.0.0\r
   6   * @date    18-February-2014\r
   7   * @brief   Header file of DAC HAL module.\r
   8   ******************************************************************************\r
   9   * @attention\r
  10   *\r
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>\r
  12   *\r
  13   * Redistribution and use in source and binary forms, with or without modification,\r
  14   * are permitted provided that the following conditions are met:\r
  15   *   1. Redistributions of source code must retain the above copyright notice,\r
  16   *      this list of conditions and the following disclaimer.\r
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,\r
  18   *      this list of conditions and the following disclaimer in the documentation\r
  19   *      and/or other materials provided with the distribution.\r
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors\r
  21   *      may be used to endorse or promote products derived from this software\r
  22   *      without specific prior written permission.\r
  23   *\r
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\r
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\r
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\r
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\r
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  34   *\r
  35   ******************************************************************************\r
  36   */\r
  37 \r
  38 /* Define to prevent recursive inclusion -------------------------------------*/\r
  39 #ifndef __STM32F4xx_HAL_DAC_H\r
  40 #define __STM32F4xx_HAL_DAC_H\r
  41 \r
  42 #ifdef __cplusplus\r
  43  extern "C" {\r
  44 #endif\r
  45 \r
  46 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)\r
  47 \r
  48 /* Includes ------------------------------------------------------------------*/\r
  49 #include "stm32f4xx_hal_def.h"\r
  50 \r
  51 /** @addtogroup STM32F4xx_HAL_Driver\r
  52   * @{\r
  53   */\r
  54 \r
  55 /** @addtogroup DAC\r
  56   * @{\r
  57   */\r
  58 \r
  59 /* Exported types ------------------------------------------------------------*/\r
  60 \r
  61 /** \r
  62   * @brief  HAL State structures definition  \r
  63   */ \r
  64 typedef enum\r
  65 {\r
  66   HAL_DAC_STATE_RESET             = 0x00,  /*!< DAC not yet initialized or disabled  */\r
  67   HAL_DAC_STATE_READY             = 0x01,  /*!< DAC initialized and ready for use    */\r
  68   HAL_DAC_STATE_BUSY              = 0x02,  /*!< DAC internal processing is ongoing   */\r
  69   HAL_DAC_STATE_TIMEOUT           = 0x03,  /*!< DAC timeout state                    */\r
  70   HAL_DAC_STATE_ERROR             = 0x04   /*!< DAC error state                      */\r
  71  \r
  72 }HAL_DAC_StateTypeDef;\r
  73  \r
  74 /** \r
  75   * @brief  DAC handle Structure definition  \r
  76   */ \r
  77 typedef struct\r
  78 {\r
  79   DAC_TypeDef                 *Instance;     /*!< Register base address             */\r
  80   \r
  81   __IO HAL_DAC_StateTypeDef   State;         /*!< DAC communication state           */\r
  82 \r
  83   HAL_LockTypeDef             Lock;          /*!< DAC locking object                */\r
  84   \r
  85   DMA_HandleTypeDef           *DMA_Handle1;  /*!< Pointer DMA handler for channel 1 */\r
  86   \r
  87   DMA_HandleTypeDef           *DMA_Handle2;  /*!< Pointer DMA handler for channel 2 */ \r
  88   \r
  89   __IO uint32_t               ErrorCode;     /*!< DAC Error code                    */\r
  90   \r
  91 }DAC_HandleTypeDef;\r
  92 \r
  93 /** \r
  94   * @brief   DAC Configuration regular Channel structure definition  \r
  95   */ \r
  96 typedef struct\r
  97 {\r
  98   uint32_t DAC_Trigger;       /*!< Specifies the external trigger for the selected DAC channel.\r
  99                                    This parameter can be a value of @ref DAC_trigger_selection */\r
 100   \r
 101   uint32_t DAC_OutputBuffer;  /*!< Specifies whether the DAC channel output buffer is enabled or disabled.\r
 102                                    This parameter can be a value of @ref DAC_output_buffer */\r
 103   \r
 104 }DAC_ChannelConfTypeDef;\r
 105 \r
 106 /* Exported constants --------------------------------------------------------*/\r
 107 \r
 108 /** @defgroup DAC_Error_Code\r
 109   * @{\r
 110   */\r
 111 #define  HAL_DAC_ERROR_NONE              0x00    /*!< No error                          */\r
 112 #define  HAL_DAC_ERROR_DMAUNDERRUNCH1    0x01    /*!< DAC channel1 DAM underrun error   */\r
 113 #define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02    /*!< DAC channel2 DAM underrun error   */\r
 114 #define  HAL_DAC_ERROR_DMA               0x04    /*!< DMA error                         */   \r
 115 /**\r
 116   * @}\r
 117   */\r
 118   \r
 119 /** @defgroup DAC_trigger_selection \r
 120   * @{\r
 121   */\r
 122 \r
 123 #define DAC_TRIGGER_NONE                   ((uint32_t)0x00000000) /*!< Conversion is automatic once the DAC1_DHRxxxx register \r
 124                                                                        has been loaded, and not by external trigger */\r
 125 #define DAC_TRIGGER_T2_TRGO                ((uint32_t)(DAC_CR_TSEL1_2 | DAC_CR_TEN1)) /*!< TIM2 TRGO selected as external conversion trigger for DAC channel */\r
 126 #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 */\r
 127 #define DAC_TRIGGER_T5_TRGO                ((uint32_t)(DAC_CR_TSEL1_1 | DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM5 TRGO selected as external conversion trigger for DAC channel */\r
 128 #define DAC_TRIGGER_T6_TRGO                ((uint32_t)DAC_CR_TEN1) /*!< TIM6 TRGO selected as external conversion trigger for DAC channel */\r
 129 #define DAC_TRIGGER_T7_TRGO                ((uint32_t)(DAC_CR_TSEL1_1 | DAC_CR_TEN1)) /*!< TIM7 TRGO selected as external conversion trigger for DAC channel */\r
 130 #define DAC_TRIGGER_T8_TRGO                ((uint32_t)(DAC_CR_TSEL1_0 | DAC_CR_TEN1)) /*!< TIM8 TRGO selected as external conversion trigger for DAC channel */                                                                       \r
 131 \r
 132 #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 */\r
 133 #define DAC_TRIGGER_SOFTWARE               ((uint32_t)(DAC_CR_TSEL1 | DAC_CR_TEN1)) /*!< Conversion started by software trigger for DAC channel */\r
 134 \r
 135 #define IS_DAC_TRIGGER(TRIGGER) (((TRIGGER) == DAC_TRIGGER_NONE) || \\r
 136                                  ((TRIGGER) == DAC_TRIGGER_T2_TRGO) || \\r
 137                                  ((TRIGGER) == DAC_TRIGGER_T8_TRGO) || \\r
 138                                  ((TRIGGER) == DAC_TRIGGER_T7_TRGO) || \\r
 139                                  ((TRIGGER) == DAC_TRIGGER_T5_TRGO) || \\r
 140                                  ((TRIGGER) == DAC_TRIGGER_T6_TRGO) || \\r
 141                                  ((TRIGGER) == DAC_TRIGGER_T4_TRGO) || \\r
 142                                  ((TRIGGER) == DAC_TRIGGER_EXT_IT9) || \\r
 143                                  ((TRIGGER) == DAC_TRIGGER_SOFTWARE))\r
 144 /**\r
 145   * @}\r
 146   */\r
 147 \r
 148 /** @defgroup DAC_output_buffer \r
 149   * @{\r
 150   */\r
 151 #define DAC_OUTPUTBUFFER_ENABLE            ((uint32_t)0x00000000)\r
 152 #define DAC_OUTPUTBUFFER_DISABLE           ((uint32_t)DAC_CR_BOFF1)\r
 153 \r
 154 #define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \\r
 155                                            ((STATE) == DAC_OUTPUTBUFFER_DISABLE))\r
 156 /**\r
 157   * @}\r
 158   */\r
 159 \r
 160 /** @defgroup DAC_Channel_selection \r
 161   * @{\r
 162   */\r
 163 #define DAC_CHANNEL_1                      ((uint32_t)0x00000000)\r
 164 #define DAC_CHANNEL_2                      ((uint32_t)0x00000010)\r
 165 \r
 166 #define IS_DAC_CHANNEL(CHANNEL) (((CHANNEL) == DAC_CHANNEL_1) || \\r
 167                                  ((CHANNEL) == DAC_CHANNEL_2))\r
 168 /**\r
 169   * @}\r
 170   */\r
 171 \r
 172 /** @defgroup DAC_data_alignement \r
 173   * @{\r
 174   */\r
 175 #define DAC_ALIGN_12B_R                    ((uint32_t)0x00000000)\r
 176 #define DAC_ALIGN_12B_L                    ((uint32_t)0x00000004)\r
 177 #define DAC_ALIGN_8B_R                     ((uint32_t)0x00000008)\r
 178 \r
 179 #define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \\r
 180                              ((ALIGN) == DAC_ALIGN_12B_L) || \\r
 181                              ((ALIGN) == DAC_ALIGN_8B_R))\r
 182 /**\r
 183   * @}\r
 184   */\r
 185 \r
 186 /** @defgroup DAC_data \r
 187   * @{\r
 188   */\r
 189 #define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0) \r
 190 /**\r
 191   * @}\r
 192   */\r
 193 \r
 194 /** @defgroup DAC_flags_definition \r
 195   * @{\r
 196   */ \r
 197 #define DAC_FLAG_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)\r
 198 #define DAC_FLAG_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)   \r
 199 \r
 200 #define IS_DAC_FLAG(FLAG) (((FLAG) == DAC_FLAG_DMAUDR1) || \\r
 201                            ((FLAG) == DAC_FLAG_DMAUDR2))  \r
 202 /**\r
 203   * @}\r
 204   */\r
 205 \r
 206 /** @defgroup DAC_IT_definition \r
 207   * @{\r
 208   */ \r
 209 #define DAC_IT_DMAUDR1                   ((uint32_t)DAC_SR_DMAUDR1)\r
 210 #define DAC_IT_DMAUDR2                   ((uint32_t)DAC_SR_DMAUDR2)   \r
 211 \r
 212 #define IS_DAC_IT(IT) (((IT) == DAC_IT_DMAUDR1) || \\r
 213                        ((IT) == DAC_IT_DMAUDR2))  \r
 214 \r
 215 /**\r
 216   * @}\r
 217   */\r
 218 \r
 219 /* Exported macro ------------------------------------------------------------*/\r
 220 /* Enable the DAC peripheral */\r
 221 #define __HAL_DAC_ENABLE(__HANDLE__, __DAC_Channel__) \\r
 222 ((__HANDLE__)->Instance->CR |=  (DAC_CR_EN1 << (__DAC_Channel__)))\r
 223 \r
 224 /* Disable the DAC peripheral */\r
 225 #define __HAL_DAC_DISABLE(__HANDLE__, __DAC_Channel__) \\r
 226 ((__HANDLE__)->Instance->CR &=  ~(DAC_CR_EN1 << (__DAC_Channel__)))\r
 227  \r
 228 /* Set DHR12R1 alignment */\r
 229 #define __HAL_DHR12R1_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000008) + (__ALIGNEMENT__))\r
 230 \r
 231 /* Set DHR12R2 alignment */\r
 232 #define __HAL_DHR12R2_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000014) + (__ALIGNEMENT__))\r
 233 \r
 234 /* Set DHR12RD alignment */\r
 235 #define __HAL_DHR12RD_ALIGNEMENT(__ALIGNEMENT__) (((uint32_t)0x00000020) + (__ALIGNEMENT__))\r
 236 \r
 237 /* Enable the DAC interrupt */\r
 238 #define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))\r
 239 \r
 240 /* Disable the DAC interrupt */\r
 241 #define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))\r
 242 \r
 243 /* Get the selected DAC's flag status */\r
 244 #define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))\r
 245 \r
 246 /* Clear the DAC's flag */\r
 247 #define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) |= (__FLAG__))                         \r
 248 \r
 249 /* Include DAC HAL Extension module */\r
 250 #include "stm32f4xx_hal_dac_ex.h"   \r
 251 \r
 252 /* Exported functions --------------------------------------------------------*/  \r
 253 /* Initialization/de-initialization functions ***********************************/ \r
 254 HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef* hdac);\r
 255 HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef* hdac);\r
 256 void HAL_DAC_MspInit(DAC_HandleTypeDef* hdac);\r
 257 void HAL_DAC_MspDeInit(DAC_HandleTypeDef* hdac);\r
 258 \r
 259 /* I/O operation functions ******************************************************/\r
 260 HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef* hdac, uint32_t Channel);\r
 261 HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef* hdac, uint32_t Channel);\r
 262 HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t* pData, uint32_t Length, uint32_t Alignment);\r
 263 HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef* hdac, uint32_t Channel);\r
 264 uint32_t HAL_DAC_GetValue(DAC_HandleTypeDef* hdac, uint32_t Channel);\r
 265 \r
 266 /* Peripheral Control functions *************************************************/\r
 267 HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef* hdac, DAC_ChannelConfTypeDef* sConfig, uint32_t Channel);\r
 268 HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef* hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data);\r
 269 \r
 270 /* Peripheral State functions ***************************************************/\r
 271 HAL_DAC_StateTypeDef HAL_DAC_GetState(DAC_HandleTypeDef* hdac);\r
 272 void HAL_DAC_IRQHandler(DAC_HandleTypeDef* hdac);\r
 273 uint32_t HAL_DAC_GetError(DAC_HandleTypeDef *hdac);\r
 274 \r
 275 void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef* hdac);\r
 276 void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef* hdac);\r
 277 void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);\r
 278 void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);\r
 279 \r
 280 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */\r
 281 \r
 282 /**\r
 283   * @}\r
 284   */\r
 285 \r
 286 /**\r
 287   * @}\r
 288   */\r
 289   \r
 290 #ifdef __cplusplus\r
 291 }\r
 292 #endif\r
 293 \r
 294 #endif /*__STM32F4xx_HAL_DAC_H */\r
 295 \r
 296 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/\r