STM8L15x Standard Peripherals Drivers: TIM4

STM8L15x/16x Standard Peripherals Drivers

previous page next page
STM8L15x Standard Peripherals Drivers
Modules | Functions

TIM4

STM8L15x_StdPeriph_Driver

TIM4 driver modules. More...

Modules

 TIM4_Exported_Types
 TIM4_Exported_Macros
 TIM4_Private_Functions

Functions

void TIM4_ARRPreloadConfig (FunctionalState NewState)
 Enables or disables TIM4 peripheral Preload register on ARR.
void TIM4_ClearFlag (TIM4_FLAG_TypeDef TIM4_FLAG)
 Clears the TIM�s pending flags.
void TIM4_ClearITPendingBit (TIM4_IT_TypeDef TIM4_IT)
 Clears the TIM4's interrupt pending bits.
void TIM4_Cmd (FunctionalState NewState)
 Enables or disables the TIM4 peripheral.
void TIM4_DeInit (void)
 Deinitializes the TIM4 peripheral registers to their default reset values.
void TIM4_DMACmd (TIM4_DMASource_TypeDef TIM4_DMASource, FunctionalState NewState)
 Enables or disables the TIMx�s DMA Requests.
void TIM4_GenerateEvent (TIM4_EventSource_TypeDef TIM4_EventSource)
 Configures the TIM4 event to be generated by software.
uint8_t TIM4_GetCounter (void)
 Gets the TIM4 Counter value.
FlagStatus TIM4_GetFlagStatus (TIM4_FLAG_TypeDef TIM4_FLAG)
 Checks whether the specified TIM4 flag is set or not.
ITStatus TIM4_GetITStatus (TIM4_IT_TypeDef TIM4_IT)
 Checks whether the TIM4 interrupt has occurred or not.
TIM4_Prescaler_TypeDef TIM4_GetPrescaler (void)
 Gets the TIM4 Prescaler value.
void TIM4_InternalClockConfig (void)
 Enables the TIM4 internal Clock.
void TIM4_ITConfig (TIM4_IT_TypeDef TIM4_IT, FunctionalState NewState)
 Enables or disables the specified TIM4 interrupts.
void TIM4_PrescalerConfig (TIM4_Prescaler_TypeDef Prescaler, TIM4_PSCReloadMode_TypeDef TIM4_PSCReloadMode)
 Configures the TIM4 Prescaler.
void TIM4_SelectInputTrigger (TIM4_TRGSelection_TypeDef TIM4_InputTriggerSource)
 Selects the TIM4 Input Trigger source.
void TIM4_SelectMasterSlaveMode (FunctionalState NewState)
 Sets or Resets the TIM4 Master/Slave Mode.
void TIM4_SelectOnePulseMode (TIM4_OPMode_TypeDef TIM4_OPMode)
 Selects the TIM4�s One Pulse Mode.
void TIM4_SelectOutputTrigger (TIM4_TRGOSource_TypeDef TIM4_TRGOSource)
 Selects the TIM4 Trigger Output Mode.
void TIM4_SelectSlaveMode (TIM4_SlaveMode_TypeDef TIM4_SlaveMode)
 Selects the TIM4 Slave Mode.
void TIM4_SetAutoreload (uint8_t Autoreload)
 Sets the TIM4 Autoreload Register value.
void TIM4_SetCounter (uint8_t Counter)
 Sets the TIM4 Counter Register value.
void TIM4_TimeBaseInit (TIM4_Prescaler_TypeDef TIM4_Prescaler, uint8_t TIM4_Period)
 Initializes the TIM4 Time Base Unit according to the specified parameters.
void TIM4_UpdateDisableConfig (FunctionalState NewState)
 Enables or Disables the TIM4 Update event.
void TIM4_UpdateRequestConfig (TIM4_UpdateSource_TypeDef TIM4_UpdateSource)
 Selects the TIM4 Update Request Interrupt source.

Detailed Description

TIM4 driver modules.

Function Documentation

void TIM4_ARRPreloadConfig ( FunctionalState  NewState)

