doc: remove some dynamic parameters from acrn-dm usage

The following parameters have not used by new design:

1.  --vsbl <vsbl_file_path>
2.  --part_info <part_info_name>
3.  -G, --gvtargs <GVT_args>
4.  -s <slot>,pci-gvt
5.  -Y, --mptgen
6.  -s <slot>,virtio-hdcp
7.  -s <slot>,npk
8.  -s <slot>,virtio-coreu
9.  -i, --ioc_node <ioc_mediator_parameters>
10. --pm_by_vuart [pty|tty],<node_path>
11. --pm_notify_channel <channel>

This patch remove these parameters from doc.

Tracked-On: #6690
Signed-off-by: Chenli Wei <chenli.wei@linux.intel.com>
This commit is contained in:
Chenli Wei
2022-01-04 17:04:49 +08:00
committed by David Kinder
parent 96d93be2a6
commit fa8837b5ff
9 changed files with 20 additions and 251 deletions

View File

@@ -52,21 +52,19 @@ options:
.. code-block:: none
acrn-dm [-hAWYv] [-B bootargs] [-E elf_image_path]
[-G GVT_args] [-i ioc_mediator_parameters] [-k kernel_image_path]
[-k kernel_image_path]
[-l lpc] [-m mem] [-r ramdisk_image_path]
[-s pci] [--vsbl vsbl_file_name] [--ovmf ovmf_file_path]
[--part_info part_info_name] [--enable_trusty] [--intr_monitor param_setting]
[-s pci] [--ovmf ovmf_file_path]
[--enable_trusty] [--intr_monitor param_setting]
[--acpidev_pt HID] [--mmiodev_pt MMIO_regions]
[--vtpm2 sock_path] [--virtio_poll interval] [--mac_seed seed_string]
[--cpu_affinity pCPUs] [--lapic_pt] [--rtvm] [--windows]
[--debugexit] [--logger-setting param_setting] [--pm_notify_channel channel]
[--pm_by_vuart vuart_node] [--ssram] <vm>
[--debugexit] [--logger-setting param_setting]
[--ssram] <vm>
-A: create ACPI tables
-B: bootargs for kernel
-E: elf image path
-G: GVT args: low_gm_size, high_gm_size, fence_sz
-h: help
-i: ioc boot parameters
-k: kernel image path
-l: LPC device configuration
-m: memory size in MB
@@ -76,11 +74,9 @@ options:
-W: force virtio to use single-vector MSI
-Y: disable MPtable generation
--mac_seed: set a platform unique string as a seed for generate mac address
--vsbl: vsbl file path
--ovmf: ovmf file path
--ssram: Enable Software SRAM
--cpu_affinity: list of pCPUs assigned to this VM
--part_info: guest partition info file path
--enable_trusty: enable trusty for guest
--debugexit: enable debug exit function
--intr_monitor: enable interrupt storm monitor
@@ -92,8 +88,6 @@ options:
--lapic_pt: enable local apic passthrough
--rtvm: indicate that the guest is rtvm
--logger_setting: params like console,level=4;kmsg,level=3
--pm_notify_channel: define the channel used to notify guest about power event
--pm_by_vuart:pty,/run/acrn/vuart_vmname or tty,/dev/ttySn
--windows: support Oracle virtio-blk, virtio-net, and virtio-input devices
for windows guest with secure boot
@@ -103,7 +97,6 @@ configuration options.
Here's an example showing how to run a VM with:
- Build ACPI table
- vSBL as the boot ROM
- UART device on PCI 00:01.0
- GPU device on PCI 00:02.0
- Virtio-block device on PCI 00:03.0
@@ -116,8 +109,8 @@ Here's an example showing how to run a VM with:
-s 0:0,hostbridge \
-s 1:0,lpc -l com1,stdio \
-s 5,virtio-console,@pty:pty_port \
-s 3,virtio-blk,b,/home/acrn/UserVM.img \
-s 4,virtio-net,tap_LaaG --vsbl /usr/share/acrn/bios/VSBL.bin \
-s 3,virtio-blk,/home/acrn/UserVM.img \
-s 4,virtio-net,tap_LaaG \
--acpidev_pt MSFT0101 \
--intr_monitor 10000,10,1,100 \
-B "root=/dev/vda2 rw rootwait maxcpus=3 nohpet console=hvc0 \
@@ -781,8 +774,8 @@ example:
-s 0:0,hostbridge \
-s 1:0,lpc -l com1,stdio \
-s 5,virtio-console,@pty:pty_port \
-s 3,virtio-blk,b,/home/acrn/UserVM.img \
-s 4,virtio-net,tap_LaaG --vsbl /usr/share/acrn/bios/VSBL.bin \
-s 3,virtio-blk,/home/acrn/UserVM.img \
-s 4,virtio-net,tap_LaaG \
-B "root=/dev/vda2 rw rootwait maxcpus=3 nohpet console=hvc0 \
console=ttyS0 no_timer_check ignore_loglevel log_buf_len=16M \
consoleblank=0 tsc=reliable \

