#include <stktest.h>

Inheritance diagram for stk::test::KernelServiceMock:

Collaboration diagram for stk::test::KernelServiceMock:

Public Member Functions
	KernelServiceMock ()
virtual	~KernelServiceMock ()
size_t	GetTid () const
	Get thread Id of the currently running task.
int64_t	GetTicks () const
	Get number of ticks elapsed since kernel start.
uint32_t	GetTickResolution () const
	Get number of microseconds in one tick.
Cycles	GetSysTimerCount () const
	Get system timer count value.
uint32_t	GetSysTimerFrequency () const
	Get system timer frequency.
void	Delay (Timeout ticks)
	Delay calling process.
void	Sleep (Timeout ticks)
	Put calling process into a sleep state.
void	SleepUntil (Ticks timestamp)
	Put calling process into a sleep state until the specified timestamp.
void	SwitchToNext ()
	Notify scheduler to switch to the next task (yield).
IWaitObject *	Wait (ISyncObject sobj, IMutex mutex, Timeout timeout)
	Put calling process into a waiting state until synchronization object is signaled or timeout occurs.
Timeout	Suspend ()
	Suspend scheduling.
void	Resume (Timeout elapsed_ticks)
	Resume scheduling after a prior Suspend() call.

Static Public Member Functions
static IKernelService *	GetInstance ()
	Get CPU-local instance of the kernel service.

Public Attributes
bool	m_inc_ticks
bool	m_switch_to_next
int64_t	m_ticks
int32_t	m_resolution
size_t	m_tid
uint64_t	m_systimer_count
uint32_t	m_systimer_freq

Detailed Description

IKernelService mock.

Definition at line 286 of file stktest.h.

Constructor & Destructor Documentation

◆ KernelServiceMock()

stk::test::KernelServiceMock::KernelServiceMock ( )

inline

Definition at line 289 of file stktest.h.

    {
        m_inc_ticks      = false;
        m_switch_to_next = false;
        m_ticks          = 0;
        m_resolution     = 0;
        m_tid            = 0;
        m_systimer_count = 0;
        m_systimer_freq  = 0;
    }

References m_inc_ticks, m_resolution, m_switch_to_next, m_systimer_count, m_systimer_freq, m_ticks, and m_tid.

◆ ~KernelServiceMock()

virtual stk::test::KernelServiceMock::~KernelServiceMock ( )

inlinevirtual

Definition at line 299 of file stktest.h.

300 {}

Member Function Documentation

◆ Delay()

void stk::test::KernelServiceMock::Delay ( Timeout ticks )

inlinevirtual

Delay calling process.

Note: Unlike Sleep this function delays code execution by spinning in a loop until deadline expiry.; Use with care in HRT mode to avoid missed deadline (see stk::KERNEL_HRT, ITask::OnDeadlineMissed).

Parameters

[in] ticks Delay time (ticks).

Warning: ISR-unsafe. Calling from an ISR context is not permitted and will trigger an assertion.

See also: Delay

Implements stk::IKernelService.

Definition at line 330 of file stktest.h.

    {
        (void)ticks;
    }

◆ GetInstance()

IKernelService * IKernelService::GetInstance ( )

staticinherited

Get CPU-local instance of the kernel service.

Definition at line 69 of file stktest.cpp.

{
    return g_KernelService;
}

References stk::test::g_KernelService.

Referenced by stk::Delay(), stk::GetSysTimerCount(), stk::GetSysTimerFrequency(), stk::GetTickResolution(), stk::GetTicks(), stk::GetTid(), stk::GetTimeNowMs(), osKernelResume(), osKernelSuspend(), stk::Sleep(), stk::SleepUntil(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), stk::test::TEST(), stk::test::Test_SyncWait(), stk::sync::Mutex::TimedLock(), stk::sync::ConditionVariable::Wait(), stk::sync::Event::Wait(), stk::sync::Semaphore::Wait(), and stk::Yield().

Here is the caller graph for this function:

◆ GetSysTimerCount()

Cycles stk::test::KernelServiceMock::GetSysTimerCount ( ) const

inlinevirtual

Get system timer count value.

