Subversion Repositories canSerial

Rev

Rev 2 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /**
  2.   ******************************************************************************
  3.   * @file    stm32f1xx_hal_dac.h
  4.   * @author  MCD Application Team
  5.   * @brief   Header file of DAC HAL module.
  6.   ******************************************************************************
  7.   * @attention
  8.   *
  9.   * Copyright (c) 2016 STMicroelectronics.
  10.   * All rights reserved.
  11.   *
  12.   * This software is licensed under terms that can be found in the LICENSE file
  13.   * in the root directory of this software component.
  14.   * If no LICENSE file comes with this software, it is provided AS-IS.
  15.   *
  16.   ******************************************************************************
  17.   */
  18.  
  19. /* Define to prevent recursive inclusion -------------------------------------*/
  20. #ifndef STM32F1xx_HAL_DAC_H
  21. #define STM32F1xx_HAL_DAC_H
  22.  
  23. #ifdef __cplusplus
  24. extern "C" {
  25. #endif
  26.  
  27. /** @addtogroup STM32F1xx_HAL_Driver
  28.   * @{
  29.   */
  30.  
  31. /* Includes ------------------------------------------------------------------*/
  32. #include "stm32f1xx_hal_def.h"
  33.  
  34. #if defined(DAC)
  35.  
  36. /** @addtogroup DAC
  37.   * @{
  38.   */
  39.  
  40. /* Exported types ------------------------------------------------------------*/
  41.  
  42. /** @defgroup DAC_Exported_Types DAC Exported Types
  43.   * @{
  44.   */
  45.  
  46. /**
  47.   * @brief  HAL State structures definition
  48.   */
  49. typedef enum
  50. {
  51.   HAL_DAC_STATE_RESET             = 0x00U,  /*!< DAC not yet initialized or disabled  */
  52.   HAL_DAC_STATE_READY             = 0x01U,  /*!< DAC initialized and ready for use    */
  53.   HAL_DAC_STATE_BUSY              = 0x02U,  /*!< DAC internal processing is ongoing   */
  54.   HAL_DAC_STATE_TIMEOUT           = 0x03U,  /*!< DAC timeout state                    */
  55.   HAL_DAC_STATE_ERROR             = 0x04U   /*!< DAC error state                      */
  56.  
  57. } HAL_DAC_StateTypeDef;
  58.  
  59. /**
  60.   * @brief  DAC handle Structure definition
  61.   */
  62. #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
  63. typedef struct __DAC_HandleTypeDef
  64. #else
  65. typedef struct
  66. #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
  67. {
  68.   DAC_TypeDef                 *Instance;     /*!< Register base address             */
  69.  
  70.   __IO HAL_DAC_StateTypeDef   State;         /*!< DAC communication state           */
  71.  
  72.   HAL_LockTypeDef             Lock;          /*!< DAC locking object                */
  73.  
  74.   DMA_HandleTypeDef           *DMA_Handle1;  /*!< Pointer DMA handler for channel 1 */
  75.  
  76.   DMA_HandleTypeDef           *DMA_Handle2;  /*!< Pointer DMA handler for channel 2 */
  77.  
  78.   __IO uint32_t               ErrorCode;     /*!< DAC Error code                    */
  79.  
  80. #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
  81.   void (* ConvCpltCallbackCh1)(struct __DAC_HandleTypeDef *hdac);
  82.   void (* ConvHalfCpltCallbackCh1)(struct __DAC_HandleTypeDef *hdac);
  83.   void (* ErrorCallbackCh1)(struct __DAC_HandleTypeDef *hdac);
  84.   void (* DMAUnderrunCallbackCh1)(struct __DAC_HandleTypeDef *hdac);
  85.  
  86.   void (* ConvCpltCallbackCh2)(struct __DAC_HandleTypeDef *hdac);
  87.   void (* ConvHalfCpltCallbackCh2)(struct __DAC_HandleTypeDef *hdac);
  88.   void (* ErrorCallbackCh2)(struct __DAC_HandleTypeDef *hdac);
  89.   void (* DMAUnderrunCallbackCh2)(struct __DAC_HandleTypeDef *hdac);
  90.  
  91.  
  92.   void (* MspInitCallback)(struct __DAC_HandleTypeDef *hdac);
  93.   void (* MspDeInitCallback)(struct __DAC_HandleTypeDef *hdac);
  94. #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
  95.  
  96. } DAC_HandleTypeDef;
  97.  
  98. /**
  99.   * @brief   DAC Configuration regular Channel structure definition
  100.   */
  101. typedef struct
  102. {
  103.   uint32_t DAC_Trigger;                  /*!< Specifies the external trigger for the selected DAC channel.
  104.                                               This parameter can be a value of @ref DAC_trigger_selection */
  105.  
  106.   uint32_t DAC_OutputBuffer;             /*!< Specifies whether the DAC channel output buffer is enabled or disabled.
  107.                                                This parameter can be a value of @ref DAC_output_buffer */
  108.  
  109. } DAC_ChannelConfTypeDef;
  110.  
  111. #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
  112. /**
  113.   * @brief  HAL DAC Callback ID enumeration definition
  114.   */
  115. typedef enum
  116. {
  117.   HAL_DAC_CH1_COMPLETE_CB_ID                 = 0x00U,  /*!< DAC CH1 Complete Callback ID      */
  118.   HAL_DAC_CH1_HALF_COMPLETE_CB_ID            = 0x01U,  /*!< DAC CH1 half Complete Callback ID */
  119.   HAL_DAC_CH1_ERROR_ID                       = 0x02U,  /*!< DAC CH1 error Callback ID         */
  120.   HAL_DAC_CH1_UNDERRUN_CB_ID                 = 0x03U,  /*!< DAC CH1 underrun Callback ID      */
  121.  
  122.   HAL_DAC_CH2_COMPLETE_CB_ID                 = 0x04U,  /*!< DAC CH2 Complete Callback ID      */
  123.   HAL_DAC_CH2_HALF_COMPLETE_CB_ID            = 0x05U,  /*!< DAC CH2 half Complete Callback ID */
  124.   HAL_DAC_CH2_ERROR_ID                       = 0x06U,  /*!< DAC CH2 error Callback ID         */
  125.   HAL_DAC_CH2_UNDERRUN_CB_ID                 = 0x07U,  /*!< DAC CH2 underrun Callback ID      */
  126.  
  127.   HAL_DAC_MSPINIT_CB_ID                      = 0x08U,  /*!< DAC MspInit Callback ID           */
  128.   HAL_DAC_MSPDEINIT_CB_ID                    = 0x09U,  /*!< DAC MspDeInit Callback ID         */
  129.   HAL_DAC_ALL_CB_ID                          = 0x0AU   /*!< DAC All ID                        */
  130. } HAL_DAC_CallbackIDTypeDef;
  131.  
  132. /**
  133.   * @brief  HAL DAC Callback pointer definition
  134.   */
  135. typedef void (*pDAC_CallbackTypeDef)(DAC_HandleTypeDef *hdac);
  136. #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
  137.  
  138. /**
  139.   * @}
  140.   */
  141.  
  142. /* Exported constants --------------------------------------------------------*/
  143.  
  144. /** @defgroup DAC_Exported_Constants DAC Exported Constants
  145.   * @{
  146.   */
  147.  
  148. /** @defgroup DAC_Error_Code DAC Error Code
  149.   * @{
  150.   */
  151. #define  HAL_DAC_ERROR_NONE              0x00U    /*!< No error                          */
  152. #define  HAL_DAC_ERROR_DMAUNDERRUNCH1    0x01U    /*!< DAC channel1 DMA underrun error   */
  153. #define  HAL_DAC_ERROR_DMAUNDERRUNCH2    0x02U    /*!< DAC channel2 DMA underrun error   */
  154. #define  HAL_DAC_ERROR_DMA               0x04U    /*!< DMA error                         */
  155. #define  HAL_DAC_ERROR_TIMEOUT           0x08U    /*!< Timeout error                     */
  156. #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
  157. #define HAL_DAC_ERROR_INVALID_CALLBACK   0x10U    /*!< Invalid callback error            */
  158. #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
  159.  
  160. /**
  161.   * @}
  162.   */
  163.  
  164. /** @defgroup DAC_output_buffer DAC output buffer
  165.   * @{
  166.   */
  167. #define DAC_OUTPUTBUFFER_ENABLE            0x00000000U
  168. #define DAC_OUTPUTBUFFER_DISABLE           (DAC_CR_BOFF1)
  169.  
  170. /**
  171.   * @}
  172.   */
  173.  
  174. /** @defgroup DAC_Channel_selection DAC Channel selection
  175.   * @{
  176.   */
  177. #define DAC_CHANNEL_1                      0x00000000U
  178.  
  179. #define DAC_CHANNEL_2                      0x00000010U
  180.  
  181. /**
  182.   * @}
  183.   */
  184.  
  185. /** @defgroup DAC_data_alignment DAC data alignment
  186.   * @{
  187.   */
  188. #define DAC_ALIGN_12B_R                    0x00000000U
  189. #define DAC_ALIGN_12B_L                    0x00000004U
  190. #define DAC_ALIGN_8B_R                     0x00000008U
  191.  
  192. /**
  193.   * @}
  194.   */
  195.  
  196. /** @defgroup DAC_flags_definition DAC flags definition
  197.   * @{
  198.   */
  199. #define DAC_FLAG_DMAUDR1                   (DAC_SR_DMAUDR1)
  200.  
  201. #define DAC_FLAG_DMAUDR2                   (DAC_SR_DMAUDR2)
  202.  
  203.  
  204. /**
  205.   * @}
  206.   */
  207.  
  208. /** @defgroup DAC_IT_definition  DAC IT definition
  209.   * @{
  210.   */
  211. #define DAC_IT_DMAUDR1                   (DAC_SR_DMAUDR1)
  212.  
  213. #define DAC_IT_DMAUDR2                   (DAC_SR_DMAUDR2)
  214.  
  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. #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
  235. #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) do {                                                        \
  236.                                                       (__HANDLE__)->State             = HAL_DAC_STATE_RESET; \
  237.                                                       (__HANDLE__)->MspInitCallback   = NULL;                \
  238.                                                       (__HANDLE__)->MspDeInitCallback = NULL;                \
  239.                                                      } while(0)
  240. #else
  241. #define __HAL_DAC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_DAC_STATE_RESET)
  242. #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
  243.  
  244. /** @brief Enable 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_ENABLE(__HANDLE__, __DAC_Channel__) \
  250.   ((__HANDLE__)->Instance->CR |=  (DAC_CR_EN1 << ((__DAC_Channel__) & 0x10UL)))
  251.  
  252. /** @brief Disable the DAC channel.
  253.   * @param  __HANDLE__ specifies the DAC handle
  254.   * @param  __DAC_Channel__ specifies the DAC channel.
  255.   * @retval None
  256.   */
  257. #define __HAL_DAC_DISABLE(__HANDLE__, __DAC_Channel__) \
  258.   ((__HANDLE__)->Instance->CR &=  ~(DAC_CR_EN1 << ((__DAC_Channel__) & 0x10UL)))
  259.  
  260. /** @brief Set DHR12R1 alignment.
  261.   * @param  __ALIGNMENT__ specifies the DAC alignment
  262.   * @retval None
  263.   */
  264. #define DAC_DHR12R1_ALIGNMENT(__ALIGNMENT__) (0x00000008UL + (__ALIGNMENT__))
  265.  
  266.  
  267. /** @brief  Set DHR12R2 alignment.
  268.   * @param  __ALIGNMENT__ specifies the DAC alignment
  269.   * @retval None
  270.   */
  271. #define DAC_DHR12R2_ALIGNMENT(__ALIGNMENT__) (0x00000014UL + (__ALIGNMENT__))
  272.  
  273.  
  274. /** @brief  Set DHR12RD alignment.
  275.   * @param  __ALIGNMENT__ specifies the DAC alignment
  276.   * @retval None
  277.   */
  278. #define DAC_DHR12RD_ALIGNMENT(__ALIGNMENT__) (0x00000020UL + (__ALIGNMENT__))
  279.  
  280. /** @brief Enable the DAC interrupt.
  281.   * @param  __HANDLE__ specifies the DAC handle
  282.   * @param  __INTERRUPT__ specifies the DAC interrupt.
  283.   *          This parameter can be any combination of the following values:
  284.   *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
  285.   *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
  286.   * @retval None
  287.   */
  288. #define __HAL_DAC_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
  289.  
  290. /** @brief Disable the DAC interrupt.
  291.   * @param  __HANDLE__ specifies the DAC handle
  292.   * @param  __INTERRUPT__ specifies the DAC interrupt.
  293.   *          This parameter can be any combination of the following values:
  294.   *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
  295.   *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
  296.   * @retval None
  297.   */
  298. #define __HAL_DAC_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
  299.  
  300. /** @brief  Check whether the specified DAC interrupt source is enabled or not.
  301.   * @param __HANDLE__ DAC handle
  302.   * @param __INTERRUPT__ DAC interrupt source to check
  303.   *          This parameter can be any combination of the following values:
  304.   *            @arg DAC_IT_DMAUDR1 DAC channel 1 DMA underrun interrupt
  305.   *            @arg DAC_IT_DMAUDR2 DAC channel 2 DMA underrun interrupt
  306.   * @retval State of interruption (SET or RESET)
  307.   */
  308. #define __HAL_DAC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->CR\
  309.                                                              & (__INTERRUPT__)) == (__INTERRUPT__))
  310.  
  311. /** @brief  Get the selected DAC's flag status.
  312.   * @param  __HANDLE__ specifies the DAC handle.
  313.   * @param  __FLAG__ specifies the DAC flag to get.
  314.   *          This parameter can be any combination of the following values:
  315.   *            @arg DAC_FLAG_DMAUDR1 DAC channel 1 DMA underrun flag
  316.   *            @arg DAC_FLAG_DMAUDR2 DAC channel 2 DMA underrun flag
  317.   * @retval None
  318.   */
  319. #define __HAL_DAC_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
  320.  
  321. /** @brief  Clear the DAC's flag.
  322.   * @param  __HANDLE__ specifies the DAC handle.
  323.   * @param  __FLAG__ specifies the DAC flag to clear.
  324.   *          This parameter can be any combination of the following values:
  325.   *            @arg DAC_FLAG_DMAUDR1 DAC channel 1 DMA underrun flag
  326.   *            @arg DAC_FLAG_DMAUDR2 DAC channel 2 DMA underrun flag
  327.   * @retval None
  328.   */
  329. #define __HAL_DAC_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = (__FLAG__))
  330.  
  331. /**
  332.   * @}
  333.   */
  334.  
  335. /* Private macro -------------------------------------------------------------*/
  336.  
  337. /** @defgroup DAC_Private_Macros DAC Private Macros
  338.   * @{
  339.   */
  340. #define IS_DAC_OUTPUT_BUFFER_STATE(STATE) (((STATE) == DAC_OUTPUTBUFFER_ENABLE) || \
  341.                                            ((STATE) == DAC_OUTPUTBUFFER_DISABLE))
  342.  
  343. #define IS_DAC_CHANNEL(CHANNEL) (((CHANNEL) == DAC_CHANNEL_1) || \
  344.                                  ((CHANNEL) == DAC_CHANNEL_2))
  345.  
  346. #define IS_DAC_ALIGN(ALIGN) (((ALIGN) == DAC_ALIGN_12B_R) || \
  347.                              ((ALIGN) == DAC_ALIGN_12B_L) || \
  348.                              ((ALIGN) == DAC_ALIGN_8B_R))
  349.  
  350. #define IS_DAC_DATA(DATA) ((DATA) <= 0xFFF0UL)
  351.  
  352. /**
  353.   * @}
  354.   */
  355.  
  356. /* Include DAC HAL Extended module */
  357. #include "stm32f1xx_hal_dac_ex.h"
  358.  
  359. /* Exported functions --------------------------------------------------------*/
  360.  
  361. /** @addtogroup DAC_Exported_Functions
  362.   * @{
  363.   */
  364.  
  365. /** @addtogroup DAC_Exported_Functions_Group1
  366.   * @{
  367.   */
  368. /* Initialization and de-initialization functions *****************************/
  369. HAL_StatusTypeDef HAL_DAC_Init(DAC_HandleTypeDef *hdac);
  370. HAL_StatusTypeDef HAL_DAC_DeInit(DAC_HandleTypeDef *hdac);
  371. void HAL_DAC_MspInit(DAC_HandleTypeDef *hdac);
  372. void HAL_DAC_MspDeInit(DAC_HandleTypeDef *hdac);
  373.  
  374. /**
  375.   * @}
  376.   */
  377.  
  378. /** @addtogroup DAC_Exported_Functions_Group2
  379.   * @{
  380.   */
  381. /* IO operation functions *****************************************************/
  382. HAL_StatusTypeDef HAL_DAC_Start(DAC_HandleTypeDef *hdac, uint32_t Channel);
  383. HAL_StatusTypeDef HAL_DAC_Stop(DAC_HandleTypeDef *hdac, uint32_t Channel);
  384. HAL_StatusTypeDef HAL_DAC_Start_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel, const uint32_t *pData, uint32_t Length,
  385.                                     uint32_t Alignment);
  386. HAL_StatusTypeDef HAL_DAC_Stop_DMA(DAC_HandleTypeDef *hdac, uint32_t Channel);
  387. void HAL_DAC_IRQHandler(DAC_HandleTypeDef *hdac);
  388. HAL_StatusTypeDef HAL_DAC_SetValue(DAC_HandleTypeDef *hdac, uint32_t Channel, uint32_t Alignment, uint32_t Data);
  389.  
  390. void HAL_DAC_ConvCpltCallbackCh1(DAC_HandleTypeDef *hdac);
  391. void HAL_DAC_ConvHalfCpltCallbackCh1(DAC_HandleTypeDef *hdac);
  392. void HAL_DAC_ErrorCallbackCh1(DAC_HandleTypeDef *hdac);
  393. void HAL_DAC_DMAUnderrunCallbackCh1(DAC_HandleTypeDef *hdac);
  394.  
  395. #if (USE_HAL_DAC_REGISTER_CALLBACKS == 1)
  396. /* DAC callback registering/unregistering */
  397. HAL_StatusTypeDef     HAL_DAC_RegisterCallback(DAC_HandleTypeDef *hdac, HAL_DAC_CallbackIDTypeDef CallbackID,
  398.                                                pDAC_CallbackTypeDef pCallback);
  399. HAL_StatusTypeDef     HAL_DAC_UnRegisterCallback(DAC_HandleTypeDef *hdac, HAL_DAC_CallbackIDTypeDef CallbackID);
  400. #endif /* USE_HAL_DAC_REGISTER_CALLBACKS */
  401.  
  402. /**
  403.   * @}
  404.   */
  405.  
  406. /** @addtogroup DAC_Exported_Functions_Group3
  407.   * @{
  408.   */
  409. /* Peripheral Control functions ***********************************************/
  410. uint32_t HAL_DAC_GetValue(const DAC_HandleTypeDef *hdac, uint32_t Channel);
  411. HAL_StatusTypeDef HAL_DAC_ConfigChannel(DAC_HandleTypeDef *hdac,
  412.                                         const DAC_ChannelConfTypeDef *sConfig, uint32_t Channel);
  413. /**
  414.   * @}
  415.   */
  416.  
  417. /** @addtogroup DAC_Exported_Functions_Group4
  418.   * @{
  419.   */
  420. /* Peripheral State and Error functions ***************************************/
  421. HAL_DAC_StateTypeDef HAL_DAC_GetState(const DAC_HandleTypeDef *hdac);
  422. uint32_t HAL_DAC_GetError(const DAC_HandleTypeDef *hdac);
  423.  
  424. /**
  425.   * @}
  426.   */
  427.  
  428. /**
  429.   * @}
  430.   */
  431.  
  432. /** @defgroup DAC_Private_Functions DAC Private Functions
  433.   * @{
  434.   */
  435. void DAC_DMAConvCpltCh1(DMA_HandleTypeDef *hdma);
  436. void DAC_DMAErrorCh1(DMA_HandleTypeDef *hdma);
  437. void DAC_DMAHalfConvCpltCh1(DMA_HandleTypeDef *hdma);
  438. /**
  439.   * @}
  440.   */
  441.  
  442. /**
  443.   * @}
  444.   */
  445.  
  446. #endif /* DAC */
  447.  
  448. /**
  449.   * @}
  450.   */
  451.  
  452. #ifdef __cplusplus
  453. }
  454. #endif
  455.  
  456.  
  457. #endif /* STM32F1xx_HAL_DAC_H */
  458.