TIM Peripheral State functions

Peripheral State functions. More...

Collaboration diagram for TIM Peripheral State functions:

Functions
HAL_TIM_StateTypeDef	HAL_TIM_Base_GetState (const TIM_HandleTypeDef *htim)
	Return the TIM Base handle state.
HAL_TIM_StateTypeDef	HAL_TIM_OC_GetState (const TIM_HandleTypeDef *htim)
	Return the TIM OC handle state.
HAL_TIM_StateTypeDef	HAL_TIM_PWM_GetState (const TIM_HandleTypeDef *htim)
	Return the TIM PWM handle state.
HAL_TIM_StateTypeDef	HAL_TIM_IC_GetState (const TIM_HandleTypeDef *htim)
	Return the TIM Input Capture handle state.
HAL_TIM_StateTypeDef	HAL_TIM_OnePulse_GetState (const TIM_HandleTypeDef *htim)
	Return the TIM One Pulse Mode handle state.
HAL_TIM_StateTypeDef	HAL_TIM_Encoder_GetState (const TIM_HandleTypeDef *htim)
	Return the TIM Encoder Mode handle state.
HAL_TIM_ActiveChannel	HAL_TIM_GetActiveChannel (const TIM_HandleTypeDef *htim)
	Return the TIM Encoder Mode handle state.
HAL_TIM_ChannelStateTypeDef	HAL_TIM_GetChannelState (const TIM_HandleTypeDef *htim, uint32_t Channel)
	Return actual state of the TIM channel.
HAL_TIM_DMABurstStateTypeDef	HAL_TIM_DMABurstState (const TIM_HandleTypeDef *htim)
	Return actual state of a DMA burst operation.

Detailed Description

Peripheral State functions.

TIM Peripheral State functions.

  ==============================================================================
                        ##### Peripheral State functions #####
  ==============================================================================
    [..]
    This subsection permits to get in run-time the status of the peripheral
    and the data flow.

Function Documentation

HAL_TIM_Base_GetState()

HAL_TIM_StateTypeDef HAL_TIM_Base_GetState

(

const TIM_HandleTypeDef *

htim

)

#include <stm32f4xx_hal_tim.h>

Return the TIM Base handle state.

Parameters

htim	TIM Base handle

Return values

HAL

state

Definition at line 6339 of file stm32f4xx_hal_tim.c.

References TIM_HandleTypeDef::State.

HAL_TIM_OC_GetState()

HAL_TIM_StateTypeDef HAL_TIM_OC_GetState

(

const TIM_HandleTypeDef *

htim

)

#include <stm32f4xx_hal_tim.h>

Return the TIM OC handle state.

Parameters

htim	TIM Output Compare handle

Return values

HAL

state

Definition at line 6349 of file stm32f4xx_hal_tim.c.

References TIM_HandleTypeDef::State.

HAL_TIM_PWM_GetState()

HAL_TIM_StateTypeDef HAL_TIM_PWM_GetState

(

const TIM_HandleTypeDef *

htim

)

#include <stm32f4xx_hal_tim.h>

Return the TIM PWM handle state.

Parameters

htim	TIM handle

Return values

HAL

state

Definition at line 6359 of file stm32f4xx_hal_tim.c.

References TIM_HandleTypeDef::State.

HAL_TIM_IC_GetState()

HAL_TIM_StateTypeDef HAL_TIM_IC_GetState

(

const TIM_HandleTypeDef *

htim

)

#include <stm32f4xx_hal_tim.h>

Return the TIM Input Capture handle state.

Parameters

htim	TIM IC handle

Return values

HAL

state

Definition at line 6369 of file stm32f4xx_hal_tim.c.

References TIM_HandleTypeDef::State.

HAL_TIM_OnePulse_GetState()

HAL_TIM_StateTypeDef HAL_TIM_OnePulse_GetState

(

const TIM_HandleTypeDef *

htim

)

#include <stm32f4xx_hal_tim.h>

Return the TIM One Pulse Mode handle state.

Parameters

htim	TIM OPM handle

Return values

HAL

state

Definition at line 6379 of file stm32f4xx_hal_tim.c.

References TIM_HandleTypeDef::State.

HAL_TIM_Encoder_GetState()

HAL_TIM_StateTypeDef HAL_TIM_Encoder_GetState

(

const TIM_HandleTypeDef *

htim

)

#include <stm32f4xx_hal_tim.h>

Return the TIM Encoder Mode handle state.

Parameters

htim	TIM Encoder Interface handle

Return values

HAL

state

Definition at line 6389 of file stm32f4xx_hal_tim.c.

References TIM_HandleTypeDef::State.

HAL_TIM_GetActiveChannel()

HAL_TIM_ActiveChannel HAL_TIM_GetActiveChannel

(

const TIM_HandleTypeDef *

htim

)

#include <stm32f4xx_hal_tim.h>

Return the TIM Encoder Mode handle state.

Parameters

htim	TIM handle

Return values

Active

channel

Definition at line 6399 of file stm32f4xx_hal_tim.c.

References TIM_HandleTypeDef::Channel.

HAL_TIM_GetChannelState()

HAL_TIM_ChannelStateTypeDef HAL_TIM_GetChannelState	(	const TIM_HandleTypeDef *	htim,
		uint32_t	Channel )

#include <stm32f4xx_hal_tim.h>

Return actual state of the TIM channel.

Parameters

htim	TIM handle
Channel	TIM Channel This parameter can be one of the following values: TIM_CHANNEL_1: TIM Channel 1 TIM_CHANNEL_2: TIM Channel 2 TIM_CHANNEL_3: TIM Channel 3 TIM_CHANNEL_4: TIM Channel 4 TIM_CHANNEL_5: TIM Channel 5 TIM_CHANNEL_6: TIM Channel 6

Return values

TIM	Channel state

Definition at line 6417 of file stm32f4xx_hal_tim.c.

References assert_param, TIM_HandleTypeDef::Instance, and TIM_CHANNEL_STATE_GET.

HAL_TIM_DMABurstState()

HAL_TIM_DMABurstStateTypeDef HAL_TIM_DMABurstState

(

const TIM_HandleTypeDef *

htim

)

#include <stm32f4xx_hal_tim.h>

Return actual state of a DMA burst operation.

Parameters

htim	TIM handle

Return values

DMA	burst state

Definition at line 6434 of file stm32f4xx_hal_tim.c.

References assert_param, TIM_HandleTypeDef::DMABurstState, and TIM_HandleTypeDef::Instance.