mbed w/ spi bug fig
Fork of mbed-src by
targets/cmsis/TARGET_STM/TARGET_NUCLEO_F072RB/stm32f0xx_hal_comp.c
- Committer:
- mbed_official
- Date:
- 2014-05-22
- Revision:
- 205:c41fc65bcfb4
- Child:
- 218:44081b78fdc2
File content as of revision 205:c41fc65bcfb4:
/** ****************************************************************************** * @file stm32f0xx_hal_comp.c * @author MCD Application Team * @version V1.0.0 * @date 20-May-2014 * @brief COMP HAL module driver. * * This file provides firmware functions to manage the following * functionalities of the COMP peripheral: * + Initialization/de-initialization functions * + I/O operation functions * + Peripheral Control functions * + Peripheral State functions * @verbatim ================================================================================ ##### COMP Peripheral features ##### ================================================================================ [..] The STM32F0xx device family integrates 2 analog comparators COMP1 and COMP2: (#) The non inverting input and inverting input can be set to GPIO pins as shown in table1. COMP Inputs below. (#) The COMP output is available using HAL_COMP_GetOutputLevel() and can be set on GPIO pins. Refer to table 2. COMP Outputs below. (#) The COMP output can be redirected to embedded timers (TIM1, TIM2 and TIM3) Refer to table 3. COMP Outputs redirection to embedded timers below. (#) The comparators COMP1 and COMP2 can be combined in window mode. (#) The 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 From the corresponding IRQ handler, the right interrupt source can be retrieved with the macro __HAL_COMP_EXTI_GET_FLAG(). Possible values are: (++) COMP_EXTI_LINE_COMP1_EVENT (++) COMP_EXTI_LINE_COMP2_EVENT [..] Table 1. COMP Inputs for the STM32F05x and STM32F07x devices +--------------------------------------------------+ | | | COMP1 | COMP2 | |-----------------|----------------|---------------| | | 1/4 VREFINT | OK | OK | | | 1/2 VREFINT | OK | OK | | | 3/4 VREFINT | OK | OK | | Inverting Input | VREFINT | OK | OK | | | DAC1 OUT (PA4) | OK | OK | | | DAC2 OUT (PA5) | OK | OK | | | IO1 | PA0 | PA2 | |-----------------|----------------|-------|-------| | Non Inverting | | PA1 | PA3 | | Input | | | | +--------------------------------------------------+ [..] Table 2. COMP Outputs for the STM32F05x and STM32F07x devices +---------------+ | COMP1 | COMP2 | |-------|-------| | PA0 | PA2 | | PA6 | PA7 | | PA11 | PA12 | +---------------+ [..] Table 3. COMP Outputs redirection to embedded timers for the STM32F05x and STM32F07x devices +---------------------------------+ | COMP1 | COMP2 | |----------------|----------------| | TIM1 BKIN | TIM1 BKIN | | | | | TIM1 OCREFCLR | TIM1 OCREFCLR | | | | | TIM1 IC1 | TIM1 IC1 | | | | | TIM2 IC4 | TIM2 IC4 | | | | | TIM2 OCREFCLR | TIM2 OCREFCLR | | | | | TIM3 IC1 | TIM3 IC1 | | | | | TIM3 OCREFCLR | TIM3 OCREFCLR | +---------------------------------+ ##### How to use this driver ##### ================================================================================ [..] This driver provides functions to configure and program the Comparators of STM32F05x and STM32F07x devices. To use the comparator, perform the following steps: (#) Fill in the HAL_COMP_MspInit() to (++) Enable the SYSCFG APB clock to get write access to comparator register using __SYSCFG_CLK_ENABLE() (++) 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 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 inverting input (++) Select the output polarity (++) Select the output redirection (++) Select the hysteresis level (++) Select the power mode (#) Enable the comparator using HAL_COMP_Start() function @endverbatim ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2014 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. * ****************************************************************************** */ #if defined(STM32F051x8) || defined(STM32F058xx) || \ defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) /* Includes ------------------------------------------------------------------*/ #include "stm32f0xx_hal.h" /** @addtogroup STM32F0xx_HAL_Driver * @{ */ /** @defgroup COMP * @brief COMP HAL module driver * @{ */ #ifdef HAL_COMP_MODULE_ENABLED /* Private typedef -----------------------------------------------------------*/ /* Private define ------------------------------------------------------------*/ /* CSR register reset value */ #define COMP_CSR_RESET_VALUE ((uint32_t)0x00000000) /* CSR register Mask */ #define COMP_CSR_UPDATE_PARAMETERS_MASK ((uint32_t)0x00003FFE) /* CSR COMPx Shift */ #define COMP_CSR_COMP1_SHIFT ((uint32_t)0) #define COMP_CSR_COMP2_SHIFT ((uint32_t)16) /* Private macro -------------------------------------------------------------*/ /* Private variables ---------------------------------------------------------*/ /* Private function prototypes -----------------------------------------------*/ /* Private functions ---------------------------------------------------------*/ /** @defgroup COMP_Private_Functions * @{ */ /** @defgroup HAL_COMP_Group1 Initialization/de-initialization functions * @brief Initialization and Configuration functions * @verbatim =============================================================================== ##### Initialization/de-initialization functions ##### =============================================================================== [..] This section provides functions to initialize and de-initialize comparators @endverbatim * @{ */ /** * @brief Initializes the COMP according to the specified * parameters in the COMP_InitTypeDef and create 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) { HAL_StatusTypeDef status = HAL_OK; uint32_t tmpreg = 0; /* Check the COMP handle allocation and lock status */ if((hcomp == NULL) || (hcomp->State & COMP_STATE_BIT_LOCK)) { status = HAL_ERROR; } else { /* Check the parameter */ assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance)); assert_param(IS_COMP_INVERTINGINPUT(hcomp->Init.InvertingInput)); assert_param(IS_COMP_OUTPUT(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)); if(hcomp->Init.WindowMode != COMP_WINDOWMODE_DISABLED) { assert_param(IS_COMP_WINDOWMODE_INSTANCE(hcomp->Instance)); } if(hcomp->State == HAL_COMP_STATE_RESET) { /* Init SYSCFG and the low level hardware to access comparators */ __SYSCFG_CLK_ENABLE(); HAL_COMP_MspInit(hcomp); } /* Set COMP parameters */ /* Set COMPxINSEL bits according to hcomp->Init.InvertingInput 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 */ if(hcomp->Instance == COMP1) { tmpreg = hcomp->Instance->CSR; tmpreg = (tmpreg & ~COMP_CSR_UPDATE_PARAMETERS_MASK); tmpreg = tmpreg | hcomp->Init.InvertingInput | \ hcomp->Init.Output | \ hcomp->Init.OutputPol | \ hcomp->Init.Hysteresis | \ hcomp->Init.Mode; hcomp->Instance->CSR = tmpreg; } else { tmpreg = (COMP->CSR); tmpreg = (tmpreg & ~(COMP_CSR_UPDATE_PARAMETERS_MASK<<COMP_CSR_COMP2_SHIFT)); tmpreg = tmpreg | (((hcomp->Init.InvertingInput | \ hcomp->Init.Output | \ hcomp->Init.OutputPol | \ hcomp->Init.Hysteresis | \ hcomp->Init.Mode) << COMP_CSR_COMP2_SHIFT) | \ hcomp->Init.WindowMode); COMP->CSR = tmpreg; } /* Initialize the COMP state*/ if(hcomp->State == HAL_COMP_STATE_RESET) { hcomp->State = HAL_COMP_STATE_READY; } } return status; } /** * @brief DeInitializes the COMP peripheral * @note Deinitialization can't 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) || (hcomp->State & COMP_STATE_BIT_LOCK)) { status = HAL_ERROR; } else { /* Check the parameter */ assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance)); /* Set COMP_CSR register to reset value for the corresponding COMP instance */ if(hcomp->Instance == COMP1) { MODIFY_REG(hcomp->Instance->CSR, (COMP_CSR_UPDATE_PARAMETERS_MASK), (COMP_CSR_RESET_VALUE)); } else { MODIFY_REG(COMP->CSR, (COMP_CSR_UPDATE_PARAMETERS_MASK << COMP_CSR_COMP2_SHIFT), (COMP_CSR_RESET_VALUE)); } /* DeInit the low level hardware: SYSCFG, GPIO, CLOCK and NVIC */ HAL_COMP_MspDeInit(hcomp); hcomp->State = HAL_COMP_STATE_RESET; } return status; } /** * @brief Initializes the COMP MSP. * @param hcomp: COMP handle * @retval None */ __weak void HAL_COMP_MspInit(COMP_HandleTypeDef *hcomp) { /* NOTE : This function Should not be modified, when the callback is needed, the HAL_COMP_MspInit could be implenetd in the user file */ } /** * @brief DeInitializes COMP MSP. * @param hcomp: COMP handle * @retval None */ __weak void HAL_COMP_MspDeInit(COMP_HandleTypeDef *hcomp) { /* NOTE : This function Should not be modified, when the callback is needed, the HAL_COMP_MspDeInit could be implenetd in the user file */ } /** * @} */ /** @defgroup HAL_COMP_Group2 I/O operation functions * @brief Data transfers functions * @verbatim =============================================================================== ##### IO operation functions ##### =============================================================================== [..] This subsection provides a set of functions allowing to manage the COMP data transfers. @endverbatim * @{ */ /** * @brief Start the comparator * @param hcomp: COMP handle * @retval HAL status */ HAL_StatusTypeDef HAL_COMP_Start(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)) { 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 */ if(hcomp->Instance == COMP1) { SET_BIT(hcomp->Instance->CSR, (COMP_CSR_COMP1EN)); } else { SET_BIT(COMP->CSR, (COMP_CSR_COMP1EN << COMP_CSR_COMP2_SHIFT)); } hcomp->State = HAL_COMP_STATE_BUSY; } 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)) { status = HAL_ERROR; } else { /* Check the parameter */ assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance)); if(hcomp->State == HAL_COMP_STATE_BUSY) { /* Disable the selected comparator */ if(hcomp->Instance == COMP1) { CLEAR_BIT(hcomp->Instance->CSR, (COMP_CSR_COMP1EN )); } else { CLEAR_BIT(COMP->CSR, (COMP_CSR_COMP1EN << COMP_CSR_COMP2_SHIFT)); } hcomp->State = HAL_COMP_STATE_READY; } else { status = HAL_ERROR; } } return status; } /** * @brief Enables the interrupt and starts the comparator * @param hcomp: COMP handle * @retval HAL status. */ HAL_StatusTypeDef HAL_COMP_Start_IT(COMP_HandleTypeDef *hcomp) { HAL_StatusTypeDef status = HAL_OK; uint32_t extiline = 0; status = HAL_COMP_Start(hcomp); if(status == HAL_OK) { /* Check the Exti Line output configuration */ extiline = __HAL_COMP_GET_EXTI_LINE(hcomp->Instance); /* Configure the rising edge */ if(hcomp->Init.TriggerMode & COMP_TRIGGERMODE_IT_RISING) { __HAL_COMP_EXTI_RISING_IT_ENABLE(extiline); } else { __HAL_COMP_EXTI_RISING_IT_DISABLE(extiline); } /* Configure the falling edge */ if(hcomp->Init.TriggerMode & COMP_TRIGGERMODE_IT_FALLING) { __HAL_COMP_EXTI_FALLING_IT_ENABLE(extiline); } else { __HAL_COMP_EXTI_FALLING_IT_DISABLE(extiline); } /* Enable Exti interrupt mode */ __HAL_COMP_EXTI_ENABLE_IT(extiline); /* Clear COMP Exti pending bit */ __HAL_COMP_EXTI_CLEAR_FLAG(extiline); } return status; } /** * @brief Disable the interrupt and Stop the comparator * @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 */ __HAL_COMP_EXTI_DISABLE_IT(__HAL_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 = __HAL_COMP_GET_EXTI_LINE(hcomp->Instance); /* Check COMP Exti flag */ if(__HAL_COMP_EXTI_GET_FLAG(extiline) != RESET) { /* Clear COMP Exti pending bit */ __HAL_COMP_EXTI_CLEAR_FLAG(extiline); /* COMP trigger user callback */ HAL_COMP_TriggerCallback(hcomp); } } /** * @} */ /** @defgroup HAL_COMP_Group3 Peripheral Control functions * @brief management functions * @verbatim =============================================================================== ##### Peripheral Control functions ##### =============================================================================== [..] This subsection provides a set of functions allowing to control the COMP data transfers. @endverbatim * @{ */ /** * @brief Lock the selected 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)) { status = HAL_ERROR; } else { /* Check the parameter */ assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance)); /* Set lock flag */ hcomp->State |= COMP_STATE_BIT_LOCK; /* Set the lock bit corresponding to selected comparator */ if(hcomp->Instance == COMP1) { SET_BIT(hcomp->Instance->CSR, (COMP_CSR_COMP1LOCK )); } else { SET_BIT(COMP->CSR, (COMP_CSR_COMP1LOCK << COMP_CSR_COMP2_SHIFT)); } } 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: COMP_OUTPUTLEVEL_LOW or COMP_OUTPUTLEVEL_HIGH. * */ uint32_t HAL_COMP_GetOutputLevel(COMP_HandleTypeDef *hcomp) { uint32_t level=0; /* Check the parameter */ assert_param(IS_COMP_ALL_INSTANCE(hcomp->Instance)); if(hcomp->Instance == COMP1) { level = READ_BIT(hcomp->Instance->CSR, (COMP_CSR_COMP1OUT )); } else { level = READ_BIT(COMP->CSR, (COMP_CSR_COMP1OUT << COMP_CSR_COMP2_SHIFT)); } if(level != 0) { return(COMP_OUTPUTLEVEL_HIGH); } return(COMP_OUTPUTLEVEL_LOW); } /** * @brief Comparator callback. * @param hcomp: COMP handle * @retval None */ __weak void HAL_COMP_TriggerCallback(COMP_HandleTypeDef *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 HAL_COMP_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 and the data flow. @endverbatim * @{ */ /** * @brief Return the COMP 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 hcomp->State; } /** * @} */ /** * @} */ #endif /* HAL_COMP_MODULE_ENABLED */ /** * @} */ /** * @} */ #endif /* STM32F051x8 || STM32F058xx || */ /* STM32F071xB || STM32F072xB || STM32F078xx */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/