The main TF-A Tests documentation on ReadTheDocs does not use the
top-level readme file. However, as explained in commit f6ee8fbc
("Revert "Remove unused top-level readme file""), we still want to
keep it because it is the page displayed on
https://git.trustedfirmware.org/TF-A/tf-a-tests.git/about

.

That said, this readme file does not need to provide such detailed
information, instead it can simply be a landing page providing a brief
overview of the project and redirecting the reader to RTD for further
information.

Revisit the top-level readme file in this way, and also fix/update a
number of broken/out-dated links in it.

Change-Id: If53cfa9bd0bf2cba044883bb7ba5e5114bfb2bf8
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

Add a document that provides instructions on how to build a rendered
version of the documentation using the Sphinx tool.

Change-Id: I57159ec867a3ba7e003e7c7cd6ac53fb190356f2
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

The feature overview page points to the revision B published in November
2016, update the link to point to the latest version (currently 1.2
published in March 2020).

Remove the link from implementing-tests.rst, as it is not referenced in
the page.

Change-Id: I9ac12eba39d33914bfc2474a5a9851e628010349
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

* changes:
  cactus: select different stdout device at runtime
  pl011: allow alternate stdout to be used
  cactus: do not compile irrelevant test files

cactus is used as both primary and secondary VM and for debug logging
primary VM can access to UART while secodary VM's use hypervisor call to
SPM.

Based on VM id it will be decided whether to use UART or hypervisor call
for debug logging.

Signed-off-by: Manish Pandey <manish.pandey2@arm.com>
Change-Id: I97786b893c0156815969692582b4de62c1b568fd

Till now only pl011 UART is available stdout but there is a usecase to
redirect it to other channel.

This patch decouples console_putc implementation from pl011.

Signed-off-by: Manish Pandey <manish.pandey2@arm.com>
Change-Id: I38e8c5c90421fad2425228f407e6f29bdf6b08c7

Now Cactus image is only used for showcasing SPCI Beta1 spec features,
however there are some residual tests(related with SPRT) which are no
more relevant.

Signed-off-by: Manish Pandey <manish.pandey2@arm.com>
Change-Id: Ia049f20f47c8d68d84b25a424d6a064592c3b0af

This reverts commit fbf26ee1.

The readme file removed by this commit is indeed not used by ReadTheDocs
but it is the one displayed on:
https://git.trustedfirmware.org/TF-A/tf-a-tests.git/about



Change-Id: I267a247bb32c570e254553d65b93bf70cdaf76e4
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

* changes:
  Update list of maintainers
  Remove unused top-level readme file

Change-Id: I9e53651762a99b02d07a94d8ef1807d9be0a777e
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

Command to build HTML-formatted pages from docs:

> make doc

Change-Id: I63938aaf3913126ab9036a6acaaf786a1199aef2
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

