Skip to content

Commit 52618d0

Browse files
lirui34dbkinder
authored andcommitted
doc: Update WaaG tutorial launch script and OVMF binary
Change WaaG launch script to the default ``launch_win.sh``, and also provide one OVMF.fd binary in order to launch WaaG. Change SOS / UOS to Service VM / Guest VM. Signed-off-by: lirui34 <ruix.li@intel.com>
1 parent 8f65bfe commit 52618d0

File tree

2 files changed

+24
-18
lines changed

2 files changed

+24
-18
lines changed

doc/tutorials/OVMF.fd

2 MB
Binary file not shown.

doc/tutorials/using_windows_as_uos.rst

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _using_windows_as_uos:
22

3-
Using Windows as Guest OS on ACRN
3+
Using Windows as Guest VM on ACRN
44
#################################
5-
This tutorial describes how to launch Windows as the Guest OS on the ACRN hypervisor.
5+
This tutorial describes how to launch Windows as a Guest (WaaG) VM on the ACRN hypervisor.
66

77
Hardware setup
88
**************
@@ -14,13 +14,13 @@ The following Intel Kaby Lake NUCs are verified:
1414
"NUC7i7DNHE", "DNKBLi7v.86A.0052.2018.0808.1344", "`link <https://downloadcenter.intel.com/download/28886?v=t>`__"
1515
"NUC7i5DNHE", "DNKBLi5v.86A.0060.2018.1220.1536", "`link <https://downloadcenter.intel.com/download/28885?v=t>`__"
1616

17-
ACRN Service OS Setup
17+
ACRN Service VM Setup
1818
*********************
1919
You may refer to the steps in :ref:`getting-started-apl-nuc` for
2020
Intel NUC to set up ACRN on the KBL NUC. After following the steps in that guide,
21-
you should be able to launch a Clear Linux UOS successfully.
21+
you should be able to launch the Service VM successfully.
2222

23-
Setup for Using Windows as Guest OS
23+
Setup for Using Windows as Guest VM
2424
***********************************
2525
All the patches to support WaaG have been upstreamed; you can download them
2626
from the acrn-hypervisor repository.
@@ -41,14 +41,14 @@ Build ACRN EFI Images
4141

4242
#. Replace the ``acrn.efi`` and ``acrn-dm`` on your NUC:
4343

44-
a. Log in to the ACRN Service OS and then ``mount`` the EFI partition to ``/boot``
44+
a. Log in to the ACRN Service VM and then ``mount`` the EFI partition to ``/boot``
4545
#. ``scp`` the ``acrn.efi`` and ``acrn-dm`` from your host::
4646

4747
# scp <acrn.efi from your host> /boot/EFI/acrn/
4848
# scp <acrn-dm from your host> /usr/bin/
4949
# chmod +x /usr/bin/acrn-dm && sync
5050

51-
Build Service OS Kernel
51+
Build Service VM Kernel
5252
=======================
5353
#. Follow the steps described at :ref:`getting-started-building` to set up the build environment.
5454
#. Follow the steps below to build the ACRN kernel::
@@ -73,13 +73,13 @@ Update Kernel on KBL NUC
7373

7474
.. code-block:: none
7575
76-
title The ACRNGT Service OS
76+
title The ACRNGT Service VM
7777
linux /bzImage
7878
options console=tty0 console=ttyS0 root=/dev/sda3 rw rootwait ignore_loglevel no_timer_check consoleblank=0 i915.nuclear_pageflip=1 i915.avail_planes_per_pipe=0x010101 i915.domain_plane_owners=0x011100001111 i915.enable_gvt=1 i915.enable_conformance_check=0 i915.enable_guc=0 hvlog=2M@0x1FE00000
7979
8080
.. note:: Change ``/dev/sda3`` to your file system partition.
8181

82-
#. ``reboot`` the Service OS and select ``The ACRNGT Service OS`` from the boot menu to apply
82+
#. ``reboot`` the Service VM and select ``The ACRNGT Service VM`` from the boot menu to apply
8383
the ACRN kernel and hypervisor updates.
8484

