STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
|
TIM HAL module driver. This file provides firmware functions to manage the following functionalities of the Timer (TIM) peripheral: More...
#include "stm32f4xx_hal.h"
Go to the source code of this file.
Functions | |
static void | TIM_OC1_SetConfig (TIM_TypeDef *TIMx, const TIM_OC_InitTypeDef *OC_Config) |
Timer Output Compare 1 configuration. | |
static void | TIM_OC3_SetConfig (TIM_TypeDef *TIMx, const TIM_OC_InitTypeDef *OC_Config) |
Timer Output Compare 3 configuration. | |
static void | TIM_OC4_SetConfig (TIM_TypeDef *TIMx, const TIM_OC_InitTypeDef *OC_Config) |
Timer Output Compare 4 configuration. | |
static void | TIM_TI1_ConfigInputStage (TIM_TypeDef *TIMx, uint32_t TIM_ICPolarity, uint32_t TIM_ICFilter) |
Configure the Polarity and Filter for TI1. | |
static void | TIM_TI2_SetConfig (TIM_TypeDef *TIMx, uint32_t TIM_ICPolarity, uint32_t TIM_ICSelection, uint32_t TIM_ICFilter) |
Configure the TI2 as Input. | |
static void | TIM_TI2_ConfigInputStage (TIM_TypeDef *TIMx, uint32_t TIM_ICPolarity, uint32_t TIM_ICFilter) |
Configure the Polarity and Filter for TI2. | |
static void | TIM_TI3_SetConfig (TIM_TypeDef *TIMx, uint32_t TIM_ICPolarity, uint32_t TIM_ICSelection, uint32_t TIM_ICFilter) |
Configure the TI3 as Input. | |
static void | TIM_TI4_SetConfig (TIM_TypeDef *TIMx, uint32_t TIM_ICPolarity, uint32_t TIM_ICSelection, uint32_t TIM_ICFilter) |
Configure the TI4 as Input. | |
static void | TIM_ITRx_SetConfig (TIM_TypeDef *TIMx, uint32_t InputTriggerSource) |
Selects the Input Trigger source. | |
static void | TIM_DMAPeriodElapsedCplt (DMA_HandleTypeDef *hdma) |
TIM DMA Period Elapse complete callback. | |
static void | TIM_DMAPeriodElapsedHalfCplt (DMA_HandleTypeDef *hdma) |
TIM DMA Period Elapse half complete callback. | |
static void | TIM_DMADelayPulseCplt (DMA_HandleTypeDef *hdma) |
TIM DMA Delay Pulse complete callback. | |
static void | TIM_DMATriggerCplt (DMA_HandleTypeDef *hdma) |
TIM DMA Trigger callback. | |
static void | TIM_DMATriggerHalfCplt (DMA_HandleTypeDef *hdma) |
TIM DMA Trigger half complete callback. | |
static HAL_StatusTypeDef | TIM_SlaveTimer_SetConfig (TIM_HandleTypeDef *htim, const TIM_SlaveConfigTypeDef *sSlaveConfig) |
Slave Timer configuration function. | |
HAL_StatusTypeDef | HAL_TIM_Base_Init (TIM_HandleTypeDef *htim) |
Initializes the TIM Time base Unit according to the specified parameters in the TIM_HandleTypeDef and initialize the associated handle. | |
HAL_StatusTypeDef | HAL_TIM_Base_DeInit (TIM_HandleTypeDef *htim) |
DeInitializes the TIM Base peripheral. | |
void | HAL_TIM_Base_MspInit (TIM_HandleTypeDef *htim) |
Initializes the TIM Base MSP. | |
void | HAL_TIM_Base_MspDeInit (TIM_HandleTypeDef *htim) |
DeInitializes TIM Base MSP. | |
HAL_StatusTypeDef | HAL_TIM_Base_Start (TIM_HandleTypeDef *htim) |
Starts the TIM Base generation. | |
HAL_StatusTypeDef | HAL_TIM_Base_Stop (TIM_HandleTypeDef *htim) |
Stops the TIM Base generation. | |
HAL_StatusTypeDef | HAL_TIM_Base_Start_IT (TIM_HandleTypeDef *htim) |
Starts the TIM Base generation in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_Base_Stop_IT (TIM_HandleTypeDef *htim) |
Stops the TIM Base generation in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_Base_Start_DMA (TIM_HandleTypeDef *htim, const uint32_t *pData, uint16_t Length) |
Starts the TIM Base generation in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_Base_Stop_DMA (TIM_HandleTypeDef *htim) |
Stops the TIM Base generation in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_OC_Init (TIM_HandleTypeDef *htim) |
Initializes the TIM Output Compare according to the specified parameters in the TIM_HandleTypeDef and initializes the associated handle. | |
HAL_StatusTypeDef | HAL_TIM_OC_DeInit (TIM_HandleTypeDef *htim) |
DeInitializes the TIM peripheral. | |
void | HAL_TIM_OC_MspInit (TIM_HandleTypeDef *htim) |
Initializes the TIM Output Compare MSP. | |
void | HAL_TIM_OC_MspDeInit (TIM_HandleTypeDef *htim) |
DeInitializes TIM Output Compare MSP. | |
HAL_StatusTypeDef | HAL_TIM_OC_Start (TIM_HandleTypeDef *htim, uint32_t Channel) |
Starts the TIM Output Compare signal generation. | |
HAL_StatusTypeDef | HAL_TIM_OC_Stop (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Output Compare signal generation. | |
HAL_StatusTypeDef | HAL_TIM_OC_Start_IT (TIM_HandleTypeDef *htim, uint32_t Channel) |
Starts the TIM Output Compare signal generation in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_OC_Stop_IT (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Output Compare signal generation in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_OC_Start_DMA (TIM_HandleTypeDef *htim, uint32_t Channel, const uint32_t *pData, uint16_t Length) |
Starts the TIM Output Compare signal generation in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_OC_Stop_DMA (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Output Compare signal generation in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_PWM_Init (TIM_HandleTypeDef *htim) |
Initializes the TIM PWM Time Base according to the specified parameters in the TIM_HandleTypeDef and initializes the associated handle. | |
HAL_StatusTypeDef | HAL_TIM_PWM_DeInit (TIM_HandleTypeDef *htim) |
DeInitializes the TIM peripheral. | |
void | HAL_TIM_PWM_MspInit (TIM_HandleTypeDef *htim) |
Initializes the TIM PWM MSP. | |
void | HAL_TIM_PWM_MspDeInit (TIM_HandleTypeDef *htim) |
DeInitializes TIM PWM MSP. | |
HAL_StatusTypeDef | HAL_TIM_PWM_Start (TIM_HandleTypeDef *htim, uint32_t Channel) |
Starts the PWM signal generation. | |
HAL_StatusTypeDef | HAL_TIM_PWM_Stop (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the PWM signal generation. | |
HAL_StatusTypeDef | HAL_TIM_PWM_Start_IT (TIM_HandleTypeDef *htim, uint32_t Channel) |
Starts the PWM signal generation in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_PWM_Stop_IT (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the PWM signal generation in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_PWM_Start_DMA (TIM_HandleTypeDef *htim, uint32_t Channel, const uint32_t *pData, uint16_t Length) |
Starts the TIM PWM signal generation in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_PWM_Stop_DMA (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM PWM signal generation in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_IC_Init (TIM_HandleTypeDef *htim) |
Initializes the TIM Input Capture Time base according to the specified parameters in the TIM_HandleTypeDef and initializes the associated handle. | |
HAL_StatusTypeDef | HAL_TIM_IC_DeInit (TIM_HandleTypeDef *htim) |
DeInitializes the TIM peripheral. | |
void | HAL_TIM_IC_MspInit (TIM_HandleTypeDef *htim) |
Initializes the TIM Input Capture MSP. | |
void | HAL_TIM_IC_MspDeInit (TIM_HandleTypeDef *htim) |
DeInitializes TIM Input Capture MSP. | |
HAL_StatusTypeDef | HAL_TIM_IC_Start (TIM_HandleTypeDef *htim, uint32_t Channel) |
Starts the TIM Input Capture measurement. | |
HAL_StatusTypeDef | HAL_TIM_IC_Stop (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Input Capture measurement. | |
HAL_StatusTypeDef | HAL_TIM_IC_Start_IT (TIM_HandleTypeDef *htim, uint32_t Channel) |
Starts the TIM Input Capture measurement in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_IC_Stop_IT (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Input Capture measurement in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_IC_Start_DMA (TIM_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData, uint16_t Length) |
Starts the TIM Input Capture measurement in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_IC_Stop_DMA (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Input Capture measurement in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_OnePulse_Init (TIM_HandleTypeDef *htim, uint32_t OnePulseMode) |
Initializes the TIM One Pulse Time Base according to the specified parameters in the TIM_HandleTypeDef and initializes the associated handle. | |
HAL_StatusTypeDef | HAL_TIM_OnePulse_DeInit (TIM_HandleTypeDef *htim) |
DeInitializes the TIM One Pulse. | |
void | HAL_TIM_OnePulse_MspInit (TIM_HandleTypeDef *htim) |
Initializes the TIM One Pulse MSP. | |
void | HAL_TIM_OnePulse_MspDeInit (TIM_HandleTypeDef *htim) |
DeInitializes TIM One Pulse MSP. | |
HAL_StatusTypeDef | HAL_TIM_OnePulse_Start (TIM_HandleTypeDef *htim, uint32_t OutputChannel) |
Starts the TIM One Pulse signal generation. | |
HAL_StatusTypeDef | HAL_TIM_OnePulse_Stop (TIM_HandleTypeDef *htim, uint32_t OutputChannel) |
Stops the TIM One Pulse signal generation. | |
HAL_StatusTypeDef | HAL_TIM_OnePulse_Start_IT (TIM_HandleTypeDef *htim, uint32_t OutputChannel) |
Starts the TIM One Pulse signal generation in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_OnePulse_Stop_IT (TIM_HandleTypeDef *htim, uint32_t OutputChannel) |
Stops the TIM One Pulse signal generation in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_Encoder_Init (TIM_HandleTypeDef *htim, const TIM_Encoder_InitTypeDef *sConfig) |
Initializes the TIM Encoder Interface and initialize the associated handle. | |
HAL_StatusTypeDef | HAL_TIM_Encoder_DeInit (TIM_HandleTypeDef *htim) |
DeInitializes the TIM Encoder interface. | |
void | HAL_TIM_Encoder_MspInit (TIM_HandleTypeDef *htim) |
Initializes the TIM Encoder Interface MSP. | |
void | HAL_TIM_Encoder_MspDeInit (TIM_HandleTypeDef *htim) |
DeInitializes TIM Encoder Interface MSP. | |
HAL_StatusTypeDef | HAL_TIM_Encoder_Start (TIM_HandleTypeDef *htim, uint32_t Channel) |
Starts the TIM Encoder Interface. | |
HAL_StatusTypeDef | HAL_TIM_Encoder_Stop (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Encoder Interface. | |
HAL_StatusTypeDef | HAL_TIM_Encoder_Start_IT (TIM_HandleTypeDef *htim, uint32_t Channel) |
Starts the TIM Encoder Interface in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_Encoder_Stop_IT (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Encoder Interface in interrupt mode. | |
HAL_StatusTypeDef | HAL_TIM_Encoder_Start_DMA (TIM_HandleTypeDef *htim, uint32_t Channel, uint32_t *pData1, uint32_t *pData2, uint16_t Length) |
Starts the TIM Encoder Interface in DMA mode. | |
HAL_StatusTypeDef | HAL_TIM_Encoder_Stop_DMA (TIM_HandleTypeDef *htim, uint32_t Channel) |
Stops the TIM Encoder Interface in DMA mode. | |
void | HAL_TIM_IRQHandler (TIM_HandleTypeDef *htim) |
This function handles TIM interrupts requests. | |
HAL_StatusTypeDef | HAL_TIM_OC_ConfigChannel (TIM_HandleTypeDef *htim, const 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, const TIM_IC_InitTypeDef *sConfig, uint32_t Channel) |
Initializes the TIM Input Capture Channels according to the specified parameters in the TIM_IC_InitTypeDef. | |
HAL_StatusTypeDef | HAL_TIM_PWM_ConfigChannel (TIM_HandleTypeDef *htim, const 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, const 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_MultiWriteStart (TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, const uint32_t *BurstBuffer, uint32_t BurstLength, uint32_t DataLength) |
Configure the DMA Burst to transfer multiple 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_MultiReadStart (TIM_HandleTypeDef *htim, uint32_t BurstBaseAddress, uint32_t BurstRequestSrc, uint32_t *BurstBuffer, uint32_t BurstLength, uint32_t DataLength) |
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. | |
HAL_StatusTypeDef | HAL_TIM_ConfigOCrefClear (TIM_HandleTypeDef *htim, const TIM_ClearInputConfigTypeDef *sClearInputConfig, uint32_t Channel) |
Configures the OCRef clear feature. | |
HAL_StatusTypeDef | HAL_TIM_ConfigClockSource (TIM_HandleTypeDef *htim, const 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_SlaveConfigSynchro (TIM_HandleTypeDef *htim, const TIM_SlaveConfigTypeDef *sSlaveConfig) |
Configures the TIM in Slave mode. | |
HAL_StatusTypeDef | HAL_TIM_SlaveConfigSynchro_IT (TIM_HandleTypeDef *htim, const TIM_SlaveConfigTypeDef *sSlaveConfig) |
Configures the TIM in Slave mode in interrupt mode. | |
uint32_t | HAL_TIM_ReadCapturedValue (const TIM_HandleTypeDef *htim, uint32_t Channel) |
Read the captured value from Capture Compare unit. | |
void | HAL_TIM_PeriodElapsedCallback (TIM_HandleTypeDef *htim) |
Period elapsed callback in non-blocking mode. | |
void | HAL_TIM_PeriodElapsedHalfCpltCallback (TIM_HandleTypeDef *htim) |
Period elapsed half complete callback in non-blocking mode. | |
void | HAL_TIM_OC_DelayElapsedCallback (TIM_HandleTypeDef *htim) |
Output Compare callback in non-blocking mode. | |
void | HAL_TIM_IC_CaptureCallback (TIM_HandleTypeDef *htim) |
Input Capture callback in non-blocking mode. | |
void | HAL_TIM_IC_CaptureHalfCpltCallback (TIM_HandleTypeDef *htim) |
Input Capture half complete callback in non-blocking mode. | |
void | HAL_TIM_PWM_PulseFinishedCallback (TIM_HandleTypeDef *htim) |
PWM Pulse finished callback in non-blocking mode. | |
void | HAL_TIM_PWM_PulseFinishedHalfCpltCallback (TIM_HandleTypeDef *htim) |
PWM Pulse finished half complete callback in non-blocking mode. | |
void | HAL_TIM_TriggerCallback (TIM_HandleTypeDef *htim) |
Hall Trigger detection callback in non-blocking mode. | |
void | HAL_TIM_TriggerHalfCpltCallback (TIM_HandleTypeDef *htim) |
Hall Trigger detection half complete callback in non-blocking mode. | |
void | HAL_TIM_ErrorCallback (TIM_HandleTypeDef *htim) |
Timer error callback in non-blocking mode. | |
HAL_TIM_StateTypeDef | HAL_TIM_Base_GetState (const TIM_HandleTypeDef *htim) |
Return the TIM Base handle state. | |
HAL_TIM_StateTypeDef | HAL_TIM_OC_GetState (const TIM_HandleTypeDef *htim) |
Return the TIM OC handle state. | |
HAL_TIM_StateTypeDef | HAL_TIM_PWM_GetState (const TIM_HandleTypeDef *htim) |
Return the TIM PWM handle state. | |
HAL_TIM_StateTypeDef | HAL_TIM_IC_GetState (const TIM_HandleTypeDef *htim) |
Return the TIM Input Capture handle state. | |
HAL_TIM_StateTypeDef | HAL_TIM_OnePulse_GetState (const TIM_HandleTypeDef *htim) |
Return the TIM One Pulse Mode handle state. | |
HAL_TIM_StateTypeDef | HAL_TIM_Encoder_GetState (const TIM_HandleTypeDef *htim) |
Return the TIM Encoder Mode handle state. | |
HAL_TIM_ActiveChannel | HAL_TIM_GetActiveChannel (const TIM_HandleTypeDef *htim) |
Return the TIM Encoder Mode handle state. | |
HAL_TIM_ChannelStateTypeDef | HAL_TIM_GetChannelState (const TIM_HandleTypeDef *htim, uint32_t Channel) |
Return actual state of the TIM channel. | |
HAL_TIM_DMABurstStateTypeDef | HAL_TIM_DMABurstState (const TIM_HandleTypeDef *htim) |
Return actual state of a DMA burst operation. | |
void | TIM_DMAError (DMA_HandleTypeDef *hdma) |
TIM DMA error callback. | |
void | TIM_DMADelayPulseHalfCplt (DMA_HandleTypeDef *hdma) |
TIM DMA Delay Pulse half complete callback. | |
void | TIM_DMACaptureCplt (DMA_HandleTypeDef *hdma) |
TIM DMA Capture complete callback. | |
void | TIM_DMACaptureHalfCplt (DMA_HandleTypeDef *hdma) |
TIM DMA Capture half complete callback. | |
void | TIM_Base_SetConfig (TIM_TypeDef *TIMx, const TIM_Base_InitTypeDef *Structure) |
Time Base configuration. | |
void | TIM_OC2_SetConfig (TIM_TypeDef *TIMx, const TIM_OC_InitTypeDef *OC_Config) |
Timer Output Compare 2 configuration. | |
void | TIM_TI1_SetConfig (TIM_TypeDef *TIMx, uint32_t TIM_ICPolarity, uint32_t TIM_ICSelection, uint32_t TIM_ICFilter) |
Configure the TI1 as Input. | |
void | TIM_ETR_SetConfig (TIM_TypeDef *TIMx, uint32_t TIM_ExtTRGPrescaler, uint32_t TIM_ExtTRGPolarity, uint32_t ExtTRGFilter) |
Configures the TIMx External Trigger (ETR). | |
void | TIM_CCxChannelCmd (TIM_TypeDef *TIMx, uint32_t Channel, uint32_t ChannelState) |
Enables or disables the TIM Capture Compare Channel x. | |
TIM HAL module driver. This file provides firmware functions to manage the following functionalities of the Timer (TIM) peripheral:
Copyright (c) 2016 STMicroelectronics. All rights reserved.
This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.
============================================================================== ##### TIMER Generic features ##### ============================================================================== [..] The Timer features include: (#) 16-bit up, down, up/down auto-reload counter. (#) 16-bit programmable prescaler allowing dividing (also on the fly) the counter clock frequency either by any factor between 1 and 65536. (#) Up to 4 independent channels for: (++) Input Capture (++) Output Compare (++) PWM generation (Edge and Center-aligned Mode) (++) One-pulse mode output (#) Synchronization circuit to control the timer with external signals and to interconnect several timers together. (#) Supports incremental encoder for positioning purposes ##### How to use this driver ##### ============================================================================== [..] (#) Initialize the TIM low level resources by implementing the following functions depending on the selected feature: (++) Time Base : HAL_TIM_Base_MspInit() (++) Input Capture : HAL_TIM_IC_MspInit() (++) Output Compare : HAL_TIM_OC_MspInit() (++) PWM generation : HAL_TIM_PWM_MspInit() (++) One-pulse mode output : HAL_TIM_OnePulse_MspInit() (++) Encoder mode output : HAL_TIM_Encoder_MspInit() (#) Initialize the TIM low level resources : (##) Enable the TIM interface clock using __HAL_RCC_TIMx_CLK_ENABLE(); (##) TIM pins configuration (+++) Enable the clock for the TIM GPIOs using the following function: __HAL_RCC_GPIOx_CLK_ENABLE(); (+++) Configure these TIM pins in Alternate function mode using HAL_GPIO_Init(); (#) The external Clock can be configured, if needed (the default clock is the internal clock from the APBx), using the following function: HAL_TIM_ConfigClockSource, the clock configuration should be done before any start function. (#) Configure the TIM in the desired functioning mode using one of the Initialization function of this driver: (++) HAL_TIM_Base_Init: to use the Timer to generate a simple time base (++) HAL_TIM_OC_Init and HAL_TIM_OC_ConfigChannel: to use the Timer to generate an Output Compare signal. (++) HAL_TIM_PWM_Init and HAL_TIM_PWM_ConfigChannel: to use the Timer to generate a PWM signal. (++) HAL_TIM_IC_Init and HAL_TIM_IC_ConfigChannel: to use the Timer to measure an external signal. (++) HAL_TIM_OnePulse_Init and HAL_TIM_OnePulse_ConfigChannel: to use the Timer in One Pulse Mode. (++) HAL_TIM_Encoder_Init: to use the Timer Encoder Interface. (#) Activate the TIM peripheral using one of the start functions depending from the feature used: (++) Time Base : HAL_TIM_Base_Start(), HAL_TIM_Base_Start_DMA(), HAL_TIM_Base_Start_IT() (++) Input Capture : HAL_TIM_IC_Start(), HAL_TIM_IC_Start_DMA(), HAL_TIM_IC_Start_IT() (++) Output Compare : HAL_TIM_OC_Start(), HAL_TIM_OC_Start_DMA(), HAL_TIM_OC_Start_IT() (++) PWM generation : HAL_TIM_PWM_Start(), HAL_TIM_PWM_Start_DMA(), HAL_TIM_PWM_Start_IT() (++) One-pulse mode output : HAL_TIM_OnePulse_Start(), HAL_TIM_OnePulse_Start_IT() (++) Encoder mode output : HAL_TIM_Encoder_Start(), HAL_TIM_Encoder_Start_DMA(), HAL_TIM_Encoder_Start_IT(). (#) The DMA Burst is managed with the two following functions: HAL_TIM_DMABurst_WriteStart() HAL_TIM_DMABurst_ReadStart() *** Callback registration *** ============================================= [..] The compilation define USE_HAL_TIM_REGISTER_CALLBACKS when set to 1 allows the user to configure dynamically the driver callbacks. [..] Use Function HAL_TIM_RegisterCallback() to register a callback. HAL_TIM_RegisterCallback() takes as parameters the HAL peripheral handle, the Callback ID and a pointer to the user callback function. [..] Use function HAL_TIM_UnRegisterCallback() to reset a callback to the default weak function. HAL_TIM_UnRegisterCallback takes as parameters the HAL peripheral handle, and the Callback ID. [..] These functions allow to register/unregister following callbacks: (+) Base_MspInitCallback : TIM Base Msp Init Callback. (+) Base_MspDeInitCallback : TIM Base Msp DeInit Callback. (+) IC_MspInitCallback : TIM IC Msp Init Callback. (+) IC_MspDeInitCallback : TIM IC Msp DeInit Callback. (+) OC_MspInitCallback : TIM OC Msp Init Callback. (+) OC_MspDeInitCallback : TIM OC Msp DeInit Callback. (+) PWM_MspInitCallback : TIM PWM Msp Init Callback. (+) PWM_MspDeInitCallback : TIM PWM Msp DeInit Callback. (+) OnePulse_MspInitCallback : TIM One Pulse Msp Init Callback. (+) OnePulse_MspDeInitCallback : TIM One Pulse Msp DeInit Callback. (+) Encoder_MspInitCallback : TIM Encoder Msp Init Callback. (+) Encoder_MspDeInitCallback : TIM Encoder Msp DeInit Callback. (+) HallSensor_MspInitCallback : TIM Hall Sensor Msp Init Callback. (+) HallSensor_MspDeInitCallback : TIM Hall Sensor Msp DeInit Callback. (+) PeriodElapsedCallback : TIM Period Elapsed Callback. (+) PeriodElapsedHalfCpltCallback : TIM Period Elapsed half complete Callback. (+) TriggerCallback : TIM Trigger Callback. (+) TriggerHalfCpltCallback : TIM Trigger half complete Callback. (+) IC_CaptureCallback : TIM Input Capture Callback. (+) IC_CaptureHalfCpltCallback : TIM Input Capture half complete Callback. (+) OC_DelayElapsedCallback : TIM Output Compare Delay Elapsed Callback. (+) PWM_PulseFinishedCallback : TIM PWM Pulse Finished Callback. (+) PWM_PulseFinishedHalfCpltCallback : TIM PWM Pulse Finished half complete Callback. (+) ErrorCallback : TIM Error Callback. (+) CommutationCallback : TIM Commutation Callback. (+) CommutationHalfCpltCallback : TIM Commutation half complete Callback. (+) BreakCallback : TIM Break Callback. [..] By default, after the Init and when the state is HAL_TIM_STATE_RESET all interrupt callbacks are set to the corresponding weak functions: examples HAL_TIM_TriggerCallback(), HAL_TIM_ErrorCallback(). [..] Exception done for MspInit and MspDeInit functions that are reset to the legacy weak functionalities in the Init / DeInit only when these callbacks are null (not registered beforehand). If not, MspInit or MspDeInit are not null, the Init / DeInit keep and use the user MspInit / MspDeInit callbacks(registered beforehand) [..] Callbacks can be registered / unregistered in HAL_TIM_STATE_READY state only. Exception done MspInit / MspDeInit that can be registered / unregistered in HAL_TIM_STATE_READY or HAL_TIM_STATE_RESET state, thus registered(user) MspInit / DeInit callbacks can be used during the Init / DeInit. In that case first register the MspInit/MspDeInit user callbacks using HAL_TIM_RegisterCallback() before calling DeInit or Init function. [..] When The compilation define USE_HAL_TIM_REGISTER_CALLBACKS is set to 0 or not defined, the callback registration feature is not available and all callbacks are set to the corresponding weak functions.
Definition in file stm32f4xx_hal_tim.c.