QP/C++  6.5.1
QP Namespace Reference
QEP | QF | QS | QV | QK | QXK

namespace associated with the QP/C++ framework More...

Data Structures

class  QActive
 QActive active object (based on QP::QHsm implementation) More...
 
class  QActiveDummy
 Dummy Active Object class. More...
 
class  QEP
 Provides miscellaneous QEP services. More...
 
class  QEQueue
 Native QF Event Queue class. More...
 
struct  QEvt
 QEvt base class. More...
 
class  QF
 QF services. More...
 
struct  QFreeBlock
 Structure representing a free block in the Native QF Memory Pool. More...
 
class  QHsm
 Hierarchical State Machine base class. More...
 
union  QHsmAttr
 Attribute of for the QHsm class (Hierarchical State Machine). More...
 
class  QK
 QK services. More...
 
class  QMActive
 QMActive active object (based on QP::QMsm implementation) More...
 
class  QMPool
 Native QF memory pool class. More...
 
class  QMsm
 QM State Machine implementation strategy. More...
 
struct  QMState
 State object for the QP::QMsm class (QM State Machine). More...
 
struct  QMTranActTable
 Transition-Action Table for the QP::QMsm State Machine. More...
 
class  QPSet
 Priority Set of up to 32 elements */. More...
 
class  QS
 QS logging facilities. More...
 
class  QTicker
 Ticker Active Object class. More...
 
class  QTimeEvt
 Time Event class. More...
 
class  QV
 QV services. More...
 
class  QXK
 QXK services. More...
 
class  QXMutex
 Priority Ceiling Mutex the QXK preemptive kernel. More...
 
class  QXSemaphore
 Counting Semaphore of the QXK preemptive kernel. More...
 
class  QXThread
 Extended (blocking) thread of the QXK preemptive kernel. More...
 

Typedefs

typedef uint16_t QSignal
 QSignal represents the signal of an event. More...
 
typedef uint_fast8_t QState
 Type returned from state-handler functions. More...
 
typedef QState(* QStateHandler) (void *const me, QEvt const *const e)
 pointer to state-handler function More...
 
typedef QState(* QActionHandler) (void *const me)
 pointer to an action-handler function More...
 
typedef uint8_t QEQueueCtr
 The data type to store the ring-buffer counters based on the macro QF_EQUEUE_CTR_SIZE. More...
 
typedef uint16_t QEvtSize
 The data type to store the block-size defined based on the macro QF_EVENT_SIZ_SIZE. More...
 
typedef uint16_t QTimeEvtCtr
 type of the Time Event counter, which determines the dynamic range of the time delays measured in clock ticks. More...
 
typedef QPSet QSubscrList
 Subscriber List. More...
 
typedef uint_fast16_t QSchedStatus
 The scheduler lock status. More...
 
typedef uint16_t QMPoolSize
 The data type to store the block-size based on the macro QF_MPOOL_SIZ_SIZE. More...
 
typedef uint16_t QMPoolCtr
 The data type to store the block-counter based on the macro QF_MPOOL_CTR_SIZE. More...
 
typedef QEvt QEvent
 deprecated typedef for backwards compatibility More...
 
typedef uint32_t QSTimeCtr
 The size (in bytes) of the QS time stamp. Valid values: 1, 2, or 4; default 4. More...
 
typedef unsigned int QSCtr
 QS ring buffer counter and offset type. More...
 
typedef void(* QXThreadHandler) (QXThread *const me)
 Thread handler pointer-to-function. More...
 

Enumerations

