8.0.5

Author: quantum-leaps

3rd_party

@@ -0,0 +1,26 @@
+QP/C Real-Time Event Framework (RTEF)
+
+Copyright (C) 2005-2025 Quantum Leaps, LLC. All rights reserved.
+
+                   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 (GPLv3) or under the terms of one of the closed-
+source Quantum Leaps commercial licenses.
+
+Redistributions in source code must retain this top-level comment block.
+Plagiarizing this software to sidestep the license obligations is illegal.
+
+NOTE:
+The GPL does NOT permit the incorporation of this code into proprietary
+programs. Please contact Quantum Leaps for commercial licensing options,
+which expressly supersede the GPL and are designed explicitly for
+closed-source distribution.
+
+Quantum Leaps contact information:
+<www.state-machine.com/licensing>
+<[email protected]>

LICENSE

@@ -30,10 +30,10 @@
 #define QP_H_
 
 //============================================================================
-#define QP_VERSION_STR "8.0.4"
-#define QP_VERSION     804U
-// <VER>=804 <DATE>=250611
-#define QP_RELEASE     0x6A9FC8ABU
+#define QP_VERSION_STR "8.0.5"
+#define QP_VERSION     805U
+// <VER>=805 <DATE>=250811
+#define QP_RELEASE     0x6A81442A
 
 //============================================================================
 // default configuration settings
@@ -182,28 +182,25 @@ typedef struct {
     union QAsmAttr temp;            //!< @protected @memberof QAsm
 } QAsm;
 
-// All possible values returned from state/action handlers
+// All possible values returned from state/action handlers...
 // NOTE: The ordering is important for algorithmic correctness.
+
+// unhandled and needs to "bubble up"
 #define Q_RET_SUPER     ((QState)0U)
 #define Q_RET_UNHANDLED ((QState)1U)
 
-// handled and do not need to "bubble up"
+// handled and does not need to "bubble up"
 #define Q_RET_HANDLED   ((QState)2U)
 #define Q_RET_IGNORED   ((QState)3U)
 
-// entry/exit
+// entry/exit/initial
 #define Q_RET_ENTRY     ((QState)4U)
 #define Q_RET_EXIT      ((QState)5U)
+#define Q_RET_TRAN_INIT ((QState)6U)
 
-// no side effects
-#define Q_RET_NULL      ((QState)6U)
-
-// transitions need to execute transition-action table in ::QMsm
+// regular tran./tran.-to-history
 #define Q_RET_TRAN      ((QState)7U)
-#define Q_RET_TRAN_INIT ((QState)8U)
-
-// transitions that additionally clobber me->state
-#define Q_RET_TRAN_HIST ((QState)9U)
+#define Q_RET_TRAN_HIST ((QState)8U)
 
 // Reserved signals by the QP-framework.
 #define Q_EMPTY_SIG     ((QSignal)0U)

examples

