From f0cb4d76cb8e493ab87013ba77d31ccbed423c83 Mon Sep 17 00:00:00 2001 From: Jochen Hoenle Date: Tue, 14 Jul 2026 14:39:26 +0200 Subject: [PATCH] [communication] remove deprecated module documentation --- .../configuration/docs/architecture/index.rst | 31 -- .../configuration/docs/index.rst | 27 -- docs/modules/communication/docs/index.rst | 51 --- .../communication/docs/manual/index.rst | 21 - .../docs/manual/safety_manual.rst | 109 ----- .../docs/release/release_note.rst | 123 ------ .../docs/requirements/aou_req.rst | 381 ------------------ .../communication/docs/safety_mgt/index.rst | 24 -- .../docs/safety_mgt/module_codeowners.rst | 47 --- .../safety_mgt/module_safety_package_fdr.rst | 67 --- .../docs/safety_mgt/module_safety_plan.rst | 250 ------------ .../safety_mgt/module_safety_plan_fdr.rst | 96 ----- .../module_verification_report.rst | 84 ---- .../frontent/docs/architecture/index.rst | 122 ------ .../communication/frontent/docs/index.rst | 27 -- docs/modules/communication/index.rst | 16 +- .../ipc_binding/docs/architecture/index.rst | 31 -- .../communication/ipc_binding/docs/index.rst | 27 -- .../lola/docs/architecture/index.rst | 30 -- .../lola/docs/component_classification.rst | 184 --------- .../lola/docs/detailed_design/index.rst | 32 -- .../modules/communication/lola/docs/index.rst | 40 -- .../lola/docs/requirements/index.rst | 36 -- .../lola/docs/safety_analysis/dfa.rst | 49 --- .../lola/docs/safety_analysis/fmea.rst | 49 --- .../docs/architecture/index.rst | 48 --- .../message_passing/docs/index.rst | 23 -- .../mock_binding/docs/architecture/index.rst | 31 -- .../communication/mock_binding/docs/index.rst | 27 -- 29 files changed, 2 insertions(+), 2081 deletions(-) delete mode 100644 docs/modules/communication/configuration/docs/architecture/index.rst delete mode 100644 docs/modules/communication/configuration/docs/index.rst delete mode 100644 docs/modules/communication/docs/index.rst delete mode 100644 docs/modules/communication/docs/manual/index.rst delete mode 100644 docs/modules/communication/docs/manual/safety_manual.rst delete mode 100644 docs/modules/communication/docs/release/release_note.rst delete mode 100644 docs/modules/communication/docs/requirements/aou_req.rst delete mode 100644 docs/modules/communication/docs/safety_mgt/index.rst delete mode 100644 docs/modules/communication/docs/safety_mgt/module_codeowners.rst delete mode 100644 docs/modules/communication/docs/safety_mgt/module_safety_package_fdr.rst delete mode 100644 docs/modules/communication/docs/safety_mgt/module_safety_plan.rst delete mode 100644 docs/modules/communication/docs/safety_mgt/module_safety_plan_fdr.rst delete mode 100644 docs/modules/communication/docs/verification/module_verification_report.rst delete mode 100644 docs/modules/communication/frontent/docs/architecture/index.rst delete mode 100644 docs/modules/communication/frontent/docs/index.rst delete mode 100644 docs/modules/communication/ipc_binding/docs/architecture/index.rst delete mode 100644 docs/modules/communication/ipc_binding/docs/index.rst delete mode 100644 docs/modules/communication/lola/docs/architecture/index.rst delete mode 100644 docs/modules/communication/lola/docs/component_classification.rst delete mode 100644 docs/modules/communication/lola/docs/detailed_design/index.rst delete mode 100644 docs/modules/communication/lola/docs/index.rst delete mode 100644 docs/modules/communication/lola/docs/requirements/index.rst delete mode 100644 docs/modules/communication/lola/docs/safety_analysis/dfa.rst delete mode 100644 docs/modules/communication/lola/docs/safety_analysis/fmea.rst delete mode 100644 docs/modules/communication/message_passing/docs/architecture/index.rst delete mode 100644 docs/modules/communication/message_passing/docs/index.rst delete mode 100644 docs/modules/communication/mock_binding/docs/architecture/index.rst delete mode 100644 docs/modules/communication/mock_binding/docs/index.rst diff --git a/docs/modules/communication/configuration/docs/architecture/index.rst b/docs/modules/communication/configuration/docs/architecture/index.rst deleted file mode 100644 index 13e2d6f1c17..00000000000 --- a/docs/modules/communication/configuration/docs/architecture/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Configuration Component Architecture -************************************ - -.. comp:: Lola Configuration - :id: comp__com_configuration - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :uses: logic_arc_int__logging__logging[version==1] - :belongs_to: feat__com_communication[version==1] - - .. needarch:: - :scale: 50 - :align: center - - {{ draw_component(need(), needs) }} diff --git a/docs/modules/communication/configuration/docs/index.rst b/docs/modules/communication/configuration/docs/index.rst deleted file mode 100644 index 7fa4b2a8d26..00000000000 --- a/docs/modules/communication/configuration/docs/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -.. _comp_doc_configuration: - -configuration -############# - -Component Documents -=================== - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - architecture/index diff --git a/docs/modules/communication/docs/index.rst b/docs/modules/communication/docs/index.rst deleted file mode 100644 index f350a895a68..00000000000 --- a/docs/modules/communication/docs/index.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -.. mod:: Communication - :id: mod__com_communication - :includes: comp__com_configuration, comp__com_ipc_binding, comp__com_mock_binding, comp__com_frontend, comp__com_message_passing - - .. needarch:: - :scale: 50 - :align: center - - {{ draw_module(need(), needs) }} - comp__com_ipc_binding -r[hidden]-> comp__com_frontend - comp__com_frontend -r[hidden]-> comp__com_mock_binding - comp__com_mock_binding -r[hidden]-> comp__com_configuration - logic_arc_int__tracing__tracing -r[hidden]-> logic_arc_int__logging__logging - - -Module Documents -================ - -.. toctree:: - :maxdepth: 1 - :titlesonly: - :glob: - - manual/index.rst - release/release_note.rst - safety_mgt/index.rst - verification/module_verification_report.rst - -Requirements ------------- - -.. toctree:: - :titlesonly: - :maxdepth: 1 - :glob: - - ./requirements/aou_req.rst diff --git a/docs/modules/communication/docs/manual/index.rst b/docs/modules/communication/docs/manual/index.rst deleted file mode 100644 index a18d36fa93f..00000000000 --- a/docs/modules/communication/docs/manual/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Manuals -####### - -.. toctree:: - :titlesonly: - - safety_manual diff --git a/docs/modules/communication/docs/manual/safety_manual.rst b/docs/modules/communication/docs/manual/safety_manual.rst deleted file mode 100644 index 076ca4c8203..00000000000 --- a/docs/modules/communication/docs/manual/safety_manual.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Safety Manual -============= - -.. document:: Communication Safety Manual - :id: doc__communication_safety_manual - :status: draft - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__module_safety_manual[version==1] - -Introduction/Scope ------------------- -This safety manual covers the communication module. - -Assumed Platform Safety Requirements ------------------------------------- - -For the communication module the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the communication module. I.e. from these all the feature and component requirements implemented are derived. - -- :need:`stkh_req__communication__inter_process` - is QM, but is always compined with the next requirement -- :need:`stkh_req__communication__safe` -- :need:`stkh_req__app_architectures__support_time` - -The safe IPC communication interfaces supported are defined as: - -- event: :need:`feat_req__com__event_type` -- method: :need:`feat_req__com__method` - -Currently there is no safe inter-ECU communication supported. - -Assumptions of Use ------------------- - -Assumptions on the Environment -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -| Generally the assumption of the project platform SEooC is that it is integrated in a safe system, i.e. the POSIX OS it runs on is qualified and also the HW related failures are taken into account by the system integrator, if not otherwise stated in the module's safety concept. -| - -.. attention:: - This section is currently missing. - -List of AoUs expected from the environment the platform / module runs on: - -.. needtable:: - :style: table - :columns: title;id;status - :colwidths: 25,25,25 - :sort: title - - results = [] - - for need in needs.filter_types(["aou_req"]): - if need and "environment" in need["tags"] and need["id"].startswith("aou_req__communication"): - results.append(need) - -Assumptions on the User -^^^^^^^^^^^^^^^^^^^^^^^ -| As there is no assumption on which specific OS and HW is used, the integration testing of the stakeholder and feature requirements is expected to be performed by the user of the platform SEooC. Tests covering all stakeholder and feature requirements performed on a reference platform (tbd link to reference platform specification), reviewed and passed are included in the platform SEooC safety case. -| Additionally the components of the platform may have additional specific assumptions how they are used. These are part of every module documentation: . Assumptions from components to their users can be fulfilled in two ways: -| 1. There are assumption which need to be fulfilled by all SW components, e.g. "every user of an IPC mechanism needs to make sure that he provides correct data (including appropriate ASIL level)" - in this case the AoU is marked as "platform". -| 2. There are assumption which can be fulfilled by a safety mechanism realized by some other project platform component and are therefore not relevant for an user who uses the whole platform. But those are relevant if you chose to use the module SEooC stand-alone - in this case the AoU is marked as "module". An example would be the "JSON read" which requires "The user shall provide a string as input which is not corrupted due to HW or QM SW errors." - which is covered when using together with safe project platform persistency feature. - -List of AoUs on the user of the platform features or the module of this safety manual: - -.. needtable:: - :style: table - :columns: title;id;status - :colwidths: 25,25,25 - :sort: title - - results = [] - - for need in needs.filter_types(["aou_req"]): - if need and "environment" not in need["tags"] and need["id"].startswith("aou_req__communication"): - results.append(need) - -Safety concept of the SEooC ---------------------------- -| - -.. attention:: - This section is currently missing. - -Safety Anomalies ----------------- -| Anomalies (bugs in ASIL SW, detected by testing or by users, which could not be fixed) known before release are documented in the platform/module release notes . - -.. attention:: - This section is currently missing. - -References ----------- -| `User Manual `_ -| diff --git a/docs/modules/communication/docs/release/release_note.rst b/docs/modules/communication/docs/release/release_note.rst deleted file mode 100644 index c7382dab600..00000000000 --- a/docs/modules/communication/docs/release/release_note.rst +++ /dev/null @@ -1,123 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Release Note -============ - -.. document:: Communication Release Note - :id: doc__communication_release_note - :status: valid - :version: 1 - :safety: ASIL_B - :security: YES - :realizes: wp__module_sw_release_note[version==1] - :tags: communication - - -Module Name: Communication - -Release Tag: v0.1.1 - -Origin Release Tag: none - -Release Commit Hash: 24d6e8916b89dbb405eae0b082348645d190dc18 - -Release Date: 2025-11-11 - -Overview --------- - -This document provides an overview of the changes, improvements, and bug fixes included in the software module release version v0.5 -as compared to the module's origin release (which is usually the previous release). - -Disclaimer ----------- -This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. -The work products compiled in the safety package are created with care according to a process satisfying standards, but the as the project, -being a non-profit and open source organization, can not take over any liability for its content. - -New Features ------------- - -* **Feature 1**: Zero-copy, shared-memory based inter-process communication for minimal latency intra-ECU messaging. -* **Feature 2**: Support for mixed-criticality configurations to match different functional safety requirements. -* **Feature 3**: Service-oriented architecture with skeleton/proxy framework. -* **Feature 4**: Automatic service registration and lookup mechanism for dynamic service discovery at runtime. -* **Feature 5**: Event-driven publish-subscribe messaging pattern for data availability notifications. -* **Feature 6**: Field-based communication with initial-value support (currently no getters or setters). -* **Feature 7**: Zero-copy, binding-agnostic communication tracing support for observability and debugging. - -Improvements ------------- - -This is the first release of the Communication module in Eclipse S-CORE, therefore there are no improvements to report. - -Bug Fixes ---------- - -This is the first release of the Communication module in Eclipse S-CORE, therefore there are no bug fixes to report. - -Compatibility -------------- - -* **Dependencies**: - - * Bazel Platforms: version 0.0.11 - Platform abstraction for cross-platform builds - * GoogleTest: version 1.15.0 - Unit testing framework for C++ - * Google Benchmark: version 1.9.1 - Performance benchmarking library - * Rules Rust: version 0.61.0 - Bazel rules for Rust language support - * Score Crates: version 0.0.2 - Rust crate dependencies repository - * Boost Program Options: version 1.87.0 - Command-line argument parsing library - * Download Utils: version 1.0.1 - Utility for downloading build artifacts - * JSON Schema Validator: version 2.1.0 - JSON schema validation library (downloaded from GitHub) - * Jsonschema: version 4.23.0 - Python JSON schema validation (downloaded from GitHub) - * nlohmann_json: version 3.11.3 - C++ JSON library - * Bazel Skylib: version 1.7.1 - Bazel standard library utilities - * Rules Doxygen: version 2.5.0 - Bazel rules for Doxygen documentation generation - * Score Baselibs: version 0.2.0 (commit de5bb27) - Core libraries with wait-free stack fix patch applied - * Rules Python: version 0.32.0 - Bazel Python toolchain rules - * Python: version 3.12 - Runtime for build tooling and traceability tools - * TRLC: version 0.0.0 (trlc-2.0.2 release, commit 650b51a) - Requirements traceability language and compiler - * LOBSTER: Requirements traceability and documentation tool (via custom extension) - -* **Optional Dependencies (Platform-Specific)**: - - * score_toolchains_gcc: version 0.4 - Toolchain for builds with GCC on various targets - * score_toolchains_qnx: version 0.0.2 - Toolchain for builds on QNX targets - -Performed Verification ----------------------- - -This release note is based on the verification as documented in module verification report -:need:`doc__communication_verification_report`. - - -Known Issues ------------- - -* **Issue 1**: Limited test coverage due to restrictions in S-CORE testing infrastructure -* **Issue 2**: Incomplete Rust frontend with limited functionality compared to C++ frontend -* **Issue 3**: Incomplete PMR Integration - PMR support not fully implemented -* **Issue 4**: Incomplete Error Handling in Rust Bridge - Error propagation incomplete. May cause unwanted behavior in error paths. -* **Issue 5**: Runtime JSON Configuration Validation - Invalid configurations may lead to an abort during configuration parsing at application startup. - -Upgrade Instructions --------------------- - -This is the first release of the Communication module in Eclipse S-CORE, therefore there are no upgrade instructions. - -Contact Information -------------------- - -For any questions or support, please contact the *Project lead* or raise an issue/discussion. diff --git a/docs/modules/communication/docs/requirements/aou_req.rst b/docs/modules/communication/docs/requirements/aou_req.rst deleted file mode 100644 index 31566af6c59..00000000000 --- a/docs/modules/communication/docs/requirements/aou_req.rst +++ /dev/null @@ -1,381 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Assumptions of Use -################## - -.. document:: Communication Assumptions of Use - :id: doc__communication_aou - :status: valid - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__requirements_comp[version==1] - -.. aou_req:: Monotonic Semi-Dynamic Memory Allocation - :id: aou_req__communication__1 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that enough memory is configured for shared memory instances, - in order that LoLa can perform all necessary allocations (e.g. push-back on a Vector). - -.. aou_req:: Correctly Configured Maximum Number of Subscribers - :id: aou_req__communication__2 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that correct maximum number of subscriber is configured for each - event for each service instance. - -.. aou_req:: Correctly configured maximum number of maximum elements per subscriber - :id: aou_req__communication__3 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that correct maximum number of elements per subscriber is - configured for each event for each service instance. - -.. aou_req:: Correctly configured ASIL Level - :id: aou_req__communication__4 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - The ASIL-Level is used to ensure Freedom from Interference (e.g. by configuring access rights). - Without a proper configured level, this cannot be ensured. - -.. aou_req:: Only LoLa supported types - :id: aou_req__communication__5 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured, that only types that are supported by LoLa are transmitted. - -.. aou_req:: No APIs from Implementation Namespace - :id: aou_req__communication__6 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that no API calls from the implementation namespace (e.g `impl`) - are directly invoked or types from within are directly used. - -.. aou_req:: No guarantees for notifications - :id: aou_req__communication__7 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that a miss behavior of event notification, will not harm a safety goal. - -.. aou_req:: Checking for possible message overflow - :id: aou_req__communication__8 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that a message overflow, which results in message loss will not harm a safety goal. - If this is not possible, a check for message overflow and necessary actions need to be performed. - -.. aou_req:: Different user for ASIL and QM processes - :id: aou_req__communication__9 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that processes with a different ASIL shall be executed within different user-ids. - -.. aou_req:: Config on a safe filesystem - :id: aou_req__communication__10 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that any configuration item that is read at runtime by LoLa is - stored on a safety certified filesystem (according to the highest supported safety level). - -.. aou_req:: No static context support - :id: aou_req__communication__11 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that LoLa is not used within static context within C++. - -.. aou_req:: No guarantee in availability of services - :id: aou_req__communication__12 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that no safety goal is harmed, because a service instance is not found. - -.. aou_req:: No notification on termination of producer - :id: aou_req__communication__13 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensure that termination (either gracefully or due to a malfunction) - of a producer will not lead to a violation of a safety goal. - -.. aou_req:: Check for nullptr on Allocate() - :id: aou_req__communication__14 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be checked if Allocate() on an event will return a nullptr. If a nullptr is returned, - the system shall transition to safe state. - - -.. aou_req:: One producer only one AllocateePtr - :id: aou_req__communication__15 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that at any time a producer instance per event only holds one AllocateePtr. - -.. aou_req:: No Copy-Send() while holding AllocateePtr. - :id: aou_req__communication__16 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that Send(const& value) is not invoked while an AllocateePtr is held. - -.. aou_req:: None reentrant methods per event instance - :id: aou_req__communication__17 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that any LoLa API that is bound to a specific event - instance is not called in a reentrant manner. - -.. aou_req:: Skeleton alive while its AllocateePtr being used - :id: aou_req__communication__18 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that a Skeleton instance is still alive while any AllocateePtr returned by it is used. - -.. aou_req:: Event Subscription active while holding SamplePtr - :id: aou_req__communication__19 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that Unsubscribe() isn't called on a proxy eventinstance as long as - any SamplePtr provided by it, is still held. - -.. aou_req:: Non-Terminating callbacks - :id: aou_req__communication__20 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that any callback passed to LoLa for invocation is not throwing. - -.. aou_req:: Valid callbacks while proxy alive - :id: aou_req__communication__21 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that all callbacks passed towards LoLa are valid as long as the associated proxy is alive. - -.. aou_req:: Quality of data is dependent on producer - :id: aou_req__communication__22 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that the necessary quality of data is produced by the respective skeleton process. - -.. aou_req:: Validity of pointer on LoLa pointer - :id: aou_req__communication__23 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that no pointer, pointing to the memory of a SamplePtr - or AllocateePtr is used once the SamplePtr or AllocateePtr are invalid. - -.. aou_req:: LoLa Memory only accessed through LoLa - :id: aou_req__communication__24 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that no other code accesses the mapped memory managed by LoLa. - -.. aou_req:: No shared memory allocation in namespace lola - :id: aou_req__communication__25 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that no other code creates shared memory segments beginning with "lola". - -.. aou_req:: LoLa specific QNX Messaging End-Points only accessed through LoLa - :id: aou_req__communication__26 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that the LoLa specific QNX Message Passing end-points are only accessed through LoLa APIs. - -.. aou_req:: aragen not safe - :id: aou_req__communication__27 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - If aragen is being used to generate LoLa interfaces, any output produced by aragen - shall be manually reviewed for its correctness. - -.. aou_req:: unsupported data-types - :id: aou_req__communication__28 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that neither variants nor maps are sent via LoLa. - -.. aou_req:: No guarantee on execution time - :id: aou_req__communication__29 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - There is no guarantee on the execution time of any function call provided by LoLa. - -.. aou_req:: Usage of configuration "oversubscription" - :id: aou_req__communication__30 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - If event instance "oversubscription" is enabled. LoLa makes no warranty, that proxies/consumers - can't suffer from data loss! It is the responsibility of the user to adapt scheduling/event-data - access in a way, that no data-loss happens. - However, we can give the guarantee that if only QM consumers misbehave,ASIL consumers are not - affected by these actions. - -.. aou_req:: Same compiler settings for provider and consumer side - :id: aou_req__communication__31 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - All compiler settings having influence on the binary representation of data exchanged via - mw::com/LoLa (event, field, service-method payloads) have to be identical for compilation of - code containing mw::com proxies and skeletons, which communicate. - -.. aou_req:: Event or Field reception via GenericProxy needs specific care - :id: aou_req__communication__32 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - When receiving event or field data via untyped GenericProxyEvent or GenericProxyField, care has to - be taken, when accessing the corresponding SamplePtr delivered by calls to GetNewSamples(): - When casting it to the expected type, it needs to be checked, that no access behind the size returned - by GetSampleSize() will happen. - -.. aou_req:: Correctly configured events/fields per service type - :id: aou_req__communication__34 - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :status: valid - :version: 1 - - It shall be ensured that all safety relevant events/fields in the service type, - are the same in all configurations. - -.. needextend:: is_external == False and "__communication_" in id - :+tags: communication diff --git a/docs/modules/communication/docs/safety_mgt/index.rst b/docs/modules/communication/docs/safety_mgt/index.rst deleted file mode 100644 index ba72f6019ab..00000000000 --- a/docs/modules/communication/docs/safety_mgt/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2024 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Safety Management -################# - -.. toctree:: - :titlesonly: - - module_safety_plan - module_codeowners - module_safety_plan_fdr - module_safety_package_fdr diff --git a/docs/modules/communication/docs/safety_mgt/module_codeowners.rst b/docs/modules/communication/docs/safety_mgt/module_codeowners.rst deleted file mode 100644 index 0b59ee2d6dd..00000000000 --- a/docs/modules/communication/docs/safety_mgt/module_codeowners.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Module Codeowners Skill Check -***************************** - -.. document:: Communication Codeowners - :id: doc__communication_codeowners - :status: valid - :version: 1 - :safety: ASIL_B - :security: YES - :realizes: wp__module_safety_plan[version==1] - -Assigned Committer(s) -===================== - -According to `Communication Module Codeowners `_ -the following committers are assigned to guard the Communication repository: - -- ``_ -- ``_ -- ``_ - -Skill Check -=========== - -For the CODEOWNERS the required skills, knowledge and experience is defined in ``_. - -The evidences are not published openly due to personal data confidentiality, but will be checked by the module safety manager. - -- ``_: SW developer and team lead for Safe POSIX SW platform at OEM > 2 years -- ``_: SW developer for Safe POSIX SW platform at OEM > 1.5y and safety manager for camera systems at OEM 1y, member of S-CORE process community -- ``_: SW developer for Safe POSIX SW platform at OEM > 2 years - -The S-CORE processes are trained on the job by the Communication module safety manager to the CODEOWNERS. diff --git a/docs/modules/communication/docs/safety_mgt/module_safety_package_fdr.rst b/docs/modules/communication/docs/safety_mgt/module_safety_package_fdr.rst deleted file mode 100644 index 97832ce6fa5..00000000000 --- a/docs/modules/communication/docs/safety_mgt/module_safety_package_fdr.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Safety Package Formal Review Report -=================================== - -.. note:: Document header - -.. document:: Communication Safety Package Formal Review - :id: doc__communication_safety_package_fdr - :status: draft - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__fdr_reports[version==1] - - - -**1. Purpose** - -The purpose of this review checklist is to report status of the formal review for the safety package. - -**2. Checklist** - -.. list-table:: Safety Package Checklist - :header-rows: 1 - - * - Id - - Safety package activity - - Compliant to ISO 26262? - - Comment - - * - 1 - - Is a safety package provided which matches the safety plan (i.e. all planned work products referenced)? - - [YES | NO ] - - - - * - 2 - - Is the argument how functional safety is achieved, provided in the safety package, plausible and sufficient? - - NO - - The argument is intentionally not provided by the project. - - * - 3 - - Are the referenced work products available? - - [YES | NO ] - - - - * - 4 - - Are the referenced work products in released state, including the process safety audit? - - [YES | NO ] - - - - * - 5 - - If safety related deviations from the process or safety concept are documented, are these argued understandably? - - [YES | NO ] - - diff --git a/docs/modules/communication/docs/safety_mgt/module_safety_plan.rst b/docs/modules/communication/docs/safety_mgt/module_safety_plan.rst deleted file mode 100644 index 8cb154818ad..00000000000 --- a/docs/modules/communication/docs/safety_mgt/module_safety_plan.rst +++ /dev/null @@ -1,250 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Module Safety Plan -****************** - -.. document:: Communication Safety Plan - :id: doc__communication_safety_plan - :status: draft - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__module_safety_plan[version==1] - - - -Functional Safety Management Context -==================================== - -This Safety Plan adds to the :need:`doc__score_platform_safety_plan` all the module development relevant work products needed for ISO 26262 conformity. - -Functional Safety Management Scope -================================== - -This Safety Plan's scope is a SW module of the SW platform :ref:`communication_module_docs`. -The module consists of one or more SW components and will be qualified as a SEooC. - -Functional Safety Management Roles -================================== - -.. list-table:: Module roles - :header-rows: 1 - - * - Role - - Assignee - - * - Safety Manager - - Alexander Schemmel - - * - Module Project Manager (= Feature team lead) - - Committers of feature team see `Communication FT `_ - -Tailoring -========= - -Additional to the tailoring in the SW platform project as defined in the :need:`doc__score_platform_safety_plan` we define here the additional tailoring on module level. - -- Excluded for this module are additionally the following work products (and their related requirements): - - - :need:`wp__requirements_inspect`: in version 0.5 the inspections have to be done by the user - - :need:`wp__sw_arch_verification`: in version 0.5 the inspections have to be done by the user - - :need:`wp__fdr_reports` (module's Safety Analyses & DFA): in version 0.5 the reviews have to be done by the user - -Functional Safety Module Work products -====================================== - -One set of work products for the module and one set for each component of the module: - -Module Work products List -------------------------- - -.. list-table:: Module Work products - :header-rows: 1 - - * - Work product Id - - Link to process - - Process status - - Link to WP - - * - :need:`wp__module_safety_plan` - - :need:`gd_guidl__saf_plan_definitions` - - :ndf:`copy('status', need_id='gd_guidl__saf_plan_definitions')` - - this document - - * - :need:`wp__module_safety_package` - - :need:`gd_guidl__saf_package` - - :ndf:`copy('status', need_id='gd_guidl__saf_package')` - - this document (including the linked documentation) - - * - :need:`wp__fdr_reports` (module Safety Plan) - - :need:`gd_chklst__safety_plan` - - :ndf:`copy('status', need_id='gd_chklst__safety_plan')` - - :need:`doc__communication_safety_plan_fdr` - - * - :need:`wp__fdr_reports` (module Safety Package) - - :need:`gd_chklst__safety_package` - - :ndf:`copy('status', need_id='gd_chklst__safety_package')` - - :need:`doc__communication_safety_package_fdr` - - * - :need:`wp__fdr_reports` (module's Safety Analyses & DFA) - - :need:`gd_chklst__safety_analysis` - - :ndf:`copy('status', need_id='gd_chklst__safety_analysis')` - - tailored - - * - :need:`wp__audit_report` - - performed by external experts - - n/a - - - - * - :need:`wp__module_safety_manual` - - :need:`gd_temp__safety_manual` - - :ndf:`copy('status', need_id='gd_temp__safety_manual')` - - :need:`doc__communication_safety_manual` - - * - :need:`wp__verification_module_ver_report` - - :need:`gd_temp__mod_ver_report` - - :ndf:`copy('status', need_id='gd_temp__mod_ver_report')` - - :need:`doc__communication_verification_report` - - * - :need:`wp__module_sw_release_note` - - :need:`gd_temp__rel_mod_rel_note` - - :ndf:`copy('status', need_id='gd_temp__rel_mod_rel_note')` - - :need:`doc__communication_release_note` - -Component lola Work products List ---------------------------------- - -.. list-table:: Component lola Work products - :header-rows: 1 - - * - Work product Id - - Link to process - - Process status - - Link to WP - - * - :need:`wp__requirements_comp` - - :need:`gd_temp__req_comp_req` - - :ndf:`copy('status', need_id='gd_temp__req_comp_req')` - - :need:`doc__lola_requirements` - - * - :need:`wp__requirements_comp_aou` - - :need:`gd_temp__req_aou_req` - - :ndf:`copy('status', need_id='gd_temp__req_aou_req')` - - :need:`doc__communication_aou` - - * - :need:`wp__requirements_inspect` - - :need:`gd_chklst__req_inspection` - - :ndf:`copy('status', need_id='gd_chklst__req_inspection')` - - tailored - - * - :need:`wp__component_arch` - - :need:`gd_temp__arch_comp` - - :ndf:`copy('status', need_id='gd_temp__arch_comp')` - - :need:`doc__lola_architecture` - - * - :need:`wp__sw_arch_verification` - - :need:`gd_chklst__arch_inspection_checklist` - - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')` - - tailored - - * - :need:`wp__sw_component_fmea` - - :need:`gd_temp__comp_saf_fmea` - - :ndf:`copy('status', need_id='gd_temp__comp_saf_fmea')` - - :need:`doc__lola_fmea` - - * - :need:`wp__sw_component_dfa` - - :need:`gd_temp__comp_saf_dfa` - - :ndf:`copy('status', need_id='gd_temp__comp_saf_dfa')` - - :need:`doc__lola_dfa` - - * - :need:`wp__sw_implementation` - - :need:`gd_guidl__implementation` - - :ndf:`copy('status', need_id='gd_guidl__implementation')` - - `lola/.h/.cpp `_, :need:`doc__lola_detailed_design` - - * - :need:`wp__verification_sw_unit_test` - - :need:`gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - - `lola/test.cpp `_ - - * - :need:`wp__sw_implementation_inspection` - - :need:`gd_chklst__impl_inspection_checklist` - - :ndf:`copy('status', need_id='gd_chklst__impl_inspection_checklist')` - - External process - - * - :need:`wp__verification_comp_int_test` - - :need:`gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - - - - * - :need:`wp__sw_component_class` - - :need:`gd_guidl__component_classification` - - :ndf:`copy('status', need_id='gd_guidl__component_classification')` - - :need:`doc__lola_comp_class` - -Module Safety Package -===================== - -To create the safety package (according to :need:`gd_guidl__saf_package`) the following -documents and work products status have to go to "valid" (after the relevant verification were performed). - -Module Documents Status ------------------------ - -For all the work product documents the status can be seen by following the "Link to WP". -A summary of the status is also documented in the project's documentation management plan. - -See :ref:`documents_docs_modules_communication_docs` - -Component Documents Status --------------------------- - -For all the work product documents the status can be seen by following the "Link to WP". -A summary of the status is also documented in the project's documentation management plan. - -See :ref:`documents_docs_modules_communication_docs` - -Component Requirements Status ------------------------------ - -not documented as needs, `lola trlc `_ -shows no status attribute - -Component AoU Status --------------------- - -.. needtable:: - :filter: "communication" in docname and "requirements" in docname and docname is not None - :style: table - :types: aou_req - :tags: communication - :columns: id;status;tags - :colwidths: 25,25,25 - :sort: title - -Component Architecture Status ------------------------------ - -see document link :need:`doc__lola_architecture` (as above) - -Deviations from Module Safety Plan ----------------------------------- - -The following deviations from the module safety plan are present in the module safety package. -These are deviations from planned processes execution and/or work product results, -safety anomalies in the sense of known bugs in the software are reported in the release notes. - - diff --git a/docs/modules/communication/docs/safety_mgt/module_safety_plan_fdr.rst b/docs/modules/communication/docs/safety_mgt/module_safety_plan_fdr.rst deleted file mode 100644 index 965f230b34f..00000000000 --- a/docs/modules/communication/docs/safety_mgt/module_safety_plan_fdr.rst +++ /dev/null @@ -1,96 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Safety Plan Formal Review Report -================================ - -.. note:: Document header - -.. document:: Communication Safety Plan Formal Review - :id: doc__communication_safety_plan_fdr - :status: draft - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__fdr_reports[version==1] - - -**1. Purpose** - -The purpose of this safety plan formal review checklist is to report status of the review for the safety plan. - -**2. Checklist** - -.. list-table:: Safety Plan Checklist - :header-rows: 1 - - * - Id - - Safety plan activity - - Compliant to ISO 26262? - - Comment - - * - 1 - - Is the rationale for the safety work products tailoring included? - - [YES | NO ] - - - - * - 2 - - Is impact analysis planned in case of re-use of SW (needed for every release following the first formal release)? - - [YES | NO ] - - - - * - 3 - - Does the safety plan define all needed activities for safety management (incl. Confirmation review and Safety Audit)? - - [YES | NO ] - - - - * - 4 - - Does the safety plan define all needed activities for System and SW development, integration and verification? - - [YES | NO ] - - - - * - 5 - - Does the safety plan define all needed activities for safety analysis and DFA? - - [YES | NO ] - - - - * - 6 - - Does the safety plan define all needed activities for supporting processes (incl. tool mgt)? - - [YES | NO ] - - - - * - 7 - - Does the safety plan document a responsible for all activities? - - [YES | NO ] - - - - * - 8 - - If OSS software components is used, is it planned to be qualified? - - [YES | NO ] - - - - * - 9 - - Is a safety manager and a project manager appointed for the project? - - [YES | NO ] - - - - * - 10 - - Is safety plan sufficiently linked to the project plan? - - [YES | NO ] - - - - * - 11 - - Is safety plan updated iteratively to show the progress? - - [YES | NO ] - - diff --git a/docs/modules/communication/docs/verification/module_verification_report.rst b/docs/modules/communication/docs/verification/module_verification_report.rst deleted file mode 100644 index e688dc72589..00000000000 --- a/docs/modules/communication/docs/verification/module_verification_report.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Verification Report -=================== - -.. document:: Communication Verification Report - :id: doc__communication_verification_report - :status: draft - :version: 1 - :safety: ASIL_B - :security: YES - :realizes: wp__verification_module_ver_report[version==1] - - -This verification report is based on the :need:`gd_temp__verification_plan`. -It covers all the components of the above stated module. - -.. attention:: - This report is currently missing. - -Verification Report contains: - -**1. Verification Coverage** - -**1.1. on Requirements** - - Lists of component requirements (incl. AoU satisfied by the component) tested by which test case, passed/failed and completeness verdict - (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - - For external component Assumptions of Use: coverage by platform safety manual or feature/components incl. test case, passed/failed and completeness verdict - - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. - - List of component requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - -**1.2. on Architecture** - - List of component architecture tags tested by which test case, passed/failed and completeness verdict - (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - - This is split in a list of QM components tested and a separate list of tests for ASIL rated components. - - List of component architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - -**1.3. on Detailed Design** - - List of detailed design tags tested by which test case, passed/failed and completeness verdict - (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - - This is split in a list of QM components tested and a separate list of tests for ASIL rated components. - - List of detailed design tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - - - The lists may also contain other verification methods like "Analysis" - process tbd - -**2. DFA Report** - - List of the performed component DFA, pass/fail with open mitigations - -**3. Safety Analysis Report** - - List of the performed component Safety Analysis, pass/fail with open mitigations - -**4. Unit Verification Coverage** - -**4.1. Structural Coverage** - - List of the units with C0(line) and C1(branch) coverage absolute and percentage - (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - - List includes a column for the safety rating of each unit. - -**4.2. Static Code Analysis** - - List of the units with compiler warning numbers and coding rule violation numbers - (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - - List includes a column for the safety rating of each unit. - -**4.3. Manual Code Inspection** - - List of components (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - -**5. Software component qualification verification report** - - Contains the needed verification results if for some components a qualification of pre-developed SW is performed. - -**Note1:** The verification report is valid for the module version tagged together with the report - -**Note2:** All the above lists are generated automatically diff --git a/docs/modules/communication/frontent/docs/architecture/index.rst b/docs/modules/communication/frontent/docs/architecture/index.rst deleted file mode 100644 index 3ddbb503291..00000000000 --- a/docs/modules/communication/frontent/docs/architecture/index.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Frontend Component Architecture -******************************* - -.. comp:: mw::com Frontend - :id: comp__com_frontend - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :implements: logic_arc_int__communication__user[version==1] - :uses: logic_arc_int__logging__logging[version==1], logic_arc_int__tracing__tracing[version==1] - :belongs_to: feat__com_communication[version==1] - -.. comp_arc_sta:: mw::com Frontend Architecture - :id: comp_arc_sta__com__frontend - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :uses: logic_arc_int__logging__logging[version==1], logic_arc_int__tracing__tracing[version==1] - :belongs_to: comp__com_frontend[version==1] - :fulfils: comp_req__communication__logging[version==1] - - .. needarch:: - :scale: 50 - :align: center - - {{ draw_component(need(), needs) }} - -.. logic_arc_int_op:: Initialize - :id: logic_arc_int_op__com__initialize - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__communication__user - -.. logic_arc_int_op:: Offer Service - :id: logic_arc_int_op__com__offer_service - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__communication__user - -.. logic_arc_int_op:: Update - :id: logic_arc_int_op__com__update - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__communication__user - -.. logic_arc_int_op:: Send - :id: logic_arc_int_op__com__send - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__communication__user - -.. logic_arc_int_op:: StartFindService - :id: logic_arc_int_op__com__startfindserv - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__communication__user - -.. logic_arc_int_op:: CreateProxy - :id: logic_arc_int_op__com__createproxy - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__communication__user - -.. logic_arc_int_op:: Subscribe - :id: logic_arc_int_op__com__subscribe - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__communication__user - -.. logic_arc_int_op:: GetNewSamples - :id: logic_arc_int_op__com__getnewsamples - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__communication__user - - -Functional Requirements -======================= - -.. comp_req:: Error logging - :id: comp_req__communication__logging - :reqtype: Functional - :security: NO - :safety: ASIL_B - :derived_from: feat_req__com__event_type[version==1] - :status: valid - :version: 1 - :satisfied_by: comp__com_frontend[version==1] - - In case, that there is no related Event Type Info source provided in shared memory for a given Event enlisted in the deployment for the proxy, an ERROR message shall be logged. diff --git a/docs/modules/communication/frontent/docs/index.rst b/docs/modules/communication/frontent/docs/index.rst deleted file mode 100644 index 28bf90630bd..00000000000 --- a/docs/modules/communication/frontent/docs/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -.. _comp_doc_frontent: - -frontent -######## - -Component Documents -=================== - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - architecture/index diff --git a/docs/modules/communication/index.rst b/docs/modules/communication/index.rst index 29cb3e4e3e5..623788ccdb5 100644 --- a/docs/modules/communication/index.rst +++ b/docs/modules/communication/index.rst @@ -16,18 +16,6 @@ Communication Module #################### -.. toctree:: - :titlesonly: - :maxdepth: 2 +The documentation for this module has moved to its own repository: - ./docs/index - -Components -========== - -.. toctree:: - :titlesonly: - :maxdepth: 1 - :glob: - - ./*/docs/index +`Communication Module Documentation `_ diff --git a/docs/modules/communication/ipc_binding/docs/architecture/index.rst b/docs/modules/communication/ipc_binding/docs/architecture/index.rst deleted file mode 100644 index 39b6642d661..00000000000 --- a/docs/modules/communication/ipc_binding/docs/architecture/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -IPC Binding Component Architecture -********************************** - -.. comp:: IPC Binding - :id: comp__com_ipc_binding - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :uses: logic_arc_int__logging__logging[version==1], logic_arc_int__tracing__tracing[version==1], logic_arc_int__baselibs__memory_shared[version==1], logic_arc_int__com__message_passing[version==1], logic_arc_int__baselibs__json[version==1] - :belongs_to: feat__com_communication[version==1] - - .. needarch:: - :scale: 50 - :align: center - - {{ draw_component(need(), needs) }} diff --git a/docs/modules/communication/ipc_binding/docs/index.rst b/docs/modules/communication/ipc_binding/docs/index.rst deleted file mode 100644 index ae3fa379a02..00000000000 --- a/docs/modules/communication/ipc_binding/docs/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -.. _comp_doc_ipc_binding: - -ipc_binding -########### - -Component Documents -=================== - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - architecture/index diff --git a/docs/modules/communication/lola/docs/architecture/index.rst b/docs/modules/communication/lola/docs/architecture/index.rst deleted file mode 100644 index 590bfa21c51..00000000000 --- a/docs/modules/communication/lola/docs/architecture/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - - -Component Architecture -====================== - -.. document:: LoLa Architecture - :id: doc__lola_architecture - :status: draft - :version: 1 - :safety: ASIL_B - :security: YES - :realizes: wp__component_arch[version==1] - -Overview --------- -No sub-components currently identified, therefore no component architecture presented. -Design is shown in :need:`doc__lola_detailed_design` diff --git a/docs/modules/communication/lola/docs/component_classification.rst b/docs/modules/communication/lola/docs/component_classification.rst deleted file mode 100644 index 2628a378275..00000000000 --- a/docs/modules/communication/lola/docs/component_classification.rst +++ /dev/null @@ -1,184 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Component Classification -======================== - -.. note:: Document header - -.. document:: lola Component Classification - :id: doc__lola_comp_class - :status: draft - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__sw_component_class[version==1] - -| Classification of lola -| -| `Lola IPC `_ v0.1.1 -| -| Additional documentation considered: -| :need:`doc__com` and :need:`doc__com_ipc` - - -Step 1: Determine (P): the uncertainty of the Processes applied ---------------------------------------------------------------- - -| Apply the process measures to determine (P). -| The result of a process measure shall have as outcome [HE, PE, NE] -| - HE: High Evidence -| - PE: Partly Evidence but Manageable -| - NE: No Evidence - -.. list-table:: Determine (P) - :header-rows: 1 - - * - Id - - Indicator for applying process - - Result - - Rationale for result - - * - 1 - - Are rules, state-of-the art processes applied for the design, implementation and verification? - - PE - - The component was already qualified as part of an OEM SW platform safety case, but not all work products are available open source. - - * - 2 - - Are requirements available? - - PE - - See `lola trlc `_ available but not according to S-CORE process - perform content centric inspection of component requirements and also checking matching of S-CORE and lola feature requirements - - * - 3 - - Are specifications for functionalities and properties available (architecture)? - - HE - - Created using S-CORE process: :need:`mod__com_communication` - - * - 4 - - Are design specifications available? - - PE - - `lola/design `_ available but not according to S-CORE process - perform content centric inspection inclusive the matching of S-CORE feature architecture with lola design - - * - 5 - - Are configuration specification and data available, if applicable? - - HE - - See `lola/design/configuration `_ - - * - 6 - - Are verification measures including tests and reports available? - - PE - - Unit tests available and configured failure blocks the merge of any lola pull request, evidences links TBD, need to check for integration testing - - -| (P=1) shall be selected when none of the determined process measures indicate PE or NE. -| (P=2) shall be selected when at least one of the determined process measures indicate PE or NE, but the gaps evaluated are acceptable, means -| the risk of systematic faults due to these gaps is sufficiently low or manageable by mitigating the gaps. -| (P=3) in all other cases. - -lola is determined as P=2 - - -Step 2: Determine (C): the uncertainty of finding systematic faults based on the Complexity -------------------------------------------------------------------------------------------- - -| Apply the complexity measures to determine (C). -| The result of a complexity measure shall have as outcome [NH, HM, NM] -| - NH: Not High -| - HM: High but Manageable -| - NM: high and Not Manageable -| -| **Complexity measure for programming language: C++** - -.. list-table:: Determine (C) for C++ - :header-rows: 1 - - * - Id - - Indicator for high Complexity - - Complexity measure Tool - - Result - - Number - - * - 1 - - High amount of Lines of Code - - Lines of Code (without comments) (generated code is excluded) - - HM - - - - * - 2 - - Cyclomatic complexity - - Static Code Analysis tooling - - NH - - - - * - 3 - - | Test exists / Coverage (Function, Line) - | (maybe better: testability, but how to measure?) - - Existing Tests Coverage - - NH - - - - * - 4 - - High amount of public function interfaces - - Number of public function interfaces - - NH - - - - * - 5 - - High amount of function parameters - - Number of parameters - - NH - - - - -| (C=1) shall be selected when none of the determined complexity measures indicate HM or NM. -| (C=2) shall be selected when at least one of the determined complexity measures indicate HM or NM, but the gaps evaluated are acceptable, means -| the risk of systematic faults due to these gaps is sufficiently low in the context of the project or manageable by mitigating the gaps. -| (C=3) in all other cases. -| - -lola is determined as C=2 - - -Step 3: Determine (CLAS_OUT): the classification outcome --------------------------------------------------------- - -| Select CLAS_OUT depending on the determined values of (C) and (P) - -+-------+-----------------------+ -| ( C ) | ( P ) | -+-------+-------+-------+-------+ -| | 1 | 2 | 3 | -+=======+=======+=======+=======+ -| 1 | Q | Q | QR | -+-------+-------+-------+-------+ -| 2 | QR | QR | QR | -+-------+-------+-------+-------+ -| 3 | QR | QR | NQ | -+-------+-------+-------+-------+ - -lola is classified as CLAS_OUT=QR - - -Step 4: Document all results and rationale for choosing (P) and (C) and (CLAS_OUT) ----------------------------------------------------------------------------------- -This document - - -Step 5: Based on (CLAS_OUT) select the activities -------------------------------------------------- - -| As soon as the change request containing this is in status "Accepted", the module safety plan for the component development is adapted based on the following: (select according to above result) -| - Q: Follow the processes for qualification of software components in a safety context. -| - QR: Follow the process for pre-existing software architectural elements -| - NQ: Do no use this element in safety context diff --git a/docs/modules/communication/lola/docs/detailed_design/index.rst b/docs/modules/communication/lola/docs/detailed_design/index.rst deleted file mode 100644 index 4441f0cb90b..00000000000 --- a/docs/modules/communication/lola/docs/detailed_design/index.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Detailed Design -############### - -.. document:: LoLa Detailed Design - :id: doc__lola_detailed_design - :status: draft - :version: 1 - :safety: ASIL_B - :security: YES - :realizes: wp__sw_implementation[version==1] - -Detailed Design for Component: LoLa -=================================== - -Description ------------ - -Detailed Design is presented in `lola/design `_ diff --git a/docs/modules/communication/lola/docs/index.rst b/docs/modules/communication/lola/docs/index.rst deleted file mode 100644 index 7eff61a2db9..00000000000 --- a/docs/modules/communication/lola/docs/index.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - - -LoLa -#### - -.. note:: Document header - -.. document:: LoLa - :id: doc__lola - :status: draft - :version: 1 - :safety: ASIL_B - :security: YES - :realizes: wp__cmpt_request[version==1] - - -As the component implements the complete feature :need:`doc__com_ipc`, there is currently nothing to add here. - -.. toctree:: - :hidden: - - requirements/index.rst - architecture/index.rst - detailed_design/index.rst - safety_analysis/fmea.rst - safety_analysis/dfa.rst - component_classification.rst diff --git a/docs/modules/communication/lola/docs/requirements/index.rst b/docs/modules/communication/lola/docs/requirements/index.rst deleted file mode 100644 index a4d633705ce..00000000000 --- a/docs/modules/communication/lola/docs/requirements/index.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Requirements -############ - -.. document:: LoLa Requirements - :id: doc__lola_requirements - :status: draft - :version: 1 - :safety: ASIL_B - :security: YES - :realizes: wp__requirements_comp[version==1] - - -LoLa component requirements -=========================== - -see `LoLa trlc `_ - -LoLa component Assumptions of Use -================================= - -.. needextend:: is_external == False and "lola" in id - :+tags: lola diff --git a/docs/modules/communication/lola/docs/safety_analysis/dfa.rst b/docs/modules/communication/lola/docs/safety_analysis/dfa.rst deleted file mode 100644 index 7febd6fc8e0..00000000000 --- a/docs/modules/communication/lola/docs/safety_analysis/dfa.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - - -DFA (Dependent Failure Analysis) -================================ - -.. document:: lola DFA - :id: doc__lola_dfa - :status: draft - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__sw_component_dfa[version==1] - - -Dependent Failure Initiators ----------------------------- - -.. code-block:: rst - - .. comp_saf_dfa:: - :violates: <Component architecture> - :id: comp_saf_dfa__<Component>__<Element descriptor> - :failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`> - :failure_effect: "description of failure effect of the failure initiator on the element" - :mitigated_by: <ID from Component Requirement | ID from AoU Component Requirement> - :mitigation_issue: <ID from Issue Tracker> - :sufficient: <yes|no> - :status: <valid|invalid> - -.. note:: argument is inside the 'content'. Therefore content is mandatory - -.. attention:: - The above directive must be updated according to your component DFA. - - - The above "code-block" directive must be updated - - Fill in all the needed information in the <brackets> diff --git a/docs/modules/communication/lola/docs/safety_analysis/fmea.rst b/docs/modules/communication/lola/docs/safety_analysis/fmea.rst deleted file mode 100644 index d1d178c7fda..00000000000 --- a/docs/modules/communication/lola/docs/safety_analysis/fmea.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - - -FMEA (Failure Modes and Effects Analysis) -========================================= - -.. document:: lola FMEA - :id: doc__lola_fmea - :status: draft - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__sw_component_fmea[version==1] - - -Failure Mode List ------------------ - -.. code-block:: rst - - .. comp_saf_fmea:: <Title> - :violates: <Component architecture> - :id: comp_saf_fmea__<Component>__<Element descriptor> - :fault_id: <ID from fault model :need:`gd_guidl__fault_models`> - :failure_effect: "description of failure effect of the fault model on the element" - :mitigated_by: <ID from Component Requirement | ID from AoU Component Requirement> - :mitigation_issue: <ID from Issue Tracker> - :sufficient: <yes|no> - :status: <valid|invalid> - -.. note:: argument is inside the 'content'. Therefore content is mandatory - -.. attention:: - The above directive must be updated according to your component FMEA. - - - The above "code-block" directive must be updated - - Fill in all the needed information in the <brackets> diff --git a/docs/modules/communication/message_passing/docs/architecture/index.rst b/docs/modules/communication/message_passing/docs/architecture/index.rst deleted file mode 100644 index 32538eab54d..00000000000 --- a/docs/modules/communication/message_passing/docs/architecture/index.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Message Passing Component Architecture -************************************** - -.. comp:: Message Passing - :id: comp__com_message_passing - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :implements: logic_arc_int__com__message_passing[version==1] - :uses: logic_arc_int__os__message_passing[version==1] - :belongs_to: feat__baselibs[version==1] - - .. needarch:: - :scale: 50 - :align: center - - {{ draw_component(need(), needs) }} - - -.. logic_arc_int:: Message Passing - :id: logic_arc_int__com__message_passing - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - -.. logic_arc_int_op:: Send Message - :id: logic_arc_int_op__com__mp_register - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :included_by: logic_arc_int__com__message_passing diff --git a/docs/modules/communication/message_passing/docs/index.rst b/docs/modules/communication/message_passing/docs/index.rst deleted file mode 100644 index 5bf5cee2fcb..00000000000 --- a/docs/modules/communication/message_passing/docs/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -.. _comp_doc_baselib_message_passing: - -message_passing -############### - -.. toctree:: - :hidden: - - architecture/index diff --git a/docs/modules/communication/mock_binding/docs/architecture/index.rst b/docs/modules/communication/mock_binding/docs/architecture/index.rst deleted file mode 100644 index b7b8a47cb8a..00000000000 --- a/docs/modules/communication/mock_binding/docs/architecture/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -Mock Binding Component Architecture -*********************************** - -.. comp:: Mock binding - :id: comp__com_mock_binding - :security: YES - :safety: ASIL_B - :status: valid - :version: 1 - :uses: logic_arc_int__logging__logging[version==1] - :belongs_to: feat__com_communication[version==1] - - .. needarch:: - :scale: 50 - :align: center - - {{ draw_component(need(), needs) }} diff --git a/docs/modules/communication/mock_binding/docs/index.rst b/docs/modules/communication/mock_binding/docs/index.rst deleted file mode 100644 index 4bc8c78d788..00000000000 --- a/docs/modules/communication/mock_binding/docs/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. - # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation - # - # See the NOTICE file(s) distributed with this work for additional - # information regarding copyright ownership. - # - # This program and the accompanying materials are made available under the - # terms of the Apache License Version 2.0 which is available at - # https://www.apache.org/licenses/LICENSE-2.0 - # - # SPDX-License-Identifier: Apache-2.0 - # ******************************************************************************* - -.. _comp_doc_mock_binding: - -mock_binding -############ - -Component Documents -=================== - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - architecture/index