blob: b483671193ba709485fae9d5628fee8efb1c03e9 [file] [log] [blame]
Paul Beesley717bac42019-10-22 11:08:15 +00001Trusted Firmware-A Tests Documentation
2======================================
3
4.. toctree::
5 :maxdepth: 1
6 :hidden:
7
8 Home<self>
Jimmy Brissonc5953842020-04-02 15:18:59 -05009 about/index
10 getting_started/index
Jimmy Brisson0862f012020-04-02 15:19:12 -050011 process/index
Paul Beesley717bac42019-10-22 11:08:15 +000012 design
Jimmy Brissona48f5072020-04-02 15:19:16 -050013 implementing-tests
14 porting/index
Paul Beesley717bac42019-10-22 11:08:15 +000015 change-log
Paul Beesley9fec7b22019-11-11 10:46:54 +000016 license
Paul Beesley717bac42019-10-22 11:08:15 +000017
Jimmy Brissonc5953842020-04-02 15:18:59 -050018The Trusted Firmware-A Tests (TF-A-Tests) is a suite of baremetal tests to
19exercise the `Trusted Firmware-A (TF-A)`_ features from the Normal World. It
20enables strong TF-A functional testing without dependency on a Rich OS. It
21mainly interacts with TF-A through its SMC interface.
22
23It provides a basis for TF-A developers to validate their own platform ports and
24add their own test cases.
25
Jimmy Brissonc5953842020-04-02 15:18:59 -050026Getting started
27---------------
28
29Get the TF-A Tests source code from `trustedfirmware.org`_.
30
31See the `User Guide`_ for instructions on how to install, build and use the TF-A
32Tests.
33
34See the `Design Guide`_ for information on how the TF-A Tests internally work.
35
36See the `Porting Guide`_ for information about how to use this software on
37another Armv8-A platform.
38
39See the `Contributing Guidelines`_ for information on how to contribute to this
40project.
41
Paul Beesley717bac42019-10-22 11:08:15 +000042--------------
43
44*Copyright (c)2019, Arm Limited. All rights reserved.*
Jimmy Brissonc5953842020-04-02 15:18:59 -050045
Jimmy Brissonc5953842020-04-02 15:18:59 -050046.. _Juno Arm Development Platform: https://developer.arm.com/products/system-design/development-boards/juno-development-board
47
48.. _Power State Coordination Interface (PSCI): PSCI_
49.. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf
50.. _Software Delegated Exception Interface (SDEI): SDEI_
51.. _SDEI: http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf
52.. _SMC Calling Convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf
53
54.. _trustedfirmware.org: https://git.trustedfirmware.org/TF-A/tf-a-tests.git
55
56.. _Trusted Firmware-A (TF-A): TF-A_
57.. _TF-A: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/about
58.. _Test Secure Payload (TSP): TSP_
59.. _TSP: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/tree/bl32/tsp
60.. _Performance Measurement Framework (PMF): PMF_
61.. _PMF: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/about/docs/firmware-design.rst#performance-measurement-framework
62.. _Firmware update: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/about/docs/firmware-update.rst
63.. _EL3 payload: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/about/docs/user-guide.rst#el3-payloads-alternative-boot-flow
64.. _Secure partition: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/about/docs/secure-partition-manager-design.rst