lib/main/STM32H7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_lptim.h

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