8.0.0

Author: quantum-leaps

.gitignore

@@ -37,17 +37,29 @@
 version-*
 JLink*.*
 
-cert/
+include/qs.h
+include/qs_pkg.h
+include/qxk.h
+src/qs/qs.c
+src/qs/qs_64bit.c
+src/qs/qs_fp.c
+src/qs/qs_rx.c
+src/qs/qutest.c
+src/qxk/qxk.c
+src/qxk/qxk_mutex.c
+src/qxk/qxk_sema.c
+src/qxk/qxk_xthr.c
+
+ports/posix-qutest/
+ports/win32-qutest/
+
+priv/
 html/
 latex/
-doxygen/gen/
-test_priv/
 dbg/
 rel/
 spy/
-build/
-build_rel/
-build_spy/
+build*/
 settings/
 .settings/
 targetConfigs/

3rd_party

@@ -3,8 +3,8 @@ Quantum Leaps Dual-Licensing:
 The QP/C Real-Time Embedded Framework is dually-licensed under
 the following two alternatives:
 
-1. Open source GNU General Public License (GPL)
-version 3, or alternatively,
+1. Open source GNU General Public License (GPL) version 3,
+   or alternatively,
 
 2. One of the closed source Quantum Leaps commercial licenses.
 

LICENSES/License.txt

@@ -1,30 +1,28 @@
-Any user of the QP/C real-time embedded framework
+public
 qpc
 2025-12-31
-
-Copyright (C) 2005 Quantum Leaps, LLC <state-machine.com>.
+Copyright (C) 2005 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 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>
+The QP/C software is dual-licensed under the terms of the open-source GNU
+General Public License (GPL) 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.
 
-Contact information:
+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]>
-#BC89496843DE5343CECA990E1370BDD6F9ACDC56
+#2BACD81DCE8ED122C193E4F48A14170D660DFF1E

LICENSES/LicenseRef-QL-dual.qlc

@@ -34,15 +34,15 @@ provides instructions on how to download, install, and get started with QP.
 - [AppNote: "Getting Started with QP Real-Time Embedded Frameworks"][AN]
 contains also a tutorial, in which you build a simple "Blinky" application.
 
