GPT_Exported_Functions_Group4

Functions
HAL_StatusTypeDef	HAL_GPT_IC_Init (GPT_HandleTypeDef *htim)
	Initializes the TIM Input Capture Time base according to the specified parameters in the GPT_HandleTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_GPT_IC_DeInit (GPT_HandleTypeDef *htim)
	DeInitializes the TIM peripheral. More...
void	HAL_GPT_IC_MspInit (GPT_HandleTypeDef *htim)
	Initializes the TIM INput Capture MSP. More...
void	HAL_GPT_IC_MspDeInit (GPT_HandleTypeDef *htim)
	DeInitializes TIM Input Capture MSP. More...
HAL_StatusTypeDef	HAL_GPT_IC_Start (GPT_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Input Capture measurement. More...
HAL_StatusTypeDef	HAL_GPT_IC_Stop (GPT_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Input Capture measurement. More...
HAL_StatusTypeDef	HAL_GPT_IC_Start_IT (GPT_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Input Capture measurement in interrupt mode. More...
HAL_StatusTypeDef	HAL_GPT_IC_Stop_IT (GPT_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Input Capture measurement in interrupt mode. More...
HAL_StatusTypeDef	HAL_GPT_IC_Start_DMA (GPT_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length)
	Starts the TIM Input Capture measurement on in DMA mode. More...
HAL_StatusTypeDef	HAL_GPT_IC_Stop_DMA (GPT_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Input Capture measurement on in DMA mode. More...

Detailed Description

Function Documentation

HAL_GPT_IC_DeInit()

HAL_StatusTypeDef HAL_GPT_IC_DeInit

(

GPT_HandleTypeDef *

htim

)

DeInitializes the TIM peripheral.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.

Return values

HAL

status

HAL_GPT_IC_Init()

HAL_StatusTypeDef HAL_GPT_IC_Init

(

GPT_HandleTypeDef *

htim

)

Initializes the TIM Input Capture Time base according to the specified parameters in the GPT_HandleTypeDef and create the associated handle.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.

Return values

HAL

status

HAL_GPT_IC_MspDeInit()

void HAL_GPT_IC_MspDeInit

(

GPT_HandleTypeDef *

htim

)

DeInitializes TIM Input Capture MSP.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.

Return values

None

HAL_GPT_IC_MspInit()

void HAL_GPT_IC_MspInit

(

GPT_HandleTypeDef *

htim

)

Initializes the TIM INput Capture MSP.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.

Return values

None

HAL_GPT_IC_Start()

HAL_StatusTypeDef HAL_GPT_IC_Start	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Input Capture measurement.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channels to be enabled. This parameter can be one of the following values: GPT_CHANNEL_1: TIM Channel 1 selected GPT_CHANNEL_2: TIM Channel 2 selected GPT_CHANNEL_3: TIM Channel 3 selected GPT_CHANNEL_4: TIM Channel 4 selected

Return values

HAL

status

HAL_GPT_IC_Start_DMA()

HAL_StatusTypeDef HAL_GPT_IC_Start_DMA	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel,
		uint32_t *	pData,
		uint16_t	Length
	)

Starts the TIM Input Capture measurement on in DMA mode.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channels to be enabled. This parameter can be one of the following values: GPT_CHANNEL_1: TIM Channel 1 selected GPT_CHANNEL_2: TIM Channel 2 selected GPT_CHANNEL_3: TIM Channel 3 selected GPT_CHANNEL_4: TIM Channel 4 selected
pData	The destination Buffer address.
Length	The length of data to be transferred from TIM peripheral to memory.

Return values

HAL

status

HAL_GPT_IC_Start_IT()

HAL_StatusTypeDef HAL_GPT_IC_Start_IT	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Input Capture measurement in interrupt mode.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channels to be enabled. This parameter can be one of the following values: GPT_CHANNEL_1: TIM Channel 1 selected GPT_CHANNEL_2: TIM Channel 2 selected GPT_CHANNEL_3: TIM Channel 3 selected GPT_CHANNEL_4: TIM Channel 4 selected

Return values

HAL

status

HAL_GPT_IC_Stop()

HAL_StatusTypeDef HAL_GPT_IC_Stop	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Input Capture measurement.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channels to be disabled. This parameter can be one of the following values: GPT_CHANNEL_1: TIM Channel 1 selected GPT_CHANNEL_2: TIM Channel 2 selected GPT_CHANNEL_3: TIM Channel 3 selected GPT_CHANNEL_4: TIM Channel 4 selected

Return values

HAL

status

HAL_GPT_IC_Stop_DMA()

HAL_StatusTypeDef HAL_GPT_IC_Stop_DMA	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Input Capture measurement on in DMA mode.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channels to be disabled. This parameter can be one of the following values: GPT_CHANNEL_1: TIM Channel 1 selected GPT_CHANNEL_2: TIM Channel 2 selected GPT_CHANNEL_3: TIM Channel 3 selected GPT_CHANNEL_4: TIM Channel 4 selected

Return values

HAL

status

HAL_GPT_IC_Stop_IT()

HAL_StatusTypeDef HAL_GPT_IC_Stop_IT	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Input Capture measurement in interrupt mode.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channels to be disabled. This parameter can be one of the following values: GPT_CHANNEL_1: TIM Channel 1 selected GPT_CHANNEL_2: TIM Channel 2 selected GPT_CHANNEL_3: TIM Channel 3 selected GPT_CHANNEL_4: TIM Channel 4 selected

Return values

HAL

status