|
STM32F479xx HAL User Manual
|
00001 /** 00002 ****************************************************************************** 00003 * @file stm32f4xx_hal_lptim.h 00004 * @author MCD Application Team 00005 * @brief Header file of LPTIM HAL module. 00006 ****************************************************************************** 00007 * @attention 00008 * 00009 * <h2><center>© Copyright (c) 2016 STMicroelectronics. 00010 * All rights reserved.</center></h2> 00011 * 00012 * This software component is licensed by ST under BSD 3-Clause license, 00013 * the "License"; You may not use this file except in compliance with the 00014 * License. You may obtain a copy of the License at: 00015 * opensource.org/licenses/BSD-3-Clause 00016 * 00017 ****************************************************************************** 00018 */ 00019 00020 /* Define to prevent recursive inclusion -------------------------------------*/ 00021 #ifndef STM32F4xx_HAL_LPTIM_H 00022 #define STM32F4xx_HAL_LPTIM_H 00023 00024 #ifdef __cplusplus 00025 extern "C" { 00026 #endif 00027 00028 /* Includes ------------------------------------------------------------------*/ 00029 #include "stm32f4xx_hal_def.h" 00030 00031 /** @addtogroup STM32F4xx_HAL_Driver 00032 * @{ 00033 */ 00034 00035 #if defined (LPTIM1) 00036 00037 /** @addtogroup LPTIM 00038 * @{ 00039 */ 00040 00041 /* Exported types ------------------------------------------------------------*/ 00042 /** @defgroup LPTIM_Exported_Types LPTIM Exported Types 00043 * @{ 00044 */ 00045 #define LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT EXTI_IMR_MR23 /*!< External interrupt line 23 Connected to the LPTIM EXTI Line */ 00046 00047 /** 00048 * @brief LPTIM Clock configuration definition 00049 */ 00050 typedef struct 00051 { 00052 uint32_t Source; /*!< Selects the clock source. 00053 This parameter can be a value of @ref LPTIM_Clock_Source */ 00054 00055 uint32_t Prescaler; /*!< Specifies the counter clock Prescaler. 00056 This parameter can be a value of @ref LPTIM_Clock_Prescaler */ 00057 00058 } LPTIM_ClockConfigTypeDef; 00059 00060 /** 00061 * @brief LPTIM Clock configuration definition 00062 */ 00063 typedef struct 00064 { 00065 uint32_t Polarity; /*!< Selects the polarity of the active edge for the counter unit 00066 if the ULPTIM input is selected. 00067 Note: This parameter is used only when Ultra low power clock source is used. 00068 Note: If the polarity is configured on 'both edges', an auxiliary clock 00069 (one of the Low power oscillator) must be active. 00070 This parameter can be a value of @ref LPTIM_Clock_Polarity */ 00071 00072 uint32_t SampleTime; /*!< Selects the clock sampling time to configure the clock glitch filter. 00073 Note: This parameter is used only when Ultra low power clock source is used. 00074 This parameter can be a value of @ref LPTIM_Clock_Sample_Time */ 00075 00076 } LPTIM_ULPClockConfigTypeDef; 00077 00078 /** 00079 * @brief LPTIM Trigger configuration definition 00080 */ 00081 typedef struct 00082 { 00083 uint32_t Source; /*!< Selects the Trigger source. 00084 This parameter can be a value of @ref LPTIM_Trigger_Source */ 00085 00086 uint32_t ActiveEdge; /*!< Selects the Trigger active edge. 00087 Note: This parameter is used only when an external trigger is used. 00088 This parameter can be a value of @ref LPTIM_External_Trigger_Polarity */ 00089 00090 uint32_t SampleTime; /*!< Selects the trigger sampling time to configure the clock glitch filter. 00091 Note: This parameter is used only when an external trigger is used. 00092 This parameter can be a value of @ref LPTIM_Trigger_Sample_Time */ 00093 } LPTIM_TriggerConfigTypeDef; 00094 00095 /** 00096 * @brief LPTIM Initialization Structure definition 00097 */ 00098 typedef struct 00099 { 00100 LPTIM_ClockConfigTypeDef Clock; /*!< Specifies the clock parameters */ 00101 00102 LPTIM_ULPClockConfigTypeDef UltraLowPowerClock;/*!< Specifies the Ultra Low Power clock parameters */ 00103 00104 LPTIM_TriggerConfigTypeDef Trigger; /*!< Specifies the Trigger parameters */ 00105 00106 uint32_t OutputPolarity; /*!< Specifies the Output polarity. 00107 This parameter can be a value of @ref LPTIM_Output_Polarity */ 00108 00109 uint32_t UpdateMode; /*!< Specifies whether the update of the autoreload and the compare 00110 values is done immediately or after the end of current period. 00111 This parameter can be a value of @ref LPTIM_Updating_Mode */ 00112 00113 uint32_t CounterSource; /*!< Specifies whether the counter is incremented each internal event 00114 or each external event. 00115 This parameter can be a value of @ref LPTIM_Counter_Source */ 00116 } LPTIM_InitTypeDef; 00117 00118 /** 00119 * @brief HAL LPTIM State structure definition 00120 */ 00121 typedef enum 00122 { 00123 HAL_LPTIM_STATE_RESET = 0x00U, /*!< Peripheral not yet initialized or disabled */ 00124 HAL_LPTIM_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */ 00125 HAL_LPTIM_STATE_BUSY = 0x02U, /*!< An internal process is ongoing */ 00126 HAL_LPTIM_STATE_TIMEOUT = 0x03U, /*!< Timeout state */ 00127 HAL_LPTIM_STATE_ERROR = 0x04U /*!< Internal Process is ongoing */ 00128 } HAL_LPTIM_StateTypeDef; 00129 00130 /** 00131 * @brief LPTIM handle Structure definition 00132 */ 00133 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 00134 typedef struct __LPTIM_HandleTypeDef 00135 #else 00136 typedef struct 00137 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 00138 { 00139 LPTIM_TypeDef *Instance; /*!< Register base address */ 00140 00141 LPTIM_InitTypeDef Init; /*!< LPTIM required parameters */ 00142 00143 HAL_StatusTypeDef Status; /*!< LPTIM peripheral status */ 00144 00145 HAL_LockTypeDef Lock; /*!< LPTIM locking object */ 00146 00147 __IO HAL_LPTIM_StateTypeDef State; /*!< LPTIM peripheral state */ 00148 00149 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 00150 void (* MspInitCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< LPTIM Base Msp Init Callback */ 00151 void (* MspDeInitCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< LPTIM Base Msp DeInit Callback */ 00152 void (* CompareMatchCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Compare match Callback */ 00153 void (* AutoReloadMatchCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Auto-reload match Callback */ 00154 void (* TriggerCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< External trigger event detection Callback */ 00155 void (* CompareWriteCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Compare register write complete Callback */ 00156 void (* AutoReloadWriteCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Auto-reload register write complete Callback */ 00157 void (* DirectionUpCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Up-counting direction change Callback */ 00158 void (* DirectionDownCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Down-counting direction change Callback */ 00159 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 00160 } LPTIM_HandleTypeDef; 00161 00162 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 00163 /** 00164 * @brief HAL LPTIM Callback ID enumeration definition 00165 */ 00166 typedef enum 00167 { 00168 HAL_LPTIM_MSPINIT_CB_ID = 0x00U, /*!< LPTIM Base Msp Init Callback ID */ 00169 HAL_LPTIM_MSPDEINIT_CB_ID = 0x01U, /*!< LPTIM Base Msp DeInit Callback ID */ 00170 HAL_LPTIM_COMPARE_MATCH_CB_ID = 0x02U, /*!< Compare match Callback ID */ 00171 HAL_LPTIM_AUTORELOAD_MATCH_CB_ID = 0x03U, /*!< Auto-reload match Callback ID */ 00172 HAL_LPTIM_TRIGGER_CB_ID = 0x04U, /*!< External trigger event detection Callback ID */ 00173 HAL_LPTIM_COMPARE_WRITE_CB_ID = 0x05U, /*!< Compare register write complete Callback ID */ 00174 HAL_LPTIM_AUTORELOAD_WRITE_CB_ID = 0x06U, /*!< Auto-reload register write complete Callback ID */ 00175 HAL_LPTIM_DIRECTION_UP_CB_ID = 0x07U, /*!< Up-counting direction change Callback ID */ 00176 HAL_LPTIM_DIRECTION_DOWN_CB_ID = 0x08U, /*!< Down-counting direction change Callback ID */ 00177 } HAL_LPTIM_CallbackIDTypeDef; 00178 00179 /** 00180 * @brief HAL TIM Callback pointer definition 00181 */ 00182 typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< pointer to the LPTIM callback function */ 00183 00184 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 00185 /** 00186 * @} 00187 */ 00188 00189 /* Exported constants --------------------------------------------------------*/ 00190 /** @defgroup LPTIM_Exported_Constants LPTIM Exported Constants 00191 * @{ 00192 */ 00193 00194 /** @defgroup LPTIM_Clock_Source LPTIM Clock Source 00195 * @{ 00196 */ 00197 #define LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC 0x00000000U 00198 #define LPTIM_CLOCKSOURCE_ULPTIM LPTIM_CFGR_CKSEL 00199 /** 00200 * @} 00201 */ 00202 00203 /** @defgroup LPTIM_Clock_Prescaler LPTIM Clock Prescaler 00204 * @{ 00205 */ 00206 #define LPTIM_PRESCALER_DIV1 0x00000000U 00207 #define LPTIM_PRESCALER_DIV2 LPTIM_CFGR_PRESC_0 00208 #define LPTIM_PRESCALER_DIV4 LPTIM_CFGR_PRESC_1 00209 #define LPTIM_PRESCALER_DIV8 (LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_1) 00210 #define LPTIM_PRESCALER_DIV16 LPTIM_CFGR_PRESC_2 00211 #define LPTIM_PRESCALER_DIV32 (LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_2) 00212 #define LPTIM_PRESCALER_DIV64 (LPTIM_CFGR_PRESC_1 | LPTIM_CFGR_PRESC_2) 00213 #define LPTIM_PRESCALER_DIV128 LPTIM_CFGR_PRESC 00214 /** 00215 * @} 00216 */ 00217 00218 /** @defgroup LPTIM_Output_Polarity LPTIM Output Polarity 00219 * @{ 00220 */ 00221 00222 #define LPTIM_OUTPUTPOLARITY_HIGH 0x00000000U 00223 #define LPTIM_OUTPUTPOLARITY_LOW LPTIM_CFGR_WAVPOL 00224 /** 00225 * @} 00226 */ 00227 00228 /** @defgroup LPTIM_Clock_Sample_Time LPTIM Clock Sample Time 00229 * @{ 00230 */ 00231 #define LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION 0x00000000U 00232 #define LPTIM_CLOCKSAMPLETIME_2TRANSITIONS LPTIM_CFGR_CKFLT_0 00233 #define LPTIM_CLOCKSAMPLETIME_4TRANSITIONS LPTIM_CFGR_CKFLT_1 00234 #define LPTIM_CLOCKSAMPLETIME_8TRANSITIONS LPTIM_CFGR_CKFLT 00235 /** 00236 * @} 00237 */ 00238 00239 /** @defgroup LPTIM_Clock_Polarity LPTIM Clock Polarity 00240 * @{ 00241 */ 00242 #define LPTIM_CLOCKPOLARITY_RISING 0x00000000U 00243 #define LPTIM_CLOCKPOLARITY_FALLING LPTIM_CFGR_CKPOL_0 00244 #define LPTIM_CLOCKPOLARITY_RISING_FALLING LPTIM_CFGR_CKPOL_1 00245 /** 00246 * @} 00247 */ 00248 00249 /** @defgroup LPTIM_Trigger_Source LPTIM Trigger Source 00250 * @{ 00251 */ 00252 #define LPTIM_TRIGSOURCE_SOFTWARE 0x0000FFFFU 00253 #define LPTIM_TRIGSOURCE_0 0x00000000U 00254 #define LPTIM_TRIGSOURCE_1 LPTIM_CFGR_TRIGSEL_0 00255 #define LPTIM_TRIGSOURCE_2 LPTIM_CFGR_TRIGSEL_1 00256 #define LPTIM_TRIGSOURCE_3 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_1) 00257 #define LPTIM_TRIGSOURCE_4 LPTIM_CFGR_TRIGSEL_2 00258 #define LPTIM_TRIGSOURCE_5 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_2) 00259 /** 00260 * @} 00261 */ 00262 00263 /** @defgroup LPTIM_External_Trigger_Polarity LPTIM External Trigger Polarity 00264 * @{ 00265 */ 00266 #define LPTIM_ACTIVEEDGE_RISING LPTIM_CFGR_TRIGEN_0 00267 #define LPTIM_ACTIVEEDGE_FALLING LPTIM_CFGR_TRIGEN_1 00268 #define LPTIM_ACTIVEEDGE_RISING_FALLING LPTIM_CFGR_TRIGEN 00269 /** 00270 * @} 00271 */ 00272 00273 /** @defgroup LPTIM_Trigger_Sample_Time LPTIM Trigger Sample Time 00274 * @{ 00275 */ 00276 #define LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION 0x00000000U 00277 #define LPTIM_TRIGSAMPLETIME_2TRANSITIONS LPTIM_CFGR_TRGFLT_0 00278 #define LPTIM_TRIGSAMPLETIME_4TRANSITIONS LPTIM_CFGR_TRGFLT_1 00279 #define LPTIM_TRIGSAMPLETIME_8TRANSITIONS LPTIM_CFGR_TRGFLT 00280 /** 00281 * @} 00282 */ 00283 00284 /** @defgroup LPTIM_Updating_Mode LPTIM Updating Mode 00285 * @{ 00286 */ 00287 00288 #define LPTIM_UPDATE_IMMEDIATE 0x00000000U 00289 #define LPTIM_UPDATE_ENDOFPERIOD LPTIM_CFGR_PRELOAD 00290 /** 00291 * @} 00292 */ 00293 00294 /** @defgroup LPTIM_Counter_Source LPTIM Counter Source 00295 * @{ 00296 */ 00297 00298 #define LPTIM_COUNTERSOURCE_INTERNAL 0x00000000U 00299 #define LPTIM_COUNTERSOURCE_EXTERNAL LPTIM_CFGR_COUNTMODE 00300 /** 00301 * @} 00302 */ 00303 00304 /** @defgroup LPTIM_Flag_Definition LPTIM Flags Definition 00305 * @{ 00306 */ 00307 00308 #define LPTIM_FLAG_DOWN LPTIM_ISR_DOWN 00309 #define LPTIM_FLAG_UP LPTIM_ISR_UP 00310 #define LPTIM_FLAG_ARROK LPTIM_ISR_ARROK 00311 #define LPTIM_FLAG_CMPOK LPTIM_ISR_CMPOK 00312 #define LPTIM_FLAG_EXTTRIG LPTIM_ISR_EXTTRIG 00313 #define LPTIM_FLAG_ARRM LPTIM_ISR_ARRM 00314 #define LPTIM_FLAG_CMPM LPTIM_ISR_CMPM 00315 /** 00316 * @} 00317 */ 00318 00319 /** @defgroup LPTIM_Interrupts_Definition LPTIM Interrupts Definition 00320 * @{ 00321 */ 00322 #define LPTIM_IT_DOWN LPTIM_IER_DOWNIE 00323 #define LPTIM_IT_UP LPTIM_IER_UPIE 00324 #define LPTIM_IT_ARROK LPTIM_IER_ARROKIE 00325 #define LPTIM_IT_CMPOK LPTIM_IER_CMPOKIE 00326 #define LPTIM_IT_EXTTRIG LPTIM_IER_EXTTRIGIE 00327 #define LPTIM_IT_ARRM LPTIM_IER_ARRMIE 00328 #define LPTIM_IT_CMPM LPTIM_IER_CMPMIE 00329 /** 00330 * @} 00331 */ 00332 00333 /** @defgroup LPTIM_Option Register Definition 00334 * @{ 00335 */ 00336 #define LPTIM_OP_PAD_AF 0x00000000U 00337 #define LPTIM_OP_PAD_PA4 LPTIM_OR_LPT_IN1_RMP_0 00338 #define LPTIM_OP_PAD_PB9 LPTIM_OR_LPT_IN1_RMP_1 00339 #define LPTIM_OP_TIM_DAC LPTIM_OR_LPT_IN1_RMP 00340 /** 00341 * @} 00342 */ 00343 00344 /** 00345 * @} 00346 */ 00347 00348 /* Exported macros -----------------------------------------------------------*/ 00349 /** @defgroup LPTIM_Exported_Macros LPTIM Exported Macros 00350 * @{ 00351 */ 00352 00353 /** @brief Reset LPTIM handle state. 00354 * @param __HANDLE__ LPTIM handle 00355 * @retval None 00356 */ 00357 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 00358 #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) do { \ 00359 (__HANDLE__)->State = HAL_LPTIM_STATE_RESET; \ 00360 (__HANDLE__)->MspInitCallback = NULL; \ 00361 (__HANDLE__)->MspDeInitCallback = NULL; \ 00362 } while(0) 00363 #else 00364 #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LPTIM_STATE_RESET) 00365 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 00366 00367 /** 00368 * @brief Enable the LPTIM peripheral. 00369 * @param __HANDLE__ LPTIM handle 00370 * @retval None 00371 */ 00372 #define __HAL_LPTIM_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE)) 00373 00374 /** 00375 * @brief Disable the LPTIM peripheral. 00376 * @param __HANDLE__ LPTIM handle 00377 * @note The following sequence is required to solve LPTIM disable HW limitation. 00378 * Please check Errata Sheet ES0335 for more details under "MCU may remain 00379 * stuck in LPTIM interrupt when entering Stop mode" section. 00380 * @note Please call @ref HAL_LPTIM_GetState() after a call to __HAL_LPTIM_DISABLE to 00381 * check for TIMEOUT. 00382 * @retval None 00383 */ 00384 #define __HAL_LPTIM_DISABLE(__HANDLE__) LPTIM_Disable(__HANDLE__) 00385 00386 /** 00387 * @brief Start the LPTIM peripheral in Continuous mode. 00388 * @param __HANDLE__ LPTIM handle 00389 * @retval None 00390 */ 00391 #define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT) 00392 /** 00393 * @brief Start the LPTIM peripheral in single mode. 00394 * @param __HANDLE__ LPTIM handle 00395 * @retval None 00396 */ 00397 #define __HAL_LPTIM_START_SINGLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT) 00398 00399 /** 00400 * @brief Write the passed parameter in the Autoreload register. 00401 * @param __HANDLE__ LPTIM handle 00402 * @param __VALUE__ Autoreload value 00403 * @retval None 00404 * @note The ARR register can only be modified when the LPTIM instance is enabled. 00405 */ 00406 #define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->ARR = (__VALUE__)) 00407 00408 /** 00409 * @brief Write the passed parameter in the Compare register. 00410 * @param __HANDLE__ LPTIM handle 00411 * @param __VALUE__ Compare value 00412 * @retval None 00413 * @note The CMP register can only be modified when the LPTIM instance is enabled. 00414 */ 00415 #define __HAL_LPTIM_COMPARE_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->CMP = (__VALUE__)) 00416 00417 /** 00418 * @brief Check whether the specified LPTIM flag is set or not. 00419 * @param __HANDLE__ LPTIM handle 00420 * @param __FLAG__ LPTIM flag to check 00421 * This parameter can be a value of: 00422 * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag. 00423 * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag. 00424 * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag. 00425 * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag. 00426 * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag. 00427 * @arg LPTIM_FLAG_ARRM : Autoreload match Flag. 00428 * @arg LPTIM_FLAG_CMPM : Compare match Flag. 00429 * @retval The state of the specified flag (SET or RESET). 00430 */ 00431 #define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__)) 00432 00433 /** 00434 * @brief Clear the specified LPTIM flag. 00435 * @param __HANDLE__ LPTIM handle. 00436 * @param __FLAG__ LPTIM flag to clear. 00437 * This parameter can be a value of: 00438 * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag. 00439 * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag. 00440 * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag. 00441 * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag. 00442 * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag. 00443 * @arg LPTIM_FLAG_ARRM : Autoreload match Flag. 00444 * @arg LPTIM_FLAG_CMPM : Compare match Flag. 00445 * @retval None. 00446 */ 00447 #define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 00448 00449 /** 00450 * @brief Enable the specified LPTIM interrupt. 00451 * @param __HANDLE__ LPTIM handle. 00452 * @param __INTERRUPT__ LPTIM interrupt to set. 00453 * This parameter can be a value of: 00454 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 00455 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 00456 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 00457 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 00458 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 00459 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 00460 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 00461 * @retval None. 00462 * @note The LPTIM interrupts can only be enabled when the LPTIM instance is disabled. 00463 */ 00464 #define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__)) 00465 00466 /** 00467 * @brief Disable the specified LPTIM interrupt. 00468 * @param __HANDLE__ LPTIM handle. 00469 * @param __INTERRUPT__ LPTIM interrupt to set. 00470 * This parameter can be a value of: 00471 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 00472 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 00473 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 00474 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 00475 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 00476 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 00477 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 00478 * @retval None. 00479 * @note The LPTIM interrupts can only be disabled when the LPTIM instance is disabled. 00480 */ 00481 #define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__))) 00482 00483 /** 00484 * @brief Check whether the specified LPTIM interrupt source is enabled or not. 00485 * @param __HANDLE__ LPTIM handle. 00486 * @param __INTERRUPT__ LPTIM interrupt to check. 00487 * This parameter can be a value of: 00488 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt. 00489 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt. 00490 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt. 00491 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt. 00492 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt. 00493 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt. 00494 * @arg LPTIM_IT_CMPM : Compare match Interrupt. 00495 * @retval Interrupt status. 00496 */ 00497 00498 #define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER\ 00499 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET) 00500 00501 /** @brief LPTIM Option Register 00502 * @param __HANDLE__ LPTIM handle 00503 * @param __VALUE__ This parameter can be a value of : 00504 * @arg LPTIM_OP_PAD_AF 00505 * @arg LPTIM_OP_PAD_PA4 00506 * @arg LPTIM_OP_PAD_PB9 00507 * @arg LPTIM_OP_TIM_DAC 00508 * @retval None 00509 */ 00510 #define __HAL_LPTIM_OPTR_CONFIG(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->OR = (__VALUE__)) 00511 00512 00513 /** 00514 * @brief Enable interrupt on the LPTIM Wake-up Timer associated Exti line. 00515 * @retval None 00516 */ 00517 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT() (EXTI->IMR\ 00518 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 00519 00520 /** 00521 * @brief Disable interrupt on the LPTIM Wake-up Timer associated Exti line. 00522 * @retval None 00523 */ 00524 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT() (EXTI->IMR\ 00525 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 00526 00527 /** 00528 * @brief Enable event on the LPTIM Wake-up Timer associated Exti line. 00529 * @retval None. 00530 */ 00531 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT() (EXTI->EMR\ 00532 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 00533 00534 /** 00535 * @brief Disable event on the LPTIM Wake-up Timer associated Exti line. 00536 * @retval None. 00537 */ 00538 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT() (EXTI->EMR\ 00539 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 00540 #if defined(EXTI_IMR_MR23) 00541 00542 /** 00543 * @brief Enable falling edge trigger on the LPTIM Wake-up Timer associated Exti line. 00544 * @retval None. 00545 */ 00546 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE() (EXTI->FTSR\ 00547 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 00548 00549 /** 00550 * @brief Disable falling edge trigger on the LPTIM Wake-up Timer associated Exti line. 00551 * @retval None. 00552 */ 00553 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE() (EXTI->FTSR\ 00554 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 00555 00556 /** 00557 * @brief Enable rising edge trigger on the LPTIM Wake-up Timer associated Exti line. 00558 * @retval None. 00559 */ 00560 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE() (EXTI->RTSR\ 00561 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 00562 00563 /** 00564 * @brief Disable rising edge trigger on the LPTIM Wake-up Timer associated Exti line. 00565 * @retval None. 00566 */ 00567 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE() (EXTI->RTSR\ 00568 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)) 00569 00570 /** 00571 * @brief Enable rising & falling edge trigger on the LPTIM Wake-up Timer associated Exti line. 00572 * @retval None. 00573 */ 00574 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_FALLING_EDGE() do{__HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE();\ 00575 __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE();\ 00576 }while(0) 00577 00578 /** 00579 * @brief Disable rising & falling edge trigger on the LPTIM Wake-up Timer associated Exti line. 00580 * @retval None. 00581 */ 00582 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_FALLING_EDGE() do{__HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE();\ 00583 __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE();\ 00584 }while(0) 00585 00586 /** 00587 * @brief Check whether the LPTIM Wake-up Timer associated Exti line interrupt flag is set or not. 00588 * @retval Line Status. 00589 */ 00590 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_GET_FLAG() (EXTI->PR\ 00591 & LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 00592 00593 /** 00594 * @brief Clear the LPTIM Wake-up Timer associated Exti line flag. 00595 * @retval None. 00596 */ 00597 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_CLEAR_FLAG() (EXTI->PR\ 00598 = LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 00599 00600 /** 00601 * @brief Generate a Software interrupt on the LPTIM Wake-up Timer associated Exti line. 00602 * @retval None. 00603 */ 00604 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_GENERATE_SWIT() (EXTI->SWIER\ 00605 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT) 00606 #endif /* EXTI_IMR_MR23 */ 00607 00608 /** 00609 * @} 00610 */ 00611 00612 /* Exported functions --------------------------------------------------------*/ 00613 /** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions 00614 * @{ 00615 */ 00616 00617 /** @addtogroup LPTIM_Exported_Functions_Group1 00618 * @brief Initialization and Configuration functions. 00619 * @{ 00620 */ 00621 /* Initialization/de-initialization functions ********************************/ 00622 HAL_StatusTypeDef HAL_LPTIM_Init(LPTIM_HandleTypeDef *hlptim); 00623 HAL_StatusTypeDef HAL_LPTIM_DeInit(LPTIM_HandleTypeDef *hlptim); 00624 00625 /* MSP functions *************************************************************/ 00626 void HAL_LPTIM_MspInit(LPTIM_HandleTypeDef *hlptim); 00627 void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef *hlptim); 00628 /** 00629 * @} 00630 */ 00631 00632 /** @addtogroup LPTIM_Exported_Functions_Group2 00633 * @brief Start-Stop operation functions. 00634 * @{ 00635 */ 00636 /* Start/Stop operation functions *********************************************/ 00637 /* ################################# PWM Mode ################################*/ 00638 /* Blocking mode: Polling */ 00639 HAL_StatusTypeDef HAL_LPTIM_PWM_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 00640 HAL_StatusTypeDef HAL_LPTIM_PWM_Stop(LPTIM_HandleTypeDef *hlptim); 00641 /* Non-Blocking mode: Interrupt */ 00642 HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 00643 HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT(LPTIM_HandleTypeDef *hlptim); 00644 00645 /* ############################# One Pulse Mode ##############################*/ 00646 /* Blocking mode: Polling */ 00647 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 00648 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop(LPTIM_HandleTypeDef *hlptim); 00649 /* Non-Blocking mode: Interrupt */ 00650 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 00651 HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT(LPTIM_HandleTypeDef *hlptim); 00652 00653 /* ############################## Set once Mode ##############################*/ 00654 /* Blocking mode: Polling */ 00655 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 00656 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop(LPTIM_HandleTypeDef *hlptim); 00657 /* Non-Blocking mode: Interrupt */ 00658 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse); 00659 HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT(LPTIM_HandleTypeDef *hlptim); 00660 00661 /* ############################### Encoder Mode ##############################*/ 00662 /* Blocking mode: Polling */ 00663 HAL_StatusTypeDef HAL_LPTIM_Encoder_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 00664 HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop(LPTIM_HandleTypeDef *hlptim); 00665 /* Non-Blocking mode: Interrupt */ 00666 HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 00667 HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT(LPTIM_HandleTypeDef *hlptim); 00668 00669 /* ############################# Time out Mode ##############################*/ 00670 /* Blocking mode: Polling */ 00671 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout); 00672 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop(LPTIM_HandleTypeDef *hlptim); 00673 /* Non-Blocking mode: Interrupt */ 00674 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout); 00675 HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT(LPTIM_HandleTypeDef *hlptim); 00676 00677 /* ############################## Counter Mode ###############################*/ 00678 /* Blocking mode: Polling */ 00679 HAL_StatusTypeDef HAL_LPTIM_Counter_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 00680 HAL_StatusTypeDef HAL_LPTIM_Counter_Stop(LPTIM_HandleTypeDef *hlptim); 00681 /* Non-Blocking mode: Interrupt */ 00682 HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period); 00683 HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef *hlptim); 00684 /** 00685 * @} 00686 */ 00687 00688 /** @addtogroup LPTIM_Exported_Functions_Group3 00689 * @brief Read operation functions. 00690 * @{ 00691 */ 00692 /* Reading operation functions ************************************************/ 00693 uint32_t HAL_LPTIM_ReadCounter(LPTIM_HandleTypeDef *hlptim); 00694 uint32_t HAL_LPTIM_ReadAutoReload(LPTIM_HandleTypeDef *hlptim); 00695 uint32_t HAL_LPTIM_ReadCompare(LPTIM_HandleTypeDef *hlptim); 00696 /** 00697 * @} 00698 */ 00699 00700 /** @addtogroup LPTIM_Exported_Functions_Group4 00701 * @brief LPTIM IRQ handler and callback functions. 00702 * @{ 00703 */ 00704 /* LPTIM IRQ functions *******************************************************/ 00705 void HAL_LPTIM_IRQHandler(LPTIM_HandleTypeDef *hlptim); 00706 00707 /* CallBack functions ********************************************************/ 00708 void HAL_LPTIM_CompareMatchCallback(LPTIM_HandleTypeDef *hlptim); 00709 void HAL_LPTIM_AutoReloadMatchCallback(LPTIM_HandleTypeDef *hlptim); 00710 void HAL_LPTIM_TriggerCallback(LPTIM_HandleTypeDef *hlptim); 00711 void HAL_LPTIM_CompareWriteCallback(LPTIM_HandleTypeDef *hlptim); 00712 void HAL_LPTIM_AutoReloadWriteCallback(LPTIM_HandleTypeDef *hlptim); 00713 void HAL_LPTIM_DirectionUpCallback(LPTIM_HandleTypeDef *hlptim); 00714 void HAL_LPTIM_DirectionDownCallback(LPTIM_HandleTypeDef *hlptim); 00715 00716 /* Callbacks Register/UnRegister functions ***********************************/ 00717 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1) 00718 HAL_StatusTypeDef HAL_LPTIM_RegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID, 00719 pLPTIM_CallbackTypeDef pCallback); 00720 HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID); 00721 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */ 00722 /** 00723 * @} 00724 */ 00725 00726 /** @addtogroup LPTIM_Group5 00727 * @brief Peripheral State functions. 00728 * @{ 00729 */ 00730 /* Peripheral State functions ************************************************/ 00731 HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim); 00732 /** 00733 * @} 00734 */ 00735 00736 /** 00737 * @} 00738 */ 00739 00740 /* Private types -------------------------------------------------------------*/ 00741 /** @defgroup LPTIM_Private_Types LPTIM Private Types 00742 * @{ 00743 */ 00744 00745 /** 00746 * @} 00747 */ 00748 00749 /* Private variables ---------------------------------------------------------*/ 00750 /** @defgroup LPTIM_Private_Variables LPTIM Private Variables 00751 * @{ 00752 */ 00753 00754 /** 00755 * @} 00756 */ 00757 00758 /* Private constants ---------------------------------------------------------*/ 00759 /** @defgroup LPTIM_Private_Constants LPTIM Private Constants 00760 * @{ 00761 */ 00762 00763 /** 00764 * @} 00765 */ 00766 00767 /* Private macros ------------------------------------------------------------*/ 00768 /** @defgroup LPTIM_Private_Macros LPTIM Private Macros 00769 * @{ 00770 */ 00771 00772 #define IS_LPTIM_CLOCK_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_CLOCKSOURCE_ULPTIM) || \ 00773 ((__SOURCE__) == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC)) 00774 00775 00776 #define IS_LPTIM_CLOCK_PRESCALER(__PRESCALER__) (((__PRESCALER__) == LPTIM_PRESCALER_DIV1 ) || \ 00777 ((__PRESCALER__) == LPTIM_PRESCALER_DIV2 ) || \ 00778 ((__PRESCALER__) == LPTIM_PRESCALER_DIV4 ) || \ 00779 ((__PRESCALER__) == LPTIM_PRESCALER_DIV8 ) || \ 00780 ((__PRESCALER__) == LPTIM_PRESCALER_DIV16 ) || \ 00781 ((__PRESCALER__) == LPTIM_PRESCALER_DIV32 ) || \ 00782 ((__PRESCALER__) == LPTIM_PRESCALER_DIV64 ) || \ 00783 ((__PRESCALER__) == LPTIM_PRESCALER_DIV128)) 00784 00785 #define IS_LPTIM_CLOCK_PRESCALERDIV1(__PRESCALER__) ((__PRESCALER__) == LPTIM_PRESCALER_DIV1) 00786 00787 #define IS_LPTIM_OUTPUT_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_OUTPUTPOLARITY_LOW ) || \ 00788 ((__POLARITY__) == LPTIM_OUTPUTPOLARITY_HIGH)) 00789 00790 #define IS_LPTIM_CLOCK_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION) || \ 00791 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_2TRANSITIONS) || \ 00792 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_4TRANSITIONS) || \ 00793 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_8TRANSITIONS)) 00794 00795 #define IS_LPTIM_CLOCK_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING) || \ 00796 ((__POLARITY__) == LPTIM_CLOCKPOLARITY_FALLING) || \ 00797 ((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING_FALLING)) 00798 00799 #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \ 00800 ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \ 00801 ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \ 00802 ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \ 00803 ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \ 00804 ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \ 00805 ((__TRIG__) == LPTIM_TRIGSOURCE_5)) 00806 00807 #define IS_LPTIM_EXT_TRG_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING ) || \ 00808 ((__POLARITY__) == LPTIM_ACTIVEEDGE_FALLING ) || \ 00809 ((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING_FALLING )) 00810 00811 #define IS_LPTIM_TRIG_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION) || \ 00812 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_2TRANSITIONS ) || \ 00813 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_4TRANSITIONS ) || \ 00814 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_8TRANSITIONS )) 00815 00816 #define IS_LPTIM_UPDATE_MODE(__MODE__) (((__MODE__) == LPTIM_UPDATE_IMMEDIATE) || \ 00817 ((__MODE__) == LPTIM_UPDATE_ENDOFPERIOD)) 00818 00819 #define IS_LPTIM_COUNTER_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_COUNTERSOURCE_INTERNAL) || \ 00820 ((__SOURCE__) == LPTIM_COUNTERSOURCE_EXTERNAL)) 00821 00822 #define IS_LPTIM_AUTORELOAD(__AUTORELOAD__) ((__AUTORELOAD__) <= 0x0000FFFFUL) 00823 00824 #define IS_LPTIM_COMPARE(__COMPARE__) ((__COMPARE__) <= 0x0000FFFFUL) 00825 00826 #define IS_LPTIM_PERIOD(__PERIOD__) ((__PERIOD__) <= 0x0000FFFFUL) 00827 00828 #define IS_LPTIM_PULSE(__PULSE__) ((__PULSE__) <= 0x0000FFFFUL) 00829 00830 /** 00831 * @} 00832 */ 00833 00834 /* Private functions ---------------------------------------------------------*/ 00835 /** @defgroup LPTIM_Private_Functions LPTIM Private Functions 00836 * @{ 00837 */ 00838 void LPTIM_Disable(LPTIM_HandleTypeDef *hlptim); 00839 /** 00840 * @} 00841 */ 00842 00843 /** 00844 * @} 00845 */ 00846 00847 #endif /* LPTIM1 */ 00848 /** 00849 * @} 00850 */ 00851 00852 #ifdef __cplusplus 00853 } 00854 #endif 00855 00856 #endif /* STM32F4xx_HAL_LPTIM_H */ 00857 00858 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
1.7.6.1