Extended Peripheral Control functions

Peripheral Control functions. More...

Functions
HAL_StatusTypeDef	HAL_TIMEx_ConfigCommutEvent (TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource)
	Configure the TIM commutation event sequence.
HAL_StatusTypeDef	HAL_TIMEx_ConfigCommutEvent_IT (TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource)
	Configure the TIM commutation event sequence with interrupt.
HAL_StatusTypeDef	HAL_TIMEx_ConfigCommutEvent_DMA (TIM_HandleTypeDef *htim, uint32_t InputTrigger, uint32_t CommutationSource)
	Configure the TIM commutation event sequence with DMA.
HAL_StatusTypeDef	HAL_TIMEx_MasterConfigSynchronization (TIM_HandleTypeDef *htim, TIM_MasterConfigTypeDef *sMasterConfig)
	Configures the TIM in master mode.
HAL_StatusTypeDef	HAL_TIMEx_ConfigBreakDeadTime (TIM_HandleTypeDef *htim, TIM_BreakDeadTimeConfigTypeDef *sBreakDeadTimeConfig)
	Configures the Break feature, dead time, Lock level, OSSI/OSSR State and the AOE(automatic output enable).
HAL_StatusTypeDef	HAL_TIMEx_ConfigBreakInput (TIM_HandleTypeDef *htim, uint32_t BreakInput, TIMEx_BreakInputConfigTypeDef *sBreakInputConfig)
	Configures the break input source.
HAL_StatusTypeDef	HAL_TIMEx_RemapConfig (TIM_HandleTypeDef *htim, uint32_t Remap)
	Configures the TIMx Remapping input capabilities.
HAL_StatusTypeDef	HAL_TIMEx_GroupChannel5 (TIM_HandleTypeDef *htim, uint32_t Channels)
	Group channel 5 and channel 1, 2 or 3.

---

Detailed Description

Peripheral Control functions.

  ==============================================================================
                    ##### Peripheral Control functions #####
  ==============================================================================
  [..]
    This section provides functions allowing to:
      (+) Configure the commutation event in case of use of the Hall sensor interface.
      (+) Configure Output channels for OC and PWM mode.

      (+) Configure Complementary channels, break features and dead time.
      (+) Configure Master synchronization.
      (+) Configure timer remapping capabilities.
      (+) Enable or disable channel grouping.

---

Function Documentation

HAL_StatusTypeDef HAL_TIMEx_ConfigBreakDeadTime	(	TIM_HandleTypeDef *	htim,
		TIM_BreakDeadTimeConfigTypeDef *	sBreakDeadTimeConfig
	)

Configures the Break feature, dead time, Lock level, OSSI/OSSR State and the AOE(automatic output enable).

Parameters:

htim	TIM handle
sBreakDeadTimeConfig	pointer to a TIM_ConfigBreakDeadConfigTypeDef structure that contains the BDTR Register configuration information for the TIM peripheral.

Note:

Interrupts can be generated when an active level is detected on the break input, the break 2 input or the system break input. Break interrupt can be enabled by calling the __HAL_TIM_ENABLE_IT macro.

Return values:

HAL

status

Definition at line 2038 of file stm32l4xx_hal_tim_ex.c.

References assert_param, TIM_BreakDeadTimeConfigTypeDef::AutomaticOutput, TIM_BreakDeadTimeConfigTypeDef::Break2Filter, TIM_BreakDeadTimeConfigTypeDef::Break2Polarity, TIM_BreakDeadTimeConfigTypeDef::Break2State, TIM_BreakDeadTimeConfigTypeDef::BreakFilter, TIM_BreakDeadTimeConfigTypeDef::BreakPolarity, TIM_BreakDeadTimeConfigTypeDef::BreakState, TIM_BreakDeadTimeConfigTypeDef::DeadTime, __TIM_HandleTypeDef::Instance, IS_TIM_AUTOMATIC_OUTPUT_STATE, IS_TIM_BREAK2_POLARITY, IS_TIM_BREAK2_STATE, IS_TIM_BREAK_FILTER, IS_TIM_BREAK_POLARITY, IS_TIM_BREAK_STATE, IS_TIM_DEADTIME, IS_TIM_LOCK_LEVEL, IS_TIM_OSSI_STATE, IS_TIM_OSSR_STATE, TIM_BreakDeadTimeConfigTypeDef::LockLevel, TIM_BreakDeadTimeConfigTypeDef::OffStateIDLEMode, and TIM_BreakDeadTimeConfigTypeDef::OffStateRunMode.