View File

@@ -426,38 +426,6 @@ to complete the User VM's host-to-guest mapping using this pseudo code:
host2guest_map_for_user_vm(x.hpa, x.user_vm_gpa, x.size)
end
Virtual Slim Bootloader
=======================
The Virtual Slim Bootloader (vSBL) is the virtual bootloader that supports
booting the User VM on the ACRN hypervisor platform. The vSBL design is
derived from Slim Bootloader. It follows a staged design approach that
provides hardware initialization and payload launching that provides the
boot logic. As shown in :numref:`overview-sbl`, the virtual SBL has an
initialization unit to initialize virtual hardware, and a payload unit
to boot a Linux or Android guest OS.
.. figure:: images/over-image110.png
:align: center
:name: overview-sbl
vSBL System Context Diagram
The vSBL image is released as a part of the Service VM root filesystem (rootfs).
The VM Manager in the Service VM copies the vSBL to the User VM memory
while creating the User VM virtual BSP. The Service VM passes the
start of vSBL and related information to HV. HV sets the guest RIP of the User
VM's virtual BSP as the start of vSBL and related guest registers, and launches
the User VM virtual BSP. The vSBL starts running in the virtual real mode within
the User VM. Conceptually, vSBL is part of the User VM runtime.
In the current design, the vSBL supports booting an Android guest OS or
Linux guest OS using the same vSBL image.
For an Android VM, the vSBL loads and verifies the trusty OS first. The
trusty OS then loads and verifies the Android OS according to the Android
OS verification mechanism.
OVMF Bootloader
=======================

View File

@@ -17,14 +17,12 @@ PCI Host Bridge and Hierarchy
There is PCI host bridge emulation in DM. The bus hierarchy is determined by ``acrn-dm`` command line input. Using this command line, as an example::
acrn-dm -A -m $mem_size -s 0:0,hostbridge \
-s 2,pci-gvt -G "$2" \
-s 5,virtio-console,@stdio:stdio_port \
-s 6,virtio-hyper_dmabuf \
-s 3,virtio-blk,/home/acrn/UserVM.img \
-s 4,virtio-net,tap0 \
-s 7,virtio-rnd \
--ovmf /usr/share/acrn/bios/OVMF.fd \
$pm_channel $pm_by_vuart $pm_vuart_node \
$logger_setting \
--mac_seed $mac_seed \
$vm_name

View File

@@ -65,11 +65,8 @@ Usage:
The device model configuration command syntax for virtio-blk is::
-s <slot>,virtio-blk,[,b,]<filepath>[,options]
-s <slot>,virtio-blk,<filepath>[,options]
- ``b``: when using ``vsbl`` as the virtual bootloader, use this
immediately after ``virtio-blk`` to specify it as a bootable
device and the bootable image location.
- ``filepath`` is the path of a file or disk partition
- ``options`` include: