思澈科技软件开发工具包  2.20
Functions
GPT_Exported_Functions_Group6
Hardware Abstract Layer » Hardware Timer » GPT_Exported_Functions

Functions

HAL_StatusTypeDef HAL_GPT_Encoder_Init (GPT_HandleTypeDef *htim, GPT_Encoder_InitTypeDef *sConfig)
 Initializes the TIM Encoder Interface and create the associated handle. More...
 
HAL_StatusTypeDef HAL_GPT_Encoder_DeInit (GPT_HandleTypeDef *htim)
 DeInitializes the TIM Encoder interface. More...
 
void HAL_GPT_Encoder_MspInit (GPT_HandleTypeDef *htim)
 Initializes the TIM Encoder Interface MSP. More...
 
void HAL_GPT_Encoder_MspDeInit (GPT_HandleTypeDef *htim)
 DeInitializes TIM Encoder Interface MSP. More...
 
HAL_StatusTypeDef HAL_GPT_Encoder_Start (GPT_HandleTypeDef *htim, uint32_t Channel)
 Starts the TIM Encoder Interface. More...
 
HAL_StatusTypeDef HAL_GPT_Encoder_Stop (GPT_HandleTypeDef *htim, uint32_t Channel)
 Stops the TIM Encoder Interface. More...
 
HAL_StatusTypeDef HAL_GPT_Encoder_Start_IT (GPT_HandleTypeDef *htim, uint32_t Channel)
 Starts the TIM Encoder Interface in interrupt mode. More...
 
HAL_StatusTypeDef HAL_GPT_Encoder_Stop_IT (GPT_HandleTypeDef *htim, uint32_t Channel)
 Stops the TIM Encoder Interface in interrupt mode. More...
 
HAL_StatusTypeDef HAL_GPT_Encoder_Start_DMA (GPT_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData1, uint32_t *pData2, uint16_t Length)
 Starts the TIM Encoder Interface in DMA mode. More...
 
HAL_StatusTypeDef HAL_GPT_Encoder_Stop_DMA (GPT_HandleTypeDef *htim, uint32_t Channel)
 Stops the TIM Encoder Interface in DMA mode. More...
 

Detailed Description

Function Documentation

◆ HAL_GPT_Encoder_DeInit()

HAL_StatusTypeDef HAL_GPT_Encoder_DeInit ( GPT_HandleTypeDef *  htim)

DeInitializes the TIM Encoder interface.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Return values
HALstatus

◆ HAL_GPT_Encoder_Init()

HAL_StatusTypeDef HAL_GPT_Encoder_Init ( GPT_HandleTypeDef *  htim,
GPT_Encoder_InitTypeDef *  sConfig 
)

Initializes the TIM Encoder Interface and create the associated handle.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
sConfigTIM Encoder Interface configuration structure
Return values
HALstatus

◆ HAL_GPT_Encoder_MspDeInit()

void HAL_GPT_Encoder_MspDeInit ( GPT_HandleTypeDef *  htim)

DeInitializes TIM Encoder Interface MSP.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Return values
None

◆ HAL_GPT_Encoder_MspInit()

void HAL_GPT_Encoder_MspInit ( GPT_HandleTypeDef *  htim)

Initializes the TIM Encoder Interface MSP.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
Return values
None

◆ HAL_GPT_Encoder_Start()

HAL_StatusTypeDef HAL_GPT_Encoder_Start ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Starts the TIM Encoder Interface.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
ChannelTIM 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_ALL: TIM Channel 1 and TIM Channel 2 are selected
Return values
HALstatus

◆ HAL_GPT_Encoder_Start_DMA()

HAL_StatusTypeDef HAL_GPT_Encoder_Start_DMA ( GPT_HandleTypeDef *  htim,
uint32_t  Channel,
uint32_t *  pData1,
uint32_t *  pData2,
uint16_t  Length 
)

Starts the TIM Encoder Interface in DMA mode.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
ChannelTIM 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_ALL: TIM Channel 1 and TIM Channel 2 are selected
pData1The destination Buffer address for IC1.
pData2The destination Buffer address for IC2.
LengthThe length of data to be transferred from TIM peripheral to memory.
Return values
HALstatus

◆ HAL_GPT_Encoder_Start_IT()

HAL_StatusTypeDef HAL_GPT_Encoder_Start_IT ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Starts the TIM Encoder Interface in interrupt mode.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
ChannelTIM 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_ALL: TIM Channel 1 and TIM Channel 2 are selected
Return values
HALstatus

◆ HAL_GPT_Encoder_Stop()

HAL_StatusTypeDef HAL_GPT_Encoder_Stop ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Stops the TIM Encoder Interface.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
ChannelTIM 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_ALL: TIM Channel 1 and TIM Channel 2 are selected
Return values
HALstatus

◆ HAL_GPT_Encoder_Stop_DMA()

HAL_StatusTypeDef HAL_GPT_Encoder_Stop_DMA ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Stops the TIM Encoder Interface in DMA mode.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
ChannelTIM 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_ALL: TIM Channel 1 and TIM Channel 2 are selected
Return values
HALstatus

◆ HAL_GPT_Encoder_Stop_IT()

HAL_StatusTypeDef HAL_GPT_Encoder_Stop_IT ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Stops the TIM Encoder Interface in interrupt mode.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
ChannelTIM 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_ALL: TIM Channel 1 and TIM Channel 2 are selected
Return values
HALstatus