Senior Design: Sound Monitor / STM32L4xx_HAL_Driver

L4 HAL Drivers

Embed: (wiki syntax)

« Back to documentation index

Peripheral Control functions
Functions

Peripheral Control functions
[TIM Exported Functions]

Peripheral Control functions. More...

Functions

__weak HAL_StatusTypeDef HAL_TIM_OC_ConfigChannel (TIM_HandleTypeDef *htim, TIM_OC_InitTypeDef *sConfig, uint32_t Channel)
 Initializes the TIM Output Compare Channels according to the specified parameters in the TIM_OC_InitTypeDef.
HAL_StatusTypeDef HAL_TIM_IC_ConfigChannel (TIM_HandleTypeDef *htim, TIM_IC_InitTypeDef *sConfig, uint32_t Channel)
 Initializes the TIM Input Capture Channels according to the specified parameters in the TIM_IC_InitTypeDef.
__weak HAL_StatusTypeDef HAL_TIM_PWM_ConfigChannel (TIM_HandleTypeDef *htim, TIM_OC_InitTypeDef *sConfig, uint32_t Channel)
 Initializes the TIM PWM channels according to the specified parameters in the TIM_OC_InitTypeDef.
HAL_StatusTypeDef HAL_TIM_OnePulse_ConfigChannel (TIM_HandleTypeDef *htim, TIM_OnePulse_InitTypeDef *sConfig, uint32_t OutputChannel, uint32_t InputChannel)
 Initializes the TIM One Pulse Channels according to the specified parameters in the TIM_OnePulse_InitTypeDef.
HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStart (TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, uint32_t *BurstBuffer, uint32_t BurstLength)
 Configure the DMA Burst to transfer Data from the memory to the TIM peripheral.
HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStop (TIM_HandleTypeDef *htim, uint32_t BurstRequestSrc)
 Stops the TIM DMA Burst mode.
HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStart (TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, uint32_t *BurstBuffer, uint32_t BurstLength)
 Configure the DMA Burst to transfer Data from the TIM peripheral to the memory.
HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStop (TIM_HandleTypeDef *htim, uint32_t BurstRequestSrc)
 Stop the DMA burst reading.
HAL_StatusTypeDef HAL_TIM_GenerateEvent (TIM_HandleTypeDef *htim, uint32_t EventSource)
 Generate a software event.
__weak HAL_StatusTypeDef HAL_TIM_ConfigOCrefClear (TIM_HandleTypeDef *htim, TIM_ClearInputConfigTypeDef *sClearInputConfig, uint32_t Channel)
 Configures the OCRef clear feature.
HAL_StatusTypeDef HAL_TIM_ConfigClockSource (TIM_HandleTypeDef *htim, TIM_ClockConfigTypeDef *sClockSourceConfig)
 Configures the clock source to be used.
HAL_StatusTypeDef HAL_TIM_ConfigTI1Input (TIM_HandleTypeDef *htim, uint32_t TI1_Selection)
 Selects the signal connected to the TI1 input: direct from CH1_input or a XOR combination between CH1_input, CH2_input & CH3_input.
HAL_StatusTypeDef HAL_TIM_SlaveConfigSynchronization (TIM_HandleTypeDef *htim, TIM_SlaveConfigTypeDef *sSlaveConfig)
 Configures the TIM in Slave mode.
HAL_StatusTypeDef HAL_TIM_SlaveConfigSynchronization_IT (TIM_HandleTypeDef *htim, TIM_SlaveConfigTypeDef *sSlaveConfig)
 Configures the TIM in Slave mode in interrupt mode.
uint32_t HAL_TIM_ReadCapturedValue (TIM_HandleTypeDef *htim, uint32_t Channel)
 Read the captured value from Capture Compare unit.

Detailed Description

Peripheral Control functions. 

  ==============================================================================
                   ##### Peripheral Control functions #####
  ==============================================================================
 [..]
   This section provides functions allowing to:
      (+) Configure The Input Output channels for OC, PWM, IC or One Pulse mode.
      (+) Configure External Clock source.
      (+) Configure Complementary channels, break features and dead time.
      (+) Configure Master and the Slave synchronization.
      (+) Configure the DMA Burst Mode.

Function Documentation

HAL_StatusTypeDef HAL_TIM_ConfigClockSource ( TIM_HandleTypeDef *  htim,
TIM_ClockConfigTypeDef *  sClockSourceConfig 
)

