Inheritance diagram for StkTimer:

Collaboration diagram for StkTimer:

Public Member Functions
	StkTimer (osTimerFunc_t f, osTimerType_t t, void arg, const char n)
virtual	~StkTimer ()
void	OnExpired (stk::time::TimerHost *) override
bool	IsActive () const
Ticks	GetDeadline () const
Ticks	GetTimestamp () const
uint32_t	GetPeriod () const
uint32_t	GetRemainingTime () const
	Get remaining ticks until the timer next expires.

Static Public Member Functions
static bool	EnsureTimerHostCreated ()

Public Attributes
osTimerFunc_t	m_func
void *	m_argument
osTimerType_t	m_type
const char *	m_name
uint32_t	m_period_ticks
bool	m_cb_owned

Private Types
typedef DListEntry< Timer, _ClosedLoop >	DLEntryType
	Convenience alias for this entry type. Used to avoid repeating the full template spelling.
typedef DListHead< Timer, _ClosedLoop >	DLHeadType
	Convenience alias for the corresponding list head type.

Private Member Functions
	STK_NONCOPYABLE_CLASS (Timer)
DLHeadType *	GetHead () const
	Get the list head this entry currently belongs to.
DLEntryType *	GetNext () const
	Get the next entry in the list.
DLEntryType *	GetPrev () const
	Get the previous entry in the list.
bool	IsLinked () const
	Check whether this entry is currently a member of any list.
	operator Timer * ()
	Implicit conversion to a mutable pointer to the host object (T).
	operator const Timer * () const
	Implicit conversion to a const pointer to the host object (T).
void	Link (DLHeadType head, DLEntryType next, DLEntryType *prev)
	Wire this entry into a list between prev and next.
void	Unlink ()
	Remove this entry from its current list.

Private Attributes
Ticks	m_deadline
	absolute expiration time (ticks)
Ticks	m_timestamp
	time at which timer expired (ticks), updated by TimerHost
uint32_t	m_period
	reload period in ticks (0 = one-shot)
volatile bool	m_active
	true if active
volatile bool	m_pending
	true if pending to be handled
DLHeadType *	m_head
	Owning list head, or `NULL` when the entry is not linked.
DLEntryType *	m_next
	Next entry in the list, or `NULL` (open list boundary) / first entry (closed loop).
DLEntryType *	m_prev
	Previous entry in the list, or `NULL` (open list boundary) / last entry (closed loop).

Detailed Description

Definition at line 306 of file cmsis_os2_stk.cpp.

Member Typedef Documentation

◆ DLEntryType

typedef DListEntry<Timer, _ClosedLoop> stk::util::DListEntry< Timer, _ClosedLoop >::DLEntryType

inherited

Convenience alias for this entry type. Used to avoid repeating the full template spelling.

Definition at line 70 of file stk_linked_list.h.

◆ DLHeadType

typedef DListHead<Timer, _ClosedLoop> stk::util::DListEntry< Timer, _ClosedLoop >::DLHeadType

inherited

Convenience alias for the corresponding list head type.

Definition at line 75 of file stk_linked_list.h.

Constructor & Destructor Documentation

◆ StkTimer()

StkTimer::StkTimer	(	osTimerFunc_t	f,
		osTimerType_t	t,
		void *	arg,
		const char *	n )

inlineexplicit

Definition at line 308 of file cmsis_os2_stk.cpp.

References m_argument, m_cb_owned, m_func, m_name, m_period_ticks, and m_type.

◆ ~StkTimer()

virtual StkTimer::~StkTimer ( )

inlinevirtual

Definition at line 311 of file cmsis_os2_stk.cpp.

Member Function Documentation

◆ EnsureTimerHostCreated()

bool StkTimer::EnsureTimerHostCreated ( )

inlinestatic

Definition at line 319 of file cmsis_os2_stk.cpp.

References stk::ACCESS_PRIVILEGED, g_StkKernel, g_TimerHost, and g_TimerHostBuf.

Referenced by osTimerNew().

Here is the caller graph for this function:

◆ GetDeadline()

Ticks stk::time::TimerHost::Timer::GetDeadline ( ) const

inlineinherited

Definition at line 154 of file stk_time_timer.h.

References m_deadline.

Referenced by stk_timer_get_deadline().

Here is the caller graph for this function:

◆ GetHead()

DLHeadType * stk::util::DListEntry< Timer, _ClosedLoop >::GetHead ( ) const

inlineinherited

Get the list head this entry currently belongs to.

Returns: Pointer to the owning DListHead, or NULL if the entry is not linked.

Definition at line 80 of file stk_linked_list.h.

◆ GetNext()

DLEntryType * stk::util::DListEntry< Timer, _ClosedLoop >::GetNext ( ) const

inlineinherited

Get the next entry in the list.

Returns: Pointer to the next DListEntry, or NULL if this is the last entry (open list) or the first entry (closed loop, where next wraps to first).

