QXK/C++ preemptive extended (blocking) kernel, platform-independent public interface. More...

#include "qequeue.hpp"
#include "qmpool.hpp"
#include "qpset.hpp"

Data Structures
struct	QXK_Attr
	attributes of the QXK kernel More...

class	QXK
	QXK services. More...

Namespaces
namespace	QP
	namespace associated with the QP/C++ framework

Macros
#define	QF_EQUEUE_TYPE QEQueue

#define	QF_OS_OBJECT_TYPE void*

#define	QF_THREAD_TYPE void*

#define	QXK_TLS(type_) (static_cast<type_>(QXK_current()->m_thread))
	Access Thread-Local Storage (TLS) and cast it on the given `type_`. More...

#define	QXK_ISR_CONTEXT_() (QXK_attr_.intNest != 0U)
	Internal port-specific macro that reports the execution context. More...

#define	QF_SCHED_STAT_ QSchedStatus lockStat_;
	Internal macro to represent the scheduler lock status. More...

#define	QF_SCHED_LOCK_(prio_)
	Internal macro for selective scheduler locking. More...

#define	QF_SCHED_UNLOCK_()
	Internal macro for selective scheduler unlocking. More...

#define	QACTIVE_EQUEUE_WAIT_(me_) Q_ASSERT_ID(110, (me_)->m_eQueue.m_frontEvt != nullptr)

#define	QACTIVE_EQUEUE_SIGNAL_(me_)

#define	QF_EPOOL_TYPE_ QMPool

#define	QF_EPOOL_INIT_(p_, poolSto_, poolSize_, evtSize_) (p_).init((poolSto_), (poolSize_), (evtSize_))

#define	QF_EPOOL_EVENT_SIZE_(p_) ((p_).m_blockSize)

#define	QF_EPOOL_GET_(p_, e_, m_, qs_id_) ((e_) = static_cast<QEvt *>((p_).get((m_), (qs_id_))))

#define	QF_EPOOL_PUT_(p_, e_, qs_id_) ((p_).put((e_), (qs_id_)))

Functions
std::uint_fast8_t	QXK_sched_ (void) noexcept
	QXK scheduler finds the highest-priority thread ready to run. More...

void	QXK_activate_ (void)
	QXK activator activates the next active object. The activated AO preempts. More...

QP::QActive *	QXK_current (void) noexcept
	return the currently executing active-object/thread More...

void	QXK_onContextSw (QP::QActive prev, QP::QActive next)
	QXK context switch callback (customized in BSPs for QXK) More...

Variables
QXK_Attr	QXK_attr_
	global attributes of the QXK kernel More...

Detailed Description

Date: Last updated on: 2021-12-23

Version: Last updated for: Version 7.0.0, 2022-04-30

Definition in file qxk.hpp.

Data Structure Documentation

◆ QXK_Attr

struct QXK_Attr

Definition at line 66 of file qxk.hpp.

Data Fields
QActive *volatile	curr	currently executing thread
QActive *volatile	next	next thread to execute
uint8_t volatile	actPrio	prio of the active basic thread
uint8_t volatile	lockPrio	lock prio (0 == no-lock)
uint8_t volatile	lockHolder	prio of the lock holder
uint8_t volatile	intNest	ISR nesting level.
QActive *	idleThread	pointer to the idle thread
QPSet	readySet	ready-set of all threads

Macro Definition Documentation

◆ QF_EQUEUE_TYPE

#define QF_EQUEUE_TYPE QEQueue

Definition at line 43 of file qxk.hpp.

◆ QF_OS_OBJECT_TYPE

#define QF_OS_OBJECT_TYPE void*

Definition at line 48 of file qxk.hpp.

◆ QF_THREAD_TYPE

#define QF_THREAD_TYPE void*

Definition at line 51 of file qxk.hpp.

◆ QXK_TLS

#define QXK_TLS ( type_ ) (static_cast<type_>(QXK_current()->m_thread))

Definition at line 54 of file qxk.hpp.

◆ QXK_ISR_CONTEXT_

#define QXK_ISR_CONTEXT_ ( ) (QXK_attr_.intNest != 0U)

Returns: true if the code executes in the ISR context and false otherwise

Definition at line 170 of file qxk.hpp.

◆ QF_SCHED_STAT_

#define QF_SCHED_STAT_ QSchedStatus lockStat_;

Definition at line 178 of file qxk.hpp.

◆ QF_SCHED_LOCK_

#define QF_SCHED_LOCK_ ( prio_ )

Value:

        do {           \
        if (QXK_ISR_CONTEXT_()) {                \
            lockStat_ = 0xFFU;                   \
        } else {                                 \
            lockStat_ = QXK::schedLock((prio_)); \
        }                                        \
    } while (false)

Definition at line 181 of file qxk.hpp.

◆ QF_SCHED_UNLOCK_

#define QF_SCHED_UNLOCK_ ( )

Value:

        do {      \
        if (lockStat_ != 0xFFU) {        \
            QXK::schedUnlock(lockStat_); \
        }                                \
    } while (false)

Definition at line 190 of file qxk.hpp.

◆ QACTIVE_EQUEUE_WAIT_

#define QACTIVE_EQUEUE_WAIT_ ( me_ ) Q_ASSERT_ID(110, (me_)->m_eQueue.m_frontEvt != nullptr)

