From 1f429aee4faf8d452fffc7e9a6f13aa78f931099 Mon Sep 17 00:00:00 2001 From: FSCHOL2 Date: Thu, 10 Apr 2025 16:04:51 +0200 Subject: [PATCH 1/5] docs: Added Daal Feature request(#864) Added first initial Feature Request --- .gitignore | 4 + docs/features/frameworks/daal/index.rst | 79 +++++++++ .../frameworks/daal/requirements/index.rst | 154 ++++++++++++++++++ docs/features/frameworks/index.rst | 1 + docs/requirements/stakeholder/index.rst | 10 +- 5 files changed, 247 insertions(+), 1 deletion(-) create mode 100644 docs/features/frameworks/daal/index.rst create mode 100644 docs/features/frameworks/daal/requirements/index.rst diff --git a/.gitignore b/.gitignore index 421cd8aaad..9ffbc7ff3b 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,7 @@ styles/ .venv __pycache__/ /.coverage + +# IDE +/.idea* +/.clwb* diff --git a/docs/features/frameworks/daal/index.rst b/docs/features/frameworks/daal/index.rst new file mode 100644 index 0000000000..b7cefe4fcc --- /dev/null +++ b/docs/features/frameworks/daal/index.rst @@ -0,0 +1,79 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + + +Deterministic App Abstraction Layer +-------------------------------------- +.. document:: Deterministic App Abstraction Layer + :id: doc__daal + :status: valid + :safety: ASIL_B + :tags: contribution_request, feature_request + +.. toctree:: + :maxdepth: 2 + :caption: Contents + + requirements/index.rst + +Feature flag +------------ + +To activate this feature, use the following feature flag: + +``experimental_daal`` + +Abstract +-------- + +Provides an application abstraction layer and APIs for testing. +Implements common code and several safety requirements. + + +Motivation +---------- +Currently there is no abstraction layer to make component tests independent from application frameworks like 'Fixed Execution Order Framework'. +With the abstraction layer you can test against different execution frameworks and in different environments (linux & qnx). + +Rationale +--------- + +The lifecycle states are designed like in usual execution frameworks to emulate the same behavior also in testing. +Also error handling and health monitoring is part of the framework for emulation of all aspects. +Different communication frameworks can be plugged in to use in testing. +The idea is also to use the framework as a testing area for our future Autosar process. + + +Backwards Compatibility +----------------------- + +It can have impact in the Feo Framework because we need only one Lifecycle interface. + + +Open Issues +----------- + +[Any points that are still being decided/discussed.] + + .. note:: + While a CR is in draft, ideas can come up which warrant further discussion. + Those ideas should be recorded so people know that they are being thought about but do not have a concrete resolution. + This helps make sure all issues required for the CR to be ready for consideration are complete and reduces people duplicating prior discussion. + + + +Footnotes +--------- + +[A collection of footnotes cited in the CR, and a place to list non-inline hyperlink targets.] diff --git a/docs/features/frameworks/daal/requirements/index.rst b/docs/features/frameworks/daal/requirements/index.rst new file mode 100644 index 0000000000..b27e2b6097 --- /dev/null +++ b/docs/features/frameworks/daal/requirements/index.rst @@ -0,0 +1,154 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + + +Deterministic App Abstraction Layer +-------------------------------------- +.. document:: Deterministic App Abstraction Layer + :id: doc__daal + :status: valid + :safety: ASIL_B + :tags: contribution_request, feature_request + +Feature flag +------------ + +To activate this feature, use the following feature flag: + +``experimental_daal`` + +Abstract +-------- + +Provides an application abstraction layer and APIs for testing. +Implements common code and several safety requirements. + + +Motivation +---------- +Currently there is no abstraction layer to make component tests independent from application frameworks like 'Fixed Execution Order Framework'. +With the abstraction layer you can test against different execution frameworks and in different environments (linux & qnx). + +Rationale +--------- + +The lifecycle states are designed like in usual execution frameworks to emulate the same behavior also in testing. +Also error handling and health monitoring is part of the framework for emulation of all aspects. +Different communication frameworks can be plugged in to use in testing. +The idea is also to use the framework as a testing area for our future Autosar process. + + +Backwards Compatibility +----------------------- + +It can have impact in the Feo Framework because we need only one Lifecycle interface. + + +Requirements +------------ +Requirements +############ + +General +================================ + +.. feat_req:: Support for Time-based Architecture + :id: feat_req__daal__time_based_arch + :reqtype: Functional + :security: NO + :safety: QM + :satisfies: stkh_req__app_architectures__support_time + :status: valid + + The daal framework shall provide Trigger to support a time-based architecture. + +.. feat_req:: Lifecycle Interface + :id: feat_req__daal__lifecycle + :reqtype: Functional + :security: NO + :safety: QM + :satisfies: stkh_req__overall_goals__reuse_of_app_soft,stkh_req__execution_model__processes,stkh_req__execution_model__low_power + :status: valid + + Lifecycle of executables should use one generic API + +.. feat_req:: Execution Environments + :id: feat_req__daal__env + :reqtype: Functional + :security: NO + :safety: QM + :satisfies: stkh_req__functional_req__operating_system + :status: valid + + It should be possible to use the framework with all specified os like qnx and linux + + + +.. feat_req:: Communication + :id: feat_req__daal__com + :reqtype: Functional + :security: NO + :safety: QM + :satisfies: stkh_req__app_architectures__support_data + :status: valid + + The communication layer should use the IPC Framework + +.. feat_req:: Logging + :id: feat_req__daal__log + :reqtype: Functional + :security: NO + :safety: QM + :satisfies: stkh_req__functional_req__logging + :status: valid + + Core Logging API should be used + +.. feat_req:: Trigger + :id: feat_req__daal__trigger + :reqtype: Functional + :security: NO + :safety: QM + :satisfies: feat_req__ipc__time_based_arch + :status: valid + + Singe Shot and Cyclic execution should be possible + +.. feat_req:: Health & Error Management + :id: feat_req__daal__health_error + :reqtype: Functional + :security: NO + :safety: QM + :satisfies: stkh_req__execution_model__processes + :status: valid + + Error and Health Management should be availability + + +Open Issues +----------- + +[Any points that are still being decided/discussed.] + + .. note:: + While a CR is in draft, ideas can come up which warrant further discussion. + Those ideas should be recorded so people know that they are being thought about but do not have a concrete resolution. + This helps make sure all issues required for the CR to be ready for consideration are complete and reduces people duplicating prior discussion. + + + +Footnotes +--------- + +[A collection of footnotes cited in the CR, and a place to list non-inline hyperlink targets.] diff --git a/docs/features/frameworks/index.rst b/docs/features/frameworks/index.rst index c6d8efe106..892b4a1993 100644 --- a/docs/features/frameworks/index.rst +++ b/docs/features/frameworks/index.rst @@ -19,3 +19,4 @@ Frameworks .. toctree:: fixed-execution-order/index.rst + daal/index.rst diff --git a/docs/requirements/stakeholder/index.rst b/docs/requirements/stakeholder/index.rst index 341111d729..3ccac38ff9 100644 --- a/docs/requirements/stakeholder/index.rst +++ b/docs/requirements/stakeholder/index.rst @@ -150,7 +150,15 @@ Functional requirements :rationale: This allows portability of platform on POSIX compliant operating systems. :status: valid - The platform shall support operating systems compliant with IEEE Std 1003.1 (2004 Edition or newer) +.. stkh_req:: Logging + :id: stkh_req__functional_req__logging + :reqtype: Functional + :security: NO + :safety: QM + :rationale: This allows portability of platform on POSIX compliant operating systems. + :status: valid + + The platform should have one central logging framework .. stkh_req:: Video subsystem :id: stkh_req__functional_req__video_subsystem From 1d2e621f53b20a1e7eb32fd8047b219e4742c63a Mon Sep 17 00:00:00 2001 From: FScholPer Date: Thu, 24 Apr 2025 15:39:30 +0200 Subject: [PATCH 2/5] docs: Added Daal Feature request(#864) Added first initial Feature Request --- .../frameworks/daal/requirements/index.rst | 48 +------------------ 1 file changed, 1 insertion(+), 47 deletions(-) diff --git a/docs/features/frameworks/daal/requirements/index.rst b/docs/features/frameworks/daal/requirements/index.rst index b27e2b6097..91ee535915 100644 --- a/docs/features/frameworks/daal/requirements/index.rst +++ b/docs/features/frameworks/daal/requirements/index.rst @@ -11,52 +11,6 @@ # # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* - - -Deterministic App Abstraction Layer --------------------------------------- -.. document:: Deterministic App Abstraction Layer - :id: doc__daal - :status: valid - :safety: ASIL_B - :tags: contribution_request, feature_request - -Feature flag ------------- - -To activate this feature, use the following feature flag: - -``experimental_daal`` - -Abstract --------- - -Provides an application abstraction layer and APIs for testing. -Implements common code and several safety requirements. - - -Motivation ----------- -Currently there is no abstraction layer to make component tests independent from application frameworks like 'Fixed Execution Order Framework'. -With the abstraction layer you can test against different execution frameworks and in different environments (linux & qnx). - -Rationale ---------- - -The lifecycle states are designed like in usual execution frameworks to emulate the same behavior also in testing. -Also error handling and health monitoring is part of the framework for emulation of all aspects. -Different communication frameworks can be plugged in to use in testing. -The idea is also to use the framework as a testing area for our future Autosar process. - - -Backwards Compatibility ------------------------ - -It can have impact in the Feo Framework because we need only one Lifecycle interface. - - -Requirements ------------- Requirements ############ @@ -120,7 +74,7 @@ General :reqtype: Functional :security: NO :safety: QM - :satisfies: feat_req__ipc__time_based_arch + :satisfies: stkh_req__execution_model__processes :status: valid Singe Shot and Cyclic execution should be possible From 684afb1fb41a92235a8041335ab47555c228c8c5 Mon Sep 17 00:00:00 2001 From: FScholPer Date: Thu, 12 Jun 2025 16:30:09 +0200 Subject: [PATCH 3/5] docs: fixed warning issue --- docs/features/frameworks/daal/requirements/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/features/frameworks/daal/requirements/index.rst b/docs/features/frameworks/daal/requirements/index.rst index 91ee535915..5c49ca24a1 100644 --- a/docs/features/frameworks/daal/requirements/index.rst +++ b/docs/features/frameworks/daal/requirements/index.rst @@ -11,6 +11,7 @@ # # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* + Requirements ############ From e2cb96956c1e6aa382293b87342a399b07d13764 Mon Sep 17 00:00:00 2001 From: Frank Scholter Peres Date: Thu, 11 Sep 2025 16:19:29 +0200 Subject: [PATCH 4/5] fixed: safety --- docs/features/frameworks/daal/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/features/frameworks/daal/index.rst b/docs/features/frameworks/daal/index.rst index b7cefe4fcc..e1e3b410cc 100644 --- a/docs/features/frameworks/daal/index.rst +++ b/docs/features/frameworks/daal/index.rst @@ -18,7 +18,7 @@ Deterministic App Abstraction Layer .. document:: Deterministic App Abstraction Layer :id: doc__daal :status: valid - :safety: ASIL_B + :safety: QM :tags: contribution_request, feature_request .. toctree:: From 21798af7cd85feb48787d8dafdfd836c793ffab3 Mon Sep 17 00:00:00 2001 From: Frank Scholter Peres Date: Mon, 29 Sep 2025 09:54:31 +0200 Subject: [PATCH 5/5] docs: replaced qm with asil-b --- .../frameworks/daal/requirements/index.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/features/frameworks/daal/requirements/index.rst b/docs/features/frameworks/daal/requirements/index.rst index 5c49ca24a1..14ee3a3e87 100644 --- a/docs/features/frameworks/daal/requirements/index.rst +++ b/docs/features/frameworks/daal/requirements/index.rst @@ -22,7 +22,7 @@ General :id: feat_req__daal__time_based_arch :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL_B :satisfies: stkh_req__app_architectures__support_time :status: valid @@ -32,7 +32,7 @@ General :id: feat_req__daal__lifecycle :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL_B :satisfies: stkh_req__overall_goals__reuse_of_app_soft,stkh_req__execution_model__processes,stkh_req__execution_model__low_power :status: valid @@ -42,7 +42,7 @@ General :id: feat_req__daal__env :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL_B :satisfies: stkh_req__functional_req__operating_system :status: valid @@ -54,7 +54,7 @@ General :id: feat_req__daal__com :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL_B :satisfies: stkh_req__app_architectures__support_data :status: valid @@ -64,7 +64,7 @@ General :id: feat_req__daal__log :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL_B :satisfies: stkh_req__functional_req__logging :status: valid @@ -74,7 +74,7 @@ General :id: feat_req__daal__trigger :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL_B :satisfies: stkh_req__execution_model__processes :status: valid @@ -84,7 +84,7 @@ General :id: feat_req__daal__health_error :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL_B :satisfies: stkh_req__execution_model__processes :status: valid