As explained in the commit message of c595384d ("doc: Copy readme
content to docs/index.rst"), the docs/index.rst file is the new landing
page/entry point for reading the docs. The top-level readme file can be
removed, now that the docs layout have been restructured.

Change-Id: I591e1800500878722c6dbc6be1af704290f82cf3
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

* changes:
  doc: Update link formats
  doc: Update page content after re-arrangement
  doc: Sync common content with TF-A
  doc: Move content from Porting Guide
  doc: Migrate content from User Guide and update it
  doc: Move tools info to Getting Started chapter
  doc: Move content to new About chapter
  doc: Copy readme content to docs/index.rst

Use docutils/Sphinx-type linking with the :ref: keyword where
possible, instead of direct links to files.

As part of this patch some external links have been updated too,
especially those that point to the TF-A docs. Some link targets
are no longer valid but can be restored after the TF-A User Guide
is split up.

Change-Id: I328d5141cf9b32471bf669bfc0191e8f6f883a48
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>

This patch modifies the content of existing documents now that
it has been moved around. Some of the content requires updating
to make sense in its new location, for example. Other content may
simply be out of date.

Change-Id: I8dfa527e1d1f1520cefd21066802451352b573d2
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>

Some information, such as contact details, is shared between
TF-A and the TF-A Tests. Bring this into line with what is in
the TF-A repo.

Change-Id: I910e229a93da67c85d70c633d5a4597a6a788b50
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>

The Porting Guide document is broken down into separate,
per-topic documents that all live under the new "Porting"
chapter.

Change-Id: I269fa06cbf6544ce3c76700d1fcf3a669793c483
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>

The User Guide document holds many different bits of
information that are not always related to each other. These
are moved out into files where information is grouped tightly
together.

This also updates build instructions and environment variable
instructions to link to the relevent parts of the TF-A user guide
and use more recent versions of compiler, respetively.

Change-Id: Iace851f93c7dea8f154ae52a2665dd599f2e5d72
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>

The Getting Started chapter will hold information on
requirements and on performing initial set-up and build
activities.

Change-Id: Iacf14a049b20f59c84aeaefa1271255ed60a8a5b
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>

This new chapter is created to hold project-related info
such as methods of contact, supported platforms, and so on.

Change-Id: Ifece3a8d9ba7f7862416a0c81a8707833da4aec7
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>

The docs/index.rst file is the new landing page / entry point
for reading the docs so the top-level content needs to be copied
there.

The existing content in readme.rst cannot be modified to point to
the new page until the hosted copy of the docs has gone live (in
order to have a working URL).

Change-Id: Ifa9e65d463c2887bbd53f7224aa803796aeec68f
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>

Signed-off-by: Madhukar Pappireddy <madhukar.pappireddy@arm.com>
Change-Id: Iac2f428490066bf7629f45c781d145298ec50524

Signed-off-by: Madhukar Pappireddy <madhukar.pappireddy@arm.com>
Change-Id: Ide56f234752ede1d998bdebd31bf39e0ac7105f9

The issue with the test has been fixed with the TF-A patch:
https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/3778


so re-enable it.

Signed-off-by: Zelalem <zelalem.aweke@arm.com>
Change-Id: Ie394b596c7da504c74c684af3ef5f6065a05eef9

For pre-Armv8.4 platform, the supported model is that SPMC runs at
S-EL1. The candidate is OP-TEE with SPCI protocol adaptation. This patch
performs a version check through direct messaging and determines if
OP-TEE runs as SPMC by checking version responses. If this does not
match, then it assumes SPMC runs at S-EL2 with two Cactus instances
running at S-EL1.

Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I34194b6e8b3d447a25f2153bbac1be2631cd7a5e

* changes:
  cactus: generate JSON file required by TF-A
  tftf: re-introduce spm tests in the flow
  cactus: update sample manifest to SPCI Beta1 format
  cactus: add symbols relocation fixup
  cactus: update build options and memory map to make it PIE
  cactus: update to SPCI Beta1 and add sample direct messaging test
  tftf: SPCI Beta1 add direct messaging test
  tftf: update SPCI svc header to latest Beta1 spec
  tftf: provide hvc conduit facility

Manish Pandey2 authored Mar 16, 2020 and Olivier Deprez committed Mar 23, 2020

Generate JSON file which is being passed as "SP_LAYOUT_FILE" build
parameter to TF-A build.
Two instances of cactus is used to demonstrate functioning of multiple
SP's. cactus-secondary dts is same as cactus dts except for UUID and
load address.

Signed-off-by: Manish Pandey <manish.pandey2@arm.com>
Change-Id: Ib6d8f7d5d4894495754da0ce39f663263eeb182f

Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I3a80e023c71426605abb13303d466a9b93f3123e

Notice, the dtb generation wrapper script had a provision
to automatically generate an "extra" memory description section.
This will be revisited later when SP boot time memory region
is implemented in SPM.

Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I4fb9e23004871d74eee4a1d1f4be0826695e3e9f

Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: Ibde8aadecf6ae6c320d01ee2acab9c3c8db3859d

Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I9287361d2a4c81954fae715fef6ba5cc57cc10e0

The scenario is: TFTF (acting as an "hypervisor" at NS-EL2) sends a
direct message request to an SP targetting its SP ID. SPMD/SPMC relays
the message down to SP. SP extracts the message payload, amends it and
sends a direct message response to TFTF that SPMC/SPMD relay back to
TFTF. This sample SP can be instantiated into multiple SPs. The early
main entry flow discriminates the first VM from other secondary VMs by
getting its running id through SPCI_ID_GET. The SP runs an infinite
message loop and waits for a new message by calling SPCI_MSG_WAIT.
Notice SPCI_MSG_WAIT is also the hint to SPMD that the SP initialized
properly. About logging, only PVM for now has direct access to UART.
2nd VMs must use the debug log hypervisor call.

Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I001261c3f54e0bc217e43fca6812d6cda1ac4430