qf_pkg.h

Go to the documentation of this file.

/*============================================================================
*
*                    Q u a n t u m  L e a P s
*                    ------------------------
*                    Modern Embedded Software
*
* Copyright (C) 2005 Quantum Leaps, LLC. All rights reserved.
*
* SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-QL-commercial
*
* This software is dual-licensed under the terms of open-source GPL 3.0
* (or any later version), or alternatively, under the terms of one of the
* closed-source Quantum Leaps commercial licenses.
*
* The terms of the open source GPL 3.0 license can be found at:
* <www.gnu.org/licenses/gpl-3.0.txt>
*
* The terms of the closed-source Quantum Leaps commercial licenses
* can be found at:
* <www.state-machine.com/licensing>
*
* NOTE: Please do NOT plagiarize this software to sidestep the license
* obligations. This is both unfair and illegal.
*
* Contact information:
* <www.state-machine.com>
* <info@state-machine.com>
============================================================================*/
#ifndef QF_PKG_H
#define QF_PKG_H
 
/*==========================================================================*/
 
/* QF-specific critical section */
#ifndef QF_CRIT_STAT_TYPE
    #define QF_CRIT_STAT_
 
    #define QF_CRIT_E_()     QF_CRIT_ENTRY(dummy)
 
    #define QF_CRIT_X_()     QF_CRIT_EXIT(dummy)
 
#elif (!defined QF_CRIT_STAT_)
    #define QF_CRIT_STAT_    QF_CRIT_STAT_TYPE critStat_;
    #define QF_CRIT_E_()     QF_CRIT_ENTRY(critStat_)
    #define QF_CRIT_X_()     QF_CRIT_EXIT(critStat_)
#endif
 
/*==========================================================================*/
 
/* Assertions inside the critical section */
#ifdef Q_NASSERT /* Q_NASSERT defined--assertion checking disabled */
 
    #define Q_ASSERT_CRIT_(id_, test_)  ((void)0)
    #define Q_REQUIRE_CRIT_(id_, test_) ((void)0)
    #define Q_ERROR_CRIT_(id_)          ((void)0)
 
#else  /* Q_NASSERT not defined--assertion checking enabled */
 
    #define Q_ASSERT_CRIT_(id_, test_) do {               \
        if ((test_)) {} else {                            \
            QF_CRIT_X_();                                 \
            Q_onAssert(&Q_this_module_[0], (int_t)(id_)); \
        }                                                 \
    } while (false)
 
    #define Q_REQUIRE_CRIT_(id_, test_) Q_ASSERT_CRIT_((id_), (test_))
 
    #define Q_ERROR_CRIT_(id_) do {                       \
        QF_CRIT_X_();                                     \
        Q_onAssert(&Q_this_module_[0], (int_t)(id_));     \
    } while (false)
 
#endif /* Q_NASSERT */
 
/*==========================================================================*/
 
/* internal prototypes (should be used via vtable only) */
 
void QActive_start_(QActive * const me, uint_fast8_t prio,
                    QEvt const * * const qSto, uint_fast16_t const qLen,
                    void * const stkSto, uint_fast16_t const stkSize,
                    void const * const par);
 
QEvt const *QActive_get_(QActive *const me);
 
#ifdef Q_SPY
    bool QActive_post_(QActive * const me, QEvt const * const e,
                       uint_fast16_t const margin,
                       void const * const sender);
#else
    bool QActive_post_(QActive * const me, QEvt const * const e,
                       uint_fast16_t const margin);
#endif
 
void QActive_postLIFO_(QActive * const me, QEvt const * const e);
 
/*==========================================================================*/
 
extern QTimeEvt QF_timeEvtHead_[QF_MAX_TICK_RATE];
 
/* The following bitmasks are for the fields of the @c refCtr_ attribute
* of the QTimeEvt struct (inherited from QEvt). This attribute is NOT used
* for reference counting in time events, because the @c poolId_ attribute
* is zero ("immutable events").
*/
#define QTE_IS_LINKED      (1U << 7U)
#define QTE_WAS_DISARMED   (1U << 6U)
#define QTE_TICK_RATE      0x0FU
 
extern QF_EPOOL_TYPE_ QF_pool_[QF_MAX_EPOOL]; 
extern uint_fast8_t QF_maxPool_;     
extern QSubscrList *QF_subscrList_;  
extern enum_t QF_maxPubSignal_;      
typedef struct QFreeBlock {
    struct QFreeBlock * volatile next;
} QFreeBlock;
 
/* internal helper macros ***************************************************/
 
#define QF_EVT_CONST_CAST_(e_)  ((QEvt *)(e_))
 
#define QF_EVT_REF_CTR_INC_(e_) (++QF_EVT_CONST_CAST_(e_)->refCtr_)
 
#define QF_EVT_REF_CTR_DEC_(e_) (--QF_EVT_CONST_CAST_(e_)->refCtr_)
 
#define QF_PTR_AT_(base_, i_)   ((base_)[(i_)])
 
#define QF_PTR_RANGE_(x_, min_, max_)  (((min_) <= (x_)) && ((x_) <= (max_)))
 
#endif /* QF_PKG_H */