enum  QSpyRecords {
  QS_EMPTY, QS_QEP_STATE_ENTRY, QS_QEP_STATE_EXIT, QS_QEP_STATE_INIT,
  QS_QEP_INIT_TRAN, QS_QEP_INTERN_TRAN, QS_QEP_TRAN, QS_QEP_IGNORED,
  QS_QEP_DISPATCH, QS_QEP_UNHANDLED, QS_QF_ACTIVE_DEFER, QS_QF_ACTIVE_RECALL,
  QS_QF_ACTIVE_SUBSCRIBE, QS_QF_ACTIVE_UNSUBSCRIBE, QS_QF_ACTIVE_POST_FIFO, QS_QF_ACTIVE_POST_LIFO,
  QS_QF_ACTIVE_GET, QS_QF_ACTIVE_GET_LAST, QS_QF_ACTIVE_RECALL_ATTEMPT, QS_QF_EQUEUE_POST_FIFO,
  QS_QF_EQUEUE_POST_LIFO, QS_QF_EQUEUE_GET, QS_QF_EQUEUE_GET_LAST, QS_QF_RESERVED2,
  QS_QF_MPOOL_GET, QS_QF_MPOOL_PUT, QS_QF_PUBLISH, QS_QF_NEW_REF,
  QS_QF_NEW, QS_QF_GC_ATTEMPT, QS_QF_GC, QS_QF_TICK,
  QS_QF_TIMEEVT_ARM, QS_QF_TIMEEVT_AUTO_DISARM, QS_QF_TIMEEVT_DISARM_ATTEMPT, QS_QF_TIMEEVT_DISARM,
  QS_QF_TIMEEVT_REARM, QS_QF_TIMEEVT_POST, QS_QF_DELETE_REF, QS_QF_CRIT_ENTRY,
  QS_QF_CRIT_EXIT, QS_QF_ISR_ENTRY, QS_QF_ISR_EXIT, QS_QF_INT_DISABLE,
  QS_QF_INT_ENABLE, QS_QF_ACTIVE_POST_ATTEMPT, QS_QF_EQUEUE_POST_ATTEMPT, QS_QF_MPOOL_GET_ATTEMPT,
  QS_MUTEX_LOCK, QS_MUTEX_UNLOCK, QS_SCHED_LOCK, QS_SCHED_UNLOCK,
  QS_SCHED_NEXT, QS_SCHED_IDLE, QS_SCHED_RESUME, QS_QEP_TRAN_HIST,
  QS_QEP_TRAN_EP, QS_QEP_TRAN_XP, QS_TEST_PAUSED, QS_TEST_PROBE_GET,
  QS_SIG_DICT, QS_OBJ_DICT, QS_FUN_DICT, QS_USR_DICT,
  QS_TARGET_INFO, QS_TARGET_DONE, QS_RX_STATUS, QS_QUERY_DATA,
  QS_PEEK_DATA, QS_ASSERT_FAIL, QS_USER
}
 Quantum Spy record types. More...
 
enum  QSpyRecordGroups {
  QS_ALL_RECORDS = 0xF0, QS_SM_RECORDS, QS_AO_RECORDS, QS_EQ_RECORDS,
  QS_MP_RECORDS, QS_TE_RECORDS, QS_QF_RECORDS, QS_SC_RECORDS,
  QS_U0_RECORDS, QS_U1_RECORDS, QS_U2_RECORDS, QS_U3_RECORDS,
  QS_U4_RECORDS, QS_UA_RECORDS
}
 QS record groups for QS_FILTER_ON() and QS_FILTER_OFF() More...
 
enum  QSpyUserRecords {
  QS_USER0 = QS_USER, QS_USER1 = QS_USER0 + 10, QS_USER2 = QS_USER1 + 10, QS_USER3 = QS_USER2 + 10,
  QS_USER4 = QS_USER3 + 10
}
 QS user record group offsets. More...
 
enum  QSpyRxRecords {
  QS_RX_INFO, QS_RX_COMMAND, QS_RX_RESET, QS_RX_TICK,
  QS_RX_PEEK, QS_RX_POKE, QS_RX_FILL, QS_RX_TEST_SETUP,
  QS_RX_TEST_TEARDOWN, QS_RX_TEST_PROBE, QS_RX_GLB_FILTER, QS_RX_LOC_FILTER,
  QS_RX_AO_FILTER, QS_RX_CURR_OBJ, QS_RX_TEST_CONTINUE, QS_RX_QUERY_CURR,
  QS_RX_EVENT
}
 Quantum Spy Receive (RX) record types. More...
 
