Linux Face / QPFramework
Embed: (wiki syntax)

« Back to documentation index

QK Class Reference

QK Class Reference

QK services. More...

#include <qk.h>

Static Public Member Functions

static char const Q_ROM *Q_ROM_VAR getVersion (void)
 get the current QK version number string
static char const Q_ROM *Q_ROM_VAR getPortVersion (void)
 Returns the QK-port version.
static void onIdle (void)
 QK idle callback (customized in BSPs for QK)
static QMutex mutexLock (uint8_t prioCeiling)
 QK priority-ceiling mutex lock.
static void mutexUnlock (QMutex mutex)
 QK priority-ceiling mutex unlock.

Detailed Description

QK services.

This class groups together QK services. It has only static members and should not be instantiated. to the QK class (as static class members). However, to avoid C++ potential name-mangling problems in assembly language, these elements are defined outside of the QK class and use the extern "C" linkage specification.

Definition at line 195 of file qk.h.


Member Function Documentation

static char const Q_ROM* Q_ROM_VAR getPortVersion ( void   ) [static]

Returns the QK-port version.

This function returns constant version string in the format x.y.zz, where x (one digit) is the major version, y (one digit) is the minor version, and zz (two digits) is the maintenance release version. An example of the QK-port version string is "1.1.03".

See also:
QK::getVersion()
static char const Q_ROM* Q_ROM_VAR getVersion ( void   ) [static]

get the current QK version number string

Returns:
version of the QK as a constant 6-character string of the form x.y.zz, where x is a 1-digit major version number, y is a 1-digit minor version number, and zz is a 2-digit release number.
See also:
QK::getPortVersion()
static QMutex mutexLock ( uint8_t  prioCeiling ) [static]

QK priority-ceiling mutex lock.

Lock the QK scheduler up to the priority level prioCeiling. The code between QK::mutexLock() and QK::mutexUnlock() should be kept to the minimum.

static void mutexUnlock ( QMutex  mutex ) [static]

QK priority-ceiling mutex unlock.

Note:
This function should be always paired with QK::mutexLock(). The code between QK::mutexLock() and QK::mutexUnlock() should be kept to the minimum.
static void onIdle ( void   ) [static]

QK idle callback (customized in BSPs for QK)

QK::onIdle() is called continously by the QK idle loop. This callback gives the application an opportunity to enter a power-saving CPU mode, or perform some other idle processing.

Note:
QK::onIdle() is invoked with interrupts unlocked and must also return with interrupts unlocked.
See also:
QF::onIdle()