Note: In a closed loop (_ClosedLoop == true) this pointer is never NULL when the entry is linked.

Definition at line 88 of file stk_linked_list.h.

◆ GetPeriod()

uint32_t stk::time::TimerHost::Timer::GetPeriod ( ) const

inlineinherited

Definition at line 156 of file stk_time_timer.h.

References m_period.

Referenced by stk_timer_get_period().

Here is the caller graph for this function:

◆ GetPrev()

DLEntryType * stk::util::DListEntry< Timer, _ClosedLoop >::GetPrev ( ) const

inlineinherited

Get the previous entry in the list.

Returns: Pointer to the previous DListEntry, or NULL if this is the first entry (open list) or the last entry (closed loop, where prev wraps to last).

Note: In a closed loop (_ClosedLoop == true) this pointer is never NULL when the entry is linked.

Definition at line 96 of file stk_linked_list.h.

◆ GetRemainingTime()

uint32_t stk::time::TimerHost::Timer::GetRemainingTime ( ) const

inlineinherited

Get remaining ticks until the timer next expires.

Returns: Ticks remaining, or 0 if already expired / not active.

Note: The value is advisory: it is computed from m_now (the last value written by the tick task) and may be up to one tick task wake cycle stale. If the deadline has already passed but not yet been processed, 0 is returned.

Definition at line 371 of file stk_time_timer.h.

References stk::GetTicks(), m_active, and m_deadline.

Referenced by stk_timer_get_remaining_time().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTimestamp()

Ticks stk::time::TimerHost::Timer::GetTimestamp ( ) const

inlineinherited

Definition at line 155 of file stk_time_timer.h.

References m_timestamp.

Referenced by stk_timer_get_timestamp().

Here is the caller graph for this function:

◆ IsActive()

bool stk::time::TimerHost::Timer::IsActive ( ) const

inlineinherited

Definition at line 153 of file stk_time_timer.h.

References m_active.

Referenced by osTimerDelete(), osTimerStop(), stk_timer_destroy(), and stk_timer_is_active().

Here is the caller graph for this function:

◆ IsLinked()

bool stk::util::DListEntry< Timer, _ClosedLoop >::IsLinked ( ) const

inlineinherited

Check whether this entry is currently a member of any list.

Returns: true if linked (m_head != NULL); false otherwise.

Definition at line 101 of file stk_linked_list.h.

◆ Link()

void stk::util::DListEntry< Timer, _ClosedLoop >::Link	(	DLHeadType *	head,
		DLEntryType *	next,
		DLEntryType *	prev )

inlineprivateinherited

Wire this entry into a list between prev and next.

Parameters

[in]	head	The owning DListHead. Stored as a back-pointer for IsLinked() and ownership checks.
[in]	next	The entry that will follow this one, or `NULL` if this becomes the last entry.
[in]	prev	The entry that will precede this one, or `NULL` if this becomes the first entry.

Note: Called exclusively by DListHead::Link(). Assumes the entry is not currently linked. Updates the neighbours' forward/back pointers to splice this entry in.

Definition at line 137 of file stk_linked_list.h.

◆ OnExpired()

void StkTimer::OnExpired ( stk::time::TimerHost * )

inlineoverridevirtual

Implements stk::time::TimerHost::Timer.

Definition at line 314 of file cmsis_os2_stk.cpp.

References m_argument, and m_func.

◆ operator const Timer *()

stk::util::DListEntry< Timer, _ClosedLoop >::operator const Timer * ( ) const

inlineinherited

Implicit conversion to a const pointer to the host object (T).

Note: Safe because T must derive from DListEntry<T, _ClosedLoop>. Eliminates the need for explicit static_cast at call sites.; MISRA deviation: [STK-DEV-004] Rule 5-2-x.

Definition at line 115 of file stk_linked_list.h.

◆ operator Timer *()

stk::util::DListEntry< Timer, _ClosedLoop >::operator Timer* ( )

inlineinherited

Implicit conversion to a mutable pointer to the host object (T).

Note: Safe because T must derive from DListEntry<T, _ClosedLoop>. Eliminates the need for explicit static_cast at call sites.; MISRA deviation: [STK-DEV-004] Rule 5-2-x.

Definition at line 108 of file stk_linked_list.h.

◆ STK_NONCOPYABLE_CLASS()

stk::time::TimerHost::Timer::STK_NONCOPYABLE_CLASS ( Timer )

privateinherited

References Timer().

Here is the call graph for this function:

◆ Unlink()

void stk::util::DListEntry< Timer, _ClosedLoop >::Unlink ( )

inlineprivateinherited

Remove this entry from its current list.

Note: Called exclusively by DListHead::Unlink(). Patches the neighbours' pointers to bridge over this entry, then clears m_head, m_next, and m_prev to NULL so the entry is in a clean unlinked state.; Does not update DListHead::m_count or m_first / m_last — those are the responsibility of the calling DListHead::Unlink().