enum  QUTestUserRecords { QUTEST_ON_POST = 124 }
 
enum  { QEP_EMPTY_SIG_ = 0 }
 
enum  { TE_IS_LINKED = static_cast<uint8_t>(1U << 7), TE_WAS_DISARMED = static_cast<uint8_t>(1U << 6), TE_TICK_RATE = static_cast<uint8_t>(0x0F) }
 
enum  QXK_Timeouts { QXK_DELAY_SIG = Q_USER_SIG, QXK_QUEUE_SIG, QXK_SEMA_SIG }
 timeout signals More...
 

Functions

uint_fast8_t QF_LOG2 (QPSetBits x)
 
uint8_t QF_EVT_POOL_ID_ (QEvt const *const e)
 return the Pool-ID of an event e More...
 
uint8_t QF_EVT_REF_CTR_ (QEvt const *const e)
 return the Reference Conter of an event e More...
 
void QF_EVT_REF_CTR_INC_ (QEvt const *const e)
 increment the refCtr_ of an event e More...
 
void QF_EVT_REF_CTR_DEC_ (QEvt const *const e)
 decrement the refCtr_ of an event e More...
 
void QS_target_info_ (uint8_t const isReset)
 send the Target info (object sizes, build time-stamp, QP version) More...
 
static void rxParseData_ (uint8_t const b)
 
static void rxHandleBadFrame_ (uint8_t state)
 
static void rxReportAck_ (enum QSpyRxRecords recId)
 
static void rxReportError_ (uint8_t const code)
 
static void rxReportDone_ (enum QSpyRxRecords recId)
 
static void rxPoke_ (void)
 

Variables

char_t const versionStr [7] = QP_VERSION_STR
 the current QP version number string based on QP_VERSION_STR More...
 
enum_t const Q_USER_SIG = static_cast<enum_t>(4)
 Offset or the user signals. More...
 
uint_fast16_t const QF_NO_MARGIN = static_cast<uint_fast16_t>(0xFFFF)
 special value of margin that causes asserting failure in case event allocation or event posting fails More...
 
uint16_t const QS_EOD = static_cast<uint16_t>(0xFFFF)
 Constant representing End-Of-Data condition returned from the QP::QS::getByte() function. More...
 
char const BUILD_DATE [12] = __DATE__
 the calendar date of the last translation of the form: "Mmm dd yyyy" More...
 
char const BUILD_TIME [9] = __TIME__
 the time of the last translation of the form: "hh:mm:ss" More...
 
static QEvt const QEP_reservedEvt_ [4]
 
QF_EPOOL_TYPE_ QF_pool_ [QF_MAX_EPOOL]
 allocate event pools More...
 
uint_fast8_t QF_maxPool_
 
QSubscrListQF_subscrList_
 the subscriber list array More...
 
enum_t QF_maxPubSignal_
 the maximum published signal More...
 
uint8_t volatile QF_intNest
 
uint8_t const QS_FRAME = static_cast<uint8_t>(0x7E)
 Frame character of the QS output protocol. More...
 
uint8_t const QS_ESC = static_cast<uint8_t>(0x7D)
 Escape character of the QS output protocol. More...
 
uint8_t const QS_ESC_XOR = static_cast<uint8_t>(0x20)
 Escape modifier of the QS output protocol. More...
 
uint8_t const QS_GOOD_CHKSUM = static_cast<uint8_t>(0xFF)
 Escape character of the QS output protocol. More...
 
QPSet QV_readySet_
 ready set of AOs More...
 

Detailed Description

namespace associated with the QP/C++ framework


Data Structure Documentation

◆ QP::QFreeBlock

struct QP::QFreeBlock

Structure representing a free block in the Native QF Memory Pool.

See also
QP::QMPool

Definition at line 122 of file qf_pkg.h.