Note: ISR-safe.

Returns: 64-bit count value.

Implements stk::IKernelService.

Definition at line 320 of file stktest.h.

    {
        return m_systimer_count;
    }

References m_systimer_count.

◆ GetSysTimerFrequency()

uint32_t stk::test::KernelServiceMock::GetSysTimerFrequency ( ) const

inlinevirtual

Get system timer frequency.

Note: ISR-safe.

Returns: Frequency (Hz).

Implements stk::IKernelService.

Definition at line 325 of file stktest.h.

    {
        return m_systimer_freq;
    }

References m_systimer_freq.

◆ GetTickResolution()

uint32_t stk::test::KernelServiceMock::GetTickResolution ( ) const

inlinevirtual

Get number of microseconds in one tick.

Note: Tick is a periodicity of the system timer expressed in microseconds.; ISR-safe.

Returns: Microseconds in one tick.

Implements stk::IKernelService.

Definition at line 315 of file stktest.h.

    {
        return m_resolution;
    }

References m_resolution.

Referenced by stk::test::TEST().

Here is the caller graph for this function:

◆ GetTicks()

int64_t stk::test::KernelServiceMock::GetTicks ( ) const

inlinevirtual

Get number of ticks elapsed since kernel start.

Returns: Ticks.

Note: ISR-safe.

Implements stk::IKernelService.

Definition at line 307 of file stktest.h.

    {
        if (m_inc_ticks)
            const_cast<int64_t &>(m_ticks) = m_ticks + 1;
 
        return m_ticks;
    }

References m_inc_ticks, and m_ticks.

◆ GetTid()

size_t stk::test::KernelServiceMock::GetTid ( ) const

inlinevirtual

Get thread Id of the currently running task.

Returns: Thread Id.

Warning: ISR-safe.

See also: TID_ISR_N, TID_NONE, IsIsrTid

Implements stk::IKernelService.

Definition at line 302 of file stktest.h.

    {
        return m_tid;
    }

References m_tid.

◆ Resume()

void stk::test::KernelServiceMock::Resume ( Timeout elapsed_ticks )

inlinevirtual

Resume scheduling after a prior Suspend() call.

Parameters

[in] elapsed_ticks Number of ticks that elapsed during the suspended period. The kernel uses this value to advance internal time counters and wake tasks whose sleep deadlines have expired.

Note: ISR-safe.

See also: IKernel::EState::STATE_SUSPENDED

Implements stk::IKernelService.

Definition at line 363 of file stktest.h.

    {
        (void)elapsed_ticks;
    }

◆ Sleep()

void stk::test::KernelServiceMock::Sleep ( Timeout ticks )

inlinevirtual

Put calling process into a sleep state.

Note: Unlike Delay this function does not waste CPU cycles and allows kernel to put CPU into a low-power state.; Unsupported in HRT mode (see stk::KERNEL_HRT); in HRT mode tasks sleep automatically according to their periodicity and workload.

Parameters

[in] ticks Sleep time (ticks).

Warning: ISR-unsafe. Calling from an ISR context is not permitted and will trigger an assertion.

Implements stk::IKernelService.

Definition at line 335 of file stktest.h.

    {
        (void)ticks;
    }

◆ SleepUntil()

void stk::test::KernelServiceMock::SleepUntil ( Ticks timestamp )

inlinevirtual

Put calling process into a sleep state until the specified timestamp.

Note: Unlike Delay this function does not waste CPU cycles and allows kernel to put CPU into a low-power state.; Unsupported in HRT mode (see stk::KERNEL_HRT); in HRT mode tasks sleep automatically according to their periodicity and workload.

Parameters

[in] timestamp Absolute timestamp (ticks).

Warning: ISR-unsafe. Calling from an ISR context is not permitted and will trigger an assertion.

Implements stk::IKernelService.

Definition at line 340 of file stktest.h.

    {
        (void)timestamp;
    }

◆ Suspend()

Timeout stk::test::KernelServiceMock::Suspend ( )

inlinevirtual

Suspend scheduling.

Returns: Number of ticks available for the suspension period, as determined by the nearest pending wake-up. The caller may program a hardware timer with this value to avoid unnecessary wakeups (tickless idle).

