HAL Control functions. More...

Collaboration diagram for HAL Control functions:

Functions
void	HAL_IncTick (void)
	This function is called to increment a global variable "uwTick" used as application time base.
void	HAL_Delay (uint32_t Delay)
	This function provides minimum delay (in milliseconds) based on variable incremented.
uint32_t	HAL_GetTick (void)
	Provides a tick value in millisecond.
uint32_t	HAL_GetTickPrio (void)
	This function returns a tick priority.
HAL_StatusTypeDef	HAL_SetTickFreq (HAL_TickFreqTypeDef Freq)
	Set new tick Freq.
HAL_TickFreqTypeDef	HAL_GetTickFreq (void)
	Return tick frequency.
void	HAL_SuspendTick (void)
	Suspend Tick increment.
void	HAL_ResumeTick (void)
	Resume Tick increment.
uint32_t	HAL_GetHalVersion (void)
	Returns the HAL revision.
uint32_t	HAL_GetREVID (void)
	Returns the device revision identifier.
uint32_t	HAL_GetDEVID (void)
	Returns the device identifier.
void	HAL_DBGMCU_EnableDBGSleepMode (void)
	Enable the Debug Module during SLEEP mode.
void	HAL_DBGMCU_DisableDBGSleepMode (void)
	Disable the Debug Module during SLEEP mode.
void	HAL_DBGMCU_EnableDBGStopMode (void)
	Enable the Debug Module during STOP mode.
void	HAL_DBGMCU_DisableDBGStopMode (void)
	Disable the Debug Module during STOP mode.
void	HAL_DBGMCU_EnableDBGStandbyMode (void)
	Enable the Debug Module during STANDBY mode.
void	HAL_DBGMCU_DisableDBGStandbyMode (void)
	Disable the Debug Module during STANDBY mode.
void	HAL_EnableCompensationCell (void)
	Enables the I/O Compensation Cell.
void	HAL_DisableCompensationCell (void)
	Power-down the I/O Compensation Cell.
uint32_t	HAL_GetUIDw0 (void)
	Returns first word of the unique device identifier (UID based on 96 bits).
uint32_t	HAL_GetUIDw1 (void)
	Returns second word of the unique device identifier (UID based on 96 bits).
uint32_t	HAL_GetUIDw2 (void)
	Returns third word of the unique device identifier (UID based on 96 bits).

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
      (+) Enable/Disable Debug module during SLEEP mode
      (+) Enable/Disable Debug module during STOP mode
      (+) Enable/Disable Debug module during STANDBY mode

Function Documentation

◆ HAL_DBGMCU_DisableDBGSleepMode()

void HAL_DBGMCU_DisableDBGSleepMode ( void )

Disable the Debug Module during SLEEP mode.

Return values

None

Definition at line 478 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_DisableDBGStandbyMode()

void HAL_DBGMCU_DisableDBGStandbyMode ( void )

Disable the Debug Module during STANDBY mode.

Return values

None

Definition at line 514 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_DisableDBGStopMode()

void HAL_DBGMCU_DisableDBGStopMode ( void )

Disable the Debug Module during STOP mode.

Return values

None

Definition at line 496 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_EnableDBGSleepMode()

void HAL_DBGMCU_EnableDBGSleepMode ( void )

Enable the Debug Module during SLEEP mode.

Return values

None

Definition at line 469 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_EnableDBGStandbyMode()

void HAL_DBGMCU_EnableDBGStandbyMode ( void )

Enable the Debug Module during STANDBY mode.

Return values

None

Definition at line 505 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_EnableDBGStopMode()

void HAL_DBGMCU_EnableDBGStopMode ( void )

Enable the Debug Module during STOP mode.

Return values

None

Definition at line 487 of file stm32f4xx_hal.c.

◆ HAL_Delay()

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 390 of file stm32f4xx_hal.c.

References HAL_GetTick(), HAL_MAX_DELAY, and uwTickFreq.

Here is the call graph for this function:

◆ HAL_DisableCompensationCell()

void HAL_DisableCompensationCell ( void )

Power-down the I/O Compensation Cell.

Note: The I/O compensation cell can be used only when the device supply voltage ranges from 2.4 to 3.6 V.

Return values

None

Definition at line 536 of file stm32f4xx_hal.c.

References CMPCR_CMP_PD_BB.

◆ HAL_EnableCompensationCell()