Configures the clock source to be used.

Parameters:
htim,:TIM handle
sClockSourceConfig,:pointer to a TIM_ClockConfigTypeDef structure that contains the clock source information for the TIM peripheral.
Return values:
HALstatus

Definition at line 3870 of file stm32l4xx_hal_tim.c.

__weak HAL_StatusTypeDef HAL_TIM_ConfigOCrefClear ( TIM_HandleTypeDef *  htim,
TIM_ClearInputConfigTypeDef *  sClearInputConfig,
uint32_t  Channel 
)

Configures the OCRef clear feature.

Parameters:
htim,:TIM handle
sClearInputConfig,:pointer to a TIM_ClearInputConfigTypeDef structure that contains the OCREF clear feature and parameters for the TIM peripheral.
Channel,:specifies the TIM Channel This parameter can be one of the following values:

  • TIM_CHANNEL_1: TIM Channel 1
  • TIM_CHANNEL_2: TIM Channel 2
  • TIM_CHANNEL_3: TIM Channel 3
  • TIM_CHANNEL_4: TIM Channel 4
Return values:
HALstatus

Definition at line 3766 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_ConfigTI1Input ( TIM_HandleTypeDef *  htim,
uint32_t  TI1_Selection 
)

Selects the signal connected to the TI1 input: direct from CH1_input or a XOR combination between CH1_input, CH2_input & CH3_input.

Parameters:
htim,:TIM handle.
TI1_Selection,:Indicate whether or not channel 1 is connected to the output of a XOR gate. This parameter can be one of the following values:

  • TIM_TI1SELECTION_CH1: The TIMx_CH1 pin is connected to TI1 input
  • TIM_TI1SELECTION_XORCOMBINATION: The TIMx_CH1, CH2 and CH3 pins are connected to the TI1 input (XOR combination)
Return values:
HALstatus

Definition at line 4031 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStart ( TIM_HandleTypeDef *  htim,
uint32_t  BurstBaseAddress,
uint32_t  BurstRequestSrc,
uint32_t *  BurstBuffer,
uint32_t  BurstLength 
)

Configure the DMA Burst to transfer Data from the TIM peripheral to the memory.

Parameters:
htim,:TIM handle
BurstBaseAddress,:TIM Base address from when the DMA will starts the Data read This parameters can be on of the following values:

  • TIM_DMABASE_CR1
  • TIM_DMABASE_CR2
  • TIM_DMABASE_SMCR
  • TIM_DMABASE_DIER
  • TIM_DMABASE_SR
  • TIM_DMABASE_EGR
  • TIM_DMABASE_CCMR1
  • TIM_DMABASE_CCMR2
  • TIM_DMABASE_CCER
  • TIM_DMABASE_CNT
  • TIM_DMABASE_PSC
  • TIM_DMABASE_ARR
  • TIM_DMABASE_RCR
  • TIM_DMABASE_CCR1
  • TIM_DMABASE_CCR2
  • TIM_DMABASE_CCR3
  • TIM_DMABASE_CCR4
  • TIM_DMABASE_BDTR
  • TIM_DMABASE_DCR
BurstRequestSrc,:TIM DMA Request sources This parameters can be on of the following values:

  • TIM_DMA_UPDATE: TIM update Interrupt source
  • TIM_DMA_CC1: TIM Capture Compare 1 DMA source
  • TIM_DMA_CC2: TIM Capture Compare 2 DMA source
  • TIM_DMA_CC3: TIM Capture Compare 3 DMA source
  • TIM_DMA_CC4: TIM Capture Compare 4 DMA source
  • TIM_DMA_COM: TIM Commutation DMA source
  • TIM_DMA_TRIGGER: TIM Trigger DMA source
BurstBuffer,:The Buffer address.
BurstLength,:DMA Burst length. This parameter can be one value between: TIM_DMABurstLength_1Transfer and TIM_DMABurstLength_18Transfers.
Return values:
HALstatus

Definition at line 3526 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_DMABurst_ReadStop ( TIM_HandleTypeDef *  htim,
uint32_t  BurstRequestSrc 
)

Stop the DMA burst reading.

Parameters:
htim,:TIM handle
BurstRequestSrc,:TIM DMA Request sources to disable.
Return values:
HALstatus

Definition at line 3658 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStart ( TIM_HandleTypeDef *  htim,
uint32_t  BurstBaseAddress,
uint32_t  BurstRequestSrc,
uint32_t *  BurstBuffer,
uint32_t  BurstLength 
)

