Martin Johnson / STM32F3-Discovery

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Space_Invaders_Demo neopixels gpio_test_stm32f3_discovery gpio_test_systimer ... more

Embed: (wiki syntax)

« Back to documentation index

TimeBase management functions
Functions

TimeBase management functions
[TIM_Private_Functions]

TimeBase management functions. More...

Functions

void TIM_DeInit (TIM_TypeDef *TIMx)
 Deinitializes the TIMx peripheral registers to their default reset values.
void TIM_TimeBaseInit (TIM_TypeDef *TIMx, TIM_TimeBaseInitTypeDef *TIM_TimeBaseInitStruct)
 Initializes the TIMx Time Base Unit peripheral according to the specified parameters in the TIM_TimeBaseInitStruct.
void TIM_TimeBaseStructInit (TIM_TimeBaseInitTypeDef *TIM_TimeBaseInitStruct)
 Fills each TIM_TimeBaseInitStruct member with its default value.
void TIM_PrescalerConfig (TIM_TypeDef *TIMx, uint16_t Prescaler, uint16_t TIM_PSCReloadMode)
 Configures the TIMx Prescaler.
void TIM_CounterModeConfig (TIM_TypeDef *TIMx, uint16_t TIM_CounterMode)
 Specifies the TIMx Counter Mode to be used.
void TIM_SetCounter (TIM_TypeDef *TIMx, uint32_t Counter)
 Sets the TIMx Counter Register value.
void TIM_SetAutoreload (TIM_TypeDef *TIMx, uint32_t Autoreload)
 Sets the TIMx Autoreload Register value.
uint32_t TIM_GetCounter (TIM_TypeDef *TIMx)
 Gets the TIMx Counter value.
uint16_t TIM_GetPrescaler (TIM_TypeDef *TIMx)
 Gets the TIMx Prescaler value.
void TIM_UpdateDisableConfig (TIM_TypeDef *TIMx, FunctionalState NewState)
 Enables or Disables the TIMx Update event.
void TIM_UpdateRequestConfig (TIM_TypeDef *TIMx, uint16_t TIM_UpdateSource)
 Configures the TIMx Update Request Interrupt source.
void TIM_UIFRemap (TIM_TypeDef *TIMx, FunctionalState NewState)
 Sets or resets the update interrupt flag (UIF)status bit Remapping.
void TIM_ARRPreloadConfig (TIM_TypeDef *TIMx, FunctionalState NewState)
 Enables or disables TIMx peripheral Preload register on ARR.
void TIM_SelectOnePulseMode (TIM_TypeDef *TIMx, uint16_t TIM_OPMode)
 Selects the TIMx's One Pulse Mode.
void TIM_SetClockDivision (TIM_TypeDef *TIMx, uint16_t TIM_CKD)
 Sets the TIMx Clock Division value.
void TIM_Cmd (TIM_TypeDef *TIMx, FunctionalState NewState)
 Enables or disables the specified TIM peripheral.

Detailed Description

