diff --git a/MODULE.bazel b/MODULE.bazel index 31b3576376..6500714ab2 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -29,7 +29,7 @@ bazel_dep(name = "rules_pkg", version = "1.1.0") # Python version # ############################################################################### -bazel_dep(name = "rules_python", version = "1.4.1") +bazel_dep(name = "rules_python", version = "1.8.3") PYTHON_VERSION = "3.12" diff --git a/process/folder_templates/features/feature_name/index.rst b/process/folder_templates/features/feature_name/index.rst index ad2f05483c..44d8a2bc47 100644 --- a/process/folder_templates/features/feature_name/index.rst +++ b/process/folder_templates/features/feature_name/index.rst @@ -23,7 +23,7 @@ :id: doc__feature_name :status: draft :safety: ASIL_B - :security: NO + :security: YES :realizes: wp__feat_request :tags: template @@ -33,7 +33,7 @@ - Modify ``document`` to be your Feature Name - Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` - Adjust ``status`` to be ``valid`` - - Adjust ``safety`` and ``tags`` according to your needs + - Adjust ``safety``, ``security`` and ``tags`` according to your needs Feature flag ============ diff --git a/process/folder_templates/features/feature_name/requirements/index.rst b/process/folder_templates/features/feature_name/requirements/index.rst index 700718d552..fe8b5f6bc6 100644 --- a/process/folder_templates/features/feature_name/requirements/index.rst +++ b/process/folder_templates/features/feature_name/requirements/index.rst @@ -12,8 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Requirements -############ +Feature Requirements +#################### .. document:: [Your Feature Name] Requirements :id: doc__feature_name_requirements @@ -34,25 +34,14 @@ Requirements =================================================================== -.. stkh_req:: Template - :id: stkh_req__requirements__template - :reqtype: Non-Functional - :safety: ASIL_B - :security: YES - :rationale: Exists just for the template example - :status: invalid - - The platform shall ... - -.. attention:: - The above stakeholder requirement must be removed, it just serves as a link target for this template. - .. feat_req:: Some Title :id: feat_req__feature_name__some_title :reqtype: Process - :security: YES + :security: NO :safety: ASIL_B :satisfies: stkh_req__requirements__template + :valid_from: v0.0.1 + :valid_until: v1.0.1 :status: invalid :belongs_to: feat__feature_name @@ -63,7 +52,7 @@ Requirements .. aou_req:: Some Other Title :id: aou_req__feature_name__some_other_title :reqtype: Process - :security: YES + :security: NO :safety: ASIL_B :status: invalid @@ -73,8 +62,13 @@ Requirements The above directives must be updated according to your feature requirements. - Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req_engineering`) - - Set the status to valid and start the review/merge process + - Set ``belongs_to`` with a link to feature ID + - Set ``reqtype`` with a link to the right value () + - Set ``satisfies`` with a link to the right stakeholder requirement + - Adjust ``safety`` and ``security`` to the right value (ASIL B/QM; YES/NO) - Add other needed requirements for your feature + - Adjust ``valid_from`` and ``valid_until`` to the right version numbers + - Set ``status`` to ``valid`` and start the review/merge process .. needextend:: docname is not None and "feature_name" in id :+tags: feature_name diff --git a/process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst b/process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst index 24e835803c..26a26c4eac 100644 --- a/process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst +++ b/process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst @@ -19,7 +19,7 @@ Requirements :id: doc__component_name_requirements :status: draft :safety: ASIL_B - :security: NO + :security: YES :realizes: wp__requirements_comp :tags: template @@ -29,7 +29,7 @@ Requirements - Modify ``Your Component Name`` to be your Component Name - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_requirements`` - Adjust ``status`` to be ``valid`` - - Adjust ``safety`` and ``tags`` according to your needs + - Adjust ``safety``, ``security`` and ``tags`` according to your needs =================================================================== @@ -54,6 +54,9 @@ Component Requirements The above directive must be updated according to your component requirements. - Replace the example content by the real content for your first requirement + - Set ``satistifes`` with links to Feature requirements + - Set ``belongs_to`` with a link to the right Component id + - Set ``safety`` and ``security`` to the right value - Set the status to valid and start the review/merge process - Add other needed requirements for your component @@ -67,7 +70,7 @@ Assumption of Use Requirements :safety: ASIL_B :status: invalid - The Component User shall do xyz to use the component safely + The Component User shall do xyz to use the component safely/securely Environmental Requirements -------------------------- @@ -89,8 +92,10 @@ Hints The above directives must be updated according to your feature requirements. - Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req_engineering`) - - Set the status to valid and start the review/merge process + - Set ``safety`` and ``security`` to the right value (ASIL B/QM; YES/NO) + - Set ``reqtype`` with a link to the right value () - Add other needed requirements for your feature + - Set ``status`` to ``valid`` and start the review/merge process .. needextend:: "component_name" in id :+tags: component_name diff --git a/process/folder_templates/modules/module_name/docs/release/release_note.rst b/process/folder_templates/modules/module_name/docs/release/release_note.rst index 215065943e..728108b2d0 100644 --- a/process/folder_templates/modules/module_name/docs/release/release_note.rst +++ b/process/folder_templates/modules/module_name/docs/release/release_note.rst @@ -122,9 +122,6 @@ Release Note | Contributor 1 | Contributor 2 | - ---- - | Contact Information | ------------------- | diff --git a/process/folder_templates/modules/module_name/docs/security_mgt/index.rst b/process/folder_templates/modules/module_name/docs/security_mgt/index.rst index 49998d3c7b..4d292cc5dc 100644 --- a/process/folder_templates/modules/module_name/docs/security_mgt/index.rst +++ b/process/folder_templates/modules/module_name/docs/security_mgt/index.rst @@ -1,23 +1,23 @@ -.. - # ******************************************************************************* - # 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 - # ******************************************************************************* - -Security Management -################### - -.. toctree:: - :titlesonly: - - module_security_plan - module_security_plan_fdr - module_security_package_fdr +.. + # ******************************************************************************* + # Copyright (c) 2026 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 + # ******************************************************************************* + +Security Management +################### + +.. toctree:: + :titlesonly: + + module_security_plan + module_security_plan_fdr + module_security_package_fdr diff --git a/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst b/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst index 7083f1d80f..5d28ec3831 100644 --- a/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst +++ b/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst @@ -33,7 +33,6 @@ Verification Report - Adjust ``status`` to be ``valid`` - Adjust ``safety`` and ``tags`` according to your needs - This verification report is based on the :need:`gd_temp__verification_plan`. It covers all the components of the above stated module. @@ -86,6 +85,12 @@ Verification Report contains: **5. Software component qualification verification report** - Contains the needed verification results if for some components a qualification of pre-developed SW is performed. +**6. Test results** + - Test result per test case with status passed/failed/not_run + +**7. Test logs** + - Test log per test case with status passed/failed/not_run + **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/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst new file mode 100644 index 0000000000..6e6d134d35 --- /dev/null +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -0,0 +1,121 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Platform Release Note +===================== + +.. note:: Document header + +.. document:: Platform Release Note + :id: doc__platform_release_note + :status: draft + :safety: ASIL_B + :security: NO + :realizes: wp__platform_sw_release_note + :tags: template + + .. attention:: + The above directive must be updated. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + + + +| Release Tag: vX.Y.Z +| Origin Release Tag: vU.V.W +| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 +| Release Date: YYYY-MM-DD +| Safety: [QM | ASIL_B] +| Security: [NO | YES] +| +| Overview +| -------- +| +| This document provides an overview of the changes, improvements, and bug fixes included in the software platform release version vX.Y.Z +| as compared to the platform'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**: Brief description of the new feature. +| - **Feature 2**: Brief description of the new feature. +| - **Feature 3**: Brief description of the new feature. +| +| Improvements +| ------------ +| +| - **Improvement 1**: Brief description of the improvement. +| - **Improvement 2**: Brief description of the improvement. +| - **Improvement 3**: Brief description of the improvement. +| +| Bug Fixes +| --------- +| +| - **Bug 1**: Brief description of the bug fix. +| - **Bug 2**: Brief description of the bug fix. +| - **Bug 3**: Brief description of the bug fix. +| +| Other changes by Label +| ---------------------- +| +| - **Label 1/Refactor 1**: Brief description of the change. +| - **Label 2/Refactor 2**: Brief description of the change. +| - **Label 3/Refactor 3**: Brief description of the change. +| +| Compatibility +| ------------- +| +| - **Dependencies**: List any dependencies and their versions. +| +| Performed Verification +| ---------------------- +| This release note is based on the verification as documented in platform verification report +| :need:`doc__platform_verification_report`. +| +| Known Issues +| ------------ +| +| - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. +| - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. +| - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. +| +| Known Vulnerabilities +| --------------------- +| +| - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. +| - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. +| - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. +| +| Upgrade Instructions +| -------------------- +| +| 1. **Step 1**: Description of the first step. +| 2. **Step 2**: Description of the second step. +| 3. **Step 3**: Description of the third step. +| +| Contributors +| ------------ +| +| Thanks to everyone who contributed to this release: +| +| Contributor 1 +| Contributor 2 +| diff --git a/process/folder_templates/platform/docs/safety_mgt/index.rst b/process/folder_templates/platform/docs/safety_mgt/index.rst new file mode 100644 index 0000000000..2555b037fb --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/index.rst @@ -0,0 +1,26 @@ +.. + # ******************************************************************************* + # Copyright (c) 2026 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: + + platform_dfa + platform_safety_manual + platform_safety_plan_fdr + platform_safety_package_fdr + platform_safety_analysis_fdr + platform_safety_plan diff --git a/process/folder_templates/platform/safety_analysis/platform_dfa.rst b/process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst similarity index 80% rename from process/folder_templates/platform/safety_analysis/platform_dfa.rst rename to process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst index cf86ee24b4..2dafac8c92 100644 --- a/process/folder_templates/platform/safety_analysis/platform_dfa.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst @@ -29,13 +29,6 @@ Platform DFA (Dependent Failure Analysis) .. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram. -.. attention:: - The above directive must be updated according to your Feature. - - - Modify ``Your Feature Name`` to be your Feature Name - - Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and succeeded by ``_dfa`` - - Adjust ``status`` to be ``valid`` - - Adjust ``safety`` and ``tags`` according to your needs Dependent Failure Initiators ---------------------------- @@ -44,10 +37,10 @@ Dependent Failure Initiators .. plat_saf_dfa:: :violates: <Feature architecture> - :id: plat_saf_DFA__<Feature>__<Element descriptor> + :id: plat_saf_DFA__Platform__<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 Feature Requirement | ID from AoU Feature Requirement> + :mitigated_by: <ID from Stakeholder Requirement | ID from AoU Feature Requirement> :mitigation_issue: <ID from Issue Tracker> :sufficient: <yes|no> :status: <valid|invalid> diff --git a/process/folder_templates/platform/safety_planning/platform_safety_analysis_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst similarity index 80% rename from process/folder_templates/platform/safety_planning/platform_safety_analysis_fdr.rst rename to process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst index 0b839e05ba..574350b99f 100644 --- a/process/folder_templates/platform/safety_planning/platform_safety_analysis_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst @@ -1,98 +1,91 @@ -.. - # ******************************************************************************* - # 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 - # ******************************************************************************* - - -Platform Safety Analysis Checklist -================================== - -.. document:: [Your Platform Name] Safety Analysis Checklist - :id: doc__platform_name_safety_analysis_fdr - :status: draft - :safety: ASIL_B - :security: YES - :realizes: wp__fdr_reports - :tags: template - -.. attention:: - The above directive must be updated according to your Platform. - - - Modify ``Your Platform Name`` to be your Platform Name - - Modify ``id`` to be your Platform Name in lower snake case preceded by ``doc__`` and followed by ``_safety _analysis_fdr`` - - Adjust ``status`` to be ``valid`` - - Adjust ``safety``, ``security`` and ``tags`` according to your needs - - -**Purpose** -The purpose of this Safety Analysis (DFA and FMEA) checklist template is to collect the topics to be checked during verification of the Safety Analysis. - -**Conduct** -As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: - -- reviewer: <committer with safety manager skills explicitly named here> - -**Checklist** - -Please note that it is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additional to add in the remarks why it is passed or not passed. In case of "no" an issue link to the issue tracking system has to be added in the last column. See also :ref:`review_concept` for further information about reviews in general and inspection in particular. - -.. list-table:: Safety Analysis Checklist - :header-rows: 1 - :widths: 10,10,30,30,20 - - * - ID - - Safety analysis activity - - Compliant to ISO 26262? - - Reference - - Comment - - * - 1 - - Is it plausible that each potential identified dependent failure that has been identified, will lead to a dependent failure which cause a violation of FFI? - - [YES | NO ] - - :need:`[[title]] <std_req__iso26262__analysis_742>` - - <Rationale for result> - - * - 2 - - Are the failure initiators :need:`[[title]] <gd_guidl__dfa_failure_initiators>` / fault models :need:`[[title]] <gd_guidl__fault_models>` applied? - - [YES | NO ] - - :need:`[[title]] <std_req__iso26262__analysis_744>` - - <Rationale for result> - - * - 3 - - Are measures defined to resolute the identified potential dependent failures? - - [YES | NO ] - - :need:`[[title]] <std_req__iso26262__analysis_746>`, :need:`[[title]] <std_req__iso26262__analysis_747>` - - <Rationale for result> - - * - 4 - - Is the result of the safety analysis indicate if the safety requirements are complied? - - [YES | NO ] - - :need:`[[title]] <std_req__iso26262__analysis_842>` - - <Rationale for result> - - * - 5 - - Are for all not complied safety requirements mitigations defined to resolute the non-compliance? The mitigations shall have a direct influence on the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. - - [YES | NO ] - - :need:`[[title]] <std_req__iso26262__analysis_843>` - - <Rationale for result> - - * - 6 - - Are the mitigations effective and implemented? - - [YES | NO ] - - :need:`[[title]] <std_req__iso26262__analysis_844>` - - <Rationale for result> - - * - 7 - - Are the templates for DFA and/or FMEA used? See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` - - [YES | NO ] - - :need:`[[title]] <std_req__iso26262__analysis_748>`, :need:`[[title]] <std_req__iso26262__analysis_849>`, :need:`[[title]] <std_req__iso26262__analysis_8410>` - - <Rationale for result> +.. + # ******************************************************************************* + # Copyright (c) 2026 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 + # ******************************************************************************* + + +Platform Safety Analysis Formal Review Report +============================================= + +.. document:: Platform Safety Analysis Formal Review Report + :id: doc__platform_safety_analysis_fdr + :status: draft + :safety: ASIL_B + :security: YES + :realizes: wp__fdr_reports + :tags: template + + + +**Purpose** +The purpose of this Safety Analysis (DFA and FMEA) formal review report template is to collect the topics to be checked during verification of the Platform Safety Analysis. + +**Conduct** +As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: + +- reviewer: **<committer with safety manager skills explicitly named here>** + +**Checklist** + +Please note that it is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additional to add in the remarks why it is passed or not passed. In case of "no" an issue link to the issue tracking system has to be added in the last column. See also :ref:`review_concept` for further information about reviews in general and inspection in particular. + +.. list-table:: Safety Analysis Checklist + :header-rows: 1 + :widths: 10,10,30,30,20 + + * - ID + - Safety analysis activity + - Compliant to ISO 26262? + - Reference + - Comment + + * - 1 + - Is it plausible that each potential identified dependent failure that has been identified, will lead to a dependent failure which cause a violation of FFI? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_742>` + - <Rationale for result> + + * - 2 + - Are the failure initiators :need:`[[title]] <gd_guidl__dfa_failure_initiators>` / fault models :need:`[[title]] <gd_guidl__fault_models>` applied? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_744>` + - <Rationale for result> + + * - 3 + - Are measures defined to resolute the identified potential dependent failures? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_746>`, :need:`[[title]] <std_req__iso26262__analysis_747>` + - <Rationale for result> + + * - 4 + - Is the result of the safety analysis indicate if the safety requirements are complied? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_842>` + - <Rationale for result> + + * - 5 + - Are for all not complied safety requirements mitigations defined to resolute the non-compliance? The mitigations shall have a direct influence on the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_843>` + - <Rationale for result> + + * - 6 + - Are the mitigations effective and implemented? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_844>` + - <Rationale for result> + + * - 7 + - Are the templates for DFA and/or FMEA used? See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_748>`, :need:`[[title]] <std_req__iso26262__analysis_849>`, :need:`[[title]] <std_req__iso26262__analysis_8410>` + - <Rationale for result> diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst new file mode 100644 index 0000000000..584590cc74 --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst @@ -0,0 +1,99 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Platform Safety Manual +====================== + +.. note:: Document header + +.. document:: Platform Safety Manual + :id: doc__platform_safety_manual + :status: draft + :safety: ASIL_B + :security: NO + :realizes: wp__platform_safety_manual + :tags: template + +.. attention:: + The above directive must be updated. + + - Adjust ``status`` to be ``valid`` + - Adjust ``tags`` according to your needs + +Introduction/Scope +------------------ +| **<Put here explanatory text introducing origin, scope, rationale, main functionalities, overall description (with special regard on safety); e.g. link to platform architecture picture>** + +Assumed Platform Safety Requirements +------------------------------------ +| For the Platform the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the Platform. I.e. from these all the feature and component requirements implemented are derived. +| **<List here all the stakeholder requirements, with safety not equal to QM. For the platform all are relevant.>** + +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 platform safety concept. +| **<List here all the OS calls the project platform expects to be safe.>** + +List of AoUs expected from the environment the platform 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"]: + 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 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 package. +| Additionally the components of the platform may have additional specific assumptions how they are used. These are part of every module documentation: <link to add>. 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:** + +**Note: Platform safety manual collects all platform wide AoU (have to be fulfilled by the user for any feature).** + +.. 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"]: + results.append(need) + +Safety concept of the SEooC +--------------------------- +| **<Describe here the safety concept incl. which faults are taken care of, reactions of the implemented functions under anomalous operating conditions>** + +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 release notes **<add link to release note>**. + +References +---------- +| **<link to the user manual>** +| **<other links>** diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst new file mode 100644 index 0000000000..497309008c --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst @@ -0,0 +1,71 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Platform Safety Package Formal Review Report +============================================ + +.. note:: Document header + +.. document:: Platform Safety Package Formal Review + :id: doc__platform_safety_package_fdr + :status: draft + :safety: ASIL_B + :security: NO + :realizes: wp__fdr_reports + :tags: template + + +**Purpose** + +The purpose of this review checklist is to report status of the formal review for the platform safety package. + +**Conduct** +As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: + +- reviewer: <committer with safety manager skills explicitly named here> + +**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 ] + - <Rationale for result> + + * - 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 ] + - <Rationale for result> + + * - 4 + - Are the referenced work products in released state, including the process safety audit? + - [YES | NO ] + - <Rationale for result> + + * - 5 + - If safety related deviations from the process or safety concept are documented, are these argued understandably? + - [YES | NO ] + - <Rationale for result> diff --git a/process/folder_templates/platform/safety_planning/platform_safety_plan.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst similarity index 98% rename from process/folder_templates/platform/safety_planning/platform_safety_plan.rst rename to process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst index bc352d7585..937b28e8cb 100644 --- a/process/folder_templates/platform/safety_planning/platform_safety_plan.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst @@ -26,7 +26,7 @@ Platform Safety Planning :tags: template .. attention:: - The above directive must be updated according to your Platform. + The above directive must be updated. - Adjust ``status`` to be ``valid`` - Adjust ``safety``, ``security`` and ``tags`` according to your needs diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst new file mode 100644 index 0000000000..20bcbe5664 --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst @@ -0,0 +1,101 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Platform Safety Plan Formal Review Report +========================================= + +.. note:: Document header + +.. document:: Platform Safety Plan Formal Review + :id: doc__platform_safety_plan_fdr + :status: draft + :safety: ASIL_B + :security: NO + :realizes: wp__fdr_reports + :tags: template + + +**Purpose** + +The purpose of this safety plan formal review checklist is to report status of the review for the platform safety plan. + +**Conduct** +As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: + +- reviewer: <committer with safety manager skills explicitly named here> + +**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 ] + - <Rationale for result> + + * - 2 + - Is impact analysis planned in case of re-use of SW (needed for every release following the first formal release)? + - [YES | NO ] + - <Rationale for result> + + * - 3 + - Does the safety plan define all needed activities for safety management (incl. Confirmation review and Safety Audit)? + - [YES | NO ] + - <Rationale for result> + + * - 4 + - Does the safety plan define all needed activities for System and SW development, integration and verification? + - [YES | NO ] + - <Rationale for result> + + * - 5 + - Does the safety plan define all needed activities for safety analysis and DFA? + - [YES | NO ] + - <Rationale for result> + + * - 6 + - Does the safety plan define all needed activities for supporting processes (incl. tool mgt)? + - [YES | NO ] + - <Rationale for result> + + * - 7 + - Does the safety plan document a responsible for all activities? + - [YES | NO ] + - <Rationale for result> + + * - 8 + - If OSS software components is used, is it planned to be qualified? + - [YES | NO ] + - <Rationale for result> + + * - 9 + - Is a safety manager and a project manager appointed for the project? + - [YES | NO ] + - <Rationale for result> + + * - 10 + - Is safety plan sufficiently linked to the project plan? + - [YES | NO ] + - <Rationale for result> + + * - 11 + - Is safety plan updated iteratively to show the progress? + - [YES | NO ] + - <Rationale for result> diff --git a/process/folder_templates/platform/docs/security_mgt/index.rst b/process/folder_templates/platform/docs/security_mgt/index.rst new file mode 100644 index 0000000000..1b38c1ed0c --- /dev/null +++ b/process/folder_templates/platform/docs/security_mgt/index.rst @@ -0,0 +1,25 @@ +.. + # ******************************************************************************* + # Copyright (c) 2026 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 + # ******************************************************************************* + +Security Management +################### + +.. toctree:: + :titlesonly: + + platform_security_manual.rst + platform_security_analysis_fdr.rst + platform_security_package_fdr.rst + platform_security_plan.rst + platform_security_plan_fdr.rst diff --git a/process/folder_templates/platform/security_analysis/platform_security_analysis_fdr.rst b/process/folder_templates/platform/docs/security_mgt/platform_security_analysis_fdr.rst similarity index 100% rename from process/folder_templates/platform/security_analysis/platform_security_analysis_fdr.rst rename to process/folder_templates/platform/docs/security_mgt/platform_security_analysis_fdr.rst diff --git a/process/folder_templates/platform/security_analysis/platform_security_manual.rst b/process/folder_templates/platform/docs/security_mgt/platform_security_manual.rst similarity index 100% rename from process/folder_templates/platform/security_analysis/platform_security_manual.rst rename to process/folder_templates/platform/docs/security_mgt/platform_security_manual.rst diff --git a/process/folder_templates/platform/security_analysis/platform_security_package_fdr.rst b/process/folder_templates/platform/docs/security_mgt/platform_security_package_fdr.rst similarity index 100% rename from process/folder_templates/platform/security_analysis/platform_security_package_fdr.rst rename to process/folder_templates/platform/docs/security_mgt/platform_security_package_fdr.rst diff --git a/process/folder_templates/platform/security_planning/platform_security_plan.rst b/process/folder_templates/platform/docs/security_mgt/platform_security_plan.rst similarity index 100% rename from process/folder_templates/platform/security_planning/platform_security_plan.rst rename to process/folder_templates/platform/docs/security_mgt/platform_security_plan.rst diff --git a/process/folder_templates/platform/security_planning/platform_security_plan_fdr.rst b/process/folder_templates/platform/docs/security_mgt/platform_security_plan_fdr.rst similarity index 100% rename from process/folder_templates/platform/security_planning/platform_security_plan_fdr.rst rename to process/folder_templates/platform/docs/security_mgt/platform_security_plan_fdr.rst diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst new file mode 100644 index 0000000000..d55617e23f --- /dev/null +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -0,0 +1,67 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Platform Verification Report +============================ + +.. note:: Document header + +.. document:: Platform Verification Report + :id: doc__platform_verification_report + :status: draft + :safety: ASIL_B + :security: YES + :realizes: wp__verification_platform_ver_report + :tags: template + +.. attention:: + The above directive must be updated. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + +This verification report is based on the :need:`wp__verification_plan`. +It covers all the selected features of the SW platform. + +Verification Report contains: + +**1. Verification Coverage** + +**1.1. on Requirements** + - Lists of stakeholder and feature requirements tested by which test case, passed/failed/not_run 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 + - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. + - List of stakeholder requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) + +**1.2. on Architecture** + - List of feature 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 features tested and a separate list of tests for ASIL rated features. + - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) + - The lists may also contain other verification methods + +**2. Safety Analyses Report** + - List of the performed Platform and Feature Safety Analyses, pass/fail with open mitigations + +**3. Test results** + - Test result per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test` + +**4. Test logs** + - Test log per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test` + with status passed/failed/not_run + +**Note1:** The verification report is valid for the platform version tagged together with the report + +**Note2:** All the above lists are generated automatically diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index ea78b48533..ca71b9cf4d 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -1,6 +1,6 @@ .. # ******************************************************************************* - # Copyright (c) 2024 Contributors to the Eclipse Foundation + # Copyright (c) 2026 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -20,12 +20,9 @@ Platform .. toctree:: :hidden: - safety_analysis/platform_dfa.rst requirements/stakeholder/chklst_req_inspection.rst - safety_planning/platform_safety_plan.rst - safety_planning/platform_safety_analysis_fdr.rst - security_analysis/platform_security_manual.rst - security_analysis/platform_security_analysis_fdr.rst - security_analysis/platform_security_package_fdr.rst - security_planning/platform_security_plan.rst - security_planning/platform_security_plan_fdr.rst + requirements/stakeholder/index.rst + docs/release/release_note.rst + docs/safety_mgt/index.rst + docs/security_mgt/index.rst + docs/verification/platform_verification_report.rst diff --git a/process/folder_templates/platform/requirements/stakeholder/index.rst b/process/folder_templates/platform/requirements/stakeholder/index.rst new file mode 100644 index 0000000000..0215408c98 --- /dev/null +++ b/process/folder_templates/platform/requirements/stakeholder/index.rst @@ -0,0 +1,69 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Stakeholder Requirements +######################## + +.. document:: Platform Requirements + :id: doc__platform_name_requirements + :status: draft + :safety: ASIL_B + :security: YES + :realizes: wp__requirements_feat + :tags: template + +.. attention:: + The above directive must be updated. + + - Adjust ``status`` to ``valid`` + - Adjust ``safety``, ``security`` and ``tags`` according to your needs + +<Headlines (for the list of requirements if structuring is needed)> +=================================================================== + +.. stkh_req:: Template + :id: stkh_req__requirements__template + :reqtype: Functional + :safety: ASIL_B + :security: YES + :rationale: <The rationale provides the reason that the requirement is needed.> + :valid_from: v0.0.1 + :valid_until: v1.0.1 + :status: invalid + + The platform shall ... + +.. aou_req:: Some Other Title + :id: aou_req__platform__some_other_title + :reqtype: Interface + :security: YES + :safety: ASIL_B + :status: invalid + + The Platform User shall do xyz to use the platform safely. + +.. attention:: + The above directives must be updated according to platform requirements. + + - Replace the example content by the real content for your requirements (according to :need:`gd_guidl__req_engineering`) + - Set ``safety`` and ``security`` to the right value (ASIL B/QM; YES/NO) + - Set ``valid_from`` and ``valid_until`` to the right milestones + - Set ``reqtype`` with a link to the right value (<Functional|Interface|Process|Non-Functional>) + - Provide the appropriate rationale + - Adjust ``valid_from`` and ``valid_until`` to the right version numbers + - Add other needed requirements for the platform + - Set ``status`` to ``valid`` and start the review/merge process + +.. needextend:: "platform" in id + :+tags: platform diff --git a/process/general_concepts/score_review_concept.rst b/process/general_concepts/score_review_concept.rst index a165b830c4..920a2ff1f1 100644 --- a/process/general_concepts/score_review_concept.rst +++ b/process/general_concepts/score_review_concept.rst @@ -62,7 +62,7 @@ In this project there are inspections on the following work products, which are Note that for test cases also a review checklist is provided for guidance, but no formal inspection is required. The same is true for Safety Analysis and DFA. -The independence of testing respectively of test case review is covered by the use of version managment tool also for the review of test cases. +The independence of testing respectively of test case review is covered by the use of version management tool also for the review of test cases. Which means that at least the test case definition or the test case review is performed by another person as the author of the verified work product (see :need:`gd_req__verification_independence`). diff --git a/process/process_areas/release_management/guidance/release_templates.rst b/process/process_areas/release_management/guidance/release_templates.rst index ea267f09dc..70eb746238 100644 --- a/process/process_areas/release_management/guidance/release_templates.rst +++ b/process/process_areas/release_management/guidance/release_templates.rst @@ -20,78 +20,7 @@ Templates :status: valid :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6 - | Platform Release Notes - | ====================== - | Release Tag: vX.Y.Z - | Origin Release Tag: vU.V.W - | Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 - | Release Date: YYYY-MM-DD - | Safety: [QM | ASIL_B] - | Security: [NO | YES] - | - | Overview - | -------- - | This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z - | as compared to the platform 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 <e.g. S-CORE> project, - | being a non-profit and open source organization, can not take over any liability for its content. - | - | New Features - | ------------ - | - **Feature 1**: Brief description of the new feature. - | - **Feature 2**: Brief description of the new feature. - | - **Feature 3**: Brief description of the new feature. - | - | Improvements - | ------------ - | - **Improvement 1**: Brief description of the improvement. - | - **Improvement 2**: Brief description of the improvement. - | - **Improvement 3**: Brief description of the improvement. - | - | Bug Fixes - | --------- - | - **Bug 1**: Brief description of the bug fix. - | - **Bug 2**: Brief description of the bug fix. - | - **Bug 3**: Brief description of the bug fix. - | - | Integrated Software Modules - | --------------------------- - | - **Module 1**: Version and brief description of the module. Link to Software module release note. - | - **Module 2**: Version and brief description of the module. Link to Software module release note. - | - **Module 3**: Version and brief description of the module. Link to Software module release note. - | - | Performed Verification - | ---------------------- - | This release note is based on the verification as documented in platform verification report - | <add link here> (report derived from template :need:`gd_temp__platform_ver_report`). - | - | Known Issues - | ------------ - | - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. - | - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. - | - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. - | - | Known Vulnerabilities - | --------------------- - | - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. - | - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. - | - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. - | - | Upgrade Instructions - | -------------------- - | - | 1. **Step 1**: Description of the first step. - | 2. **Step 2**: Description of the second step. - | 3. **Step 3**: Description of the third step. - | - | Contact Information - | ------------------- - | - | For any questions or support, please contact the *Project Lead* or raise an issue/discussion. + For the content see here: :need:`doc__platform_release_note` .. gd_temp:: Module Release Note Template diff --git a/process/process_areas/requirements_engineering/guidance/requirements_templates.rst b/process/process_areas/requirements_engineering/guidance/requirements_templates.rst index 37c5564fec..624c3205dd 100644 --- a/process/process_areas/requirements_engineering/guidance/requirements_templates.rst +++ b/process/process_areas/requirements_engineering/guidance/requirements_templates.rst @@ -22,66 +22,28 @@ Templates :status: valid :complies: std_req__iso26262__system_6411, std_req__iso26262__system_6413, std_req__iso26262__support_641, std_req__iso26262__support_6421, std_req__iso26262__support_6425, std_req__aspice_40__SWE-1-BP1 - .. code-block:: rst - - .. stkh_req:: <Title> - :id: stkh_req__<Title> - :reqtype: <Functional|Interface|Process|Non-Functional> - :security: <YES|NO> - :safety: <QM|ASIL_B> - :rational: <The rationale provides the reason that the requirement is needed.> - :valid_from: <milestone version> - :valid_until: <milestone version> - :status: <valid|invalid> + See :need:`stkh_req__requirements__template` .. gd_temp:: Feature Requirements Template :id: gd_temp__req_feat_req :status: valid :complies: std_req__iso26262__support_641, std_req__iso26262__support_6421, std_req__iso26262__support_6425, std_req__aspice_40__SWE-1-BP1 - .. code-block:: rst - - .. feat_req:: <Title> - :id: feat_req__<Feature>__<Title> - :reqtype: <Functional|Interface|Process|Non-Functional> - :security: <YES|NO> - :safety: <QM|ASIL_B> - :satisfies: <link to stakeholder requirement id> - :valid_from: <milestone version> - :valid_until: <milestone version> - :status: <valid|invalid> - :belongs_to: <link to feature id> + See :need:`feat_req__feature_name__some_title` .. gd_temp:: Component Requirements Template :id: gd_temp__req_comp_req :status: valid :complies: std_req__iso26262__support_641, std_req__iso26262__support_6421, std_req__iso26262__support_6425, std_req__iso26262__support_12425, std_req__aspice_40__SWE-1-BP1 - .. code-block:: rst - - .. comp_req:: <Title> - :id: comp_req__<platform|Feature|Component>__<Title> - :reqtype: <Functional|Interface|Process|Non-Functional> - :security: <YES|NO> - :safety: <QM|ASIL_B> - :satisfies: <link to feature requirement id> - :status: <valid|invalid> - :belongs_to: <link to component id> + See :need:`comp_req__component_name__some_title` .. gd_temp:: AoU Requirement Template :id: gd_temp__req_aou_req :status: valid :complies: std_req__iso26262__support_641, std_req__iso26262__support_6421, std_req__iso26262__support_6425, std_req__aspice_40__SWE-1-BP1 - .. code-block:: rst - - .. aou_req:: <Title> - :id: aou_req__<Component>__<Title> - :reqtype: <Functional|Interface|Process|Non-Functional> - :security: <YES|NO> - :safety: <QM|ASIL_B> - :status: <valid|invalid> - :mitigates: <link to safety analysis> + See :need:`aou_req__platform__some_other_title`, :need:`aou_req__feature_name__some_other_title`, :need:`aou_req__component_name__another_title` .. gd_temp:: Process Requirements Template :id: gd_temp__req_process_req diff --git a/process/process_areas/safety_analysis/guidance/safety_analysis_checklist.rst b/process/process_areas/safety_analysis/guidance/safety_analysis_checklist.rst index a5c8e4f419..d7aed9b8f3 100644 --- a/process/process_areas/safety_analysis/guidance/safety_analysis_checklist.rst +++ b/process/process_areas/safety_analysis/guidance/safety_analysis_checklist.rst @@ -25,5 +25,5 @@ Safety Analysis Checklist For the content see here: - - :need:`doc__platform_name_safety_analysis_fdr` (platform) + - :need:`doc__platform_safety_analysis_fdr` (platform) - :need:`doc__module_name_safety_analysis_fdr` (module) diff --git a/process/process_areas/verification/guidance/verification_report_template.rst b/process/process_areas/verification/guidance/verification_report_template.rst index 3f74cdc8b3..dfec446e78 100644 --- a/process/process_areas/verification/guidance/verification_report_template.rst +++ b/process/process_areas/verification/guidance/verification_report_template.rst @@ -30,70 +30,7 @@ Verification Report Templates This document implements :need:`wp__verification_module_ver_report`. - | Place the document header here following the definitions in template - | :need:`gd_temp__documentation`. - | - | This verification report is based on the :need:`wp__verification_plan`. - | It covers all the components of the above stated module. - | - | 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/not_run 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. - | - | **6. Test results** - | - Test result per test case with status passed/failed/not_run - | - | **7. Test logs** - | - Test log per test case with status passed/failed/not_run - - **Note1:** The verification report is valid for the module version tagged together with the report - - **Note2:** All the above lists are generated automatically + | For the content, see :need:`doc__module_name_verification_report`. .. gd_temp:: Platform Verification Report Template :id: gd_temp__platform_ver_report @@ -104,43 +41,4 @@ Verification Report Templates This document implements :need:`wp__verification_platform_ver_report`. - | Place the document header here following the definitions in template - | :need:`gd_temp__documentation`. - | - | This verification report is based on the :need:`wp__verification_plan`. - | It covers all the selected features of the SW platform. - | - | Verification Report contains: - | - | **1. Verification Coverage** - | - | **1.1. on Requirements** - | - Lists of feature requirements tested by which test case, passed/failed/not_run 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 - | - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. - | - List of feature requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - | - | **1.2. on Architecture** - | - List of feature 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 features tested and a separate list of tests for ASIL rated features. - | - List of feature architecture 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 Feature DFA, pass/fail with open mitigations - | - | **3. Safety Analysis Report** - | - List of the performed Feature Safety Analysis, pass/fail with open mitigations - | - | **4. Test results** - | - Test result per test case with status passed/failed/not_run - | - | **5. Test logs** - | - Test log per test case with status passed/failed/not_run - - **Note1:** The verification report is valid for the platform version tagged together with the report - - **Note2:** All the above lists are generated automatically + | For the content, see :need:`doc__platform_verification_report`.