| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120 |
- /**
- ******************************************************************************
- * @file stm32f3xx_hal_comp.c
- * @author MCD Application Team
- * @brief COMP HAL module driver.
- * This file provides firmware functions to manage the following
- * functionalities of the COMP peripheral:
- * + Initialization and de-initialization functions
- * + Peripheral Control functions
- * + Peripheral State functions
- *
- ******************************************************************************
- * @attention
- *
- * Copyright (c) 2016 STMicroelectronics.
- * All rights reserved.
- *
- * This software is licensed under terms that can be found in the LICENSE file
- * in the root directory of this software component.
- * If no LICENSE file comes with this software, it is provided AS-IS.
- *
- ******************************************************************************
- @verbatim
- ================================================================================
- ##### COMP Peripheral features #####
- ================================================================================
- [..]
- The STM32F3xx device family integrates up to 7 analog comparators COMP1, COMP2...COMP7:
- (#) The non inverting input and inverting input can be set to GPIO pins.
- For STM32F3xx devices please refer to the COMP peripheral section in corresponding
- Reference Manual.
- (#) The COMP output is available using HAL_COMP_GetOutputLevel()
- and can be set on GPIO pins.
- For STM32F3xx devices please refer to the COMP peripheral section in corresponding
- Reference Manual.
- (#) The COMP output can be redirected to embedded timers (TIM1, TIM2, TIM3...).
- For STM32F3xx devices please refer to the COMP peripheral section in corresponding
- Reference Manual.
- (#) Each couple of comparators COMP1 and COMP2, COMP3 and COMP4, COMP5 and COMP6 can be combined in window
- mode and respectively COMP1, COMP3 and COMP5 non inverting input is used as common non-inverting input.
- (#) The seven comparators have interrupt capability with wake-up
- from Sleep and Stop modes (through the EXTI controller):
- (++) COMP1 is internally connected to EXTI Line 21
- (++) COMP2 is internally connected to EXTI Line 22
- (++) COMP3 is internally connected to EXTI Line 29
- (++) COMP4 is internally connected to EXTI Line 30
- (++) COMP5 is internally connected to EXTI Line 31
- (++) COMP6 is internally connected to EXTI Line 32
- (++) COMP7 is internally connected to EXTI Line 33.
- From the corresponding IRQ handler, the right interrupt source can be retrieved with the
- adequate macro __HAL_COMP_COMPx_EXTI_GET_FLAG().
- ##### How to use this driver #####
- ================================================================================
- [..]
- This driver provides functions to configure and program the Comparators of all STM32F3xx devices.
- To use the comparator, perform the following steps:
- (#) Fill in the HAL_COMP_MspInit() to
- (++) Configure the comparator input in analog mode using HAL_GPIO_Init()
- (++) Configure the comparator output in alternate function mode using HAL_GPIO_Init() to map the comparator
- output to the GPIO pin
- (++) If required enable the COMP interrupt (EXTI line Interrupt): by configuring and enabling EXTI line in Interrupt mode and
- selecting the desired sensitivity level using HAL_GPIO_Init() function. After that enable the comparator
- interrupt vector using HAL_NVIC_SetPriority() and HAL_NVIC_EnableIRQ() functions.
- (#) Configure the comparator using HAL_COMP_Init() function:
- (++) Select the inverting input (input minus)
- (++) Select the non-inverting input (input plus)
- (++) Select the output polarity
- (++) Select the output redirection
- (++) Select the hysteresis level
- (++) Select the power mode
- (++) Select the event/interrupt mode
- -@@- HAL_COMP_Init() calls internally __HAL_RCC_SYSCFG_CLK_ENABLE() in order
- to enable the comparator(s).
- (#) On-the-fly reconfiguration of comparator(s) may be done by calling again HAL_COMP_Init(
- function with new input parameter values; HAL_COMP_MspInit() function shall be adapted
- to support multi configurations.
- (#) Enable the comparator using HAL_COMP_Start() or HAL_COMP_Start_IT() functions.
- (#) Use HAL_COMP_TriggerCallback() and/or HAL_COMP_GetOutputLevel() functions
- to manage comparator outputs (events and output level).
- (#) Disable the comparator using HAL_COMP_Stop() or HAL_COMP_Stop_IT()
- function.
- (#) De-initialize the comparator using HAL_COMP_DeInit() function.
- (#) For safety purposes comparator(s) can be locked using HAL_COMP_Lock() function.
- Only a MCU reset can reset that protection.
- *** Callback registration ***
- =============================================
- [..]
- The compilation flag USE_HAL_COMP_REGISTER_CALLBACKS, when set to 1,
- allows the user to configure dynamically the driver callbacks.
- Use Functions HAL_COMP_RegisterCallback()
- to register an interrupt callback.
- [..]
- Function HAL_COMP_RegisterCallback() allows to register following callbacks:
- (+) OperationCpltCallback : callback for End of operation.
- (+) ErrorCallback : callback for error detection.
- (+) MspInitCallback : callback for Msp Init.
- (+) MspDeInitCallback : callback for Msp DeInit.
- This function takes as parameters the HAL peripheral handle, the Callback ID
- and a pointer to the user callback function.
- [..]
- Use function HAL_COMP_UnRegisterCallback to reset a callback to the default
- weak function.
- [..]
- HAL_COMP_UnRegisterCallback takes as parameters the HAL peripheral handle,
- and the Callback ID.
- This function allows to reset following callbacks:
- (+) OperationCpltCallback : callback for End of operation.
- (+) ErrorCallback : callback for error detection.
- (+) MspInitCallback : callback for Msp Init.
- (+) MspDeInitCallback : callback for Msp DeInit.
- [..]
- By default, after the HAL_COMP_Init() and when the state is HAL_COMP_STATE_RESET
- all callbacks are set to the corresponding weak functions:
- examples HAL_COMP_OperationCpltCallback(), HAL_COMP_ErrorCallback().
- Exception done for MspInit and MspDeInit functions that are
- reset to the legacy weak functions in the HAL_COMP_Init()/ HAL_COMP_DeInit() only when
- these callbacks are null (not registered beforehand).
- [..]
- If MspInit or MspDeInit are not null, the HAL_COMP_Init()/ HAL_COMP_DeInit()
- keep and use the user MspInit/MspDeInit callbacks (registered beforehand) whatever the state.
- [..]
- Callbacks can be registered/unregistered in HAL_COMP_STATE_READY state only.
- Exception done MspInit/MspDeInit functions that can be registered/unregistered
- in HAL_COMP_STATE_READY or HAL_COMP_STATE_RESET state,
- thus registered (user) MspInit/DeInit callbacks can be used during the Init/DeInit.
- [..]
- Then, the user first registers the MspInit/MspDeInit user callbacks
- using HAL_COMP_RegisterCallback() before calling HAL_COMP_DeInit()
- or HAL_COMP_Init() function.
- [..]
- When the compilation flag USE_HAL_COMP_REGISTER_CALLBACKS is set to 0 or
- not defined, the callback registration feature is not available and all callbacks
- are set to the corresponding weak functions.
- ******************************************************************************
- */
- /*
- Additional Tables:
- Table 1. COMP Inputs for the STM32F303xB/STM32F303xC/STM32F303xE devices
- +------------------------------------------------------------------------------------------+
- | | | COMP1 | COMP2 | COMP3 | COMP4 | COMP5 | COMP6 | COMP7 |
- |-----------------|----------------|---------------|---------------------------------------|
- | | 1U/4 VREFINT | OK | OK | OK | OK | OK | OK | OK |
- | | 1U/2 VREFINT | OK | OK | OK | OK | OK | OK | OK |
- | | 3U/4 VREFINT | OK | OK | OK | OK | OK | OK | OK |
- | Inverting Input | VREFINT | OK | OK | OK | OK | OK | OK | OK |
- | | DAC1 OUT (PA4) | OK | OK | OK | OK | OK | OK | OK |
- | | DAC2 OUT (PA5) | OK | OK | OK | OK | OK | OK | OK |
- | | IO1 | PA0 | PA2 | PD15U | PE8 | PD13U | PD10U | PC0 |
- | | IO2 | --- | --- | PB12U | PB2 | PB10U | PB15U | --- |
- |-----------------|----------------|-------|-------|-------|-------|-------|-------|-------|
- | Non Inverting | IO1 | PA1 | PA7 | PB14U | PB0 | PD12U | PD11U | PA0 |
- | Input | IO2 | --- | PA3 | PD14U | PE7 | PB13U | PB11U | PC1 |
- +------------------------------------------------------------------------------------------+
- Table 2. COMP Outputs for the STM32F303xB/STM32F303xC/STM32F303xE devices
- +-------------------------------------------------------+
- | COMP1 | COMP2 | COMP3 | COMP4 | COMP5 | COMP6 | COMP7 |
- |-------|-------|-------|-------|-------|-------|-------|
- | PA0 | PA2 | PB1 | PC8 | PC7 | PA10U | PC2 |
- | PF4 | PA7 | --- | PA8 | PA9 | PC6 | --- |
- | PA6 | PA12U | --- | --- | --- | --- | --- |
- | PA11U | PB9 | --- | --- | --- | --- | --- |
- | PB8 | --- | --- | --- | --- | --- | --- |
- +-------------------------------------------------------+
- Table 3. COMP Outputs redirection to embedded timers for the STM32F303xB/STM32F303xC devices
- +----------------------------------------------------------------------------------------------------------------------+
- | COMP1 | COMP2 | COMP3 | COMP4 | COMP5 | COMP6 | COMP7 |
- |----------------|----------------|----------------|----------------|----------------|----------------|----------------|
- | TIM1 BKIN | TIM1 BKIN | TIM1 BKIN | TIM1 BKIN | TIM1 BKIN | TIM1 BKIN | TIM1 BKIN |
- | | | | | | | |
- | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 |
- | | | | | | | |
- | TIM8 BKIN | TIM8 BKIN | TIM8 BKIN | TIM8 BKIN | TIM8 BKIN | TIM8 BKIN | TIM8 BKIN |
- | | | | | | | |
- | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 |
- | | | | | | | |
- | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 |
- | + | + | + | + | + | + | + |
- | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 |
- | | | | | | | |
- | TIM1 OCREFCLR | TIM1 OCREFCLR | TIM1 OCREFCLR | TIM8 OCREFCLR | TIM8 OCREFCLR | TIM8 OCREFCLR | TIM1 OCREFCLR |
- | | | | | | | |
- | TIM1 IC1 | TIM1 IC1 | TIM2 OCREFCLR | TIM3 IC3 | TIM2 IC1 | TIM2 IC2 | TIM8 OCREFCLR |
- | | | | | | | |
- | TIM2 IC4 | TIM2 IC4 | TIM3 IC2 | TIM3 OCREFCLR | TIM3 OCREFCLR | TIM2 OCREFCLR | TIM2 IC3 |
- | | | | | | | |
- | TIM2 OCREFCLR | TIM2 OCREFCLR | TIM4 IC1 | TIM4 IC2 | TIM4 IC3 | TIM16 OCREFCLR| TIM1 IC2 |
- | | | | | | | |
- | TIM3 IC1 | TIM3 IC1 | TIM15 IC1 | TIM15 OCREFCLR| TIM16 BKIN | TIM16 IC1 | TIM17 OCREFCLR|
- | | | | | | | |
- | TIM3 OCREFCLR | TIM3 OCREFCLR | TIM15 BKIN | TIM15 IC2 | TIM17 IC1 | TIM4 IC4 | TIM17 BKIN |
- +----------------------------------------------------------------------------------------------------------------------+
- Table 4. COMP Outputs redirection to embedded timers for the STM32F303xE devices
- +----------------------------------------------------------------------------------------------------------------------+
- | COMP1 | COMP2 | COMP3 | COMP4 | COMP5 | COMP6 | COMP7 |
- |----------------|----------------|----------------|----------------|----------------|----------------|----------------|
- | TIM1 BKIN | TIM1 BKIN | TIM1 BKIN | TIM1 BKIN (1U) | TIM1 BKIN | TIM1 BKIN | TIM1 BKIN (1U) |
- | | | | | | | |
- | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 |
- | | | | | | | |
- | TIM8 BKIN | TIM8 BKIN | TIM8 BKIN | TIM8 BKIN (1U) | TIM8 BKIN | TIM8 BKIN | TIM8 BKIN (1U) |
- | | | | | | | |
- | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 |
- | | | | | | | |
- | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 |
- | + | + | + | + | + | + | + |
- | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 | TIM8BKIN2 |
- | | | | | | | |
- | TIM1 OCREFCLR | TIM1 OCREFCLR | TIM1 OCREFCLR | TIM8 OCREFCLR | TIM8 OCREFCLR | TIM8 OCREFCLR | TIM1 OCREFCLR |
- | | | | | | | |
- | TIM1 IC1 | TIM1 IC1 | TIM2 OCREFCLR | TIM3 IC3 | TIM2 IC1 | TIM2 IC2 | TIM8 OCREFCLR |
- | | | | | | | |
- | TIM2 IC4 | TIM2 IC4 | TIM3 IC2 | TIM3 OCREFCLR | TIM3 OCREFCLR | TIM2 OCREFCLR | TIM2 IC3 |
- | | | | | | | |
- | TIM2 OCREFCLR | TIM2 OCREFCLR | TIM4 IC1 | TIM4 IC2 | TIM4 IC3 | TIM16 OCREFCLR| TIM1 IC2 |
- | | | | | | | |
- | TIM3 IC1 | TIM3 IC1 | TIM15 IC1 | TIM15 OCREFCLR| TIM16 BKIN | TIM16 IC1 | TIM17 OCREFCLR|
- | | | | | | | |
- | TIM3 OCREFCLR | TIM3 OCREFCLR | TIM15 BKIN | TIM15 IC2 | TIM17 IC1 | TIM4 IC4 | TIM17 BKIN |
- | | | | | | | |
- | TIM20 BKIN | TIM20 BKIN | TIM20 BKIN | TIM20 BKIN (1U)| TIM20 BKIN | TIM20 BKIN | TIM20 BKIN (1U)|
- | | | | | | | |
- | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 |
- | | | | | | | |
- | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 | TIM1 BKIN2 |
- | + | + | + | + | + | + | + |
- | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 | TIM8 BKIN2 |
- | + | + | + | + | + | + | + |
- | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 | TIM20 BKIN2 |
- | | | | | | | |
- +----------------------------------------------------------------------------------------------------------------------+
- (1U): This connection consists of connecting both GPIO and COMP output to TIM1/8U/20 BRK input through an OR gate, instead
- of connecting the GPIO to the TIM1/8U/20 BRK input and the COMP output to the TIM1/8U/20 BRK_ACTH input. The aim is to
- add a digital filter (3 bits) on the COMP output.
- Table 5. COMP Outputs blanking sources for the STM32F303xB/STM32F303xC/STM32F303xE devices
- +----------------------------------------------------------------------------------------------------------------------+
- | COMP1 | COMP2 | COMP3 | COMP4 | COMP5 | COMP6 | COMP7 |
- |----------------|----------------|----------------|----------------|----------------|----------------|----------------|
- | TIM1 OC5 | TIM1 OC5 | TIM1 OC5 | TIM3 OC4 | -------- | TIM8 OC5 | TIM1 OC5 |
- | | | | | | | |
- | TIM2 OC3 | TIM2 OC3 | -------- | TIM8 OC5 | TIM3 OC3 | TIM2 OC4 | TIM8 OC5 |
- | | | | | | | |
- | TIM3 OC3 | TIM3 OC3 | TIM2 OC4 | TIM15 OC1 | TIM8 OC5 | TIM15 OC2 | TIM15 OC2 |
- | | | | | | | |
- +----------------------------------------------------------------------------------------------------------------------+
- */
- /* Includes ------------------------------------------------------------------*/
- #include "stm32f3xx_hal.h"
- /** @addtogroup STM32F3xx_HAL_Driver
- * @{
- */
- /** @defgroup COMP COMP
- * @brief COMP HAL module driver
- * @{
- */
- #ifdef HAL_COMP_MODULE_ENABLED
- /* Private typedef -----------------------------------------------------------*/
- /* Private define ------------------------------------------------------------*/
- /** @defgroup COMP_Private_Constants COMP Private Constants
- * @{
- */
- #define COMP_LOCK_DISABLE (0x00000000U)
- #define COMP_LOCK_ENABLE COMP_CSR_COMPxLOCK
- /* Delay for COMP startup time. */
- /* Note: Delay required to reach propagation delay specification. */
- /* Literal set to maximum value (refer to device datasheet, */
- /* parameter "tSTART"). */
- /* Unit: us */
- #define COMP_DELAY_STARTUP_US (80UL) /*!< Delay for COMP startup time */
- /* Delay for COMP voltage scaler stabilization time. */
- /* Literal set to maximum value (refer to device datasheet, */
- /* parameter "tSTART_SCALER"). */
- /* Unit: us */
- #define COMP_DELAY_VOLTAGE_SCALER_STAB_US (200UL) /*!< Delay for COMP voltage scaler stabilization time */
- /**
- * @}
- */
- /* Private macro -------------------------------------------------------------*/
- /* Private variables ---------------------------------------------------------*/
- /* Private function prototypes -----------------------------------------------*/
- /* Exported functions --------------------------------------------------------*/
- /** @defgroup COMP_Exported_Functions COMP Exported Functions
- * @{
- */
- /** @defgroup COMP_Exported_Functions_Group1 Initialization/de-initialization functions
- * @brief Initialization and de-initialization functions.
- *
- @verbatim
- ===============================================================================
- ##### Initialization and de-initialization functions #####
- ===============================================================================
- [..] This section provides functions to initialize and de-initialize comparators.
- @endverbatim
- * @{
- */
- /**
- * @brief Initialize the COMP peripheral according to the specified
- * parameters in the COMP_InitTypeDef and initialize the associated handle.
- * @note If the selected comparator is locked, initialization cannot be performed.
- * To unlock the configuration, perform a system reset.
- * @param hcomp COMP handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_COMP_Init(COMP_HandleTypeDef *hcomp)
- {
- uint32_t comp_voltage_scaler_initialized; /* Value "0" if comparator voltage scaler is not initialized */
- __IO uint32_t wait_loop_index = 0UL;
- HAL_StatusTypeDef status = HAL_OK;
- /* Check the COMP handle allocation and lock status */
- if ((hcomp == NULL) || ((hcomp->State & COMP_STATE_BIT_LOCK) != RESET))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameters */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- assert_param(IS_COMP_INVERTINGINPUT(hcomp->Init.InvertingInput));
- assert_param(IS_COMP_NONINVERTINGINPUT(hcomp->Init.NonInvertingInput));
- assert_param(IS_COMP_NONINVERTINGINPUT_INSTANCE(hcomp->Instance, hcomp->Init.NonInvertingInput));
- assert_param(IS_COMP_OUTPUT(hcomp->Init.Output));
- assert_param(IS_COMP_OUTPUT_INSTANCE(hcomp->Instance, hcomp->Init.Output));
- assert_param(IS_COMP_OUTPUTPOL(hcomp->Init.OutputPol));
- assert_param(IS_COMP_HYSTERESIS(hcomp->Init.Hysteresis));
- assert_param(IS_COMP_MODE(hcomp->Init.Mode));
- assert_param(IS_COMP_BLANKINGSRCE(hcomp->Init.BlankingSrce));
- assert_param(IS_COMP_BLANKINGSRCE_INSTANCE(hcomp->Instance, hcomp->Init.BlankingSrce));
- assert_param(IS_COMP_TRIGGERMODE(hcomp->Init.TriggerMode));
- if (hcomp->Init.WindowMode != COMP_WINDOWMODE_DISABLE)
- {
- assert_param(IS_COMP_WINDOWMODE_INSTANCE(hcomp->Instance));
- assert_param(IS_COMP_WINDOWMODE(hcomp->Init.WindowMode));
- }
- /* Init SYSCFG and the low level hardware to access comparators */
- __HAL_RCC_SYSCFG_CLK_ENABLE();
- #if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
- /* Init the COMP Callback settings */
- hcomp->TriggerCallback = HAL_COMP_TriggerCallback; /* Legacy weak callback */
- if (hcomp->MspInitCallback == NULL)
- {
- hcomp->MspInitCallback = HAL_COMP_MspInit; /* Legacy weak MspInit */
- }
-
- /* Init the low level hardware */
- hcomp->MspInitCallback(hcomp);
- #else
- /* Init the low level hardware : SYSCFG to access comparators */
- HAL_COMP_MspInit(hcomp);
- #endif /* USE_HAL_COMP_REGISTER_CALLBACKS */
- /* Memorize voltage scaler state before initialization */
- comp_voltage_scaler_initialized = READ_BIT(hcomp->Instance->CSR, (COMP_CSR_COMPxINSEL_1 | COMP_CSR_COMPxINSEL_0));
- if (hcomp->State == HAL_COMP_STATE_RESET)
- {
- /* Allocate lock resource and initialize it */
- hcomp->Lock = HAL_UNLOCKED;
- }
- /* Manage inverting input comparator inverting input connected to a GPIO */
- /* for STM32F302x, STM32F32xx, STM32F33x. */
- hcomp->Init.InvertingInput = COMP_INVERTINGINPUT_SELECTION(hcomp->Instance, hcomp->Init.InvertingInput);
- /* Set COMP parameters */
- /* Set COMPxINSEL bits according to hcomp->Init.InvertingInput value */
- /* Set COMPxNONINSEL bits according to hcomp->Init.NonInvertingInput value */
- /* Set COMPxBLANKING bits according to hcomp->Init.BlankingSrce value */
- /* Set COMPxOUTSEL bits according to hcomp->Init.Output value */
- /* Set COMPxPOL bit according to hcomp->Init.OutputPol value */
- /* Set COMPxHYST bits according to hcomp->Init.Hysteresis value */
- /* Set COMPxMODE bits according to hcomp->Init.Mode value */
- COMP_INIT(hcomp);
- /* Delay for COMP scaler bridge voltage stabilization */
- /* Apply the delay if voltage scaler bridge is required and not already enabled */
- if ((READ_BIT(hcomp->Instance->CSR, (COMP_CSR_COMPxINSEL_1 | COMP_CSR_COMPxINSEL_0)) != 0UL) &&
- (comp_voltage_scaler_initialized == 0UL))
- {
- /* Wait loop initialization and execution */
- /* Note: Variable divided by 2 to compensate partially */
- /* CPU processing cycles, scaling in us split to not */
- /* exceed 32 bits register capacity and handle low frequency. */
- wait_loop_index = ((COMP_DELAY_VOLTAGE_SCALER_STAB_US / 10UL) * ((SystemCoreClock / (100000UL * 2UL)) + 1UL));
- while (wait_loop_index != 0UL)
- {
- wait_loop_index--;
- }
- }
- /* Initialize the COMP state*/
- hcomp->State = HAL_COMP_STATE_READY;
- }
- return status;
- }
- /**
- * @brief DeInitialize the COMP peripheral.
- * @note If the selected comparator is locked, deinitialization cannot be performed.
- * To unlock the configuration, perform a system reset.
- * @param hcomp COMP handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_COMP_DeInit(COMP_HandleTypeDef *hcomp)
- {
- HAL_StatusTypeDef status = HAL_OK;
- /* Check the COMP handle allocation and lock status */
- if ((hcomp == NULL) || ((hcomp->State & COMP_STATE_BIT_LOCK) != RESET))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- /* Set COMP_CSR register to reset value */
- COMP_DEINIT(hcomp);
- #if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
- if (hcomp->MspDeInitCallback == NULL)
- {
- hcomp->MspDeInitCallback = HAL_COMP_MspDeInit; /* Legacy weak MspDeInit */
- }
-
- /* DeInit the low level hardware: SYSCFG, GPIO, CLOCK and NVIC */
- hcomp->MspDeInitCallback(hcomp);
- #else
- /* DeInit the low level hardware: SYSCFG, GPIO, CLOCK and NVIC */
- HAL_COMP_MspDeInit(hcomp);
- #endif /* USE_HAL_COMP_REGISTER_CALLBACKS */
- hcomp->State = HAL_COMP_STATE_RESET;
- /* Release Lock */
- __HAL_UNLOCK(hcomp);
- }
- return status;
- }
- /**
- * @brief Initialize the COMP MSP.
- * @param hcomp COMP handle
- * @retval None
- */
- __weak void HAL_COMP_MspInit(COMP_HandleTypeDef *hcomp)
- {
- /* Prevent unused argument(s) compilation warning */
- UNUSED(hcomp);
- /* NOTE : This function should not be modified, when the callback is needed,
- the HAL_COMP_MspInit could be implemented in the user file
- */
- }
- /**
- * @brief DeInitialize the COMP MSP.
- * @param hcomp COMP handle
- * @retval None
- */
- __weak void HAL_COMP_MspDeInit(COMP_HandleTypeDef *hcomp)
- {
- /* Prevent unused argument(s) compilation warning */
- UNUSED(hcomp);
- /* NOTE : This function should not be modified, when the callback is needed,
- the HAL_COMP_MspDeInit could be implemented in the user file
- */
- }
- #if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
- /**
- * @brief Register a User COMP Callback
- * To be used instead of the weak predefined callback
- * @param hcomp Pointer to a COMP_HandleTypeDef structure that contains
- * the configuration information for the specified COMP.
- * @param CallbackID ID of the callback to be registered
- * This parameter can be one of the following values:
- * @arg @ref HAL_COMP_TRIGGER_CB_ID Trigger callback ID
- * @arg @ref HAL_COMP_MSPINIT_CB_ID MspInit callback ID
- * @arg @ref HAL_COMP_MSPDEINIT_CB_ID MspDeInit callback ID
- * @param pCallback pointer to the Callback function
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_COMP_RegisterCallback(COMP_HandleTypeDef *hcomp, HAL_COMP_CallbackIDTypeDef CallbackID, pCOMP_CallbackTypeDef pCallback)
- {
- HAL_StatusTypeDef status = HAL_OK;
-
- if (pCallback == NULL)
- {
- /* Update the error code */
- hcomp->ErrorCode |= HAL_COMP_ERROR_INVALID_CALLBACK;
- return HAL_ERROR;
- }
-
- if (HAL_COMP_STATE_READY == hcomp->State)
- {
- switch (CallbackID)
- {
- case HAL_COMP_TRIGGER_CB_ID :
- hcomp->TriggerCallback = pCallback;
- break;
-
- case HAL_COMP_MSPINIT_CB_ID :
- hcomp->MspInitCallback = pCallback;
- break;
-
- case HAL_COMP_MSPDEINIT_CB_ID :
- hcomp->MspDeInitCallback = pCallback;
- break;
-
- default :
- /* Update the error code */
- hcomp->ErrorCode |= HAL_COMP_ERROR_INVALID_CALLBACK;
-
- /* Return error status */
- status = HAL_ERROR;
- break;
- }
- }
- else if (HAL_COMP_STATE_RESET == hcomp->State)
- {
- switch (CallbackID)
- {
- case HAL_COMP_MSPINIT_CB_ID :
- hcomp->MspInitCallback = pCallback;
- break;
-
- case HAL_COMP_MSPDEINIT_CB_ID :
- hcomp->MspDeInitCallback = pCallback;
- break;
-
- default :
- /* Update the error code */
- hcomp->ErrorCode |= HAL_COMP_ERROR_INVALID_CALLBACK;
-
- /* Return error status */
- status = HAL_ERROR;
- break;
- }
- }
- else
- {
- /* Update the error code */
- hcomp->ErrorCode |= HAL_COMP_ERROR_INVALID_CALLBACK;
-
- /* Return error status */
- status = HAL_ERROR;
- }
-
- return status;
- }
- /**
- * @brief Unregister a COMP Callback
- * COMP callback is redirected to the weak predefined callback
- * @param hcomp Pointer to a COMP_HandleTypeDef structure that contains
- * the configuration information for the specified COMP.
- * @param CallbackID ID of the callback to be unregistered
- * This parameter can be one of the following values:
- * @arg @ref HAL_COMP_TRIGGER_CB_ID Trigger callback ID
- * @arg @ref HAL_COMP_MSPINIT_CB_ID MspInit callback ID
- * @arg @ref HAL_COMP_MSPDEINIT_CB_ID MspDeInit callback ID
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_COMP_UnRegisterCallback(COMP_HandleTypeDef *hcomp, HAL_COMP_CallbackIDTypeDef CallbackID)
- {
- HAL_StatusTypeDef status = HAL_OK;
- if (HAL_COMP_STATE_READY == hcomp->State)
- {
- switch (CallbackID)
- {
- case HAL_COMP_TRIGGER_CB_ID :
- hcomp->TriggerCallback = HAL_COMP_TriggerCallback; /* Legacy weak callback */
- break;
-
- case HAL_COMP_MSPINIT_CB_ID :
- hcomp->MspInitCallback = HAL_COMP_MspInit; /* Legacy weak MspInit */
- break;
- case HAL_COMP_MSPDEINIT_CB_ID :
- hcomp->MspDeInitCallback = HAL_COMP_MspDeInit; /* Legacy weak MspDeInit */
- break;
- default :
- /* Update the error code */
- hcomp->ErrorCode |= HAL_COMP_ERROR_INVALID_CALLBACK;
- /* Return error status */
- status = HAL_ERROR;
- break;
- }
- }
- else if (HAL_COMP_STATE_RESET == hcomp->State)
- {
- switch (CallbackID)
- {
- case HAL_COMP_MSPINIT_CB_ID :
- hcomp->MspInitCallback = HAL_COMP_MspInit; /* Legacy weak MspInit */
- break;
- case HAL_COMP_MSPDEINIT_CB_ID :
- hcomp->MspDeInitCallback = HAL_COMP_MspDeInit; /* Legacy weak MspDeInit */
- break;
- default :
- /* Update the error code */
- hcomp->ErrorCode |= HAL_COMP_ERROR_INVALID_CALLBACK;
- /* Return error status */
- status = HAL_ERROR;
- break;
- }
- }
- else
- {
- /* Update the error code */
- hcomp->ErrorCode |= HAL_COMP_ERROR_INVALID_CALLBACK;
- /* Return error status */
- status = HAL_ERROR;
- }
- return status;
- }
- #endif /* USE_HAL_COMP_REGISTER_CALLBACKS */
- /**
- * @}
- */
- /** @defgroup COMP_Exported_Functions_Group2 Start Stop operation functions
- * @brief Start-Stop operation functions.
- *
- @verbatim
- ===============================================================================
- ##### Start Stop operation functions #####
- ===============================================================================
- [..] This section provides functions allowing to:
- (+) Start a comparator without interrupt generation.
- (+) Stop a comparator without interrupt generation.
- (+) Start a comparator with interrupt generation.
- (+) Stop a comparator with interrupt generation.
- (+) Handle interrupts from a comparator with associated callback function.
- @endverbatim
- * @{
- */
- /**
- * @brief Start the comparator.
- * @param hcomp COMP handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_COMP_Start(COMP_HandleTypeDef *hcomp)
- {
- __IO uint32_t wait_loop_index = 0UL;
- HAL_StatusTypeDef status = HAL_OK;
- uint32_t extiline = 0U;
- /* Check the COMP handle allocation and lock status */
- if ((hcomp == NULL) || ((hcomp->State & COMP_STATE_BIT_LOCK) != RESET))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- if (hcomp->State == HAL_COMP_STATE_READY)
- {
- /* Get the EXTI Line output configuration */
- extiline = COMP_GET_EXTI_LINE(hcomp->Instance);
- /* Configure the event generation */
- if ((hcomp->Init.TriggerMode & (COMP_TRIGGERMODE_EVENT_RISING | COMP_TRIGGERMODE_EVENT_FALLING)) != RESET)
- {
- /* Configure the event trigger rising edge */
- if ((hcomp->Init.TriggerMode & COMP_TRIGGERMODE_EVENT_RISING) != RESET)
- {
- COMP_EXTI_RISING_ENABLE(extiline);
- }
- else
- {
- COMP_EXTI_RISING_DISABLE(extiline);
- }
- /* Configure the trigger falling edge */
- if ((hcomp->Init.TriggerMode & COMP_TRIGGERMODE_EVENT_FALLING) != RESET)
- {
- COMP_EXTI_FALLING_ENABLE(extiline);
- }
- else
- {
- COMP_EXTI_FALLING_DISABLE(extiline);
- }
- /* Enable EXTI event generation */
- COMP_EXTI_ENABLE_EVENT(extiline);
- /* Clear COMP EXTI pending bit */
- COMP_EXTI_CLEAR_FLAG(extiline);
- }
- /* Enable the selected comparator */
- __HAL_COMP_ENABLE(hcomp);
- hcomp->State = HAL_COMP_STATE_BUSY;
- /* Delay for COMP startup time */
- /* Wait loop initialization and execution */
- /* Note: Variable divided by 2 to compensate partially */
- /* CPU processing cycles, scaling in us split to not */
- /* exceed 32 bits register capacity and handle low frequency. */
- wait_loop_index = ((COMP_DELAY_STARTUP_US / 10UL) * ((SystemCoreClock / (100000UL * 2UL)) + 1UL));
- while (wait_loop_index != 0UL)
- {
- wait_loop_index--;
- }
- }
- else
- {
- status = HAL_ERROR;
- }
- }
- return status;
- }
- /**
- * @brief Stop the comparator.
- * @param hcomp COMP handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_COMP_Stop(COMP_HandleTypeDef *hcomp)
- {
- HAL_StatusTypeDef status = HAL_OK;
- /* Check the COMP handle allocation and lock status */
- if ((hcomp == NULL) || ((hcomp->State & COMP_STATE_BIT_LOCK) != RESET))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- if (hcomp->State == HAL_COMP_STATE_BUSY)
- {
- /* Disable the EXTI Line event mode if any */
- COMP_EXTI_DISABLE_EVENT(COMP_GET_EXTI_LINE(hcomp->Instance));
- /* Disable the selected comparator */
- __HAL_COMP_DISABLE(hcomp);
- hcomp->State = HAL_COMP_STATE_READY;
- }
- else
- {
- status = HAL_ERROR;
- }
- }
- return status;
- }
- /**
- * @brief Start the comparator in Interrupt mode.
- * @param hcomp COMP handle
- * @retval HAL status.
- */
- HAL_StatusTypeDef HAL_COMP_Start_IT(COMP_HandleTypeDef *hcomp)
- {
- HAL_StatusTypeDef status = HAL_OK;
- uint32_t extiline = 0U;
- /* Check the COMP handle allocation and lock status */
- if ((hcomp == NULL) || ((hcomp->State & COMP_STATE_BIT_LOCK) != RESET))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- if (hcomp->State == HAL_COMP_STATE_READY)
- {
- /* Configure the EXTI event generation */
- if ((hcomp->Init.TriggerMode & (COMP_TRIGGERMODE_IT_RISING | COMP_TRIGGERMODE_IT_FALLING)) != RESET)
- {
- /* Get the EXTI Line output configuration */
- extiline = COMP_GET_EXTI_LINE(hcomp->Instance);
- /* Configure the trigger rising edge */
- if ((hcomp->Init.TriggerMode & COMP_TRIGGERMODE_IT_RISING) != RESET)
- {
- COMP_EXTI_RISING_ENABLE(extiline);
- }
- else
- {
- COMP_EXTI_RISING_DISABLE(extiline);
- }
- /* Configure the trigger falling edge */
- if ((hcomp->Init.TriggerMode & COMP_TRIGGERMODE_IT_FALLING) != RESET)
- {
- COMP_EXTI_FALLING_ENABLE(extiline);
- }
- else
- {
- COMP_EXTI_FALLING_DISABLE(extiline);
- }
- /* Clear COMP EXTI pending bit if any */
- COMP_EXTI_CLEAR_FLAG(extiline);
- /* Enable EXTI interrupt mode */
- COMP_EXTI_ENABLE_IT(extiline);
- /* Enable the selected comparator */
- __HAL_COMP_ENABLE(hcomp);
- hcomp->State = HAL_COMP_STATE_BUSY;
- }
- else
- {
- status = HAL_ERROR;
- }
- }
- else
- {
- status = HAL_ERROR;
- }
- }
- return status;
- }
- /**
- * @brief Stop the comparator in Interrupt mode.
- * @param hcomp COMP handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_COMP_Stop_IT(COMP_HandleTypeDef *hcomp)
- {
- HAL_StatusTypeDef status = HAL_OK;
- /* Disable the EXTI Line interrupt mode */
- COMP_EXTI_DISABLE_IT(COMP_GET_EXTI_LINE(hcomp->Instance));
- status = HAL_COMP_Stop(hcomp);
- return status;
- }
- /**
- * @brief Comparator IRQ Handler.
- * @param hcomp COMP handle
- * @retval HAL status
- */
- void HAL_COMP_IRQHandler(COMP_HandleTypeDef *hcomp)
- {
- uint32_t extiline = COMP_GET_EXTI_LINE(hcomp->Instance);
- /* Check COMP EXTI flag */
- if (COMP_EXTI_GET_FLAG(extiline) != RESET)
- {
- /* Clear COMP EXTI pending bit */
- COMP_EXTI_CLEAR_FLAG(extiline);
- /* COMP trigger callback */
- #if (USE_HAL_COMP_REGISTER_CALLBACKS == 1)
- hcomp->TriggerCallback(hcomp);
- #else
- HAL_COMP_TriggerCallback(hcomp);
- #endif /* USE_HAL_COMP_REGISTER_CALLBACKS */
- }
- }
- /**
- * @brief Comparator trigger callback.
- * @param hcomp COMP handle
- * @retval None
- */
- __weak void HAL_COMP_TriggerCallback(COMP_HandleTypeDef *hcomp)
- {
- /* Prevent unused argument(s) compilation warning */
- UNUSED(hcomp);
- /* NOTE : This function should not be modified, when the callback is needed,
- the HAL_COMP_TriggerCallback should be implemented in the user file
- */
- }
- /**
- * @}
- */
- /** @defgroup COMP_Exported_Functions_Group3 Peripheral Control functions
- * @brief Management functions.
- *
- @verbatim
- ===============================================================================
- ##### Peripheral Control functions #####
- ===============================================================================
- [..]
- This subsection provides a set of functions allowing to control the comparators.
- @endverbatim
- * @{
- */
- /**
- * @brief Lock the selected comparator configuration.
- * @note A system reset is required to unlock the comparator configuration.
- * @param hcomp COMP handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_COMP_Lock(COMP_HandleTypeDef *hcomp)
- {
- HAL_StatusTypeDef status = HAL_OK;
- /* Check the COMP handle allocation and lock status */
- if ((hcomp == NULL) || ((hcomp->State & COMP_STATE_BIT_LOCK) != RESET))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- /* Set lock flag on state */
- switch (hcomp->State)
- {
- case HAL_COMP_STATE_BUSY:
- hcomp->State = HAL_COMP_STATE_BUSY_LOCKED;
- break;
- case HAL_COMP_STATE_READY:
- hcomp->State = HAL_COMP_STATE_READY_LOCKED;
- break;
- default:
- /* unexpected state */
- status = HAL_ERROR;
- break;
- }
- }
- if (status == HAL_OK)
- {
- /* Set the lock bit corresponding to selected comparator */
- __HAL_COMP_LOCK(hcomp);
- }
- return status;
- }
- /**
- * @brief Return the output level (high or low) of the selected comparator.
- * The output level depends on the selected polarity.
- * If the polarity is not inverted:
- * - Comparator output is low when the non-inverting input is at a lower
- * voltage than the inverting input
- * - Comparator output is high when the non-inverting input is at a higher
- * voltage than the inverting input
- * If the polarity is inverted:
- * - Comparator output is high when the non-inverting input is at a lower
- * voltage than the inverting input
- * - Comparator output is low when the non-inverting input is at a higher
- * voltage than the inverting input
- * @param hcomp COMP handle
- * @retval Returns the selected comparator output level:
- * @arg @ref COMP_OUTPUTLEVEL_LOW
- * @arg @ref COMP_OUTPUTLEVEL_HIGH
- *
- */
- uint32_t HAL_COMP_GetOutputLevel(COMP_HandleTypeDef *hcomp)
- {
- uint32_t level = 0U;
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- level = READ_BIT(hcomp->Instance->CSR, COMP_CSR_COMPxOUT);
- if (level != 0U)
- {
- return (COMP_OUTPUTLEVEL_HIGH);
- }
- return (COMP_OUTPUTLEVEL_LOW);
- }
- /**
- * @}
- */
- /** @defgroup COMP_Exported_Functions_Group4 Peripheral State functions
- * @brief Peripheral State functions.
- *
- @verbatim
- ===============================================================================
- ##### Peripheral State functions #####
- ===============================================================================
- [..]
- This subsection permits to get in run-time the status of the peripheral.
- @endverbatim
- * @{
- */
- /**
- * @brief Return the COMP handle state.
- * @param hcomp COMP handle
- * @retval HAL state
- */
- HAL_COMP_StateTypeDef HAL_COMP_GetState(COMP_HandleTypeDef *hcomp)
- {
- /* Check the COMP handle allocation */
- if (hcomp == NULL)
- {
- return HAL_COMP_STATE_RESET;
- }
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- /* Return COMP handle state */
- return hcomp->State;
- }
- /**
- * @brief Return the COMP error code.
- * @param hcomp COMP handle
- * @retval COMP error code
- */
- uint32_t HAL_COMP_GetError(COMP_HandleTypeDef *hcomp)
- {
- /* Check the parameters */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
-
- return hcomp->ErrorCode;
- }
- /**
- * @}
- */
- /**
- * @}
- */
- #endif /* HAL_COMP_MODULE_ENABLED */
- /**
- * @}
- */
- /**
- * @}
- */
|