stk::test::event::ResetManualTask< _AccessMode > Class Template Reference

Tests Reset() on a manual-reset event. More...

Inheritance diagram for stk::test::event::ResetManualTask< _AccessMode >:

Collaboration diagram for stk::test::event::ResetManualTask< _AccessMode >:

Public Types
enum

Public Member Functions
	ResetManualTask (uint8_t task_id, int32_t)
Word *	GetStack () const
	Get pointer to the stack memory.
size_t	GetStackSize () const
	Get number of elements of the stack memory array.
size_t	GetStackSizeBytes () const
	Get size of the memory in bytes.
EAccessMode	GetAccessMode () const
	Get hardware access mode of the user task.
virtual void	OnDeadlineMissed (uint32_t duration)
	Default no-op handler. Override in subclass to log or handle missed deadlines.
virtual void	OnExit ()
	Default no-op handler. Override to implement join semantics (signal a waiting joiner).
virtual int32_t	GetWeight () const
	Default weight of 1. Override in subclass if custom scheduling weight is needed.
virtual TId	GetId () const
	Get object's own address as its Id. Unique per task instance, requires no manual assignment.
virtual const char *	GetTraceName () const
	Override in subclass to supply a name for SEGGER SystemView tracing. Returns NULL by default.
virtual size_t	GetStackSpace ()
	Get available stack space.

Private Member Functions
void	Run ()
	Entry point of the user task.

Private Attributes
uint8_t	m_task_id
StackMemoryDef< _StackSize >::Type	m_stack
	Stack memory region, 16-byte aligned.

Detailed Description

template<EAccessMode _AccessMode>
class stk::test::event::ResetManualTask< _AccessMode >

Tests Reset() on a manual-reset event.

Note

Verifies that Reset() clears the signaled state and that subsequent Wait() calls block correctly; also verifies Reset() return value (true on actual state change, false if already non-signaled).

Definition at line 325 of file test_event.cpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Definition at line 52 of file stk_helper.h.

{ STACK_SIZE = _StackSize }; 

Constructor & Destructor Documentation

ResetManualTask()

template<EAccessMode _AccessMode>

stk::test::event::ResetManualTask< _AccessMode >::ResetManualTask ( uint8_t task_id, int32_t  )

inline

Definition at line 330 of file test_event.cpp.

                                              : m_task_id(task_id)
    {}

References m_task_id.

Member Function Documentation

GetAccessMode()

EAccessMode stk::Task< _StackSize, _AccessMode >::GetAccessMode ( ) const

inlinevirtualinherited

Get hardware access mode of the user task.

Implements stk::ITask.

Definition at line 57 of file stk_helper.h.

{ return _AccessMode; }

GetId()

virtual TId stk::Task< _StackSize, _AccessMode >::GetId ( ) const

inlinevirtualinherited

Get object's own address as its Id. Unique per task instance, requires no manual assignment.

Implements stk::ITask.

Definition at line 77 of file stk_helper.h.

{ return hw::PtrToWord(this); }

GetStack()

Word * stk::Task< _StackSize, _AccessMode >::GetStack ( ) const

inlinevirtualinherited

Get pointer to the stack memory.

Implements stk::IStackMemory.

Definition at line 54 of file stk_helper.h.

{ return const_cast<Word *>(m_stack); }

GetStackSize()

size_t stk::Task< _StackSize, _AccessMode >::GetStackSize ( ) const

inlinevirtualinherited

Get number of elements of the stack memory array.

Implements stk::IStackMemory.

Definition at line 55 of file stk_helper.h.

{ return _StackSize; }

GetStackSizeBytes()

size_t stk::Task< _StackSize, _AccessMode >::GetStackSizeBytes ( ) const

inlinevirtualinherited

Get size of the memory in bytes.

Implements stk::IStackMemory.

Definition at line 56 of file stk_helper.h.

{ return _StackSize * sizeof(Word); }

GetStackSpace()

virtual size_t stk::IStackMemory::GetStackSpace ( )

inlinevirtualinherited

Get available stack space.

Returns

Number of elements of the stack memory array remaining on the stack (computed via the watermark pattern). Returns 0 if the stack has been fully used or the watermark STK_STACK_MEMORY_FILLER was overwritten.

Warning

Stack type: Bottom to Top (index[0]).

Definition at line 252 of file stk_common.h.

    {
        const Word *stack = GetStack();
        const size_t stack_size = GetStackSize();
 
        // count leading Words equal to STK_STACK_MEMORY_FILLER (watermark)
        size_t space = 0U;
        for ( ; (space < stack_size) && (stack[space] == STK_STACK_MEMORY_FILLER); ++space)
        {}
 
        return space;
    }

