From c3582dcd040f6bd38a035e1b101b8ccfb32aa505 Mon Sep 17 00:00:00 2001 From: Deb Taylor Date: Tue, 24 Mar 2020 21:04:35 -0400 Subject: [PATCH] Doc: Edits to workaround note for EFI command line option string issue. Signed-off-by: Deb Taylor --- doc/getting-started/rt_industry.rst | 16 +++++++++++----- doc/tutorials/running_deb_as_serv_vm.rst | 13 ++++++++++--- doc/tutorials/using_ubuntu_as_sos.rst | 19 ++++++++++--------- 3 files changed, 31 insertions(+), 17 deletions(-) diff --git a/doc/getting-started/rt_industry.rst b/doc/getting-started/rt_industry.rst index 89b842868..8727f4d0c 100644 --- a/doc/getting-started/rt_industry.rst +++ b/doc/getting-started/rt_industry.rst @@ -154,11 +154,16 @@ Use the pre-installed industry ACRN hypervisor Boot000D* INTEL SSDPEKKW256G8 : PART 0 : Boot Drive BBS(HD,,0x0)..BO Boot000E* UEFI : INTEL SSDPEKKW256G8 : PART 0 : OS Bootloader PciRoot(0x0)/Pci(0x1d,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-00)/HD(1,GPT,8aa992f8-8149-4f6b-8b64-503998c776c1,0x800,0x47000)..BO - .. note:: Ensure that ACRN is first in the boot order, or you may use ``efibootmgr -o 1`` command to move it - to the first position. If you need to enable the serial port, run the following command before rebooting: + .. note:: Ensure that ACRN is first in the boot order, or you may use the + ``efibootmgr -o 1`` command to move it to the first position. If you need to enable the serial port, run the following command before rebooting: ``efibootmgr -c -l '\EFI\acrn\acrn.efi' -d /dev/sda -p 1 -L ACRN -u "uart=port@0x3f8 "`` + Note the extra space at the end of the EFI command-line options + string. This is a workaround for a current `efi-stub bootloader name + issue `_. + It ensures that the end of the string is properly detected. + #. Reboot KBL NUC. #. Use the ``dmesg`` command to ensure that the Service VM boots: @@ -206,9 +211,10 @@ Use the ACRN industry out-of-the-box image # efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/sda -p 1 -L "ACRN" -u "uart=port@0x3f8 " - .. note:: This is a workaround for the issue in efi-stub; - Add an extra space to the EFI option to make sure space could be used to detect the end of bootloader name string. - The extra space can be removed after the issue in efi-stub is fixed later. + .. note:: Note the extra space at the end of the EFI command-line options + strings above. This is a workaround for a current `efi-stub bootloader + name issue `_. + It ensures that the end of the string is properly detected. #. Reboot the test machine. After the Clear Linux OS boots, log in as “root” for the first time. diff --git a/doc/tutorials/running_deb_as_serv_vm.rst b/doc/tutorials/running_deb_as_serv_vm.rst index e9dc947cf..40e45cb98 100644 --- a/doc/tutorials/running_deb_as_serv_vm.rst +++ b/doc/tutorials/running_deb_as_serv_vm.rst @@ -14,7 +14,7 @@ Use the following instructions to install Debian. - Navigate to `Debian 10 iso `_. Select and download **debian-10.1.0-amd64-netinst.iso** (scroll down to the bottom of the page). - Follow the `Debian installation guide `_ to install it on your NUC; we are using an Intel Kaby Lake NUC (NUC7i7DNHE) in this tutorial. -- :ref:`install-build-tools-dependencies` for ACRN. +- Install the necessary development tools. Refer to :ref:`install-build-tools-dependencies` for ACRN. - Update to the latest iASL (required by the ACRN Device Model): .. code-block:: bash @@ -63,7 +63,7 @@ Install ACRN on the Debian VM $ sudo mkdir /boot/efi/EFI/acrn/ $ sudo cp ~/acrn-hypervisor/build/hypervisor/acrn.efi /boot/efi/EFI/acrn/ - $ sudo efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/sda -p 1 -L "ACRN Hypervisor" -u "bootloader=\EFI\debian\grubx64.efi" + $ sudo efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/sda -p 1 -L "ACRN Hypervisor" -u "bootloader=\EFI\debian\grubx64.efi " $ sudo efibootmgr -v # shows output as below Timeout: 1 seconds BootOrder: 0009,0003,0004,0007,0005,0006,0001,0008,0002,0000 @@ -78,7 +78,14 @@ Install ACRN on the Debian VM Boot0008* Linux bootloader VenHw(99e275e7-75a0-4b37-a2e6-c5385e6c00cb) Boot0009* ACRN Hypervisor HD(1,GPT,94597852-7166-4216-b0f1-cef5fd1f2349,0x800,0x100000)/File(\EFI\acrn\acrn.efi)b.o.o.t.l.o.a.d.e.r.=.\.E.F.I.\.d.e.b.i.a.n.\.g.r.u.b.x.6.4...e.f.i. - #. Install the Service VM kernel and reboot: + + .. note:: + Note the extra space at the end of the EFI command-line options + string above. This is a workaround for a current `efi-stub + bootloader name issue `_. + It ensures that the end of the string is properly detected. + + b. Install the Service VM kernel and reboot: .. code-block:: bash diff --git a/doc/tutorials/using_ubuntu_as_sos.rst b/doc/tutorials/using_ubuntu_as_sos.rst index 63cbda4dc..1806f111c 100644 --- a/doc/tutorials/using_ubuntu_as_sos.rst +++ b/doc/tutorials/using_ubuntu_as_sos.rst @@ -118,10 +118,11 @@ the source code, build it, and install it on your device. sudo efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/nvme0n1 -p 1 \ -L "ACRN Hypervisor" -u "bootloader=\EFI\ubuntu\grubx64.efi " - .. Note:: - This is a workaround for the issue in efi-stub; - Add an extra space to the EFI option to make sure space could be used to detect the end of bootloader name string. - This extra space can be removed after issue in efi-stub fixed later. + .. note:: + Note the extra space at the end of the EFI command-line options + strings above. This is a workaround for a current `efi-stub + bootloader name issue `_. + It ensures that the end of the string is properly detected. #. Verify that "ACRN Hypervisor" is added and that it will boot first: @@ -220,9 +221,9 @@ Download the latest Service VM kernel. start the Ubuntu Desktop and you can now log in (as before). .. note:: - If you don't see the Grub menu after rebooting the system (and you are - not booting into the ACRN hypervisor), enter the EFI firmware at boot - (using :kbd:`F10`) and manually select ``ACRN Hypervisor``. + If you don't see the Grub menu after rebooting the system (and you are + not booting into the ACRN hypervisor), enter the EFI firmware at boot + (using :kbd:`F10`) and manually select ``ACRN Hypervisor``. If you see a black screen on the first-time reboot after installing the ACRN Hypervisor, wait a few moments and the Ubuntu desktop will @@ -303,8 +304,8 @@ for the Service VM. -s 3,virtio-blk,/root/clear-31670-kvm.img \ .. note:: - The User VM image can be stored in other directories instead of ``~/``. - Remember to also modify the image directory in ``launch_uos.sh``. + The User VM image can be stored in other directories instead of ``~/``. + Remember to also modify the image directory in ``launch_uos.sh``. Start the User VM *****************