@@ -39,7 +39,7 @@
 typedef struct {
 #if (QF_MAX_EPOOL > 0U)
     QF_EPOOL_TYPE_ ePool_[QF_MAX_EPOOL]; //!< @private @memberof QF_Attr
-    uint_fast8_t maxPool_;               //!< @private @memberof QF_Attr
+    uint8_t maxPool_;                    //!< @private @memberof QF_Attr
 #else
     uint8_t dummy;                       //!< @private @memberof QF_Attr
 #endif //  (QF_MAX_EPOOL == 0U)

include/qp.h

@@ -69,7 +69,7 @@ static void task_function(void *pvParameters); // FreeRTOS task signature
 // xQUEUE.uxLength          == StaticQueue_t.uxDummy4[1];
 //
 #define FREERTOS_QUEUE_GET_FREE(me_) \
-    ((me_)->osObject.uxDummy4[1] - (me_)->osObject.uxDummy4[0])
+    ((me_)->osObject.queue.uxDummy4[1] - (me_)->osObject.queue.uxDummy4[0])
 
 //============================================================================
 void QF_init(void) {
@@ -150,7 +150,7 @@ void QActive_start(QActive * const me,
         (UBaseType_t)qLen,     // length of the queue
         (UBaseType_t)sizeof(QEvtPtr), // item size
         (uint8_t *)qSto,       // storage buffer
-        &me->osObject);        // static queue buffer
+        &me->osObject.queue);  // static queue buffer
     QF_CRIT_ENTRY();
     Q_ASSERT_INCRIT(110, me->eQueue != (QueueHandle_t)0);
     QF_CRIT_EXIT();
@@ -164,8 +164,8 @@ void QActive_start(QActive * const me,
     QS_FLUSH(); // flush the trace buffer to the host
 
     // task name provided by the user in QActive_setAttr() or default name
-    char const *taskName = (me->thread.pxDummy1 != (void *)0)
-                             ? (char const *)me->thread.pxDummy1
+    char const *taskName = (me->osObject.task.pxDummy1 != (void *)0)
+                             ? (char const *)me->osObject.task.pxDummy1
                              : (char const *)"AO";
 
     // The FreeRTOS priority of the AO thread can be specified in two ways:
@@ -193,17 +193,17 @@ void QActive_start(QActive * const me,
     }
 
     // statically create the FreeRTOS task for the AO
-    TaskHandle_t task = xTaskCreateStatic(
+    me->thread = xTaskCreateStatic(
         &task_function, // the task function
         taskName ,      // the name of the task
         stkSize/sizeof(portSTACK_TYPE), // stack length
         (void *)me,     // the 'pvParameters' parameter
         freertos_prio,  // FreeRTOS priority
-        (StackType_t *)stkSto,        // stack storage
-        &me->thread);   // task buffer
+        (StackType_t *)stkSto, // stack storage
+        &me->osObject.task);   // task buffer
 
     QF_CRIT_ENTRY();
-    Q_ASSERT_INCRIT(120, task != (TaskHandle_t)0);
+    Q_ASSERT_INCRIT(120, me->thread != (TaskHandle_t)0);
     QF_CRIT_EXIT();
 
 #ifdef Q_UNSAFE
@@ -223,11 +223,11 @@ void QActive_setAttr(QActive *const me, uint32_t attr1, void const *attr2) {
     QF_CRIT_ENTRY();
     // this function must be called before QActive_start(),
     // which implies that me->thread.pxDummy1 must not be used yet;
-    Q_REQUIRE_INCRIT(150, me->thread.pxDummy1 == (void *)0);
+    Q_REQUIRE_INCRIT(150, me->osObject.task.pxDummy1 == (void *)0);
     switch (attr1) {
         case TASK_NAME_ATTR:
             // temporarily store the name, cast 'const' away
-            me->thread.pxDummy1 = (void *)attr2;
+            me->osObject.task.pxDummy1 = (void *)attr2;
             break;
         // ...
         default:

include/qp_pkg.h

@@ -38,8 +38,8 @@
 
 // QActive event queue and thread types for FreeRTOS
 #define QACTIVE_EQUEUE_TYPE     QueueHandle_t
-#define QACTIVE_OS_OBJ_TYPE     StaticQueue_t
-#define QACTIVE_THREAD_TYPE     StaticTask_t
+#define QACTIVE_OS_OBJ_TYPE     OsObject
+#define QACTIVE_THREAD_TYPE     TaskHandle_t
 
 // FreeRTOS requires the "FromISR" API in QP/C
 #define QF_ISR_API              1
@@ -59,6 +59,11 @@
 #include "task.h"      // FreeRTOS task management
 #include "queue.h"     // FreeRTOS queue management
 
+typedef struct {
+    StaticQueue_t queue;
+    StaticTask_t  task;
+} OsObject;
+
 #include "qequeue.h"   // QP event queue (for deferring events)
 #include "qmpool.h"    // QP memory pool (for event pools)
 #include "qp.h"        // QP platform-independent public interface

ports/freertos/qf_port.c

@@ -1,25 +1,25 @@
 8cc1cf50aef9624decf8cd1545e9734b5c1d8191 *include/qequeue.h
 3559dc235f4fe3f16015a26dbdcced1dba7beebc *include/qk.h
 5fa3ee98371fd6d0c3aad09a9b121a3063143a65 *include/qmpool.h
-5e47d0bcfc90220162ab31c9d4732f0a9bc049cd *include/qp.h
-f7e678241666f5dd4533e2af3a217baea1a3a519 *include/qp_pkg.h
+7abdb18b633f14df58f0f2f7a4716d1d0a4e9027 *include/qp.h
+86b509e3719a7867bbcaa62ff0cc3dee57ecf814 *include/qp_pkg.h
 5e8038024653d7355b6e6c01bde8f156ef675faf *include/qpc.h
-23ac6520b61a0b22f7d2976075bee495e3aacbf7 *include/qs.h
+d1667edfd10b01fe04d57aa1384107279ce27b7d *include/qs.h
 62ef68e67df263501a19f6154718218e74927d86 *include/qs_dummy.h
-480276a966e505867bbf0395fb5275ea52d6ab31 *include/qs_pkg.h
+ce8e07b7cdb8286fdd0d276bc609566d1f149772 *include/qs_pkg.h
 fa866cf8f14f6c481e9f64a1cf48bcdcf7e81240 *include/qsafe.h
 014aad797f8b633a2bc0e2e35efd5b3e3b2eb318 *include/qstamp.h
 a29f98c426a0e1526f39c370bffb905cf6556830 *include/qv.h
 c8442376dd70f1b3eff18eca46a5d3bc7d0f56a9 *include/qxk.h
 5886c3a0831996cfbf7141255efb4e9f5b4d8254 *include/README.md
 7f54a0933a9dc2fcaca475919fa0067667ed99ed *src/qf/CMakeLists.txt
-678157a9a16bd44a41e3719f83979d99920710a3 *src/qf/qep_hsm.c
-3b12b11cb25d5bf58fa7f52ddf50b940596c17cc *src/qf/qep_msm.c
+aeb22a94b9ad3e5958a474456f9760a205e463bb *src/qf/qep_hsm.c
+917a47a6575c7c8c2747f9c4acf2094112585f41 *src/qf/qep_msm.c
 2616fcd5f5abe8bc94ca3ec397d34c72de5fa4e9 *src/qf/qf_act.c
 92b829f22c7bda19f98ba7c7fbaf6a1431e5e8ce *src/qf/qf_actq.c
 1fa8ef33b4645f58d146c714389f60177b1d83bf *src/qf/qf_defer.c
-14a0ec10ec03d1188ff167aa07de7b7cd30f7582 *src/qf/qf_dyn.c
-e7f8b6282917decf07b96f0b6e41133c75aab8ae *src/qf/qf_mem.c
+d35d5f001e68d8f8dd63e9aa8c10d58272a674fc *src/qf/qf_dyn.c
+c70f2ef1c892f3fb2e9a6781a98cdf0c7e96e989 *src/qf/qf_mem.c
 16616f6f8e3ad03333ae37b8614eeb96274dd116 *src/qf/qf_ps.c
 16cf334c566b1653135ef881ec3a2817ef36560b *src/qf/qf_qact.c
 6fa6a664678d7bdf0f8d3df6184d79537e209177 *src/qf/qf_qeq.c
@@ -28,15 +28,15 @@ e7f8b6282917decf07b96f0b6e41133c75aab8ae *src/qf/qf_mem.c
 878a737efe234f40dc8c9374acc351e510b4da1e *src/qk/CMakeLists.txt
 9306097e83a7b09a23b7c9aa43db82f4fcc8dd7f *src/qk/qk.c
 68c99a2991d25df7486e57edadaa955b2bda396d *src/qs/CMakeLists.txt
-b2f1c531dae8c8e2854c3d56371683d5cce4ebe2 *src/qs/qs.c
+fb9f15f6e5c714d3bbb594c42b60ae7c2d25c7c4 *src/qs/qs.c
 fcf5873f819d8f05d12ea119de13a34f89aa78d8 *src/qs/qs_64bit.c
 0560472d61afcfaf166568350b2038d4a01152ad *src/qs/qs_fp.c
 f3e44eaa2c9c6f61410123b97950035907f80524 *src/qs/qs_rx.c
 8c73b815861bf560fdd0497c30924d31a2b2219f *src/qs/qstamp.c
 9f1b983e0b8802390cec04f02b06e01a92ca05d2 *src/qs/qutest.c
 b1d2def9b8f6cde464170af7682ab0f01f4f40f6 *src/qv/CMakeLists.txt
 8f2c260f9844d7462b64d8a2d271ff050b27c6fa *src/qv/qv.c
-e7d916f568277368855ee62e09781be0e0c2fbd1 *src/qxk/qxk.c
+df2ddd5f32b8d108b650dda6adb200c8dd38535d *src/qxk/qxk.c
 e4a82244233a24905c292c1a4760498dfa09f3ba *src/qxk/qxk_mutex.c
 e0c7eb35f685f1d456b570218580784d18722af6 *src/qxk/qxk_sema.c
 321fce23618670efcc8426d3a2ba0061c7c74f4e *src/qxk/qxk_xthr.c
@@ -99,8 +99,8 @@ dec344db269481b0244d9e2a845d9a4d86cf6c06 *ports/embos/qp_port.h
 4efebcfb83036649c8e7c6feb5a98cda01877ae9 *ports/embos/qs_port.h
 4e86718c62fd78bc866ffdf855aa1e5a186916b2 *ports/embos/syscalls.c
 e65838e1764bd6b4eb73025be1e8116ac28247b2 *ports/freertos/CMakeLists.txt
-9e32d26c78a4b9f7c64ae1dfe186cdda0ef7c99c *ports/freertos/qf_port.c
-a50faf80400e462acd61b4cca6955d62deb87502 *ports/freertos/qp_port.h
+0c3778f06097da4f0458b584c2fd2ec2232b760f *ports/freertos/qf_port.c
+b2d541fb7bb1721b7e1225862620e63680adf24a *ports/freertos/qp_port.h
 4efebcfb83036649c8e7c6feb5a98cda01877ae9 *ports/freertos/qs_port.h
 4e86718c62fd78bc866ffdf855aa1e5a186916b2 *ports/freertos/syscalls.c
 a01e1f6d49ce056ac4e130d54ae4724fda2ebf32 *ports/threadx/CMakeLists.txt
@@ -162,7 +162,7 @@ c3d90fffd08d165b106292f500f0af13b7fb2d8f *ports/win32-qutest/qutest_port.c
 848a30efa3274ff30fb72059f926fe7963ab2321 *zephyr/CMakeLists.txt
 10764710e545dd4d2ce0ddf032711df7f9191937 *zephyr/Kconfig
 2eb2a922e18b4760a68151ebee1b6282d20b4692 *zephyr/module.yml
-e52e0be250a968576aeba0b894f3af01b488b984 *zephyr/qf_port.c
+a3b6860c93400cd3a91cd68a29cbdafbe80c2af0 *zephyr/qf_port.c
 109c291df50110f185adc17bcdf8becc0a79346c *zephyr/qp-zephyr.jpg
 05c2b569d54153d4093171ad48755a4a83266598 *zephyr/qp_port.h
 4efebcfb83036649c8e7c6feb5a98cda01877ae9 *zephyr/qs_port.h

ports/freertos/qp_port.h

@@ -1,6 +1,6 @@
 @setlocal
 
-set VERSION=8.0.4
+set VERSION=8.0.5
 
 :: usage
 @echo Usage: qpc_sha1 [gen]

qpc_8.0.4.sha1 renamed to qpc_8.0.5.sha1

@@ -42,13 +42,18 @@ Q_DEFINE_THIS_MODULE("qep_hsm")
 // must be >= 3
 #define QHSM_MAX_NEST_DEPTH_  6
 
+//! @cond INTERNAL
+
+// immutable events corresponding to the reserved signals.
 static QEvt const l_reservedEvt_[4] = {
     QEVT_INITIALIZER(Q_EMPTY_SIG),
     QEVT_INITIALIZER(Q_ENTRY_SIG),
     QEVT_INITIALIZER(Q_EXIT_SIG),
     QEVT_INITIALIZER(Q_INIT_SIG)
 };
 
+//! @endcond
+
 //============================================================================
 //! @cond INTERNAL
 
@@ -310,14 +315,15 @@ void QHsm_dispatch_(
         QHsm_enter_target_(me, &path[0], ip, qsId);
         QS_TRAN_END_(QS_QEP_TRAN, s, path[0]);
     }
-#ifdef Q_SPY
     else if (r == Q_RET_HANDLED) {
         QS_TRAN0_(QS_QEP_INTERN_TRAN, s);
     }
-    else {
+    else if (r == Q_RET_IGNORED) {
         QS_TRAN0_(QS_QEP_IGNORED, me->state.fun);
     }
-#endif // Q_SPY
+    else {
+        Q_ERROR_LOCAL(360);
+    }
 
     me->state.fun = path[0]; // change the current active state
 #ifndef Q_UNSAFE