Functions that configure the Core System Timer. More...

Functions
__STATIC_FORCEINLINE void	SysTimer_SetLoadValue (uint64_t value)
	Set system timer load value. More...

__STATIC_FORCEINLINE uint64_t	SysTimer_GetLoadValue (void)
	Get system timer load value. More...

__STATIC_FORCEINLINE void	SysTimer_SetCompareValue (uint64_t value)
	Set system timer compare value. More...

__STATIC_FORCEINLINE uint64_t	SysTimer_GetCompareValue (void)
	Get system timer compare value. More...

__STATIC_FORCEINLINE void	SysTimer_SetSWIRQ (void)
	Trigger or set software interrupt via system timer. More...

__STATIC_FORCEINLINE void	SysTimer_ClearSWIRQ (void)
	Clear system timer software interrupt pending request. More...

__STATIC_FORCEINLINE uint32_t	SysTimer_GetMsipValue (void)
	Get system timer MSIP register value. More...

__STATIC_FORCEINLINE void	SysTimer_SetMsipValue (uint32_t msip)
	Set system timer MSIP register value. More...

__STATIC_INLINE uint32_t	SysTick_Config (uint64_t ticks)
	System Tick Configuration. More...

__STATIC_FORCEINLINE uint32_t	SysTick_Reload (uint64_t ticks)
	System Tick Reload. More...

Detailed Description

Functions that configure the Core System Timer.

Function Documentation

◆ SysTick_Config()

__STATIC_INLINE uint32_t SysTick_Config ( uint64_t ticks )

System Tick Configuration.

Initializes the System Timer and its non-vector interrupt, and starts the System Tick Timer.

In our default implementation, the timer counter will be set to zero, and it will start a timer compare non-vector interrupt when it matchs the ticks user set, during the timer interrupt user should reload the system tick using SysTick_Reload function or similar function written by user, so it can produce period timer interrupt.

Parameters

[in] ticks Number of ticks between two interrupts.

Returns: 0 Function succeeded.; 1 Function failed.

See also

SysTimer_SetCompareValue; SysTimer_SetLoadValue

Definition at line 208 of file core_feature_timer.h.

 {
     SysTimer_SetLoadValue(0);
     SysTimer_SetCompareValue(ticks);
     __enable_timer_irq();
     return (0UL);
 }

References __enable_timer_irq(), SysTimer_SetCompareValue(), and SysTimer_SetLoadValue().

◆ SysTick_Reload()

__STATIC_FORCEINLINE uint32_t SysTick_Reload ( uint64_t ticks )

System Tick Reload.

Reload the System Timer Tick when the MTIMECMP reached TIME value

Parameters

[in] ticks Number of ticks between two interrupts.

Returns: 0 Function succeeded.; 1 Function failed.

See also

Definition at line 227 of file core_feature_timer.h.

 {
     uint64_t cur_ticks = SysTimer->MTIME;
     uint64_t reload_ticks = ticks + cur_ticks;
  
     if (__USUALLY(reload_ticks > cur_ticks)) {
         SysTimer->MTIMECMP = reload_ticks;
     } else {
         /* When added the ticks value, then the MTIMERCMP < TIMER,
          * which means the MTIMERCMP is overflowed,
          * so we need to reset the counter to zero */
         SysTimer->MTIME = 0;
         SysTimer->MTIMECMP = ticks;
     }
  
     return (0UL);
 }

References __USUALLY, and SysTimer.

◆ SysTimer_ClearSWIRQ()

__STATIC_FORCEINLINE void SysTimer_ClearSWIRQ ( void )

Clear system timer software interrupt pending request.

This function clear the system timer MSIP bit in MSIP register.

Remarks

Clear system timer MSIP bit in MSIP register to clear the software interrupt pending.
SysTimer_SetSWIRQ
SysTimer_GetMsipValue

Definition at line 162 of file core_feature_timer.h.

 {
     SysTimer->MSIP &= ~SysTimer_MSIP_MSIP_Msk;
 }