Collaboration diagram for QFreeBlock:
Collaboration graph
Data Fields
QFreeBlock *volatile m_next link to the next free block

◆ QP::QHsmAttr

union QP::QHsmAttr

Attribute of for the QHsm class (Hierarchical State Machine).

Description
This union represents possible values stored in the 'state' and 'temp' attributes of the QHsm and QMsm classes.

Definition at line 235 of file qep.h.

Collaboration diagram for QHsmAttr:
Collaboration graph
Data Fields
QStateHandler fun pointer to a state handler function
QActionHandler act pointer to an action-handler function
QMState const * obj pointer to QMState object
QMTranActTable const * tatbl transition-action table

◆ QP::QMState

struct QP::QMState

State object for the QP::QMsm class (QM State Machine).

Description
This class groups together the attributes of a QP::QMsm state, such as the parent state (state nesting), the associated state handler function and the exit action handler function. These attributes are used inside the QP::QMsm::dispatch() and QP::QMsm::init() functions.
Attention
The QP::QMState class is only intended for the QM code generator and should not be used in hand-crafted code.

Definition at line 541 of file qep.h.

Collaboration diagram for QMState:
Collaboration graph
Data Fields
QMState const * superstate superstate of this state
QStateHandler const stateHandler state handler function
QActionHandler const entryAction entry action handler function
QActionHandler const exitAction exit action handler function
QActionHandler const initAction init action handler function

◆ QP::QMTranActTable

struct QP::QMTranActTable

Transition-Action Table for the QP::QMsm State Machine.

Definition at line 550 of file qep.h.

Collaboration diagram for QMTranActTable:
Collaboration graph
Data Fields
QMState const * target
QActionHandler const act[1]

Typedef Documentation

◆ QSignal

typedef uint16_t QSignal

QSignal represents the signal of an event.

Description
The relationship between an event and a signal is as follows. A signal in UML is the specification of an asynchronous stimulus that triggers reactions, and as such is an essential part of an event. (The signal conveys the type of the occurrence–what happened?) However, an event can also contain additional quantitative information about the occurrence in form of event parameters.

Definition at line 148 of file qep.h.

◆ QState

Type returned from state-handler functions.

Definition at line 219 of file qep.h.

◆ QStateHandler

typedef QState(* QStateHandler) (void *const me, QEvt const *const e)

pointer to state-handler function

Definition at line 222 of file qep.h.

◆ QActionHandler

typedef QState(* QActionHandler) (void *const me)

pointer to an action-handler function

Definition at line 225 of file qep.h.

◆ QEQueueCtr

The data type to store the ring-buffer counters based on the macro QF_EQUEUE_CTR_SIZE.

Description
The dynamic range of this data type determines the maximum length of the ring buffer managed by the native QF event queue.

Definition at line 72 of file qequeue.h.

◆ QEvtSize

typedef uint16_t QEvtSize

The data type to store the block-size defined based on the macro QF_EVENT_SIZ_SIZE.

Description
The dynamic range of this data type determines the maximum block size that can be managed by the pool.

Definition at line 90 of file qf.h.

◆ QTimeEvtCtr

type of the Time Event counter, which determines the dynamic range of the time delays measured in clock ticks.

Description
This typedef is configurable via the preprocessor switch QF_TIMEEVT_CTR_SIZE. The other possible values of this type are as follows:
uint8_t when (QF_TIMEEVT_CTR_SIZE == 1), and
uint32_t when (QF_TIMEEVT_CTR_SIZE == 4).

Definition at line 109 of file qf.h.

◆ QSubscrList

typedef QPSet QSubscrList

Subscriber List.

Description
This data type represents a set of active objects that subscribe to a given signal. The set is represented as priority-set, where each bit corresponds to the unique priority of an active object.

Definition at line 510 of file qf.h.

◆ QSchedStatus

The scheduler lock status.

Definition at line 124 of file qk.h.

◆ QMPoolSize

The data type to store the block-size based on the macro QF_MPOOL_SIZ_SIZE.

