doc: improve acrn-dm param layout

Use a table instead of a dictionary list to make the parameter
description layout more readable.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-12-12 10:57:10 -08:00 committed by David Kinder
parent 21a5b30865
commit 6dec166779

View File

@ -10,16 +10,20 @@ emulation based on command line configurations, as introduced in
Here are descriptions for each of these ``acrn-dm`` command line parameters: Here are descriptions for each of these ``acrn-dm`` command line parameters:
:kbd:`-A, --acpi` .. list-table::
Create ACPI tables. :widths: 22 78
:header-rows: 0
* - \-A, --acpi
- Create ACPI tables.
With this option, DM will build an ACPI table into its VMs F-Segment 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, (0xf2400). This ACPI table includes full tables for RSDP, RSDT, XSDT,
MADT, FADT, HPET, MCFG, FACS, and DSDT. All these items are programmed MADT, FADT, HPET, MCFG, FACS, and DSDT. All these items are programmed
according to acrn-dm command line configuration and derived from their according to acrn-dm command line configuration and derived from their
default value. default value.
:kbd:`-B, --bootargs <bootargs>` * - \-B, --bootargs <bootargs>
Set the UOS kernel command line arguments. - Set the UOS kernel command line arguments.
The maximum length is 1023. The maximum length is 1023.
The bootargs string will be passed to the kernel as its cmdline. The bootargs string will be passed to the kernel as its cmdline.
@ -29,13 +33,13 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
specifies the kernel log level at 7 specifies the kernel log level at 7
:kbd:`-c, --ncpus <cpus>` * - \-c, --ncpus <cpus>
Set number of CPUs for UOS. This number is an integer and must not be - Set number of CPUs for UOS. This number is an integer and must not be
more than the total number of CPUs in the system, minus one (which is more than the total number of CPUs in the system, minus one (which is
used by the SOS). used by the SOS).
:kbd:`--enable_trusty` * - \--enable_trusty
Enable trusty for guest. - Enable trusty for guest.
For Android guest OS, ACRN provides a VM environment with two worlds: 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 normal world and trusty world. The Android OS runs in the the normal
world. The trusty OS and security sensitive applications runs in the world. The trusty OS and security sensitive applications runs in the
@ -44,8 +48,8 @@ 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. 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 - ACRN implements GVT-g for graphics virtualization (aka AcrnGT). This
option allows you to set some of its parameters. option allows you to set some of its parameters.
GVT_args format: ``gvt_high_gm_sz gvt_low_gm_sz gvt_fence_sz`` GVT_args format: ``gvt_high_gm_sz gvt_low_gm_sz gvt_fence_sz``
@ -63,11 +67,11 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
sets up 10Mb for GVT-g aperture, 128M for GVT-g hidden sets up 10Mb for GVT-g aperture, 128M for GVT-g hidden
memory, and 6 fence registers. memory, and 6 fence registers.
:kbd:`-h, --help` * - \-h, --help
Show a summary of commands. - 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. - 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, It routes Vehicle Bus signals, for example extracted from CAN messages,
from IOC to the SoC and back, as well as controlling the onboard from IOC to the SoC and back, as well as controlling the onboard
peripherals from SoC. (The ``-i`` and ``-l`` parameters are only peripherals from SoC. (The ``-i`` and ``-l`` parameters are only
@ -103,46 +107,46 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
-i /run/acrn/ioc_$vm_name,0x20 -i /run/acrn/ioc_$vm_name,0x20
-l com2,/run/acrn/ioc_$vm_name -l com2,/run/acrn/ioc_$vm_name
:kbd:`-k, --kernel <kernel_image_path>` * - \-k, --kernel <kernel_image_path>
Set the kernel (full path) for the UOS kernel. The maximum length is - Set the kernel (full path) for the UOS kernel. The maximum path length is
1023. The DM handles bzImage image format. 1023 characters. The DM handles bzImage image format.
usage: ``-k /path/to/your/kernel_image`` usage: ``-k /path/to/your/kernel_image``
:kbd:`-l, --lpc <lpc_device_configuration>` * - \-l, --lpc <lpc_device_configuration>
(See **-i, --ioc_node**) - (See **-i, --ioc_node**)
:kbd:`-m, --memsize <memory_size>` * - \-m, --memsize <memory_size>
Setup total memory size for UOS. - Setup total memory size for UOS.
memory_size format is: "<size>{K/k, B/b, M/m, G/g}", and size is an memory_size format is: "<size>{K/k, B/b, M/m, G/g}", and size is an
integer. integer.
usage: ``-m 4g``: set UOS memory to 4 gigabytes. usage: ``-m 4g``: set UOS memory to 4 gigabytes.
:kbd:`-p, --pincpu <vcpu:hostcpu>` * - \-p, --pincpu <vcpu:hostcpu>
Pin host CPU to appointed vCPU: - Pin host CPU to appointed vCPU:
- vcpu is the ID of the CPU seen by the UOS, and - ``vcpu`` is the ID of the CPU seen by the UOS, and
- hostcpu is the physical CPU ID on the system. - ``hostcpu`` is the physical CPU ID on the system.
Example: ``-p "1:2"`` means pin the 2nd physical cpu to 1st vcpu in UOS Example: ``-p "1:2"`` means pin the 2nd physical cpu to 1st vcpu in UOS
:kbd:`--ptdev_no_reset` * - \--ptdev_no_reset
Disable reset check for pci device. - Disable reset check for pci device.
When assigning a PCI device as a passthrough device, we will reset it When assigning a PCI device as a passthrough device, we will reset it
first to get it to a valid device state. So if the device doesn't have first to get it to a valid device state. So if the device doesn't have
the reset capability, the passthrough will fail. The PCI device reset the reset capability, the passthrough will fail. The PCI device reset
can be disabled using this option. can be disabled using this option.
:kbd:`-r, --ramdisk <ramdisk_image_path>` * - \-r, --ramdisk <ramdisk_image_path>
Set the ramdisk (full path) for the UOS. The maximum length is 1023. - Set the ramdisk (full path) for the UOS. The maximum length is 1023.
The supported ramdisk format depends on your UOS kernel configuration. The supported ramdisk format depends on your UOS kernel configuration.
usage: ``-r /path/to/your/ramdisk_image`` usage: ``-r /path/to/your/ramdisk_image``
:kbd:`-s, --pci_slot <slot_config>` * - \-s, --pci_slot <slot_config>
Setup PCI device configuration. - Setup PCI device configuration.
slot_config format is:: slot_config format is::
@ -174,8 +178,8 @@ 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 This add virtual block in PCI slot 9 and use "/root/test.img" as the
disk image disk image
:kbd:`-U, --uuid <uuid>` * - \-U, --uuid <uuid>
Set UUID for a VM. - Set UUID for a VM.
Every VM is identified by a UUID. You can define that UUID with this 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 option. If you don't use this option, a default one
("d2795438-25d6-11e8-864e-cb7a18b34643") will be used. ("d2795438-25d6-11e8-864e-cb7a18b34643") will be used.
@ -186,11 +190,11 @@ 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" set the newly created VM's UUID to "42795636-1d31-6512-7432-087d33b34756"
:kbd:`-v, --version` * - \-v, --version
Show Device Model version - Show Device Model version
:kbd:`--vsbl <vsbl_file_path>` * - \--vsbl <vsbl_file_path>
Virtual Slim bootloader (vSBL) is the virtual bootloader supporting - Virtual Slim bootloader (vSBL) is the virtual bootloader supporting
booting of the UOS on the ACRN hypervisor platform. The vSBL design is booting of the UOS on the ACRN hypervisor platform. The vSBL design is
derived from Slim Bootloader, which follows a staged design approach derived from Slim Bootloader, which follows a staged design approach
that provides hardware initialization and launching a payload that that provides hardware initialization and launching a payload that
@ -209,14 +213,14 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
uses ``/usr/share/acrn/bios/VSBL.bin`` as the vSBL image uses ``/usr/share/acrn/bios/VSBL.bin`` as the vSBL image
:kbd:`-W, --virtio_msix` * - \-W, --virtio_msix
This option forces virtio to use single-vector MSI. - This option forces virtio to use single-vector MSI.
By default, any virtio-based devices will use MSI-X as its interrupt 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 method. If you want to use single-vector MSI interrupt, you can do so
using this option. using this option.
:kbd:`-Y, --mptgen` * - \-Y, --mptgen
Disable MPtable generation. - Disable MPtable generation.
The MultiProcessor Specification (MPS) for the x86 architecture is an The MultiProcessor Specification (MPS) for the x86 architecture is an
open standard describing enhancements to both operating systems and open standard describing enhancements to both operating systems and
firmware that allows them to work with x86-compatible processors in a firmware that allows them to work with x86-compatible processors in a