diff --git a/doc/tutorials/create-up2-images.sh b/doc/tutorials/create-up2-images.sh index 4e7089ef7..445ec6c16 100755 --- a/doc/tutorials/create-up2-images.sh +++ b/doc/tutorials/create-up2-images.sh @@ -1,20 +1,22 @@ -#!/bin/bash +# Copyright (C) 2018 Intel Corporation. +# SPDX-License-Identifier: BSD-3-Clause +#!/bin/bash usage() { echo "Usage: $0 [options]" - echo "This script build images for SBL based platforms" + echo "This script builds images for Slim Boot Loader (SBL) based platforms" echo "options:" echo "--mirror-url default: 'https://cdn.download.clearlinux.org/releases/', for swupd" - echo "--acrn-code-path: Specify acrn_hypervisor code path for acrn sbl build. If acrn-sbl-path is provided, acrn-code-path will be ignored" - echo "--acrn-sbl-path: Specify acrn sbl binary path. If acrn-sbl-path isn't provided, acrn_code_path will be must option" - echo "--clearlinux-version: mandatory option for sos images build" - echo "--images-type: Specify the type of OS image to build (sos/laag/all, default vaule is all)" + echo "--acrn-code-path: Specify acrn-hypervisor code path for ACRN SBL build. If acrn-sbl-path is provided, acrn-code-path will be ignored" + echo "--acrn-sbl-path: Specify ACRN SBL binary path. If acrn-sbl-path isn't provided, acrn_code_path will be must option" + echo "--clearlinux-version: mandatory option for sos image build" + echo "--images-type: Specify the type of OS image to build (sos/laag/all, default value is all)" echo "--sign-key: Specify the debug key for signing, default value provided" - echo "--sos-rootfs-size: Specify the sos_rootfs image size, default value is 3584M" - echo "--laag-image-size: Specify the laag image size, default value is 10240M" - echo "--sos-bundle-append: Specify more sos bundles need to be add" - echo "--laag-json: mandatory option for uos image build, used for ister.py" + echo "--sos-rootfs-size: Specify the sos_rootfs image size in MB, default value is 3584" + echo "--laag-image-size: Specify the laag image size in MB, default value is 10240" + echo "--sos-bundle-append: Specify additional bundles to be installed in the sos" + echo "--laag-json: mandatory option, used by ister.py to build the uos" } @@ -50,7 +52,7 @@ create_sos_images() { if [ ${ACRN_HV_CODE_PATH} ] then make -C ${ACRN_HV_CODE_PATH} clean || return 1 - make -C ${ACRN_HV_CODE_PATH} hypervisor PLATFORM=sbl BOARD=up2 FIRMWARE=sbl || return 1 + make -C ${ACRN_HV_CODE_PATH} hypervisor BOARD=up2 FIRMWARE=sbl || return 1 ACRN_SBL=${ACRN_HV_CODE_PATH}/build/hypervisor/acrn.32.out else echo "Need to provide acrn.sbl or acrn-hypervisor source code path" @@ -283,3 +285,4 @@ then fi exit 0 + diff --git a/doc/tutorials/launch_uos.sh b/doc/tutorials/launch_uos.sh index 590c8fb2e..4c69b5d38 100644 --- a/doc/tutorials/launch_uos.sh +++ b/doc/tutorials/launch_uos.sh @@ -1,3 +1,6 @@ +# Copyright (C) 2018 Intel Corporation. +# SPDX-License-Identifier: BSD-3-Clause + #!/bin/bash @@ -363,23 +366,15 @@ fi -B "$kernel_cmdline" $vm_name } -function launch_alios() -{ -#AliOS is not Android, only has same configuration currently, reuse launch function - -launch_android "$@" -} - function help() { -echo "Use luanch_uos.sh like that ./launch_uos.sh -V <#>" +echo "Use launch_uos.sh like that ./launch_uos.sh -V <#>" echo "The option -V means the UOSs group to be launched by vsbl as below" echo "-V 1 means just launching 1 clearlinux UOS" echo "-V 2 means just launching 1 android UOS" echo "-V 3 means launching 1 clearlinux UOS + 1 android UOS" echo "-V 4 means launching 2 clearlinux UOSs" -echo "-V 5 means just launching 1 alios UOS" -echo "-V 6 means auto check android/linux/alios UOS; if exist, launch it" +echo "-V 5 means auto check android/linux UOS; if exist, launch it" } launch_type=1 @@ -413,9 +408,7 @@ mount /dev/mmcblk0p3 /data if [ $launch_type == 6 ]; then if [ -f "/data/android/android.img" ]; then - launch_type=2; - elif [ -f "/data/alios/alios.img" ]; then - launch_type=5; + launch_type=2 else launch_type=1; fi @@ -456,9 +449,6 @@ case $launch_type in sleep 5 launch_clearlinux 2 1 "64 448 4" 0x070F00 clearlinux_dup "L2aaG" $debug ;; - 5) echo "Launch alios UOS" - launch_alios 1 3 "64 448 8" 0x070F00 alios "AliaaG" $debug - ;; esac umount /data diff --git a/doc/tutorials/using_sbl_on_up2.rst b/doc/tutorials/using_sbl_on_up2.rst index c65904c39..b1fac9f63 100644 --- a/doc/tutorials/using_sbl_on_up2.rst +++ b/doc/tutorials/using_sbl_on_up2.rst @@ -6,6 +6,11 @@ Using SBL on UP2 Borad This document builds on the :ref:`getting-started-up2`, and explains how to use SBL instead of UEFI to boot UP2 board. +Slim Bootloader is an open-source boot firmware solution, +built from the ground up to be secure, lightweight, and highly +optimized while leveraging robust tools and libraries from +the EDK II framework. + .. image:: images/sbl_boot_flow_UP2.png :align: center @@ -13,7 +18,7 @@ We show a verified Boot Sequence with SBL on an Intel® Architecture platform UP and the boot process proceeds as follows: #. SBL verifies and boots the ACRN hypervisor and Service OS kernel -#. Service OS kernel verifies and loads ACRN Device Model and vSBL through ``dm-verity`` +#. Service OS kernel verifies and loads ACRN Device Model and vSBL #. vSBL starts the User-side verified boot process @@ -35,11 +40,6 @@ The following hardware and software are required to use SBL on an UP2 board: Build SBL ********* -Slim Bootloader is an open-source boot firmware solution, -built from the ground up to be secure, lightweight, and highly -optimized while leveraging robust tools and libraries from -the EDK II framework. - Follow the steps of `Building `_ and `Stitching `_ from ``_ to generate the @@ -54,23 +54,16 @@ Flash SBL on the UP2 #. Put the empty USB flash drive in your PC and format it as FAT32. #. Decompress the BIOS zip file into the formatted drive. #. Attach the USB disk and keyboard to the board and power it on. -#. During boot, press :kbd:`F7` on the usb keyboard to enter the UEFI BIOS boot menu. -#. Navigate through the following menus and select ``Build-in EFI shell``. +#. During boot, press :kbd:`F7` on the keyboard to enter the UEFI BIOS boot menu. +#. Navigate through the following menus and select ``Built-in EFI shell``. #. Please take note of which filesystem number ``fs*`` your USB drive is mapped to. -#. Switch to that filesystem, e.g. ``fs1:``. +#. Switch to that filesystem, e.g. ``fs1:``. (Don't forget the colon.) #. Navigate to the path where you decompressed the update (the ``cd`` and ``ls`` commands are available here, as if in an Unix shell). .. code-block:: none - + Fpt_3.1.50.2222.efi -f -y -.. note:: - Note the trailing colon on the command ``fs*`` and ``fs1:`` for example. - -.. note:: - The current version of UP Board UEFI BIOS is ``R1.5``, - and the programming software version is ``Fpt_3.1.50.2222.efi``. - Build ACRN for UP2 ****************** @@ -98,7 +91,7 @@ An example of the configuration file ``uos.json``: .. note:: To generate the image with a specified version, please modify - the "Version" argument, and we can set ``"Version": 26000`` instead + the "Version" argument, ``"Version": 26000`` instead of ``"Version": 26880`` for example. Clone the source code of ``acrn-hypervisor`` and build SOS and LaaG image: @@ -107,7 +100,8 @@ Clone the source code of ``acrn-hypervisor`` and build SOS and LaaG image: cd ~ git clone https://github.com/projectacrn/acrn-hypervisor - sudo ./acrn-hypervisor/devicemodel/samples/up2/create-up2-images.sh --images-type all --clearlinux-version 26880 --laag-json uos.json --acrn-code-path ~/acrn-hypervisor/ + sudo ./acrn-hypervisor/devicemodel/samples/up2/create-up2-images.sh --images-type all \ + --clearlinux-version 26880 --laag-json uos.json --acrn-code-path ~/acrn-hypervisor/ This step will generate the images of SOS and LaaG: