雄介 太田 / mbed

mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

TARGET_NUCLEO_F303RE/stm32f3xx_hal_comp.h@98:01a414ca7d6d, 2015-04-08 (annotated)

Committer:
yusuke_kyo
Date:
Wed Apr 08 08:04:18 2015 +0000
Revision:
98:01a414ca7d6d
Parent:
93:e188a91d3eaa 
remove SerialHalfDuplex.h

Who changed what in which revision?

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