2019-07-08 12:45:16 +01:00
/**
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* @ file stm32f0xx_hal_comp . h
* @ author MCD Application Team
* @ brief Header file of COMP HAL module .
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* @ attention
*
2019-10-18 12:36:04 +01:00
* < h2 > < center > & copy ; Copyright ( c ) 2016 STMicroelectronics .
* All rights reserved . < / center > < / h2 >
2019-07-08 12:45:16 +01:00
*
2019-10-18 12:36:04 +01:00
* This software component is licensed by ST under BSD 3 - Clause license ,
* the " License " ; You may not use this file except in compliance with the
* License . You may obtain a copy of the License at :
* opensource . org / licenses / BSD - 3 - Clause
2019-07-08 12:45:16 +01:00
*
2019-10-18 12:36:04 +01:00
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
2019-07-08 12:45:16 +01:00
*/
/* Define to prevent recursive inclusion -------------------------------------*/
2019-10-18 12:36:04 +01:00
# ifndef STM32F0xx_HAL_COMP_H
# define STM32F0xx_HAL_COMP_H
2019-07-08 12:45:16 +01:00
# ifdef __cplusplus
extern " C " {
# endif
2019-10-18 12:36:04 +01:00
# if defined (COMP1) || defined (COMP2)
2019-07-08 12:45:16 +01:00
/* Includes ------------------------------------------------------------------*/
# include "stm32f0xx_hal_def.h"
/** @addtogroup STM32F0xx_HAL_Driver
* @ {
*/
/** @addtogroup COMP COMP
* @ {
*/
/* Exported types ------------------------------------------------------------*/
/** @defgroup COMP_Exported_Types COMP Exported Types
* @ {
*/
/**
* @ brief COMP Init structure definition
*/
typedef struct
{
uint32_t InvertingInput ; /*!< Selects the inverting input of the comparator.
This parameter can be a value of @ ref COMP_InvertingInput */
uint32_t NonInvertingInput ; /*!< Selects the non inverting input of the comparator.
This parameter can be a value of @ ref COMP_NonInvertingInput */
uint32_t Output ; /*!< Selects the output redirection of the comparator.
This parameter can be a value of @ ref COMP_Output */
uint32_t OutputPol ; /*!< Selects the output polarity of the comparator.
This parameter can be a value of @ ref COMP_OutputPolarity */
uint32_t Hysteresis ; /*!< Selects the hysteresis voltage of the comparator.
This parameter can be a value of @ ref COMP_Hysteresis */
uint32_t Mode ; /*!< Selects the operating comsumption mode of the comparator
to adjust the speed / consumption .
This parameter can be a value of @ ref COMP_Mode */
uint32_t WindowMode ; /*!< Selects the window mode of the comparator 1 & 2.
This parameter can be a value of @ ref COMP_WindowMode */
uint32_t TriggerMode ; /*!< Selects the trigger mode of the comparator (interrupt mode).
This parameter can be a value of @ ref COMP_TriggerMode */
} COMP_InitTypeDef ;
/**
* @ brief COMP Handle Structure definition
*/
2019-10-18 12:36:04 +01:00
typedef struct __COMP_HandleTypeDef
2019-07-08 12:45:16 +01:00
{
2019-10-18 12:36:04 +01:00
COMP_TypeDef * Instance ; /*!< Register base address */
COMP_InitTypeDef Init ; /*!< COMP required parameters */
HAL_LockTypeDef Lock ; /*!< Locking object */
__IO uint32_t State ; /*!< COMP communication state
This parameter can be a value of @ ref COMP_State */
__IO uint32_t ErrorCode ; /*!< COMP Error code */
# if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
void ( * TriggerCallback ) ( struct __COMP_HandleTypeDef * hcomp ) ; /*!< COMP trigger callback */
void ( * MspInitCallback ) ( struct __COMP_HandleTypeDef * hcomp ) ; /*!< COMP Msp Init callback */
void ( * MspDeInitCallback ) ( struct __COMP_HandleTypeDef * hcomp ) ; /*!< COMP Msp DeInit callback */
# endif /* USE_HAL_COMP_REGISTER_CALLBACKS */
2019-07-08 12:45:16 +01:00
} COMP_HandleTypeDef ;
2019-10-18 12:36:04 +01:00
# if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
/**
* @ brief HAL COMP Callback ID enumeration definition
*/
typedef enum
{
HAL_COMP_TRIGGER_CB_ID = 0x00U , /*!< COMP trigger callback ID */
HAL_COMP_MSPINIT_CB_ID = 0x01U , /*!< COMP Msp Init callback ID */
HAL_COMP_MSPDEINIT_CB_ID = 0x02U /*!< COMP Msp DeInit callback ID */
} HAL_COMP_CallbackIDTypeDef ;
/**
* @ brief HAL COMP Callback pointer definition
*/
typedef void ( * pCOMP_CallbackTypeDef ) ( COMP_HandleTypeDef * hcomp ) ; /*!< pointer to a COMP callback function */
# endif /* USE_HAL_COMP_REGISTER_CALLBACKS */
2019-07-08 12:45:16 +01:00
/**
* @ }
*/
/* Exported constants --------------------------------------------------------*/
/** @defgroup COMP_Exported_Constants COMP Exported Constants
* @ {
*/
2019-10-18 12:36:04 +01:00
/** @defgroup COMP_Error_Code COMP Error Code
* @ {
*/
# define HAL_COMP_ERROR_NONE (0x00U) /*!< No error */
# if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
# define HAL_COMP_ERROR_INVALID_CALLBACK (0x01U) /*!< Invalid Callback error */
# endif /* USE_HAL_COMP_REGISTER_CALLBACKS */
/**
* @ }
*/
2019-07-08 12:45:16 +01:00
/** @defgroup COMP_State COMP State
* @ {
*/
# define HAL_COMP_STATE_RESET (0x00000000U) /*!< COMP not yet initialized or disabled */
# define HAL_COMP_STATE_READY (0x00000001U) /*!< COMP initialized and ready for use */
# define HAL_COMP_STATE_READY_LOCKED (0x00000011U) /*!< COMP initialized but the configuration is locked */
# define HAL_COMP_STATE_BUSY (0x00000002U) /*!< COMP is running */
# define HAL_COMP_STATE_BUSY_LOCKED (0x00000012U) /*!< COMP is running and the configuration is locked */
/**
* @ }
*/
/** @defgroup COMP_OutputPolarity COMP OutputPolarity
* @ {
*/
# define COMP_OUTPUTPOL_NONINVERTED (0x00000000U) /*!< COMP output on GPIO isn't inverted */
# define COMP_OUTPUTPOL_INVERTED COMP_CSR_COMP1POL /*!< COMP output on GPIO is inverted */
/**
* @ }
*/
/** @defgroup COMP_Hysteresis COMP Hysteresis
* @ {
*/
# define COMP_HYSTERESIS_NONE (0x00000000U) /*!< No hysteresis */
# define COMP_HYSTERESIS_LOW COMP_CSR_COMP1HYST_0 /*!< Hysteresis level low */
# define COMP_HYSTERESIS_MEDIUM COMP_CSR_COMP1HYST_1 /*!< Hysteresis level medium */
# define COMP_HYSTERESIS_HIGH COMP_CSR_COMP1HYST /*!< Hysteresis level high */
/**
* @ }
*/
/** @defgroup COMP_Mode COMP Mode
* @ {
*/
/* Please refer to the electrical characteristics in the device datasheet for
the power consumption values */
# define COMP_MODE_HIGHSPEED (0x00000000U) /*!< High Speed */
# define COMP_MODE_MEDIUMSPEED COMP_CSR_COMP1MODE_0 /*!< Medium Speed */
# define COMP_MODE_LOWPOWER COMP_CSR_COMP1MODE_1 /*!< Low power mode */
# define COMP_MODE_ULTRALOWPOWER COMP_CSR_COMP1MODE /*!< Ultra-low power mode */
/**
* @ }
*/
/** @defgroup COMP_InvertingInput COMP InvertingInput
* @ {
*/
# define COMP_INVERTINGINPUT_1_4VREFINT (0x00000000U) /*!< 1/4 VREFINT connected to comparator inverting input */
# define COMP_INVERTINGINPUT_1_2VREFINT COMP_CSR_COMP1INSEL_0 /*!< 1/2 VREFINT connected to comparator inverting input */
# define COMP_INVERTINGINPUT_3_4VREFINT COMP_CSR_COMP1INSEL_1 /*!< 3/4 VREFINT connected to comparator inverting input */
# define COMP_INVERTINGINPUT_VREFINT (COMP_CSR_COMP1INSEL_1|COMP_CSR_COMP1INSEL_0) /*!< VREFINT connected to comparator inverting input */
# define COMP_INVERTINGINPUT_DAC1 COMP_CSR_COMP1INSEL_2 /*!< DAC_OUT1 (PA4) connected to comparator inverting input */
# define COMP_INVERTINGINPUT_DAC1SWITCHCLOSED (COMP_CSR_COMP1INSEL_2|COMP_CSR_COMP1SW1) / *!< DAC_OUT1 (PA4) connected to comparator inverting input
and close switch ( PA0 for COMP1 only ) */
# define COMP_INVERTINGINPUT_DAC2 (COMP_CSR_COMP1INSEL_2|COMP_CSR_COMP1INSEL_0) /*!< DAC_OUT2 (PA5) connected to comparator inverting input */
# define COMP_INVERTINGINPUT_IO1 (COMP_CSR_COMP1INSEL_2|COMP_CSR_COMP1INSEL_1) /*!< IO (PA0 for COMP1 and PA2 for COMP2) connected to comparator inverting input */
/**
* @ }
*/
/** @defgroup COMP_NonInvertingInput COMP NonInvertingInput
* @ {
*/
# define COMP_NONINVERTINGINPUT_IO1 (0x00000000U) / *!< I / O1 (PA1 for COMP1, PA3 for COMP2)
connected to comparator non inverting input */
# define COMP_NONINVERTINGINPUT_DAC1SWITCHCLOSED COMP_CSR_COMP1SW1 /*!< DAC ouput connected to comparator COMP1 non inverting input */
/**
* @ }
*/
/** @defgroup COMP_Output COMP Output
* @ {
*/
/* Output Redirection common for COMP1 and COMP2 */
# define COMP_OUTPUT_NONE (0x00000000U) /*!< COMP output isn't connected to other peripherals */
# define COMP_OUTPUT_TIM1BKIN COMP_CSR_COMP1OUTSEL_0 /*!< COMP output connected to TIM1 Break Input (BKIN) */
# define COMP_OUTPUT_TIM1IC1 COMP_CSR_COMP1OUTSEL_1 /*!< COMP output connected to TIM1 Input Capture 1 */
# define COMP_OUTPUT_TIM1OCREFCLR (COMP_CSR_COMP1OUTSEL_1|COMP_CSR_COMP1OUTSEL_0) /*!< COMP output connected to TIM1 OCREF Clear */
# define COMP_OUTPUT_TIM2IC4 COMP_CSR_COMP1OUTSEL_2 /*!< COMP output connected to TIM2 Input Capture 4 */
# define COMP_OUTPUT_TIM2OCREFCLR (COMP_CSR_COMP1OUTSEL_2|COMP_CSR_COMP1OUTSEL_0) /*!< COMP output connected to TIM2 OCREF Clear */
# define COMP_OUTPUT_TIM3IC1 (COMP_CSR_COMP1OUTSEL_2|COMP_CSR_COMP1OUTSEL_1) /*!< COMP output connected to TIM3 Input Capture 1 */
# define COMP_OUTPUT_TIM3OCREFCLR COMP_CSR_COMP1OUTSEL /*!< COMP output connected to TIM3 OCREF Clear */
/**
* @ }
*/
/** @defgroup COMP_OutputLevel COMP OutputLevel
* @ {
*/
/* When output polarity is not inverted, comparator output is low when
the non - inverting input is at a lower voltage than the inverting input */
# define COMP_OUTPUTLEVEL_LOW (0x00000000U)
/* When output polarity is not inverted, comparator output is high when
the non - inverting input is at a higher voltage than the inverting input */
# define COMP_OUTPUTLEVEL_HIGH COMP_CSR_COMP1OUT
/**
* @ }
*/
/** @defgroup COMP_TriggerMode COMP TriggerMode
* @ {
*/
# define COMP_TRIGGERMODE_NONE (0x00000000U) /*!< No External Interrupt trigger detection */
# define COMP_TRIGGERMODE_IT_RISING (0x00000001U) /*!< External Interrupt Mode with Rising edge trigger detection */
# define COMP_TRIGGERMODE_IT_FALLING (0x00000002U) /*!< External Interrupt Mode with Falling edge trigger detection */
# define COMP_TRIGGERMODE_IT_RISING_FALLING (0x00000003U) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */
# define COMP_TRIGGERMODE_EVENT_RISING (0x00000010U) /*!< Event Mode with Rising edge trigger detection */
# define COMP_TRIGGERMODE_EVENT_FALLING (0x00000020U) /*!< Event Mode with Falling edge trigger detection */
# define COMP_TRIGGERMODE_EVENT_RISING_FALLING (0x00000030U) /*!< Event Mode with Rising/Falling edge trigger detection */
/**
* @ }
*/
/** @defgroup COMP_WindowMode COMP WindowMode
* @ {
*/
# define COMP_WINDOWMODE_DISABLE (0x00000000U) /*!< Window mode disabled */
# define COMP_WINDOWMODE_ENABLE COMP_CSR_WNDWEN / *!< Window mode enabled: non inverting input of comparator 2
is connected to the non inverting input of comparator 1 ( PA1 ) */
/**
* @ }
*/
/** @defgroup COMP_Flag COMP Flag
* @ {
*/
# define COMP_FLAG_LOCK ((uint32_t)COMP_CSR_COMPxLOCK) /*!< Lock flag */
/**
* @ }
*/
/**
* @ }
*/
/* Exported macros -----------------------------------------------------------*/
/** @defgroup COMP_Exported_Macros COMP Exported Macros
* @ {
*/
/** @brief Reset COMP handle state
* @ param __HANDLE__ COMP handle .
* @ retval None
*/
2019-10-18 12:36:04 +01:00
# if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
# define __HAL_COMP_RESET_HANDLE_STATE(__HANDLE__) do{ \
( __HANDLE__ ) - > State = HAL_COMP_STATE_RESET ; \
( __HANDLE__ ) - > MspInitCallback = NULL ; \
( __HANDLE__ ) - > MspDeInitCallback = NULL ; \
} while ( 0 )
# else
2019-07-08 12:45:16 +01:00
# define __HAL_COMP_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_COMP_STATE_RESET)
2019-10-18 12:36:04 +01:00
# endif
/**
* @ brief Clear COMP error code ( set it to no error code " HAL_COMP_ERROR_NONE " ) .
* @ param __HANDLE__ COMP handle
* @ retval None
*/
# define COMP_CLEAR_ERRORCODE(__HANDLE__) ((__HANDLE__)->ErrorCode = HAL_COMP_ERROR_NONE)
2019-07-08 12:45:16 +01:00
/**
* @ brief Enable the specified comparator .
* @ param __HANDLE__ COMP handle .
* @ retval None
*/
# define __HAL_COMP_ENABLE(__HANDLE__) (((__HANDLE__)->Instance == COMP1) ? \
SET_BIT ( COMP - > CSR , COMP_CSR_COMP1EN ) : \
SET_BIT ( COMP - > CSR , COMP_CSR_COMP2EN ) )
/**
* @ brief Disable the specified comparator .
* @ param __HANDLE__ COMP handle .
* @ retval None
*/
# define __HAL_COMP_DISABLE(__HANDLE__) (((__HANDLE__)->Instance == COMP1) ? \
CLEAR_BIT ( COMP - > CSR , COMP_CSR_COMP1EN ) : \
CLEAR_BIT ( COMP - > CSR , COMP_CSR_COMP2EN ) )
/**
* @ brief Lock the specified comparator configuration .
* @ param __HANDLE__ COMP handle .
* @ retval None
*/
# define __HAL_COMP_LOCK(__HANDLE__) (((__HANDLE__)->Instance == COMP1) ? \
SET_BIT ( COMP - > CSR , COMP_CSR_COMP1LOCK ) : \
SET_BIT ( COMP - > CSR , COMP_CSR_COMP2LOCK ) )
/**
* @ brief Enable the COMP1 EXTI line rising edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_ENABLE_RISING_EDGE() SET_BIT(EXTI->RTSR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Disable the COMP1 EXTI line rising edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_DISABLE_RISING_EDGE() CLEAR_BIT(EXTI->RTSR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Enable the COMP1 EXTI line falling edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_ENABLE_FALLING_EDGE() SET_BIT(EXTI->FTSR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Disable the COMP1 EXTI line falling edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_DISABLE_FALLING_EDGE() CLEAR_BIT(EXTI->FTSR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Enable the COMP1 EXTI line rising & falling edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_ENABLE_RISING_FALLING_EDGE() do { \
__HAL_COMP_COMP1_EXTI_ENABLE_RISING_EDGE ( ) ; \
__HAL_COMP_COMP1_EXTI_ENABLE_FALLING_EDGE ( ) ; \
} while ( 0 )
/**
* @ brief Disable the COMP1 EXTI line rising & falling edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_DISABLE_RISING_FALLING_EDGE() do { \
__HAL_COMP_COMP1_EXTI_DISABLE_RISING_EDGE ( ) ; \
__HAL_COMP_COMP1_EXTI_DISABLE_FALLING_EDGE ( ) ; \
} while ( 0 )
/**
* @ brief Enable the COMP1 EXTI line in interrupt mode .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_ENABLE_IT() SET_BIT(EXTI->IMR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Disable the COMP1 EXTI line in interrupt mode .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_DISABLE_IT() CLEAR_BIT(EXTI->IMR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Generate a software interrupt on the COMP1 EXTI line .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_GENERATE_SWIT() SET_BIT(EXTI->SWIER, COMP_EXTI_LINE_COMP1)
/**
* @ brief Enable the COMP1 EXTI Line in event mode .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_ENABLE_EVENT() SET_BIT(EXTI->EMR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Disable the COMP1 EXTI Line in event mode .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_DISABLE_EVENT() CLEAR_BIT(EXTI->EMR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Check whether the COMP1 EXTI line flag is set or not .
* @ retval RESET or SET
*/
# define __HAL_COMP_COMP1_EXTI_GET_FLAG() READ_BIT(EXTI->PR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Clear the COMP1 EXTI flag .
* @ retval None
*/
# define __HAL_COMP_COMP1_EXTI_CLEAR_FLAG() WRITE_REG(EXTI->PR, COMP_EXTI_LINE_COMP1)
/**
* @ brief Enable the COMP2 EXTI line rising edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_ENABLE_RISING_EDGE() SET_BIT(EXTI->RTSR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Disable the COMP2 EXTI line rising edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_DISABLE_RISING_EDGE() CLEAR_BIT(EXTI->RTSR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Enable the COMP2 EXTI line falling edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_ENABLE_FALLING_EDGE() SET_BIT(EXTI->FTSR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Disable the COMP2 EXTI line falling edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_DISABLE_FALLING_EDGE() CLEAR_BIT(EXTI->FTSR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Enable the COMP2 EXTI line rising & falling edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_ENABLE_RISING_FALLING_EDGE() do { \
__HAL_COMP_COMP2_EXTI_ENABLE_RISING_EDGE ( ) ; \
__HAL_COMP_COMP2_EXTI_ENABLE_FALLING_EDGE ( ) ; \
} while ( 0 )
/**
* @ brief Disable the COMP2 EXTI line rising & falling edge trigger .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_DISABLE_RISING_FALLING_EDGE() do { \
__HAL_COMP_COMP2_EXTI_DISABLE_RISING_EDGE ( ) ; \
__HAL_COMP_COMP2_EXTI_DISABLE_FALLING_EDGE ( ) ; \
} while ( 0 )
/**
* @ brief Enable the COMP2 EXTI line in interrupt mode .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_ENABLE_IT() SET_BIT(EXTI->IMR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Disable the COMP2 EXTI line in interrupt mode .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_DISABLE_IT() CLEAR_BIT(EXTI->IMR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Generate a software interrupt on the COMP2 EXTI line .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_GENERATE_SWIT() SET_BIT(EXTI->SWIER, COMP_EXTI_LINE_COMP2)
/**
* @ brief Enable the COMP2 EXTI Line in event mode .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_ENABLE_EVENT() SET_BIT(EXTI->EMR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Disable the COMP2 EXTI Line in event mode .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_DISABLE_EVENT() CLEAR_BIT(EXTI->EMR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Check whether the COMP2 EXTI line flag is set or not .
* @ retval RESET or SET
*/
# define __HAL_COMP_COMP2_EXTI_GET_FLAG() READ_BIT(EXTI->PR, COMP_EXTI_LINE_COMP2)
/**
* @ brief Clear the COMP2 EXTI flag .
* @ retval None
*/
# define __HAL_COMP_COMP2_EXTI_CLEAR_FLAG() WRITE_REG(EXTI->PR, COMP_EXTI_LINE_COMP2)
/** @brief Check whether the specified COMP flag is set or not.
* @ param __HANDLE__ specifies the COMP Handle .
* @ param __FLAG__ specifies the flag to check .
* This parameter can be one of the following values :
* @ arg COMP_FLAG_LOCK : lock flag
* @ retval The new state of __FLAG__ ( TRUE or FALSE ) .
*/
# define __HAL_COMP_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->CSR & (__FLAG__)) == (__FLAG__))
/**
* @ }
*/
/* Exported functions --------------------------------------------------------*/
/** @addtogroup COMP_Exported_Functions COMP Exported Functions
* @ {
*/
/** @addtogroup COMP_Exported_Functions_Group1 Initialization/de-initialization functions
* @ brief Initialization and Configuration functions
* @ {
*/
/* Initialization and de-initialization functions ****************************/
HAL_StatusTypeDef HAL_COMP_Init ( COMP_HandleTypeDef * hcomp ) ;
HAL_StatusTypeDef HAL_COMP_DeInit ( COMP_HandleTypeDef * hcomp ) ;
void HAL_COMP_MspInit ( COMP_HandleTypeDef * hcomp ) ;
void HAL_COMP_MspDeInit ( COMP_HandleTypeDef * hcomp ) ;
2019-10-18 12:36:04 +01:00
# if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
/* Callbacks Register/UnRegister functions ***********************************/
HAL_StatusTypeDef HAL_COMP_RegisterCallback ( COMP_HandleTypeDef * hcomp , HAL_COMP_CallbackIDTypeDef CallbackID , pCOMP_CallbackTypeDef pCallback ) ;
HAL_StatusTypeDef HAL_COMP_UnRegisterCallback ( COMP_HandleTypeDef * hcomp , HAL_COMP_CallbackIDTypeDef CallbackID ) ;
# endif /* USE_HAL_COMP_REGISTER_CALLBACKS */
2019-07-08 12:45:16 +01:00
/**
* @ }
*/
/** @addtogroup COMP_Exported_Functions_Group2 I/O operation functions
* @ brief Data transfers functions
* @ {
*/
/* IO operation functions *****************************************************/
HAL_StatusTypeDef HAL_COMP_Start ( COMP_HandleTypeDef * hcomp ) ;
HAL_StatusTypeDef HAL_COMP_Stop ( COMP_HandleTypeDef * hcomp ) ;
HAL_StatusTypeDef HAL_COMP_Start_IT ( COMP_HandleTypeDef * hcomp ) ;
HAL_StatusTypeDef HAL_COMP_Stop_IT ( COMP_HandleTypeDef * hcomp ) ;
void HAL_COMP_IRQHandler ( COMP_HandleTypeDef * hcomp ) ;
/**
* @ }
*/
/** @addtogroup COMP_Exported_Functions_Group3 Peripheral Control functions
* @ brief management functions
* @ {
*/
/* Peripheral Control functions ***********************************************/
HAL_StatusTypeDef HAL_COMP_Lock ( COMP_HandleTypeDef * hcomp ) ;
uint32_t HAL_COMP_GetOutputLevel ( COMP_HandleTypeDef * hcomp ) ;
/* Callback in Interrupt mode */
void HAL_COMP_TriggerCallback ( COMP_HandleTypeDef * hcomp ) ;
/**
* @ }
*/
/** @addtogroup COMP_Exported_Functions_Group4 Peripheral State functions
* @ brief Peripheral State functions
* @ {
*/
/* Peripheral State and Error functions ***************************************/
2019-10-18 12:36:04 +01:00
uint32_t HAL_COMP_GetState ( COMP_HandleTypeDef * hcomp ) ;
uint32_t HAL_COMP_GetError ( COMP_HandleTypeDef * hcomp ) ;
2019-07-08 12:45:16 +01:00
/**
* @ }
*/
/**
* @ }
*/
/* Private types -------------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/** @defgroup COMP_Private_Constants COMP Private Constants
* @ {
*/
/** @defgroup COMP_ExtiLine COMP EXTI Lines
* Elements values convention : XXXX0000
* - XXXX : Interrupt mask in the EMR / IMR / RTSR / FTSR register
* @ {
*/
# define COMP_EXTI_LINE_COMP1 ((uint32_t)EXTI_IMR_MR21) /*!< EXTI line 21 connected to COMP1 output */
# define COMP_EXTI_LINE_COMP2 ((uint32_t)EXTI_IMR_MR22) /*!< EXTI line 22 connected to COMP2 output */
/**
* @ }
*/
/**
* @ }
*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup COMP_Private_Macros COMP Private Macros
* @ {
*/
/** @defgroup COMP_GET_EXTI_LINE COMP Private macros to get EXTI line associated with Comparators
* @ {
*/
/**
* @ brief Get the specified EXTI line for a comparator instance .
* @ param __INSTANCE__ specifies the COMP instance .
* @ retval value of @ ref COMP_ExtiLine
*/
# define COMP_GET_EXTI_LINE(__INSTANCE__) (((__INSTANCE__) == COMP1) ? COMP_EXTI_LINE_COMP1 : \
COMP_EXTI_LINE_COMP2 )
/**
* @ }
*/
/** @defgroup COMP_IS_COMP_Definitions COMP Private macros to check input parameters
* @ {
*/
# define IS_COMP_OUTPUTPOL(POL) (((POL) == COMP_OUTPUTPOL_NONINVERTED) || \
( ( POL ) = = COMP_OUTPUTPOL_INVERTED ) )
# define IS_COMP_HYSTERESIS(HYSTERESIS) (((HYSTERESIS) == COMP_HYSTERESIS_NONE) || \
( ( HYSTERESIS ) = = COMP_HYSTERESIS_LOW ) | | \
( ( HYSTERESIS ) = = COMP_HYSTERESIS_MEDIUM ) | | \
( ( HYSTERESIS ) = = COMP_HYSTERESIS_HIGH ) )
# define IS_COMP_MODE(MODE) (((MODE) == COMP_MODE_HIGHSPEED) || \
( ( MODE ) = = COMP_MODE_MEDIUMSPEED ) | | \
( ( MODE ) = = COMP_MODE_LOWPOWER ) | | \
( ( MODE ) = = COMP_MODE_ULTRALOWPOWER ) )
# define IS_COMP_INVERTINGINPUT(INPUT) (((INPUT) == COMP_INVERTINGINPUT_1_4VREFINT) || \
( ( INPUT ) = = COMP_INVERTINGINPUT_1_2VREFINT ) | | \
( ( INPUT ) = = COMP_INVERTINGINPUT_3_4VREFINT ) | | \
( ( INPUT ) = = COMP_INVERTINGINPUT_VREFINT ) | | \
( ( INPUT ) = = COMP_INVERTINGINPUT_DAC1 ) | | \
( ( INPUT ) = = COMP_INVERTINGINPUT_DAC1SWITCHCLOSED ) | | \
( ( INPUT ) = = COMP_INVERTINGINPUT_DAC2 ) | | \
( ( INPUT ) = = COMP_INVERTINGINPUT_IO1 ) )
# define IS_COMP_NONINVERTINGINPUT(INPUT) (((INPUT) == COMP_NONINVERTINGINPUT_IO1) || \
( ( INPUT ) = = COMP_NONINVERTINGINPUT_DAC1SWITCHCLOSED ) )
# define IS_COMP_OUTPUT(OUTPUT) (((OUTPUT) == COMP_OUTPUT_NONE) || \
( ( OUTPUT ) = = COMP_OUTPUT_TIM1BKIN ) | | \
( ( OUTPUT ) = = COMP_OUTPUT_TIM1IC1 ) | | \
( ( OUTPUT ) = = COMP_OUTPUT_TIM1OCREFCLR ) | | \
( ( OUTPUT ) = = COMP_OUTPUT_TIM2IC4 ) | | \
( ( OUTPUT ) = = COMP_OUTPUT_TIM2OCREFCLR ) | | \
( ( OUTPUT ) = = COMP_OUTPUT_TIM3IC1 ) | | \
( ( OUTPUT ) = = COMP_OUTPUT_TIM3OCREFCLR ) )
# define IS_COMP_WINDOWMODE(WINDOWMODE) (((WINDOWMODE) == COMP_WINDOWMODE_DISABLE) || \
( ( WINDOWMODE ) = = COMP_WINDOWMODE_ENABLE ) )
# define IS_COMP_TRIGGERMODE(__MODE__) (((__MODE__) == COMP_TRIGGERMODE_NONE) || \
( ( __MODE__ ) = = COMP_TRIGGERMODE_IT_RISING ) | | \
( ( __MODE__ ) = = COMP_TRIGGERMODE_IT_FALLING ) | | \
( ( __MODE__ ) = = COMP_TRIGGERMODE_IT_RISING_FALLING ) | | \
( ( __MODE__ ) = = COMP_TRIGGERMODE_EVENT_RISING ) | | \
( ( __MODE__ ) = = COMP_TRIGGERMODE_EVENT_FALLING ) | | \
( ( __MODE__ ) = = COMP_TRIGGERMODE_EVENT_RISING_FALLING ) )
/**
* @ }
*/
/** @defgroup COMP_Lock COMP Lock
* @ {
*/
# define COMP_LOCK_DISABLE (0x00000000U)
# define COMP_LOCK_ENABLE COMP_CSR_COMP1LOCK
# define COMP_STATE_BIT_LOCK (0x10U)
/**
* @ }
*/
/**
* @ }
*/
/* Private functions ---------------------------------------------------------*/
/**
* @ }
*/
/**
* @ }
*/
2019-10-18 12:36:04 +01:00
# endif /* COMP1 || COMP2 */
2019-07-08 12:45:16 +01:00
# ifdef __cplusplus
}
# endif
2019-10-18 12:36:04 +01:00
# endif /* STM32F0xx_HAL_COMP_H */
2019-07-08 12:45:16 +01:00
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/