Description
The dynamic range of this data type determines the maximum size of blocks that can be managed by the native QF event pool.

Definition at line 63 of file qmpool.h.

◆ QMPoolCtr

The data type to store the block-counter based on the macro QF_MPOOL_CTR_SIZE.

Description
The dynamic range of this data type determines the maximum number of blocks that can be stored in the pool.

Definition at line 78 of file qmpool.h.

◆ QEvent

typedef QEvt QEvent

deprecated typedef for backwards compatibility

Definition at line 129 of file qpcpp.h.

◆ QSTimeCtr

The size (in bytes) of the QS time stamp. Valid values: 1, 2, or 4; default 4.

Description
This macro can be defined in the QS port file (qs_port.h) to configure the QSTimeCtr type. Here the macro is not defined so the default of 4 byte is chosen.

Definition at line 222 of file qs.h.

◆ QSCtr

typedef unsigned int QSCtr

QS ring buffer counter and offset type.

Definition at line 231 of file qs.h.

◆ QXThreadHandler

typedef void(* QXThreadHandler) (QXThread *const me)

Thread handler pointer-to-function.

Definition at line 50 of file qxthread.h.

Enumeration Type Documentation

◆ QSpyRecords

Quantum Spy record types.

Description
This enumeration specifies the record types used in the QP components. You can specify your own record types starting from QP::QS_USER offset. Currently, the maximum of all records cannot exceed 256.
See also
QP::QS::filterOn() / QS_FILTER_ON() and QP::QS::filterOff() / QS_FILTER_OFF()
Enumerator
QS_EMPTY 

QS record for cleanly starting a session.

QS_QEP_STATE_ENTRY 

a state was entered

QS_QEP_STATE_EXIT 

a state was exited

QS_QEP_STATE_INIT 

an initial transition was taken in a state

QS_QEP_INIT_TRAN 

the top-most initial transition was taken

QS_QEP_INTERN_TRAN 

an internal transition was taken

QS_QEP_TRAN 

a regular transition was taken

QS_QEP_IGNORED 

an event was ignored (silently discarded)

QS_QEP_DISPATCH 

an event was dispatched (begin of RTC step)

QS_QEP_UNHANDLED 

an event was unhandled due to a guard

QS_QF_ACTIVE_DEFER 

AO deferred an event.

QS_QF_ACTIVE_RECALL 

AO recalled an event.

QS_QF_ACTIVE_SUBSCRIBE 

an AO subscribed to an event

QS_QF_ACTIVE_UNSUBSCRIBE 

an AO unsubscribed to an event

QS_QF_ACTIVE_POST_FIFO 

an event was posted (FIFO) directly to AO

QS_QF_ACTIVE_POST_LIFO 

an event was posted (LIFO) directly to AO

QS_QF_ACTIVE_GET 

an AO got an event and its queue is not empty

QS_QF_ACTIVE_GET_LAST 

an AO got an event and its queue is empty

QS_QF_ACTIVE_RECALL_ATTEMPT 

AO attempted to recall an event.

QS_QF_EQUEUE_POST_FIFO 

an event was posted (FIFO) to a raw queue

QS_QF_EQUEUE_POST_LIFO 

an event was posted (LIFO) to a raw queue

QS_QF_EQUEUE_GET 

get an event and queue still not empty

QS_QF_EQUEUE_GET_LAST 

get the last event from the queue

QS_QF_RESERVED2 
QS_QF_MPOOL_GET 

a memory block was removed from memory pool

QS_QF_MPOOL_PUT 

a memory block was returned to memory pool

QS_QF_PUBLISH 

an event was published

QS_QF_NEW_REF 

new event reference was created

QS_QF_NEW 

new event creation

QS_QF_GC_ATTEMPT 

garbage collection attempt

QS_QF_GC 

garbage collection

QS_QF_TICK 

QP::QF::tickX() was called.

QS_QF_TIMEEVT_ARM 

a time event was armed

QS_QF_TIMEEVT_AUTO_DISARM 

