qpc/include/qvanilla.h

/*****************************************************************************
* Product: QP/C
* Last Updated for Version: 5.2.0
* Date of the Last Update:  Dec 02, 2013
*
*                    Q u a n t u m     L e a P s
*                    ---------------------------
*                    innovating embedded systems
*
* Copyright (C) 2002-2013 Quantum Leaps, LLC. All rights reserved.
*
* This program is open source software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alternatively, this program may be distributed and modified under the
* terms of Quantum Leaps commercial licenses, which expressly supersede
* the GNU General Public License and are specifically designed for
* licensees interested in retaining the proprietary status of their code.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Contact information:
* Quantum Leaps Web sites: http://www.quantum-leaps.com
*                          http://www.state-machine.com
* e-mail:                  info@quantum-leaps.com
*****************************************************************************/
#ifndef qvanilla_h
#define qvanilla_h

/**
* \file
* \ingroup qf
* \brief platform-independent interface to the cooperative "vanilla" kernel.
*/

#include "qequeue.h"    /* "Vanilla" kernel uses the native QF event queue  */
#include "qmpool.h"     /* "Vanilla" kernel uses the native QF memory pool  */
#include "qpset.h"      /* "Vanilla" kernel uses the native QF priority set */

/** \brief This macro defines the type of the event queue used for the
* active objects.
*
* \note This is just an example of the macro definition. Typically, you need
* to define it in the specific QF port file (qf_port.h). In case of QK, which
* always depends on the native QF queue, this macro is defined at the level
* of the platform-independent interface qk.h.
*/
#define QF_EQUEUE_TYPE  QEQueue

/*****************************************************************************
* interface used only inside QF, but not in applications
*/
#ifdef qf_pkg_h
                                        /* native QF event queue operations */
    #define QACTIVE_EQUEUE_WAIT_(me_) \
        Q_ASSERT((me_)->eQueue.frontEvt != (QEvt *)0)

    #if (QF_MAX_ACTIVE <= 8)
        #define QACTIVE_EQUEUE_SIGNAL_(me_) \
            QPSet8_insert(&QF_readySet_, (me_)->prio)
        #define QACTIVE_EQUEUE_ONEMPTY_(me_) \
            QPSet8_remove(&QF_readySet_, (me_)->prio)
    #else
        #define QACTIVE_EQUEUE_SIGNAL_(me_) \
            QPSet64_insert(&QF_readySet_, (me_)->prio)
        #define QACTIVE_EQUEUE_ONEMPTY_(me_) \
            QPSet64_remove(&QF_readySet_, (me_)->prio)
    #endif
                                         /* native QF event pool operations */
    #define QF_EPOOL_TYPE_            QMPool
    #define QF_EPOOL_INIT_(p_, poolSto_, poolSize_, evtSize_) \
        (QMPool_init(&(p_), (poolSto_), (poolSize_), (evtSize_)))
    #define QF_EPOOL_EVENT_SIZE_(p_)  ((uint_t)(p_).blockSize)
    #define QF_EPOOL_GET_(p_, e_, m_) ((e_) = (QEvt *)QMPool_get(&(p_), (m_)))
    #define QF_EPOOL_PUT_(p_, e_)     (QMPool_put(&(p_), (e_)))

    #if (QF_MAX_ACTIVE <= 8)
        extern QPSet8 QF_readySet_;                /**< QF-ready set of AOs */
    #else
        extern QPSet64 QF_readySet_;               /**< QF-ready set of AOs */
    #endif

#endif                                                    /* ifdef qf_pkg_h */

#endif                                                        /* qvanilla_h */