This change enhances the script by adding a dynamic wait mechanism that
monitors the microdroid VM's boot process.A timeout of 10 minutes is
included to prevent indefinite waiting.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

Added a feature to handle_start_microdroid_cmd to support the --auto-connect
option. When --auto-connect is specified, the script will automatically attempt
to connect to the VM after booting it.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

Added a print_help function to display usage instructions and detailed
descriptions for each command option. The help function will be called when
the script is passed the help option or when an invalid option is provided.
This ensures the script provides clear guidance on how to use each command and
handles invalid input gracefully.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

Separated the sanity checks to be specific for each command entered, avoiding
unnecessary calls in case of wrong input. Introduced two new functions:
tc_env_init and tc_demo_app_init. The tc_env_init function is responsible for
the basic sanity checks required for all commands, while the tc_demo_app_init
function includes additional checks specific to running the TC demo app.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

Added the vm-connect option to enable connecting to the microdroid running
instance/instances shell. User can connect to a running microdroid instance
by passing the CID to the vm-connect option, i.e.:

        ./run_microdroid_demo.sh vm-connect <CID number>

If no CID is specified, the script will search for the available CIDs. If only
one is found, it will automatically connect to it. If multiple instances are
found, the script will prompt the available CIDs for the user to select one of
them to connect to.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

This change enables the script to run the Microdroid VM itself along with
the TC demo app. Use 'start-microdroid' to start the VM with an empty payload
and 'run-tc-app' to run the TC Microdroid demo app.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

- Extracted TC Microdroid demo app commands into handle_run_tc_app_cmd function
- Added ADB and directory variable definitions for reuse
- Used case statement to handle 'run-tc-app' command and future commands
- Removed redundant inline commands and improved readability

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

-l argument doesn't work with version 3.0, also ns uart pane have
larger size without -l argument for all version of tmux so remove
-l argument.

Signed-off-by: Jagdish Gediya <jagdish.gediya@arm.com>

This is helpful when artifacts are downloaded from CI build or copied
from other places to boot FVP locally.

Signed-off-by: Jagdish Gediya <jagdish.gediya@arm.com>

Once when run in the TMUX session, it launches 4 panes for every
termimal. So we can simply debug the system with the terminal.

Add a new option "--tumx" to allow uses to launch console terminals in
TUI sessions. This option is exclusive with "--telnet" option, only one
of them can be used.

The original idea comes from Qixiang Xu <qixiang.xu@arm.com>.

Suggested-by: Qixiang Xu <qixiang.xu@arm.com>
Signed-off-by: Leo Yan <leo.yan@arm.com>

Change SCP uart from debug uart to SoC uart 0

Signed-off-by: Tintu Thomas <tintu.thomas@arm.com>

rse was previously called rss

Signed-off-by: Ben Horgan <ben.horgan@arm.com>

RSS has been renamed to RSE. Updating the name of the variables.

Signed-off-by: Alex Dobrescu <alex.dobrescu@arm.com>

This patch makes the following changes to the model arguments:
- SIC_AUTH_ENABLE/SIC_DECRYPT_ENABLE - these allow the RSS to use
authentication in the SIC (which is used when the XIP flag is set as is
now the case for all TC platforms)
- VMADDRWIDTH=16 - this specifies that the size of the RSS SRAM is 64KiB
which matches the RSS source code expectation (again with the XIP flag
enabled)

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

This reverts commit ec57a880.

Internal model parameter has been updated which requires RSS change. For
compatibility with current RSS downstream, hardcode the existing value
in the run_model.sh script.

Note this should be removed once the RSS has been updated.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

Ahmed Genidi authored Apr 03, 2024 and Sergio da Silva Alves committed Apr 04, 2024

Validates the values of TC_ANDROID_VERSION for the correct version
in the run_microdroid_demo.sh script. Provides clear error messages
for incorrect configurations, preventing silent failures.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

As with other networking modes, we need to use the hostbridge which
resides in the RoS, not the wider board in order for networking to
function correctly.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

Due to a FVP bug, this value is currently hardcoded in the FVP to an
incorrect value. Temporarily override that here to allow the boot to
continue.

Note, this sets a default value in the RSS integrity checker. Without
this the integrity checker fails to verify when loading data into the
OTP, leading the RSS boot to fail.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

This reflects a change made in the upstream TF-M. Here the CM
provisioning bundle load address has been moved to SRAM + OTP_DMA_ICS_SIZE
(which has a value of 0x400).

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

New TF-M updates the CM provisioning bundle name. Update this in the run
script.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

Adapt run_microdroid for Android 13 and 14 compatibility. Uses version-specific
commands for app execution, supporting Android 14.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

Introduce tc_check_microdroid_apk_build to verify APK build success. Exits with
error if APK is missing, ensuring build integrity before proceeding.

Signed-off-by: Ahmed Genidi <ahmed.genidi@arm.com>