8585
Create Windows 10 Image
@@ -103,7 +103,7 @@ Preparations
103103

104104
* Download `virtio Windows driver
105105
<https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/archive-virtio/virtio-win-0.1.141-1/virtio-win-0.1.141.iso>`_
106-
to the Service OS in ``/root/img/virtio-win-0.1.141.iso``.
106+
to the Service VM in ``/root/img/virtio-win-0.1.141.iso``.
107107

108108
* Download `Intel DCH Graphics Driver <https://downloadmirror.intel.com/28148/a08/dch_win64_25.20.100.6444.exe>`_.
109109

@@ -252,7 +252,7 @@ Pre-install drivers and re-generate Windows ISO
252252

253253
Create Raw Disk
254254
---------------
255-
Run these commands on the Service OS::
255+
Run these commands on the Service VM::
256256

257257
# swupd bundle-add kvm-host
258258
# mkdir /root/img
@@ -268,7 +268,7 @@ version is used to install Windows 10 on ACRN from scratch. The
268268
<https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/doc/tutorials/install_by_vga_gsg.tar.gz>`_
269269
together with the script used to install Windows 10.
270270

271-
#. Uncompress ``install_by_vga_gsg.tar.gz`` to the Service OS::
271+
#. Uncompress ``install_by_vga_gsg.tar.gz`` to the Service VM::
272272

273273
# tar zxvf install_by_vga_gsg.tar.gz && cd install_by_vga_gsg
274274

@@ -335,8 +335,12 @@ together with the script used to install Windows 10.
335335

336336
Boot Windows with GVT-g on ACRN
337337
===============================
338-
#. Launch the Windows Guest using the ``launch_igx-waag.sh``. You should see the WaaG desktop
339-
coming up over the HDMI monitor (instead of the VNC).
338+
#. Modify the ``/usr/share/acrn/samples/nuc/launch_win.sh`` script to specify the Windows image generated above.
339+
340+
#. Download `OVMF.fd <https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/doc/tutorials/OVMF.fd>`_
341+
binary to the directory in Service VM: ``/usr/share/acrn/samples/nuc/``.
342+
343+
#. Run the ``launch_win.sh`` and you should see the WaaG desktop coming up over the HDMI monitor (instead of the VNC).
340344

341345
.. note:: Use the following command to disable the GNOME Display Manager (GDM) if it is enabled::
342346

@@ -345,9 +349,10 @@ Boot Windows with GVT-g on ACRN
345349
.. note:: You must connect two monitors to the KBL NUC in order to launch Windows with
346350
the default configurations above.
347351

348-
.. note:: The second monitor must include the Weston desktop. If you have set up Weston in the Service OS,
352+
.. note:: The second monitor must include the Weston desktop. If you have set up Weston in the Service VM,
349353
follow the steps in :ref:`skl-nuc-gpu-passthrough` to set up Weston as
350-
the desktop environment in SOS in order to experience Windows with the AcrnGT local display feature.
354+
the desktop environment in Service VM in order to experience Windows with the AcrnGT local display feature.
355+
351356

352357
ACRN Windows verified feature list
353358
**********************************
@@ -398,11 +403,12 @@ Device configurations of acrn-dm command line
398403
This is for the network virtualization.
399404

400405
* *-s 5,fbuf,tcp=0.0.0.0:5900,w=800,h=600*:
401-
This will open a port 5900 on SOS which can be connected to via vncviewer.
406+
This will open a port 5900 on Service VM which can be connected to via vncviewer.
402407

403408
* *-s 6,virtio-input,/dev/input/event4*:
404409
This is to passthrough the mouse/keyboard to Windows via virtio.
405-
Please change ``event4`` accordingly. You can use the following command to check the event node on your SOS::
410+
Please change ``event4`` accordingly. You can use the following command to check
411+
the event node on your Service VM::
406412

407413
<To get the input event of mouse>
408414
# cat /proc/bus/input/devices | grep mouse

0 commit comments

Comments
 (0)