doc: spell check and formatting

Fix misspellings missed during regular reviews, and remove trailing
white space and Windows \r at end of lines.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2019-01-07 13:13:03 -08:00
committed by David Kinder
parent fad44184a5
commit 4c541ba18c
7 changed files with 153 additions and 150 deletions

View File

@@ -1,6 +1,6 @@
.. _using-sbl-up2:
Using SBL on UP2 Borad
Using SBL on UP2 Board
######################
This document builds on the :ref:`getting-started-up2`, and explains how to use
@@ -14,8 +14,8 @@ please visit `<https://slimbootloader.github.io/how-tos/boot-acrn.html>`_.
.. image:: images/sbl_boot_flow_UP2.png
:align: center
We show a verified Boot Sequence with SBL on an Intel® Architecture platform UP2,
We show a verified Boot Sequence with SBL on an Intel® Architecture platform UP2,
and the boot process proceeds as follows:
#. SBL verifies and boots the ACRN hypervisor and Service OS kernel
@@ -39,8 +39,8 @@ The following hardware and software are required to use SBL on an UP2 board:
.. image:: images/up2_sbl_connections.png
:align: center
The connections between USB to TTL Serial Cable and USB 2.0 Pin Header
Cable shoule be:
The connections between USB to TTL Serial Cable and USB 2.0 Pin Header
Cable should be:
.. image:: images/up2_sbl_cables_connections.png
:align: center
@@ -49,8 +49,8 @@ Build SBL
*********
Follow the steps of `Building <https://slimbootloader.github.io/supported-hardware/up2.html#building>`_
and `Stitching <https://slimbootloader.github.io/supported-hardware/up2.html#stitching>`_
from `<https://slimbootloader.github.io/supported-hardware/up2.html>`_ to generate the
and `Stitching <https://slimbootloader.github.io/supported-hardware/up2.html#stitching>`_
from `<https://slimbootloader.github.io/supported-hardware/up2.html>`_ to generate the
BIOS binary file ``<SBL_IFWI_IMAGE>``, which is the new IFWI image with SBL in BIOS region.
@@ -60,14 +60,14 @@ Flash SBL on the UP2
#. Download the appropriate BIOS update for `UP2 Board <https://downloads.up-community.org/download/up-board-uefi-bios-upc1dm15/>`_.
#. Put the empty USB flash drive in your PC and format it as FAT32.
#. Decompress the BIOS zip file into the formatted drive.
#. 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 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:``. (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 <SBL_IFWI_IMAGE> -y
@@ -98,14 +98,14 @@ An example of the configuration file ``uos.json``:
}
.. note::
To generate the image with a specified version, please modify
the "Version" argument, ``"Version": 26000`` instead
To generate the image with a specified version, please modify
the "Version" argument, ``"Version": 26000`` instead
of ``"Version": 26880`` for example.
Clone the source code of ``acrn-hypervisor`` and build SOS and LaaG image:
.. code-block:: none
cd ~
git clone https://github.com/projectacrn/acrn-hypervisor
sudo ./acrn-hypervisor/devicemodel/samples/up2/create-up2-images.sh --images-type all \
@@ -119,19 +119,19 @@ This step will generate the images of SOS and LaaG:
* up2_laag.img
.. note::
When building images, you can modify the ``--clearlinux-version`` argument
to a specific version (such as 26800). To generate the images of SOS only,
When building images, you can modify the ``--clearlinux-version`` argument
to a specific version (such as 26800). To generate the images of SOS only,
modify the ``--images-type`` argument to ``sos``.
We still need the binary image for GPT partitions and
We still need the binary image for GPT partitions and
configuration file for flashing:
* partition_desc.bin
* flash_LaaG.json
.. note::
``partition_desc.bin`` and ``flash_LaaG.json`` are in the diretory
``partition_desc.bin`` and ``flash_LaaG.json`` are in the directory
``~/acrn-hypervisor/doc/tutorials/``.
@@ -159,22 +159,25 @@ configuration file for flashing:
+------------------------------+---------------------------------------------------+
.. note::
In this step, please build SOS and LaaG images in Clear Linux rather than Ubuntu.
In this step, please build SOS and LaaG images in Clear Linux rather than Ubuntu.
Download and install flash tool
*******************************
#. Download Intel® Platform Flash Tool Lite from `<https://github.com/projectceladon/tools/tree/master/platform_flash_tool_lite/latest/>`_.
#. Download Intel® Platform Flash Tool Lite from
`<https://github.com/projectceladon/tools/tree/master/platform_flash_tool_lite/latest/>`_.
#. For Ubuntu host, install `platformflashtoollite_5.8.9.0_linux_x86_64.deb <https://github.com/projectceladon/tools/blob/master/platform_flash_tool_lite/latest/platformflashtoollite_5.8.9.0_linux_x86_64.deb>`_ for example.
#. For Ubuntu host, install `platformflashtoollite_5.8.9.0_linux_x86_64.deb
<https://github.com/projectceladon/tools/blob/master/platform_flash_tool_lite/latest/platformflashtoollite_5.8.9.0_linux_x86_64.deb>`_
for example.
SOS and LaaG Installation
*************************
#. Connect a USB cable from the debug board to your Ubuntu host machine,
and run the following command to verify that its USB serial port is
#. Connect a USB cable from the debug board to your Ubuntu host machine,
and run the following command to verify that its USB serial port is
discovered and showing under ``/dev``.
.. code-block:: none
@@ -187,57 +190,57 @@ SOS and LaaG Installation
.. code-block:: none
sudo minicom -s /dev/ttyUSB0
.. note::
Please verify the minicom serial port settings are 115200 8N1 and
both HW and SW flow control are turned off.
both HW and SW flow control are turned off.
#. When you see following console log, please press any key to enter
#. When you see following console log, please press any key to enter
shell command
.. code-block:: none
====================Os Loader====================
Press any key within 2 second(s) to enter the command shell
Shell>
#. Swap the boot sequence of ``DevType: MEM`` to ``Idx:0``:
.. code-block:: none
Shell> boot
Boot options (in HEX):
Idx|ImgType|DevType|DevNum|Flags|HwPart|FsType|SwPart|File/Lbaoffset
0| 0| MMC | 0 | 0 | 0 | RAW | 1 | 0x0
1| 4| MEM | 0 | 0 | 0 | RAW | 0 | 0x0
SubCommand:
s -- swap boot order by index
a -- modify all boot options one by one
q -- quit boot option change
idx -- modify the boot option specified by idx (0 to 0x1)
s
Updated the Boot Option List
Boot options (in HEX):
Idx|ImgType|DevType|DevNum|Flags|HwPart|FsType|SwPart|File/Lbaoffset
0| 4| MEM | 0 | 0 | 0 | RAW | 0 | 0x0
1| 0| MMC | 0 | 0 | 0 | RAW | 1 | 0x0
Shell> boot
Boot options (in HEX):
Idx|ImgType|DevType|DevNum|Flags|HwPart|FsType|SwPart|File/Lbaoffset
0| 0| MMC | 0 | 0 | 0 | RAW | 1 | 0x0
1| 4| MEM | 0 | 0 | 0 | RAW | 0 | 0x0
SubCommand:
s -- swap boot order by index
a -- modify all boot options one by one
q -- quit boot option change
idx -- modify the boot option specified by idx (0 to 0x1)
s
Updated the Boot Option List
Boot options (in HEX):
Idx|ImgType|DevType|DevNum|Flags|HwPart|FsType|SwPart|File/Lbaoffset
0| 4| MEM | 0 | 0 | 0 | RAW | 0 | 0x0
1| 0| MMC | 0 | 0 | 0 | RAW | 1 | 0x0
#. Exit and reboot to fastboot mode:
.. code-block:: none
Shell> exit
40E0 | 175118 ms | 158 ms | Kernel setup
40F0 | 175144 ms | 26 ms | FSP ReadyToBoot/EndOfFirmware notify
4100 | 175144 ms | 0 ms | TPM IndicateReadyToBoot
@@ -265,17 +268,17 @@ SOS and LaaG Installation
USB for fastboot transport layer selected
#. When UP2 board is in fastboot mode, you should be able
see the device in Platform Flash Tool. Select the
#. When UP2 board is in fastboot mode, you should be able
see the device in Platform Flash Tool. Select the
file ``flash_LaaG.json`` and modify ``Configuration``
to ``SOS_and_LaaG``. Click ``Start to flash`` to flash images.
.. image:: images/platformflashtool_start_to_flash.png
:align: center
Boot to SOS
Boot to SOS
***********
After flashing, UP2 board will automaticlly reboot and
After flashing, UP2 board will automatically reboot and
boot to ACRN hypervisor. And login SOS by following command:
.. image:: images/sos_console_login.png
@@ -284,11 +287,11 @@ boot to ACRN hypervisor. And login SOS by following command:
Launch UOS
**********
Run the ``launch_uos.sh`` script to launch the UOS:
.. code-block:: none
cd ~
wget https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/doc/tutorials/launch_uos.sh
sudo ./launch_uos.sh -V 1
**Congratulations**, you are now watching the User OS booting up!
.. code-block:: none
cd ~
wget https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/doc/tutorials/launch_uos.sh
sudo ./launch_uos.sh -V 1
**Congratulations**, you are now watching the User OS booting up!