HAL_StatusTypeDef HAL_TIMEx_ConfigBreakInput	(	TIM_HandleTypeDef *	htim,
		uint32_t	BreakInput,
		TIMEx_BreakInputConfigTypeDef *	sBreakInputConfig
	)

Configures the break input source.

Parameters:

htim	TIM handle.
BreakInput	Break input to configure This parameter can be one of the following values: TIM_BREAKINPUT_BRK: Timer break input TIM_BREAKINPUT_BRK2: Timer break 2 input
sBreakInputConfig	Break input source configuration

Return values:

HAL

status

Definition at line 2102 of file stm32l4xx_hal_tim_ex.c.

References assert_param, TIMEx_BreakInputConfigTypeDef::Enable, __TIM_HandleTypeDef::Instance, IS_TIM_BREAKINPUT, IS_TIM_BREAKINPUTSOURCE, IS_TIM_BREAKINPUTSOURCE_POLARITY, IS_TIM_BREAKINPUTSOURCE_STATE, TIMEx_BreakInputConfigTypeDef::Polarity, TIMEx_BreakInputConfigTypeDef::Source, TIM_BREAKINPUT_BRK, TIM_BREAKINPUT_BRK2, TIM_BREAKINPUTSOURCE_BKIN, TIM_BREAKINPUTSOURCE_COMP1, and TIM_BREAKINPUTSOURCE_COMP2.

HAL_StatusTypeDef HAL_TIMEx_ConfigCommutEvent	(	TIM_HandleTypeDef *	htim,
		uint32_t	InputTrigger,
		uint32_t	CommutationSource
	)

Configure the TIM commutation event sequence.

Note:

This function is mandatory to use the commutation event in order to update the configuration at each commutation detection on the TRGI input of the Timer, the typical use of this feature is with the use of another Timer(interface Timer) configured in Hall sensor interface, this interface Timer will generate the commutation at its TRGO output (connected to Timer used in this function) each time the TI1 of the Interface Timer detect a commutation at its input TI1.

Parameters:

htim	TIM handle
InputTrigger	the Internal trigger corresponding to the Timer Interfacing with the Hall sensor This parameter can be one of the following values: TIM_TS_ITR0: Internal trigger 0 selected TIM_TS_ITR1: Internal trigger 1 selected TIM_TS_ITR2: Internal trigger 2 selected TIM_TS_ITR3: Internal trigger 3 selected TIM_TS_NONE: No trigger is needed
CommutationSource	the Commutation Event source This parameter can be one of the following values: TIM_COMMUTATION_TRGI: Commutation source is the TRGI of the Interface Timer TIM_COMMUTATION_SOFTWARE: Commutation source is set by software using the COMG bit

Return values:

HAL

status

Definition at line 1803 of file stm32l4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE_DMA, __HAL_TIM_DISABLE_IT, assert_param, __TIM_HandleTypeDef::Instance, IS_TIM_INTERNAL_TRIGGEREVENT_SELECTION, TIM_DMA_COM, TIM_IT_COM, TIM_TS_ITR0, TIM_TS_ITR1, TIM_TS_ITR2, and TIM_TS_ITR3.

HAL_StatusTypeDef HAL_TIMEx_ConfigCommutEvent_DMA	(	TIM_HandleTypeDef *	htim,
		uint32_t	InputTrigger,
		uint32_t	CommutationSource
	)

Configure the TIM commutation event sequence with DMA.

Note:

This function is mandatory to use the commutation event in order to update the configuration at each commutation detection on the TRGI input of the Timer, the typical use of this feature is with the use of another Timer(interface Timer) configured in Hall sensor interface, this interface Timer will generate the commutation at its TRGO output (connected to Timer used in this function) each time the TI1 of the Interface Timer detect a commutation at its input TI1.

The user should configure the DMA in his own software, in This function only the COMDE bit is set

Parameters:

htim	TIM handle
InputTrigger	the Internal trigger corresponding to the Timer Interfacing with the Hall sensor This parameter can be one of the following values: TIM_TS_ITR0: Internal trigger 0 selected TIM_TS_ITR1: Internal trigger 1 selected TIM_TS_ITR2: Internal trigger 2 selected TIM_TS_ITR3: Internal trigger 3 selected TIM_TS_NONE: No trigger is needed
CommutationSource	the Commutation Event source This parameter can be one of the following values: TIM_COMMUTATION_TRGI: Commutation source is the TRGI of the Interface Timer TIM_COMMUTATION_SOFTWARE: Commutation source is set by software using the COMG bit

Return values:

HAL

status