GetTraceName()

virtual const char * stk::Task< _StackSize, _AccessMode >::GetTraceName ( ) const

inlinevirtualinherited

Override in subclass to supply a name for SEGGER SystemView tracing. Returns NULL by default.

Implements stk::ITask.

Definition at line 81 of file stk_helper.h.

{ return nullptr; }

GetWeight()

virtual int32_t stk::Task< _StackSize, _AccessMode >::GetWeight ( ) const

inlinevirtualinherited

Default weight of 1. Override in subclass if custom scheduling weight is needed.

Note

Only relevant when using SwitchStrategySmoothWeightedRoundRobin. Prefer TaskW for compile-time weight assignment.

Implements stk::ITask.

Definition at line 73 of file stk_helper.h.

{ return 1; }

OnDeadlineMissed()

virtual void stk::Task< _StackSize, _AccessMode >::OnDeadlineMissed ( uint32_t duration )

inlinevirtualinherited

Default no-op handler. Override in subclass to log or handle missed deadlines.

Note

HRT deadline misses are only possible when the kernel is started with KERNEL_HRT.

Implements stk::ITask.

Definition at line 62 of file stk_helper.h.

{ STK_UNUSED(duration); }

OnExit()

virtual void stk::Task< _StackSize, _AccessMode >::OnExit ( )

inlinevirtualinherited

Default no-op handler. Override to implement join semantics (signal a waiting joiner).

Note

Called by the kernel only in KERNEL_DYNAMIC mode.

Implements stk::ITask.

Definition at line 67 of file stk_helper.h.

{}

Run()

template<EAccessMode _AccessMode>

void stk::test::event::ResetManualTask< _AccessMode >::Run ( )

inlineprivatevirtual

Entry point of the user task.

Note

Called by the Kernel when the task is scheduled for execution. Implement this method with the task's main logic.

Warning

If Kernel is configured as KERNEL_STATIC, the body must contain an infinite loop.

void Run()
{
    while (true)
    {
        // task logic here
    }
}

Implements stk::ITask.

Definition at line 334 of file test_event.cpp.

    {
        if (m_task_id == 0)
        {
            // Set the event (manual-reset), verify state, then Reset() and verify block
            bool set_changed   = g_TestEvent.Set();
            bool reset_changed = g_TestEvent.Reset();
            bool reset_again   = g_TestEvent.Reset(); // already non-signaled: must return false
 
            // Both tasks 1 and 2 were sleeping during Set/Reset; they should now time out
            stk::Sleep(_STK_EVT_TEST_LONG_SLEEP);
 
            printf("reset manual: set_changed=%d (expected 1), reset_changed=%d (expected 1), "
                "reset_again=%d (expected 0), counter=%d (expected 0)\n",
                (int)set_changed, (int)reset_changed, (int)reset_again, (int)g_SharedCounter);
 
            if (set_changed && reset_changed && !reset_again && (g_SharedCounter == 0))
                g_TestResult = 1;
        }
        else
        if (m_task_id == 1)
        {
            // Wait after Reset(); must time out because event was reset before we got here
            stk::Sleep(_STK_EVT_TEST_SHORT_SLEEP); // ensure task 0 has Set+Reset'd by now
 
            bool acquired = g_TestEvent.Wait(_STK_EVT_TEST_SHORT_SLEEP);
 
            if (!acquired)
                ; // expected; do not count
            else
                ++g_SharedCounter; // unexpected wake counts as a failure
        }
        else
        if (m_task_id == 2)
        {
            // Same as task 1: must also time out
            stk::Sleep(_STK_EVT_TEST_SHORT_SLEEP);
 
            bool acquired = g_TestEvent.Wait(_STK_EVT_TEST_SHORT_SLEEP);
 
            if (acquired)
                ++g_SharedCounter; // unexpected wake counts as a failure
        }
    }

References _STK_EVT_TEST_LONG_SLEEP, _STK_EVT_TEST_SHORT_SLEEP, stk::test::event::g_SharedCounter, stk::test::event::g_TestEvent, stk::test::event::g_TestResult, m_task_id, and stk::Sleep().

Here is the call graph for this function:

Member Data Documentation

m_stack

StackMemoryDef<_StackSize>::Type stk::Task< _StackSize, _AccessMode >::m_stack

privateinherited

Stack memory region, 16-byte aligned.

Definition at line 103 of file stk_helper.h.

m_task_id

template<EAccessMode _AccessMode>

uint8_t stk::test::event::ResetManualTask< _AccessMode >::m_task_id

private

Definition at line 327 of file test_event.cpp.

Referenced by ResetManualTask(), and Run().

---

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

• test_event.cpp