Definition at line 197 of file qxk.hpp.

◆ QACTIVE_EQUEUE_SIGNAL_

#define QACTIVE_EQUEUE_SIGNAL_ ( me_ )

Value:

        do {                   \
        QXK_attr_.readySet.insert(                             \
            static_cast<std::uint_fast8_t>((me_)->m_dynPrio)); \
        if (!QXK_ISR_CONTEXT_()) {                             \
            if (QXK_sched_() != 0U) {                          \
                QXK_activate_();                               \
            }                                                  \
        }                                                      \
    } while (false)

Definition at line 200 of file qxk.hpp.

◆ QF_EPOOL_TYPE_

#define QF_EPOOL_TYPE_ QMPool

Definition at line 211 of file qxk.hpp.

◆ QF_EPOOL_INIT_

#define QF_EPOOL_INIT_	(	p_,
		poolSto_,
		poolSize_,
		evtSize_
	)	(p_).init((poolSto_), (poolSize_), (evtSize_))

Definition at line 212 of file qxk.hpp.

◆ QF_EPOOL_EVENT_SIZE_

#define QF_EPOOL_EVENT_SIZE_ ( p_ ) ((p_).m_blockSize)

Definition at line 214 of file qxk.hpp.

◆ QF_EPOOL_GET_

#define QF_EPOOL_GET_	(	p_,
		e_,
		m_,
		qs_id_
	)	((e_) = static_cast<QEvt *>((p_).get((m_), (qs_id_))))

Definition at line 215 of file qxk.hpp.

◆ QF_EPOOL_PUT_

#define QF_EPOOL_PUT_	(	p_,
		e_,
		qs_id_
	)	((p_).put((e_), (qs_id_)))

Definition at line 217 of file qxk.hpp.

Function Documentation

◆ QXK_sched_()

std::uint_fast8_t QXK_sched_ ( void )

noexcept

Description: The QXK scheduler finds the priority of the highest-priority thread that is ready to run.

Returns: the 1-based priority of the the active object to run next, or zero if no eligible active object is found.

Attention: QXK_sched_() must be always called with interrupts disabled and returns with interrupts disabled.

Definition at line 340 of file qxk.cpp.

◆ QXK_activate_()

void QXK_activate_ ( void )

Attention: QXK_activate_() must be always called with interrupts disabled and returns with interrupts disabled.

Note: The activate function might enable interrupts internally, but it always returns with interrupts disabled.

Precondition: QXK_attr_.next must be valid

Definition at line 417 of file qxk.cpp.

◆ QXK_current()

QP::QActive * QXK_current ( void )

noexcept

Precondition: the QXK kernel must be running

Postcondition: the current thread must be valid

Definition at line 549 of file qxk.cpp.

◆ QXK_onContextSw()

void QXK_onContextSw	(	QP::QActive *	prev,
		QP::QActive *	next
	)

Description: This callback function provides a mechanism to perform additional custom operations when QXK switches context from one thread to another.

Parameters

[in]	prev	pointer to the previous thread (active object) (prev==0 means that `prev` was the QXK idle thread)
[in]	next	pointer to the next thread (active object) (next==0) means that `next` is the QXK idle thread)

Attention: QXK_onContextSw() is invoked with interrupts disabled and must also return with interrupts disabled.

Note: This callback is enabled by defining the macro #QXK_ON_CONTEXT_SW.

extern "C" { // use the "C" calling convention
 
#ifdef QXK_ON_CONTEXT_SW
// NOTE: the context-switch callback is called with interrupts DISABLED
void QXK_onContextSw(QActive *prev, QActive *next) {
    (void)prev;
    if (next != (QActive *)0) { // next is not the QK idle loop?
        _impure_ptr = next->thread; // switch to next TLS
    }
 
    // If you use QS software tracing, use the _NOCRIT() begin/end
    QS_BEGIN_NOCRIT(ON_CONTEXT_SW, 0U)
        QS_OBJ(prev);
        QS_OBJ(next);
    QS_END_NOCRIT()
}
#endif // QXK_ON_CONTEXT_SW
 
} // extern "C"

Variable Documentation

◆ QXK_attr_

QXK_Attr QXK_attr_

extern

Definition at line 54 of file qxk.cpp.

Data Structures

Namespaces

Macros

Functions

Variables

Detailed Description

Data Structure Documentation

◆ QXK_Attr

Macro Definition Documentation

◆ QF_EQUEUE_TYPE

◆ QF_OS_OBJECT_TYPE

◆ QF_THREAD_TYPE

◆ QXK_TLS

◆ QXK_ISR_CONTEXT_

◆ QF_SCHED_STAT_

◆ QF_SCHED_LOCK_

◆ QF_SCHED_UNLOCK_

◆ QACTIVE_EQUEUE_WAIT_

◆ QACTIVE_EQUEUE_SIGNAL_

◆ QF_EPOOL_TYPE_

◆ QF_EPOOL_INIT_

◆ QF_EPOOL_EVENT_SIZE_

◆ QF_EPOOL_GET_

◆ QF_EPOOL_PUT_

Function Documentation

◆ QXK_sched_()

◆ QXK_activate_()

◆ QXK_current()

◆ QXK_onContextSw()

Variable Documentation

◆ QXK_attr_