doc: update BDF information for 'uart=' hypervisor parameter

The 'uart=' parameter for the hypervisor takes multiple forms. One
is to specify the BDF (Bus, Device, Function) value of the serial
port PCI device. The description in the documentation used the
previous format (e.g. '0:18.1') but a 16-bit WORD in HEX needs
to be passed nowadays. E.g.: '0:18.1' is specified by 'uart=0xc1'

Tracked-On: #5842
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Signed-off-by: Benjamin Fitch <benjamin.fitch@intel.com>
This commit is contained in:
Geoffroy Van Cutsem 2021-03-12 13:25:16 +01:00 committed by fitchbe
parent fceeb0b511
commit a7e53dd32f
2 changed files with 7 additions and 3 deletions

View File

@ -13,7 +13,11 @@ The ACRN hypervisor supports the following parameter:
+=================+=============================+========================================================================================+
| | disabled | This disables the serial port completely. |
| +-----------------------------+----------------------------------------------------------------------------------------+
| ``uart=`` | bdf@<BDF value> | This sets the serial port PCI BDF, e.g. ``bdf@0:18.1`` |
| ``uart=`` | bdf@<BDF value> | This sets the serial port PCI BDF (in HEX), e.g. ``bdf@0xc1`` |
| | | |
| | | BDF: Bus, Device, and Function (in HEX) of the serial PCI device. The BDF is packed |
| | | into a 16-bit WORD with format (B:8, D:5, F:3). For example, PCI device ``0:18.1`` |
| | | becomes ``0xc1`` |
| +-----------------------------+----------------------------------------------------------------------------------------+
| | port@<port address> | This sets the serial port PIO address, e.g. ``uart=port@0x3F8`` |
| +-----------------------------+----------------------------------------------------------------------------------------+
@ -30,7 +34,7 @@ For example:
insmod part_gpt
insmod ext2
echo 'Loading ACRN hypervisor ...'
multiboot --quirk-modules-after-kernel /boot/acrn.32.out uart=bdf@0:18.1
multiboot --quirk-modules-after-kernel /boot/acrn.32.out uart=bdf@0xc1
module /boot/bzImage Linux_bzImage
module /boot/bzImage2 Linux_bzImage2
}

View File

@ -20,7 +20,7 @@ static struct uart_cmd {
int type;
} cmd_list[] = {
{ "uart=port@", PIO }, /* uart=port@0x3F8 */
{ "uart=bdf@", PCI }, /* uart=bdf@0:18.2 */
{ "uart=bdf@", PCI }, /* uart=bdf@0xc1 */
{ "uart=mmio@", MMIO }, /* uart=mmio@0xfe040000 */
{ "uart=disabled", INVALID }
};