void HAL_EnableCompensationCell ( void )

Enables the I/O Compensation Cell.

Note: The I/O compensation cell can be used only when the device supply voltage ranges from 2.4 to 3.6 V.

Return values

None

Definition at line 525 of file stm32f4xx_hal.c.

References CMPCR_CMP_PD_BB.

◆ HAL_GetDEVID()

uint32_t HAL_GetDEVID ( void )

Returns the device identifier.

Return values

Device identifier

Definition at line 460 of file stm32f4xx_hal.c.

References IDCODE_DEVID_MASK.

◆ HAL_GetHalVersion()

uint32_t HAL_GetHalVersion ( void )

Returns the HAL revision.

Return values

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

< [31:24] main version

< [23:16] sub1 version

< [15:8] sub2 version

< [7:0] release candidate

Definition at line 442 of file stm32f4xx_hal.c.

References __STM32F4xx_HAL_VERSION.

◆ HAL_GetREVID()

uint32_t HAL_GetREVID ( void )

Returns the device revision identifier.

Return values

Device revision identifier

Definition at line 451 of file stm32f4xx_hal.c.

◆ HAL_GetTick()

uint32_t HAL_GetTick ( void )

Provides 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 323 of file stm32f4xx_hal.c.

References uwTick.

Referenced by HAL_Delay().

◆ HAL_GetTickFreq()

HAL_TickFreqTypeDef HAL_GetTickFreq ( void )

Return tick frequency.

Return values

Tick	frequency. Value of HAL_TickFreqTypeDef.

Definition at line 374 of file stm32f4xx_hal.c.

References uwTickFreq.

◆ HAL_GetTickPrio()

uint32_t HAL_GetTickPrio ( void )

This function returns a tick priority.

Return values

tick priority

Definition at line 332 of file stm32f4xx_hal.c.

References uwTickPrio.

◆ HAL_GetUIDw0()

uint32_t HAL_GetUIDw0 ( void )

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

Return values

Device identifier

Definition at line 545 of file stm32f4xx_hal.c.

◆ HAL_GetUIDw1()

uint32_t HAL_GetUIDw1 ( void )

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

Return values

Device identifier

Definition at line 554 of file stm32f4xx_hal.c.

◆ HAL_GetUIDw2()

uint32_t HAL_GetUIDw2 ( void )

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

Return values

Device identifier

Definition at line 563 of file stm32f4xx_hal.c.

◆ HAL_IncTick()

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 312 of file stm32f4xx_hal.c.

References uwTick, and uwTickFreq.

Referenced by HAL_RTC_AlarmAEventCallback(), HAL_RTCEx_WakeUpTimerEventCallback(), and HAL_TIM_PeriodElapsedCallback().

◆ HAL_ResumeTick()

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 432 of file stm32f4xx_hal.c.

◆ HAL_SetTickFreq()

HAL_StatusTypeDef HAL_SetTickFreq ( HAL_TickFreqTypeDef Freq )

Set new tick Freq.

Return values

Status

Definition at line 341 of file stm32f4xx_hal.c.

References assert_param, HAL_InitTick(), HAL_OK, IS_TICKFREQ, uwTickFreq, and uwTickPrio.

Here is the call graph for this function:

◆ HAL_SuspendTick()

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 416 of file stm32f4xx_hal.c.

Functions

Detailed Description

Function Documentation

◆ HAL_DBGMCU_DisableDBGSleepMode()

◆ HAL_DBGMCU_DisableDBGStandbyMode()

◆ HAL_DBGMCU_DisableDBGStopMode()

◆ HAL_DBGMCU_EnableDBGSleepMode()

◆ HAL_DBGMCU_EnableDBGStandbyMode()

◆ HAL_DBGMCU_EnableDBGStopMode()

◆ HAL_Delay()

◆ HAL_DisableCompensationCell()

◆ HAL_EnableCompensationCell()

◆ HAL_GetDEVID()

◆ HAL_GetHalVersion()

◆ HAL_GetREVID()

◆ HAL_GetTick()

◆ HAL_GetTickFreq()

◆ HAL_GetTickPrio()

◆ HAL_GetUIDw0()

◆ HAL_GetUIDw1()

◆ HAL_GetUIDw2()

◆ HAL_IncTick()

◆ HAL_ResumeTick()

◆ HAL_SetTickFreq()

◆ HAL_SuspendTick()