GPT_Exported_Functions_Group2

Functions
HAL_StatusTypeDef	HAL_GPT_OC_Init (GPT_HandleTypeDef *htim)
	Initializes the TIM Output Compare according to the specified parameters in the GPT_HandleTypeDef and create the associated handle. More...
HAL_StatusTypeDef	HAL_GPT_OC_DeInit (GPT_HandleTypeDef *htim)
	DeInitializes the TIM peripheral. More...
void	HAL_GPT_OC_MspInit (GPT_HandleTypeDef *htim)
	Initializes the TIM Output Compare MSP. More...
void	HAL_GPT_OC_MspDeInit (GPT_HandleTypeDef *htim)
	DeInitializes TIM Output Compare MSP. More...
HAL_StatusTypeDef	HAL_GPT_OC_Start (GPT_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Output Compare signal generation. More...
HAL_StatusTypeDef	HAL_GPT_OC_Stop (GPT_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation. More...
HAL_StatusTypeDef	HAL_GPT_OC_Start_IT (GPT_HandleTypeDef *htim, uint32_t Channel)
	Starts the TIM Output Compare signal generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_GPT_OC_Stop_IT (GPT_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_GPT_OC_Start_DMA (GPT_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length)
	Starts the TIM Output Compare signal generation in DMA mode. More...
HAL_StatusTypeDef	HAL_GPT_OC_Stop_DMA (GPT_HandleTypeDef *htim, uint32_t Channel)
	Stops the TIM Output Compare signal generation in DMA mode. More...

Detailed Description

Function Documentation

HAL_GPT_OC_DeInit()

HAL_StatusTypeDef HAL_GPT_OC_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_OC_Init()

HAL_StatusTypeDef HAL_GPT_OC_Init

(

GPT_HandleTypeDef *

htim

)

Initializes the TIM Output Compare 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_OC_MspDeInit()

void HAL_GPT_OC_MspDeInit

(

GPT_HandleTypeDef *

htim

)

DeInitializes TIM Output Compare MSP.

Parameters

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

Return values

None

HAL_GPT_OC_MspInit()

void HAL_GPT_OC_MspInit

(

GPT_HandleTypeDef *

htim

)

Initializes the TIM Output Compare MSP.

Parameters

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

Return values

None

HAL_GPT_OC_Start()

HAL_StatusTypeDef HAL_GPT_OC_Start	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Output Compare signal generation.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channel 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_OC_Start_DMA()

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

Starts the TIM Output Compare signal generation in DMA mode.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channel 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 source Buffer address.
Length	The length of data to be transferred from memory to TIM peripheral

Return values

HAL

status

HAL_GPT_OC_Start_IT()

HAL_StatusTypeDef HAL_GPT_OC_Start_IT	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Starts the TIM Output Compare signal generation in interrupt mode.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channel 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_OC_Stop()

HAL_StatusTypeDef HAL_GPT_OC_Stop	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Output Compare signal generation.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channel 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_OC_Stop_DMA()

HAL_StatusTypeDef HAL_GPT_OC_Stop_DMA	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Output Compare signal generation in DMA mode.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channel 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_OC_Stop_IT()

HAL_StatusTypeDef HAL_GPT_OC_Stop_IT	(	GPT_HandleTypeDef *	htim,
		uint32_t	Channel
	)

Stops the TIM Output Compare signal generation in interrupt mode.

Parameters

htim	pointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Channel	TIM Channel 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