From da14265d8966f8ea78877e5f14f28942ec454e5f Mon Sep 17 00:00:00 2001 From: Tintu Thomas Date: Wed, 18 May 2022 14:56:25 +0100 Subject: [PATCH] docs/totalcompute: Addressed OOB comments for TC1 q2 release Re-arranged user-guide to place appropriate information under Poky and Android run sections. Removed python-pip from the list of prerequisites. Added information on how to get the latest git version and how to configure it. Added approximate time needed for Android boot. Signed-off-by: Tintu Thomas --- docs/totalcompute/tc1/user-guide.rst | 50 +++++++++++++++++++--------- 1 file changed, 34 insertions(+), 16 deletions(-) diff --git a/docs/totalcompute/tc1/user-guide.rst b/docs/totalcompute/tc1/user-guide.rst index 693900e..e8955b9 100755 --- a/docs/totalcompute/tc1/user-guide.rst +++ b/docs/totalcompute/tc1/user-guide.rst @@ -43,6 +43,21 @@ To get the latest repo tool from google, run the following commands: chmod a+x ~/bin/repo export PATH=~/bin:$PATH +To get the latest stable git version for Ubuntu: + +:: + + add-apt-repository ppa:git-core/ppa + apt update + apt-get install git + +To configure the git username and email: + +:: + + git config --global user.name "FIRST_NAME LAST_NAME" + git config --global user.email "MY_NAME@example.com" + If syncing and building android, the minimum requirements for the host machine can be found at https://source.android.com/setup/build/requirements, These include: * At least 250GB of free disk space to check out the code and an extra 150 GB to build it. If you conduct multiple builds, you need additional space. * At least 16 GB of available RAM/swap. @@ -341,6 +356,13 @@ the previously built images as arguments. Run the ``run_model.sh`` script: -t, --tap-interface [OPTIONAL] enable TAP interface -e, --extra-model-params [OPTIONAL] extra model parameters +When the script is run, two terminal instances will be launched. terminal_s0 used for the SCP, +TF-A, OP-TEE core logs and terminal_s1 used by TF-A early boot, Hafnium, U-boot and Linux. + +Once the FVP is running, the SCP will be the first to boot, bringing the AP out of reset. +The AP will start booting from its ROM and then proceed to boot Trusted Firmware-A, Hafnium, +Secure Partitions (OP-TEE, Trusted Services in Poky and Trusty in Android) then U-Boot, and then Linux and Poky/Android. + Running Poky ############ @@ -348,6 +370,16 @@ Running Poky ./run-scripts/tc1/run_model.sh -m -d poky +When booting Poky, the model will boot Linux and present a login prompt. Login +using the username ``root``. You may need to hit Enter for the prompt to appear. + +The OP-TEE and Trusted Services are initialized in Poky distribution. The functionality of OP-TEE and +core set of trusted services such as Crypto and Internal Trusted Storage can be invoked only on Poky distribution. +For OP-TEE, the TEE sanity test suite can be run using command ``xtest``. +For Trusted Services, run command ``ts-service-test -sg ItsServiceTests -sg PsaCryptoApiTests -sg +CryptoServicePackedcTests -sg CryptoServiceProtobufTests -sg CryptoServiceLimitTests -v`` for Service API level tests +and run command ``ts-demo`` for the demonstration client application. + Running Android ############### @@ -362,22 +394,8 @@ Running Android For running android with AVB enabled: ./run-scripts/tc1/run_model.sh -m -d android-swr -a true -When the script is run, two terminal instances will be launched. terminal_s0 used for the SCP, -TF-A, OP-TEE core logs and terminal_s1 used by TF-A early boot, Hafnium, U-boot and Linux. - -Once the FVP is running, the SCP will be the first to boot, bringing the AP out of reset. -The AP will start booting from its ROM and then proceed to boot Trusted Firmware-A, Hafnium, -Secure Partitions (OP-TEE, Trusted Services in Poky and Trusty in Android) then U-Boot, and then Linux and Poky/Android. - -When booting Poky the model will boot Linux and present a login prompt. Login -using the username ``root``. You may need to hit Enter for the prompt to appear. - -The OP-TEE and Trusted Services are initialized in Poky distribution. The functionality of OP-TEE and -core set of trusted services such as Crypto and Internal Trusted Storage can be invoked only on Poky distribution. -For OP-TEE, the TEE sanity test suite can be run using command ``xtest``. -For Trusted Services, run command ``ts-service-test -sg ItsServiceTests -sg PsaCryptoApiTests -sg -CryptoServicePackedcTests -sg CryptoServiceProtobufTests -sg CryptoServiceLimitTests -v`` for Service API level tests -and run command ``ts-demo`` for the demonstration client application. +Android boot is time consuming. For instance, it takes approximately 1.5 hours (On a 12 core machine with 32GB RAM) +to display the Android logo screen and another 2 hours to display the home screen. On Android distribution, Trusty provides a Trusted Execution Environment (TEE). The functionality of Trusty IPC can be tested using command ``tipc-test -t ta2ta-ipc`` with root privilege. -- GitLab