github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-20 12:42:54 +00:00
Code Issues Projects Releases Wiki Activity

doc: update configuration tool description of vuarts

Browse Source 
Acrn introduces pci based vuart. Update the existing vuarts and add the
pci based vuart description

1. rename existing vuarts to legacy_vuart
2. add console and communication vuarts general desciption
  - the console vuart is similar to legacy_vuart0 but only contains subtag "base"
  - the communication vuart is similar to legacy_vuart1 but only contains subtags
    "base", "target_vm_id" and "target_uart_id"

Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
Yang,Yu-chu 2020-11-19 10:55:09 -08:00 committed by David Kinder
parent 4a4f97525c
commit 73cd9e939c
1 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/tutorials/acrn_configuration_tool.rst
View File

@ -110,6 +110,9 @@ Additional scenario XML elements:
``SERIAL_CONSOLE`` (a child node of ``DEBUG_OPTIONS``): ``SERIAL_CONSOLE`` (a child node of ``DEBUG_OPTIONS``):
Specify the host serial device is used for hypervisor debugging. Specify the host serial device is used for hypervisor debugging.
This configuration is valid only if Service VM ``legacy_vuart0``
is enabled. Leave this field empty if Service VM ``console_vuart``
is enabled. Using ``bootargs`` for ``console_vuart`` configuration.
``MEM_LOGLEVEL`` (a child node of ``DEBUG_OPTIONS``): ``MEM_LOGLEVEL`` (a child node of ``DEBUG_OPTIONS``):
Specify the default log level in memory. Specify the default log level in memory.
@ -294,7 +297,7 @@ Additional scenario XML elements:
``bootargs`` (a child node of ``os_config``): ``bootargs`` (a child node of ``os_config``):
For internal use only and is not configurable. Specify the kernel boot arguments For internal use only and is not configurable. Specify the kernel boot arguments
in bootargs under the parent of board_private. in ``bootargs`` under the parent of ``board_private``.
``kern_load_addr`` (a child node of ``os_config``): ``kern_load_addr`` (a child node of ``os_config``):
The loading address in host memory for the VM kernel. The loading address in host memory for the VM kernel.
@ -302,27 +305,45 @@ Additional scenario XML elements:
``kern_entry_addr`` (a child node of ``os_config``): ``kern_entry_addr`` (a child node of ``os_config``):
The entry address in host memory for the VM kernel. The entry address in host memory for the VM kernel.
``vuart``: ``legacy_vuart``:
Specify the vUART (aka COM) with the vUART ID by its ``id`` attribute. Specify the vUART (aka COM) with the vUART ID by its ``id`` attribute.
Refer to :ref:`vuart_config` for detailed vUART settings. Refer to :ref:`vuart_config` for detailed vUART settings.
``type`` (a child node of ``vuart``): ``console_vuart``:
Specify the console vUART (aka PCI based vUART) with the vUART ID by
its ``id`` attribute.
Refer to :ref:`vuart_config` for detailed vUART settings.
``communication_vuart``:
Specify the communication vUART (aka PCI based vUART) with the vUART ID by
its ``id`` attribute.
Refer to :ref:`vuart_config` for detailed vUART settings.
``type`` (a child node of ``legacy_vuart``):
vUART (aka COM) type; currently only supports the legacy PIO mode. vUART (aka COM) type; currently only supports the legacy PIO mode.
``base`` (a child node of ``vuart``): ``base`` (a child node of ``legacy_vuart``, ``console_vuart``, and ``communication_vuart``):
vUART (A.K.A COM) enabling switch. Enable by exposing its COM_BASE vUART (A.K.A COM) enabling switch. Enable by exposing its COM_BASE
(SOS_COM_BASE for Service VM); disable by returning INVALID_COM_BASE. (SOS_COM_BASE for Service VM); disable by returning INVALID_COM_BASE.
``irq`` (a child node of ``vuart``): console and communication vUART (A.K.A PCI based vUART) enabling switch.
Enable by specifying PCI_VUART; disable by returning INVALID_PCI_BASE.
``irq`` (a child node of ``legacy_vuart``):
vCOM IRQ. vCOM IRQ.
``target_vm_id`` (a child node of ``vuart1``): ``target_vm_id`` (a child node of ``legacy_vuart1``, ``communication_vuart``):
COM2 is used for VM communications. When it is enabled, specify which COM2 is used for VM communications. When it is enabled, specify which
target VM the current VM connects to. target VM the current VM connects to.
``target_uart_id`` (a child node of ``vuart1``): ``communication_vuart`` is used for VM communications. When it is enabled, specify
which target VM the current VM connects to.
``target_uart_id`` (a child node of ``legacy_vuart1`` and ``communication_vuart``):
Target vUART ID to which the vCOM2 connects. Target vUART ID to which the vCOM2 connects.
Target vUART ID to which the ``communication_vuart`` connects.
``pci_dev_num``: ``pci_dev_num``:
PCI devices number of the VM; it is hard-coded for each scenario so it PCI devices number of the VM; it is hard-coded for each scenario so it
is not configurable for now. is not configurable for now.