Commit 57354abb authored by Paul Beesley's avatar Paul Beesley
Browse files

doc: Remove per-page contents lists



These are no longer needed as there will always be a table of contents
rendered to the left of every page.

Some of these lists can be quite long and, when opening a page, the
reader sees nothing but a huge list of contents! After this patch,
the document contents are front-and-centre and the contents are
nicely rendered in the sidebar without duplication.

Change-Id: I444754d548ec91d00f2b04e861de8dde8856aa62
Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
parent 1ef35512
......@@ -4,8 +4,6 @@ Change Log & Release Notes
This document contains a summary of the new features, changes, fixes and known
issues in each release of Trusted Firmware-A.
.. contents::
Version 2.1
-----------
......
Exception Handling Framework
============================
.. contents::
:depth: 2
.. |EHF| replace:: Exception Handling Framework
.. |TF-A| replace:: Trusted Firmware-A
......
Firmware Update (FWU)
=====================
.. contents::
--------------
Introduction
------------
......
Platform Interrupt Controller API
=================================
.. contents::
This document lists the optional platform interrupt controller API that
abstracts the runtime configuration and control of interrupt controller from the
generic code. The mandatory APIs are described in the `porting guide`__.
......
Reliability, Availability, and Serviceability (RAS) Extensions
==============================================================
.. contents::
:depth: 2
.. |EHF| replace:: Exception Handling Framework
.. |TF-A| replace:: Trusted Firmware-A
......
Library at ROM
==============
.. contents::
This document provides an overview of the "library at ROM" implementation in
Trusted Firmware-A (TF-A).
......
SDEI: Software Delegated Exception Interface
============================================
.. contents::
:depth: 2
This document provides an overview of the SDEI dispatcher implementation in
Trusted Firmware-A (TF-A).
......
Secure Partition Manager
************************
.. contents::
Background
==========
......
Translation (XLAT) Tables Library
=================================
.. contents::
This document describes the design of the translation tables library (version 2)
used by Trusted Firmware-A (TF-A). This library provides APIs to create page
tables based on a description of the memory layout, as well as setting up system
......
Authentication Framework & Chain of Trust
=========================================
.. contents::
The aim of this document is to describe the authentication framework
implemented in Trusted Firmware-A (TF-A). This framework fulfills the
following requirements:
......
Arm CPU Specific Build Macros
=============================
.. contents::
This document describes the various build options present in the CPU specific
operations framework to enable errata workarounds and to enable optimizations
for a specific CPU on a platform.
......
Firmware Design
===============
.. contents::
Trusted Firmware-A (TF-A) implements a subset of the Trusted Board Boot
Requirements (TBBR) Platform Design Document (PDD) [1]_ for Arm reference
platforms. The TBB sequence starts when the platform is powered on and runs up
......
Interrupt Management Framework
==============================
.. contents::
This framework is responsible for managing interrupts routed to EL3. It also
allows EL3 software to configure the interrupt routing behavior. Its main
objective is to implement the following two requirements.
......
PSCI Power Domain Tree Structure
================================
.. contents::
--------------
Requirements
------------
......
CPU Reset
=========
.. contents::
This document describes the high-level design of the framework to handle CPU
resets in Trusted Firmware-A (TF-A). It also describes how the platform
integrator can tailor this code to the system configuration to some extent,
......
Trusted Board Boot
==================
.. contents::
The Trusted Board Boot (TBB) feature prevents malicious firmware from running on
the platform by authenticating all firmware images up to and including the
normal world bootloader. It does this by establishing a Chain of Trust using
......
Image Terminology
=================
.. contents::
This page contains the current name, abbreviated name and purpose of the various
images referred to in the Trusted Firmware project.
......
Porting Guide
=============
.. contents::
Introduction
------------
......
PSCI Library Integration guide for Armv8-A AArch32 systems
==========================================================
.. contents::
This document describes the PSCI library interface with a focus on how to
integrate with a suitable Trusted OS for an Armv8-A AArch32 system. The PSCI
Library implements the PSCI Standard as described in `PSCI spec`_ and is meant
......
EL3 Runtime Service Writer's Guide
=====================================================
.. contents::
Introduction
------------
......
User Guide
==========
.. contents::
This document describes how to build Trusted Firmware-A (TF-A) and run it with a
tested set of other software components using defined configurations on the Juno
Arm development platform and Arm Fixed Virtual Platform (FVP) models. It is
......
......@@ -3,7 +3,7 @@ Trusted Firmware-A Documentation
.. toctree::
:maxdepth: 1
:caption: Contents
:hidden:
Home<self>
getting_started/index
......@@ -18,6 +18,9 @@ Trusted Firmware-A Documentation
maintainers
license
.. contents:: On This Page
:depth: 3
Trusted Firmware-A (TF-A) provides a reference implementation of secure world
software for `Armv7-A and Armv8-A`_, including a `Secure Monitor`_ executing
at Exception Level 3 (EL3). It implements various Arm interface standards,
......
Raspberry Pi 3
==============
.. contents::
The `Raspberry Pi 3`_ is an inexpensive single-board computer that contains four
Arm Cortex-A53 cores.
......
Coding Style & Guidelines
=========================
.. contents::
The following sections contain TF coding guidelines. They are continually
evolving and should not be considered "set in stone". Feel free to question them
and provide feedback.
......
Platform Compatibility Policy
=============================
.. contents::
--------------
Introduction
------------
......
Release Processes
=================
.. contents::
--------------
Project Release Cadence
-----------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment