Skip to content

Commit c42f5c5

Browse files
lirui34dbkinder
authored andcommitted
Add description of enabling serial console for KBL NUC.
1 parent 8ee00c1 commit c42f5c5

File tree

5 files changed

+33
-2
lines changed

5 files changed

+33
-2
lines changed

doc/getting-started/apl-nuc.rst

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,26 @@ supported for ACRN development:
1717
<https://www.up-board.org/upsquared/specifications/>`_ (UP2) is also
1818
known to work and its setup is described in :ref:`getting-started-up2`.
1919

20+
- A serial console can be enabled on :ref:`Kaby Lake NUC
21+
<intel-kaby-lake-nuc>` (KBL). The following figure shows the KBL's serial port header
22+
we'll be using as documented in the `NUC7i5DN
23+
<https://www.intel.com/content/dam/support/us/en/documents/boardsandkits/NUC7i5DN_TechProdSpec.pdf>`_.
24+
25+
.. image:: images/KBL-serial-port-header.png
26+
27+
28+
Connecting to the serial port
29+
=============================
30+
31+
You can just ignore this section if command line is not needed via the serial console.
32+
Or you have to prepare these cables to enable the serial port.
33+
34+
.. image:: images/KBL-serial-port-header-to-RS232-cable.jpg
35+
:target: https://www.amazon.com/dp/B07BV1W6N8/ref=cm_sw_r_cp_ep_dp_wYm0BbABD5AK6
36+
37+
.. image:: images/RS232-to-USB-to-Host-cable.png
38+
39+
2040
Firmware update on the NUC
2141
==========================
2242

@@ -25,6 +45,7 @@ Follow these `BIOS Update Instructions
2545
<https://www.intel.com/content/www/us/en/support/articles/000005636.html>`__
2646
for downloading and flashing an updated BIOS for the NUC.
2747

48+
2849
Software setup
2950
**************
3051

@@ -183,6 +204,13 @@ partition. Follow these steps:
183204
#. ``uart=bdf@<BDF value>``: this sets the PCI serial port based on its BDF.
184205
For example, use ``bdf@0:18.1`` for a BDF of 0:18.1 ttyS1.
185206
#. ``uart=port@<port address>``: this sets the serial port address
207+
208+
.. note::
209+
210+
``uart=port@<port address>`` is required if you want to enable the serial console.
211+
You should run ``dmesg |grep ttyS0`` to get port address from the output, and then
212+
set the ``uart`` parameter as ``uart=port@0x3f8``
213+
186214
#. ``vuart=ttySn@irqN``: this tells the hypervisor which virtual serial device SOS
187215
will use and its IRQ number. This is used to avoid conflict with SOS passthrough
188216
devices' interrupt. If UART is set to ttyS1, and its native IRQ is 5, you'd better
@@ -195,8 +223,8 @@ partition. Follow these steps:
195223
.. code-block:: none
196224
197225
$ sudo efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/sda -p 1 -L "ACRN NUC Hypervisor" \
198-
-u "bootloader=\EFI\org.clearlinux\bootloaderx64.efi uart=disabled"
199-
226+
-u "bootloader=\EFI\org.clearlinux\bootloaderx64.efi uart=port@0x3f8"
227+
200228
#. Create a boot entry for the ACRN Service OS by copying a provided ``acrn.conf``
201229
and editing it to account for the kernel versions noted in a previous step.
202230

14.9 KB
Loading
230 KB
Loading
254 KB
Loading

doc/hardware.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ up ACRN on the NUC.
3434
.. _SimplyNUC:
3535
https://www.simplynuc.com/?s=NUC6CAYH&post_type=product
3636

37+
38+
.. _intel-kaby-lake-nuc:
39+
3740
Intel Kaby Lake NUC
3841
*********************
3942

0 commit comments

Comments
 (0)