STM32F479xx HAL User Manual
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)
 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.
__weak void HAL_Delay (uint32_t Delay)
 This function provides minimum 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)
 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)
void HAL_EnableMemorySwappingBank (void)
 Enables the Internal FLASH Bank Swapping.
void HAL_DisableMemorySwappingBank (void)
 Disables the Internal FLASH Bank Swapping.

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

void HAL_DBGMCU_DisableDBGSleepMode ( void  )

Disable the Debug Module during SLEEP mode.

Return values:
None

Definition at line 477 of file stm32f4xx_hal.c.

void HAL_DBGMCU_DisableDBGStandbyMode ( void  )

Disable the Debug Module during STANDBY mode.

Return values:
None

Definition at line 513 of file stm32f4xx_hal.c.

void HAL_DBGMCU_DisableDBGStopMode ( void  )

Disable the Debug Module during STOP mode.

Return values:
None

Definition at line 495 of file stm32f4xx_hal.c.

void HAL_DBGMCU_EnableDBGSleepMode ( void  )

Enable the Debug Module during SLEEP mode.

Return values:
None

Definition at line 468 of file stm32f4xx_hal.c.

void HAL_DBGMCU_EnableDBGStandbyMode ( void  )

Enable the Debug Module during STANDBY mode.

Return values:
None

Definition at line 504 of file stm32f4xx_hal.c.

void HAL_DBGMCU_EnableDBGStopMode ( void  )

Enable the Debug Module during STOP mode.

Return values:
None

Definition at line 486 of file stm32f4xx_hal.c.

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:
Delayspecifies the delay time length, in milliseconds.
Return values:
None

Definition at line 389 of file stm32f4xx_hal.c.

References HAL_GetTick(), and uwTickFreq.

Referenced by ETH_MACDMAConfig(), HAL_DSI_ExitULPM(), HAL_DSI_ExitULPMData(), HAL_ETH_ConfigDMA(), HAL_ETH_ConfigMAC(), and HAL_ETH_Init().

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

References CMPCR_CMP_PD_BB.

void HAL_DisableMemorySwappingBank ( void  )

Disables the Internal FLASH Bank Swapping.

Note:
This function can be used only for STM32F42xxx/43xxx/469xx/479xx devices.
The default state : Flash Bank1 mapped at 0x08000000 (and aliased @0x00000000) and Flash Bank2 mapped at 0x08100000 (and aliased at 0x00100000)
Return values:
None

Definition at line 594 of file stm32f4xx_hal.c.

References UFB_MODE_BB.

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

References CMPCR_CMP_PD_BB.

void HAL_EnableMemorySwappingBank ( void  )

Enables the Internal FLASH Bank Swapping.

Note:
This function can be used only for STM32F42xxx/43xxx/469xx/479xx devices.
Flash Bank2 mapped at 0x08000000 (and aliased @0x00000000) and Flash Bank1 mapped at 0x08100000 (and aliased at 0x00100000)
Return values:
None

Definition at line 579 of file stm32f4xx_hal.c.

References UFB_MODE_BB.

uint32_t HAL_GetDEVID ( void  )

Returns the device identifier.

Return values:
Deviceidentifier

Definition at line 459 of file stm32f4xx_hal.c.

References IDCODE_DEVID_MASK.

uint32_t HAL_GetHalVersion ( void  )

Returns the HAL revision.

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

Definition at line 441 of file stm32f4xx_hal.c.

References __STM32F4xx_HAL_VERSION.

uint32_t HAL_GetREVID ( void  )

Returns the device revision identifier.

Return values:
Devicerevision identifier

Definition at line 450 of file stm32f4xx_hal.c.

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

Definition at line 323 of file stm32f4xx_hal.c.

References uwTick.

Referenced by CRYP_AESCCM_Process(), CRYP_AESGCM_Process(), CRYP_WaitOnBUSYFlag(), CRYP_WaitOnIFEMFlag(), CRYP_WaitOnOFNEFlag(), DSI_ShortWrite(), FLASH_WaitForLastOperation(), 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_WritePHYRegister(), 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_MMC_ReadBlocks(), HAL_MMC_WriteBlocks(), HAL_NAND_Read_Page_16b(), HAL_NAND_Read_Page_8b(), HAL_NAND_Read_SpareArea_16b(), HAL_NAND_Read_SpareArea_8b(), HAL_NAND_Write_Page_16b(), HAL_NAND_Write_Page_8b(), HAL_NAND_Write_SpareArea_16b(), HAL_NAND_Write_SpareArea_8b(), HAL_NOR_GetStatus(), HAL_PWREx_ControlVoltageScaling(), HAL_PWREx_DisableBkUpReg(), HAL_PWREx_DisableOverDrive(), HAL_PWREx_EnableBkUpReg(), HAL_PWREx_EnableOverDrive(), HAL_QSPI_Abort(), HAL_QSPI_AutoPolling(), HAL_QSPI_AutoPolling_IT(), HAL_QSPI_Command(), HAL_QSPI_Command_IT(), HAL_QSPI_Init(), HAL_QSPI_MemoryMapped(), HAL_QSPI_Receive(), HAL_QSPI_Transmit(), HAL_RCC_ClockConfig(), HAL_RCC_DeInit(), HAL_RCC_OscConfig(), HAL_RCCEx_DisablePLLI2S(), HAL_RCCEx_DisablePLLSAI(), HAL_RCCEx_EnablePLLI2S(), HAL_RCCEx_EnablePLLSAI(), HAL_RCCEx_PeriphCLKConfig(), HAL_RNG_GenerateRandomNumber(), HAL_RTC_DeactivateAlarm(), HAL_RTC_DeInit(), HAL_RTC_PollForAlarmAEvent(), HAL_RTC_SetAlarm(), HAL_RTC_WaitForSynchro(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_PollForAlarmBEvent(), HAL_RTCEx_PollForTamper1Event(), HAL_RTCEx_PollForTamper2Event(), 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(), I2SEx_FullDuplexWaitFlagStateUntilTimeout(), IRDA_WaitOnFlagUntilTimeout(), MMC_ReadExtCSD(), QSPI_WaitFlagStateUntilTimeout(), 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_TickFreqTypeDef HAL_GetTickFreq ( void  )

Return tick frequency.

Return values:
tickperiod in Hz

Definition at line 373 of file stm32f4xx_hal.c.

References uwTickFreq.

uint32_t HAL_GetTickPrio ( void  )

This function returns a tick priority.

Return values:
tickpriority

Definition at line 332 of file stm32f4xx_hal.c.

References uwTickPrio.

uint32_t HAL_GetUIDw0 ( void  )

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

Return values:
Deviceidentifier

Definition at line 544 of file stm32f4xx_hal.c.

uint32_t HAL_GetUIDw1 ( void  )

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

Return values:
Deviceidentifier

Definition at line 553 of file stm32f4xx_hal.c.

uint32_t HAL_GetUIDw2 ( void  )

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

Return values:
Deviceidentifier

Definition at line 562 of file stm32f4xx_hal.c.

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.

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

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(), IS_TICKFREQ, uwTickFreq, and uwTickPrio.

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

Generated on Fri Jul 16 2021 16:03:51 for STM32F479xx HAL User Manual by   doxygen 1.7.6.1