Definition at line 1916 of file stm32l4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE_IT, __HAL_TIM_ENABLE_DMA, assert_param, __TIM_HandleTypeDef::hdma, __TIM_HandleTypeDef::Instance, IS_TIM_INTERNAL_TRIGGEREVENT_SELECTION, TIM_DMA_COM, TIM_DMA_ID_COMMUTATION, TIM_DMAError(), TIM_IT_COM, TIM_TS_ITR0, TIM_TS_ITR1, TIM_TS_ITR2, TIM_TS_ITR3, TIMEx_DMACommutationCplt(), TIMEx_DMACommutationHalfCplt(), __DMA_HandleTypeDef::XferCpltCallback, __DMA_HandleTypeDef::XferErrorCallback, and __DMA_HandleTypeDef::XferHalfCpltCallback.

HAL_StatusTypeDef HAL_TIMEx_ConfigCommutEvent_IT	(	TIM_HandleTypeDef *	htim,
		uint32_t	InputTrigger,
		uint32_t	CommutationSource
	)

Configure the TIM commutation event sequence with interrupt.

Note:

This function is mandatory to use the commutation event in order to update the configuration at each commutation detection on the TRGI input of the Timer, the typical use of this feature is with the use of another Timer(interface Timer) configured in Hall sensor interface, this interface Timer will generate the commutation at its TRGO output (connected to Timer used in this function) each time the TI1 of the Interface Timer detect a commutation at its input TI1.

Parameters:

htim	TIM handle
InputTrigger	the Internal trigger corresponding to the Timer Interfacing with the Hall sensor This parameter can be one of the following values: TIM_TS_ITR0: Internal trigger 0 selected TIM_TS_ITR1: Internal trigger 1 selected TIM_TS_ITR2: Internal trigger 2 selected TIM_TS_ITR3: Internal trigger 3 selected TIM_TS_NONE: No trigger is needed
CommutationSource	the Commutation Event source This parameter can be one of the following values: TIM_COMMUTATION_TRGI: Commutation source is the TRGI of the Interface Timer TIM_COMMUTATION_SOFTWARE: Commutation source is set by software using the COMG bit

Return values:

HAL

status

Definition at line 1859 of file stm32l4xx_hal_tim_ex.c.

References __HAL_TIM_DISABLE_DMA, __HAL_TIM_ENABLE_IT, assert_param, __TIM_HandleTypeDef::Instance, IS_TIM_INTERNAL_TRIGGEREVENT_SELECTION, TIM_DMA_COM, TIM_IT_COM, TIM_TS_ITR0, TIM_TS_ITR1, TIM_TS_ITR2, and TIM_TS_ITR3.

HAL_StatusTypeDef HAL_TIMEx_GroupChannel5	(	TIM_HandleTypeDef *	htim,
		uint32_t	Channels
	)

Group channel 5 and channel 1, 2 or 3.

Parameters:

htim

TIM handle.

Channels

specifies the reference signal(s) the OC5REF is combined with. This parameter can be any combination of the following values: TIM_GROUPCH5_NONE: No effect of OC5REF on OC1REFC, OC2REFC and OC3REFC TIM_GROUPCH5_OC1REFC: OC1REFC is the logical AND of OC1REFC and OC5REF TIM_GROUPCH5_OC2REFC: OC2REFC is the logical AND of OC2REFC and OC5REF TIM_GROUPCH5_OC3REFC: OC3REFC is the logical AND of OC3REFC and OC5REF

Return values:

HAL

status

Definition at line 2501 of file stm32l4xx_hal_tim_ex.c.

References assert_param, HAL_TIM_STATE_BUSY, HAL_TIM_STATE_READY, __TIM_HandleTypeDef::Instance, IS_TIM_GROUPCH5, and __TIM_HandleTypeDef::State.

HAL_StatusTypeDef HAL_TIMEx_MasterConfigSynchronization	(	TIM_HandleTypeDef *	htim,
		TIM_MasterConfigTypeDef *	sMasterConfig
	)

Configures the TIM in master mode.

Parameters:

htim	TIM handle.
sMasterConfig	pointer to a TIM_MasterConfigTypeDef structure that contains the selected trigger output (TRGO) and the Master/Slave mode.

Return values:

HAL

status

Definition at line 1965 of file stm32l4xx_hal_tim_ex.c.

References assert_param, HAL_TIM_STATE_BUSY, HAL_TIM_STATE_READY, __TIM_HandleTypeDef::Instance, IS_TIM_MSM_STATE, IS_TIM_TRGO2_SOURCE, IS_TIM_TRGO_SOURCE, TIM_MasterConfigTypeDef::MasterOutputTrigger, TIM_MasterConfigTypeDef::MasterOutputTrigger2, TIM_MasterConfigTypeDef::MasterSlaveMode, and __TIM_HandleTypeDef::State.