TimeBase management functions. 

 ===============================================================================
                   ##### TimeBase management functions #####
 ===============================================================================  
  
             
    *** TIM Driver: how to use it in Timing(Time base) Mode ***
    ============================================================ 
    [..]
    To use the Timer in Timing(Time base) mode, the following steps are mandatory:
       
    (#) Enable TIM clock using 
        RCC_APBxPeriphClockCmd(RCC_APBxPeriph_TIMx, ENABLE) function               
    (#) Fill the TIM_TimeBaseInitStruct with the desired parameters.   
    (#) Call TIM_TimeBaseInit(TIMx, &TIM_TimeBaseInitStruct) to configure 
        the Time Base unit
        with the corresponding configuration        
    (#) Enable the NVIC if you need to generate the update interrupt.        
    (#) Enable the corresponding interrupt using the function 
        TIM_ITConfig(TIMx, TIM_IT_Update)      
    (#) Call the TIM_Cmd(ENABLE) function to enable the TIM counter.
    [..]                  
    (@) All other functions can be used separately to modify, if needed,
        a specific feature of the Timer.

Function Documentation

void TIM_ARRPreloadConfig ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Enables or disables TIMx peripheral Preload register on ARR.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
NewState,:new state of the TIMx peripheral Preload register This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 532 of file stm32f30x_tim.c.

void TIM_Cmd ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Enables or disables the specified TIM peripheral.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6, 7, 8, 15, 16, 17 and 20 to select the TIMx peripheral.
NewState,:new state of the TIMx peripheral. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 603 of file stm32f30x_tim.c.

void TIM_CounterModeConfig ( TIM_TypeDef *  TIMx,
uint16_t  TIM_CounterMode 
)

Specifies the TIMx Counter Mode to be used.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 20 or 8 to select the TIM peripheral.
TIM_CounterMode,:specifies the Counter Mode to be used This parameter can be one of the following values:

  • TIM_CounterMode_Up: TIM Up Counting Mode
  • TIM_CounterMode_Down: TIM Down Counting Mode
  • TIM_CounterMode_CenterAligned1: TIM Center Aligned Mode1
  • TIM_CounterMode_CenterAligned2: TIM Center Aligned Mode2
  • TIM_CounterMode_CenterAligned3: TIM Center Aligned Mode3
Return values:
None

Definition at line 367 of file stm32f30x_tim.c.

void TIM_DeInit ( TIM_TypeDef *  TIMx )

Deinitializes the TIMx peripheral registers to their default reset values.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16,17 or 20 to select the TIM peripheral.
Return values:
None

Definition at line 199 of file stm32f30x_tim.c.

uint32_t TIM_GetCounter ( TIM_TypeDef *  TIMx )

Gets the TIMx Counter value.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
Return values:
CounterRegister value

Definition at line 422 of file stm32f30x_tim.c.

uint16_t TIM_GetPrescaler ( TIM_TypeDef *  TIMx )

Gets the TIMx Prescaler value.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
Return values:
PrescalerRegister value.

Definition at line 436 of file stm32f30x_tim.c.

void TIM_PrescalerConfig ( TIM_TypeDef *  TIMx,
uint16_t  Prescaler,
uint16_t  TIM_PSCReloadMode 
)

Configures the TIMx Prescaler.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 8, 15, 16 or 17 to select the TIM peripheral.
Prescaler,:specifies the Prescaler Register value
TIM_PSCReloadMode,:specifies the TIM Prescaler Reload mode This parameter can be one of the following values:

  • TIM_PSCReloadMode_Update: The Prescaler is loaded at the update event.
  • TIM_PSCReloadMode_Immediate: The Prescaler is loaded immediately.
Return values:
None

Definition at line 344 of file stm32f30x_tim.c.

void TIM_SelectOnePulseMode ( TIM_TypeDef *  TIMx,
uint16_t  TIM_OPMode 
)

Selects the TIMx's One Pulse Mode.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
TIM_OPMode,:specifies the OPM Mode to be used. This parameter can be one of the following values:

  • TIM_OPMode_Single
  • TIM_OPMode_Repetitive
Return values:
None

Definition at line 559 of file stm32f30x_tim.c.

void TIM_SetAutoreload ( TIM_TypeDef *  TIMx,
uint32_t  Autoreload 
)

Sets the TIMx Autoreload Register value.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
Autoreload,:specifies the Autoreload register new value.
Return values:
None

Definition at line 408 of file stm32f30x_tim.c.

void TIM_SetClockDivision ( TIM_TypeDef *  TIMx,
uint16_t  TIM_CKD 
)

Sets the TIMx Clock Division value.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 8, 15, 16 or 17, to select the TIM peripheral.
TIM_CKD,:specifies the clock division value. This parameter can be one of the following value:

  • TIM_CKD_DIV1: TDTS = Tck_tim
  • TIM_CKD_DIV2: TDTS = 2*Tck_tim
  • TIM_CKD_DIV4: TDTS = 4*Tck_tim
Return values:
None

Definition at line 582 of file stm32f30x_tim.c.

void TIM_SetCounter ( TIM_TypeDef *  TIMx,
uint32_t  Counter 
)

Sets the TIMx Counter Register value.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
Counter,:specifies the Counter register new value.
Return values:
None

Definition at line 393 of file stm32f30x_tim.c.

void TIM_TimeBaseInit ( TIM_TypeDef *  TIMx,
TIM_TimeBaseInitTypeDef *  TIM_TimeBaseInitStruct 
)

Initializes the TIMx Time Base Unit peripheral according to the specified parameters in the TIM_TimeBaseInitStruct.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
TIM_TimeBaseInitStruct,:pointer to a TIM_TimeBaseInitTypeDef structure that contains the configuration information for the specified TIM peripheral.
Return values:
None

Definition at line 272 of file stm32f30x_tim.c.

void TIM_TimeBaseStructInit ( TIM_TimeBaseInitTypeDef *  TIM_TimeBaseInitStruct )

Fills each TIM_TimeBaseInitStruct member with its default value.

Parameters:
TIM_TimeBaseInitStruct: pointer to a TIM_TimeBaseInitTypeDef structure which will be initialized.
Return values:
None

Definition at line 324 of file stm32f30x_tim.c.

void TIM_UIFRemap ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Sets or resets the update interrupt flag (UIF)status bit Remapping.

when sets, reading TIMx_CNT register returns UIF bit instead of CNT[31]

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
NewState,:new state of the UIFREMAP bit. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 507 of file stm32f30x_tim.c.

void TIM_UpdateDisableConfig ( TIM_TypeDef *  TIMx,
FunctionalState  NewState 
)

Enables or Disables the TIMx Update event.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
NewState,:new state of the TIMx UDIS bit This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 452 of file stm32f30x_tim.c.

void TIM_UpdateRequestConfig ( TIM_TypeDef *  TIMx,
uint16_t  TIM_UpdateSource 
)

Configures the TIMx Update Request Interrupt source.

Parameters:
TIMx,:where x can be 1, 2, 3, 4, 6 ,7 ,8, 15, 16, 17 or 20 to select the TIM peripheral.
TIM_UpdateSource,:specifies the Update source. This parameter can be one of the following values:

  • TIM_UpdateSource_Regular: Source of update is the counter overflow/underflow or the setting of UG bit, or an update generation through the slave mode controller.
  • TIM_UpdateSource_Global: Source of update is counter overflow/underflow.
Return values:
None

Definition at line 481 of file stm32f30x_tim.c.

Generated on Tue Jul 12 2022 17:34:46 by  doxygen 1.7.2