Enables or disables TIM4 peripheral Preload register on ARR.

Parameters:
NewState,:The new state of the TIM4 peripheral Preload register. This parameter can be ENABLE or DISABLE
Return values:
None

Definition at line 336 of file stm8l15x_tim4.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM4, and TIM4_CR1_ARPE.

void TIM4_ClearFlag ( TIM4_FLAG_TypeDef  TIM4_FLAG)

Clears the TIM�s pending flags.

Parameters:
TIM4_FLAG,:Specifies the flag to clear. This parameter can be one of the following values:
  • TIM4_FLAG_Update: Update
  • TIM4_FLAG_Trigger: Trigger
Return values:
None

Definition at line 494 of file stm8l15x_tim4.c.

References IS_TIM4_CLEAR_FLAG, and TIM4.

void TIM4_ClearITPendingBit ( TIM4_IT_TypeDef  TIM4_IT)

Clears the TIM4's interrupt pending bits.

Parameters:
TIM4_IT,:Specifies the pending bit to clear. This parameter can be one of the following values:
  • TIM4_IT_Update: Update
  • TIM4_IT_Trigger: Trigger
Return values:
None

Definition at line 544 of file stm8l15x_tim4.c.

References IS_TIM4_IT, and TIM4.

void TIM4_Cmd ( FunctionalState  NewState)

Enables or disables the TIM4 peripheral.

Parameters:
NewState,:The new state of the TIM4 peripheral. This parameter can be ENABLE or DISABLE
Return values:
None

Definition at line 382 of file stm8l15x_tim4.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM4, and TIM4_CR1_CEN.

void TIM4_DeInit ( void  )

Deinitializes the TIM4 peripheral registers to their default reset values.

Parameters:
None
Return values:
None

Definition at line 124 of file stm8l15x_tim4.c.

References TIM4, TIM4_ARR_RESET_VALUE, TIM4_CNTR_RESET_VALUE, TIM4_CR1_RESET_VALUE, TIM4_CR2_RESET_VALUE, TIM4_IER_RESET_VALUE, TIM4_PSCR_RESET_VALUE, TIM4_SMCR_RESET_VALUE, and TIM4_SR1_RESET_VALUE.

void TIM4_DMACmd ( TIM4_DMASource_TypeDef  TIM4_DMASource,
FunctionalState  NewState 
)

Enables or disables the TIMx�s DMA Requests.

Parameters:
TIM4_DMASources,:specifies the DMA Request sources. This parameter can be one of the following values:
  • TIM4_DMASource_Update: Update
NewState,:new state of the DMA Request sources. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 562 of file stm8l15x_tim4.c.

References DISABLE, IS_FUNCTIONAL_STATE, IS_TIM4_DMA_SOURCE, and TIM4.

void TIM4_GenerateEvent ( TIM4_EventSource_TypeDef  TIM4_EventSource)

Configures the TIM4 event to be generated by software.

Parameters:
TIM4_EventSource,:Specifies the event source. This parameter can be one of the following values:
  • TIM4_EventSource_Update: Update
  • TIM4_EventSource_Trigger: Trigger
Return values:
None

Definition at line 450 of file stm8l15x_tim4.c.

References IS_TIM4_EVENT_SOURCE, and TIM4.

uint8_t TIM4_GetCounter ( void  )

Gets the TIM4 Counter value.

Parameters:
None
Return values:
CounterRegister value.

Definition at line 249 of file stm8l15x_tim4.c.

References TIM4.

FlagStatus TIM4_GetFlagStatus ( TIM4_FLAG_TypeDef  TIM4_FLAG)

Checks whether the specified TIM4 flag is set or not.

Parameters:
TIM4_FLAG,:Specifies the flag to check. This parameter can be one of the following values:
  • TIM4_FLAG_Update: Update
  • TIM4_FLAG_Trigger: Trigger
Return values:
FlagStatus,:The new state of TIM4_FLAG. This parameter can be SET or RESET.

Definition at line 468 of file stm8l15x_tim4.c.

