Commit b0bcdc04 authored by Selvarasu Ganesan's avatar Selvarasu Ganesan Committed by Deepak Pandey
Browse files

docs/aemfvp-a: update the steps for installing repo



Update the repo installation steps, in addition mention the path to
find the boot logs, and fix some grammar issues in the documentations.
Signed-off-by: Selvarasu Ganesan's avatarSelvarasu Ganesan <selvarasu.ganesan@arm.com>
Change-Id: I66711b12c3e2ab532fe89d89156405acbbbd794c
parent 7ce08084
......@@ -108,8 +108,8 @@ Individual software component build (Optional)
The user can use the following command if they want to rebuild individual
software component. Each software component has a separate script to build that
component. After the software components have been built they must be packaged a
disk image using ``build-test-busybox.sh``.
component. After the software components have been built they must be packaged
as a disk image using ``build-test-busybox.sh``.
To rebuild individual software components, the command to be used is
......@@ -237,7 +237,7 @@ Example commands for booting Busybox are listed below.
When the script is executed, three terminal instances will be launched, one for
the SCP and two for the AP (Application Processor). The SCP will not be used in
booting of Armv-A Base AEM FVP. The AP will start booting Trusted Firmware-A,
then UEFI/U-Boot, then BusyBox.
followed by UEFI/U-Boot, and then BusyBox.
To run terminal-only mode on hosts without graphics/display:
......@@ -256,6 +256,10 @@ To stop the model, exit telnet:
Ctrl + ]
telnet> close
Note: The boot logs can be found at ``<aemfvp-a_workspace>/aemfvp-a`` path after
booting busybox.
--------------
*Copyright (c) 2021, Arm Limited. All rights reserved.*
......
......@@ -23,7 +23,7 @@ Features
--------
- (AARCH64) UEFI + Busybox boot supported with latest stable kernel version 5.13.
- (AARCH64) U-Boot + Busybox boot supported with latest stable kernel version 5.13.
- Linux distribution boot supported and the following distribution are verified
- Linux distribution boot supported and the following distributions are verified
with Armv-A Base AEM FVP.
- Fedora-34-1.2
......@@ -41,7 +41,7 @@ Platform Support
Known issues or Limitations
---------------------------
- Ubuntu 20.04.1 installation may take longer compared to other distribution
- Ubuntu 20.04.1 installation may take longer time compared to other distribution
installations on Armv-A Base AEM FVP.
- The Armv-A Base AEM FVP model hangs when Linux reboot is triggered after the
model is booted with U-Boot and Busybox.
......
......@@ -249,6 +249,10 @@ To stop the model, exit telnet:
Ctrl + ]
telnet> close
Note: The boot logs can be found at ``<aemfvp-a_workspace>/aemfvp-a`` path after
booting distribution.
--------------
*Copyright (c) 2021, Arm Limited. All rights reserved.*
......
......@@ -79,7 +79,7 @@ FVP closes abruptly
Tests such as distribution installation take few hours to complete on Armv-A
Base AEM FVP. If the model quits abruptly during its execution
without any particular error message displayed in the model launch
without any particular error message displayed on the model launch
window, the host machine's memory requirements have to be rechecked.
Refer to the `model document`_ for more information about the system
requirements and follow the recommended configurations.
......
......@@ -48,13 +48,11 @@ To ensure that all the required packages for FVP are installed, run:
Repo
----
All packages except for the ``repo`` tool can be installed using ``apt-get``.
Follow the instructions provided in the `repo README file`_ to install the
``repo tool``.
Note: While ``repo`` is available to install with ``apt-get`` this is not a
supported configuration.
Follow the instructions provided in the `AOSP guide`_ to install the ``repo``
tool.
NOTE: The repo tool which gets installed using apt-get command sometimes return
errors, in such a case it's recommended to install repo using the ``curl`` method.
The ``repo`` tool uses ``git`` to download the source code.
It should be configured before using the ``repo`` tool.
......@@ -65,7 +63,6 @@ It should be configured before using the ``repo`` tool.
git config --global user.email "you@example.com"
Downloading the software stack
==============================
......@@ -80,7 +77,7 @@ This section explains the procedure to sync the software stack.
mkdir <aemfvp-a_workspace>
cd <aemfvp-a_workspace>
- For obtaining the latest *stable* software stack, use the following commands
- For fetching the latest *stable* software stack, use the following commands
to sync:
::
......@@ -93,9 +90,9 @@ This section explains the procedure to sync the software stack.
repo sync
Note: The repo tool requires at least Python 3.6 to be installed on the
development machine. On machines where python3 is not the default, the
development machine. On machines where python3 is not used as default, the
repo init command will fail to complete. Refer to the `troubleshooting guide`_
on resolving this issue.
for resolving this issue.
Note: To reduce the size of the commit history that is downloaded (and reduce
the time taken to download the platform software stack), append "--depth=1"
......@@ -132,11 +129,11 @@ that directory when prompted for during the FVP installation process.
Enable network on Armv-A Base AEM FVP
=====================================
The Armv-A Base AEM FVP supports virtual ethernet interface to allow
networking support to be usable for the software executed by the Armv-A
Base AEM FVP. If support for networking is required, the host TAP interface
has to be set up before the Armv-A Base AEM FVP is launched. To set up the
TAP interface, execute the following commands on the host machine.
The Armv-A Base AEM FVP supports virtual ethernet interface to allow networking
support, used for the software executed by the Armv-A Base AEM FVP. If support
for networking is required, the host TAP interface has to be set up before the
Armv-A Base AEM FVP is launched. To set up the TAP interface, execute the
following commands on the host machine.
- Install libvirt-bin
......@@ -276,7 +273,7 @@ Root Filesystem (Distribution)
This environment provides the base firmware (TF-A and UEFI) to boot the distribution
on Armv-A Base AEM FVP and does not have a separate script to create the installable
distribution images. The installable distribution images are fetched from the
corresponding repository. The GRUB, Linux, and Rootfs are part of the installable
corresponding repository. The GRUB, Linux, and Rootfs are parts of the installable
distribution images.
Report security vulnerabilities
......@@ -308,7 +305,7 @@ introduced in each release is listed in `change log`_.
.. _Busybox Boot: docs/aemfvp-a/busybox-boot.rst
.. _Distribution Boot: docs/aemfvp-a/distro-boot.rst
.. _change log: docs/aemfvp-a/change-log.rst
.. _AOSP guide: https://source.android.com/setup/develop#installing-repo
.. _repo README file: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md
.. _troubleshooting guide: docs/aemfvp-a/troubleshooting-guide.rst
.. _here: https://gitlab.arm.com/arm-reference-solutions/arm-reference-solutions-manifest
.. _Trusted Firmware-A: https://git.trustedfirmware.org/TF-A/trusted-firmware-a
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment