HAL Control functions

HAL Control functions. More...

Functions
void	HAL_IncTick (void)
	This function is called to increment a global variable "uwTick" used as application time base. More...
void	HAL_Delay (__IO uint32_t Delay)
	This function provides accurate delay (in milliseconds) based on variable incremented. More...
uint32_t	HAL_GetTick (void)
	Provides a tick value in millisecond. More...
void	HAL_SuspendTick (void)
	Suspend Tick increment. More...
void	HAL_ResumeTick (void)
	Resume Tick increment. More...
uint32_t	HAL_GetHalVersion (void)
	Returns the HAL revision. More...
uint32_t	HAL_GetREVID (void)
	Returns the device revision identifier. More...
uint32_t	HAL_GetDEVID (void)
	Returns the device identifier. More...
void	HAL_DBGMCU_EnableDBGSleepMode (void)
	Enable the Debug Module during SLEEP mode. More...
void	HAL_DBGMCU_DisableDBGSleepMode (void)
	Disable the Debug Module during SLEEP mode. More...
void	HAL_DBGMCU_EnableDBGStopMode (void)
	Enable the Debug Module during STOP mode. More...
void	HAL_DBGMCU_DisableDBGStopMode (void)
	Disable the Debug Module during STOP mode. More...
void	HAL_DBGMCU_EnableDBGStandbyMode (void)
	Enable the Debug Module during STANDBY mode. More...
void	HAL_DBGMCU_DisableDBGStandbyMode (void)
	Disable the Debug Module during STANDBY mode. More...
void	HAL_EnableCompensationCell (void)
	Enables the I/O Compensation Cell. More...
void	HAL_DisableCompensationCell (void)
	Power-down the I/O Compensation Cell. More...

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

HAL_DBGMCU_DisableDBGStandbyMode()

void HAL_DBGMCU_DisableDBGStandbyMode

(

void

)

Disable the Debug Module during STANDBY mode.

Return values

None

HAL_DBGMCU_DisableDBGStopMode()

void HAL_DBGMCU_DisableDBGStopMode

(

void

)

Disable the Debug Module during STOP mode.

Return values

None

HAL_DBGMCU_EnableDBGSleepMode()

void HAL_DBGMCU_EnableDBGSleepMode

(

void

)

Enable the Debug Module during SLEEP mode.

Return values

None

HAL_DBGMCU_EnableDBGStandbyMode()

void HAL_DBGMCU_EnableDBGStandbyMode

(

void

)

Enable the Debug Module during STANDBY mode.

Return values

None

HAL_DBGMCU_EnableDBGStopMode()

void HAL_DBGMCU_EnableDBGStopMode

(

void

)

Enable the Debug Module during STOP mode.

Return values

None

HAL_Delay()

__weak void HAL_Delay

(

__IO uint32_t

Delay

)

This function provides 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

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

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

HAL_GetDEVID()

uint32_t HAL_GetDEVID

(

void

)

Returns the device identifier.

Return values

Device

identifier

HAL_GetHalVersion()

uint32_t HAL_GetHalVersion

(

void

)

Returns the HAL revision.

Return values

version

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

HAL_GetREVID()

uint32_t HAL_GetREVID

(

void

)

Returns the device revision identifier.

Return values

Device

revision identifier

HAL_GetTick()

__weak 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

HAL_IncTick()

__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

HAL_ResumeTick()

__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

HAL_SuspendTick()

__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