diff --git a/docs/features/time/docs/requirements/index.rst b/docs/features/time/docs/requirements/index.rst index 5e794bc9438..122ae03d61d 100644 --- a/docs/features/time/docs/requirements/index.rst +++ b/docs/features/time/docs/requirements/index.rst @@ -56,7 +56,7 @@ 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 @@ -64,6 +64,7 @@ Time Synchronization :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. .. feat_req:: Vehicle Time base accuracy qualifier :id: feat_req__time__vehicle_time_acc_qual_api @@ -84,6 +85,24 @@ Time Synchronization * are there any instabilities, like time jumps to the past or to the future * does the time increase in a monotonic manner. +.. feat_req:: Reliability of Vehicle Time base accuracy qualifier + :id: feat_req__time__veh_time_reliable_accur_qual + :reqtype: Non-Functional + :security: NO + :safety: ASIL_B + :derived_from: stkh_req__time__qualified_time_information + :satisfied_by: feat__time[version==1] + :status: valid + :version: 1 + :valid_from: v1.0.0 + + The architecture and implementation parts of the time feature shall support to ensure, + that the provided accuracy qualifier always reflects the actual quality of the local time base. + + Note: + * This does not apply to willful interferences by malicious software components or components in control by malicious actors, which are out of scope of this requirement. + * The end-to-end quality of the time information provided by the time base API requires components and protocols outside of the scope of this SW-platform to be qualified accordingly (e.g. the respective time master) or at least support this requirement (e.g. time-aware bridges/switches supporting end-to-end protection extensions of gPTP). + .. feat_req:: Vehicle Time base time point qualifier :id: feat_req__time__vehicle_time_time_pt_qual :reqtype: Functional @@ -101,7 +120,7 @@ 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 :derived_from: stkh_req__time__vehicle_time_api[version==1] @@ -157,7 +176,7 @@ Time Synchronization to absolute external sources :id: feat_req__time__abs_base_api :reqtype: Functional :security: YES - :safety: QM + :safety: ASIL_B :derived_from: stkh_req__time__absolute_time_api[version==1] :satisfied_by: feat__time[version==1] :status: valid @@ -165,6 +184,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 @@ -231,20 +251,21 @@ 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. + 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. @@ -252,7 +273,7 @@ Local Clock :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 @@ -260,6 +281,7 @@ Local Clock :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 ^^^^^^^^^^^^ diff --git a/docs/requirements/stakeholder/index.rst b/docs/requirements/stakeholder/index.rst index 807e8a38c1e..4fd950de975 100644 --- a/docs/requirements/stakeholder/index.rst +++ b/docs/requirements/stakeholder/index.rst @@ -261,7 +261,7 @@ Dependability .. stkh_req:: Automotive Safety Integrity Level :id: stkh_req__dependability__automotive_safety - :reqtype: Functional + :reqtype: Non-Functional :security: NO :safety: ASIL_B :rationale: The SW-platform shall be usable by safety relevant applications. @@ -867,25 +867,25 @@ 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. .. stkh_req:: Synchronize the HW clock with Vehicle Time :id: stkh_req__time__hw_clock_sync @@ -904,57 +904,76 @@ 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 :reqtype: Functional :security: YES - :safety: QM + :safety: ASIL_B :rationale: Enables an application to correlate its data with an absolute vehicle-external time reference for event timestamping and chronological events comparison. :status: valid :version: 1 :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:: Reliable Qualification of Time Information + :id: stkh_req__time__qualified_time_information + :reqtype: Non-Functional + :security: NO + :safety: ASIL_B + :rationale: Depending on the user needs and their SW platform configuration, it can be guaranteed that applications can rely on the quality rating of the time reference of a certain time base, even in case of interferences induced into or by QM-rated software components involved in the synchronization process. + :status: valid + :version: 1 + :valid_from: v1.0.0 + + The architecture and common implementation parts of the time synchronization framework shall support to ensure, that the provided qualification information of a synchronized time base always reflects the actual quality of the provided time (stamp) information. + + Note: + * This does not apply to willful interferences by malicious software components or components in control by malicious actors, which are out of scope of this requirement. + * The end-to-end quality of the time information provided by the time base API requires components and protocols outside of the scope of this SW-platform to be qualified accordingly (e.g. the respective time master) or at least support this requirement (e.g. time-aware bridges/switches supporting end-to-end protection extensions of gPTP). + +.. 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. .. 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. + AI SW-platform -------------- - .. stkh_req:: On-board ML Workloads :id: stkh_req__ai_platform__enablement :reqtype: Functional