HAL Control functions

HAL Control functions. More...

Functions
void	HAL_IncTick (void)
	This function is called to increment a global variable "uwTick" used as application time base. More...
void	HAL_Delay (uint32_t Delay)
	This function provides minimum delay (in milliseconds) based on variable incremented. More...
uint32_t	HAL_GetTick (void)
	Provide a tick value in millisecond. More...
uint32_t	HAL_GetTickPrio (void)
	This function returns a tick priority. More...
HAL_StatusTypeDef	HAL_SetTickFreq (uint32_t Freq)
	Set new tick Freq. More...
uint32_t	HAL_GetTickFreq (void)
	Return tick frequency. More...
void	HAL_SuspendTick (void)
	Suspend Tick increment. More...
void	HAL_ResumeTick (void)
	Resume Tick increment. More...
uint32_t	HAL_GetHalVersion (void)
	Return the HAL revision. More...
uint32_t	HAL_GetREVID (void)
	Return the device revision identifier. More...
uint32_t	HAL_GetDEVID (void)
	Return the device identifier. More...
uint32_t	HAL_GetUIDw0 (void)
	Return the first word of the unique device identifier (UID based on 96 bits) More...
uint32_t	HAL_GetUIDw1 (void)
	Return the second word of the unique device identifier (UID based on 96 bits) More...
uint32_t	HAL_GetUIDw2 (void)
	Return the third word of the unique device identifier (UID based on 96 bits) More...

Detailed Description

HAL Control functions.

 ===============================================================================
                      ##### HAL Control functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
      (+) Provide a tick value in millisecond
      (+) Provide a blocking delay in millisecond
      (+) Suspend the time base source interrupt
      (+) Resume the time base source interrupt
      (+) Get the HAL API driver version
      (+) Get the device identifier
      (+) Get the device revision identifier

Function Documentation

HAL_Delay()

__weak void HAL_Delay

(

uint32_t

Delay

)

This function provides minimum delay (in milliseconds) based on variable incremented.

Note

In the default implementation , SysTick timer is the source of time base. It is used to generate interrupts at regular time intervals where uwTick is incremented.

This function is declared as __weak to be overwritten in case of other implementations in user file.

Parameters

Delay

specifies the delay time length, in milliseconds.

Return values

None

Definition at line 394 of file stm32l4xx_hal.c.

{
  uint32_t tickstart = HAL_GetTick();
  uint32_t wait = Delay;

  /* Add a period to guaranty minimum wait */
  if (wait < HAL_MAX_DELAY)
  {
    wait += (uint32_t)(uwTickFreq);
  }

  while((HAL_GetTick() - tickstart) < wait)
  {
  }
}

HAL_GetDEVID()

uint32_t HAL_GetDEVID

(

void

)

Return the device identifier.

Return values

Device

identifier

Definition at line 464 of file stm32l4xx_hal.c.

{
  return(DBGMCU->IDCODE & DBGMCU_IDCODE_DEV_ID);
}

HAL_GetHalVersion()

uint32_t HAL_GetHalVersion

(

void

)

Return the HAL revision.

Return values

version

: 0xXYZR (8bits for each decimal, R for RC)

Definition at line 446 of file stm32l4xx_hal.c.

{
  return STM32L4XX_HAL_VERSION;
}

HAL_GetREVID()

uint32_t HAL_GetREVID

(

void

)

Return the device revision identifier.

Return values

Device

revision identifier

Definition at line 455 of file stm32l4xx_hal.c.

{
  return((DBGMCU->IDCODE & DBGMCU_IDCODE_REV_ID) >> 16);
}

HAL_GetTick()

__weak uint32_t HAL_GetTick

(

void

)

Provide a tick value in millisecond.

Note

This function is declared as __weak to be overwritten in case of other implementations in user file.

Return values

tick

value

Definition at line 337 of file stm32l4xx_hal.c.

{
  return uwTick;
}

HAL_GetTickFreq()

uint32_t HAL_GetTickFreq

(

void

)

Return tick frequency.

Return values

tick	period in Hz

Definition at line 378 of file stm32l4xx_hal.c.

{
  return uwTickFreq;
}

HAL_GetTickPrio()

uint32_t HAL_GetTickPrio

(

void

)

This function returns a tick priority.

Return values

tick

priority

Definition at line 346 of file stm32l4xx_hal.c.

{
  return uwTickPrio;
}

HAL_GetUIDw0()

uint32_t HAL_GetUIDw0

(

void

)

Return the first word of the unique device identifier (UID based on 96 bits)

Return values

Device

identifier

Definition at line 473 of file stm32l4xx_hal.c.

{
  return(READ_REG(*((uint32_t *)UID_BASE)));
}

HAL_GetUIDw1()

uint32_t HAL_GetUIDw1

(

void

)

Return the second word of the unique device identifier (UID based on 96 bits)

Return values

Device

identifier

Definition at line 482 of file stm32l4xx_hal.c.

{
  return(READ_REG(*((uint32_t *)(UID_BASE + 4U))));
}

HAL_GetUIDw2()

uint32_t HAL_GetUIDw2

(

void

)

Return the third word of the unique device identifier (UID based on 96 bits)

Return values

Device

identifier

Definition at line 491 of file stm32l4xx_hal.c.

{
  return(READ_REG(*((uint32_t *)(UID_BASE + 8U))));
}

HAL_IncTick()

__weak void HAL_IncTick

(

void

)

This function is called to increment a global variable "uwTick" used as application time base.

Note

In the default implementation, this variable is incremented each 1ms in SysTick ISR.

This function is declared as __weak to be overwritten in case of other implementations in user file.

Return values

None

Definition at line 326 of file stm32l4xx_hal.c.

{
  uwTick += uwTickFreq;
}

HAL_ResumeTick()

__weak void HAL_ResumeTick

(

void

)

Resume Tick increment.

Note

In the default implementation , SysTick timer is the source of time base. It is used to generate interrupts at regular time intervals. Once HAL_ResumeTick() is called, the SysTick interrupt will be enabled and so Tick increment is resumed.

This function is declared as __weak to be overwritten in case of other implementations in user file.

Return values

None

Definition at line 436 of file stm32l4xx_hal.c.

{
  /* Enable SysTick Interrupt */
  SysTick->CTRL  |= SysTick_CTRL_TICKINT_Msk;
}

HAL_SetTickFreq()

HAL_StatusTypeDef HAL_SetTickFreq

(

uint32_t

Freq

)

Set new tick Freq.

Parameters

Freq	tick frequency

Return values

HAL

status

Definition at line 356 of file stm32l4xx_hal.c.

{
  HAL_StatusTypeDef status  = HAL_OK;
  assert_param(IS_TICKFREQ(Freq));

  if (uwTickFreq != Freq)
  {
    /* Apply the new tick Freq  */
    status = HAL_InitTick(uwTickPrio);
    if (status == HAL_OK)
    {
      uwTickFreq = Freq;
    }
  }

  return status;
}

HAL_SuspendTick()

__weak void HAL_SuspendTick

(

void

)

Suspend Tick increment.

Note

In the default implementation , SysTick timer is the source of time base. It is used to generate interrupts at regular time intervals. Once HAL_SuspendTick() is called, the SysTick interrupt will be disabled and so Tick increment is suspended.

This function is declared as __weak to be overwritten in case of other implementations in user file.

Return values

None

Definition at line 420 of file stm32l4xx_hal.c.

{
  /* Disable SysTick Interrupt */
  SysTick->CTRL &= ~SysTick_CTRL_TICKINT_Msk;
}