References IS_TIM4_GET_FLAG, RESET, SET, and TIM4.

ITStatus TIM4_GetITStatus ( TIM4_IT_TypeDef  TIM4_IT)

Checks whether the TIM4 interrupt has occurred or not.

Parameters:
TIM4_IT,:Specifies the TIM4 interrupt source to check. This parameter can be one of the following values:
  • TIM4_IT_Update: Update
  • TIM4_IT_Trigger: Trigger
Return values:
ITStatus,:The new state of the TIM4_IT. This parameter can be SET or RESET

Definition at line 512 of file stm8l15x_tim4.c.

References IS_TIM4_GET_IT, RESET, SET, and TIM4.

TIM4_Prescaler_TypeDef TIM4_GetPrescaler ( void  )

Gets the TIM4 Prescaler value.

Parameters:
None
Return values:
TIM4Prescaler can be one of the following values:
  • TIM4_Prescaler_1: Time base Prescaler = 1 (No effect)
  • TIM4_Prescaler_2: Time base Prescaler = 2
  • TIM4_Prescaler_4: Time base Prescaler = 4
  • TIM4_Prescaler_8: Time base Prescaler = 8
  • TIM4_Prescaler_16: Time base Prescaler = 16
  • TIM4_Prescaler_32: Time base Prescaler = 32
  • TIM4_Prescaler_64: Time base Prescaler = 64
  • TIM4_Prescaler_128: Time base Prescaler = 128
  • TIM4_Prescaler_256: Time base Prescaler = 256
  • TIM4_Prescaler_512: Time base Prescaler = 512
  • TIM4_Prescaler_1024: Time base Prescaler = 1024
  • TIM4_Prescaler_2048: Time base Prescaler = 2048
  • TIM4_Prescaler_4096: Time base Prescaler = 4096
  • TIM4_Prescaler_8192: Time base Prescaler = 8192
  • TIM4_Prescaler_16384: Time base Prescaler = 16384
  • TIM4_Prescaler_32768: Time base Prescaler = 32768

Definition at line 278 of file stm8l15x_tim4.c.

References TIM4.

void TIM4_InternalClockConfig ( void  )

Enables the TIM4 internal Clock.

Parameters:
None
Return values:
None

Definition at line 601 of file stm8l15x_tim4.c.

References TIM4, and TIM4_SMCR_SMS.

void TIM4_ITConfig ( TIM4_IT_TypeDef  TIM4_IT,
FunctionalState  NewState 
)

Enables or disables the specified TIM4 interrupts.

Parameters:
TIM4_IT,:Specifies the TIM4 interrupts sources to be enabled or disabled. This parameter can be one of the following values:
  • TIM4_IT_Update: Update
  • TIM4_IT_Trigger: Trigger
NewState,:The new state of the TIM4 peripheral. This parameter can be ENABLE or DISABLE
Return values:
None

Definition at line 424 of file stm8l15x_tim4.c.

References DISABLE, IS_FUNCTIONAL_STATE, IS_TIM4_IT, and TIM4.

void TIM4_PrescalerConfig ( TIM4_Prescaler_TypeDef  Prescaler,
TIM4_PSCReloadMode_TypeDef  TIM4_PSCReloadMode 
)

Configures the TIM4 Prescaler.

Parameters:
Prescaler,:Specifies the Prescaler Register value This parameter can be one of the following values:
  • TIM4_Prescaler_1: Time base Prescaler = 1 (No effect)
  • TIM4_Prescaler_2: Time base Prescaler = 2
  • TIM4_Prescaler_4: Time base Prescaler = 4
  • TIM4_Prescaler_8: Time base Prescaler = 8
  • TIM4_Prescaler_16: Time base Prescaler = 16
  • TIM4_Prescaler_32: Time base Prescaler = 32
  • TIM4_Prescaler_64: Time base Prescaler = 64
  • TIM4_Prescaler_128: Time base Prescaler = 128
  • TIM4_Prescaler_256: Time base Prescaler = 256
  • TIM4_Prescaler_512: Time base Prescaler = 512
  • TIM4_Prescaler_1024: Time base Prescaler = 1024
  • TIM4_Prescaler_2048: Time base Prescaler = 2048
  • TIM4_Prescaler_4096: Time base Prescaler = 4096
  • TIM4_Prescaler_8192: Time base Prescaler = 8192
  • TIM4_Prescaler_16384: Time base Prescaler = 16384
  • TIM4_Prescaler_32768: Time base Prescaler = 32768