The FVP conveniently pops up a status and a graphical window as well as
a new terminal window for every UART interface. However, these windows
are quite clunky (can't copy from them), half the time just one is
needed, and using a headless machine is completely impossible. Add
--visualisation to get rid of the graphical windows when they are not
needed and --telnet to disable the terminals and let the user connect
with their preferred (telnet) client.  UARTs will start at port 5000 and
count up. The FVP is smart enough to detect which ports are taken up and
use higher port numbers so having many runs at the same time is also
possible. Port numbers should even be stable as long as just 1 out of N
running FVPs is killed and restarted.  This allows for easy to use
headless runs.

Also add a --debug to make debugging easier.

Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>

System commands usually list arguments to parameters after the argument
name. They also separate required from optional arguments visually
rather than tagging them.

This way it's more clear whether options require a parameter and what it
is. Lines are more concise, and there's less boilerplate to scan
through.

Also align with spaces so the help "renders" the same on every machine.

Also change the double `shift` command to `shift 2` to save on a line
for each option as it is getting long with boilerplate.

Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>

Quoc Khanh Le authored Jan 19, 2024 and Quoc Khanh Le committed Feb 15, 2024

After the unification of build options for android distro in build-scripts,
update the run option for android distro from android-fvp to android

Signed-off-by: Quoc Khanh Le <QuocKhanh.Le@arm.com>

This reverts commit cc056268.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

This change includes:
* Saving fvp model run logs into the files form different terminals
* Introduced a new argument used as suffix to give custom name to the
  log directory. This is to differentiate special case logs from the
  regular logs.
  Ex: Logs to be shared with other teams.

Signed-off-by: Rupinderjit Singh <rupinderjit.singh@arm.com>

Set the number of CMEs in the TC4 FVP to 2 (in line with the SAR). Note
that, as per model logic, this also enables the SME and SME2
instructions on the FVP.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

Add a new variable which allows individual platforms to specify
additional model parameters which are custom to the platform. Initially,
this is an empty string.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>

The logs file occasionally gets committed and we never want it to be.
Add a gitignore to prevent that

Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>

Build-scripts now knows how to build all target permutations from the
same checkout. This moves around the deploy directory for scripts so
update it accordingly. It also does away with the trusty distinction,
instead relying on multibuild to handle it, therefore changing (and
unifying!) a bunch of binary names.

Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>

Ahmed Genidi authored Dec 14, 2023 and Ahmed Genidi committed Dec 29, 2023

Adding a new parameter for the virtio image path for the fvp.
This will unify the scripts for tc4 and other tc variants.
tc4 will use the new one, others use the old one:
	-TC4: cpnss.ros.virtio_blockdevice.image_path
	-TCx: board.virtioblockdevice.image_path

Signed-off-by: Ahmed Genidi <Ahmed.Genidi@arm.com>

BL1_IMAGE_FILE is no longer used as BL1 is loaded through the FIP.

Signed-off-by: Alex Dobrescu <alex.dobrescu@arm.com>

Linux has a requirement to be loaded at 2 MiB aligned address. To
comply, u-boot will accept any load address and quietly move it to such
an address. For whatever reason the load address on the FVP isn't 2MiB
aligned but is fairly close so we needlessly lose time.

Move the address to 2MiB above the start of ram to simplify u-boot's
job. This also aligns the FVP with the FPGA and enables a unified
u-boot.

Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>

These parameters (specifying the networking type and ethernet controller
settings) reside within the RoS and therefore we must update the start
of the model parameters to use the RoS path variable.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

Rework the variable which specifies the name of the model parameter for
the MMC file. Instead of passing a variable which specifies the whole
name, instead specify the model parameter path to the RoS (which
contains the MMC). This allows for making use of this RoS variable in
other parts of the common script.

Note that if the same IP block is instantiated in the different RoSs,
its parameters will have the same format and the only change will be the
RoS path (specified in the first part of the model parameter).

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

TC2, TC3 and TC4 run_model.sh are almost identical except for the difference
of a few key parameters. Therefore it makes sense to unify them into a
single common run_model.sh which is sourced by each of the other
scripts. This avoids any functional changes.

Note the differences between the scripts are as follows:
- Name of deploy directory (handled by the TC_PLATFORM) variable
- Model parameter name for the MMC (handled by the BOARD_MMC_FILE
variable)
- Names of the UARTS, this is handled by hardcoding the name of each
UART in the top level script
- The RSS subsystem path, this is handled by the RSS_NAME variable

We also keep the output directory for the logs the same by specifying
the following to be the logs dir...

LOGS_DIR="$(realpath --no-symlinks "${RUN_SCRIPTS_DIR}")"/logs

This ensures that the logs are still output in the directory
for the specific platform as before instead of the common directory.

This patch also adds additional features to the TC2 and TC3 run_model.sh
script to ensure that these are compatible with TC4. Specifically the
following have changed:
- We now explicitly set uart_enable=1 for all UARTs. This is required
for TC4 RSS UART and it is cleanest to set it for all UARTS.
- For TC2, we bring in the features added to the TC3 script, namely that
a run.sh script will now be generated in the log output directory.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>

Current UART used to generate SCP log file is incorrect, change it to
specify the UART that the SCP is actually using.

Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>