QK/C++ platform-independent public interface. More...

#include "qequeue.h"
#include "qmpool.h"
#include "qpset.h"

Classes
class	QK
	QK services. More...
Defines
#define	QF_EQUEUE_TYPE QEQueue
	This macro defines the type of the event queue used for the active objects.
#define	QACTIVE_EQUEUE_WAIT_(me_) Q_ASSERT((me_)->m_eQueue.m_frontEvt != static_cast<QEvt const *>(0))
	Platform-dependent macro defining how QF should block the calling task when the QF native queue is empty.
#define	QACTIVE_EQUEUE_SIGNAL_(me_)
	Platform-dependent macro defining how QF should signal the active object task that an event has just arrived.
#define	QACTIVE_EQUEUE_ONEMPTY_(me_) QK_readySet_.remove((me_)->m_prio)
	Platform-dependent macro defining the action QF should take when the native QF event queue becomes empty.
#define	QF_EPOOL_TYPE_ QMPool
	This macro defines the type of the event pool used in this QF port.
#define	QF_EPOOL_INIT_(p_, poolSto_, poolSize_, evtSize_)
	Platform-dependent macro defining the event pool initialization.
#define	QF_EPOOL_EVENT_SIZE_(p_) static_cast<uint32_t>((p_).getBlockSize())
	Platform-dependent macro defining how QF should obtain the event pool block-size.
#define	QF_EPOOL_GET_(p_, e_) ((e_) = static_cast<QEvt *>((p_).get()))
	Platform-dependent macro defining how QF should obtain an event e_ from the event pool p_.
#define	QF_EPOOL_PUT_(p_, e_) ((p_).put(e_))
	Platform-dependent macro defining how QF should return an event e_ to the event pool p_.
Functions
QP_END_ void	QK_init (void)
	QK initialization.
void	QK_sched_ (uint8_t p)
	The QK scheduler.
void	QK_schedExt_ (uint8_t p)
	The QK extended scheduler for interrupt context.
uint8_t	QK_schedPrio_ (void)
	Find the highest-priority task ready to run.
Variables
QP_BEGIN_ typedef uint8_t	QMutex
	QK Mutex type.
QP_ QPSet64	QK_readySet_
	ready set of QK
uint8_t	QK_currPrio_
	current task/interrupt priority
uint8_t	QK_intNest_
	interrupt nesting level

Detailed Description

QK/C++ platform-independent public interface.

This header file must be included directly or indirectly in all modules (*.cpp files) that use QK/C++.

Definition in file qk.h.

Define Documentation

#define QACTIVE_EQUEUE_ONEMPTY_ ( me_ ) QK_readySet_.remove((me_)->m_prio)

Platform-dependent macro defining the action QF should take when the native QF event queue becomes empty.

Note:: QACTIVE_EQUEUE_ONEMPTY_ is called from a critical section. It should not leave the critical section.; This is just an example of QACTIVE_EQUEUE_ONEMPTY_ for the QK-port of QF. In other QF ports you need to define the macro appropriately for the underlying kernel/OS you're using.

Definition at line 139 of file qk.h.

#define QACTIVE_EQUEUE_SIGNAL_ ( me_ )

Value:

do { \
    QK_readySet_.insert((me_)->m_prio); \
    if (QK_intNest_ == static_cast<uint8_t>(0)) { \
        uint8_t p = QK_schedPrio_(); \
        if (p != static_cast<uint8_t>(0)) { \
            QK_sched_(p); \
        } \
    } \
} while (false)

Platform-dependent macro defining how QF should signal the active object task that an event has just arrived.

The macro is necessary only when the native QF event queue is used. The signaling of task involves unblocking the task if it is blocked.

Note:: QACTIVE_EQUEUE_SIGNAL_ is called from a critical section. It might leave the critical section internally, but must restore the critical section before exiting to the caller.; This is just an example of QACTIVE_EQUEUE_SIGNAL_ for the QK-port of QF. In other QF ports you need to define the macro appropriately for the underlying kernel/OS you're using.

Definition at line 120 of file qk.h.

Referenced by QActive::postFIFO(), and QActive::postLIFO().

#define QACTIVE_EQUEUE_WAIT_ ( me_ ) Q_ASSERT((me_)->m_eQueue.m_frontEvt != static_cast<QEvt const *>(0))

Platform-dependent macro defining how QF should block the calling task when the QF native queue is empty.

Note:: This is just an example of QACTIVE_EQUEUE_WAIT_ for the QK-port of QF. QK never activates a task that has no events to process, so in this case the macro asserts that the queue is not empty. In other QF ports you using.

Definition at line 104 of file qk.h.

#define QF_EPOOL_EVENT_SIZE_ ( p_ ) static_cast<uint32_t>((p_).getBlockSize())

Platform-dependent macro defining how QF should obtain the event pool block-size.

Note:: This is a specific implementation for the QK-port of QF. In other QF ports you need to define the macro appropriately for the underlying kernel/OS you're using.

Definition at line 166 of file qk.h.

Referenced by QF::new_(), and QF::poolInit().

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

Platform-dependent macro defining how QF should obtain an event e_ from the event pool p_.

Note:: This is a specific implementation for the QK-port of QF. In other QF ports you need to define the macro appropriately for the underlying kernel/OS you're using.

Definition at line 175 of file qk.h.

Referenced by QF::new_().

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

Value:

(p_).init((poolSto_), (poolSize_), \
        static_cast<QMPoolSize>(evtSize_))

Platform-dependent macro defining the event pool initialization.

Note:: This is a specific implementation for the QK-port of QF. In other QF ports you need to define the macro appropriately for the underlying kernel/OS you're using.

Definition at line 156 of file qk.h.

Referenced by QF::poolInit().

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

Platform-dependent macro defining how QF should return an event e_ to the event pool p_.

Note:: This is a specific implementation for the QK-port of QF. In other QF ports you need to define the macro appropriately for the underlying kernel/OS you're using.

Definition at line 183 of file qk.h.

Referenced by QF::gc().

#define QF_EPOOL_TYPE_ QMPool

This macro defines the type of the event pool used in this QF port.

Note:: This is a specific implementation for the QK-port of QF. In other QF ports you need to define the macro appropriately for the underlying kernel/OS you're using.

Definition at line 149 of file qk.h.

#define QF_EQUEUE_TYPE QEQueue

This macro defines the type of the event queue used for the active objects.

Note:: This is just an example of the macro definition. Typically, you need to define it in the specific QF port file (qf_port.h). In case of QK, which always depends on the native QF queue, this macro is defined at the level of the platform-independent interface qk.h.

Definition at line 59 of file qk.h.