Configure the DMA Burst to transfer Data from the memory to the TIM peripheral.

Parameters:
htim,:TIM handle
BurstBaseAddress,:TIM Base address from when the DMA will starts the Data write This parameters can be on of the following values:

  • TIM_DMABASE_CR1
  • TIM_DMABASE_CR2
  • TIM_DMABASE_SMCR
  • TIM_DMABASE_DIER
  • TIM_DMABASE_SR
  • TIM_DMABASE_EGR
  • TIM_DMABASE_CCMR1
  • TIM_DMABASE_CCMR2
  • TIM_DMABASE_CCER
  • TIM_DMABASE_CNT
  • TIM_DMABASE_PSC
  • TIM_DMABASE_ARR
  • TIM_DMABASE_RCR
  • TIM_DMABASE_CCR1
  • TIM_DMABASE_CCR2
  • TIM_DMABASE_CCR3
  • TIM_DMABASE_CCR4
  • TIM_DMABASE_BDTR
  • TIM_DMABASE_DCR
BurstRequestSrc,:TIM DMA Request sources This parameters can be on of the following values:

  • TIM_DMA_UPDATE: TIM update Interrupt source
  • TIM_DMA_CC1: TIM Capture Compare 1 DMA source
  • TIM_DMA_CC2: TIM Capture Compare 2 DMA source
  • TIM_DMA_CC3: TIM Capture Compare 3 DMA source
  • TIM_DMA_CC4: TIM Capture Compare 4 DMA source
  • TIM_DMA_COM: TIM Commutation DMA source
  • TIM_DMA_TRIGGER: TIM Trigger DMA source
BurstBuffer,:The Buffer address.
BurstLength,:DMA Burst length. This parameter can be one value between: TIM_DMABurstLength_1Transfer and TIM_DMABurstLength_18Transfers.
Return values:
HALstatus

Definition at line 3303 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_DMABurst_WriteStop ( TIM_HandleTypeDef *  htim,
uint32_t  BurstRequestSrc 
)

Stops the TIM DMA Burst mode.

Parameters:
htim,:TIM handle
BurstRequestSrc,:TIM DMA Request sources to disable
Return values:
HALstatus

Definition at line 3434 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_GenerateEvent ( TIM_HandleTypeDef *  htim,
uint32_t  EventSource 
)

Generate a software event.

Parameters:
htim,:TIM handle
EventSource,:specifies the event source. This parameter can be one of the following values:

  • TIM_EVENTSOURCE_UPDATE: Timer update Event source
  • TIM_EVENTSOURCE_CC1: Timer Capture Compare 1 Event source
  • TIM_EVENTSOURCE_CC2: Timer Capture Compare 2 Event source
  • TIM_EVENTSOURCE_CC3: Timer Capture Compare 3 Event source
  • TIM_EVENTSOURCE_CC4: Timer Capture Compare 4 Event source
  • TIM_EVENTSOURCE_COM: Timer COM event source
  • TIM_EVENTSOURCE_TRIGGER: Timer Trigger Event source
  • TIM_EVENTSOURCE_BREAK: Timer Break event source
  • TIM_EVENTSOURCE_BREAK2: Timer Break2 event source
Return values:
None

Definition at line 3729 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_IC_ConfigChannel ( TIM_HandleTypeDef *  htim,
TIM_IC_InitTypeDef *  sConfig,
uint32_t  Channel 
)

Initializes the TIM Input Capture Channels according to the specified parameters in the TIM_IC_InitTypeDef.

Parameters:
htim,:TIM IC handle
sConfig,:TIM Input Capture configuration structure
Channel: TIM Channels to be enabled This parameter can be one of the following values:

  • TIM_CHANNEL_1: TIM Channel 1 selected
  • TIM_CHANNEL_2: TIM Channel 2 selected
  • TIM_CHANNEL_3: TIM Channel 3 selected
  • TIM_CHANNEL_4: TIM Channel 4 selected
Return values:
HALstatus

Definition at line 2968 of file stm32l4xx_hal_tim.c.

__weak HAL_StatusTypeDef HAL_TIM_OC_ConfigChannel ( TIM_HandleTypeDef *  htim,
TIM_OC_InitTypeDef *  sConfig,
uint32_t  Channel 
)

Initializes the TIM Output Compare Channels according to the specified parameters in the TIM_OC_InitTypeDef.