HAL_StatusTypeDef HAL_TIMEx_RemapConfig	(	TIM_HandleTypeDef *	htim,
		uint32_t	Remap
	)

Configures the TIMx Remapping input capabilities.

Parameters:

htim	TIM handle.
Remap	specifies the TIM remapping source. For TIM1, the parameter is a combination of 3 fields (field1 | field2 | field3):

field1 can have the following values:

• TIM_TIM1_ETR_ADC1_NONE: TIM1_ETR is not connected to any ADC1 AWD (analog watchdog)
• TIM_TIM1_ETR_ADC1_AWD1: TIM1_ETR is connected to ADC1 AWD1
• TIM_TIM1_ETR_ADC1_AWD2: TIM1_ETR is connected to ADC1 AWD2
• TIM_TIM1_ETR_ADC1_AWD3: TIM1_ETR is connected to ADC1 AWD3

field2 can have the following values:

• TIM_TIM1_TI1_GPIO: TIM1 TI1 is connected to GPIO
• TIM_TIM1_TI1_COMP1: TIM1 TI1 is connected to COMP1 output

field3 can have the following values:

• TIM_TIM1_ETR_COMP1: TIM1_ETR is connected to COMP1 output
• TIM_TIM1_ETR_COMP2: TIM1_ETR is connected to COMP2 output

Note:

When field3 is set to TIM_TIM1_ETR_COMP1 or TIM_TIM1_ETR_COMP2 field1 values is not significant

For TIM2, the parameter is a combination of 3 fields (field1 | field2 | field3):

field1 can have the following values:

• TIM_TIM2_ITR1_NONE: No internal trigger on TIM2_ITR1
• TIM_TIM2_ITR1_USB_SOF: TIM2_ITR1 is connected to USB SOF

field2 can have the following values:

• TIM_TIM2_ETR_GPIO: TIM2_ETR is connected to GPIO
• TIM_TIM2_ETR_LSE: TIM2_ETR is connected to LSE
• TIM_TIM2_ETR_COMP1: TIM2_ETR is connected to COMP1 output
• TIM_TIM2_ETR_COMP2: TIM2_ETR is connected to COMP2 output

field3 can have the following values:

• TIM_TIM2_TI4_GPIO: TIM2 TI4 is connected to GPIO
• TIM_TIM2_TI4_COMP1: TIM2 TI4 is connected to COMP1 output
• TIM_TIM2_TI4_COMP2: TIM2 TI4 is connected to COMP2 output
• TIM_TIM2_TI4_COMP1_COMP2: TIM2 TI4 is connected to logical OR between COMP1 and COMP2 output

For TIM15, the parameter is a combination of 2 fields (field1 | field2):

field1 can have the following values:

• TIM_TIM15_TI1_GPIO: TIM15 TI1 is connected to GPIO
• TIM_TIM15_TI1_LSE: TIM15 TI1 is connected to LSE

field2 can have the following values:

• TIM_TIM15_ENCODERMODE_NONE: No redirection
• TIM_TIM15_ENCODERMODE_TIM2: TIM2 IC1 and TIM2 IC2 are connected to TIM15 IC1 and TIM15 IC2 respectively
• TIM_TIM15_ENCODERMODE_TIM3: TIM3 IC1 and TIM3 IC2 are connected to TIM15 IC1 and TIM15 IC2 respectively
• TIM_TIM15_ENCODERMODE_TIM4: TIM4 IC1 and TIM4 IC2 are connected to TIM15 IC1 and TIM15 IC2 respectively

For TIM16, the parameter can have the following values:

• TIM_TIM16_TI1_GPIO: TIM16 TI1 is connected to GPIO
• TIM_TIM16_TI1_LSI: TIM16 TI1 is connected to LSI
• TIM_TIM16_TI1_LSE: TIM16 TI1 is connected to LSE
• TIM_TIM16_TI1_RTC: TIM16 TI1 is connected to RTC wakeup interrupt
• TIM_TIM16_TI1_MSI: TIM16 TI1 is connected to MSI (constraints: MSI clock < 1/4 TIM APB clock)
• TIM_TIM16_TI1_HSE_32: TIM16 TI1 is connected to HSE div 32 (note that HSE div 32 must be selected as RTC clock source)
• TIM_TIM16_TI1_MCO: TIM16 TI1 is connected to MCO

Return values:

HAL

status

Definition at line 2456 of file stm32l4xx_hal_tim_ex.c.

References assert_param, __TIM_HandleTypeDef::Instance, and IS_TIM_REMAP.