mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-05-03 22:17:03 +00:00
4adea0c15b
Fix formatting and adhere to the recommendations published by the documentation owner when writing reST documents. Simplify the instructions by referencing the main Getting Started Guide. This is now possible with the latest code since what required us to modify the source code and build the components are now parameters we can set when installing ACRN. This simplifies the instructions *a lot*. Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
87 lines
3.5 KiB
ReStructuredText
87 lines
3.5 KiB
ReStructuredText
.. _getting_started_up2:
|
|
|
|
Getting started guide for UP2 board
|
|
###################################
|
|
|
|
Hardware setup
|
|
**************
|
|
|
|
The `UP Squared board <http://www.up-board.org/upsquared/>`_ (UP2) is the x86 maker board based on Intel Apollo Lake platform. The UP boards have been used in IoT, industrial automation, digital signage and more. The UP2 features Intel `Celeron N3550 <https://ark.intel.com/products/95598/Intel-Celeron-Processor-N3350-2M-Cache-up-to-2_4-GHz>`_ and Intel `Pentium N4200 <https://ark.intel.com/products/95592/Intel-Pentium-Processor-N4200-2M-Cache-up-to-2_5-GHz>`_ SoCs. Both have been confirmed to work with ACRN.
|
|
|
|
Connecting to the serial port
|
|
=============================
|
|
|
|
The UP2 board has two serial ports. Please refer to the `UP2 specifications <http://www.up-board.org/upsquared/specifications-up2/>`_ for more information. We'll access the serial port through the I/O pins in the 40-pin HAT connector using a `USB TTL serial cable <http://www.ftdichip.com/Products/USBTTLSerial.htm>`_. Connect pin 6 (``GND``), pin 8 (``TX``) and pin 10 (``RX``) of the HAT connector to respectively the ``GND``, ``RX`` and ``TX`` pins of your USB serial cable. Plug the USB TTL serial cable into your PC and use a console emulation tool such as ``minicom`` or ``putty`` to communicate with the UP2 board for debugging.
|
|
|
|
Software setup
|
|
**************
|
|
|
|
Setting up the ACRN hypervisor (and associated components) on the UP2
|
|
board is no different than other hardware platforms so please follow
|
|
the instructions provided in the :ref:`getting_started`.
|
|
|
|
There are a few parameters specific to the UP2 board that differ from
|
|
what is referenced in the :ref:`getting_started` section:
|
|
|
|
1. Serial Port settings
|
|
#. Storage device name
|
|
#. ``pci_devices_ignore`` parameter
|
|
|
|
You will need to keep these in mind in a few places:
|
|
|
|
* When mounting the EFI System Partition (ESP)
|
|
|
|
.. code-block:: console
|
|
|
|
# mount /dev/mmcblk0p1 /mnt
|
|
|
|
* When adjusting the ``acrn.conf`` file
|
|
|
|
* Change the ``options`` line and set ``pci_devices_ignore=(0:18:1)``
|
|
* Set the ``root=`` parameter using the ``PARTUUID`` or device name directly
|
|
|
|
* When configuring the EFI firmware to boot the ACRN hypervisor by default
|
|
|
|
.. code-block:: console
|
|
|
|
# efibootmgr -c -l "\EFI\acrn\acrn.efi" -d /dev/mmcblk0 -p 1 -L "ACRN Hypervisor" \
|
|
-u "bootloader=\EFI\org.clearlinux\bootloaderx64.efi uart=mmio@0x9141e000"
|
|
|
|
UP2 serial port setting
|
|
=======================
|
|
|
|
The serial port in the 40-pin HAT connector is located at ``MMIO 0x0x9141e000``.
|
|
You can check this from the ``dmesg`` output from the initial Clearlinux installation.
|
|
|
|
.. code-block:: console
|
|
|
|
# dmesg | grep dw-apb-uart
|
|
[2.150689] dw-apb-uart.8: ttyS1 at MMIO 0x91420000 (irq = 4, base_baud = 115200) is a 16550A
|
|
[2.152072] dw-apb-uart.9: ttyS2 at MMIO 0x9141e000 (irq = 5, base_baud = 115200) is a 16550A
|
|
|
|
The second entry associated with ``dw-apb-uart.9`` is the one on the 40-pin HAT connector.
|
|
|
|
UP2 block device
|
|
================
|
|
|
|
The UP2 board has an on-board eMMC device. The device name to be used
|
|
throughout the :ref:`getting_started` therefore is ``/dev/mmcblk0``
|
|
(and ``/dev/mmcblk0pX`` for any partition).
|
|
|
|
The UUID of the partition ``/dev/mmcblk0p3`` can be found by
|
|
|
|
.. code-block:: console
|
|
|
|
# blkid /dev/mmcblk
|
|
|
|
.. note::
|
|
You can also use the device name directly, e.g.: ``root=/dev/mmcblk0p3``
|
|
|
|
Running the hypervisor
|
|
**********************
|
|
|
|
Now that the hypervisor and Service OS have been installed on your UP2 board,
|
|
you can proceed with the rest of the instructions in the :ref:`getting_started`
|
|
and install the User OS (UOS).
|
|
|