Senior Design: Sound Monitor / STM32L4xx_HAL_Driver

L4 HAL Drivers

Embed: (wiki syntax)

« Back to documentation index

Extended Timer Hall Sensor functions
Functions

Extended Timer Hall Sensor functions
[TIM Extended Exported Functions]

Timer Hall Sensor functions. More...

Functions

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Init (TIM_HandleTypeDef *htim, TIM_HallSensor_InitTypeDef *sConfig)
 Initializes the TIM Hall Sensor Interface and initialize the associated handle.
HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit (TIM_HandleTypeDef *htim)
 DeInitialize the TIM Hall Sensor interface.
__weak void HAL_TIMEx_HallSensor_MspInit (TIM_HandleTypeDef *htim)
 Initializes the TIM Hall Sensor MSP.
__weak void HAL_TIMEx_HallSensor_MspDeInit (TIM_HandleTypeDef *htim)
 DeInitialize TIM Hall Sensor MSP.
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start (TIM_HandleTypeDef *htim)
 Starts the TIM Hall Sensor Interface.
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop (TIM_HandleTypeDef *htim)
 Stops the TIM Hall sensor Interface.
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT (TIM_HandleTypeDef *htim)
 Starts the TIM Hall Sensor Interface in interrupt mode.
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT (TIM_HandleTypeDef *htim)
 Stops the TIM Hall Sensor Interface in interrupt mode.
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_DMA (TIM_HandleTypeDef *htim, uint32_t *pData, uint16_t Length)
 Starts the TIM Hall Sensor Interface in DMA mode.
HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA (TIM_HandleTypeDef *htim)
 Stops the TIM Hall Sensor Interface in DMA mode.

Detailed Description

Timer Hall Sensor functions. 

  ==============================================================================
                      ##### Timer Hall Sensor functions #####
  ==============================================================================
  [..]
    This section provides functions allowing to:
    (+) Initialize and configure TIM HAL Sensor.
    (+) De-initialize TIM HAL Sensor.
    (+) Start the Hall Sensor Interface.
    (+) Stop the Hall Sensor Interface.
    (+) Start the Hall Sensor Interface and enable interrupts.
    (+) Stop the Hall Sensor Interface and disable interrupts.
    (+) Start the Hall Sensor Interface and enable DMA transfers.
    (+) Stop the Hall Sensor Interface and disable DMA transfers.

Function Documentation

HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit ( TIM_HandleTypeDef *  htim )

DeInitialize the TIM Hall Sensor interface.

Parameters:
htim,:TIM Hall Sensor handle
Return values:
HALstatus

Definition at line 347 of file stm32l4xx_hal_tim_ex.c.

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Init ( TIM_HandleTypeDef *  htim,
TIM_HallSensor_InitTypeDef *  sConfig 
)

Initializes the TIM Hall Sensor Interface and initialize the associated handle.

Parameters:
htim,:TIM Encoder Interface handle
sConfig,:TIM Hall Sensor configuration structure
Return values:
HALstatus

Definition at line 269 of file stm32l4xx_hal_tim_ex.c.

__weak void HAL_TIMEx_HallSensor_MspDeInit ( TIM_HandleTypeDef *  htim )

DeInitialize TIM Hall Sensor MSP.

Parameters:
htim,:TIM handle
Return values:
None

Definition at line 386 of file stm32l4xx_hal_tim_ex.c.

__weak void HAL_TIMEx_HallSensor_MspInit ( TIM_HandleTypeDef *  htim )

Initializes the TIM Hall Sensor MSP.

Parameters:
htim,:TIM handle
Return values:
None

Definition at line 374 of file stm32l4xx_hal_tim_ex.c.

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start ( TIM_HandleTypeDef *  htim )

Starts the TIM Hall Sensor Interface.

Parameters:
htim: TIM Hall Sensor handle
Return values:
HALstatus

Definition at line 398 of file stm32l4xx_hal_tim_ex.c.

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_DMA ( TIM_HandleTypeDef *  htim,
uint32_t *  pData,
uint16_t  Length 
)

Starts the TIM Hall Sensor Interface in DMA mode.

Parameters:
htim: TIM Hall Sensor handle
pData,:The destination Buffer address.
Length,:The length of data to be transferred from TIM peripheral to memory.
Return values:
HALstatus

Definition at line 490 of file stm32l4xx_hal_tim_ex.c.

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT ( TIM_HandleTypeDef *  htim )

Starts the TIM Hall Sensor Interface in interrupt mode.

Parameters:
htim: TIM Hall Sensor handle
Return values:
HALstatus

Definition at line 440 of file stm32l4xx_hal_tim_ex.c.

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop ( TIM_HandleTypeDef *  htim )

Stops the TIM Hall sensor Interface.

Parameters:
htim: TIM Hall Sensor handle
Return values:
HALstatus

Definition at line 419 of file stm32l4xx_hal_tim_ex.c.

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA ( TIM_HandleTypeDef *  htim )

Stops the TIM Hall Sensor Interface in DMA mode.

Parameters:
htim: TIM handle
Return values:
HALstatus

Definition at line 537 of file stm32l4xx_hal_tim_ex.c.

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT ( TIM_HandleTypeDef *  htim )

Stops the TIM Hall Sensor Interface in interrupt mode.

Parameters:
htim: TIM handle
Return values:
HALstatus

Definition at line 464 of file stm32l4xx_hal_tim_ex.c.

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