123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755 |
- /**
- ******************************************************************************
- * @file stm32l4xx_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
- * + Start/Stop operation functions in polling mode
- * + Start/Stop operation functions in interrupt mode (through EXTI interrupt)
- * + Peripheral control functions
- * + Peripheral state functions
- *
- @verbatim
- ================================================================================
- ##### COMP Peripheral features #####
- ================================================================================
- [..]
- The STM32L4xx device family integrates two analog comparators instances:
- COMP1, COMP2.
- (#) Comparators input minus (inverting input) and input plus (non inverting input)
- can be set to internal references or to GPIO pins
- (refer to GPIO list in reference manual).
-
- (#) Comparators output level is available using HAL_COMP_GetOutputLevel()
- and can be redirected to other peripherals: GPIO pins (in mode
- alternate functions for comparator), timers.
- (refer to GPIO list in reference manual).
-
- (#) The comparators have interrupt capability through the EXTI controller
- with wake-up from sleep and stop modes.
-
- (#) Pairs of comparators instances can be combined in window mode
- (2 consecutive instances odd and even COMP<x> and COMP<x+1>).
-
- From the corresponding IRQ handler, the right interrupt source can be retrieved
- using macro __HAL_COMP_COMPx_EXTI_GET_FLAG().
- ##### How to use this driver #####
- ================================================================================
- [..]
- This driver provides functions to configure and program the comparator instances
- of STM32L4xx devices.
-
- To use the comparator, perform the following steps:
-
- (#) Initialize the COMP low level resources by implementing the HAL_COMP_MspInit():
- (++) Configure the GPIO connected to comparator inputs plus and minus in analog mode
- using HAL_GPIO_Init().
- (++) If needed, configure the GPIO connected to comparator output in alternate function mode
- using HAL_GPIO_Init().
- (++) If required enable the COMP 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_EnableIRQ() function.
-
- (#) Configure the comparator using HAL_COMP_Init() function:
- (++) Select the input minus (inverting input)
- (++) Select the input plus (non-inverting input)
- (++) Select the hysteresis
- (++) Select the blanking source
- (++) Select the output polarity
- (++) Select the power mode
- (++) Select the window mode
-
- -@@- HAL_COMP_Init() calls internally __HAL_RCC_SYSCFG_CLK_ENABLE()
- to enable internal control clock of the comparators.
- However, this is a legacy strategy. In future STM32 families,
- COMP clock enable must be implemented by user in "HAL_COMP_MspInit()".
- Therefore, for compatibility anticipation, it is recommended to
- implement __HAL_RCC_SYSCFG_CLK_ENABLE() in "HAL_COMP_MspInit()".
-
- (#) Reconfiguration on-the-fly of comparator can be done by calling again
- function HAL_COMP_Init() with new input structure parameters values.
-
- (#) Enable the comparator using HAL_COMP_Start() function.
-
- (#) Use HAL_COMP_TriggerCallback() or HAL_COMP_GetOutputLevel() functions
- to manage comparator outputs (events and output level).
-
- (#) Disable the comparator using HAL_COMP_Stop() function.
-
- (#) De-initialize the comparator using HAL_COMP_DeInit() function.
-
- (#) For safety purpose, comparator configuration can be locked using HAL_COMP_Lock() function.
- The only way to unlock the comparator is a device hardware reset.
-
- @endverbatim
- ******************************************************************************
- Table 1. COMP inputs and output for STM32L4xx devices
- +---------------------------------------------------------+
- | | | COMP1 | COMP2 |
- |----------------|----------------|-----------|-----------|
- | | IO1 | PC5 | PB4 |
- | Input plus | IO2 | PB2 | PB6 |
- | | IO3 (3) | PA1 | PA3 |
- |----------------|----------------|-----------------------|
- | | 1/4 VrefInt | Available | Available |
- | | 1/2 VrefInt | Available | Available |
- | | 3/4 VrefInt | Available | Available |
- | Input minus | VrefInt | Available | Available |
- | | DAC1 channel 1 | Available | Available |
- | | DAC1 channel 2 | Available | Available |
- | | IO1 | PB1 | PB3 |
- | | IO2 | PC4 | PB7 |
- | | IO3 (3) | PA0 | PA2 |
- | | IO4 (3) | PA4 | PA4 |
- | | IO5 (3) | PA5 | PA5 |
- +---------------------------------------------------------+
- | Output | | PB0 (1) | PB5 (1) |
- | | | PB10 (1) | PB11 (1) |
- | | | TIM (2) | TIM (2) |
- +---------------------------------------------------------+
- (1) GPIO must be set to alternate function for comparator
- (2) Comparators output to timers is set in timers instances.
- (3) Only STM32L43x/L44x
- ******************************************************************************
- * @attention
- *
- * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- * 3. Neither the name of STMicroelectronics nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- ******************************************************************************
- */
- /* Includes ------------------------------------------------------------------*/
- #include "stm32l4xx_hal.h"
- #ifdef HAL_COMP_MODULE_ENABLED
- #if defined (COMP1) || defined (COMP2)
- /** @addtogroup STM32L4xx_HAL_Driver
- * @{
- */
- /** @defgroup COMP COMP
- * @brief COMP HAL module driver
- * @{
- */
- /* Private typedef -----------------------------------------------------------*/
- /* Private define ------------------------------------------------------------*/
- /** @addtogroup COMP_Private_Constants
- * @{
- */
- /* 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 (80U) /*!< 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 (200U) /*!< Delay for COMP voltage scaler stabilization time */
- #define COMP_OUTPUT_LEVEL_BITOFFSET_POS (30U)
- /**
- * @}
- */
- /* 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 according to the specified
- * parameters in the COMP_InitTypeDef and initialize the associated handle.
- * @note If the selected comparator is locked, initialization can't 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 tmp_csr = 0U;
- uint32_t exti_line = 0U;
- uint32_t comp_voltage_scaler_not_initialized = 0U;
- __IO uint32_t wait_loop_index = 0U;
- HAL_StatusTypeDef status = HAL_OK;
-
- /* Check the COMP handle allocation and lock status */
- if((hcomp == NULL) || (__HAL_COMP_IS_LOCKED(hcomp)))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameters */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- assert_param(IS_COMP_INPUT_PLUS(hcomp->Instance, hcomp->Init.NonInvertingInput));
- assert_param(IS_COMP_INPUT_MINUS(hcomp->Instance, hcomp->Init.InvertingInput));
- assert_param(IS_COMP_OUTPUTPOL(hcomp->Init.OutputPol));
- assert_param(IS_COMP_POWERMODE(hcomp->Init.Mode));
- assert_param(IS_COMP_HYSTERESIS(hcomp->Init.Hysteresis));
- assert_param(IS_COMP_BLANKINGSRC_INSTANCE(hcomp->Instance, hcomp->Init.BlankingSrce));
- assert_param(IS_COMP_TRIGGERMODE(hcomp->Init.TriggerMode));
- assert_param(IS_COMP_WINDOWMODE(hcomp->Init.WindowMode));
-
- if(hcomp->State == HAL_COMP_STATE_RESET)
- {
- /* Allocate lock resource and initialize it */
- hcomp->Lock = HAL_UNLOCKED;
-
- /* Init SYSCFG and the low level hardware to access comparators */
- /* Note: HAL_COMP_Init() calls __HAL_RCC_SYSCFG_CLK_ENABLE() */
- /* to enable internal control clock of the comparators. */
- /* However, this is a legacy strategy. In future STM32 families, */
- /* COMP clock enable must be implemented by user */
- /* in "HAL_COMP_MspInit()". */
- /* Therefore, for compatibility anticipation, it is recommended */
- /* to implement __HAL_RCC_SYSCFG_CLK_ENABLE() */
- /* in "HAL_COMP_MspInit()". */
- __HAL_RCC_SYSCFG_CLK_ENABLE();
-
- /* Init the low level hardware */
- HAL_COMP_MspInit(hcomp);
- }
-
- /* Memorize voltage scaler state before initialization */
- comp_voltage_scaler_not_initialized = (READ_BIT(hcomp->Instance->CSR, COMP_CSR_SCALEN) == 0);
-
- /* Set COMP parameters */
- tmp_csr = ( hcomp->Init.NonInvertingInput
- | hcomp->Init.InvertingInput
- | hcomp->Init.BlankingSrce
- | hcomp->Init.Hysteresis
- | hcomp->Init.OutputPol
- | hcomp->Init.Mode
- );
-
- /* Set parameters in COMP register */
- /* Note: Update all bits except read-only, lock and enable bits */
- #if defined (COMP_CSR_INMESEL)
- MODIFY_REG(hcomp->Instance->CSR,
- COMP_CSR_PWRMODE | COMP_CSR_INMSEL | COMP_CSR_INPSEL |
- COMP_CSR_WINMODE | COMP_CSR_POLARITY | COMP_CSR_HYST |
- COMP_CSR_BLANKING | COMP_CSR_BRGEN | COMP_CSR_SCALEN | COMP_CSR_INMESEL,
- tmp_csr
- );
- #else
- MODIFY_REG(hcomp->Instance->CSR,
- COMP_CSR_PWRMODE | COMP_CSR_INMSEL | COMP_CSR_INPSEL |
- COMP_CSR_WINMODE | COMP_CSR_POLARITY | COMP_CSR_HYST |
- COMP_CSR_BLANKING | COMP_CSR_BRGEN | COMP_CSR_SCALEN,
- tmp_csr
- );
- #endif
-
- /* Set window mode */
- /* Note: Window mode bit is located into 1 out of the 2 pairs of COMP */
- /* instances. Therefore, this function can update another COMP */
- /* instance that the one currently selected. */
- if(hcomp->Init.WindowMode == COMP_WINDOWMODE_COMP1_INPUT_PLUS_COMMON)
- {
- SET_BIT(COMP12_COMMON->CSR, COMP_CSR_WINMODE);
- }
- else
- {
- CLEAR_BIT(COMP12_COMMON->CSR, COMP_CSR_WINMODE);
- }
-
- /* Delay for COMP scaler bridge voltage stabilization */
- /* Apply the delay if voltage scaler bridge is enabled for the first time */
- if ((READ_BIT(hcomp->Instance->CSR, COMP_CSR_SCALEN) != 0U) &&
- (comp_voltage_scaler_not_initialized != 0U) )
- {
- /* Wait loop initialization and execution */
- /* Note: Variable divided by 2 to compensate partially */
- /* CPU processing cycles. */
- wait_loop_index = (COMP_DELAY_VOLTAGE_SCALER_STAB_US * (SystemCoreClock / (1000000 * 2U)));
- while(wait_loop_index != 0U)
- {
- wait_loop_index--;
- }
- }
-
- /* Get the EXTI line corresponding to the selected COMP instance */
- exti_line = COMP_GET_EXTI_LINE(hcomp->Instance);
-
- /* Manage EXTI settings */
- if((hcomp->Init.TriggerMode & (COMP_EXTI_IT | COMP_EXTI_EVENT)) != RESET)
- {
- /* Configure EXTI rising edge */
- if((hcomp->Init.TriggerMode & COMP_EXTI_RISING) != RESET)
- {
- LL_EXTI_EnableRisingTrig_0_31(exti_line);
- }
- else
- {
- LL_EXTI_DisableRisingTrig_0_31(exti_line);
- }
-
- /* Configure EXTI falling edge */
- if((hcomp->Init.TriggerMode & COMP_EXTI_FALLING) != RESET)
- {
- LL_EXTI_EnableFallingTrig_0_31(exti_line);
- }
- else
- {
- LL_EXTI_DisableFallingTrig_0_31(exti_line);
- }
-
- /* Clear COMP EXTI pending bit (if any) */
- LL_EXTI_ClearFlag_0_31(exti_line);
-
- /* Configure EXTI event mode */
- if((hcomp->Init.TriggerMode & COMP_EXTI_EVENT) != RESET)
- {
- LL_EXTI_EnableEvent_0_31(exti_line);
- }
- else
- {
- LL_EXTI_DisableEvent_0_31(exti_line);
- }
-
- /* Configure EXTI interrupt mode */
- if((hcomp->Init.TriggerMode & COMP_EXTI_IT) != RESET)
- {
- LL_EXTI_EnableIT_0_31(exti_line);
- }
- else
- {
- LL_EXTI_DisableIT_0_31(exti_line);
- }
- }
- else
- {
- /* Disable EXTI event mode */
- LL_EXTI_DisableEvent_0_31(exti_line);
-
- /* Disable EXTI interrupt mode */
- LL_EXTI_DisableIT_0_31(exti_line);
- }
-
- /* Set HAL COMP handle state */
- /* Note: Transition from state reset to state ready, */
- /* otherwise (coming from state ready or busy) no state update. */
- if (hcomp->State == HAL_COMP_STATE_RESET)
- {
- hcomp->State = HAL_COMP_STATE_READY;
- }
- }
-
- return status;
- }
- /**
- * @brief DeInitialize the COMP peripheral.
- * @note Deinitialization cannot be performed if the COMP configuration is locked.
- * 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) || (__HAL_COMP_IS_LOCKED(hcomp)))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
-
- /* Set COMP_CSR register to reset value */
- WRITE_REG(hcomp->Instance->CSR, 0x00000000U);
-
- /* DeInit the low level hardware: SYSCFG, GPIO, CLOCK and NVIC */
- HAL_COMP_MspDeInit(hcomp);
-
- /* Set HAL COMP handle state */
- 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
- */
- }
- /**
- * @}
- */
- /** @defgroup COMP_Exported_Functions_Group2 Start-Stop operation functions
- * @brief Start-Stop operation functions.
- *
- @verbatim
- ===============================================================================
- ##### IO operation functions #####
- ===============================================================================
- [..] This section provides functions allowing to:
- (+) Start a comparator instance.
- (+) Stop a comparator instance.
- @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 = 0U;
- HAL_StatusTypeDef status = HAL_OK;
-
- /* Check the COMP handle allocation and lock status */
- if((hcomp == NULL) || (__HAL_COMP_IS_LOCKED(hcomp)))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
- if(hcomp->State == HAL_COMP_STATE_READY)
- {
- /* Enable the selected comparator */
- SET_BIT(hcomp->Instance->CSR, COMP_CSR_EN);
-
- /* Set HAL COMP handle state */
- 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. */
- wait_loop_index = (COMP_DELAY_STARTUP_US * (SystemCoreClock / (1000000U * 2U)));
- while(wait_loop_index != 0U)
- {
- 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) || (__HAL_COMP_IS_LOCKED(hcomp)))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
-
- if((hcomp->State == HAL_COMP_STATE_BUSY) ||
- (hcomp->State == HAL_COMP_STATE_READY) )
- {
- /* Disable the selected comparator */
- CLEAR_BIT(hcomp->Instance->CSR, COMP_CSR_EN);
- /* Set HAL COMP handle state */
- hcomp->State = HAL_COMP_STATE_READY;
- }
- else
- {
- status = HAL_ERROR;
- }
- }
-
- return status;
- }
- /**
- * @brief Comparator IRQ handler.
- * @param hcomp COMP handle
- * @retval None
- */
- void HAL_COMP_IRQHandler(COMP_HandleTypeDef *hcomp)
- {
- /* Get the EXTI line corresponding to the selected COMP instance */
- uint32_t exti_line = COMP_GET_EXTI_LINE(hcomp->Instance);
-
- /* Check COMP EXTI flag */
- if(LL_EXTI_IsActiveFlag_0_31(exti_line) != RESET)
- {
- /* Check whether comparator is in independent or window mode */
- if(READ_BIT(COMP12_COMMON->CSR, COMP_CSR_WINMODE) != RESET)
- {
- /* Clear COMP EXTI line pending bit of the pair of comparators */
- /* in window mode. */
- /* Note: Pair of comparators in window mode can both trig IRQ when */
- /* input voltage is changing from "out of window" area */
- /* (low or high ) to the other "out of window" area (high or low).*/
- /* Both flags must be cleared to call comparator trigger */
- /* callback is called once. */
- LL_EXTI_ClearFlag_0_31((COMP_EXTI_LINE_COMP1 | COMP_EXTI_LINE_COMP2));
- }
- else
- {
- /* Clear COMP EXTI line pending bit */
- LL_EXTI_ClearFlag_0_31(exti_line);
- }
-
- /* COMP trigger user callback */
- HAL_COMP_TriggerCallback(hcomp);
- }
- }
- /**
- * @}
- */
- /** @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.
- * @note Locking the comparator from reset state is possible
- * if __HAL_RCC_SYSCFG_CLK_ENABLE() is being called before.
- * @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) || (__HAL_COMP_IS_LOCKED(hcomp)))
- {
- status = HAL_ERROR;
- }
- else
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
-
- /* Set HAL COMP handle state */
- hcomp->State = ((HAL_COMP_StateTypeDef)(hcomp->State | COMP_STATE_BITFIELD_LOCK));
- }
-
- 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 input plus is at a lower
- * voltage than the input minus
- * - Comparator output is high when the input plus is at a higher
- * voltage than the input minus
- * If the polarity is inverted:
- * - Comparator output is high when the input plus is at a lower
- * voltage than the input minus
- * - Comparator output is low when the input plus is at a higher
- * voltage than the input minus
- * @param hcomp COMP handle
- * @retval Returns the selected comparator output level:
- * @arg COMP_OUTPUT_LEVEL_LOW
- * @arg COMP_OUTPUT_LEVEL_HIGH
- *
- */
- uint32_t HAL_COMP_GetOutputLevel(COMP_HandleTypeDef *hcomp)
- {
- /* Check the parameter */
- assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance));
-
- return (uint32_t)(READ_BIT(hcomp->Instance->CSR, COMP_CSR_VALUE)
- >> COMP_OUTPUT_LEVEL_BITOFFSET_POS);
- }
- /**
- * @brief Comparator 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_Group4 Peripheral State functions
- * @brief Peripheral State functions.
- *
- @verbatim
- ===============================================================================
- ##### Peripheral State functions #####
- ===============================================================================
- [..]
- This subsection permit 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 HAL COMP handle state */
- return hcomp->State;
- }
- /**
- * @}
- */
- /**
- * @}
- */
- /**
- * @}
- */
- /**
- * @}
- */
- #endif /* COMP1 || COMP2 */
- #endif /* HAL_COMP_MODULE_ENABLED */
- /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|