mirror of
https://github.com/QuantumLeaps/qpcpp.git
synced 2025-01-14 05:42:57 +08:00
127 lines
4.7 KiB
C++
127 lines
4.7 KiB
C++
/// @file
|
|
/// @brief QV/C++ platform-independent public interface.
|
|
/// @ingroup qv
|
|
/// @cond
|
|
///***************************************************************************
|
|
/// Last updated for version 5.8.1
|
|
/// Last updated on 2016-12-14
|
|
///
|
|
/// Q u a n t u m L e a P s
|
|
/// ---------------------------
|
|
/// innovating embedded systems
|
|
///
|
|
/// Copyright (C) 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:
|
|
/// https://state-machine.com
|
|
/// mailto:info@state-machine.com
|
|
///***************************************************************************
|
|
/// @endcond
|
|
|
|
#ifndef qv_h
|
|
#define qv_h
|
|
|
|
#include "qequeue.h" // QV kernel uses the native QF event queue
|
|
#include "qmpool.h" // QV kernel uses the native QF memory pool
|
|
#include "qpset.h" // QV kernel uses the native QF priority set
|
|
|
|
//****************************************************************************
|
|
// QF configuration for QK
|
|
|
|
//! This macro defines the type of the event queue used for 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 qv.h.
|
|
#define QF_EQUEUE_TYPE QEQueue
|
|
|
|
|
|
//****************************************************************************
|
|
namespace QP {
|
|
|
|
//! QV services.
|
|
/// @description
|
|
/// This class groups together QV services. It has only static members and
|
|
/// should not be instantiated.
|
|
///
|
|
// @note The QV ready set, etc. belong conceptually to the QV class (as static
|
|
/// class members). However, to avoid C++ potential name-mangling problems in
|
|
/// assembly language, these elements are defined outside of the QK class and
|
|
/// use the extern "C" linkage specification.
|
|
class QV {
|
|
public:
|
|
|
|
//! get the current QV version number string of the form X.Y.Z
|
|
static char_t const *getVersion(void) {
|
|
return versionStr;
|
|
}
|
|
|
|
//! QV idle callback (customized in BSPs for QK)
|
|
/// @description
|
|
/// QV::onIdle() must be called with interrupts DISABLED because
|
|
/// the determination of the idle condition (no events in the
|
|
/// queues) can change at any time by an interrupt posting events
|
|
/// to a queue. QV::onIdle() MUST enable interrupts internally,
|
|
/// perhaps at the same time as putting the CPU into a power-saving
|
|
/// mode.
|
|
///
|
|
/// @sa QP::QK::onIdle()
|
|
static void onIdle(void);
|
|
};
|
|
|
|
} // namespace QP
|
|
|
|
//****************************************************************************
|
|
extern "C" {
|
|
extern QP::QPSet QV_readySet_; //!< ready set of AOs
|
|
} // extern "C"
|
|
|
|
//****************************************************************************
|
|
// interface used only inside QF, but not in applications
|
|
|
|
#ifdef QP_IMPL
|
|
|
|
// QV-specific scheduler locking (not needed in QV)
|
|
#define QF_SCHED_STAT_
|
|
#define QF_SCHED_LOCK_(dummy) ((void)0)
|
|
#define QF_SCHED_UNLOCK_() ((void)0)
|
|
|
|
// QV-specific native event queue operations...
|
|
#define QACTIVE_EQUEUE_WAIT_(me_) \
|
|
Q_ASSERT_ID(110, (me_)->m_eQueue.m_frontEvt != static_cast<QEvt *>(0))
|
|
#define QACTIVE_EQUEUE_SIGNAL_(me_) \
|
|
(QV_readySet_.insert((me_)->m_prio))
|
|
|
|
// QV-specific native QF event pool operations...
|
|
#define QF_EPOOL_TYPE_ QMPool
|
|
#define QF_EPOOL_INIT_(p_, poolSto_, poolSize_, evtSize_) \
|
|
(p_).init((poolSto_), (poolSize_), (evtSize_))
|
|
#define QF_EPOOL_EVENT_SIZE_(p_) \
|
|
static_cast<uint_fast16_t>((p_).getBlockSize())
|
|
#define QF_EPOOL_GET_(p_, e_, m_) \
|
|
((e_) = static_cast<QEvt *>((p_).get((m_))))
|
|
#define QF_EPOOL_PUT_(p_, e_) ((p_).put(e_))
|
|
|
|
#endif // QP_IMPL
|
|
|
|
#endif // qv_h
|