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

doc: update acrn-dm parameters documentation

Browse Source 
Update the documentation listing and describing all `acrn-dm` parameters as it
has gone out of sync with the actual implementation. Some parameters are missing
and others are now obsolete.

Tracked-On: #4732
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
Geoffroy Van Cutsem 2020-04-28 12:53:32 +02:00 committed by wenlingz
parent 0c6b3e57d6
commit 97245363b1
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -37,7 +37,7 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
- Enable guest to write io port 0xf4 to exit guest. It's mainly used by - Enable guest to write io port 0xf4 to exit guest. It's mainly used by
guest unit test. guest unit test.
* - :kbd:`-E <elf image path>` * - :kbd:`-E, --elf_file <elf image path>`
- This option is to define a static elf binary which could be loaded by - This option is to define a static elf binary which could be loaded by
DM. DM will run elf as guest of ACRN. DM. DM will run elf as guest of ACRN.
@ -158,13 +158,6 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
* - :kbd:`--part_info <part_info_name>` * - :kbd:`--part_info <part_info_name>`
- Set guest partition info path. - Set guest partition info path.
* - :kbd:`--ptdev_no_reset`
- Disable reset check for pci device.
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
the reset capability, the passthrough will fail. The PCI device reset
can be disabled using this option.
* - :kbd:`-r, --ramdisk <ramdisk_image_path>` * - :kbd:`-r, --ramdisk <ramdisk_image_path>`
- Set the ramdisk (full path) for the User VM. The maximum length is 1023. - 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. The supported ramdisk format depends on your User VM kernel configuration.
@ -264,6 +257,16 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
--ovmf w,/usr/share/acrn/bios/OVMF.fd --ovmf w,/usr/share/acrn/bios/OVMF.fd
* - :kbd:`--cpu_affinity <list of pCPUs>`
- list of pCPUs assigned to this VM.
Example::
--cpu_affinity 1,3
to assign physical CPUs (pCPUs) 1 and 3 to this VM.
* - :kbd:`--virtio_poll <poll_interval>` * - :kbd:`--virtio_poll <poll_interval>`
- Enable virtio poll mode with poll interval xxx ns. - Enable virtio poll mode with poll interval xxx ns.
@ -350,3 +353,11 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
--pm_notify_channel uart --pm_by_vuart tty,/dev/ttyS1 --pm_notify_channel uart --pm_by_vuart tty,/dev/ttyS1
For different User VM, it can be configured as needed. For different User VM, it can be configured as needed.
* - :kbd:`--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.
usage::
--windows