a time event expired and was disarmed

QS_QF_TIMEEVT_DISARM_ATTEMPT 

attempt to disarm a disarmed QTimeEvt

QS_QF_TIMEEVT_DISARM 

true disarming of an armed time event

QS_QF_TIMEEVT_REARM 

rearming of a time event

QS_QF_TIMEEVT_POST 

a time event posted itself directly to an AO

QS_QF_DELETE_REF 

an event reference is about to be deleted

QS_QF_CRIT_ENTRY 

critical section was entered

QS_QF_CRIT_EXIT 

critical section was exited

QS_QF_ISR_ENTRY 

an ISR was entered

QS_QF_ISR_EXIT 

an ISR was exited

QS_QF_INT_DISABLE 

interrupts were disabled

QS_QF_INT_ENABLE 

interrupts were enabled

QS_QF_ACTIVE_POST_ATTEMPT 

attempt to post an evt to AO failed

QS_QF_EQUEUE_POST_ATTEMPT 

attempt to post an evt to QEQueue failed

QS_QF_MPOOL_GET_ATTEMPT 

attempt to get a memory block failed

QS_MUTEX_LOCK 

a mutex was locked

QS_MUTEX_UNLOCK 

a mutex was unlocked

QS_SCHED_LOCK 

scheduler was locked

QS_SCHED_UNLOCK 

scheduler was unlocked

QS_SCHED_NEXT 

scheduler found next task to execute

QS_SCHED_IDLE 

scheduler became idle

QS_SCHED_RESUME 

scheduler resumed previous task (not idle)

QS_QEP_TRAN_HIST 

a tran to history was taken

QS_QEP_TRAN_EP 

a tran to entry point into a submachine

QS_QEP_TRAN_XP 

a tran to exit point out of a submachine

QS_TEST_PAUSED 

test has been paused

QS_TEST_PROBE_GET 

reports that Test-Probe has been used

QS_SIG_DICT 

signal dictionary entry

QS_OBJ_DICT 

object dictionary entry

QS_FUN_DICT 

function dictionary entry

QS_USR_DICT 

user QS record dictionary entry

QS_TARGET_INFO 

reports the Target information

QS_TARGET_DONE 

reports completion of a user callback

QS_RX_STATUS 

reports QS data receive status

QS_QUERY_DATA 

reports the data from "current object" query

QS_PEEK_DATA 

reports the data from the PEEK query

QS_ASSERT_FAIL 

assertion failed in the code

QS_USER 

the first record available to QS users

Definition at line 74 of file qs.h.

◆ QSpyRecordGroups

QS record groups for QS_FILTER_ON() and QS_FILTER_OFF()

Enumerator
QS_ALL_RECORDS 

all maskable QS records

QS_SM_RECORDS 

State Machine QS records.

QS_AO_RECORDS 

Active Object QS records.

QS_EQ_RECORDS 

Event Queues QS records.

QS_MP_RECORDS 

Memory Pools QS records.

QS_TE_RECORDS 

Time Events QS records.

QS_QF_RECORDS 

QF QS records.

QS_SC_RECORDS 

Scheduler QS records.

QS_U0_RECORDS 

User Group 70-79 records.

QS_U1_RECORDS 

User Group 80-89 records.

QS_U2_RECORDS 

User Group 90-99 records.

QS_U3_RECORDS 

User Group 100-109 records.

QS_U4_RECORDS 

User Group 110-124 records.

QS_UA_RECORDS 

All User records.

Definition at line 181 of file qs.h.

◆ QSpyUserRecords

QS user record group offsets.

Enumerator
QS_USER0 

offset for User Group 0

QS_USER1 

offset for User Group 1

QS_USER2 

offset for User Group 2

QS_USER3 

offset for User Group 3

QS_USER4 

offset for User Group 4

Definition at line 199 of file qs.h.

◆ QSpyRxRecords

Quantum Spy Receive (RX) record types.

Description
This enumeration specifies the record types for the QS receive channel
Enumerator
QS_RX_INFO 

query Target info (ver, config, tstamp)

QS_RX_COMMAND 

execute a user-defined command in the Target

QS_RX_RESET 

reset the Target

QS_RX_TICK 

call QF_tick()

QS_RX_PEEK 

peek Target memory

QS_RX_POKE 

poke Target memory

QS_RX_FILL 

fill Target memory

QS_RX_TEST_SETUP 

test setup

QS_RX_TEST_TEARDOWN 

test teardown

QS_RX_TEST_PROBE 

set a Test-Probe in the Target

QS_RX_GLB_FILTER 

set global filters in the Target

QS_RX_LOC_FILTER 

set local filters in the Target

QS_RX_AO_FILTER 

set local AO filter in the Target

QS_RX_CURR_OBJ 

set the "current-object" in the Target

QS_RX_TEST_CONTINUE 

continue a test after QS_RX_TEST_WAIT()

QS_RX_QUERY_CURR 

query the "current object" in the Target

QS_RX_EVENT 

inject an event to the Target (post/publish)

Definition at line 494 of file qs.h.

◆ QUTestUserRecords

Enumerator
QUTEST_ON_POST 

Definition at line 549 of file qs.h.

◆ anonymous enum

anonymous enum
Enumerator
QEP_EMPTY_SIG_ 

empty signal for internal use only

Definition at line 82 of file qep_hsm.cpp.

◆ anonymous enum

anonymous enum
Enumerator
TE_IS_LINKED 
TE_WAS_DISARMED 
TE_TICK_RATE 

Definition at line 132 of file qf_pkg.h.

◆ QXK_Timeouts

timeout signals

Enumerator
QXK_DELAY_SIG 
QXK_QUEUE_SIG 
QXK_SEMA_SIG 

Definition at line 45 of file qxk_pkg.h.

Function Documentation

◆ QF_LOG2()

uint_fast8_t QP::QF_LOG2 ( QPSetBits  x)

◆ QF_EVT_POOL_ID_()

uint8_t QP::QF_EVT_POOL_ID_ ( QEvt const *const  e)
inline

return the Pool-ID of an event e

Definition at line 142 of file qf_pkg.h.

◆ QF_EVT_REF_CTR_()

uint8_t QP::QF_EVT_REF_CTR_ ( QEvt const *const  e)
inline

return the Reference Conter of an event e

Definition at line 147 of file qf_pkg.h.

◆ QF_EVT_REF_CTR_INC_()

void QP::QF_EVT_REF_CTR_INC_ ( QEvt const *const  e)
inline

increment the refCtr_ of an event e

Definition at line 152 of file qf_pkg.h.

◆ QF_EVT_REF_CTR_DEC_()

void QP::QF_EVT_REF_CTR_DEC_ ( QEvt const *const  e)
inline

decrement the refCtr_ of an event e

Definition at line 157 of file qf_pkg.h.

◆ QS_target_info_()

void QS_target_info_ ( uint8_t const  isReset)

send the Target info (object sizes, build time-stamp, QP version)

Definition at line 361 of file qs.cpp.

◆ rxParseData_()

static void QP::rxParseData_ ( uint8_t const  b)
static

Definition at line 343 of file qs_rx.cpp.

◆ rxHandleBadFrame_()

static void QP::rxHandleBadFrame_ ( uint8_t  state)
static

Definition at line 1197 of file qs_rx.cpp.

◆ rxReportAck_()

static void QP::rxReportAck_ ( enum QSpyRxRecords  recId)
static

Definition at line 1212 of file qs_rx.cpp.

◆ rxReportError_()

static void QP::rxReportError_ ( uint8_t const  code)
static

Definition at line 1220 of file qs_rx.cpp.

◆ rxReportDone_()

static void QP::rxReportDone_ ( enum QSpyRxRecords  recId)
static

Definition at line 1228 of file qs_rx.cpp.

◆ rxPoke_()

static void QP::rxPoke_ ( void  )
static

