STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_hal_lptim.h File Reference

Header file of LPTIM HAL module. More...

Go to the source code of this file.

Data Structures

struct  LPTIM_ClockConfigTypeDef
 LPTIM Clock configuration definition. More...
 
struct  LPTIM_ULPClockConfigTypeDef
 LPTIM Clock configuration definition. More...
 
struct  LPTIM_TriggerConfigTypeDef
 LPTIM Trigger configuration definition. More...
 
struct  LPTIM_InitTypeDef
 LPTIM Initialization Structure definition. More...
 
struct  endif
 ADC handle Structure definition. More...
 

Typedefs

typedef struct __LPTIM_HandleTypeDef else typedef struct endif LPTIM_HandleTypeDef
 LPTIM handle Structure definition.
 
typedef void(* pLPTIM_CallbackTypeDef) (LPTIM_HandleTypeDef *hlptim)
 HAL TIM Callback pointer definition. More...
 

Enumerations

enum  HAL_LPTIM_StateTypeDef {
  HAL_LPTIM_STATE_RESET = 0x00U , HAL_LPTIM_STATE_READY = 0x01U , HAL_LPTIM_STATE_BUSY = 0x02U , HAL_LPTIM_STATE_TIMEOUT = 0x03U ,
  HAL_LPTIM_STATE_ERROR = 0x04U
}
 HAL LPTIM State structure definition. More...
 
enum  HAL_LPTIM_CallbackIDTypeDef {
  HAL_LPTIM_MSPINIT_CB_ID = 0x00U , HAL_LPTIM_MSPDEINIT_CB_ID = 0x01U , HAL_LPTIM_COMPARE_MATCH_CB_ID = 0x02U , HAL_LPTIM_AUTORELOAD_MATCH_CB_ID = 0x03U ,
  HAL_LPTIM_TRIGGER_CB_ID = 0x04U , HAL_LPTIM_COMPARE_WRITE_CB_ID = 0x05U , HAL_LPTIM_AUTORELOAD_WRITE_CB_ID = 0x06U , HAL_LPTIM_DIRECTION_UP_CB_ID = 0x07U ,
  HAL_LPTIM_DIRECTION_DOWN_CB_ID = 0x08U
}
 HAL LPTIM Callback ID enumeration definition. More...
 

Functions

HAL_StatusTypeDef HAL_LPTIM_Init (LPTIM_HandleTypeDef *hlptim)
 Initialize the LPTIM according to the specified parameters in the LPTIM_InitTypeDef and initialize the associated handle. More...
 
HAL_StatusTypeDef HAL_LPTIM_DeInit (LPTIM_HandleTypeDef *hlptim)
 DeInitialize the LPTIM peripheral. More...
 
void HAL_LPTIM_MspInit (LPTIM_HandleTypeDef *hlptim)
 Initialize the LPTIM MSP. More...
 
void HAL_LPTIM_MspDeInit (LPTIM_HandleTypeDef *hlptim)
 DeInitialize LPTIM MSP. More...
 
HAL_StatusTypeDef HAL_LPTIM_PWM_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM PWM generation. More...
 
HAL_StatusTypeDef HAL_LPTIM_PWM_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM PWM generation. More...
 
HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM PWM generation in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM PWM generation in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM One pulse generation. More...
 
HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM One pulse generation. More...
 
HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM One pulse generation in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM One pulse generation in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM in Set once mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM Set once mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM Set once mode in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM Set once mode in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_Encoder_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
 Start the Encoder interface. More...
 
HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the Encoder interface. More...
 
HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
 Start the Encoder interface in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the Encoder interface in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout)
 Start the Timeout function. More...
 
HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the Timeout function. More...
 
HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout)
 Start the Timeout function in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the Timeout function in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_Counter_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
 Start the Counter mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_Counter_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the Counter mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
 Start the Counter mode in interrupt mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the Counter mode in interrupt mode. More...
 
uint32_t HAL_LPTIM_ReadCounter (const LPTIM_HandleTypeDef *hlptim)
 Return the current counter value. More...
 
uint32_t HAL_LPTIM_ReadAutoReload (const LPTIM_HandleTypeDef *hlptim)
 Return the current Autoreload (Period) value. More...
 
uint32_t HAL_LPTIM_ReadCompare (const LPTIM_HandleTypeDef *hlptim)
 Return the current Compare (Pulse) value. More...
 
void HAL_LPTIM_IRQHandler (LPTIM_HandleTypeDef *hlptim)
 Handle LPTIM interrupt request. More...
 
void HAL_LPTIM_CompareMatchCallback (LPTIM_HandleTypeDef *hlptim)
 Compare match callback in non-blocking mode. More...
 
void HAL_LPTIM_AutoReloadMatchCallback (LPTIM_HandleTypeDef *hlptim)
 Autoreload match callback in non-blocking mode. More...
 
void HAL_LPTIM_TriggerCallback (LPTIM_HandleTypeDef *hlptim)
 Trigger detected callback in non-blocking mode. More...
 
void HAL_LPTIM_CompareWriteCallback (LPTIM_HandleTypeDef *hlptim)
 Compare write callback in non-blocking mode. More...
 
void HAL_LPTIM_AutoReloadWriteCallback (LPTIM_HandleTypeDef *hlptim)
 Autoreload write callback in non-blocking mode. More...
 
void HAL_LPTIM_DirectionUpCallback (LPTIM_HandleTypeDef *hlptim)
 Direction counter changed from Down to Up callback in non-blocking mode. More...
 
void HAL_LPTIM_DirectionDownCallback (LPTIM_HandleTypeDef *hlptim)
 Direction counter changed from Up to Down callback in non-blocking mode. More...
 
HAL_StatusTypeDef HAL_LPTIM_RegisterCallback (LPTIM_HandleTypeDef *hlptim, HAL_LPTIM_CallbackIDTypeDef CallbackID, pLPTIM_CallbackTypeDef pCallback)
 Register a User LPTIM callback to be used instead of the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback (LPTIM_HandleTypeDef *hlptim, HAL_LPTIM_CallbackIDTypeDef CallbackID)
 Unregister a LPTIM callback LLPTIM callback is redirected to the weak predefined callback. More...
 
HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState (const LPTIM_HandleTypeDef *hlptim)
 Return the LPTIM handle state. More...
 
void LPTIM_Disable (LPTIM_HandleTypeDef *hlptim)
 Disable LPTIM HW instance. More...
 

Detailed Description

Header file of LPTIM HAL module.

Author
MCD Application Team
Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_lptim.h.