QP/C++  6.5.1
QXK Class Reference

QXK services. More...

#include <qxk.h>

Collaboration diagram for QXK:
Collaboration graph

Static Public Member Functions

static QSchedStatus schedLock (uint_fast8_t const ceiling)
 QXK selective scheduler lock. More...
 
static void schedUnlock (QSchedStatus const stat)
 QXK selective scheduler unlock. More...
 
static void onIdle (void)
 QXK idle callback (customized in BSPs for QXK) More...
 
static char_t const * getVersion (void)
 get the current QXK version number string of the form X.Y.Z More...
 

Detailed Description

QXK services.

Description
This class groups together QXK services. It has only static members and should not be instantiated.
Note
The QXK initialization and the QXK scheduler belong conceptually to the QXK class (as static class members). However, to avoid C++ potential name-mangling problems in assembly language, these elements are defined outside of the QXK class and outside the QP namespace with the extern "C" linkage specification.

Definition at line 155 of file qxk.h.

Member Function Documentation

◆ schedLock()

static QSchedStatus schedLock ( uint_fast8_t const  ceiling)
static

QXK selective scheduler lock.

◆ schedUnlock()

static void schedUnlock ( QSchedStatus const  stat)
static

QXK selective scheduler unlock.

◆ onIdle()

static void onIdle ( void  )
static

QXK idle callback (customized in BSPs for QXK)

Description
QP::QXK::onIdle() is called continously by the QXK idle loop. This callback gives the application an opportunity to enter a power-saving CPU mode, or perform some other idle processing.
Note
QP::QXK::onIdle() is invoked with interrupts enabled and must also return with interrupts enabled.
See also
QP::QF::onIdle()

◆ getVersion()

static char_t const* getVersion ( void  )
inlinestatic

get the current QXK version number string of the form X.Y.Z

Definition at line 176 of file qxk.h.


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