Definition at line 1237 of file qs_rx.cpp.

Variable Documentation

◆ versionStr

char_t const versionStr = QP_VERSION_STR

the current QP version number string based on QP_VERSION_STR

Definition at line 79 of file qep_hsm.cpp.

◆ Q_USER_SIG

enum_t const Q_USER_SIG = static_cast<enum_t>(4)

Offset or the user signals.

Definition at line 567 of file qep.h.

◆ QF_NO_MARGIN

uint_fast16_t const QF_NO_MARGIN = static_cast<uint_fast16_t>(0xFFFF)

special value of margin that causes asserting failure in case event allocation or event posting fails

Definition at line 640 of file qf.h.

◆ QS_EOD

uint16_t const QS_EOD = static_cast<uint16_t>(0xFFFF)

Constant representing End-Of-Data condition returned from the QP::QS::getByte() function.

Definition at line 235 of file qs.h.

◆ BUILD_DATE

char_t const BUILD_DATE = __DATE__

the calendar date of the last translation of the form: "Mmm dd yyyy"

Definition at line 16 of file qstamp.cpp.

◆ BUILD_TIME

char_t const BUILD_TIME = __TIME__

the time of the last translation of the form: "hh:mm:ss"

Definition at line 19 of file qstamp.cpp.

◆ QEP_reservedEvt_

QEvt const QEP_reservedEvt_[4]
static
Initial value:
= {
{ static_cast<QSignal>(0),
static_cast<uint8_t>(0), static_cast<uint8_t>(0) },
{ static_cast<QSignal>(1),
static_cast<uint8_t>(0), static_cast<uint8_t>(0) },
{ static_cast<QSignal>(2),
static_cast<uint8_t>(0), static_cast<uint8_t>(0) },
{ static_cast<QSignal>(3),
static_cast<uint8_t>(0), static_cast<uint8_t>(0) }
}
Description
Static, preallocated standard events that the QEP event processor sends to state handler functions of QP::QHsm and QP::QFsm subclasses to execute entry actions, exit actions, and initial transitions.

Definition at line 92 of file qep_hsm.cpp.

◆ QF_pool_

QF_EPOOL_TYPE_ QF_pool_

allocate event pools

Definition at line 53 of file qf_dyn.cpp.

◆ QF_maxPool_

uint_fast8_t QF_maxPool_

of initialized event pools

Definition at line 54 of file qf_dyn.cpp.

◆ QF_subscrList_

QSubscrList * QF_subscrList_

the subscriber list array

Definition at line 56 of file qf_ps.cpp.

◆ QF_maxPubSignal_

enum_t QF_maxPubSignal_

the maximum published signal

Definition at line 57 of file qf_ps.cpp.

◆ QF_intNest

uint8_t volatile QF_intNest

Definition at line 53 of file qutest.cpp.

◆ QS_FRAME

uint8_t const QS_FRAME = static_cast<uint8_t>(0x7E)

Frame character of the QS output protocol.

Definition at line 79 of file qs_pkg.h.

◆ QS_ESC

uint8_t const QS_ESC = static_cast<uint8_t>(0x7D)

Escape character of the QS output protocol.

Definition at line 82 of file qs_pkg.h.

◆ QS_ESC_XOR

uint8_t const QS_ESC_XOR = static_cast<uint8_t>(0x20)

Escape modifier of the QS output protocol.

The escaped byte is XOR-ed with the escape modifier before it is inserted into the QS buffer.

Definition at line 88 of file qs_pkg.h.

◆ QS_GOOD_CHKSUM

uint8_t const QS_GOOD_CHKSUM = static_cast<uint8_t>(0xFF)

Escape character of the QS output protocol.

Definition at line 91 of file qs_pkg.h.

◆ QV_readySet_

QPSet QV_readySet_

ready set of AOs

Note
The functions implemented in this module can have a different implementation in other QF ports. The implementations included here are appropriate for the cooperative QV kernel only.

Definition at line 65 of file qv.cpp.