KhronosGroup / KhronosGroup/KSCAF_DocRequirements

System-interaction details

Open
#39 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
4
Forks
2
PR merge metrics
No merged PRs in 30d

Description

**SC profile shall discuss API system-interaction details as much as needed to ensure safety**

Rationale: Safety environment places additional requirements on the interaction between the API implementation and other system components, when compared to non-safety environment. If the impact of these additional requirements is not taken into account and discussed as needed in the SC profile, the profile may inadvertently define functions, data structures or procedures which are infeasible to implement in the safety environment.

Example: Function `Handle getObjectHandle(uint16_t i)` is defined such that it returns handle to object with index `i` within a pool of objects. Since safety-critical execution typically requires minimal memory allocation, it is expected that the objects will be allocated before the API implementation is started. To ensure feasible implementation of the mentioned function, API has to specify that the system has to guarantee availability of certain number of objects in the pool at any time during system operation.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the SC profile requirements and the API system-interaction rationale in this issue. Define what interaction details must be documented for safety-critical feasibility, using the object-handle example as a guide; the work is done when the requirement addresses these details and their implementation constraints clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.