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.
Time Input Capture functions
[TIM Exported Functions]
Time Input Capture functions. More...
Functions | |
| 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 create the associated handle. | |
| HAL_StatusTypeDef | HAL_TIM_IC_DeInit (TIM_HandleTypeDef *htim) |
| DeInitializes the TIM peripheral. | |
| __weak void | HAL_TIM_IC_MspInit (TIM_HandleTypeDef *htim) |
| Initializes the TIM Input Capture MSP. | |
| __weak 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. | |
Detailed Description
Time Input Capture functions.
==============================================================================
##### Time Input Capture functions #####
==============================================================================
[..]
This section provides functions allowing to:
(+) Initialize and configure the TIM Input Capture.
(+) De-initialize the TIM Input Capture.
(+) Start the Time Input Capture.
(+) Stop the Time Input Capture.
(+) Start the Time Input Capture and enable interrupt.
(+) Stop the Time Input Capture and disable interrupt.
(+) Start the Time Input Capture and enable DMA transfer.
(+) Stop the Time Input Capture and disable DMA transfer.
Function Documentation
| HAL_StatusTypeDef HAL_TIM_IC_DeInit | ( | TIM_HandleTypeDef * | htim ) |
DeInitializes the TIM peripheral.
- Parameters:
-
htim : TIM Input Capture handle
- Return values:
-
HAL status
Definition at line 1531 of file stm32f1xx_hal_tim.c.
| 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 create the associated handle.
- Parameters:
-
htim : TIM Input Capture handle
- Return values:
-
HAL status
Definition at line 1492 of file stm32f1xx_hal_tim.c.
| __weak void HAL_TIM_IC_MspDeInit | ( | TIM_HandleTypeDef * | htim ) |
DeInitializes TIM Input Capture MSP.
- Parameters:
-
htim : TIM handle
- Return values:
-
None
Definition at line 1572 of file stm32f1xx_hal_tim.c.
| __weak void HAL_TIM_IC_MspInit | ( | TIM_HandleTypeDef * | htim ) |
Initializes the TIM Input Capture MSP.
- Parameters:
-
htim : TIM handle
- Return values:
-
None
Definition at line 1558 of file stm32f1xx_hal_tim.c.
| HAL_StatusTypeDef HAL_TIM_IC_Start | ( | TIM_HandleTypeDef * | htim, |
| uint32_t | Channel | ||
| ) |
Starts the TIM Input Capture measurement.
- Parameters:
-
htim : TIM Input Capture 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:
-
HAL status
Definition at line 1592 of file stm32f1xx_hal_tim.c.
| 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.
- Parameters:
-
htim : TIM Input Capture 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
pData : The destination Buffer address. Length : The length of data to be transferred from TIM peripheral to memory.
- Return values:
-
HAL status
Definition at line 1765 of file stm32f1xx_hal_tim.c.
| HAL_StatusTypeDef HAL_TIM_IC_Start_IT | ( | TIM_HandleTypeDef * | htim, |
| uint32_t | Channel | ||
| ) |
Starts the TIM Input Capture measurement in interrupt mode.
- Parameters:
-
htim : TIM Input Capture 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:
-
HAL status
Definition at line 1644 of file stm32f1xx_hal_tim.c.
| HAL_StatusTypeDef HAL_TIM_IC_Stop | ( | TIM_HandleTypeDef * | htim, |
| uint32_t | Channel | ||
| ) |
Stops the TIM Input Capture measurement.
- Parameters:
-
htim : TIM handle Channel : TIM Channels to be disabled 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:
-
HAL status
Definition at line 1618 of file stm32f1xx_hal_tim.c.
| HAL_StatusTypeDef HAL_TIM_IC_Stop_DMA | ( | TIM_HandleTypeDef * | htim, |
| uint32_t | Channel | ||
| ) |
Stops the TIM Input Capture measurement in DMA mode.
- Parameters:
-
htim : TIM Input Capture handle Channel : TIM Channels to be disabled 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:
-
HAL status
Definition at line 1878 of file stm32f1xx_hal_tim.c.
| HAL_StatusTypeDef HAL_TIM_IC_Stop_IT | ( | TIM_HandleTypeDef * | htim, |
| uint32_t | Channel | ||
| ) |
Stops the TIM Input Capture measurement in interrupt mode.
- Parameters:
-
htim : TIM handle Channel : TIM Channels to be disabled 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:
-
HAL status
Definition at line 1703 of file stm32f1xx_hal_tim.c.
Generated on Tue Jul 12 2022 15:37:32 by
1.7.2