References SysTimer, and SysTimer_MSIP_MSIP_Msk.

◆ SysTimer_GetCompareValue()

__STATIC_FORCEINLINE uint64_t SysTimer_GetCompareValue ( void )

Get system timer compare value.

This function get the system timer compare value in MTIMERCMP register.

Returns: compare value of system timer MTIMERCMP register.

Remarks

Compare value is 64bits wide.
SysTimer_SetCompareValue

Definition at line 134 of file core_feature_timer.h.

 {
     return SysTimer->MTIMECMP;
 }

References SysTimer.

◆ SysTimer_GetLoadValue()

__STATIC_FORCEINLINE uint64_t SysTimer_GetLoadValue ( void )

Get system timer load value.

This function get the system timer current value in MTIMER register.

Returns: current value(64bit) of system timer MTIMER register.

Remarks

Load value is 64bits wide.
SysTimer_SetLoadValue

Definition at line 104 of file core_feature_timer.h.

 {
     return SysTimer->MTIME;
 }

References SysTimer.

◆ SysTimer_GetMsipValue()

__STATIC_FORCEINLINE uint32_t SysTimer_GetMsipValue ( void )

Get system timer MSIP register value.

This function get the system timer MSIP register value.

Returns: Value of Timer MSIP register.

Remarks

Bit0 is SW interrupt flag. Bit0 is 1 then SW interrupt set. Bit0 is 0 then SW interrupt clear.
SysTimer_SetSWIRQ
SysTimer_ClearSWIRQ

Definition at line 178 of file core_feature_timer.h.

 {
     return (uint32_t)(SysTimer->MSIP & SysTimer_MSIP_Msk);
 }

References SysTimer, and SysTimer_MSIP_Msk.

◆ SysTimer_SetCompareValue()

__STATIC_FORCEINLINE void SysTimer_SetCompareValue ( uint64_t value )

Set system timer compare value.

This function set the system Timer compare value in MTIMERCMP register.

Parameters

[in] value compare value to set system timer MTIMERCMP register.

Remarks

Compare value is 64bits wide.
If compare value is larger than current value timer interrupt generate.
Modify the load value or compare value less to clear the interrupt.
SysTimer_GetCompareValue

Definition at line 120 of file core_feature_timer.h.

 {
     SysTimer->MTIMECMP = value;
 }

References SysTimer.

Referenced by SysTick_Config().

◆ SysTimer_SetLoadValue()

__STATIC_FORCEINLINE void SysTimer_SetLoadValue ( uint64_t value )

Set system timer load value.

This function set the system timer load value in MTIMER register.

Parameters

[in] value value to set system timer MTIMER register.

Remarks

Load value is 64bits wide.
SysTimer_GetLoadValue

Definition at line 90 of file core_feature_timer.h.

 {
     SysTimer->MTIME = value;
 }

References SysTimer.

Referenced by SysTick_Config().

◆ SysTimer_SetMsipValue()

__STATIC_FORCEINLINE void SysTimer_SetMsipValue ( uint32_t msip )

Set system timer MSIP register value.

This function set the system timer MSIP register value.

Parameters

[in] msip value to set MSIP register

Definition at line 189 of file core_feature_timer.h.

 {
     SysTimer->MSIP = (msip & SysTimer_MSIP_Msk);
 }

References SysTimer, and SysTimer_MSIP_Msk.

◆ SysTimer_SetSWIRQ()

__STATIC_FORCEINLINE void SysTimer_SetSWIRQ ( void )

Trigger or set software interrupt via system timer.

This function set the system timer MSIP bit in MSIP register.

Remarks

Set system timer MSIP bit and generate a SW interrupt.
SysTimer_ClearSWIRQ
SysTimer_GetMsipValue

Definition at line 148 of file core_feature_timer.h.

 {
     SysTimer->MSIP |= SysTimer_MSIP_MSIP_Msk;
 }

References SysTimer, and SysTimer_MSIP_MSIP_Msk.