qpcpp/ports/embos/qf_port.hpp
2022-10-26 19:47:39 -04:00

118 lines
4.0 KiB
C++

//============================================================================
// QP/C++ Real-Time Embedded Framework (RTEF)
// 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 the open source GNU
// General Public License version 3 (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 GNU General Public License version 3
// can be found at: <www.gnu.org/licenses/gpl-3.0>
//
// The terms of the closed source Quantum Leaps commercial licenses
// can be found at: <www.state-machine.com/licensing>
//
// Redistributions in source code must retain this top-level comment block.
// Plagiarizing this software to sidestep the license obligations is illegal.
//
// Contact information:
// <www.state-machine.com>
// <info@state-machine.com>
//============================================================================
//! @date Last updated on: 2022-06-30
//! @version Last updated for: @ref qpcpp_7_0_1
//!
//! @file
//! @brief QF/C++ port to embOS kernel, all supported compilers
#ifndef QF_PORT_HPP
#define QF_PORT_HPP
// message mailbox and thread types for embOS
#define QF_EQUEUE_TYPE OS_MAILBOX
#define QF_THREAD_TYPE OS_TASK
#define QF_OS_OBJECT_TYPE std::uint32_t
// The maximum number of active objects in the application, see NOTE1
#define QF_MAX_ACTIVE 32U
// QF interrupt disable/enable
#define QF_INT_DISABLE() OS_IncDI()
#define QF_INT_ENABLE() OS_DecRI()
// QF critical section for embOS, see NOTE2
//#define QF_CRIT_STAT_TYPE not defined
#define QF_CRIT_ENTRY(dummy) QF_INT_DISABLE()
#define QF_CRIT_EXIT(dummy) QF_INT_ENABLE()
namespace QP {
// thread attributes...
enum EmbOS_TaskAttrs {
TASK_NAME_ATTR,
TASK_USES_FPU
};
} // namespace QP
#include "RTOS.h" // embOS API
#include "qep_port.hpp" // QEP port
#include "qequeue.hpp" // used for event deferral
#include "qmpool.hpp" // this QP port uses the native QF memory pool
#include "qf.hpp" // QF platform-independent public interface
//============================================================================
// interface used only inside QF, but not in applications
//
#ifdef QP_IMPL
// embOS-specific scheduler locking, see NOTE3
#define QF_SCHED_STAT_
#define QF_SCHED_LOCK_(dummy) do { \
if (OS_InInterrupt() == static_cast<OS_BOOL>(0)) { \
OS_EnterRegion(); \
} \
} while (false)
#define QF_SCHED_UNLOCK_() do { \
if (OS_InInterrupt() == static_cast<OS_BOOL>(0)) { \
OS_LeaveRegion(); \
} \
} while (false)
// 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_) ((p_).getBlockSize())
#define QF_EPOOL_GET_(p_, e_, m_, qs_id_) \
((e_) = static_cast<QEvt *>((p_).get((m_), (qs_id_))))
#define QF_EPOOL_PUT_(p_, e_, qs_id_) ((p_).put((e_), (qs_id_)))
#endif // ifdef QP_IMPL
//============================================================================
// NOTE1:
// The maximum number of active objects in QP can be increased to 63,
// inclusive, but it can be reduced to save some memory. Also, the number of
// active objects cannot exceed the number of embOS thread priorities,
// because each QP active object requires a unique priority level.
//
// NOTE2:
// The embOS critical section does not use the status variable, because the
// implementation uses a global up-down counter, which allows the embOS
// critical section to nest. Nesting of critical sections is needed in this
// QP-embOS port.
//
// NOTE3:
// embOS provides only global scheduler locking for all thread priorities
// by means of OS_EnterRegion() and OS_LeaveRegion(). Therefore, locking the
// scheduler only up to the specified lock priority is not supported.
//
#endif // QF_PORT_HPP