STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
Functions
HAL Control functions
STM32F4xx_HAL_Driver » HAL » HAL Exported Functions

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

__weak void HAL_IncTick ( void )

#include <stm32f4xx_hal.h>

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

__weak void HAL_Delay ( uint32_t Delay)

#include <stm32f4xx_hal.h>

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
Delayspecifies 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.

Referenced by ETH_FlushTransmitFIFO(), ETH_SetDMAConfig(), ETH_SetMACConfig(), HAL_DSI_EnterULPM(), HAL_DSI_EnterULPMData(), HAL_DSI_ExitULPM(), HAL_DSI_ExitULPMData(), HAL_DSI_Init(), HAL_ETH_ExitPowerDownMode(), HAL_ETH_SetHashTable(), HAL_ETH_SetMACFilterConfig(), HAL_ETH_SetRxVLANIdentifier(), HAL_ETH_Start(), HAL_ETH_Start_IT(), HAL_ETH_Stop(), HAL_ETH_Stop_IT(), HAL_MMC_InitCard(), and HAL_SD_InitCard().

◆ HAL_GetTick()

__weak uint32_t HAL_GetTick ( void )

#include <stm32f4xx_hal.h>

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
tickvalue

Definition at line 323 of file stm32f4xx_hal.c.

References uwTick.

