Skip to content

Commit c50db02

Browse files
Geoffroy Van Cutsemdbkinder
authored andcommitted
Getting Started Guide: update (and simplify) GSG
Update the Getting Started Guide to remove some instructions that are now obsolete and add details of the cmdline parameters that can be passed to the ACRN hypervisor (EFI), namely: * bootloader= * uart= The wording of the GSG has been made less specific to the NUC platform so we can refer to it for new platform being supported without causing confusion to the reader Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
1 parent 4adea0c commit c50db02

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

doc/getting_started/index.rst

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@ Hardware setup
1515
**************
1616

1717
The Intel |reg| NUC (NUC6CAYH) is the supported reference target
18-
platform for ACRN work, as described in :ref:`hardware`, and is the only
19-
platform currently tested with these setup instructions.
18+
platform for ACRN work, as described in :ref:`hardware`, and is the main
19+
platform currently tested with these setup instructions. The
20+
`UP Squared board <http://www.up-board.org/upsquared/>`_ (UP2) is also
21+
known to work and the few specificities for it are described
22+
in :ref:`getting_started_up2`.
2023

2124
The recommended NUC hardware configuration is:
2225

@@ -26,9 +29,6 @@ The recommended NUC hardware configuration is:
2629
- Memory: 8G DDR3
2730
- SSD: 120G SATA
2831

29-
Software setup
30-
**************
31-
3232
Firmware update on the NUC
3333
==========================
3434

@@ -37,12 +37,15 @@ Follow these `BIOS Update Instructions
3737
<https://www.intel.com/content/www/us/en/support/articles/000005636.html>`__
3838
for downloading and flashing an updated BIOS for the NUC.
3939

40+
Software setup
41+
**************
42+
4043
Set up a Clear Linux Operating System
4144
=====================================
4245

4346
Currently, an installable version of ARCN does not exist. Therefore, you
44-
need to setup a base Clear Linux OS to bootstrap ACRN on the NUC. You'll
45-
need a network connection for your NUC to complete this setup.
47+
need to setup a base Clear Linux OS to bootstrap ACRN on your platform. You'll
48+
need a network connection for your platform to complete this setup.
4649

4750
.. note::
4851
ACRN requires Clear Linux version 22140 or newer. The instructions below
@@ -54,10 +57,10 @@ need a network connection for your NUC to complete this setup.
5457
https://download.clearlinux.org/releases/22140/clear/clear-22140-installer.img.xz
5558
and follow the `Clear Linux installation guide
5659
<https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install>`__
57-
as a starting point for installing Clear Linux onto your NUC. Follow the recommended
58-
options for choosing an **Automatic** installation type, and using the NUC's
60+
as a starting point for installing Clear Linux onto your platform. Follow the recommended
61+
options for choosing an **Automatic** installation type, and using the platform's
5962
storage as the target device for installation (overwriting the existing data
60-
and creating three partitions on the NUC's SSD drive).
63+
and creating three partitions on the platform's storage drive).
6164

6265
#. After installation is complete, boot into Clear Linux, login as
6366
**root**, and set a password.
@@ -97,7 +100,7 @@ need a network connection for your NUC to complete this setup.
97100
Add the ACRN hypervisor to the EFI Partition
98101
============================================
99102

100-
In order to boot the ACRN SOS on the NUC, you'll need to add it to the EFI
103+
In order to boot the ACRN SOS on the platform, you'll need to add it to the EFI
101104
partition. Follow these steps:
102105

103106
#. Mount the EFI partition and verify you have the following files:
@@ -119,6 +122,13 @@ partition. Follow these steps:
119122
and ``*-standard``) listed on your system,
120123
as you will need them later.
121124

125+
.. note::
126+
The EFI System Partition (ESP) may be different based on your hardware.
127+
It will typically be something like ``/dev/mmcblk0p1`` on platforms
128+
that have an on-board eMMC or ``/dev/nvme0n1p1`` if your system has
129+
a non-volatile storage media attached via a PCI Express (PCIe) bus
130+
(NVMe).
131+
122132
#. Put the ``acrn.efi`` hypervisor application (included in the Clear
123133
Linux release) on the EFI partition with:
124134

@@ -136,9 +146,7 @@ partition. Follow these steps:
136146

137147
.. code-block:: none
138148
139-
# efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/sda1 -p 1 -L ACRN
140-
# cd /mnt/EFI/org.clearlinux/
141-
# cp bootloaderx64.efi bootloaderx64_origin.efi
149+
# efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/sda -p 1 -L ACRN
142150
143151
.. note::
144152
Be aware that a Clearlinux update that includes a kernel upgrade will
@@ -193,7 +201,7 @@ partition. Follow these steps:
193201
.. literalinclude:: ../../hypervisor/bsp/uefi/clearlinux/acrn.conf
194202
:caption: hypervisor/bsp/uefi/clearlinux/acrn.conf
195203

196-
On the NUC, copy the ``acrn.conf`` file to the EFI partition we mounted earlier:
204+
On the platform, copy the ``acrn.conf`` file to the EFI partition we mounted earlier:
197205

198206
.. code-block:: none
199207
@@ -205,6 +213,9 @@ partition. Follow these steps:
205213

206214
Use ``blkid`` to find out what your ``/dev/sda3`` ``PARTUUID`` value is.
207215

216+
.. note::
217+
It is also possible to use the device name directly, e.g. ``root=/dev/sda3``
218+
208219
#. Add a timeout period for Systemd-Boot to wait, otherwise it will not
209220
present the boot menu and will always boot the base Clear Linux
210221

@@ -265,7 +276,7 @@ directory. Run it to create a network bridge:
265276
Set up Reference UOS
266277
====================
267278

268-
#. On your NUC, download the pre-built reference Clear Linux UOS image into your
279+
#. On your platform, download the pre-built reference Clear Linux UOS image into your
269280
(root) home directory:
270281

271282
.. code-block:: none
@@ -295,7 +306,7 @@ Set up Reference UOS
295306
# umount /mnt
296307
# sync
297308
298-
#. Edit and Run the launch_uos.sh script to launch the UOS.
309+
#. Edit and Run the ``launch_uos.sh`` script to launch the UOS.
299310

300311
A sample `launch_uos.sh
301312
<https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/devicemodel/samples/nuc/launch_uos.sh>`__

0 commit comments

Comments
 (0)