Note: ISR-safe. Pair with Resume().

See also: IKernel::EState::STATE_SUSPENDED

Implements stk::IKernelService.

Definition at line 358 of file stktest.h.

    {
        return 1;
    }

◆ SwitchToNext()

void stk::test::KernelServiceMock::SwitchToNext ( )

inlinevirtual

Notify scheduler to switch to the next task (yield).

Note: A cooperation mechanism in HRT mode (see stk::KERNEL_HRT).

Warning: ISR-unsafe.

Implements stk::IKernelService.

Definition at line 345 of file stktest.h.

    {
        m_switch_to_next = true;
    }

References m_switch_to_next.

◆ Wait()

IWaitObject * stk::test::KernelServiceMock::Wait	(	ISyncObject *	sobj,
		IMutex *	mutex,
		Timeout	timeout )

inlinevirtual

Put calling process into a waiting state until synchronization object is signaled or timeout occurs.

Note: This function implements core blocking logic using the Monitor pattern to ensure atomicity between state check and suspension.; The kernel automatically unlocks the provided mutex before the task is suspended and re-locks it before this function returns.

Parameters

[in]	sobj	Synchronization object to wait on.
[in]	mutex	Mutex protecting the state of the synchronization object.
[in]	timeout	Maximum wait time (ticks). Use `WAIT_INFINITE` to block indefinitely, use `NO_WAIT` to poll without blocking.

Returns: Pointer to the wait object representing this wait operation (always non-NULL). The caller must check IWaitObject::IsTimeout() after this function returns to determine whether the wake was caused by a signal or by timeout expiry. The returned pointer is valid until the calling task re-enters a wait or the wait object is explicitly released by the kernel. The return value is guaranteed non nullptr and points to a valid IWaitObject.

Warning: ISR-unsafe.

Implements stk::IKernelService.

Definition at line 350 of file stktest.h.

    {
        (void)sobj;
        (void)mutex;
        (void)timeout;
        return nullptr;
    }

Member Data Documentation

◆ m_inc_ticks

bool stk::test::KernelServiceMock::m_inc_ticks

Definition at line 368 of file stktest.h.

Referenced by GetTicks(), and KernelServiceMock().

◆ m_resolution

int32_t stk::test::KernelServiceMock::m_resolution

Definition at line 371 of file stktest.h.

Referenced by GetTickResolution(), KernelServiceMock(), and stk::test::TEST().

◆ m_switch_to_next

bool stk::test::KernelServiceMock::m_switch_to_next

Definition at line 369 of file stktest.h.

Referenced by KernelServiceMock(), and SwitchToNext().

◆ m_systimer_count

uint64_t stk::test::KernelServiceMock::m_systimer_count

Definition at line 373 of file stktest.h.

Referenced by GetSysTimerCount(), and KernelServiceMock().

◆ m_systimer_freq

uint32_t stk::test::KernelServiceMock::m_systimer_freq

Definition at line 374 of file stktest.h.

Referenced by GetSysTimerFrequency(), and KernelServiceMock().

◆ m_ticks

int64_t stk::test::KernelServiceMock::m_ticks

Definition at line 370 of file stktest.h.

Referenced by GetTicks(), KernelServiceMock(), and stk::test::TEST().

◆ m_tid

size_t stk::test::KernelServiceMock::m_tid

Definition at line 372 of file stktest.h.

Referenced by GetTid(), and KernelServiceMock().

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

stktest.h

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KernelServiceMock()

◆ ~KernelServiceMock()

Member Function Documentation

◆ Delay()

◆ GetInstance()

◆ GetSysTimerCount()

◆ GetSysTimerFrequency()

◆ GetTickResolution()

◆ GetTicks()

◆ GetTid()

◆ Resume()

◆ Sleep()

◆ SleepUntil()

◆ Suspend()

◆ SwitchToNext()

◆ Wait()

Member Data Documentation

◆ m_inc_ticks

◆ m_resolution

◆ m_switch_to_next

◆ m_systimer_count

◆ m_systimer_freq

◆ m_ticks

◆ m_tid