Referenced by CRYP_AESCCM_Process(), CRYP_AESGCM_Process(), CRYP_WaitOnCCFlag(), DSI_ShortWrite(), FLASH_WaitForLastOperation(), FMPI2C_IsErrorOccurred(), FMPI2C_WaitOnFlagUntilTimeout(), FMPI2C_WaitOnRXNEFlagUntilTimeout(), FMPI2C_WaitOnSTOPFlagUntilTimeout(), FMPI2C_WaitOnTXISFlagUntilTimeout(), FMPSMBUS_WaitOnFlagUntilTimeout(), HAL_ADC_PollForConversion(), HAL_ADC_PollForEvent(), HAL_ADCEx_InjectedPollForConversion(), HAL_CAN_Init(), HAL_CAN_Start(), HAL_CAN_Stop(), HAL_CRYPEx_AESCCM_GenerateAuthTAG(), HAL_CRYPEx_AESGCM_GenerateAuthTAG(), HAL_Delay(), HAL_DMA2D_Abort(), HAL_DMA2D_CLUTLoading_Abort(), HAL_DMA2D_CLUTLoading_Suspend(), HAL_DMA2D_PollForTransfer(), HAL_DMA2D_Suspend(), HAL_DMA_Abort(), HAL_DMA_Init(), HAL_DMA_PollForTransfer(), HAL_DSI_EnterULPM(), HAL_DSI_EnterULPMData(), HAL_DSI_ExitULPM(), HAL_DSI_ExitULPMData(), HAL_DSI_Init(), HAL_DSI_LongWrite(), HAL_DSI_Read(), HAL_ETH_Init(), HAL_ETH_ReadPHYRegister(), HAL_ETH_Transmit(), HAL_ETH_WritePHYRegister(), HAL_FMPI2C_IsDeviceReady(), HAL_FMPI2C_Master_Receive(), HAL_FMPI2C_Master_Transmit(), HAL_FMPI2C_Mem_Read(), HAL_FMPI2C_Mem_Write(), HAL_FMPI2C_Slave_Receive(), HAL_FMPI2C_Slave_Transmit(), HAL_FMPSMBUS_IsDeviceReady(), HAL_I2C_IsDeviceReady(), HAL_I2C_Master_Receive(), HAL_I2C_Master_Transmit(), HAL_I2C_Mem_Read(), HAL_I2C_Mem_Read_DMA(), HAL_I2C_Mem_Write(), HAL_I2C_Mem_Write_DMA(), HAL_I2C_Slave_Receive(), HAL_I2C_Slave_Transmit(), HAL_I2S_DMAStop(), HAL_IRDA_Receive(), HAL_IRDA_Transmit(), HAL_IWDG_Init(), HAL_LTDC_DeInit(), HAL_MMC_GetCardExtCSD(), HAL_MMC_ReadBlocks(), HAL_MMC_WriteBlocks(), HAL_PWREx_ControlVoltageScaling(), HAL_PWREx_DisableBkUpReg(), HAL_PWREx_DisableOverDrive(), HAL_PWREx_EnableBkUpReg(), HAL_PWREx_EnableOverDrive(), HAL_RCC_ClockConfig(), HAL_RCC_DeInit(), HAL_RCC_OscConfig(), HAL_RCCEx_PeriphCLKConfig(), HAL_RTC_DeactivateAlarm(), HAL_RTC_PollForAlarmAEvent(), HAL_RTC_SetAlarm(), HAL_RTC_WaitForSynchro(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_PollForAlarmBEvent(), HAL_RTCEx_PollForTamper1Event(), HAL_RTCEx_PollForTimeStampEvent(), HAL_RTCEx_PollForWakeUpTimerEvent(), HAL_RTCEx_SetSmoothCalib(), HAL_RTCEx_SetSynchroShift(), HAL_RTCEx_SetWakeUpTimer(), HAL_SAI_Receive(), HAL_SAI_Transmit(), HAL_SAI_Transmit_DMA(), HAL_SD_ReadBlocks(), HAL_SD_WriteBlocks(), HAL_SMARTCARD_Receive(), HAL_SMARTCARD_Transmit(), HAL_SMBUS_IsDeviceReady(), HAL_SPI_Receive(), HAL_SPI_Transmit(), HAL_SPI_TransmitReceive(), HAL_UART_Receive(), HAL_UART_Transmit(), HAL_UARTEx_ReceiveToIdle(), HAL_USART_Receive(), HAL_USART_Transmit(), HAL_USART_TransmitReceive(), HASH_WaitOnFlagUntilTimeout(), I2C_WaitOnBTFFlagUntilTimeout(), I2C_WaitOnFlagUntilTimeout(), I2C_WaitOnMasterAddressFlagUntilTimeout(), I2C_WaitOnRXNEFlagUntilTimeout(), I2C_WaitOnSTOPFlagUntilTimeout(), I2C_WaitOnTXEFlagUntilTimeout(), I2S_WaitFlagStateUntilTimeout(), IRDA_WaitOnFlagUntilTimeout(), MMC_ReadExtCSD(), RTC_EnterInitMode(), SD_FindSCR(), SD_SendSDStatus(), SMARTCARD_WaitOnFlagUntilTimeout(), SMBUS_WaitOnFlagUntilTimeout(), SPI_CloseRx_ISR(), SPI_CloseRxTx_ISR(), SPI_CloseTx_ISR(), SPI_DMAReceiveCplt(), SPI_DMARxAbortCallback(), SPI_DMATransmitCplt(), SPI_DMATransmitReceiveCplt(), SPI_WaitFlagStateUntilTimeout(), UART_WaitOnFlagUntilTimeout(), and USART_WaitOnFlagUntilTimeout().

◆ HAL_GetTickPrio()

uint32_t HAL_GetTickPrio ( void )

#include <stm32f4xx_hal.h>

This function returns a tick priority.

Return values
tickpriority

Definition at line 332 of file stm32f4xx_hal.c.

References uwTickPrio.

◆ HAL_SetTickFreq()

HAL_StatusTypeDef HAL_SetTickFreq ( HAL_TickFreqTypeDef Freq)

#include <stm32f4xx_hal.h>

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.

◆ HAL_GetTickFreq()

HAL_TickFreqTypeDef HAL_GetTickFreq ( void )

#include <stm32f4xx_hal.h>

Return tick frequency.

Return values
Tickfrequency. Value of HAL_TickFreqTypeDef.

Definition at line 374 of file stm32f4xx_hal.c.

References uwTickFreq.

◆ HAL_SuspendTick()

__weak void HAL_SuspendTick ( void )

#include <stm32f4xx_hal.h>

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.

◆ HAL_ResumeTick()

__weak void HAL_ResumeTick ( void )

#include <stm32f4xx_hal.h>

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

uint32_t HAL_GetHalVersion ( void )

#include <stm32f4xx_hal.h>

Returns the HAL revision.

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

Definition at line 442 of file stm32f4xx_hal.c.

References __STM32F4xx_HAL_VERSION.

◆ HAL_GetREVID()

uint32_t HAL_GetREVID ( void )

#include <stm32f4xx_hal.h>

Returns the device revision identifier.

Return values
Devicerevision identifier

Definition at line 451 of file stm32f4xx_hal.c.

◆ HAL_GetDEVID()

uint32_t HAL_GetDEVID ( void )

#include <stm32f4xx_hal.h>

Returns the device identifier.

Return values
Deviceidentifier

Definition at line 460 of file stm32f4xx_hal.c.

References IDCODE_DEVID_MASK.

◆ HAL_DBGMCU_EnableDBGSleepMode()

void HAL_DBGMCU_EnableDBGSleepMode ( void )

#include <stm32f4xx_hal.h>

Enable the Debug Module during SLEEP mode.

Return values
None

Definition at line 469 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_DisableDBGSleepMode()

void HAL_DBGMCU_DisableDBGSleepMode ( void )

#include <stm32f4xx_hal.h>

Disable the Debug Module during SLEEP mode.

Return values
None

Definition at line 478 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_EnableDBGStopMode()

void HAL_DBGMCU_EnableDBGStopMode ( void )

#include <stm32f4xx_hal.h>

Enable the Debug Module during STOP mode.

Return values
None

Definition at line 487 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_DisableDBGStopMode()

void HAL_DBGMCU_DisableDBGStopMode ( void )

#include <stm32f4xx_hal.h>

Disable the Debug Module during STOP mode.

Return values
None

Definition at line 496 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_EnableDBGStandbyMode()

void HAL_DBGMCU_EnableDBGStandbyMode ( void )

#include <stm32f4xx_hal.h>

Enable the Debug Module during STANDBY mode.

Return values
None

Definition at line 505 of file stm32f4xx_hal.c.

◆ HAL_DBGMCU_DisableDBGStandbyMode()

void HAL_DBGMCU_DisableDBGStandbyMode ( void )

#include <stm32f4xx_hal.h>

Disable the Debug Module during STANDBY mode.

Return values
None

Definition at line 514 of file stm32f4xx_hal.c.

◆ HAL_EnableCompensationCell()

void HAL_EnableCompensationCell ( void )

#include <stm32f4xx_hal.h>

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

void HAL_DisableCompensationCell ( void )

#include <stm32f4xx_hal.h>

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

uint32_t HAL_GetUIDw0 ( void )

#include <stm32f4xx_hal.h>

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

Return values
Deviceidentifier

Definition at line 545 of file stm32f4xx_hal.c.

◆ HAL_GetUIDw1()

uint32_t HAL_GetUIDw1 ( void )

#include <stm32f4xx_hal.h>

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

Return values
Deviceidentifier

Definition at line 554 of file stm32f4xx_hal.c.

◆ HAL_GetUIDw2()

uint32_t HAL_GetUIDw2 ( void )

#include <stm32f4xx_hal.h>

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

Return values
Deviceidentifier

Definition at line 563 of file stm32f4xx_hal.c.