Extended Timer Hall Sensor 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. More...
HAL_StatusTypeDef	HAL_TIMEx_HallSensor_DeInit (TIM_HandleTypeDef *htim)
	DeInitializes the TIM Hall Sensor interface. More...
void	HAL_TIMEx_HallSensor_MspInit (TIM_HandleTypeDef *htim)
	Initializes the TIM Hall Sensor MSP. More...
void	HAL_TIMEx_HallSensor_MspDeInit (TIM_HandleTypeDef *htim)
	DeInitializes TIM Hall Sensor MSP. More...
HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Start (TIM_HandleTypeDef *htim)
	Starts the TIM Hall Sensor Interface. More...
HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Stop (TIM_HandleTypeDef *htim)
	Stops the TIM Hall sensor Interface. More...
HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Start_IT (TIM_HandleTypeDef *htim)
	Starts the TIM Hall Sensor Interface in interrupt mode. More...
HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Stop_IT (TIM_HandleTypeDef *htim)
	Stops the TIM Hall Sensor Interface in interrupt mode. More...
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. More...
HAL_StatusTypeDef	HAL_TIMEx_HallSensor_Stop_DMA (TIM_HandleTypeDef *htim)
	Stops the TIM Hall Sensor Interface in DMA mode. More...

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_TIMEx_HallSensor_DeInit()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit

(

TIM_HandleTypeDef *

htim

)

DeInitializes the TIM Hall Sensor interface.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL

status

Definition at line 224 of file stm32l4xx_hal_tim_ex.c.

{
  /* Check the parameters */
  assert_param(IS_TIM_INSTANCE(htim->Instance));

  htim->State = HAL_TIM_STATE_BUSY;

  /* Disable the TIM Peripheral Clock */
  __HAL_TIM_DISABLE(htim);

#if (USE_HAL_TIM_REGISTER_CALLBACKS == 1)
  if (htim->HallSensor_MspDeInitCallback == NULL)
  {
    htim->HallSensor_MspDeInitCallback = HAL_TIMEx_HallSensor_MspDeInit;
  }
  /* DeInit the low level hardware */
  htim->HallSensor_MspDeInitCallback(htim);
#else
  /* DeInit the low level hardware: GPIO, CLOCK, NVIC */
  HAL_TIMEx_HallSensor_MspDeInit(htim);
#endif /* USE_HAL_TIM_REGISTER_CALLBACKS */

  /* Change TIM state */
  htim->State = HAL_TIM_STATE_RESET;

  /* Release Lock */
  __HAL_UNLOCK(htim);

  return HAL_OK;
}

HAL_TIMEx_HallSensor_Init()

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 Hall Sensor Interface handle
sConfig	TIM Hall Sensor configuration structure

Return values

HAL

status

Definition at line 132 of file stm32l4xx_hal_tim_ex.c.

