qp_pkg.h

Go to the documentation of this file.

//============================================================================
// QP/C Real-Time Event Framework (RTEF)
//
// Copyright (C) 2005 Quantum Leaps, LLC. All rights reserved.
//
//                    Q u a n t u m  L e a P s
//                    ------------------------
//                    Modern Embedded Software
//
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-QL-commercial
//
// This software is dual-licensed under the terms of the open-source GNU
// General Public License (GPL) or under the terms of one of the closed-
// source Quantum Leaps commercial licenses.
//
// Redistributions in source code must retain this top-level comment block.
// Plagiarizing this software to sidestep the license obligations is illegal.
//
// NOTE:
// The GPL does NOT permit the incorporation of this code into proprietary
// programs. Please contact Quantum Leaps for commercial licensing options,
// which expressly supersede the GPL and are designed explicitly for
// closed-source distribution.
//
// Quantum Leaps contact information:
// <www.state-machine.com/licensing>
// <info@state-machine.com>
//============================================================================
#ifndef QP_PKG_H_
#define QP_PKG_H_
 
//============================================================================
// helper macros...
#define QACTIVE_CAST_(ptr_)            ((QActive *)(ptr_))
#define QP_DIS_UPDATE_(T_, org_)       ((T_)~(org_))
#define QP_DIS_VERIFY_(T_, org_, dis_) ((T_)(org_) == (T_)~(dis_))
 
//============================================================================
typedef struct {
#if (QF_MAX_EPOOL > 0U)
    QF_EPOOL_TYPE_ ePool_[QF_MAX_EPOOL]; //!< @private @memberof QF_Attr
    uint_fast8_t maxPool_;               //!< @private @memberof QF_Attr
#else
    uint8_t dummy;                       //!< @private @memberof QF_Attr
#endif //  (QF_MAX_EPOOL == 0U)
} QF_Attr;
 
extern QF_Attr QF_priv_; //!< @static @private @memberof QF
 
//! @static @private @memberof QF
void QF_bzero_(
    void * const start,
    uint_fast16_t const len);
 
//! @static @private @memberof QActive
extern QActive * QActive_registry_[QF_MAX_ACTIVE + 1U];
 
//============================================================================
//! @static @private @memberof QActive
extern QSubscrList * QActive_subscrList_;
 
//! @static @private @memberof QActive
extern QSignal QActive_maxPubSignal_;
 
//============================================================================
//! @static @private @memberof QTimeEvt
extern QTimeEvt QTimeEvt_timeEvtHead_[QF_MAX_TICK_RATE];
 
//============================================================================
// Bitmasks are for the QTimeEvt::flags attribute
#define QTE_FLAG_IS_LINKED      (1U << 7U)
#define QTE_FLAG_WAS_DISARMED   (1U << 6U)
 
//============================================================================
//! @private @memberof QEvt
static inline void QEvt_refCtr_inc_(QEvt const * const me) {
    // NOTE: this function must be called inside a critical section
    uint8_t const rc = me->refCtr_ + 1U;
    ((QEvt *)me)->refCtr_ = rc; // cast away 'const'
}
 
//! @private @memberof QEvt
static inline void QEvt_refCtr_dec_(QEvt const * const me) {
    // NOTE: this function must be called inside a critical section
    uint8_t const rc = me->refCtr_ - 1U;
    ((QEvt *)me)->refCtr_ = rc; // cast away 'const'
}
 
#endif // QP_PKG_H_