github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-25 06:51:49 +00:00
Code Issues Projects Releases Wiki Activity

doc: terminology cleanup in design guidelines

Browse Source 
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
This commit is contained in:
Amy Reyes 2021-11-12 15:00:04 -08:00 committed by David Kinder
parent 279f129f2d
commit 6c5035f9c1
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/developer-guides/sw_design_guidelines.rst
View File

@ -113,8 +113,8 @@ level are shown below.
**Return error code** **Return error code**
The hypervisor shall return an error code to the VM when the below cases The hypervisor shall return an error code to the VM when the below cases
occur. The error code shall indicate the error type detected (e.g. invalid occur. The error code shall indicate the error type detected (e.g., invalid
parameter, device not found, device busy, resource unavailable, etc). parameter, device not found, device busy, and resource unavailable).
This method applies to the following case: This method applies to the following case:
@ -123,8 +123,8 @@ level are shown below.
**Inform the safety VM through specific register or memory area** **Inform the safety VM through specific register or memory area**
The hypervisor shall inform the safety VM through a specific register or The hypervisor shall inform the safety VM through a specific register or
memory area when the below cases occur. The VM will decide how to handle memory area when the below cases occur. The VM will decide how to handle
the related error. This shall be done only after the VM (Safety OS or the related error. This shall be done only after the VM (Safety VM or
Service OS) dedicated to error handling has started. Service VM) dedicated to error handling has started.
This method applies to the following cases: This method applies to the following cases:
@ -273,7 +273,7 @@ The rules of error detection and error handling on a module level are shown in
| Resource Class | Failure | Error Detection via | Error Handling Policy | Example | | Resource Class | Failure | Error Detection via | Error Handling Policy | Example |
| | Mode | Hypervisor | | | | | Mode | Hypervisor | | |
+====================+===========+============================+===========================+=========================+ +====================+===========+============================+===========================+=========================+
| Internal data of | N/A | Partial. | The hypervisor shall use | virtual PCI device | | Internal data of | N/A | Partial. | The hypervisor shall use | Virtual PCI device |
| the hypervisor | | The related pre-conditions | the internal resource/data| information, defined | | the hypervisor | | The related pre-conditions | the internal resource/data| information, defined |
| | | are required. | directly. | with array | | | | are required. | directly. | with array |
| | | | | ``pci_vdevs[]`` | | | | | | ``pci_vdevs[]`` |
@ -570,7 +570,7 @@ The following table shows some use cases of module level configuration design:
- This module is used to virtualize part of LAPIC functionalities. - This module is used to virtualize part of LAPIC functionalities.
It can be done via APICv or software emulation depending on CPU It can be done via APICv or software emulation depending on CPU
capabilities. capabilities.
For example, KBL Intel NUC doesn't support virtual-interrupt delivery, For example, Kaby Lake NUC doesn't support virtual-interrupt delivery,
while other platforms support it. while other platforms support it.
- If a function pointer is used, the prerequisite is - If a function pointer is used, the prerequisite is
"hv_operation_mode == OPERATIONAL". "hv_operation_mode == OPERATIONAL".