: This document is part of the SafeQP Certification Kit↑, which has been specifically designed to help companies in safety certification of their software based on the SafeQP Framework. This document applies to QP/C Framework as well.

Document Revisions

QP/C version	Document revision	Date (YYYY-MM-DD)	By	Description
8.1.4	A	2026-05-16	MMS	Updated for QP/C 8.1.4
8.1.5	B	2026-08-08	MMS	Updated for QP/C 8.1.5

About This Document

[SCRM_QP]

Source Code Reference Manual (SCRM)

Description

This QP/C Source Code Reference Manual, formally identified as [SCRM_QP], provides the definitive, source-code-level reference for the QP/C Framework: a complete, cross-referenced catalog of the classes, functions, macros, and other code elements that implement the design specified in the QP Software Design Specification (SDS_QP). Unlike the SDS, which describes and justifies the design, this manual documents the actual, as-built QP/C source code — extracted directly from the header and implementation files using Doxygen (see TQR_QP) — so that every code element can be looked up, cross-referenced, and traced back to the design and requirements it realizes.

Scope

This Source Code Reference Manual covers the public and internal QP/C Framework source code: the header and implementation files of the QP/C distribution, together with their associated compile-time configuration macros. It is organized into a curated API Summary, grouped by functional area (Active Objects, Events, State Machines, Event and Time Management, Event Queues, Software Tracing, and the QV/QK/QXK kernels), a Deprecated APIs listing, and the complete, automatically generated Class and File reference extracted from the source code itself. It does not cover the design rationale and viewpoints behind the QP/C Framework (see the Software Design Specification, SDS_QP), quantitative code-quality metrics (see the Software Metrics Report, SMR_QP), or MISRA-C/C++ compliance findings (see the MISRA Compliance Report, MISRA_QP). QP/C Application (integrator) code is out of scope.

Regulatory background

None of the three functional safety standards mandates a document by this specific name, but all three require that safety-related software be implemented at the source-code level in a form that is documented, reviewable, and traceable back to its design. This Source Code Reference Manual is the artifact through which that source-code-level evidence is organized and made reviewable. The following table summarizes the role of the SCRM in the applicable functional safety standards.

IEC 61508-3:2010 (Functional Safety of E/E/PE Systems)
IEC 61508-3:2010 Clause 7.4.6 (Requirements for code implementation) requires that the source code correctly and completely implements the software design, uses only a defined subset of the programming language, and is documented in a manner suitable for review. The SCRM provides the reviewable, cross-referenced record of that implementation, complementing the coding-standard compliance evidence in the MISRA Compliance Report (MISRA_QP).
IEC 62304:2006 + Amd1:2015 (Medical Device Software)
IEC 62304 Clause 5.5 (Software Unit Implementation and Verification) requires each software unit to be implemented and its source code to satisfy defined acceptance criteria before verification proceeds. The SCRM identifies and documents every implemented unit (class, function, macro), giving verification personnel a single, current reference against which unit-level implementation can be reviewed.
ISO 26262:2018 (Road Vehicles Functional Safety)
ISO 26262-6:2018 Clause 8 (Software unit design and implementation) requires software units to be implemented in accordance with the detailed design and documented to a level that supports verification, including static and dynamic analysis. The SCRM makes the implemented QP/C units and their interfaces traceable back to the detailed design captured in the Software Design Specification (SDS_QP).

Document Organization

This Source Code Reference Manual is organized into the following sections:

Backward Traceability

Document Conventions

Source Code UIDs

UIDs of source code elements follow the rules established by Doxygen, with the following general form:

     +-------------- [1] Namespace or class (e.g., 'QP', or 'QHsm')
     |          +--- [2] element (e.g., attribute or operation)
     |          |
[namespace]_[element]

Examples:

QP/C API Summary