qf_pkg.h

Go to the documentation of this file.

#ifndef qf_pkg_h
#define qf_pkg_h

/****************************************************************************/
/* QF-specific critical section */
#ifndef QF_CRIT_STAT_TYPE

    #define QF_CRIT_STAT_

    #define QF_CRIT_ENTRY_()    QF_CRIT_ENTRY(dummy)

    #define QF_CRIT_EXIT_()     QF_CRIT_EXIT(dummy)

#else
    #define QF_CRIT_STAT_       QF_CRIT_STAT_TYPE critStat_;
    #define QF_CRIT_ENTRY_()    QF_CRIT_ENTRY(critStat_)
    #define QF_CRIT_EXIT_()     QF_CRIT_EXIT(critStat_)
#endif

/****************************************************************************/
/* Assertions inside the crticial 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_EXIT_(); \
            Q_onAssert(&Q_this_module_[0], (int_t)(id_)); \
        } \
    } while (0)

    #define Q_REQUIRE_CRIT_(id_, test_) Q_ASSERT_CRIT_((id_), (test_))

    #define Q_ERROR_CRIT_(id_) do { \
        QF_CRIT_EXIT_(); \
        Q_onAssert(&Q_this_module_[0], (int_t)(id_)); \
    } while (0)

#endif /* Q_NASSERT */

/****************************************************************************/
/* internal implementation (should be used via vtbl only) */

void QActive_start_(QActive * const me, uint_fast8_t prio,
                    QEvt const *qSto[], uint_fast16_t qLen,
                    void *stkSto, uint_fast16_t stkSize,
                    QEvt const *ie);

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 flags and 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 ("static events").
*/
enum {
    TE_IS_LINKED    = (uint8_t)(1U << 7), /* flag  */
    TE_WAS_DISARMED = (uint8_t)(1U << 6), /* flag */
    TE_TICK_RATE    = (uint8_t)0x0F       /* bitmask */
};

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_REF_CTR_INC_(e_) (++((QEvt *)(e_))->refCtr_)

#define QF_EVT_REF_CTR_DEC_(e_) (--((QEvt *)(e_))->refCtr_)

#define QF_PTR_AT_(base_, i_)   ((base_)[(i_)])

#define QF_PTR_RANGE_(x_, min_, max_)  (((min_) <= (x_)) && ((x_) <= (max_)))

/****************************************************************************/
#ifdef Q_SPY  /* QS software tracing enabled? */

    #if (QF_EQUEUE_CTR_SIZE == 1)

        #define QS_EQC_(ctr_)       QS_u8_((uint8_t)(ctr_))
    #elif (QF_EQUEUE_CTR_SIZE == 2)
        #define QS_EQC_(ctr_)       QS_u16_((uint16_t)(ctr_))
    #elif (QF_EQUEUE_CTR_SIZE == 4)
        #define QS_EQC_(ctr_)       QS_u32_((uint32_t)(ctr_))
    #else
        #error "QF_EQUEUE_CTR_SIZE not defined"
    #endif


    #if (QF_EVENT_SIZ_SIZE == 1)

        #define QS_EVS_(size_)      QS_u8_((uint8_t)(size_))
    #elif (QF_EVENT_SIZ_SIZE == 2)
        #define QS_EVS_(size_)      QS_u16_((uint16_t)(size_))
    #elif (QF_EVENT_SIZ_SIZE == 4)
        #define QS_EVS_(size_)      QS_u32_((uint32_t)(size_))
    #endif


    #if (QF_MPOOL_SIZ_SIZE == 1)

        #define QS_MPS_(size_)      QS_u8_((uint8_t)(size_))
    #elif (QF_MPOOL_SIZ_SIZE == 2)
        #define QS_MPS_(size_)      QS_u16_((uint16_t)(size_))
    #elif (QF_MPOOL_SIZ_SIZE == 4)
        #define QS_MPS_(size_)      QS_u32_((uint32_t)(size_))
    #endif

    #if (QF_MPOOL_CTR_SIZE == 1)

        #define QS_MPC_(ctr_)       QS_u8_((uint8_t)(ctr_))
    #elif (QF_MPOOL_CTR_SIZE == 2)
        #define QS_MPC_(ctr_)       QS_u16_((uint16_t)(ctr_))
    #elif (QF_MPOOL_CTR_SIZE == 4)
        #define QS_MPC_(ctr_)       QS_u32_((uint16_t)(ctr_))
    #endif


    #if (QF_TIMEEVT_CTR_SIZE == 1)

        #define QS_TEC_(ctr_)       QS_u8_((uint8_t)(ctr_))
    #elif (QF_TIMEEVT_CTR_SIZE == 2)
        #define QS_TEC_(ctr_)       QS_u16_((uint16_t)(ctr_))
    #elif (QF_TIMEEVT_CTR_SIZE == 4)
        #define QS_TEC_(ctr_)       QS_u32_((uint32_t)(ctr_))
    #endif

#endif /* Q_SPY */

#endif /* qf_pkg_h */