Definition at line 157 of file stk_linked_list.h.

Member Data Documentation

◆ m_active

volatile bool stk::time::TimerHost::Timer::m_active

privateinherited

true if active

Definition at line 172 of file stk_time_timer.h.

Referenced by GetRemainingTime(), IsActive(), stk::time::TimerHost::ProcessCommands(), stk::time::TimerHost::Reset(), stk::time::TimerHost::SetPeriod(), stk::time::TimerHost::Start(), stk::time::TimerHost::Stop(), Timer(), and stk::time::TimerHost::UpdateTime().

◆ m_argument

void* StkTimer::m_argument

Definition at line 332 of file cmsis_os2_stk.cpp.

Referenced by OnExpired(), and StkTimer().

◆ m_cb_owned

bool StkTimer::m_cb_owned

Definition at line 336 of file cmsis_os2_stk.cpp.

Referenced by StkTimer().

◆ m_deadline

Ticks stk::time::TimerHost::Timer::m_deadline

privateinherited

absolute expiration time (ticks)

Definition at line 169 of file stk_time_timer.h.

Referenced by GetDeadline(), GetRemainingTime(), stk::time::TimerHost::ProcessCommands(), Timer(), and stk::time::TimerHost::UpdateTime().

◆ m_func

osTimerFunc_t StkTimer::m_func

Definition at line 331 of file cmsis_os2_stk.cpp.

Referenced by OnExpired(), and StkTimer().

◆ m_head

DLHeadType* stk::util::DListEntry< Timer, _ClosedLoop >::m_head

privateinherited

Owning list head, or NULL when the entry is not linked.

Definition at line 170 of file stk_linked_list.h.

◆ m_name

const char* StkTimer::m_name

Definition at line 334 of file cmsis_os2_stk.cpp.

Referenced by StkTimer().

◆ m_next

DLEntryType* stk::util::DListEntry< Timer, _ClosedLoop >::m_next

privateinherited

Next entry in the list, or NULL (open list boundary) / first entry (closed loop).

Definition at line 171 of file stk_linked_list.h.

◆ m_pending

volatile bool stk::time::TimerHost::Timer::m_pending

privateinherited

true if pending to be handled

Definition at line 173 of file stk_time_timer.h.

Referenced by stk::time::TimerHost::ProcessCommands(), stk::time::TimerHost::ProcessTimers(), Timer(), and stk::time::TimerHost::UpdateTime().

◆ m_period

uint32_t stk::time::TimerHost::Timer::m_period

privateinherited

reload period in ticks (0 = one-shot)

Definition at line 171 of file stk_time_timer.h.

Referenced by GetPeriod(), stk::time::TimerHost::ProcessCommands(), stk::time::TimerHost::Reset(), stk::time::TimerHost::SetPeriod(), Timer(), and stk::time::TimerHost::UpdateTime().

◆ m_period_ticks

uint32_t StkTimer::m_period_ticks

Definition at line 335 of file cmsis_os2_stk.cpp.

Referenced by osTimerStart(), and StkTimer().

◆ m_prev

DLEntryType* stk::util::DListEntry< Timer, _ClosedLoop >::m_prev

privateinherited

Previous entry in the list, or NULL (open list boundary) / last entry (closed loop).

Definition at line 172 of file stk_linked_list.h.

◆ m_timestamp

Ticks stk::time::TimerHost::Timer::m_timestamp

privateinherited

time at which timer expired (ticks), updated by TimerHost

Definition at line 170 of file stk_time_timer.h.

Referenced by GetTimestamp(), Timer(), and stk::time::TimerHost::UpdateTime().

◆ m_type

osTimerType_t StkTimer::m_type

Definition at line 333 of file cmsis_os2_stk.cpp.

Referenced by osTimerStart(), and StkTimer().

The documentation for this struct was generated from the following file:

cmsis_os2_stk.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DLEntryType

◆ DLHeadType

Constructor & Destructor Documentation

◆ StkTimer()

◆ ~StkTimer()

Member Function Documentation

◆ EnsureTimerHostCreated()

◆ GetDeadline()

◆ GetHead()

◆ GetNext()

◆ GetPeriod()

◆ GetPrev()

◆ GetRemainingTime()

◆ GetTimestamp()

◆ IsActive()

◆ IsLinked()

◆ Link()

◆ OnExpired()

◆ operator const Timer *()

◆ operator Timer *()

◆ STK_NONCOPYABLE_CLASS()

◆ Unlink()

Member Data Documentation

◆ m_active

◆ m_argument

◆ m_cb_owned

◆ m_deadline

◆ m_func

◆ m_head

◆ m_name

◆ m_next

◆ m_pending

◆ m_period

◆ m_period_ticks

◆ m_prev

◆ m_timestamp

◆ m_type