mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_F334R8/stm32f3xx_hal_comp.h@89:552587b429a1, 2014-09-12 (annotated)

Committer:
bogdanm
Date:
Fri Sep 12 16:41:52 2014 +0100
Revision:
89:552587b429a1
Parent:
86:04dd9b1680ae
Child:
92:4fc01daae5a5
Release 89 of the mbed library



Main changes:



- low power optimizations for Nordic targets

- code structure changes for Freescale K64F targets

- bug fixes in various backends

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 86:04dd9b1680ae 1 /**
bogdanm 86:04dd9b1680ae 2 ******************************************************************************
bogdanm 86:04dd9b1680ae 3 * @file stm32f3xx_hal_comp.h
bogdanm 86:04dd9b1680ae 4 * @author MCD Application Team
bogdanm 86:04dd9b1680ae 5 * @version V1.0.1
bogdanm 86:04dd9b1680ae 6 * @date 18-June-2014
bogdanm 86:04dd9b1680ae 7 * @brief Header file of COMP HAL module.
bogdanm 86:04dd9b1680ae 8 ******************************************************************************
bogdanm 86:04dd9b1680ae 9 * @attention
bogdanm 86:04dd9b1680ae 10 *
bogdanm 86:04dd9b1680ae 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
bogdanm 86:04dd9b1680ae 12 *
bogdanm 86:04dd9b1680ae 13 * Redistribution and use in source and binary forms, with or without modification,
bogdanm 86:04dd9b1680ae 14 * are permitted provided that the following conditions are met:
bogdanm 86:04dd9b1680ae 15 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 86:04dd9b1680ae 16 * this list of conditions and the following disclaimer.
bogdanm 86:04dd9b1680ae 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 86:04dd9b1680ae 18 * this list of conditions and the following disclaimer in the documentation
bogdanm 86:04dd9b1680ae 19 * and/or other materials provided with the distribution.
bogdanm 86:04dd9b1680ae 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 86:04dd9b1680ae 21 * may be used to endorse or promote products derived from this software
bogdanm 86:04dd9b1680ae 22 * without specific prior written permission.
bogdanm 86:04dd9b1680ae 23 *
bogdanm 86:04dd9b1680ae 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 86:04dd9b1680ae 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 86:04dd9b1680ae 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 86:04dd9b1680ae 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 86:04dd9b1680ae 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 86:04dd9b1680ae 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 86:04dd9b1680ae 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 86:04dd9b1680ae 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 86:04dd9b1680ae 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 86:04dd9b1680ae 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 86:04dd9b1680ae 34 *
bogdanm 86:04dd9b1680ae 35 ******************************************************************************
bogdanm 86:04dd9b1680ae 36 */
bogdanm 86:04dd9b1680ae 37
bogdanm 86:04dd9b1680ae 38 /* Define to prevent recursive inclusion -------------------------------------*/
bogdanm 86:04dd9b1680ae 39 #ifndef __STM32F3xx_HAL_COMP_H
bogdanm 86:04dd9b1680ae 40 #define __STM32F3xx_HAL_COMP_H
bogdanm 86:04dd9b1680ae 41
bogdanm 86:04dd9b1680ae 42 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 43 extern "C" {
bogdanm 86:04dd9b1680ae 44 #endif
bogdanm 86:04dd9b1680ae 45
bogdanm 86:04dd9b1680ae 46 /* Includes ------------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 47 #include "stm32f3xx_hal_def.h"
bogdanm 86:04dd9b1680ae 48
bogdanm 86:04dd9b1680ae 49 /** @addtogroup STM32F3xx_HAL_Driver
bogdanm 86:04dd9b1680ae 50 * @{
bogdanm 86:04dd9b1680ae 51 */
bogdanm 86:04dd9b1680ae 52
bogdanm 86:04dd9b1680ae 53 /** @addtogroup COMP
bogdanm 86:04dd9b1680ae 54 * @{
bogdanm 86:04dd9b1680ae 55 */
bogdanm 86:04dd9b1680ae 56
bogdanm 86:04dd9b1680ae 57 /* Exported types ------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 58
bogdanm 86:04dd9b1680ae 59 /**
bogdanm 86:04dd9b1680ae 60 * @brief COMP Init structure definition
bogdanm 86:04dd9b1680ae 61 */
bogdanm 86:04dd9b1680ae 62
bogdanm 86:04dd9b1680ae 63 typedef struct
bogdanm 86:04dd9b1680ae 64 {
bogdanm 86:04dd9b1680ae 65
bogdanm 86:04dd9b1680ae 66 uint32_t InvertingInput; /*!< Selects the inverting input of the comparator.
bogdanm 86:04dd9b1680ae 67 This parameter can be a value of @ref COMPEx_InvertingInput */
bogdanm 86:04dd9b1680ae 68
bogdanm 86:04dd9b1680ae 69 uint32_t NonInvertingInput; /*!< Selects the non inverting input of the comparator.
bogdanm 86:04dd9b1680ae 70 This parameter can be a value of @ref COMPEx_NonInvertingInput
bogdanm 86:04dd9b1680ae 71 Note: Only available on STM32F302xB/xC, STM32F303xB/xC and STM32F358xx devices */
bogdanm 86:04dd9b1680ae 72
bogdanm 86:04dd9b1680ae 73 uint32_t Output; /*!< Selects the output redirection of the comparator.
bogdanm 86:04dd9b1680ae 74 This parameter can be a value of @ref COMPEx_Output */
bogdanm 86:04dd9b1680ae 75
bogdanm 86:04dd9b1680ae 76 uint32_t OutputPol; /*!< Selects the output polarity of the comparator.
bogdanm 86:04dd9b1680ae 77 This parameter can be a value of @ref COMP_OutputPolarity */
bogdanm 86:04dd9b1680ae 78
bogdanm 86:04dd9b1680ae 79 uint32_t Hysteresis; /*!< Selects the hysteresis voltage of the comparator.
bogdanm 86:04dd9b1680ae 80 This parameter can be a value of @ref COMPEx_Hysteresis
bogdanm 86:04dd9b1680ae 81 Note: Only available on STM32F302xB/xC, STM32F303xB/xC, STM32F373xB/xC, STM32F358xx and STM32F378xx devices */
bogdanm 86:04dd9b1680ae 82
bogdanm 86:04dd9b1680ae 83 uint32_t BlankingSrce; /*!< Selects the output blanking source of the comparator.
bogdanm 86:04dd9b1680ae 84 This parameter can be a value of @ref COMPEx_BlankingSrce
bogdanm 86:04dd9b1680ae 85 Note: Not available on STM32F373xB/C and STM32F378xx devices */
bogdanm 86:04dd9b1680ae 86
bogdanm 86:04dd9b1680ae 87 uint32_t Mode; /*!< Selects the operating comsumption mode of the comparator
bogdanm 86:04dd9b1680ae 88 to adjust the speed/consumption.
bogdanm 86:04dd9b1680ae 89 This parameter can be a value of @ref COMPEx_Mode
bogdanm 86:04dd9b1680ae 90 Note: Not available on STM32F301x6/x8, STM32F302x6/x8, STM32F334x6/x8, STM32F318xx and STM32F328xx devices */
bogdanm 86:04dd9b1680ae 91
bogdanm 86:04dd9b1680ae 92 uint32_t WindowMode; /*!< Selects the window mode of the comparator X (X=2, 4 or 6 if available).
bogdanm 86:04dd9b1680ae 93 This parameter can be a value of @ref COMPEx_WindowMode */
bogdanm 86:04dd9b1680ae 94
bogdanm 86:04dd9b1680ae 95 uint32_t TriggerMode; /*!< Selects the trigger mode of the comparator (interrupt mode).
bogdanm 86:04dd9b1680ae 96 This parameter can be a value of @ref COMP_TriggerMode */
bogdanm 86:04dd9b1680ae 97
bogdanm 86:04dd9b1680ae 98 }COMP_InitTypeDef;
bogdanm 86:04dd9b1680ae 99
bogdanm 86:04dd9b1680ae 100 /**
bogdanm 86:04dd9b1680ae 101 * @brief HAL State structures definition
bogdanm 86:04dd9b1680ae 102 */
bogdanm 86:04dd9b1680ae 103 typedef enum
bogdanm 86:04dd9b1680ae 104 {
bogdanm 86:04dd9b1680ae 105 HAL_COMP_STATE_RESET = 0x00, /*!< COMP not yet initialized or disabled */
bogdanm 86:04dd9b1680ae 106 HAL_COMP_STATE_READY = 0x01, /*!< COMP initialized and ready for use */
bogdanm 86:04dd9b1680ae 107 HAL_COMP_STATE_READY_LOCKED = 0x11, /*!< COMP initialized but the configuration is locked */
bogdanm 86:04dd9b1680ae 108 HAL_COMP_STATE_BUSY = 0x02, /*!< COMP is running */
bogdanm 86:04dd9b1680ae 109 HAL_COMP_STATE_BUSY_LOCKED = 0x12 /*!< COMP is running and the configuration is locked */
bogdanm 86:04dd9b1680ae 110 }HAL_COMP_StateTypeDef;
bogdanm 86:04dd9b1680ae 111
bogdanm 86:04dd9b1680ae 112
bogdanm 86:04dd9b1680ae 113 /**
bogdanm 86:04dd9b1680ae 114 * @brief PPP Handle Structure definition
bogdanm 86:04dd9b1680ae 115 */
bogdanm 86:04dd9b1680ae 116 typedef struct
bogdanm 86:04dd9b1680ae 117 {
bogdanm 86:04dd9b1680ae 118 COMP_TypeDef *Instance; /*!< Register base address */
bogdanm 86:04dd9b1680ae 119 COMP_InitTypeDef Init; /*!< COMP required parameters */
bogdanm 86:04dd9b1680ae 120 HAL_LockTypeDef Lock; /*!< Locking object */
bogdanm 86:04dd9b1680ae 121 __IO HAL_COMP_StateTypeDef State; /*!< COMP communication state */
bogdanm 86:04dd9b1680ae 122
bogdanm 86:04dd9b1680ae 123 }COMP_HandleTypeDef;
bogdanm 86:04dd9b1680ae 124
bogdanm 86:04dd9b1680ae 125 /* Exported constants --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 126 /** @defgroup COMP_Exported_Constants
bogdanm 86:04dd9b1680ae 127 * @{
bogdanm 86:04dd9b1680ae 128 */
bogdanm 86:04dd9b1680ae 129
bogdanm 86:04dd9b1680ae 130 /** @defgroup COMP_OutputPolarity
bogdanm 86:04dd9b1680ae 131 * @{
bogdanm 86:04dd9b1680ae 132 */
bogdanm 86:04dd9b1680ae 133 #define COMP_OUTPUTPOL_NONINVERTED ((uint32_t)0x00000000) /*!< COMP output on GPIO isn't inverted */
bogdanm 86:04dd9b1680ae 134 #define COMP_OUTPUTPOL_INVERTED COMP_CSR_COMPxPOL /*!< COMP output on GPIO is inverted */
bogdanm 86:04dd9b1680ae 135 #define IS_COMP_OUTPUTPOL(POL) (((POL) == COMP_OUTPUTPOL_NONINVERTED) || \
bogdanm 86:04dd9b1680ae 136 ((POL) == COMP_OUTPUTPOL_INVERTED))
bogdanm 86:04dd9b1680ae 137 /**
bogdanm 86:04dd9b1680ae 138 * @}
bogdanm 86:04dd9b1680ae 139 */
bogdanm 86:04dd9b1680ae 140
bogdanm 86:04dd9b1680ae 141 /** @defgroup COMP_OutputLevel
bogdanm 86:04dd9b1680ae 142 * @{
bogdanm 86:04dd9b1680ae 143 */
bogdanm 86:04dd9b1680ae 144 /* When output polarity is not inverted, comparator output is low when
bogdanm 86:04dd9b1680ae 145 the non-inverting input is at a lower voltage than the inverting input*/
bogdanm 86:04dd9b1680ae 146 #define COMP_OUTPUTLEVEL_LOW ((uint32_t)0x00000000)
bogdanm 86:04dd9b1680ae 147 /* When output polarity is not inverted, comparator output is high when
bogdanm 86:04dd9b1680ae 148 the non-inverting input is at a higher voltage than the inverting input */
bogdanm 86:04dd9b1680ae 149 #define COMP_OUTPUTLEVEL_HIGH COMP_CSR_COMPxOUT
bogdanm 86:04dd9b1680ae 150 /**
bogdanm 86:04dd9b1680ae 151 * @}
bogdanm 86:04dd9b1680ae 152 */
bogdanm 86:04dd9b1680ae 153
bogdanm 86:04dd9b1680ae 154 /** @defgroup COMP_TriggerMode
bogdanm 86:04dd9b1680ae 155 * @{
bogdanm 86:04dd9b1680ae 156 */
bogdanm 86:04dd9b1680ae 157 #define COMP_TRIGGERMODE_NONE ((uint32_t)0x00000000) /*!< No External Interrupt trigger detection */
bogdanm 86:04dd9b1680ae 158 #define COMP_TRIGGERMODE_IT_RISING ((uint32_t)0x00000001) /*!< External Interrupt Mode with Rising edge trigger detection */
bogdanm 86:04dd9b1680ae 159 #define COMP_TRIGGERMODE_IT_FALLING ((uint32_t)0x00000002) /*!< External Interrupt Mode with Falling edge trigger detection */
bogdanm 86:04dd9b1680ae 160 #define COMP_TRIGGERMODE_IT_RISING_FALLING ((uint32_t)0x00000003) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */
bogdanm 86:04dd9b1680ae 161 #define IS_COMP_TRIGGERMODE(MODE) (((MODE) == COMP_TRIGGERMODE_NONE) || \
bogdanm 86:04dd9b1680ae 162 ((MODE) == COMP_TRIGGERMODE_IT_RISING) || \
bogdanm 86:04dd9b1680ae 163 ((MODE) == COMP_TRIGGERMODE_IT_FALLING) || \
bogdanm 86:04dd9b1680ae 164 ((MODE) == COMP_TRIGGERMODE_IT_RISING_FALLING))
bogdanm 86:04dd9b1680ae 165 /**
bogdanm 86:04dd9b1680ae 166 * @}
bogdanm 86:04dd9b1680ae 167 */
bogdanm 86:04dd9b1680ae 168
bogdanm 86:04dd9b1680ae 169 #define COMP_LOCK_DISABLE ((uint32_t)0x00000000)
bogdanm 86:04dd9b1680ae 170 #define COMP_LOCK_ENABLE COMP_CSR_COMPxLOCK
bogdanm 86:04dd9b1680ae 171
bogdanm 86:04dd9b1680ae 172 #define COMP_STATE_BIT_LOCK ((uint32_t)0x10)
bogdanm 86:04dd9b1680ae 173
bogdanm 86:04dd9b1680ae 174 /**
bogdanm 86:04dd9b1680ae 175 * @}
bogdanm 86:04dd9b1680ae 176 */
bogdanm 86:04dd9b1680ae 177
bogdanm 86:04dd9b1680ae 178 /* Exported macros -----------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 179
bogdanm 86:04dd9b1680ae 180 /** @brief Reset COMP handle state
bogdanm 86:04dd9b1680ae 181 * @param __HANDLE__: COMP handle.
bogdanm 86:04dd9b1680ae 182 * @retval None
bogdanm 86:04dd9b1680ae 183 */
bogdanm 86:04dd9b1680ae 184 #define __HAL_COMP_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_COMP_STATE_RESET)
bogdanm 86:04dd9b1680ae 185
bogdanm 86:04dd9b1680ae 186 /* Include COMP HAL Extension module */
bogdanm 86:04dd9b1680ae 187 #include "stm32f3xx_hal_comp_ex.h"
bogdanm 86:04dd9b1680ae 188
bogdanm 86:04dd9b1680ae 189 /* Exported functions --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 190
bogdanm 86:04dd9b1680ae 191 /* Initialization and de-initialization functions ****************************/
bogdanm 86:04dd9b1680ae 192 HAL_StatusTypeDef HAL_COMP_Init(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 193 HAL_StatusTypeDef HAL_COMP_DeInit (COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 194 void HAL_COMP_MspInit(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 195 void HAL_COMP_MspDeInit(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 196
bogdanm 86:04dd9b1680ae 197 /* IO operation functions *****************************************************/
bogdanm 86:04dd9b1680ae 198 HAL_StatusTypeDef HAL_COMP_Start(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 199 HAL_StatusTypeDef HAL_COMP_Stop(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 200 HAL_StatusTypeDef HAL_COMP_Start_IT(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 201 HAL_StatusTypeDef HAL_COMP_Stop_IT(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 202 void HAL_COMP_IRQHandler(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 203
bogdanm 86:04dd9b1680ae 204 /* Peripheral Control functions ***********************************************/
bogdanm 86:04dd9b1680ae 205 HAL_StatusTypeDef HAL_COMP_Lock(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 206 uint32_t HAL_COMP_GetOutputLevel(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 207
bogdanm 86:04dd9b1680ae 208 /* Callback in Interrupt mode */
bogdanm 86:04dd9b1680ae 209 void HAL_COMP_TriggerCallback(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 210
bogdanm 86:04dd9b1680ae 211 /* Peripheral State and Error functions ***************************************/
bogdanm 86:04dd9b1680ae 212 HAL_COMP_StateTypeDef HAL_COMP_GetState(COMP_HandleTypeDef *hcomp);
bogdanm 86:04dd9b1680ae 213
bogdanm 86:04dd9b1680ae 214 /**
bogdanm 86:04dd9b1680ae 215 * @}
bogdanm 86:04dd9b1680ae 216 */
bogdanm 86:04dd9b1680ae 217
bogdanm 86:04dd9b1680ae 218 /**
bogdanm 86:04dd9b1680ae 219 * @}
bogdanm 86:04dd9b1680ae 220 */
bogdanm 86:04dd9b1680ae 221
bogdanm 86:04dd9b1680ae 222 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 223 }
bogdanm 86:04dd9b1680ae 224 #endif
bogdanm 86:04dd9b1680ae 225
bogdanm 86:04dd9b1680ae 226 #endif /* __STM32F3xx_HAL_COMP_H */
bogdanm 86:04dd9b1680ae 227
bogdanm 86:04dd9b1680ae 228 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/