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
3 changes: 2 additions & 1 deletion docs/features/time/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
.. _time_feature:

Time
#############
####

.. document:: Time
:id: doc__time
Expand All @@ -35,6 +35,7 @@ Time

architecture/index
requirements/index
requirements/aou_req

Feature flag
============
Expand Down
40 changes: 40 additions & 0 deletions docs/features/time/requirements/aou_req.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

# *******************************************************************************
# 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
# *******************************************************************************

.. document:: Time Assumption of Use Requirements
:id: doc__feature_time_aou_reqs
:status: draft
:version: 1
:security: NO
:safety: ASIL_B
:realizes: wp__requirements_feat_aou[version==1]

Time Feature Assumption of Use Requirements
===========================================

.. aou_req:: Vehicle time end-to-end integrity
:id: aou_req__feature__veh_time_e2e_integrity
:reqtype: Non-Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1

If the system using the S-CORE Time feature has the safety goal to achive end-to-end integrity of
the vehicle time information, the involved external components (like grand master clock, any
intermediate master clock, and time-aware bridges/switches) must support respective measures for
the integrity protection.

Note: If this assumption is violated, the data integrity level of the vehicle time information will fall
back to QM and must be marked accordingly in the respective project documentation.
30 changes: 19 additions & 11 deletions docs/features/time/requirements/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,20 +56,25 @@ Time Synchronization
:id: feat_req__time__vehicle_time_time_api
:reqtype: Functional
:security: NO
:safety: QM
:safety: ASIL_B
:derived_from: stkh_req__time__vehicle_time_api[version==1]
:satisfied_by: feat__time[version==1]
:status: valid
:version: 1
:valid_from: v1.0.0

The **score::time feature** shall provide an API to access the synchronized vehicle time.
Usage of this API shall be free from interferences for the consuming components.

Note (providing tracebility as long as safety analysis is not available):
:need:`feat_req__time__vehicle_time_time_api` requires backing by :need:`aou_req__feature__veh_time_e2e_integrity`
to guarantee end-to-end data integrity.

.. feat_req:: Vehicle Time base accuracy qualifier
:id: feat_req__time__vehicle_time_acc_qual_api
:reqtype: Functional
:security: NO
:safety: QM
:safety: ASIL_B
:derived_from: stkh_req__time__vehicle_time_api[version==1]
:satisfied_by: feat__time[version==1]
:status: valid
Expand Down Expand Up @@ -101,9 +106,9 @@ Time Synchronization

.. feat_req:: Vehicle Time control flow
:id: feat_req__time__vehicle_time_ctrl_flow
:reqtype: Functional
:reqtype: Non-Functional
:security: NO
:safety: QM
:safety: ASIL_B
:derived_from: stkh_req__time__vehicle_time_api[version==1]
:satisfied_by: feat__time[version==1]
:status: valid
Expand Down Expand Up @@ -165,6 +170,7 @@ Time Synchronization to absolute external sources
:valid_from: v1.0.0

The **score::time feature** shall provide an API to read the absolute time base, synchronized to external time sources.
Usage of this API shall be free from interferences for the consuming components.

.. feat_req:: Absolute Time base accuracy qualifier
:id: feat_req__time__abs_acc_qual
Expand Down Expand Up @@ -231,35 +237,37 @@ Time Synchronization to absolute external sources
Local Clock
^^^^^^^^^^^^^^^^^^^^

.. feat_req:: High precision clock API
:id: feat_req__time__high_prec_clock_api
.. feat_req:: High resolution clock API
:id: feat_req__time__high_res_clock_api
:reqtype: Functional
:security: NO
:safety: QM
:derived_from: stkh_req__time__high_precision_clock_api[version==1]
:safety: ASIL_B
:derived_from: stkh_req__time__high_res_clock_api[version==1]
:satisfied_by: feat__time[version==1]
:status: valid
:version: 1
:valid_from: v1.0.0

The **score::time feature** shall provide an API to read the high precision clock in nanoseconds precision.
The **score::time feature** shall provide an API to read the high resolution clock in nanoseconds resolution.
Comment thread
pawelrutkaq marked this conversation as resolved.
Usage of this API shall be free from interferences for the consuming components.

Note: to which clock the high precision clock is mapped, depends on the system design.
Note: to which clock the high resolution clock is mapped, depends on the system design.

*Use case:* such clocks might be used for time-critical applications, such as audio/video streaming, event logging, and diagnostics.

.. feat_req:: Monotonic clock API
:id: feat_req__time__monotonic_clock_api
:reqtype: Functional
:security: NO
:safety: QM
:safety: ASIL_B
:derived_from: stkh_req__time__monotonic_clock_api[version==1]
:satisfied_by: feat__time[version==1]
:status: valid
:version: 1
:valid_from: v1.0.0

The **score::time feature** shall provide an API to read monotonic, not adjustable clock value.
Usage of this API shall be free from interferences for the consuming components.

Testability
^^^^^^^^^^^^
Expand Down
16 changes: 16 additions & 0 deletions docs/requirements/platform_assumptions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -435,3 +435,19 @@ In this section assumptions are described which need to be fulfilled by the syst
- C library
- math library
- high precision time source (HW synchronized)

.. aou_req:: Vehicle time end-to-end integrity
:id: aou_req__platform__veh_time_e2e_integrity
:reqtype: Non-Functional
:security: NO
:safety: ASIL_B
:status: valid
:version: 1
:tags: environment

