Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions docs/modules/baselibs/docs/manual/safety_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,30 @@ Safety Manual

Introduction/Scope
------------------
| <Describe here which module (or the platform) is covered by this manual.>

This is the safety manual for baselibs module which is a collection of several utilities of common use.

Assumed Platform Safety Requirements
------------------------------------
| For the <Project platform / module name> the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the <Project platform / module name>. 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, the module's components requirements are derived from.>

For the Baselibs module the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the module. I.e. from these all the feature and component requirements implemented are derived.

- :need:`stkh_req__functional_req__base_libraries` - is QM, but some of the libraries combine this with the next requirement
- :need:`stkh_req__dependability__automotive_safety`
- :need:`stkh_req__dev_experience__prog_languages` - is QM, but some of the libraries combine this with the previous requirement

This means that not all baselibs libraries and language API are provided in ASIL B.
So for Baselibs the definition of the assumed safety requirement(s) of each of the ASIL B libraries are defined in the following feature requirements:

- bitmanipulation library: :need:`feat_req__baselibs__bitmanipulation`
- concurrency library: :need:`feat_req__baselibs__concurrency_library`
- containers library: :need:`feat_req__baselibs__containers_library`
- filesystem library: :need:`feat_req__baselibs__filesystem_library`
- flatbuffers library: :need:`feat_req__baselibs__flatbuffers_library`
- json library: :need:`feat_req__baselibs__json_library`
- memory library: :need:`feat_req__baselibs__memory_library`
- result library: :need:`feat_req__baselibs__result_library`
- safecpp, static_reflection_with_serialization, utils :need:`feat_req__baselibs__core_utilities`

Assumptions of Use
------------------
Expand Down
16 changes: 12 additions & 4 deletions docs/modules/communication/docs/manual/safety_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,19 @@ 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.
| <List here all the stakeholder requirements, with safety not equal to QM, the module's components requirements are derived from.>

.. attention::
This section is currently missing.
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
------------------
Expand Down
8 changes: 6 additions & 2 deletions docs/modules/feo/docs/manual/safety_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,12 @@ For now it only contains Assumptions of Use related to the use of Rust libraries

Assumed Platform Safety Requirements
------------------------------------
For <S-CORE platform / FEO> the following safety related stakeholder requirements are assumed to define the top level functionality (purpose)>. 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, the module's components requirements are derived from.>
For FEO module the following safety related stakeholder requirements are assumed to define the top level functionality (purpose). I.e. from these all the feature and component requirements implemented are derived.

- :need:`stkh_req__app_architectures__support_time`
- :need:`stkh_req__app_architectures__support_data`
- :need:`stkh_req__dependability__safety_features_1`
- :need:`stkh_req__dependability__safety_features_4`

Assumptions of Use
------------------
Expand Down
11 changes: 8 additions & 3 deletions docs/modules/orchestrator/docs/manual/safety_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,17 @@ Safety Manual

Introduction/Scope
------------------
| <Describe here which module (or the platform) is covered by this manual.>
This safety manual covers the orchestrator module.

Assumed Platform Safety Requirements
------------------------------------
| For the <Project platform / module name> the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the <Project platform / module name>. 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, the module's components requirements are derived from.>
For the orchestrator module name the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the module. I.e. from these all the feature and component requirements implemented are derived.

- :need:`stkh_req__execution_model__processes` - this requirement is QM and not fully covered as ASIL, only combined with the following requirements
- :need:`stkh_req__dependability__automotive_safety`
- :need:`stkh_req__app_architectures__support_time`

The user needs to check orchestration feature level requirements to see which functionalities are provided as ASIL B.

Assumptions of Use
------------------
Expand Down
4 changes: 3 additions & 1 deletion docs/safety/platform_safety_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,6 @@ References

`FEO Safety Manual <https://eclipse-score.github.io/score/main/modules/feo/docs/manual/safety_manual.html>`_

`KVS Safety Manual <https://eclipse-score.github.io/persistency/main/persistency/manual/safety_manual.html>`_
`KVS Safety Manual <https://eclipse-score.github.io/persistency/main/docs/manual/safety_manual.html>`_

`Orchestrator Safety Manual <https://eclipse-score.github.io/score/main/modules/orchestrator/docs/manual/safety_manual.html>`_
Loading