HAL Control 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.
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)
	Return the HAL revision.
uint32_t	HAL_GetREVID (void)
	Return the device revision identifier.
uint32_t	HAL_GetDEVID (void)
	Return the device identifier.
uint32_t	HAL_GetUIDw0 (void)
	Return the first word of the unique device identifier (UID based on 96 bits)
uint32_t	HAL_GetUIDw1 (void)
	Return the second word of the unique device identifier (UID based on 96 bits)
uint32_t	HAL_GetUIDw2 (void)
	Return the 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

---

Function Documentation

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

References HAL_GetTick(), and uwTickFreq.

Referenced by HAL_DAC_ConfigChannel(), HAL_DACEx_SelfCalibrate(), HAL_MMC_InitCard(), HAL_OPAMP_SelfCalibrate(), HAL_OPAMPEx_SelfCalibrateAll(), HAL_PCDEx_BCD_VBUSDetect(), and HAL_SD_InitCard().

uint32_t HAL_GetDEVID

(

void

)

Return the device identifier.

Return values:

Device

identifier

Definition at line 472 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 454 of file stm32l4xx_hal.c.

References STM32L4XX_HAL_VERSION.

uint32_t HAL_GetREVID

(

void

)

Return the device revision identifier.

Return values:

Device

revision identifier

Definition at line 463 of file stm32l4xx_hal.c.

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

References uwTick.

Referenced by ADC_ConversionStop(), ADC_Disable(), ADC_Enable(), CRYP_WaitOnBusyFlagReset(), CRYP_WaitOnCCFlag(), FLASH_WaitForLastOperation(), HAL_ADC_PollForConversion(), HAL_ADC_PollForEvent(), HAL_ADCEx_InjectedPollForConversion(), HAL_CAN_Init(), HAL_CAN_Start(), HAL_CAN_Stop(), HAL_DAC_ConfigChannel(), HAL_Delay(), HAL_DMA_PollForTransfer(), HAL_I2C_IsDeviceReady(), HAL_I2C_Master_Receive(), HAL_I2C_Master_Transmit(), HAL_I2C_Mem_Read(), HAL_I2C_Mem_Read_DMA(), HAL_I2C_Mem_Read_IT(), HAL_I2C_Mem_Write(), HAL_I2C_Mem_Write_DMA(), HAL_I2C_Mem_Write_IT(), HAL_I2C_Slave_Receive(), HAL_I2C_Slave_Transmit(), HAL_IRDA_Receive(), HAL_IRDA_Transmit(), HAL_IWDG_Init(), HAL_LCD_Clear(), HAL_LCD_Init(), HAL_LCD_UpdateDisplayRequest(), HAL_LCD_Write(), HAL_MMC_GetCardExtCSD(), HAL_MMC_ReadBlocks(), HAL_MMC_WriteBlocks(), HAL_PCDEx_BCD_VBUSDetect(), 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_CRSWaitSynchronization(), HAL_RCCEx_DisablePLLSAI1(), HAL_RCCEx_EnablePLLSAI1(), HAL_RCCEx_PeriphCLKConfig(), HAL_RNG_DeInit(), HAL_RNG_GenerateRandomNumber(), HAL_RNG_Init(), HAL_RTC_DeactivateAlarm(), HAL_RTC_PollForAlarmAEvent(), HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), HAL_RTC_WaitForSynchro(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_PollForAlarmBEvent(), HAL_RTCEx_PollForTamper1Event(), HAL_RTCEx_PollForTamper2Event(), HAL_RTCEx_PollForTamper3Event(), HAL_RTCEx_PollForTimeStampEvent(), HAL_RTCEx_PollForWakeUpTimerEvent(), HAL_RTCEx_SetSmoothCalib(), HAL_RTCEx_SetSynchroShift(), HAL_RTCEx_SetWakeUpTimer(), HAL_RTCEx_SetWakeUpTimer_IT(), HAL_SAI_Receive(), HAL_SAI_Transmit(), HAL_SAI_Transmit_DMA(), HAL_SD_Init(), HAL_SD_ReadBlocks(), HAL_SD_WriteBlocks(), HAL_SMARTCARD_Receive(), HAL_SMARTCARD_Transmit(), HAL_SMBUS_IsDeviceReady(), HAL_SPI_Abort(), HAL_SPI_Receive(), HAL_SPI_Transmit(), HAL_SPI_TransmitReceive(), HAL_SWPMI_Receive(), HAL_SWPMI_Transmit(), HAL_SYSCFG_EnableVREFBUF(), HAL_UART_Receive(), HAL_UART_Transmit(), HAL_UARTEx_ReceiveToIdle(), HAL_UARTEx_StopModeWakeUpSourceConfig(), HAL_USART_Receive(), HAL_USART_Transmit(), HAL_USART_TransmitReceive(), I2C_IsErrorOccurred(), I2C_WaitOnFlagUntilTimeout(), I2C_WaitOnRXNEFlagUntilTimeout(), I2C_WaitOnSTOPFlagUntilTimeout(), I2C_WaitOnTXISFlagUntilTimeout(), IRDA_CheckIdleState(), IRDA_WaitOnFlagUntilTimeout(), LCD_WaitForSynchro(), MMC_ReadExtCSD(), QSPI_WaitFlagStateUntilTimeout(), RCCEx_PLLSAI1_Config(), RTC_EnterInitMode(), SD_FindSCR(), SD_PowerON(), SD_SendSDStatus(), SMARTCARD_CheckIdleState(), SMARTCARD_WaitOnFlagUntilTimeout(), SMBUS_WaitOnFlagUntilTimeout(), SPI_AbortRx_ISR(), SPI_AbortTx_ISR(), SPI_CloseRx_ISR(), SPI_CloseRxTx_ISR(), SPI_CloseTx_ISR(), SPI_DMAReceiveCplt(), SPI_DMARxAbortCallback(), SPI_DMATransmitCplt(), SPI_DMATransmitReceiveCplt(), SPI_DMATxAbortCallback(), SPI_WaitFifoStateUntilTimeout(), SPI_WaitFlagStateUntilTimeout(), SWPMI_DMATransmitCplt(), SWPMI_WaitOnFlagSetUntilTimeout(), UART_CheckIdleState(), UART_WaitOnFlagUntilTimeout(), USART_CheckIdleState(), and USART_WaitOnFlagUntilTimeout().

HAL_TickFreqTypeDef HAL_GetTickFreq

(

void

)

Return tick frequency.

Return values:

tick	period in Hz

Definition at line 386 of file stm32l4xx_hal.c.

References uwTickFreq.

uint32_t HAL_GetTickPrio

(

void

)

This function returns a tick priority.

Return values:

tick

priority

Definition at line 347 of file stm32l4xx_hal.c.

References uwTickPrio.

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

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

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 499 of file stm32l4xx_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 327 of file stm32l4xx_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 444 of file stm32l4xx_hal.c.

HAL_StatusTypeDef HAL_SetTickFreq

(

HAL_TickFreqTypeDef

Freq

)

Set new tick Freq.

Parameters:

Freq	tick frequency

Return values:

HAL

status

Definition at line 357 of file stm32l4xx_hal.c.

References HAL_InitTick(), 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 428 of file stm32l4xx_hal.c.