TIM4_PSCReloadMode,:Specifies the TIM4 Prescaler Reload mode. This parameter can be one of the following values:
  • TIM4_PSCReloadMode_Update: Prescaler value is reloaded at every update
  • TIM4_PSCReloadMode_Immediate: Prescaler value is reloaded immediatly
Return values:
None

Definition at line 199 of file stm8l15x_tim4.c.

References IS_TIM4_Prescaler, IS_TIM4_Prescaler_RELOAD, TIM4, TIM4_EGR_UG, and TIM4_PSCReloadMode_Immediate.

void TIM4_SelectInputTrigger ( TIM4_TRGSelection_TypeDef  TIM4_InputTriggerSource)

Selects the TIM4 Input Trigger source.

Parameters:
TIM4_InputTriggerSource,:Specifies Input Trigger source. This parameter can be one of the following values:
  • TIM4_TRGSelection_TIM5: TRIG Input source = TIM5 TRIG Output
  • TIM4_TRGSelection_TIM1: TRIG Input source = TIM1 TRIG Output
  • TIM4_TRGSelection_TIM3: TRIG Input source = TIM3 TRIG Output
  • TIM4_TRGSelection_TIM2: TRIG Input source = TIM2 TRIG Output
Return values:
None

Definition at line 645 of file stm8l15x_tim4.c.

References IS_TIM4_TRIGGER_SELECTION, TIM4, and TIM4_SMCR_TS.

void TIM4_SelectMasterSlaveMode ( FunctionalState  NewState)

Sets or Resets the TIM4 Master/Slave Mode.

Parameters:
NewState,:The new state of the synchronization between TIM4 and its slaves (through TRGO). This parameter can be ENABLE or DISABLE
Return values:
None

Definition at line 724 of file stm8l15x_tim4.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM4, and TIM4_SMCR_MSM.

void TIM4_SelectOnePulseMode ( TIM4_OPMode_TypeDef  TIM4_OPMode)

Selects the TIM4�s One Pulse Mode.

Parameters:
TIM4_OPMode,:Specifies the OPM Mode to be used. This parameter can be one of the following values:
  • TIM4_OPMode_Single: Single one Pulse mode (OPM Active)
  • TIM4_OPMode_Repetitive: Repetitive Pulse mode (OPM inactive)
Return values:
None

Definition at line 360 of file stm8l15x_tim4.c.

References IS_TIM4_OPM_MODE, TIM4, TIM4_CR1_OPM, and TIM4_OPMode_Single.

void TIM4_SelectOutputTrigger ( TIM4_TRGOSource_TypeDef  TIM4_TRGOSource)

Selects the TIM4 Trigger Output Mode.

Parameters:
TIM4_TRGOSource,:Specifies the Trigger Output source. This parameter can be one of the following values:
  • TIM4_TRGOSource_Reset: Trigger Output source = Reset
  • TIM4_TRGOSource_Enable: Trigger Output source = TIM4 is enabled
  • TIM4_TRGOSource_Update: Trigger Output source = Update event
Return values:
None

Definition at line 670 of file stm8l15x_tim4.c.

References IS_TIM4_TRGO_SOURCE, TIM4, and TIM4_CR2_MMS.

void TIM4_SelectSlaveMode ( TIM4_SlaveMode_TypeDef  TIM4_SlaveMode)

Selects the TIM4 Slave Mode.

