Skip to content

Commit 4c3f298

Browse files
Xiangyang Wudbkinder
authored andcommitted
doc:add more description about application constraints
In the current design guidlines, it is not clear about how to check application constraints and how to record them. Add description about it is optional to do error checking for application constraints during hypversisor boot time; Add reference about how to record design assumptions. Signed-off-by: Xiangyang Wu <xiangyang.wu@linux.intel.com>
1 parent ae99625 commit 4c3f298

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

doc/developer-guides/c_coding_guidelines.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3245,6 +3245,7 @@ Compliant example::
32453245
*
32463246
* Detailed description of the function. Detailed description of the function. Detailed description of the
32473247
* function. Detailed description of the function.
3248+
* Application Constraints: Detailed description of application constraint.
32483249
*
32493250
* @param param_1 Parameter description for param_1.
32503251
* @param param_2 Parameter description for param_2.

doc/developer-guides/sw_design_guidelines.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@ below:
6464
All application constraints shall be guaranteed by external safety
6565
applications, such as Board Support Package, firmware, safety VM, or Hardware.
6666
The verification of application integration shall check whether the safety
67-
application meets all application constraints.
67+
application meets all application constraints. These constraints must be verified
68+
during hypervisor validation test. It is optional to do error checking for
69+
application constraints at hypervisor boot time.
6870

6971
This design assumption applies to the following cases:
7072

@@ -73,6 +75,12 @@ below:
7375

7476
- Input data which is only specified by external safety application.
7577

78+
.. note:: If input data can be specified by both a non-safety VM and a safety VM,
79+
the application constraint isn't applicable to these data. Related error checking
80+
and handling shall be done during hypervisor design.
81+
82+
Refer to the :ref:`C Programming Language Coding Guidelines <c_coding_guidelines>`
83+
to document these design assumptions with doxygen-style comments.
7684

7785
Architecture Level
7886
==================

0 commit comments

Comments
 (0)