{
  TIM_OC_InitTypeDef OC_Config;

  /* Check the TIM handle allocation */
  if (htim == NULL)
  {
    return HAL_ERROR;
  }

  /* Check the parameters */
  assert_param(IS_TIM_HALL_SENSOR_INTERFACE_INSTANCE(htim->Instance));
  assert_param(IS_TIM_COUNTER_MODE(htim->Init.CounterMode));
  assert_param(IS_TIM_CLOCKDIVISION_DIV(htim->Init.ClockDivision));
  assert_param(IS_TIM_AUTORELOAD_PRELOAD(htim->Init.AutoReloadPreload));
  assert_param(IS_TIM_IC_POLARITY(sConfig->IC1Polarity));
  assert_param(IS_TIM_IC_PRESCALER(sConfig->IC1Prescaler));
  assert_param(IS_TIM_IC_FILTER(sConfig->IC1Filter));

  if (htim->State == HAL_TIM_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    htim->Lock = HAL_UNLOCKED;

#if (USE_HAL_TIM_REGISTER_CALLBACKS == 1)
    /* Reset interrupt callbacks to legacy week callbacks */
    TIM_ResetCallback(htim);

    if (htim->HallSensor_MspInitCallback == NULL)
    {
      htim->HallSensor_MspInitCallback = HAL_TIMEx_HallSensor_MspInit;
    }
    /* Init the low level hardware : GPIO, CLOCK, NVIC */
    htim->HallSensor_MspInitCallback(htim);
#else
    /* Init the low level hardware : GPIO, CLOCK, NVIC and DMA */
    HAL_TIMEx_HallSensor_MspInit(htim);
#endif /* USE_HAL_TIM_REGISTER_CALLBACKS */
  }

  /* Set the TIM state */
  htim->State = HAL_TIM_STATE_BUSY;

  /* Configure the Time base in the Encoder Mode */
  TIM_Base_SetConfig(htim->Instance, &htim->Init);

  /* Configure the Channel 1 as Input Channel to interface with the three Outputs of the  Hall sensor */
  TIM_TI1_SetConfig(htim->Instance, sConfig->IC1Polarity, TIM_ICSELECTION_TRC, sConfig->IC1Filter);

  /* Reset the IC1PSC Bits */
  htim->Instance->CCMR1 &= ~TIM_CCMR1_IC1PSC;
  /* Set the IC1PSC value */
  htim->Instance->CCMR1 |= sConfig->IC1Prescaler;

  /* Enable the Hall sensor interface (XOR function of the three inputs) */
  htim->Instance->CR2 |= TIM_CR2_TI1S;

  /* Select the TIM_TS_TI1F_ED signal as Input trigger for the TIM */
  htim->Instance->SMCR &= ~TIM_SMCR_TS;
  htim->Instance->SMCR |= TIM_TS_TI1F_ED;

  /* Use the TIM_TS_TI1F_ED signal to reset the TIM counter each edge detection */
  htim->Instance->SMCR &= ~TIM_SMCR_SMS;
  htim->Instance->SMCR |= TIM_SLAVEMODE_RESET;

  /* Program channel 2 in PWM 2 mode with the desired Commutation_Delay*/
  OC_Config.OCFastMode = TIM_OCFAST_DISABLE;
  OC_Config.OCIdleState = TIM_OCIDLESTATE_RESET;
  OC_Config.OCMode = TIM_OCMODE_PWM2;
  OC_Config.OCNIdleState = TIM_OCNIDLESTATE_RESET;
  OC_Config.OCNPolarity = TIM_OCNPOLARITY_HIGH;
  OC_Config.OCPolarity = TIM_OCPOLARITY_HIGH;
  OC_Config.Pulse = sConfig->Commutation_Delay;

  TIM_OC2_SetConfig(htim->Instance, &OC_Config);

  /* Select OC2REF as trigger output on TRGO: write the MMS bits in the TIMx_CR2
    register to 101 */
  htim->Instance->CR2 &= ~TIM_CR2_MMS;
  htim->Instance->CR2 |= TIM_TRGO_OC2REF;

  /* Initialize the TIM state*/
  htim->State = HAL_TIM_STATE_READY;

  return HAL_OK;
}

HAL_TIMEx_HallSensor_MspDeInit()

__weak void HAL_TIMEx_HallSensor_MspDeInit

(

TIM_HandleTypeDef *

htim

)

DeInitializes TIM Hall Sensor MSP.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

None

Definition at line 275 of file stm32l4xx_hal_tim_ex.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(htim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_TIMEx_HallSensor_MspDeInit could be implemented in the user file
   */
}

HAL_TIMEx_HallSensor_MspInit()

__weak void HAL_TIMEx_HallSensor_MspInit

(

TIM_HandleTypeDef *

htim

)

Initializes the TIM Hall Sensor MSP.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

None

Definition at line 260 of file stm32l4xx_hal_tim_ex.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(htim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_TIMEx_HallSensor_MspInit could be implemented in the user file
   */
}

HAL_TIMEx_HallSensor_Start()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start

(

TIM_HandleTypeDef *

htim

)

