1 /** 2 ****************************************************************************** 3 * @file stm32l0xx_hal_lptim.h 4 * @author MCD Application Team 5 * @brief Header file of LPTIM HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2016 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 STM32L0xx_HAL_LPTIM_H 21 #define STM32L0xx_HAL_LPTIM_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32l0xx_hal_def.h" 29 30 /** @addtogroup STM32L0xx_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_IM29 /*!< External interrupt line 29 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 #define LPTIM_TRIGSOURCE_6 (LPTIM_CFGR_TRIGSEL_1 | LPTIM_CFGR_TRIGSEL_2) 259 #define LPTIM_TRIGSOURCE_7 LPTIM_CFGR_TRIGSEL 260 /** 261 * @} 262 */ 263 264 /** @defgroup LPTIM_External_Trigger_Polarity LPTIM External Trigger Polarity 265 * @{ 266 */ 267 #define LPTIM_ACTIVEEDGE_RISING LPTIM_CFGR_TRIGEN_0 268 #define LPTIM_ACTIVEEDGE_FALLING LPTIM_CFGR_TRIGEN_1 269 #define LPTIM_ACTIVEEDGE_RISING_FALLING LPTIM_CFGR_TRIGEN 270 /** 271 * @} 272 */ 273 274 /** @defgroup LPTIM_Trigger_Sample_Time LPTIM Trigger Sample Time 275 * @{ 276 */ 277 #define LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION 0x00000000U 278 #define LPTIM_TRIGSAMPLETIME_2TRANSITIONS LPTIM_CFGR_TRGFLT_0 279 #define LPTIM_TRIGSAMPLETIME_4TRANSITIONS LPTIM_CFGR_TRGFLT_1 280 #define LPTIM_TRIGSAMPLETIME_8TRANSITIONS LPTIM_CFGR_TRGFLT 281 /** 282 * @} 283 */ 284 285 /** @defgroup LPTIM_Updating_Mode LPTIM Updating Mode 286 * @{ 287 */ 288 289 #define LPTIM_UPDATE_IMMEDIATE 0x00000000U 290 #define LPTIM_UPDATE_ENDOFPERIOD LPTIM_CFGR_PRELOAD 291 /** 292 * @} 293 */ 294 295 /** @defgroup LPTIM_Counter_Source LPTIM Counter Source 296 * @{ 297 */ 298 299 #define LPTIM_COUNTERSOURCE_INTERNAL 0x00000000U 300 #define LPTIM_COUNTERSOURCE_EXTERNAL LPTIM_CFGR_COUNTMODE 301 /** 302 * @} 303 */ 304 305 /** @defgroup LPTIM_Flag_Definition LPTIM Flags Definition 306 * @{ 307 */ 308 309 #define LPTIM_FLAG_DOWN LPTIM_ISR_DOWN 310 #define LPTIM_FLAG_UP LPTIM_ISR_UP 311 #define LPTIM_FLAG_ARROK LPTIM_ISR_ARROK 312 #define LPTIM_FLAG_CMPOK LPTIM_ISR_CMPOK 313 #define LPTIM_FLAG_EXTTRIG LPTIM_ISR_EXTTRIG 314 #define LPTIM_FLAG_ARRM LPTIM_ISR_ARRM 315 #define LPTIM_FLAG_CMPM LPTIM_ISR_CMPM 316 /** 317 * @} 318 */ 319 320 /** @defgroup LPTIM_Interrupts_Definition LPTIM Interrupts Definition 321 * @{ 322 */ 323 #define LPTIM_IT_DOWN LPTIM_IER_DOWNIE 324 #define LPTIM_IT_UP LPTIM_IER_UPIE 325 #define LPTIM_IT_ARROK LPTIM_IER_ARROKIE 326 #define LPTIM_IT_CMPOK LPTIM_IER_CMPOKIE 327 #define LPTIM_IT_EXTTRIG LPTIM_IER_EXTTRIGIE 328 #define LPTIM_IT_ARRM LPTIM_IER_ARRMIE 329 #define LPTIM_IT_CMPM LPTIM_IER_CMPMIE 330 /** 331 * @} 332 */ 333 334 /** 335 * @} 336 */ 337 338 /* Exported macros -----------------------------------------------------------*/ 339 /** @defgroup LPTIM_Exported_Macros LPTIM Exported Macros 340 * @{ 341 */ 342 343 /** @brief Reset LPTIM handle state. 344 * @param __HANDLE__ LPTIM handle 345 * @retval None 346 */ 347 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 348 #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) do { \ 349 (__HANDLE__)->State = HAL_LPTIM_STATE_RESET; \ 350 (__HANDLE__)->MspInitCallback = NULL; \ 351 (__HANDLE__)->MspDeInitCallback = NULL; \ 352 } while(0) 353 #else 354 #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LPTIM_STATE_RESET) 355 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 356 357 /** 358 * @brief Enable the LPTIM peripheral. 359 * @param __HANDLE__ LPTIM handle 360 * @retval None 361 */ 362 #define __HAL_LPTIM_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE)) 363 364 /** 365 * @brief Disable the LPTIM peripheral. 366 * @param __HANDLE__ LPTIM handle 367 * @note The following sequence is required to solve LPTIM disable HW limitation. 368 * Please check Errata Sheet ES0335 for more details under "MCU may remain 369 * stuck in LPTIM interrupt when entering Stop mode" section. 370 * @note Please call @ref HAL_LPTIM_GetState() after a call to __HAL_LPTIM_DISABLE to 371 * check for TIMEOUT. 372 * @retval None 373 */ 374 #define __HAL_LPTIM_DISABLE(__HANDLE__) LPTIM_Disable(__HANDLE__) 375 376 /** 377 * @brief Start the LPTIM peripheral in Continuous mode. 378 * @param __HANDLE__ LPTIM handle 379 * @retval None 380 */ 381 #define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT) 382 /** 383 * @brief Start the LPTIM peripheral in single mode. 384 * @param __HANDLE__ LPTIM handle 385 * @retval None 386 */ 387 #define __HAL_LPTIM_START_SINGLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT) 388 389 /** 390 * @brief Write the passed parameter in the Autoreload register. 391 * @param __HANDLE__ LPTIM handle 392 * @param __VALUE__ Autoreload value 393 * @retval None 394 * @note The ARR register can only be modified when the LPTIM instance is enabled. 395 */ 396 #define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->ARR = (__VALUE__)) 397 398 /** 399 * @brief Write the passed parameter in the Compare register. 400 * @param __HANDLE__ LPTIM handle 401 * @param __VALUE__ Compare value 402 * @retval None 403 * @note The CMP register can only be modified when the LPTIM instance is enabled. 404 */ 405 #define __HAL_LPTIM_COMPARE_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->CMP = (__VALUE__)) 406 407 /** 408 * @brief Check whether the specified LPTIM flag is set or not. 409 * @param __HANDLE__ LPTIM handle 410 * @param __FLAG__ LPTIM flag to check 411 * This parameter can be a value of: 412 * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag. 413 * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag. 414 * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag. 415 * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag. 416 * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag. 417 * @arg LPTIM_FLAG_ARRM : Autoreload match Flag. 418 * @arg LPTIM_FLAG_CMPM : Compare match Flag. 419 * @retval The state of the specified flag (SET or RESET). 420 */ 421 #define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__)) 422 423 /** 424 * @brief Clear the specified LPTIM flag. 425 * @param __HANDLE__ LPTIM handle. 426 * @param __FLAG__ LPTIM flag to clear. 427 * This parameter can be a value of: 428 * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag. 429 * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag. 430 * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag. 431 * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag. 432 * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag. 433 * @arg LPTIM_FLAG_ARRM : Autoreload match Flag. 434 * @arg LPTIM_FLAG_CMPM : Compare match Flag. 435 * @retval None. 436 */ 437 #define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 438 439 /** 440 * @brief Enable the specified LPTIM interrupt. 441 * @param __HANDLE__ LPTIM handle. 442 * @param __INTERRUPT__ LPTIM interrupt to set. 443 * This parameter can be a value of: 444 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 445 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 446 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 447 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 448 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 449 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 450 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 451 * @retval None. 452 * @note The LPTIM interrupts can only be enabled when the LPTIM instance is disabled. 453 */ 454 #define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__)) 455 456 /** 457 * @brief Disable the specified LPTIM interrupt. 458 * @param __HANDLE__ LPTIM handle. 459 * @param __INTERRUPT__ LPTIM interrupt to set. 460 * This parameter can be a value of: 461 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 462 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 463 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 464 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 465 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 466 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 467 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 468 * @retval None. 469 * @note The LPTIM interrupts can only be disabled when the LPTIM instance is disabled. 470 */ 471 #define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__))) 472 473 /** 474 * @brief Check whether the specified LPTIM interrupt source is enabled or not. 475 * @param __HANDLE__ LPTIM handle. 476 * @param __INTERRUPT__ LPTIM interrupt to check. 477 * This parameter can be a value of: 478 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 479 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 480 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 481 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 482 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 483 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 484 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 485 * @retval Interrupt status. 486 */ 487 488 #define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER\ 489 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET) 490 491 /** 492 * @brief Enable interrupt on the LPTIM Wake-up Timer associated Exti line. 493 * @retval None 494 */ 495 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT() (EXTI->IMR\ 496 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 497 498 /** 499 * @brief Disable interrupt on the LPTIM Wake-up Timer associated Exti line. 500 * @retval None 501 */ 502 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT() (EXTI->IMR\ 503 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 504 505 /** 506 * @brief Enable event on the LPTIM Wake-up Timer associated Exti line. 507 * @retval None. 508 */ 509 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT() (EXTI->EMR\ 510 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 511 512 /** 513 * @brief Disable event on the LPTIM Wake-up Timer associated Exti line. 514 * @retval None. 515 */ 516 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT() (EXTI->EMR\ 517 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 518 519 /** 520 * @} 521 */ 522 523 /* Exported functions --------------------------------------------------------*/ 524 /** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions 525 * @{ 526 */ 527 528 /** @addtogroup LPTIM_Exported_Functions_Group1 529 * @brief Initialization and Configuration functions. 530 * @{ 531 */ 532 /* Initialization/de-initialization functions ********************************/ 533 HAL_StatusTypeDef HAL_LPTIM_Init(LPTIM_HandleTypeDef *hlptim); 534 HAL_StatusTypeDef HAL_LPTIM_DeInit(LPTIM_HandleTypeDef *hlptim); 535 536 /* MSP functions *************************************************************/ 537 void HAL_LPTIM_MspInit(LPTIM_HandleTypeDef *hlptim); 538 void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef *hlptim); 539 /** 540 * @} 541 */ 542 543 /** @addtogroup LPTIM_Exported_Functions_Group2 544 * @brief Start-Stop operation functions. 545 * @{ 546 */ 547 /* Start/Stop operation functions *********************************************/ 548 /* ################################# PWM Mode ################################*/ 549 /* Blocking mode: Polling */ 550 HAL_StatusTypeDef HAL_LPTIM_PWM_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 551 HAL_StatusTypeDef HAL_LPTIM_PWM_Stop(LPTIM_HandleTypeDef *hlptim); 552 /* Non-Blocking mode: Interrupt */ 553 HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 554 HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT(LPTIM_HandleTypeDef *hlptim); 555 556 /* ############################# One Pulse Mode ##############################*/ 557 /* Blocking mode: Polling */ 558 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 559 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop(LPTIM_HandleTypeDef *hlptim); 560 /* Non-Blocking mode: Interrupt */ 561 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 562 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT(LPTIM_HandleTypeDef *hlptim); 563 564 /* ############################## Set once Mode ##############################*/ 565 /* Blocking mode: Polling */ 566 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 567 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop(LPTIM_HandleTypeDef *hlptim); 568 /* Non-Blocking mode: Interrupt */ 569 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 570 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT(LPTIM_HandleTypeDef *hlptim); 571 572 /* ############################### Encoder Mode ##############################*/ 573 /* Blocking mode: Polling */ 574 HAL_StatusTypeDef HAL_LPTIM_Encoder_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 575 HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop(LPTIM_HandleTypeDef *hlptim); 576 /* Non-Blocking mode: Interrupt */ 577 HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 578 HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT(LPTIM_HandleTypeDef *hlptim); 579 580 /* ############################# Time out Mode ##############################*/ 581 /* Blocking mode: Polling */ 582 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout); 583 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop(LPTIM_HandleTypeDef *hlptim); 584 /* Non-Blocking mode: Interrupt */ 585 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout); 586 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT(LPTIM_HandleTypeDef *hlptim); 587 588 /* ############################## Counter Mode ###############################*/ 589 /* Blocking mode: Polling */ 590 HAL_StatusTypeDef HAL_LPTIM_Counter_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 591 HAL_StatusTypeDef HAL_LPTIM_Counter_Stop(LPTIM_HandleTypeDef *hlptim); 592 /* Non-Blocking mode: Interrupt */ 593 HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 594 HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef *hlptim); 595 /** 596 * @} 597 */ 598 599 /** @addtogroup LPTIM_Exported_Functions_Group3 600 * @brief Read operation functions. 601 * @{ 602 */ 603 /* Reading operation functions ************************************************/ 604 uint32_t HAL_LPTIM_ReadCounter(const LPTIM_HandleTypeDef *hlptim); 605 uint32_t HAL_LPTIM_ReadAutoReload(const LPTIM_HandleTypeDef *hlptim); 606 uint32_t HAL_LPTIM_ReadCompare(const LPTIM_HandleTypeDef *hlptim); 607 /** 608 * @} 609 */ 610 611 /** @addtogroup LPTIM_Exported_Functions_Group4 612 * @brief LPTIM IRQ handler and callback functions. 613 * @{ 614 */ 615 /* LPTIM IRQ functions *******************************************************/ 616 void HAL_LPTIM_IRQHandler(LPTIM_HandleTypeDef *hlptim); 617 618 /* CallBack functions ********************************************************/ 619 void HAL_LPTIM_CompareMatchCallback(LPTIM_HandleTypeDef *hlptim); 620 void HAL_LPTIM_AutoReloadMatchCallback(LPTIM_HandleTypeDef *hlptim); 621 void HAL_LPTIM_TriggerCallback(LPTIM_HandleTypeDef *hlptim); 622 void HAL_LPTIM_CompareWriteCallback(LPTIM_HandleTypeDef *hlptim); 623 void HAL_LPTIM_AutoReloadWriteCallback(LPTIM_HandleTypeDef *hlptim); 624 void HAL_LPTIM_DirectionUpCallback(LPTIM_HandleTypeDef *hlptim); 625 void HAL_LPTIM_DirectionDownCallback(LPTIM_HandleTypeDef *hlptim); 626 627 /* Callbacks Register/UnRegister functions ***********************************/ 628 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 629 HAL_StatusTypeDef HAL_LPTIM_RegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID, 630 pLPTIM_CallbackTypeDef pCallback); 631 HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID); 632 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 633 /** 634 * @} 635 */ 636 637 /** @addtogroup LPTIM_Group5 638 * @brief Peripheral State functions. 639 * @{ 640 */ 641 /* Peripheral State functions ************************************************/ 642 HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(const LPTIM_HandleTypeDef *hlptim); 643 /** 644 * @} 645 */ 646 647 /** 648 * @} 649 */ 650 651 /* Private types -------------------------------------------------------------*/ 652 /** @defgroup LPTIM_Private_Types LPTIM Private Types 653 * @{ 654 */ 655 656 /** 657 * @} 658 */ 659 660 /* Private variables ---------------------------------------------------------*/ 661 /** @defgroup LPTIM_Private_Variables LPTIM Private Variables 662 * @{ 663 */ 664 665 /** 666 * @} 667 */ 668 669 /* Private constants ---------------------------------------------------------*/ 670 /** @defgroup LPTIM_Private_Constants LPTIM Private Constants 671 * @{ 672 */ 673 674 /** 675 * @} 676 */ 677 678 /* Private macros ------------------------------------------------------------*/ 679 /** @defgroup LPTIM_Private_Macros LPTIM Private Macros 680 * @{ 681 */ 682 683 #define IS_LPTIM_CLOCK_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_CLOCKSOURCE_ULPTIM) || \ 684 ((__SOURCE__) == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC)) 685 686 687 #define IS_LPTIM_CLOCK_PRESCALER(__PRESCALER__) (((__PRESCALER__) == LPTIM_PRESCALER_DIV1 ) || \ 688 ((__PRESCALER__) == LPTIM_PRESCALER_DIV2 ) || \ 689 ((__PRESCALER__) == LPTIM_PRESCALER_DIV4 ) || \ 690 ((__PRESCALER__) == LPTIM_PRESCALER_DIV8 ) || \ 691 ((__PRESCALER__) == LPTIM_PRESCALER_DIV16 ) || \ 692 ((__PRESCALER__) == LPTIM_PRESCALER_DIV32 ) || \ 693 ((__PRESCALER__) == LPTIM_PRESCALER_DIV64 ) || \ 694 ((__PRESCALER__) == LPTIM_PRESCALER_DIV128)) 695 696 #define IS_LPTIM_CLOCK_PRESCALERDIV1(__PRESCALER__) ((__PRESCALER__) == LPTIM_PRESCALER_DIV1) 697 698 #define IS_LPTIM_OUTPUT_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_OUTPUTPOLARITY_LOW ) || \ 699 ((__POLARITY__) == LPTIM_OUTPUTPOLARITY_HIGH)) 700 701 #define IS_LPTIM_CLOCK_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION) || \ 702 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_2TRANSITIONS) || \ 703 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_4TRANSITIONS) || \ 704 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_8TRANSITIONS)) 705 706 #define IS_LPTIM_CLOCK_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING) || \ 707 ((__POLARITY__) == LPTIM_CLOCKPOLARITY_FALLING) || \ 708 ((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING_FALLING)) 709 710 #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \ 711 ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \ 712 ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \ 713 ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \ 714 ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \ 715 ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \ 716 ((__TRIG__) == LPTIM_TRIGSOURCE_5) || \ 717 ((__TRIG__) == LPTIM_TRIGSOURCE_6) || \ 718 ((__TRIG__) == LPTIM_TRIGSOURCE_7)) 719 720 #define IS_LPTIM_EXT_TRG_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING ) || \ 721 ((__POLARITY__) == LPTIM_ACTIVEEDGE_FALLING ) || \ 722 ((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING_FALLING )) 723 724 #define IS_LPTIM_TRIG_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION) || \ 725 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_2TRANSITIONS ) || \ 726 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_4TRANSITIONS ) || \ 727 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_8TRANSITIONS )) 728 729 #define IS_LPTIM_UPDATE_MODE(__MODE__) (((__MODE__) == LPTIM_UPDATE_IMMEDIATE) || \ 730 ((__MODE__) == LPTIM_UPDATE_ENDOFPERIOD)) 731 732 #define IS_LPTIM_COUNTER_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_COUNTERSOURCE_INTERNAL) || \ 733 ((__SOURCE__) == LPTIM_COUNTERSOURCE_EXTERNAL)) 734 735 #define IS_LPTIM_AUTORELOAD(__AUTORELOAD__) ((0x00000001UL <= (__AUTORELOAD__)) &&\ 736 ((__AUTORELOAD__) <= 0x0000FFFFUL)) 737 738 #define IS_LPTIM_COMPARE(__COMPARE__) ((__COMPARE__) <= 0x0000FFFFUL) 739 740 #define IS_LPTIM_PERIOD(__PERIOD__) ((0x00000001UL <= (__PERIOD__)) &&\ 741 ((__PERIOD__) <= 0x0000FFFFUL)) 742 743 #define IS_LPTIM_PULSE(__PULSE__) ((__PULSE__) <= 0x0000FFFFUL) 744 745 /** 746 * @} 747 */ 748 749 /* Private functions ---------------------------------------------------------*/ 750 /** @defgroup LPTIM_Private_Functions LPTIM Private Functions 751 * @{ 752 */ 753 void LPTIM_Disable(LPTIM_HandleTypeDef *hlptim); 754 /** 755 * @} 756 */ 757 758 /** 759 * @} 760 */ 761 762 #endif /* LPTIM1 */ 763 /** 764 * @} 765 */ 766 767 #ifdef __cplusplus 768 } 769 #endif 770 771 #endif /* STM32L0xx_HAL_LPTIM_H */ 772
