1.. _hv-parameters:
2
3ACRN Hypervisor Parameters
4##########################
5
6Generic Hypervisor Parameters
7*****************************
8
9The ACRN hypervisor supports the following parameter:
10
11+-----------------+-----------------------------+----------------------------------------------------------------------------------------+
12|   Parameter     |     Value                   |            Description                                                                 |
13+=================+=============================+========================================================================================+
14|                 | disabled                    | This value disables the serial port completely.                                        |
15|                 +-----------------------------+----------------------------------------------------------------------------------------+
16| ``uart=``       | bdf@<BDF value>             | This value sets the serial port PCI BDF (in HEX), for example, ``bdf@0xc1``.           |
17|                 |                             |                                                                                        |
18|                 |                             | BDF: Bus, Device, and Function (in HEX) of the serial PCI device. The BDF is packed    |
19|                 |                             | into a 16-bit WORD with format (B:8, D:5, F:3). For example, PCI device ``0:18.1``     |
20|                 |                             | becomes ``0xc1``.                                                                      |
21|                 +-----------------------------+----------------------------------------------------------------------------------------+
22|                 | port@<port address>         | This value sets the serial port PIO address, for example, ``uart=port@0x3F8``.         |
23|                 +-----------------------------+----------------------------------------------------------------------------------------+
24|                 | mmio@<MMIO address>         | This value sets the serial port MMIO address, for example, ``uart=mmio@0xfe040000``.   |
25+-----------------+-----------------------------+----------------------------------------------------------------------------------------+
26
27The Generic hypervisor parameters are specified in the GRUB multiboot/multiboot2 command.
28For example:
29
30.. code-block:: none
31   :emphasize-lines: 5
32
33   menuentry 'Boot ACRN hypervisor from multiboot' {
34      insmod part_gpt
35      insmod ext2
36      echo 'Loading ACRN hypervisor ...'
37      multiboot --quirk-modules-after-kernel /boot/acrn.32.out uart=bdf@0xc1
38      module /boot/bzImage Linux_bzImage
39      module /boot/bzImage2 Linux_bzImage2
40   }
41