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_F303K8/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:
109:9296ab0bfc11 
.

Who changed what in which revision?

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