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

doc: fix layout of dm-params

Browse Source 
Use of :kbd: isn't appropriate as used and isn't rendered right. change
to inline codeblock notation instead.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2021-02-08 12:39:21 -08:00 committed by David Kinder
parent 2f796a7961
commit 6337bafb55
1 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
doc/user-guides/acrn-dm-parameters.rst
View File

@ -14,7 +14,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
:widths: 22 78
:header-rows: 0
* - :kbd:`-A, --acpi`
* - ``-A``, ``--acpi``
- Create ACPI tables.
With this option, DM will build an ACPI table into its VMs F-Segment
(0xf2400). This ACPI table includes full tables for RSDP, RSDT, XSDT,
@ -22,7 +22,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
according to acrn-dm command line configuration and derived from their
default value.
* - :kbd:`-B, --bootargs <bootargs>`
* - ``-B``, ``--bootargs <bootargs>``
- Set the User VM kernel command-line arguments.
The maximum length is 1023.
The bootargs string will be passed to the kernel as its cmdline.
@ -33,15 +33,15 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
specifies the kernel log level at 7
* - :kbd:`--debugexit`
* - ``--debugexit``
- Enable guest to write io port 0xf4 to exit guest. It's mainly used by
guest unit test.
* - :kbd:`-E, --elf_file <elf image path>`
* - ``-E``, ``--elf_file <elf image path>``
- This option is to define a static elf binary which could be loaded by
DM. DM will run elf as guest of ACRN.
* - :kbd:`--enable_trusty`
* - ``--enable_trusty``
- Enable trusty for guest.
For Android guest OS, ACRN provides a VM environment with two worlds:
normal world and trusty world. The Android OS runs in the the normal
@ -51,7 +51,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
By default, the trusty world is disabled. Use this option to enable it.
* - :kbd:`-G, --gvtargs <GVT_args>`
* - ``-G``, ``--gvtargs <GVT_args>``
- ACRN implements GVT-g for graphics virtualization (aka AcrnGT). This
option allows you to set some of its parameters.
@ -70,10 +70,10 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
sets up 10Mb for GVT-g aperture, 128M for GVT-g hidden
memory, and 6 fence registers.
* - :kbd:`-h, --help`
* - ``-h``, ``--help``
- Show a summary of commands.
* - :kbd:`-i, --ioc_node <ioc_mediator_parameters>`
* - ``-i``, ``--ioc_node <ioc_mediator_parameters>``
- IOC (IO Controller) is a bridge of an SoC to communicate with Vehicle Bus.
It routes Vehicle Bus signals, for example extracted from CAN messages,
from IOC to the SoC and back, as well as controlling the onboard
@ -110,7 +110,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
-i /run/acrn/ioc_$vm_name,0x20
-l com2,/run/acrn/ioc_$vm_name
* - :kbd:`--intr_monitor <intr_monitor_params>`
* - ``--intr_monitor <intr_monitor_params>``
- Enable interrupt storm monitor for User VM. Use this option to prevent an interrupt
storm from the User VM.
@ -128,16 +128,16 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
- ``100``: after 100ms, we will cancel the interrupt injection delay and restore
to normal.
* - :kbd:`-k, --kernel <kernel_image_path>`
* - ``-k``, ``--kernel <kernel_image_path>``
- Set the kernel (full path) for the User VM kernel. The maximum path length is
1023 characters. The DM handles bzImage image format.
usage: ``-k /path/to/your/kernel_image``
* - :kbd:`-l, --lpc <lpc_device_configuration>`
- (See :kbd:`-i, --ioc_node`)
* - ``-l``, ``--lpc <lpc_device_configuration>``
- (See ``-i``, ``--ioc_node``)
* - :kbd:`-m, --memsize <memory_size>`
* - ``-m``, ``--memsize <memory_size>``
- Setup total memory size for User VM.
memory_size format is: "<size>{K/k, B/b, M/m, G/g}", and size is an
@ -145,7 +145,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
usage: ``-m 4g``: set User VM memory to 4 gigabytes.
* - :kbd:`--mac_seed <seed_string>`
* - ``--mac_seed <seed_string>``
- Set a platform unique string as a seed to generate the mac address.
Each VM should have a different "seed_string". The "seed_string" can
be generated by the following method where $(vm_name) contains the
@ -155,16 +155,16 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
``seed_string=${mac:9:8}-${vm_name}``
* - :kbd:`--part_info <part_info_name>`
* - ``--part_info <part_info_name>``
- Set guest partition info path.
* - :kbd:`-r, --ramdisk <ramdisk_image_path>`
* - ``-r``, ``--ramdisk <ramdisk_image_path>``
- Set the ramdisk (full path) for the User VM. The maximum length is 1023.
The supported ramdisk format depends on your User VM kernel configuration.
usage: ``-r /path/to/your/ramdisk_image``
* - :kbd:`-s, --pci_slot <slot_config>`
* - ``-s``, ``--pci_slot <slot_config>``
- Setup PCI device configuration.
slot_config format is::
@ -197,7 +197,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
This add virtual block in PCI slot 9 and use ``/root/test.img`` as the
disk image
* - :kbd:`-U, --uuid <uuid>`
* - ``-U``, ``--uuid <uuid>``
- Set UUID for a VM.
Every VM is identified by a UUID. You can define that UUID with this
option. If you don't use this option, a default one
@ -209,10 +209,10 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
set the newly created VM's UUID to ``42795636-1d31-6512-7432-087d33b34756``
* - :kbd:`-v, --version`
* - ``-v``, ``--version``
- Show Device Model version
* - :kbd:`--vsbl <vsbl_file_path>`
* - ``--vsbl <vsbl_file_path>``
- Virtual Slim bootloader (vSBL) is the virtual bootloader supporting
booting of the User VM on the ACRN hypervisor platform. The vSBL design is
derived from Slim Bootloader, which follows a staged design approach
@ -235,8 +235,8 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
uses ``/usr/share/acrn/bios/VSBL.bin`` as the vSBL image
* - :kbd:`--ovmf [w,]<ovmf_file_path>`
:kbd:`--ovmf [w,]code=<ovmf_code_file>,vars=<ovmf_vars_file>`
* - ``--ovmf [w,]<ovmf_file_path>``
``--ovmf [w,]code=<ovmf_code_file>,vars=<ovmf_vars_file>``
- Open Virtual Machine Firmware (OVMF) is an EDK II based project to enable
UEFI support for Virtual Machines.
@ -269,7 +269,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
--ovmf w,/usr/share/acrn/bios/OVMF.fd
* - :kbd:`--cpu_affinity <list of pCPUs>`
* - ``--cpu_affinity <list of pCPUs>``
- list of pCPUs assigned to this VM.
Example::
@ -278,7 +278,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
to assign physical CPUs (pCPUs) 1 and 3 to this VM.
* - :kbd:`--virtio_poll <poll_interval>`
* - ``--virtio_poll <poll_interval>``
- Enable virtio poll mode with poll interval xxx ns.
Example::
@ -287,7 +287,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
enable virtio poll mode with poll interval 1ms.
* - :kbd:`--acpidev_pt <HID>`
* - ``--acpidev_pt <HID>``
- This option is to enable ACPI device passthrough support. The ``HID`` is a
mandatory parameter for this option which is the Hardware ID of the ACPI
device.
@ -298,7 +298,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
To pass through a TPM (which HID is MSFT0101) ACPI device to a User VM.
* - :kbd:`--mmiodev_pt <MMIO_Region>`
* - ``--mmiodev_pt <MMIO_Region>``
- This option is to enable MMIO device passthrough support. The ``MMIO_Region``
is a mandatory parameter for this option which is the MMIO resource of the
MMIO device. The ``MMIO_Region`` needs to be the base address followed by
@ -312,17 +312,17 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
The base address of this region is 0xFED40000 and the size of the region
is 0x00005000.
* - :kbd:`--vtpm2 <sock_path>`
* - ``--vtpm2 <sock_path>``
- This option is to enable virtual TPM support. The sock_path is a mandatory
parameter for this option which is the path of swtpm socket fd.
* - :kbd:`-W, --virtio_msix`
* - ``-W, --virtio_msix``
- This option forces virtio to use single-vector MSI.
By default, any virtio-based devices will use MSI-X as its interrupt
method. If you want to use single-vector MSI interrupt, you can do so
using this option.
* - :kbd:`-Y, --mptgen`
* - ``-Y, --mptgen``
- Disable MPtable generation.
The MultiProcessor Specification (MPS) for the x86 architecture is an
open standard describing enhancements to both operating systems and
@ -333,7 +333,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
By default, DM will create the MPtable for you. Use this option to
disable it.
* - :kbd:`--lapic_pt`
* - ``--lapic_pt``
- This option is to create a VM with the local APIC (LAPIC) passed-through.
With this option, a VM is created with ``LAPIC_PASSTHROUGH`` and
``IO_COMPLETION_POLLING`` mode. This option is typically used for hard
@ -341,7 +341,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
By default, this option is not enabled.
* - :kbd:`--rtvm`
* - ``--rtvm``
- This option is used to create a VM with real-time attributes.
With this option, a VM is created with ``GUEST_FLAG_RT`` and
``GUEST_FLAG_IO_COMPLETION_POLLING`` mode. This kind of VM is
@ -352,7 +352,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
By default, this option is not enabled.
* - :kbd:`--logger_setting <console,level=4;disk,level=4;kmsg,level=3>`
* - ``--logger_setting <console,level=4;disk,level=4;kmsg,level=3>``
- This option sets the level of logging that is used for each log channel.
The general format of this option is ``<log channel>,level=<log level>``.
Different log channels are separated by a semi-colon (``;``). The various
@ -361,7 +361,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
By default, the log severity level is set to 4 (``info``).
* - :kbd:`--pm_notify_channel <channel>`
* - ``--pm_notify_channel <channel>``
- This option is used to define which channel could be used DM to
communicate with VM about power management event.
@ -373,7 +373,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
Use ioc as power management event motify channel.
* - :kbd:`--pm_by_vuart [pty|tty],<node_path>`
* - ``--pm_by_vuart [pty|tty],<node_path>``
- This option is used to set a user OS power management by virtual UART.
With acrn-dm UART emulation and hypervisor UART emulation and configure,
service OS can communicate with user OS through virtual UART. By this
@ -391,7 +391,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
For different User VM, it can be configured as needed.
* - :kbd:`--windows`
* - ``--windows``
- This option is used to run Windows User VMs. It supports Oracle
``virtio-blk``, ``virtio-net`` and ``virtio-input`` devices for Windows
guests with secure boot.