Parameters:
htim,:TIM Output Compare handle
sConfig,:TIM Output Compare configuration structure
Channel: TIM Channels to be enabled This parameter can be one of the following values:

  • TIM_CHANNEL_1: TIM Channel 1 selected
  • TIM_CHANNEL_2: TIM Channel 2 selected
  • TIM_CHANNEL_3: TIM Channel 3 selected
  • TIM_CHANNEL_4: TIM Channel 4 selected
  • TIM_CHANNEL_5: TIM Channel 5 selected
  • TIM_CHANNEL_6: TIM Channel 6 selected
Return values:
HALstatus

Definition at line 2896 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_OnePulse_ConfigChannel ( TIM_HandleTypeDef *  htim,
TIM_OnePulse_InitTypeDef *  sConfig,
uint32_t  OutputChannel,
uint32_t  InputChannel 
)

Initializes the TIM One Pulse Channels according to the specified parameters in the TIM_OnePulse_InitTypeDef.

Parameters:
htim,:TIM One Pulse handle
sConfig,:TIM One Pulse configuration structure
OutputChannel: TIM Channels to be enabled This parameter can be one of the following values:

  • TIM_CHANNEL_1: TIM Channel 1 selected
  • TIM_CHANNEL_2: TIM Channel 2 selected
InputChannel: TIM Channels to be enabled This parameter can be one of the following values:

  • TIM_CHANNEL_1: TIM Channel 1 selected
  • TIM_CHANNEL_2: TIM Channel 2 selected
Return values:
HALstatus

Definition at line 3167 of file stm32l4xx_hal_tim.c.

__weak HAL_StatusTypeDef HAL_TIM_PWM_ConfigChannel ( TIM_HandleTypeDef *  htim,
TIM_OC_InitTypeDef *  sConfig,
uint32_t  Channel 
)

Initializes the TIM PWM channels according to the specified parameters in the TIM_OC_InitTypeDef.

Parameters:
htim,:TIM handle
sConfig,:TIM PWM configuration structure
Channel: TIM Channels to be enabled This parameter can be one of the following values:

  • TIM_CHANNEL_1: TIM Channel 1 selected
  • TIM_CHANNEL_2: TIM Channel 2 selected
  • TIM_CHANNEL_3: TIM Channel 3 selected
  • TIM_CHANNEL_4: TIM Channel 4 selected
Return values:
HALstatus

Definition at line 3064 of file stm32l4xx_hal_tim.c.

uint32_t HAL_TIM_ReadCapturedValue ( TIM_HandleTypeDef *  htim,
uint32_t  Channel 
)

Read the captured value from Capture Compare unit.

Parameters:
htim,:TIM handle.
Channel: TIM Channels to be enabled This parameter can be one of the following values:

  • TIM_CHANNEL_1: TIM Channel 1 selected
  • TIM_CHANNEL_2: TIM Channel 2 selected
  • TIM_CHANNEL_3: TIM Channel 3 selected
  • TIM_CHANNEL_4: TIM Channel 4 selected
Return values:
Capturedvalue

Definition at line 4136 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_SlaveConfigSynchronization ( TIM_HandleTypeDef *  htim,
TIM_SlaveConfigTypeDef *  sSlaveConfig 
)

Configures the TIM in Slave mode.

Parameters:
htim,:TIM handle.
sSlaveConfig,:pointer to a TIM_SlaveConfigTypeDef structure that contains the selected trigger (internal trigger input, filtered timer input or external trigger input) and the ) and the Slave mode (Disable, Reset, Gated, Trigger, External clock mode 1).
Return values:
HALstatus

Definition at line 4063 of file stm32l4xx_hal_tim.c.

HAL_StatusTypeDef HAL_TIM_SlaveConfigSynchronization_IT ( TIM_HandleTypeDef *  htim,
TIM_SlaveConfigTypeDef *  sSlaveConfig 
)

Configures the TIM in Slave mode in interrupt mode.

Parameters:
htim,:TIM handle.
sSlaveConfig,:pointer to a TIM_SlaveConfigTypeDef structure that contains the selected trigger (internal trigger input, filtered timer input or external trigger input) and the ) and the Slave mode (Disable, Reset, Gated, Trigger, External clock mode 1).
Return values:
HALstatus

Definition at line 4098 of file stm32l4xx_hal_tim.c.

Generated on Tue Jul 12 2022 10:58:18 by  doxygen 1.7.2