If the system using the SW-platform has the safety goal to achive end-to-end integrity of the vehicle time
information, the involved external components (like the grand master clock, any intermediate master clock,
and time-aware bridges/switches) must support respective measures for the integrity protection.

Note: If this assumption is violated, the data integrity level of the vehicle time information will fall
back to QM and must be marked accordingly in the respective project documentation.
45 changes: 30 additions & 15 deletions docs/requirements/stakeholder/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Dependability

.. stkh_req:: Automotive Safety Integrity Level
:id: stkh_req__dependability__automotive_safety
:reqtype: Functional
:reqtype: Non-Functional
Comment thread
BjoernAtBosch marked this conversation as resolved.
:security: NO
:safety: ASIL_B
:rationale: The SW-platform shall be usable by safety relevant applications.
Expand Down Expand Up @@ -867,25 +867,29 @@ Time
:reqtype: Functional
:security: NO
:safety: QM
:rationale: Enables the system to compare events chronologically.
:rationale: Enables the system to compare in-vehicle events chronologically.
:status: valid
:version: 1
:valid_from: v1.0.0

The SW-platform shall provide a time synchronization framework to synchronize its clock
to Time Master within the vehicle.
The SW-platform shall provide a framework to synchronize its local vehicle clock representation to a Time Master within the vehicle.

.. stkh_req:: Vehicle Time base API
:id: stkh_req__time__vehicle_time_api
:reqtype: Functional
:security: NO
:safety: QM
:safety: ASIL_B
:rationale: Enables an application to correlate its data with a vehicle-internal time reference for event timestamp and chronological events comparison.
:status: valid
:version: 1
:valid_from: v1.0.0

The SW-platform shall provide access to synchronized vehicle time.
The SW-platform shall provide access to the synchronized vehicle time.
Access shall be free from interferences for the consuming components.

Comment thread
BjoernAtBosch marked this conversation as resolved.
Note (providing tracebility as long as safety analysis is not available):
:need:`stkh_req__time__vehicle_time_api` requires backing by :need:`aou_req__platform__veh_time_e2e_integrity`
to guarantee end-to-end data integrity.

.. stkh_req:: Synchronize the HW clock with Vehicle Time
:id: stkh_req__time__hw_clock_sync
Expand All @@ -904,12 +908,12 @@ Time
:reqtype: Functional
:security: YES
:safety: QM
:rationale: Enables the system to validate a certificate or token with temporal validity conditions, adding a UTC-timestamp to a data set.
:rationale: Enables the system to validate a certificate or token with temporal validity conditions, to add a UTC-timestamp to a data set, etc.
:status: valid
:version: 1
:valid_from: v1.0.0

The SW-platform shall provide a framework to synchronize the clock to external-to-vehicle absolute time base (UTC).
The SW-platform shall provide a framework to synchronize its local absolute clock representation to an external-to-vehicle absolute time base (e.g. UTC).

.. stkh_req:: Absolute time base API
:id: stkh_req__time__absolute_time_api
Expand All @@ -922,39 +926,50 @@ Time
:valid_from: v1.0.0

The SW-platform shall provide access to the absolute time base, synchronized with external time sources.
Access shall be free from interferences for the consuming components.

.. stkh_req:: Local High precision Clock API
:id: stkh_req__time__high_precision_clock_api
.. stkh_req:: Local High Resolution Clock API
:id: stkh_req__time__high_res_clock_api
:reqtype: Functional
:security: NO
:safety: QM
:safety: ASIL_B
:rationale: Enables an application to get the current system time, which is essential for time-sensitive operations and event scheduling, via common, mockable and standardized API.
:status: valid
:version: 1
:valid_from: v1.0.0

The SW-platform shall provide access to the current high precision clock from the system time provider in nanoseconds.
The SW-platform shall provide access to the current high resolution clock from the system time provider in nanoseconds.
Access shall be free from interferences for the consuming components.

Note: to which clock the high precision clock is mapped, depends on the system design.
Note: to which clock the high resolution clock is mapped, depends on the system design.
Comment thread
BjoernAtBosch marked this conversation as resolved.

Note (allowing tracebility as long as safety analysis is not available):
:need:`stkh_req__time__high_res_clock_api` requires backing by :need:`aou_req__platform__os_safety_functions`
to guarantee FFI and clock data integrity on OS and HW level.

.. stkh_req:: Local Monotonic Clock API
:id: stkh_req__time__monotonic_clock_api
:reqtype: Functional
:security: NO
:safety: QM
:safety: ASIL_B
:rationale: Enables an application to get the current system time, which is essential for time-sensitive operations and event scheduling, via common, mockable and standardized API.
:status: valid
:version: 1
:valid_from: v1.0.0

The SW-platform shall provide access to the current monotonic clock from the system time provider.
Access shall be free from interferences for the consuming components.

Note: to which clock the monotonic clock is mapped, depends on the system design.

Note (allowing tracebility as long as safety analysis is not available):
:need:`stkh_req__time__monotonic_clock_api` requires backing by :need:`aou_req__platform__os_safety_functions`
to guarantee FFI and clock data integrity on OS and HW level.


AI SW-platform
--------------


.. stkh_req:: On-board ML Workloads
:id: stkh_req__ai_platform__enablement
:reqtype: Functional
Expand Down
Loading