1 /** 2 ****************************************************************************** 3 * @file stm32f7xx_hal_lptim.h 4 * @author MCD Application Team 5 * @brief Header file of LPTIM HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2017 STMicroelectronics. 10 * All rights reserved. 11 * 12 * This software is licensed under terms that can be found in the LICENSE file 13 * in the root directory of this software component. 14 * If no LICENSE file comes with this software, it is provided AS-IS. 15 * 16 ****************************************************************************** 17 */ 18 19 /* Define to prevent recursive inclusion -------------------------------------*/ 20 #ifndef STM32F7xx_HAL_LPTIM_H 21 #define STM32F7xx_HAL_LPTIM_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32f7xx_hal_def.h" 29 30 /** @addtogroup STM32F7xx_HAL_Driver 31 * @{ 32 */ 33 34 #if defined (LPTIM1) 35 36 /** @addtogroup LPTIM 37 * @{ 38 */ 39 40 /* Exported types ------------------------------------------------------------*/ 41 /** @defgroup LPTIM_Exported_Types LPTIM Exported Types 42 * @{ 43 */ 44 #define LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT EXTI_IMR_MR23 /*!< External interrupt line 23 Connected to the LPTIM EXTI Line */ 45 46 /** 47 * @brief LPTIM Clock configuration definition 48 */ 49 typedef struct 50 { 51 uint32_t Source; /*!< Selects the clock source. 52 This parameter can be a value of @ref LPTIM_Clock_Source */ 53 54 uint32_t Prescaler; /*!< Specifies the counter clock Prescaler. 55 This parameter can be a value of @ref LPTIM_Clock_Prescaler */ 56 57 } LPTIM_ClockConfigTypeDef; 58 59 /** 60 * @brief LPTIM Clock configuration definition 61 */ 62 typedef struct 63 { 64 uint32_t Polarity; /*!< Selects the polarity of the active edge for the counter unit 65 if the ULPTIM input is selected. 66 Note: This parameter is used only when Ultra low power clock source is used. 67 Note: If the polarity is configured on 'both edges', an auxiliary clock 68 (one of the Low power oscillator) must be active. 69 This parameter can be a value of @ref LPTIM_Clock_Polarity */ 70 71 uint32_t SampleTime; /*!< Selects the clock sampling time to configure the clock glitch filter. 72 Note: This parameter is used only when Ultra low power clock source is used. 73 This parameter can be a value of @ref LPTIM_Clock_Sample_Time */ 74 75 } LPTIM_ULPClockConfigTypeDef; 76 77 /** 78 * @brief LPTIM Trigger configuration definition 79 */ 80 typedef struct 81 { 82 uint32_t Source; /*!< Selects the Trigger source. 83 This parameter can be a value of @ref LPTIM_Trigger_Source */ 84 85 uint32_t ActiveEdge; /*!< Selects the Trigger active edge. 86 Note: This parameter is used only when an external trigger is used. 87 This parameter can be a value of @ref LPTIM_External_Trigger_Polarity */ 88 89 uint32_t SampleTime; /*!< Selects the trigger sampling time to configure the clock glitch filter. 90 Note: This parameter is used only when an external trigger is used. 91 This parameter can be a value of @ref LPTIM_Trigger_Sample_Time */ 92 } LPTIM_TriggerConfigTypeDef; 93 94 /** 95 * @brief LPTIM Initialization Structure definition 96 */ 97 typedef struct 98 { 99 LPTIM_ClockConfigTypeDef Clock; /*!< Specifies the clock parameters */ 100 101 LPTIM_ULPClockConfigTypeDef UltraLowPowerClock;/*!< Specifies the Ultra Low Power clock parameters */ 102 103 LPTIM_TriggerConfigTypeDef Trigger; /*!< Specifies the Trigger parameters */ 104 105 uint32_t OutputPolarity; /*!< Specifies the Output polarity. 106 This parameter can be a value of @ref LPTIM_Output_Polarity */ 107 108 uint32_t UpdateMode; /*!< Specifies whether the update of the autoreload and the compare 109 values is done immediately or after the end of current period. 110 This parameter can be a value of @ref LPTIM_Updating_Mode */ 111 112 uint32_t CounterSource; /*!< Specifies whether the counter is incremented each internal event 113 or each external event. 114 This parameter can be a value of @ref LPTIM_Counter_Source */ 115 } LPTIM_InitTypeDef; 116 117 /** 118 * @brief HAL LPTIM State structure definition 119 */ 120 typedef enum 121 { 122 HAL_LPTIM_STATE_RESET = 0x00U, /*!< Peripheral not yet initialized or disabled */ 123 HAL_LPTIM_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */ 124 HAL_LPTIM_STATE_BUSY = 0x02U, /*!< An internal process is ongoing */ 125 HAL_LPTIM_STATE_TIMEOUT = 0x03U, /*!< Timeout state */ 126 HAL_LPTIM_STATE_ERROR = 0x04U /*!< Internal Process is ongoing */ 127 } HAL_LPTIM_StateTypeDef; 128 129 /** 130 * @brief LPTIM handle Structure definition 131 */ 132 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 133 typedef struct __LPTIM_HandleTypeDef 134 #else 135 typedef struct 136 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 137 { 138 LPTIM_TypeDef *Instance; /*!< Register base address */ 139 140 LPTIM_InitTypeDef Init; /*!< LPTIM required parameters */ 141 142 HAL_StatusTypeDef Status; /*!< LPTIM peripheral status */ 143 144 HAL_LockTypeDef Lock; /*!< LPTIM locking object */ 145 146 __IO HAL_LPTIM_StateTypeDef State; /*!< LPTIM peripheral state */ 147 148 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 149 void (* MspInitCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< LPTIM Base Msp Init Callback */ 150 void (* MspDeInitCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< LPTIM Base Msp DeInit Callback */ 151 void (* CompareMatchCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Compare match Callback */ 152 void (* AutoReloadMatchCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Auto-reload match Callback */ 153 void (* TriggerCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< External trigger event detection Callback */ 154 void (* CompareWriteCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Compare register write complete Callback */ 155 void (* AutoReloadWriteCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Auto-reload register write complete Callback */ 156 void (* DirectionUpCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Up-counting direction change Callback */ 157 void (* DirectionDownCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Down-counting direction change Callback */ 158 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 159 } LPTIM_HandleTypeDef; 160 161 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 162 /** 163 * @brief HAL LPTIM Callback ID enumeration definition 164 */ 165 typedef enum 166 { 167 HAL_LPTIM_MSPINIT_CB_ID = 0x00U, /*!< LPTIM Base Msp Init Callback ID */ 168 HAL_LPTIM_MSPDEINIT_CB_ID = 0x01U, /*!< LPTIM Base Msp DeInit Callback ID */ 169 HAL_LPTIM_COMPARE_MATCH_CB_ID = 0x02U, /*!< Compare match Callback ID */ 170 HAL_LPTIM_AUTORELOAD_MATCH_CB_ID = 0x03U, /*!< Auto-reload match Callback ID */ 171 HAL_LPTIM_TRIGGER_CB_ID = 0x04U, /*!< External trigger event detection Callback ID */ 172 HAL_LPTIM_COMPARE_WRITE_CB_ID = 0x05U, /*!< Compare register write complete Callback ID */ 173 HAL_LPTIM_AUTORELOAD_WRITE_CB_ID = 0x06U, /*!< Auto-reload register write complete Callback ID */ 174 HAL_LPTIM_DIRECTION_UP_CB_ID = 0x07U, /*!< Up-counting direction change Callback ID */ 175 HAL_LPTIM_DIRECTION_DOWN_CB_ID = 0x08U, /*!< Down-counting direction change Callback ID */ 176 } HAL_LPTIM_CallbackIDTypeDef; 177 178 /** 179 * @brief HAL TIM Callback pointer definition 180 */ 181 typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< pointer to the LPTIM callback function */ 182 183 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 184 /** 185 * @} 186 */ 187 188 /* Exported constants --------------------------------------------------------*/ 189 /** @defgroup LPTIM_Exported_Constants LPTIM Exported Constants 190 * @{ 191 */ 192 193 /** @defgroup LPTIM_Clock_Source LPTIM Clock Source 194 * @{ 195 */ 196 #define LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC 0x00000000U 197 #define LPTIM_CLOCKSOURCE_ULPTIM LPTIM_CFGR_CKSEL 198 /** 199 * @} 200 */ 201 202 /** @defgroup LPTIM_Clock_Prescaler LPTIM Clock Prescaler 203 * @{ 204 */ 205 #define LPTIM_PRESCALER_DIV1 0x00000000U 206 #define LPTIM_PRESCALER_DIV2 LPTIM_CFGR_PRESC_0 207 #define LPTIM_PRESCALER_DIV4 LPTIM_CFGR_PRESC_1 208 #define LPTIM_PRESCALER_DIV8 (LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_1) 209 #define LPTIM_PRESCALER_DIV16 LPTIM_CFGR_PRESC_2 210 #define LPTIM_PRESCALER_DIV32 (LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_2) 211 #define LPTIM_PRESCALER_DIV64 (LPTIM_CFGR_PRESC_1 | LPTIM_CFGR_PRESC_2) 212 #define LPTIM_PRESCALER_DIV128 LPTIM_CFGR_PRESC 213 /** 214 * @} 215 */ 216 217 /** @defgroup LPTIM_Output_Polarity LPTIM Output Polarity 218 * @{ 219 */ 220 221 #define LPTIM_OUTPUTPOLARITY_HIGH 0x00000000U 222 #define LPTIM_OUTPUTPOLARITY_LOW LPTIM_CFGR_WAVPOL 223 /** 224 * @} 225 */ 226 227 /** @defgroup LPTIM_Clock_Sample_Time LPTIM Clock Sample Time 228 * @{ 229 */ 230 #define LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION 0x00000000U 231 #define LPTIM_CLOCKSAMPLETIME_2TRANSITIONS LPTIM_CFGR_CKFLT_0 232 #define LPTIM_CLOCKSAMPLETIME_4TRANSITIONS LPTIM_CFGR_CKFLT_1 233 #define LPTIM_CLOCKSAMPLETIME_8TRANSITIONS LPTIM_CFGR_CKFLT 234 /** 235 * @} 236 */ 237 238 /** @defgroup LPTIM_Clock_Polarity LPTIM Clock Polarity 239 * @{ 240 */ 241 #define LPTIM_CLOCKPOLARITY_RISING 0x00000000U 242 #define LPTIM_CLOCKPOLARITY_FALLING LPTIM_CFGR_CKPOL_0 243 #define LPTIM_CLOCKPOLARITY_RISING_FALLING LPTIM_CFGR_CKPOL_1 244 /** 245 * @} 246 */ 247 248 /** @defgroup LPTIM_Trigger_Source LPTIM Trigger Source 249 * @{ 250 */ 251 #define LPTIM_TRIGSOURCE_SOFTWARE 0x0000FFFFU 252 #define LPTIM_TRIGSOURCE_0 0x00000000U 253 #define LPTIM_TRIGSOURCE_1 LPTIM_CFGR_TRIGSEL_0 254 #define LPTIM_TRIGSOURCE_2 LPTIM_CFGR_TRIGSEL_1 255 #define LPTIM_TRIGSOURCE_3 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_1) 256 #define LPTIM_TRIGSOURCE_4 LPTIM_CFGR_TRIGSEL_2 257 #define LPTIM_TRIGSOURCE_5 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_2) 258 /** 259 * @} 260 */ 261 262 /** @defgroup LPTIM_External_Trigger_Polarity LPTIM External Trigger Polarity 263 * @{ 264 */ 265 #define LPTIM_ACTIVEEDGE_RISING LPTIM_CFGR_TRIGEN_0 266 #define LPTIM_ACTIVEEDGE_FALLING LPTIM_CFGR_TRIGEN_1 267 #define LPTIM_ACTIVEEDGE_RISING_FALLING LPTIM_CFGR_TRIGEN 268 /** 269 * @} 270 */ 271 272 /** @defgroup LPTIM_Trigger_Sample_Time LPTIM Trigger Sample Time 273 * @{ 274 */ 275 #define LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION 0x00000000U 276 #define LPTIM_TRIGSAMPLETIME_2TRANSITIONS LPTIM_CFGR_TRGFLT_0 277 #define LPTIM_TRIGSAMPLETIME_4TRANSITIONS LPTIM_CFGR_TRGFLT_1 278 #define LPTIM_TRIGSAMPLETIME_8TRANSITIONS LPTIM_CFGR_TRGFLT 279 /** 280 * @} 281 */ 282 283 /** @defgroup LPTIM_Updating_Mode LPTIM Updating Mode 284 * @{ 285 */ 286 287 #define LPTIM_UPDATE_IMMEDIATE 0x00000000U 288 #define LPTIM_UPDATE_ENDOFPERIOD LPTIM_CFGR_PRELOAD 289 /** 290 * @} 291 */ 292 293 /** @defgroup LPTIM_Counter_Source LPTIM Counter Source 294 * @{ 295 */ 296 297 #define LPTIM_COUNTERSOURCE_INTERNAL 0x00000000U 298 #define LPTIM_COUNTERSOURCE_EXTERNAL LPTIM_CFGR_COUNTMODE 299 /** 300 * @} 301 */ 302 303 /** @defgroup LPTIM_Flag_Definition LPTIM Flags Definition 304 * @{ 305 */ 306 307 #define LPTIM_FLAG_DOWN LPTIM_ISR_DOWN 308 #define LPTIM_FLAG_UP LPTIM_ISR_UP 309 #define LPTIM_FLAG_ARROK LPTIM_ISR_ARROK 310 #define LPTIM_FLAG_CMPOK LPTIM_ISR_CMPOK 311 #define LPTIM_FLAG_EXTTRIG LPTIM_ISR_EXTTRIG 312 #define LPTIM_FLAG_ARRM LPTIM_ISR_ARRM 313 #define LPTIM_FLAG_CMPM LPTIM_ISR_CMPM 314 /** 315 * @} 316 */ 317 318 /** @defgroup LPTIM_Interrupts_Definition LPTIM Interrupts Definition 319 * @{ 320 */ 321 #define LPTIM_IT_DOWN LPTIM_IER_DOWNIE 322 #define LPTIM_IT_UP LPTIM_IER_UPIE 323 #define LPTIM_IT_ARROK LPTIM_IER_ARROKIE 324 #define LPTIM_IT_CMPOK LPTIM_IER_CMPOKIE 325 #define LPTIM_IT_EXTTRIG LPTIM_IER_EXTTRIGIE 326 #define LPTIM_IT_ARRM LPTIM_IER_ARRMIE 327 #define LPTIM_IT_CMPM LPTIM_IER_CMPMIE 328 /** 329 * @} 330 */ 331 332 /** 333 * @} 334 */ 335 336 /* Exported macros -----------------------------------------------------------*/ 337 /** @defgroup LPTIM_Exported_Macros LPTIM Exported Macros 338 * @{ 339 */ 340 341 /** @brief Reset LPTIM handle state. 342 * @param __HANDLE__ LPTIM handle 343 * @retval None 344 */ 345 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 346 #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) do { \ 347 (__HANDLE__)->State = HAL_LPTIM_STATE_RESET; \ 348 (__HANDLE__)->MspInitCallback = NULL; \ 349 (__HANDLE__)->MspDeInitCallback = NULL; \ 350 } while(0) 351 #else 352 #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LPTIM_STATE_RESET) 353 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 354 355 /** 356 * @brief Enable the LPTIM peripheral. 357 * @param __HANDLE__ LPTIM handle 358 * @retval None 359 */ 360 #define __HAL_LPTIM_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE)) 361 362 /** 363 * @brief Disable the LPTIM peripheral. 364 * @param __HANDLE__ LPTIM handle 365 * @note The following sequence is required to solve LPTIM disable HW limitation. 366 * Please check Errata Sheet ES0335 for more details under "MCU may remain 367 * stuck in LPTIM interrupt when entering Stop mode" section. 368 * @note Please call @ref HAL_LPTIM_GetState() after a call to __HAL_LPTIM_DISABLE to 369 * check for TIMEOUT. 370 * @retval None 371 */ 372 #define __HAL_LPTIM_DISABLE(__HANDLE__) LPTIM_Disable(__HANDLE__) 373 374 /** 375 * @brief Start the LPTIM peripheral in Continuous mode. 376 * @param __HANDLE__ LPTIM handle 377 * @retval None 378 */ 379 #define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT) 380 /** 381 * @brief Start the LPTIM peripheral in single mode. 382 * @param __HANDLE__ LPTIM handle 383 * @retval None 384 */ 385 #define __HAL_LPTIM_START_SINGLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT) 386 387 /** 388 * @brief Write the passed parameter in the Autoreload register. 389 * @param __HANDLE__ LPTIM handle 390 * @param __VALUE__ Autoreload value 391 * @retval None 392 * @note The ARR register can only be modified when the LPTIM instance is enabled. 393 */ 394 #define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->ARR = (__VALUE__)) 395 396 /** 397 * @brief Write the passed parameter in the Compare register. 398 * @param __HANDLE__ LPTIM handle 399 * @param __VALUE__ Compare value 400 * @retval None 401 * @note The CMP register can only be modified when the LPTIM instance is enabled. 402 */ 403 #define __HAL_LPTIM_COMPARE_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->CMP = (__VALUE__)) 404 405 /** 406 * @brief Check whether the specified LPTIM flag is set or not. 407 * @param __HANDLE__ LPTIM handle 408 * @param __FLAG__ LPTIM flag to check 409 * This parameter can be a value of: 410 * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag. 411 * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag. 412 * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag. 413 * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag. 414 * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag. 415 * @arg LPTIM_FLAG_ARRM : Autoreload match Flag. 416 * @arg LPTIM_FLAG_CMPM : Compare match Flag. 417 * @retval The state of the specified flag (SET or RESET). 418 */ 419 #define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__)) 420 421 /** 422 * @brief Clear the specified LPTIM flag. 423 * @param __HANDLE__ LPTIM handle. 424 * @param __FLAG__ LPTIM flag to clear. 425 * This parameter can be a value of: 426 * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag. 427 * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag. 428 * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag. 429 * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag. 430 * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag. 431 * @arg LPTIM_FLAG_ARRM : Autoreload match Flag. 432 * @arg LPTIM_FLAG_CMPM : Compare match Flag. 433 * @retval None. 434 */ 435 #define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 436 437 /** 438 * @brief Enable the specified LPTIM interrupt. 439 * @param __HANDLE__ LPTIM handle. 440 * @param __INTERRUPT__ LPTIM interrupt to set. 441 * This parameter can be a value of: 442 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 443 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 444 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 445 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 446 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 447 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 448 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 449 * @retval None. 450 * @note The LPTIM interrupts can only be enabled when the LPTIM instance is disabled. 451 */ 452 #define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__)) 453 454 /** 455 * @brief Disable the specified LPTIM interrupt. 456 * @param __HANDLE__ LPTIM handle. 457 * @param __INTERRUPT__ LPTIM interrupt to set. 458 * This parameter can be a value of: 459 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 460 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 461 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 462 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 463 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 464 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 465 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 466 * @retval None. 467 * @note The LPTIM interrupts can only be disabled when the LPTIM instance is disabled. 468 */ 469 #define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__))) 470 471 /** 472 * @brief Check whether the specified LPTIM interrupt source is enabled or not. 473 * @param __HANDLE__ LPTIM handle. 474 * @param __INTERRUPT__ LPTIM interrupt to check. 475 * This parameter can be a value of: 476 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 477 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 478 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 479 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 480 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 481 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 482 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 483 * @retval Interrupt status. 484 */ 485 486 #define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER\ 487 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET) 488 489 /** 490 * @brief Enable interrupt on the LPTIM Wake-up Timer associated Exti line. 491 * @retval None 492 */ 493 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT() (EXTI->IMR\ 494 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 495 496 /** 497 * @brief Disable interrupt on the LPTIM Wake-up Timer associated Exti line. 498 * @retval None 499 */ 500 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT() (EXTI->IMR\ 501 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 502 503 /** 504 * @brief Enable event on the LPTIM Wake-up Timer associated Exti line. 505 * @retval None. 506 */ 507 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT() (EXTI->EMR\ 508 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 509 510 /** 511 * @brief Disable event on the LPTIM Wake-up Timer associated Exti line. 512 * @retval None. 513 */ 514 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT() (EXTI->EMR\ 515 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 516 517 /** 518 * @brief Enable falling edge trigger on the LPTIM Wake-up Timer associated Exti line. 519 * @retval None. 520 */ 521 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE() (EXTI->FTSR\ 522 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 523 524 /** 525 * @brief Disable falling edge trigger on the LPTIM Wake-up Timer associated Exti line. 526 * @retval None. 527 */ 528 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE() (EXTI->FTSR\ 529 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 530 531 /** 532 * @brief Enable rising edge trigger on the LPTIM Wake-up Timer associated Exti line. 533 * @retval None. 534 */ 535 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE() (EXTI->RTSR\ 536 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 537 538 /** 539 * @brief Disable rising edge trigger on the LPTIM Wake-up Timer associated Exti line. 540 * @retval None. 541 */ 542 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE() (EXTI->RTSR\ 543 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 544 545 /** 546 * @brief Enable rising & falling edge trigger on the LPTIM Wake-up Timer associated Exti line. 547 * @retval None. 548 */ 549 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_FALLING_EDGE() do{__HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE();\ 550 __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE();\ 551 }while(0) 552 553 /** 554 * @brief Disable rising & falling edge trigger on the LPTIM Wake-up Timer associated Exti line. 555 * @retval None. 556 */ 557 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_FALLING_EDGE() do{__HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE();\ 558 __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE();\ 559 }while(0) 560 561 /** 562 * @brief Check whether the LPTIM Wake-up Timer associated Exti line interrupt flag is set or not. 563 * @retval Line Status. 564 */ 565 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_GET_FLAG() (EXTI->PR\ 566 & LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 567 568 /** 569 * @brief Clear the LPTIM Wake-up Timer associated Exti line flag. 570 * @retval None. 571 */ 572 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_CLEAR_FLAG() (EXTI->PR\ 573 = LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 574 575 /** 576 * @brief Generate a Software interrupt on the LPTIM Wake-up Timer associated Exti line. 577 * @retval None. 578 */ 579 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_GENERATE_SWIT() (EXTI->SWIER\ 580 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 581 582 /** 583 * @} 584 */ 585 586 /* Exported functions --------------------------------------------------------*/ 587 /** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions 588 * @{ 589 */ 590 591 /** @addtogroup LPTIM_Exported_Functions_Group1 592 * @brief Initialization and Configuration functions. 593 * @{ 594 */ 595 /* Initialization/de-initialization functions ********************************/ 596 HAL_StatusTypeDef HAL_LPTIM_Init(LPTIM_HandleTypeDef *hlptim); 597 HAL_StatusTypeDef HAL_LPTIM_DeInit(LPTIM_HandleTypeDef *hlptim); 598 599 /* MSP functions *************************************************************/ 600 void HAL_LPTIM_MspInit(LPTIM_HandleTypeDef *hlptim); 601 void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef *hlptim); 602 /** 603 * @} 604 */ 605 606 /** @addtogroup LPTIM_Exported_Functions_Group2 607 * @brief Start-Stop operation functions. 608 * @{ 609 */ 610 /* Start/Stop operation functions *********************************************/ 611 /* ################################# PWM Mode ################################*/ 612 /* Blocking mode: Polling */ 613 HAL_StatusTypeDef HAL_LPTIM_PWM_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 614 HAL_StatusTypeDef HAL_LPTIM_PWM_Stop(LPTIM_HandleTypeDef *hlptim); 615 /* Non-Blocking mode: Interrupt */ 616 HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 617 HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT(LPTIM_HandleTypeDef *hlptim); 618 619 /* ############################# One Pulse Mode ##############################*/ 620 /* Blocking mode: Polling */ 621 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 622 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop(LPTIM_HandleTypeDef *hlptim); 623 /* Non-Blocking mode: Interrupt */ 624 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 625 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT(LPTIM_HandleTypeDef *hlptim); 626 627 /* ############################## Set once Mode ##############################*/ 628 /* Blocking mode: Polling */ 629 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 630 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop(LPTIM_HandleTypeDef *hlptim); 631 /* Non-Blocking mode: Interrupt */ 632 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 633 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT(LPTIM_HandleTypeDef *hlptim); 634 635 /* ############################### Encoder Mode ##############################*/ 636 /* Blocking mode: Polling */ 637 HAL_StatusTypeDef HAL_LPTIM_Encoder_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 638 HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop(LPTIM_HandleTypeDef *hlptim); 639 /* Non-Blocking mode: Interrupt */ 640 HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 641 HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT(LPTIM_HandleTypeDef *hlptim); 642 643 /* ############################# Time out Mode ##############################*/ 644 /* Blocking mode: Polling */ 645 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout); 646 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop(LPTIM_HandleTypeDef *hlptim); 647 /* Non-Blocking mode: Interrupt */ 648 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout); 649 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT(LPTIM_HandleTypeDef *hlptim); 650 651 /* ############################## Counter Mode ###############################*/ 652 /* Blocking mode: Polling */ 653 HAL_StatusTypeDef HAL_LPTIM_Counter_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 654 HAL_StatusTypeDef HAL_LPTIM_Counter_Stop(LPTIM_HandleTypeDef *hlptim); 655 /* Non-Blocking mode: Interrupt */ 656 HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 657 HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef *hlptim); 658 /** 659 * @} 660 */ 661 662 /** @addtogroup LPTIM_Exported_Functions_Group3 663 * @brief Read operation functions. 664 * @{ 665 */ 666 /* Reading operation functions ************************************************/ 667 uint32_t HAL_LPTIM_ReadCounter(const LPTIM_HandleTypeDef *hlptim); 668 uint32_t HAL_LPTIM_ReadAutoReload(const LPTIM_HandleTypeDef *hlptim); 669 uint32_t HAL_LPTIM_ReadCompare(const LPTIM_HandleTypeDef *hlptim); 670 /** 671 * @} 672 */ 673 674 /** @addtogroup LPTIM_Exported_Functions_Group4 675 * @brief LPTIM IRQ handler and callback functions. 676 * @{ 677 */ 678 /* LPTIM IRQ functions *******************************************************/ 679 void HAL_LPTIM_IRQHandler(LPTIM_HandleTypeDef *hlptim); 680 681 /* CallBack functions ********************************************************/ 682 void HAL_LPTIM_CompareMatchCallback(LPTIM_HandleTypeDef *hlptim); 683 void HAL_LPTIM_AutoReloadMatchCallback(LPTIM_HandleTypeDef *hlptim); 684 void HAL_LPTIM_TriggerCallback(LPTIM_HandleTypeDef *hlptim); 685 void HAL_LPTIM_CompareWriteCallback(LPTIM_HandleTypeDef *hlptim); 686 void HAL_LPTIM_AutoReloadWriteCallback(LPTIM_HandleTypeDef *hlptim); 687 void HAL_LPTIM_DirectionUpCallback(LPTIM_HandleTypeDef *hlptim); 688 void HAL_LPTIM_DirectionDownCallback(LPTIM_HandleTypeDef *hlptim); 689 690 /* Callbacks Register/UnRegister functions ***********************************/ 691 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 692 HAL_StatusTypeDef HAL_LPTIM_RegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID, 693 pLPTIM_CallbackTypeDef pCallback); 694 HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID); 695 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 696 /** 697 * @} 698 */ 699 700 /** @addtogroup LPTIM_Group5 701 * @brief Peripheral State functions. 702 * @{ 703 */ 704 /* Peripheral State functions ************************************************/ 705 HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim); 706 /** 707 * @} 708 */ 709 710 /** 711 * @} 712 */ 713 714 /* Private types -------------------------------------------------------------*/ 715 /** @defgroup LPTIM_Private_Types LPTIM Private Types 716 * @{ 717 */ 718 719 /** 720 * @} 721 */ 722 723 /* Private variables ---------------------------------------------------------*/ 724 /** @defgroup LPTIM_Private_Variables LPTIM Private Variables 725 * @{ 726 */ 727 728 /** 729 * @} 730 */ 731 732 /* Private constants ---------------------------------------------------------*/ 733 /** @defgroup LPTIM_Private_Constants LPTIM Private Constants 734 * @{ 735 */ 736 737 /** 738 * @} 739 */ 740 741 /* Private macros ------------------------------------------------------------*/ 742 /** @defgroup LPTIM_Private_Macros LPTIM Private Macros 743 * @{ 744 */ 745 746 #define IS_LPTIM_CLOCK_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_CLOCKSOURCE_ULPTIM) || \ 747 ((__SOURCE__) == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC)) 748 749 750 #define IS_LPTIM_CLOCK_PRESCALER(__PRESCALER__) (((__PRESCALER__) == LPTIM_PRESCALER_DIV1 ) || \ 751 ((__PRESCALER__) == LPTIM_PRESCALER_DIV2 ) || \ 752 ((__PRESCALER__) == LPTIM_PRESCALER_DIV4 ) || \ 753 ((__PRESCALER__) == LPTIM_PRESCALER_DIV8 ) || \ 754 ((__PRESCALER__) == LPTIM_PRESCALER_DIV16 ) || \ 755 ((__PRESCALER__) == LPTIM_PRESCALER_DIV32 ) || \ 756 ((__PRESCALER__) == LPTIM_PRESCALER_DIV64 ) || \ 757 ((__PRESCALER__) == LPTIM_PRESCALER_DIV128)) 758 759 #define IS_LPTIM_CLOCK_PRESCALERDIV1(__PRESCALER__) ((__PRESCALER__) == LPTIM_PRESCALER_DIV1) 760 761 #define IS_LPTIM_OUTPUT_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_OUTPUTPOLARITY_LOW ) || \ 762 ((__POLARITY__) == LPTIM_OUTPUTPOLARITY_HIGH)) 763 764 #define IS_LPTIM_CLOCK_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION) || \ 765 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_2TRANSITIONS) || \ 766 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_4TRANSITIONS) || \ 767 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_8TRANSITIONS)) 768 769 #define IS_LPTIM_CLOCK_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING) || \ 770 ((__POLARITY__) == LPTIM_CLOCKPOLARITY_FALLING) || \ 771 ((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING_FALLING)) 772 773 #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \ 774 ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \ 775 ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \ 776 ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \ 777 ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \ 778 ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \ 779 ((__TRIG__) == LPTIM_TRIGSOURCE_5)) 780 781 #define IS_LPTIM_EXT_TRG_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING ) || \ 782 ((__POLARITY__) == LPTIM_ACTIVEEDGE_FALLING ) || \ 783 ((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING_FALLING )) 784 785 #define IS_LPTIM_TRIG_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION) || \ 786 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_2TRANSITIONS ) || \ 787 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_4TRANSITIONS ) || \ 788 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_8TRANSITIONS )) 789 790 #define IS_LPTIM_UPDATE_MODE(__MODE__) (((__MODE__) == LPTIM_UPDATE_IMMEDIATE) || \ 791 ((__MODE__) == LPTIM_UPDATE_ENDOFPERIOD)) 792 793 #define IS_LPTIM_COUNTER_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_COUNTERSOURCE_INTERNAL) || \ 794 ((__SOURCE__) == LPTIM_COUNTERSOURCE_EXTERNAL)) 795 796 #define IS_LPTIM_AUTORELOAD(__AUTORELOAD__) ((0x00000001UL <= (__AUTORELOAD__)) &&\ 797 ((__AUTORELOAD__) <= 0x0000FFFFUL)) 798 799 #define IS_LPTIM_COMPARE(__COMPARE__) ((__COMPARE__) <= 0x0000FFFFUL) 800 801 #define IS_LPTIM_PERIOD(__PERIOD__) ((0x00000001UL <= (__PERIOD__)) &&\ 802 ((__PERIOD__) <= 0x0000FFFFUL)) 803 804 #define IS_LPTIM_PULSE(__PULSE__) ((__PULSE__) <= 0x0000FFFFUL) 805 806 /** 807 * @} 808 */ 809 810 /* Private functions ---------------------------------------------------------*/ 811 /** @defgroup LPTIM_Private_Functions LPTIM Private Functions 812 * @{ 813 */ 814 void LPTIM_Disable(LPTIM_HandleTypeDef *hlptim); 815 /** 816 * @} 817 */ 818 819 /** 820 * @} 821 */ 822 823 #endif /* LPTIM1 */ 824 /** 825 * @} 826 */ 827 828 #ifdef __cplusplus 829 } 830 #endif 831 832 #endif /* STM32F7xx_HAL_LPTIM_H */ 833
