Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / arm-trusted-firmware / 10e7a9e904dfddd62ee839098e2d0737a3afad15 / . / docs / contents.rst
blob: 4909dabe6750d9b2a51090dda88723291936c203 [file] [log] [blame]
John Tsichritzisa16fd372019-05-24 12:27:49 +0100[diff] [blame]1Trusted Firmware-A Documentation Contents
2=========================================
3
4This document serves as a list of the documentation that is included with the
5Trusted Firmware-A source.
6
7Introduction
8------------
9
10`About Trusted Firmware-A`_
11
12Getting Started
13---------------
14
15`Frequently-Asked Questions (FAQ)`_
16
17`Image Terminology`_
18
19`Porting Guide`_
20
21`User Guide`_
22
23Contributing
24------------
25
26`Coding Style and Guidelines`_
27
28`Contributor Acknowledgements`_
29
30`Contributor's Guide`_
31
32`License`_
33
34`Maintainers`_
35
36Processes and Policies
37----------------------
38
39`Platform Compatibility Policy`_
40
41`Release Processes`_
42
43Secure Payload Dispatch
44-----------------------
45
46`OP-TEE Dispatcher`_
47
48`Trusted Little Kernel (TLK) Dispatcher`_
49
50`Trusty Dispatcher`_
51
52System Design and Components
53----------------------------
54
55`Arm CPU Specific Build Macros`_
56
57`Arm SiP Services`_
58
59`Authentication Framework & Chain of Trust`_
60
61`CPU Reset`_
62
63`EL3 Runtime Service Writer’s Guide`_
64
65`Exception Handling Framework`_
66
67`Firmware Design Overview`_
68
69`Firmware Update (FWU)`_
70
71`Interrupt Management Framework`_
72
73`Library at ROM`_
74
75`Platform Interrupt Controller API`_
76
77`PSCI Library Integration Guide for Armv8-A AArch32 systems`_
78
79`PSCI Power Domain Tree design`_
80
81`Reliability, Availability, and Serviceability (RAS) Extensions`_
82
83`Secure Partition Manager`_
84
85`Software Delegated Exception Interface`_
86
87`Translation (XLAT) Tables Library`_
88
89`Trusted Board Boot Design Guide`_
90
91Performance and Testing
92-----------------------
93
94`PSCI Performance Measurements on Arm Juno Development Platform`_
95
96Security and Advisories
97-----------------------
98
99`Security Processes`_
100
101`TFV-1`_
102
103`TFV-2`_
104
105`TFV-3`_
106
107`TFV-4`_
108
109`TFV-5`_
110
111`TFV-6`_
112
113`TFV-7`_
114
115`TFV-8`_
116
117Other Documents
118---------------
119
120`Change Log`_
121
122.. _About Trusted Firmware-A: ../readme.rst
123.. _Frequently-Asked Questions (FAQ): ./process/faq.rst
124.. _Image Terminology: ./getting_started/image-terminology.rst
125.. _Porting Guide: ./getting_started/porting-guide.rst
126.. _User Guide: ./getting_started/user-guide.rst
127.. _Coding Style and Guidelines: ./process/coding-guidelines.rst
128.. _Contributor Acknowledgements: ./acknowledgements.rst
129.. _`Contributor's Guide`: ./process/contributing.rst
130.. _License: ../license.rst
131.. _Maintainers: ./maintainers.rst
132.. _Platform Compatibility Policy: ./process/platform-compatibility-policy.rst
133.. _Release Processes: ./process/release-information.rst
134.. _Arm SiP Services: ./components/arm-sip-service.rst
135.. _Exception Handling Framework: ./components/exception-handling.rst
136.. _Firmware Update (FWU): ./components/firmware-update.rst
137.. _Interrupt Management Framework: ./design/interrupt-framework-design.rst
138.. _Library at ROM: ./components/romlib-design.rst
139.. _Platform Interrupt Controller API: ./components/platform-interrupt-controller-API.rst
140.. _`Reliability, Availability, and Serviceability (RAS) Extensions`: ./components/ras.rst
141.. _Secure Partition Manager: ./components/secure-partition-manager-design.rst
142.. _Software Delegated Exception Interface: ./components/sdei.rst
143.. _Translation (XLAT) Tables Library: ./components/xlat-tables-lib-v2-design.rst
144.. _OP-TEE Dispatcher: ./components/spd/optee-dispatcher.rst
145.. _Trusted Little Kernel (TLK) Dispatcher: ./components/spd/tlk-dispatcher.rst
146.. _Trusty Dispatcher: ./components/spd/trusty-dispatcher.rst
147.. _Arm CPU Specific Build Macros: ./design/cpu-specific-build-macros.rst
148.. _`Authentication Framework & Chain of Trust`: ./design/auth-framework.rst
149.. _CPU Reset: ./design/reset-design.rst
150.. _`EL3 Runtime Service Writer’s Guide`: ./getting_started/rt-svc-writers-guide.rst
151.. _Firmware Design Overview: ./design/firmware-design.rst
152.. _PSCI Library Integration Guide for Armv8-A AArch32 systems: ./getting_started/psci-lib-integration-guide.rst
153.. _PSCI Power Domain Tree design: ./design/psci-pd-tree.rst
154.. _Trusted Board Boot Design Guide: ./design/trusted-board-boot.rst
155.. _PSCI Performance Measurements on Arm Juno Development Platform: ./perf/psci-performance-juno.rst
156.. _Security Processes: ./process/security.rst
157.. _Change Log: ./change-log.rst
158.. _TFV-1: ./security_advisories/security-advisory-tfv-1.rst
159.. _TFV-2: ./security_advisories/security-advisory-tfv-2.rst
160.. _TFV-3: ./security_advisories/security-advisory-tfv-3.rst
161.. _TFV-4: ./security_advisories/security-advisory-tfv-4.rst
162.. _TFV-5: ./security_advisories/security-advisory-tfv-5.rst
163.. _TFV-6: ./security_advisories/security-advisory-tfv-6.rst
164.. _TFV-7: ./security_advisories/security-advisory-tfv-7.rst
165.. _TFV-8: ./security_advisories/security-advisory-tfv-8.rst