Important

This is the latest documentation for the unstable development branch of Project ACRN (master).
Use the drop-down menu on the left to select documentation for a stable release such as v2.7.

Launch Configuration Options

As explained in Introduction to ACRN Configuration, launch configuration files define post-launched User VM settings. This document describes these option settings.

user_vm:

Specify the User VM id to the Service VM.

user_vm_type:

Specify the User VM type, such as CLEARLINUX, ANDROID, ALIOS, PREEMPT-RT LINUX, GENERIC LINUX, WINDOWS, YOCTO, UBUNTU, ZEPHYR or VXWORKS.

rtos_type:

Specify the User VM Real-time capability: Soft RT, Hard RT, or none of them.

mem_size:

Specify the User VM memory size in megabytes.

vbootloader:

Virtual bootloader type; only supports OVMF.

vuart0:

Specify whether the Device Model emulates the vUART0 (vCOM1); refer to Enable vUART Configurations for details. If set to Enable, the vUART0 is emulated by the Device Model; if set to Disable, the vUART0 is emulated by the hypervisor if it is configured in the scenario XML.

enable_ptm:

Enable the Precision Timing Measurement (PTM) feature.

usb_xhci:

USB xHCI mediator configuration. Input format: bus#-port#[:bus#-port#: ...], e.g.: 1-2:2-4. Refer to USB Virtualization for details.

shm_regions:

List of shared memory regions for inter-VM communication.

shm_region (a child node of shm_regions):

Configure the shared memory regions for the current VM, input format: [hv|dm]:/<shm name>,<shm size in MB>. Refer to ACRN Shared Memory Based Inter-VM Communication for details.

console_vuart:

Enable a PCI-based console vUART. Refer to Enable vUART Configurations for details.

communication_vuarts:

List of PCI-based communication vUARTs. Refer to Enable vUART Configurations for details.

communication_vuart (a child node of communication_vuarts):

Enable a PCI-based communication vUART with its ID. Refer to Enable vUART Configurations for details.

passthrough_devices:

Select the passthrough device from the PCI device list. We support: usb_xdci, audio, audio_codec, ipu, ipu_i2c, cse, wifi, bluetooth, sd_card, ethernet, sata, and nvme.

network (a child node of virtio_devices):

The virtio network device setting. Input format: <device_name>[,vhost][,mac=<XX:XX:XX:XX:XX:XX>]. The <device_name> is the name of the TAP (or MacVTap) device. It must include the keyword tap. vhost specifies the vhost backend; otherwise, the VBSU backend is used. The mac address is optional.

block (a child node of virtio_devices):

The virtio block device setting. Input format: [blk partition:][img path] e.g.: /dev/sda3:./a/b.img.

console (a child node of virtio_devices):

The virtio console device setting. Input format: [@]stdio|tty|pty|sock:portname[=portpath][,[@]stdio|tty|pty:portname[=portpath]].

cpu_affinity:

A comma-separated list of Service VM vCPUs assigned to this VM. A Service VM vCPU is identified by its lapic ID.

Note

The configurable and readonly attributes are used to mark whether the item is configurable for users. When configurable="n" and readonly="y", the item is not configurable from the web interface. When configurable="n", the item does not appear on the interface.