Starts the TIM Hall Sensor Interface.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL

status

Definition at line 290 of file stm32l4xx_hal_tim_ex.c.

{
  uint32_t tmpsmcr;

  /* Check the parameters */
  assert_param(IS_TIM_HALL_SENSOR_INTERFACE_INSTANCE(htim->Instance));

  /* Enable the Input Capture channel 1
    (in the Hall Sensor Interface the three possible channels that can be used are TIM_CHANNEL_1, TIM_CHANNEL_2 and TIM_CHANNEL_3) */
  TIM_CCxChannelCmd(htim->Instance, TIM_CHANNEL_1, TIM_CCx_ENABLE);

  /* Enable the Peripheral, except in trigger mode where enable is automatically done with trigger */
  tmpsmcr = htim->Instance->SMCR & TIM_SMCR_SMS;
  if (!IS_TIM_SLAVEMODE_TRIGGER_ENABLED(tmpsmcr))
  {
    __HAL_TIM_ENABLE(htim);
  }

  /* Return function status */
  return HAL_OK;
}

HAL_TIMEx_HallSensor_Start_DMA()

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 Interface handle
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 394 of file stm32l4xx_hal_tim_ex.c.

{
  uint32_t tmpsmcr;

  /* Check the parameters */
  assert_param(IS_TIM_HALL_SENSOR_INTERFACE_INSTANCE(htim->Instance));

  if ((htim->State == HAL_TIM_STATE_BUSY))
  {
    return HAL_BUSY;
  }
  else if ((htim->State == HAL_TIM_STATE_READY))
  {
    if (((uint32_t)pData == 0U) && (Length > 0U))
    {
      return HAL_ERROR;
    }
    else
    {
      htim->State = HAL_TIM_STATE_BUSY;
    }
  }
  else
  {
    /* nothing to do */
  }
  /* Enable the Input Capture channel 1
    (in the Hall Sensor Interface the three possible channels that can be used are TIM_CHANNEL_1, TIM_CHANNEL_2 and TIM_CHANNEL_3) */
  TIM_CCxChannelCmd(htim->Instance, TIM_CHANNEL_1, TIM_CCx_ENABLE);

  /* Set the DMA Input Capture 1 Callbacks */
  htim->hdma[TIM_DMA_ID_CC1]->XferCpltCallback = TIM_DMACaptureCplt;
  htim->hdma[TIM_DMA_ID_CC1]->XferHalfCpltCallback = TIM_DMACaptureHalfCplt;
  /* Set the DMA error callback */
  htim->hdma[TIM_DMA_ID_CC1]->XferErrorCallback = TIM_DMAError ;

  /* Enable the DMA channel for Capture 1*/
  if (HAL_DMA_Start_IT(htim->hdma[TIM_DMA_ID_CC1], (uint32_t)&htim->Instance->CCR1, (uint32_t)pData, Length) != HAL_OK)
  {
    return HAL_ERROR;
  }
  /* Enable the capture compare 1 Interrupt */
  __HAL_TIM_ENABLE_DMA(htim, TIM_DMA_CC1);

  /* Enable the Peripheral, except in trigger mode where enable is automatically done with trigger */
  tmpsmcr = htim->Instance->SMCR & TIM_SMCR_SMS;
  if (!IS_TIM_SLAVEMODE_TRIGGER_ENABLED(tmpsmcr))
  {
    __HAL_TIM_ENABLE(htim);
  }

  /* Return function status */
  return HAL_OK;
}

HAL_TIMEx_HallSensor_Start_IT()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT

(

TIM_HandleTypeDef *

htim

)

Starts the TIM Hall Sensor Interface in interrupt mode.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL

status

Definition at line 338 of file stm32l4xx_hal_tim_ex.c.

{
  uint32_t tmpsmcr;

  /* Check the parameters */
  assert_param(IS_TIM_HALL_SENSOR_INTERFACE_INSTANCE(htim->Instance));

  /* Enable the capture compare Interrupts 1 event */
  __HAL_TIM_ENABLE_IT(htim, TIM_IT_CC1);

  /* Enable the Input Capture channel 1
    (in the Hall Sensor Interface the three possible channels that can be used are TIM_CHANNEL_1, TIM_CHANNEL_2 and TIM_CHANNEL_3) */
  TIM_CCxChannelCmd(htim->Instance, TIM_CHANNEL_1, TIM_CCx_ENABLE);

  /* Enable the Peripheral, except in trigger mode where enable is automatically done with trigger */
  tmpsmcr = htim->Instance->SMCR & TIM_SMCR_SMS;
  if (!IS_TIM_SLAVEMODE_TRIGGER_ENABLED(tmpsmcr))
  {
    __HAL_TIM_ENABLE(htim);
  }

  /* Return function status */
  return HAL_OK;
}

HAL_TIMEx_HallSensor_Stop()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop

(

TIM_HandleTypeDef *

htim

)

Stops the TIM Hall sensor Interface.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL

status

Definition at line 317 of file stm32l4xx_hal_tim_ex.c.

{
  /* Check the parameters */
  assert_param(IS_TIM_HALL_SENSOR_INTERFACE_INSTANCE(htim->Instance));

  /* Disable the Input Capture channels 1, 2 and 3
    (in the Hall Sensor Interface the three possible channels that can be used are TIM_CHANNEL_1, TIM_CHANNEL_2 and TIM_CHANNEL_3) */
  TIM_CCxChannelCmd(htim->Instance, TIM_CHANNEL_1, TIM_CCx_DISABLE);

  /* Disable the Peripheral */
  __HAL_TIM_DISABLE(htim);

  /* Return function status */
  return HAL_OK;
}

HAL_TIMEx_HallSensor_Stop_DMA()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA

(

TIM_HandleTypeDef *

htim

)

Stops the TIM Hall Sensor Interface in DMA mode.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL

status

Definition at line 454 of file stm32l4xx_hal_tim_ex.c.

{
  /* Check the parameters */
  assert_param(IS_TIM_HALL_SENSOR_INTERFACE_INSTANCE(htim->Instance));

  /* Disable the Input Capture channel 1
    (in the Hall Sensor Interface the three possible channels that can be used are TIM_CHANNEL_1, TIM_CHANNEL_2 and TIM_CHANNEL_3) */
  TIM_CCxChannelCmd(htim->Instance, TIM_CHANNEL_1, TIM_CCx_DISABLE);


  /* Disable the capture compare Interrupts 1 event */
  __HAL_TIM_DISABLE_DMA(htim, TIM_DMA_CC1);

  (void)HAL_DMA_Abort_IT(htim->hdma[TIM_DMA_ID_CC1]);
  /* Disable the Peripheral */
  __HAL_TIM_DISABLE(htim);

  /* Return function status */
  return HAL_OK;
}

HAL_TIMEx_HallSensor_Stop_IT()

HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT

(

TIM_HandleTypeDef *

htim

)

Stops the TIM Hall Sensor Interface in interrupt mode.

Parameters

htim	TIM Hall Sensor Interface handle

Return values

HAL

status

Definition at line 368 of file stm32l4xx_hal_tim_ex.c.

{
  /* Check the parameters */
  assert_param(IS_TIM_HALL_SENSOR_INTERFACE_INSTANCE(htim->Instance));

  /* Disable the Input Capture channel 1
    (in the Hall Sensor Interface the three possible channels that can be used are TIM_CHANNEL_1, TIM_CHANNEL_2 and TIM_CHANNEL_3) */
  TIM_CCxChannelCmd(htim->Instance, TIM_CHANNEL_1, TIM_CCx_DISABLE);

  /* Disable the capture compare Interrupts event */
  __HAL_TIM_DISABLE_IT(htim, TIM_IT_CC1);

  /* Disable the Peripheral */
  __HAL_TIM_DISABLE(htim);

  /* Return function status */
  return HAL_OK;
}