-## Licensing
-The QP frameworks (QP/C and QP/C++) are licensed under the
+# Licensing
+The QP/C real-time embedded framework is licensed under the
 [dual licensing model](https://www.state-machine.com/licensing), with
 the following licensing options:
 
 1. [Open-source licensing](https://www.state-machine.com/licensing#Open) under the
 [GNU General Public License (GPLv3)](https://www.gnu.org/licenses/gpl-3.0.en.html).
 
-> NOTE: GPL requires that all modifications to the original code
+> NOTE: The GPL requires that all modifications to the original code
 as well as your application code (Derivative Works as defined in the
 Copyright Law) must also be released under the terms of the GPL
 open source license.
@@ -56,6 +56,19 @@ proprietary status of their code.
 all QP frameworks can be licensed commercially, in which case you don't use
 any open source license and you do not violate your policy.
 
+## Files Removed from the QP/C Open Source GPL Distribution
+Due to the widespread non-compliance with the GPL, as well as infringement on the
+[dual-licensing model of QP frameworks][Lic], the following QP/C components
+have been **removed from the open-source GPL distribution**:
+- QS target-resident software tracing component
+- QXK dual-mode kernel
+
+> NOTE: These components are available to the [commercial licensees][Cust] with
+the active Support Term. Please contact [Quantum Leaps technical support][Sup]
+to get the complete QP/C framework distribution.
+
+> NOTE: To request **evaluation** of the complete QP/C framework, please contact
+Quantum Leaps at: https://www.state-machine.com/contact
 
 # About QP/C
 QP/C (Quantum Platform in C) is a lightweight, open source
@@ -103,7 +116,7 @@ without any traditional RTOS. The framework contains a selection of
 the [preemptive non-blocking QK kernel][QK], and the preemptive,
 [dual-mode QXK kernel][QXK] that provides all the features you might expect
 from a traditional RTOS. Native QP ports and ready-to-use examples are provided
-for major CPUs, such as ARM Cortex-M (M0/M0+/M3/M4/M7/M23/M33/M85).
+for major CPUs, such as ARM Cortex-M (M0/M0+/M3/M4/M7/M23/M33/...).
 
 ## Traditional RTOS/OS
 QP/C can also work with a traditional RTOS, such as ThreadX, embOS, FreeRTOS,
@@ -138,12 +151,18 @@ in your web browser.
 # How to Help this Project?
 If you like this project, please give it a star (in the upper-right corner of your browser window):
 
-![GitHub star](https://www.state-machine.com/img/github-star.jpg)
+<p align="center">
+<img src="https://www.state-machine.com/img/github-star.jpg"/><br>
+</p>
 
    [RTEF]:   <https://www.state-machine.com/rtef>
    [QP]:     <https://www.state-machine.com/products/qp>
    [QP/C]:   <https://github.com/QuantumLeaps/qpc>
    [QP/C++]: <https://github.com/QuantumLeaps/qpcpp>
+   [QS/C]:   <https://www.state-machine.com/qpc/srs-qp_qs.html>
+   [QV]:     <https://www.state-machine.com/qpc/srs-qp_qv.html>
+   [QK]:     <https://www.state-machine.com/qpc/srs-qp_qk.html>
+   [QXK]:    <https://www.state-machine.com/qpc/srs-qp_qxk.html>
    [QM]:     <https://github.com/QuantumLeaps/qm>
    [QTools]: <https://github.com/QuantumLeaps/qtools>
    [QP-Rel]: <https://github.com/QuantumLeaps/qpc/releases>
@@ -153,6 +172,7 @@ If you like this project, please give it a star (in the upper-right corner of yo
    [HSM]:    <https://www.state-machine.com/qpc/srs-qp_sm.html>
    [Lic]:    <https://www.state-machine.com/licensing>
    [Cust]:   <https://www.state-machine.com/customers>
+   [Sup]:    <mailto:[email protected]>
    [AN]:     <https://www.state-machine.com/doc/AN_Getting_Started_with_QP.pdf>
    [Tutorial]: <https://www.state-machine.com/qpc/gs_tut.html>
    [Video]:  <https://youtu.be/O7ER6_VqIH0>

README.md

@@ -38,6 +38,10 @@ set(QPC_PROJECT qpcPrj)
 set(QPC_CFG_KERNEL QV)
 set(QPC_CFG_GUI TRUE)
 set(QPC_CFG_PORT win32)
+# QP/C 8.0.0: to include a local 'qp_config.h' add the related include path
+# to the qpc build settings. Replace "${CMAKE_CURRENT_LIST_DIR}/include" by
+# your project specific path!
+set(QPC_CFG_QPCONFIG_H_INCLUDE_PATH ${CMAKE_CURRENT_LIST_DIR}/include)
 qpc_sdk_init()
 
 target_link_libraries(qpcApp PRIVATE qpc)
@@ -78,6 +82,8 @@ This file is situated in the root directory of qpc. It performs a pre-initializa
 * `QPC-CFG-GUI` - BOOL: set this boolean variable to ON/TRUE, if GUI support (win32) shall be compiled in. Default: OFF
 * `QPC_CFG_UNIT_TEST` - BOOL: set this to ON/TRUE to support qutest, if build configuration `Spy` is active. Default: OFF
 * `QPC_CFG_VERBOSE` - BOOL: set this to enable more verbosity in message output. Default: OFF
+* `QPC_CFG_QPCONFIG_H_INCLUDE_PATH`: - STRING (PATH): (`QP/C 8.0.0`) set this to have the build of QP/C use your project specific `qp_config.h`.
+  Default: `${QPC_SDK_PATH}/ports/config`
 
 ### General usage hints
 1. Set `QPC_SDK_PATH` or `QPC_FETCH_FROM_GIT` either in your `CMakeLists.txt` file or as an environment variable.
@@ -111,43 +117,13 @@ Many `qpc` examples provide 3 build configurations:
 These configurations are also supported by qpc with cmake. Different possibilities exist to activate those.
 
 ### `qp_config.h` support
-Some build configurations require the inclusion of `qp_config.h`. To achieve this, the QPC macro `QP_CONFIG` should be set, when compiling the
-`qpc` source files. The include search paths also needs to be set accordingly in order for the preprocessor to be able to find the correct include
-file.
+With the release of QP/C V8.0.0 the inclusion of `qp_config.h` is mandatory.
+The `cmake` build system of qpc addresses this by providing the configuration variable `QPC_CFG_QPCONFIG_H_INCLUDE_PATH`. Set this to the path of your local project's `qp_config.h` and this will automatically be found by the build system. Do this in your main `CMakeLists.txt` file __before__ calling `qpc_sdk_init()`.
 
-As `qp_config.h` is a project related file, which - in most cases - resides outside the `qpc` source code tree, the decision is to handle the
-above mentioned topic within the root project's `CMakeLists.txt` file instead of integrating this topic into a rather complicated configuration
-of `qpc` itself.
+You do not need to set this variable, should the qpc default settings be sufficient for your project. In this case the build system uses the `qp_config.h` file, as it can be found in the directory `${QPC_SDK_PATH}/src/ports/config`.
 
-An example can be found in the [cmake dpp example](https://github.com/QuantumLeaps/qpc-examples/tree/main/posix-win32-cmake/dpp). Have a look into
-the example's [CMakeLists.txt](https://github.com/QuantumLeaps/qpc-examples/blob/main/posix-win32-cmake/dpp/CMakeLists.txt).
-
-You will find the reference to the `qpc` library, followed by the project's specific setup for `qp_config.h` like this:
-```
-# set up qpc library
-target_link_libraries(dpp
-    PRIVATE
-        qpc
-)
-# should a 'qp_config.h' configuration file be used and is it available
-# edit the HINTS in the 'find_file()' call according to your project settings
-if(USE_QP_CONFIG)
-    find_file(QP_CONFIG qp_config.h HINTS ${CMAKE_CURRENT_SOURCE_DIR}) # try to identify 'qp_config.h'
-    if(QP_CONFIG) # found 'qp_config.h'
-        cmake_path(GET QP_CONFIG PARENT_PATH QP_CONFIG_DIR) # extract the path from the FQFN
-        target_compile_definitions(qpc # add -DQP_CONFIG to the qpc build
-            PUBLIC
-                QP_CONFIG
-        )
-        target_include_directories(qpc # add the path to 'qp_config.h' to the list of include paths for qpc
-            PUBLIC
-                ${QP_CONFIG_DIR}
-        )
-    else() # 'qp_config.h' requested but not find - try to configure and build anyways
-        message(WARNING "File 'qp_config.h' not found!")
-    endif()
-endif()
-```
+An example can be found in the [cmake dpp example](https://github.com/QuantumLeaps/qpcpp-examples/tree/main/posix-win32-cmake/dpp). Have a look into
+the example's [CMakeLists.txt](https://github.com/QuantumLeaps/qpcpp-examples/blob/main/posix-win32-cmake/dpp/CMakeLists.txt).
 
 ### Multi configuration generators
 The most easy way to make use of the different configurations is to use a multi config generator like `Ninja Multi-Config` or `MS Visual Studio`.

cmakeSupport.md

@@ -0,0 +1,45 @@
+# Files Missing from the QP/C GPL Distribution
+Due to the widespread non-compliance with the GPL, as well as infringement
+on the [dual-licensing model of QP frameworks][Lic], the following files
+have been **removed from the open-source GPL distribution**:
+
+```
+qpc
+|
++---include
+|       qs.h
+|       qs_pkg.h
+|       qxk.h
+|
+\---src
+    |
+    +---qs
+    |       qs.c
+    |       qs_64bit.c
+    |       qs_fp.c
+    |       qs_rx.c
+    |       qutest.c
+    |
+    \---qxk
+            qxk.c
+            qxk_mutex.c
+            qxk_sema.c
+            qxk_xthr.c
+```
+
+> NOTE: These files are available to the [commercial licensees][Cust] with
+the active Support Term. Please contact [Quantum Leaps technical support][Sup]
+to get the complete QP/C framework distribution.
+
+# QP/C Framework Evaluation
+To request **evaluation** of the complete QP/C framework, please contact
+Quantum Leaps at:
+- https://www.state-machine.com/contact
+
+# Quantum Leaps Licensing:
+To learn more about the open source and commercial licensing options:
+- https://www.state-machine.com/licensing
+
+   [Lic]:    <https://www.state-machine.com/licensing>
+   [Cust]:   <https://www.state-machine.com/customers>
+   [Sup]:    <mailto:[email protected]>