Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F302R8/stm32f3xx_hal_comp.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
90:cb3d968589d8 
.

Who changed what in which revision?

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