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

Functions

HAL_StatusTypeDef HAL_GPT_PWM_Init (GPT_HandleTypeDef *htim)
 Initializes the TIM PWM Time Base according to the specified parameters in the GPT_HandleTypeDef and create the associated handle. More...
 
HAL_StatusTypeDef HAL_GPT_PWM_DeInit (GPT_HandleTypeDef *htim)
 DeInitializes the TIM peripheral. More...
 
void HAL_GPT_PWM_MspInit (GPT_HandleTypeDef *htim)
 Initializes the TIM PWM MSP. More...
 
void HAL_GPT_PWM_MspDeInit (GPT_HandleTypeDef *htim)
 DeInitializes TIM PWM MSP. More...
 
HAL_StatusTypeDef HAL_GPT_PWM_Start (GPT_HandleTypeDef *htim, uint32_t Channel)
 Starts the PWM signal generation. More...
 
HAL_StatusTypeDef HAL_GPT_PWM_Stop (GPT_HandleTypeDef *htim, uint32_t Channel)
 Stops the PWM signal generation. More...
 
HAL_StatusTypeDef HAL_GPT_PWM_Start_IT (GPT_HandleTypeDef *htim, uint32_t Channel)
 Starts the PWM signal generation in interrupt mode. More...
 
HAL_StatusTypeDef HAL_GPT_PWM_Stop_IT (GPT_HandleTypeDef *htim, uint32_t Channel)
 Stops the PWM signal generation in interrupt mode. More...
 
HAL_StatusTypeDef HAL_GPT_PWM_Start_DMA (GPT_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length)
 Starts the TIM PWM signal generation in DMA mode. More...
 
HAL_StatusTypeDef HAL_GPT_PWM_Stop_DMA (GPT_HandleTypeDef *htim, uint32_t Channel)
 Stops the TIM PWM signal generation in DMA mode. More...
 

Detailed Description

Function Documentation

◆ HAL_GPT_PWM_DeInit()

HAL_StatusTypeDef HAL_GPT_PWM_DeInit ( GPT_HandleTypeDef *  htim)

DeInitializes the TIM peripheral.

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

◆ HAL_GPT_PWM_Init()

HAL_StatusTypeDef HAL_GPT_PWM_Init ( GPT_HandleTypeDef *  htim)

Initializes the TIM PWM Time Base according to the specified parameters in the GPT_HandleTypeDef and create the associated handle.

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

◆ HAL_GPT_PWM_MspDeInit()

void HAL_GPT_PWM_MspDeInit ( GPT_HandleTypeDef *  htim)

DeInitializes TIM PWM MSP.

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

◆ HAL_GPT_PWM_MspInit()

void HAL_GPT_PWM_MspInit ( GPT_HandleTypeDef *  htim)

Initializes the TIM PWM MSP.

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

◆ HAL_GPT_PWM_Start()

HAL_StatusTypeDef HAL_GPT_PWM_Start ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Starts the PWM signal generation.

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_3: TIM Channel 3 selected
  • GPT_CHANNEL_4: TIM Channel 4 selected
Return values
HALstatus

◆ HAL_GPT_PWM_Start_DMA()

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

Starts the TIM PWM signal generation 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_3: TIM Channel 3 selected
  • GPT_CHANNEL_4: TIM Channel 4 selected
pDataThe source Buffer address.
LengthThe length of data to be transferred from memory to TIM peripheral
Return values
HALstatus

◆ HAL_GPT_PWM_Start_IT()

HAL_StatusTypeDef HAL_GPT_PWM_Start_IT ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Starts the PWM signal generation in interrupt mode.

Parameters
htimpointer to a GPT_HandleTypeDef structure that contains the configuration information for TIM module.
ChannelTIM 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
HALstatus

◆ HAL_GPT_PWM_Stop()

HAL_StatusTypeDef HAL_GPT_PWM_Stop ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Stops the PWM signal generation.

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_3: TIM Channel 3 selected
  • GPT_CHANNEL_4: TIM Channel 4 selected
Return values
HALstatus

◆ HAL_GPT_PWM_Stop_DMA()

HAL_StatusTypeDef HAL_GPT_PWM_Stop_DMA ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Stops the TIM PWM signal generation in DMA 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_3: TIM Channel 3 selected
  • GPT_CHANNEL_4: TIM Channel 4 selected
Return values
HALstatus

◆ HAL_GPT_PWM_Stop_IT()

HAL_StatusTypeDef HAL_GPT_PWM_Stop_IT ( GPT_HandleTypeDef *  htim,
uint32_t  Channel 
)

Stops the PWM signal generation 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_3: TIM Channel 3 selected
  • GPT_CHANNEL_4: TIM Channel 4 selected
Return values
HALstatus