diff --git a/doc/tutorials/images/NUC-serial-port.jpg b/doc/tutorials/images/NUC-serial-port.png similarity index 100% rename from doc/tutorials/images/NUC-serial-port.jpg rename to doc/tutorials/images/NUC-serial-port.png diff --git a/doc/tutorials/images/NUC11TNH-serial-port-header-to-RS232-cable.png b/doc/tutorials/images/NUC11TNH-serial-port-header-to-RS232-cable.png new file mode 100644 index 000000000..b1832653a Binary files /dev/null and b/doc/tutorials/images/NUC11TNH-serial-port-header-to-RS232-cable.png differ diff --git a/doc/tutorials/images/NUC11TNH-serial-port-header.png b/doc/tutorials/images/NUC11TNH-serial-port-header.png new file mode 100644 index 000000000..3c35d9382 Binary files /dev/null and b/doc/tutorials/images/NUC11TNH-serial-port-header.png differ diff --git a/doc/tutorials/images/NUC11TNH-serial-port.png b/doc/tutorials/images/NUC11TNH-serial-port.png new file mode 100644 index 000000000..90e269035 Binary files /dev/null and b/doc/tutorials/images/NUC11TNH-serial-port.png differ diff --git a/doc/tutorials/images/NVMe-M.2-to-PCIe-adaptor.png b/doc/tutorials/images/NVMe-M.2-to-PCIe-adaptor.png new file mode 100644 index 000000000..e3721af04 Binary files /dev/null and b/doc/tutorials/images/NVMe-M.2-to-PCIe-adaptor.png differ diff --git a/doc/tutorials/images/PCIe-serial-Connection.png b/doc/tutorials/images/PCIe-serial-Connection.png new file mode 100644 index 000000000..de4bf1945 Binary files /dev/null and b/doc/tutorials/images/PCIe-serial-Connection.png differ diff --git a/doc/tutorials/images/PCIe-serial-LeKuo.png b/doc/tutorials/images/PCIe-serial-LeKuo.png new file mode 100644 index 000000000..9d6d6760b Binary files /dev/null and b/doc/tutorials/images/PCIe-serial-LeKuo.png differ diff --git a/doc/tutorials/images/PCIe-serial-StarTech.png b/doc/tutorials/images/PCIe-serial-StarTech.png new file mode 100644 index 000000000..a981d329d Binary files /dev/null and b/doc/tutorials/images/PCIe-serial-StarTech.png differ diff --git a/doc/tutorials/using_serial_port.rst b/doc/tutorials/using_serial_port.rst index d1673b2b3..61ee0df5d 100644 --- a/doc/tutorials/using_serial_port.rst +++ b/doc/tutorials/using_serial_port.rst @@ -1,35 +1,38 @@ .. _connect_serial_port: -Using the Serial Port on KBL Intel NUC -====================================== +Enable Serial Port on NUC +######################### +Option 1: Using the Serial Port on TGL Intel NUC +================================================ + You can enable the serial console on the -`KBL Intel NUC `_ -(NUC7i7DNH). The KBL Intel NUC has a serial port header you can +`TGL Intel NUC `_. +(NUC11TNHi5). The TGL Intel NUC has a serial port header you can expose with a serial DB9 header cable. (The Intel NUC has a punch out hole for mounting the serial connector.) -.. figure:: images/NUC-serial-port.jpg +.. figure:: images/NUC11TNH-serial-port.png - KBL Intel NUC with populated serial port punchout + TGL Intel NUC with populated serial port punchout You can `purchase `_ such a cable or you can build it yourself; -refer to the `KBL Intel NUC product specification -`_ +refer to the `TGL Intel NUC product specification +`_ as shown below: -.. figure:: images/KBL-serial-port-header.png +.. figure:: images/NUC11TNH-serial-port-header.png :scale: 80 - KBL serial port header details + NUC11TNH serial port header details -.. figure:: images/KBL-serial-port-header-to-RS232-cable.jpg +.. figure:: images/NUC11TNH-serial-port-header-to-RS232-cable.png :scale: 80 - KBL `serial port header to RS232 cable + NUC11TNH `serial port header to RS232 cable `_ @@ -41,3 +44,64 @@ to connect to your host system. Note that If you want to use the RS232 DB9 female/female cable, choose the **cross-over** type rather than **straight-through** type. + +Option 2: Enabling PCIe Serial Port on TGL Intel NUC +==================================================== + +If there is no internal serial port header on your NUC; you can enable PCIe serial port to debug the issues effeciently. +As you know,most of the NUC don't have PCIe interface,but have NVMe M.2 interface;so the additional M.2 to PCIe adaptor is needed to +enabnle PCIe serial port on NUC.You can buy the `adaptor +`_ first; Then buy the PCIe serial card with `StarTech 2 Port Native PCI Express +`_ or `IO-PCE99100-2S. +`_ +Both of them are verified with this `commit. +`_ + +.. figure:: images/NVMe-M.2-to-PCIe-adaptor.png + :scale: 80 + + NVMe M.2 to PCIe adaptor + +.. figure:: images/PCIe-serial-StarTech.png + :scale: 80 + + StarTech 2 Port Native PCI Express + +.. figure:: images/PCIe-serial-LeKuo.png + :scale: 80 + + IO-PCE99100-2S + + +Check the BDF Information +************************* +Connection as following,boot into native and check the bdf information of the adapter using: ``lspci`` + +.. figure:: images/PCIe-serial-Connection.png + :scale: 80 + + PCIe Serial Connection on NUC + +.. code-block:: bash + + 01:00.0 Serial controller: Asix Electronics Corporation Device 9100 + 01:00.1 Serial controller: Asix Electronics Corporation Device 9100 + +Convert the BDF to Hex Format +***************************** + +Refer this :ref:`hv-parameters` to change bdf 01:00.1 to Hex format: 0x101; +Then adding it into grub menu: + +.. Note:: + + multiboot2 /boot/acrn.bin root=PARTUUID="b1bebafc-2b06-43e2-bf6a-323337daebc0“ uart=bdf@0x101 + +.. Note:: + + uart=bdf@0x100 for port 1 + + uart=bdf@0x101 for port 2 + + uart=bdf@0x101 is preferred for industry scenario; otherwise it can’t input in Hypervisor console after Service VM boots up. + There is no this limitation for hybrid and hybrid_rt scenario.