mirror of
https://github.com/QuantumLeaps/qpcpp.git
synced 2025-01-28 06:02:56 +08:00
80d9bcd6fb
Added QP Functional Safety (FuSa) Subsystem Memory Isolation with MPU Added QAsm abstract state machine base class Added memory marker to QEvt and rearranged memory layout Updated: QP-FreeRTOS, QP-ESP-IDF,QP-Zephyr Added drift-free ticking for QP-POSIX Reorganized documentation Updated 3rd_party
252 lines
9.4 KiB
C++
252 lines
9.4 KiB
C++
//$file${include::qpcpp.hpp} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
|
|
//
|
|
// Model: qpcpp.qm
|
|
// File: ${include::qpcpp.hpp}
|
|
//
|
|
// This code has been generated by QM 5.3.0 <www.state-machine.com/qm>.
|
|
// DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
|
|
//
|
|
// This code is covered by the following QP license:
|
|
// License # : LicenseRef-QL-dual
|
|
// Issued to : Any user of the QP/C++ real-time embedded framework
|
|
// Framework(s) : qpcpp
|
|
// Support ends : 2024-12-31
|
|
// License scope:
|
|
//
|
|
// Copyright (C) 2005 Quantum Leaps, LLC <state-machine.com>.
|
|
//
|
|
// Q u a n t u m L e a P s
|
|
// ------------------------
|
|
// Modern Embedded Software
|
|
//
|
|
// 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/licensing>
|
|
// <info@state-machine.com>
|
|
//
|
|
//$endhead${include::qpcpp.hpp} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
#ifndef QPCPP_HPP_
|
|
#define QPCPP_HPP_
|
|
|
|
//============================================================================
|
|
#include "qp_port.hpp" // QP port from the port directory
|
|
#include "qsafe.h" // QP Functional Safety (FuSa) Subsystem
|
|
#ifdef Q_SPY // software tracing enabled?
|
|
#include "qs_port.hpp" // QS/C++ port from the port directory
|
|
#else
|
|
#include "qs_dummy.hpp" // QS/C++ dummy (inactive) interface
|
|
#endif
|
|
|
|
//============================================================================
|
|
#ifndef QP_API_VERSION
|
|
|
|
#define QP_API_VERSION 0
|
|
|
|
#endif // QP_API_VERSION
|
|
|
|
//============================================================================
|
|
// QP/C++ API compatibility layer...
|
|
|
|
#if (QP_API_VERSION < 730)
|
|
|
|
//! @deprecated plain 'char' is no longer forbidden in MISRA/AUTOSAR-C++
|
|
using char_t = char;
|
|
|
|
//! @deprecated assertion failure handler
|
|
//! Use Q_onError() instead.
|
|
#define Q_onAssert(module_, id_) Q_onError(module_, id_)
|
|
|
|
//! @deprecated #Q_NASSERT preprocessor switch to disable QP assertions
|
|
#ifdef Q_NASSERT
|
|
|
|
// #Q_UNSAFE now replaces the functionality of Q_NASSERT
|
|
#define Q_UNSAFE
|
|
|
|
//! @deprecated general purpose assertion with user-specified ID
|
|
//! number that **always** evaluates the `expr_` expression.
|
|
#define Q_ALLEGE_ID(id_, expr_) ((void)(expr_))
|
|
|
|
#else // QP FuSa Subsystem enabled
|
|
|
|
//! @deprecated general purpose assertion with user-specified ID
|
|
//! number that **always** evaluates the `expr_` expression.
|
|
//! @note
|
|
//! The use of this macro is no longer recommended.
|
|
#define Q_ALLEGE_ID(id_, expr_) if (!(expr_)) { \
|
|
QF_CRIT_STAT \
|
|
QF_CRIT_ENTRY(); \
|
|
Q_onError(&Q_this_module_[0], (id_)); \
|
|
QF_CRIT_EXIT(); \
|
|
} else ((void)0)
|
|
|
|
#endif
|
|
|
|
//! @deprecated general purpose assertion without ID number
|
|
//! that **always** evaluates the `expr_` expression.
|
|
//! Instead of ID number, this macro is based on the standard
|
|
//! `__LINE__` macro.
|
|
//!
|
|
//! @note The use of this macro is no longer recommended.
|
|
#define Q_ALLEGE(expr_) Q_ALLEGE_ID(__LINE__, (expr_))
|
|
|
|
//! Static (compile-time) assertion.
|
|
//!
|
|
//! @deprecated
|
|
//! Use Q_ASSERT_STATIC() or better yet `static_assert()` instead.
|
|
//!
|
|
#define Q_ASSERT_COMPILE(expr_) Q_ASSERT_STATIC(expr_)
|
|
|
|
//! @deprecated use QP::QF::NO_MARGIN instead
|
|
#define QF_NO_MARGIN QP::QF::NO_MARGIN
|
|
|
|
//============================================================================
|
|
#if (QP_API_VERSION < 691)
|
|
|
|
//! @deprecated enable the QS global filter
|
|
#define QS_FILTER_ON(rec_) QS_GLB_FILTER((rec_))
|
|
|
|
//! @deprecated disable the QS global filter
|
|
#define QS_FILTER_OFF(rec_) QS_GLB_FILTER(-(rec_))
|
|
|
|
//! @deprecated enable the QS local filter for SM (state machine) object
|
|
#define QS_FILTER_SM_OBJ(obj_) (static_cast<void>(0))
|
|
|
|
//! @deprecated enable the QS local filter for AO (active objects)
|
|
#define QS_FILTER_AO_OBJ(obj_) (static_cast<void>(0))
|
|
|
|
//! @deprecated enable the QS local filter for MP (memory pool) object
|
|
#define QS_FILTER_MP_OBJ(obj_) (static_cast<void>(0))
|
|
|
|
//! @deprecated enable the QS local filter for EQ (event queue) object
|
|
#define QS_FILTER_EQ_OBJ(obj_) (static_cast<void>(0))
|
|
|
|
//! @deprecated enable the QS local filter for TE (time event) object
|
|
#define QS_FILTER_TE_OBJ(obj_) (static_cast<void>(0))
|
|
|
|
#ifdef Q_SPY
|
|
|
|
//! @deprecated local Filter for a generic application object `obj_`.
|
|
#define QS_FILTER_AP_OBJ(obj_) \
|
|
(QP::QS::filt_.loc_AP = (obj_))
|
|
|
|
//! @deprecated begin of a user QS record, instead use QS_BEGIN_ID()
|
|
#define QS_BEGIN(rec_, obj_) \
|
|
if (QS_GLB_FILTER_(rec_) && \
|
|
((QP::QS::filt_.loc[QP::QS::AP_OBJ] == nullptr) \
|
|
|| (QP::QS::filt_.loc_AP == (obj_)))) \
|
|
{ \
|
|
QS_CRIT_STAT \
|
|
QS_CRIT_ENTRY(); \
|
|
QP::QS::beginRec_(static_cast<std::uint_fast8_t>(rec_)); \
|
|
QS_TIME_PRE_();
|
|
|
|
//! @deprecated output hex-formatted std::uint32_t to the QS record
|
|
#define QS_U32_HEX(width_, data_) \
|
|
(QP::QS::u32_fmt_(static_cast<std::uint8_t>( \
|
|
(static_cast<std::uint8_t>((width_) << 4)) | QS_HEX_FMT), (data_)))
|
|
|
|
#else
|
|
|
|
#define QS_FILTER_AP_OBJ(obj_) (static_cast<void>(0))
|
|
#define QS_BEGIN(rec_, obj_) if (false) {
|
|
#define QS_U32_HEX(width_, data_) (Q_UNUSED_PAR(0))
|
|
|
|
#endif // def Q_SPY
|
|
|
|
//============================================================================
|
|
#if (QP_API_VERSION < 680)
|
|
|
|
//! @deprecated
|
|
//! Macro to specify a tran. in the "me->" impl-strategy.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! you call tran(Q_STATE_CAST(target_)).
|
|
#define Q_TRAN(target_) (me->tran(Q_STATE_CAST(target_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to specify a tran-to-history in the "me->" impl-strategy.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! you call tran_hist(Q_STATE_CAST(hist_)).
|
|
#define Q_TRAN_HIST(hist_) (me->tran_hist((hist_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to specify the superstate in the "me->" impl-strategy.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! you call super(state_)).
|
|
#define Q_SUPER(state_) (me->super(Q_STATE_CAST(state_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to call in a QM state entry-handler. Applicable only to QMSMs.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_entry(Q_STATE_CAST(state_)).
|
|
#define QM_ENTRY(state_) (me->qm_entry((state_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to call in a QM state exit-handler. Applicable only to QMSMs.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_exit(Q_STATE_CAST(state_)).
|
|
#define QM_EXIT(state_) (me->qm_exit((state_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to call in a QM submachine exit-handler. Applicable only to QMSMs.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_sm_exit(Q_STATE_CAST(state_)).
|
|
#define QM_SM_EXIT(state_) (me->qm_sm_exit((state_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to call in a QM state-handler when it executes a tran.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_tran((tatbl_)).
|
|
#define QM_TRAN(tatbl_) (me->qm_tran((tatbl_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to call in a QM state-handler when it executes an initial tran.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_tran_init((tatbl_)).
|
|
#define QM_TRAN_INIT(tatbl_) (me->qm_tran_init((tatbl_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to call in a QM state-handler when it executes a tran-to-history.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_tran_hist((history_), (tatbl_)).
|
|
#define QM_TRAN_HIST(history_, tatbl_) \
|
|
(me->qm_tran_hist((history_), (tatbl_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to call in a QM state-handler when it executes an initial tran.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_tran_ep((tatbl_)).
|
|
#define QM_TRAN_EP(tatbl_) (me->qm_tran_ep((tatbl_)))
|
|
|
|
//! @deprecated
|
|
//! Macro to call in a QM state-handler when it executes a tran-to-exit-point.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_tran_xp((xp_), (tatbl_)).
|
|
#define QM_TRAN_XP(xp_, tatbl_) (me->qm_tran_xp((xp_), (tatbl_)))
|
|
|
|
//! @deprecated
|
|
//! Designates the superstate of a given state in a subclass of QP::QMsm.
|
|
//! Instead use the new impl-strategy without the "me->" pointer, where
|
|
//! the QM-generated code calls qm_super_sub((state_)).
|
|
#define QM_SUPER_SUB(state_) (me->qm_super_sub((state_)))
|
|
|
|
#endif // QP_API_VERSION < 680
|
|
#endif // QP_API_VERSION < 691
|
|
#endif // QP_API_VERSION < 700
|
|
|
|
#endif // QPCPP_HPP_
|