Eric Lewiston / STM32L4xx_HAL_Driver

Hal Drivers for L4

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

HAL Control functions
Functions

HAL Control functions
[HAL Exported Functions]

HAL Control functions. More...

Functions

__weak void HAL_IncTick (void)
 This function is called to increment a global variable "uwTick" used as application time base.
__weak uint32_t HAL_GetTick (void)
 Provide a tick value in millisecond.
__weak void HAL_Delay (uint32_t Delay)
 Provide accurate delay (in milliseconds) based on variable incremented.
__weak void HAL_SuspendTick (void)
 Suspend Tick increment.
__weak void HAL_ResumeTick (void)
 Resume Tick increment.
uint32_t HAL_GetHalVersion (void)
 Return the HAL revision.
uint32_t HAL_GetREVID (void)
 Return the device revision identifier.
uint32_t HAL_GetDEVID (void)
 Return the device identifier.

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

__weak void HAL_Delay ( uint32_t  Delay )

Provide accurate 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 328 of file stm32l4xx_hal.c.

uint32_t HAL_GetDEVID ( void   )

Return the device identifier.

Return values:
Deviceidentifier

Definition at line 391 of file stm32l4xx_hal.c.

uint32_t HAL_GetHalVersion ( void   )

Return the HAL revision.

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

Definition at line 373 of file stm32l4xx_hal.c.

uint32_t HAL_GetREVID ( void   )

Return the device revision identifier.

Return values:
Devicerevision identifier

Definition at line 382 of file stm32l4xx_hal.c.

__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:
tickvalue

Definition at line 313 of file stm32l4xx_hal.c.

__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 302 of file stm32l4xx_hal.c.

__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 363 of file stm32l4xx_hal.c.

__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 347 of file stm32l4xx_hal.c.

Generated on Tue Jul 12 2022 11:35:29 by  doxygen 1.7.2