Skip to content

Commit 61f03da

Browse files
mgcaodbkinder
authored andcommitted
DOC: change PCI uart description from mmio to bdf
HV code changed to configure PCI uart mmio@ to bdf@, so change its description to match it. Tracked-On: #2031 Signed-off-by: Minggui Cao <minggui.cao@intel.com>
1 parent 50f5b0f commit 61f03da

File tree

4 files changed

+17
-16
lines changed

4 files changed

+17
-16
lines changed

doc/getting-started/apl-nuc.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,8 @@ partition. Follow these steps:
177177
whether it should be disabled. There are three forms for this parameter:
178178

179179
#. ``uart=disabled``: this disables the serial port completely
180-
#. ``uart=mmio@<MMIO address>``: this sets the serial port MMIO address
180+
#. ``uart=bdf@<BDF value>``: this sets the PCI serial port based on its BDF.
181+
For example, use ``bdf@0:18.2`` for a BDF of 0:18.2 ttyS2.
181182
#. ``uart=port@<port address>``: this sets the serial port address
182183

183184
Here is a more complete example of how to configure the EFI firmware to load the ACRN

doc/getting-started/up2.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,21 +75,21 @@ You will need to keep these in mind in a few places:
7575
.. code-block:: none
7676
7777
# efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/mmcblk0 -p 1 -L "ACRN Hypervisor" \
78-
-u "bootloader=\EFI\org.clearlinux\bootloaderx64.efi uart=mmio@0x9141e000"
78+
-u "bootloader=\EFI\org.clearlinux\bootloaderx64.efi uart=bdf@0:18.1"
7979
8080
UP2 serial port setting
8181
=======================
8282

83-
The serial port in the 40-pin HAT connector is located at ``MMIO 0x0x9141e000``.
84-
You can check this from the ``dmesg`` output from the initial Clearlinux installation.
83+
The serial port in the 40-pin HAT connector is located at ``serial PCI BDF 0:18.1``.
84+
You can check this from the ``lspci`` output from the initial Clearlinux installation.
8585

8686
.. code-block:: none
8787
88-
# dmesg | grep dw-apb-uart
89-
[2.150689] dw-apb-uart.8: ttyS1 at MMIO 0x91420000 (irq = 4, base_baud = 115200) is a 16550A
90-
[2.152072] dw-apb-uart.9: ttyS2 at MMIO 0x9141e000 (irq = 5, base_baud = 115200) is a 16550A
88+
# lspci | grep UART
89+
00:18.0 . Series HSUART Controller #1 (rev 0b)
90+
00:18.1 . Series HSUART Controller #2 (rev 0b)
9191
92-
The second entry associated with ``dw-apb-uart.9`` is the one on the 40-pin HAT connector.
92+
The second entry associated with ``00:18.1`` is the one on the 40-pin HAT connector.
9393

9494
UP2 block device
9595
================

doc/tutorials/images/menuconfig-partition-mode.png

100644100755
243 KB
Loading

doc/tutorials/using_partition_mode_on_up2.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,11 @@ Enable partition mode in ACRN hypervisor
106106
.. code-block:: none
107107
:emphasize-lines: 1
108108
109-
$ dmesg | grep ttyS
110-
[ 10.552369] dw-apb-uart.8: ttyS4 at MMIO 0x91524000 (irq = 4, base_baud = 115200) is a 16550A
111-
[ 10.552568] serial serial0: tty port ttyS4 registered
112-
[ 10.572344] dw-apb-uart.9: ttyS5 at MMIO 0x91522000 (irq = 5, base_baud = 115200) is a 16550A
113-
[ 10.572545] serial serial1: tty port ttyS5 registered
109+
$ sudo lspci | grep UART
110+
00:18.0 . Series HSUART Controller #1 (rev 0b)
111+
00:18.1 . Series HSUART Controller #2 (rev 0b)
112+
113+
The second with ``00:18.1`` is the one on the 40-pin expansion connector.
114114
115115
The following command prints detailed information about all PCI buses
116116
and devices in the system. Look up the PCI BAR addresses of the SATA
@@ -153,7 +153,7 @@ Enable partition mode in ACRN hypervisor
153153
$ make menuconfig
154154
155155
Set the ``Hypervisor mode`` option to ``Partition mode``, and depending
156-
on the serial port you are using, enter its MMIO address to the configuration
156+
on the serial port you are using, enter its BDF to the configuration
157157
menu as shown in this screenshot. Finally, save the configuration.
158158

159159
.. figure:: images/menuconfig-partition-mode.png
@@ -347,8 +347,8 @@ Switch between privileged VMs
347347
*****************************
348348

349349
Connect the serial port on the UP2 board to the development workstation.
350-
If you set the MMIO address of the serial port right while building the
351-
ACRN hypervisor, you should see the output from the ACRN serial console as below.
350+
If you set the BDF of the serial port right while building the ACRN hypervisor,
351+
you should see the output from the ACRN serial console as below.
352352
You could then log in to the privileged VMs by ``sos_console`` command,
353353
and press :kbd:`CTRL+Space` keys to return to the ACRN serial console.
354354

0 commit comments

Comments
 (0)