Parameters:
TIM4_SlaveMode,:Specifies the TIM4 Slave Mode. This parameter can be one of the following values:
  • TIM4_SlaveMode_Disable: Disable slave mode to clock the prescaler directly with the internal clock
  • TIM4_SlaveMode_Reset: Slave Mode Selection = Reset
  • TIM4_SlaveMode_Gated: Slave Mode Selection = Gated
  • TIM4_SlaveMode_Trigger: Slave Mode Selection = Trigger
  • TIM4_SlaveMode_External1: Slave Mode Selection = External 1
Return values:
None

Definition at line 700 of file stm8l15x_tim4.c.

References IS_TIM4_SLAVE_MODE, TIM4, and TIM4_SMCR_SMS.

void TIM4_SetAutoreload ( uint8_t  Autoreload)

Sets the TIM4 Autoreload Register value.

Parameters:
Autoreload,:Specifies the Autoreload register new value. This parameter is between 0x00 and 0xFF.
Return values:
None

Definition at line 238 of file stm8l15x_tim4.c.

References TIM4.

void TIM4_SetCounter ( uint8_t  Counter)

Sets the TIM4 Counter Register value.

Parameters:
Counter,:Specifies the Counter register new value. This parameter is between 0x00 and 0xFF.
Return values:
None

Definition at line 226 of file stm8l15x_tim4.c.

References TIM4.

void TIM4_TimeBaseInit ( TIM4_Prescaler_TypeDef  TIM4_Prescaler,
uint8_t  TIM4_Period 
)

Initializes the TIM4 Time Base Unit according to the specified parameters.

Parameters:
TIM4_Prescaler,:Prescaler This parameter can be one of the following values:
  • TIM4_Prescaler_1: Time base Prescaler = 1 (No effect)
  • TIM4_Prescaler_2: Time base Prescaler = 2
  • TIM4_Prescaler_4: Time base Prescaler = 4
  • TIM4_Prescaler_8: Time base Prescaler = 8
  • TIM4_Prescaler_16: Time base Prescaler = 16
  • TIM4_Prescaler_32: Time base Prescaler = 32
  • TIM4_Prescaler_64: Time base Prescaler = 64
  • TIM4_Prescaler_128: Time base Prescaler = 128
  • TIM4_Prescaler_256: Time base Prescaler = 256
  • TIM4_Prescaler_512: Time base Prescaler = 512
  • TIM4_Prescaler_1024: Time base Prescaler = 1024
  • TIM4_Prescaler_2048: Time base Prescaler = 2048
  • TIM4_Prescaler_4096: Time base Prescaler = 4096
  • TIM4_Prescaler_8192: Time base Prescaler = 8192
  • TIM4_Prescaler_16384: Time base Prescaler = 16384
  • TIM4_Prescaler_32768: Time base Prescaler = 32768
TIM4_Period,:This parameter must be a value between 0x00 and 0xFF.
Return values:
None

Definition at line 159 of file stm8l15x_tim4.c.

References IS_TIM4_Prescaler, TIM4, and TIM4_EventSource_Update.

void TIM4_UpdateDisableConfig ( FunctionalState  NewState)

Enables or Disables the TIM4 Update event.

Parameters:
NewState,:The new state of the TIM4 peripheral Preload register. This parameter can be ENABLE or DISABLE
Return values:
None

Definition at line 290 of file stm8l15x_tim4.c.

References DISABLE, IS_FUNCTIONAL_STATE, TIM4, and TIM4_CR1_UDIS.

void TIM4_UpdateRequestConfig ( TIM4_UpdateSource_TypeDef  TIM4_UpdateSource)

Selects the TIM4 Update Request Interrupt source.

Parameters:
TIM4_UpdateSource,:Specifies the Update source. This parameter can be one of the following values:
  • TIM4_UpdateSource_Global: Global Update request source
  • TIM4_UpdateSource_Regular: Regular Update request source
Return values:
None

Definition at line 314 of file stm8l15x_tim4.c.

References IS_TIM4_UPDATE_SOURCE, TIM4, TIM4_CR1_URS, and TIM4_UpdateSource_Regular.

STM8S Firmware Library: Overview

 

 

 

For complete documentation on STM8L15x 8-bit microcontrollers platform visit www.st.com

 

previous page start next page