diff --git a/doc/tutorials/using_serial_port.rst b/doc/tutorials/using_serial_port.rst index 61ee0df5d..57f706863 100644 --- a/doc/tutorials/using_serial_port.rst +++ b/doc/tutorials/using_serial_port.rst @@ -7,9 +7,9 @@ Option 1: Using the Serial Port on TGL Intel NUC ================================================ You can enable the serial console on the -`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 +`TGL Intel NUC `_ +(NUC11TNHi5). The TGL Intel NUC has a serial port header that you can +expose with a serial DB9 header cable. (The Intel NUC has a punch-out hole for mounting the serial connector.) .. figure:: images/NUC11TNH-serial-port.png @@ -37,7 +37,7 @@ as shown below: You'll also need an `RS232 DB9 female to USB cable -`_, +`_ or an `RS232 DB9 female/female (NULL modem) cross-over cable `_ to connect to your host system. @@ -48,14 +48,13 @@ 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. -`_ +If there is no internal serial port header on your NUC, you can enable the PCIe serial port to debug the issues effeciently. +Most of the NUCs don't have a PCIe interface but have an NVMe M.2 interface, so the additional M.2 to PCIe adaptor is needed to +enable the PCIe serial port on the NUC. You can buy the `adaptor +`_ first and 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 @@ -75,7 +74,9 @@ Both of them are verified with this `commit. Check the BDF Information ************************* -Connection as following,boot into native and check the bdf information of the adapter using: ``lspci`` + +Connect as in following figure, boot into native, and then check the BDF +information of the adapter using: ``lspci``. .. figure:: images/PCIe-serial-Connection.png :scale: 80 @@ -91,7 +92,7 @@ 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: +then add it to the grub menu: .. Note:: @@ -103,5 +104,6 @@ Then adding it into grub menu: 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. + uart=bdf@0x101 is preferred for the industry scenario; otherwise, it can't + input in the Hypervisor console after the Service VM boots up. + There is no such limitation for the hybrid or hybrid_rt scenarios.