Upstream fork of ATF with a couple of rk3399 patches to remove HDCP blob and increase BAUD_RATE.
Go to file
Soby Mathew 12d0d00d1e PSCI: Introduce new platform and CM helper APIs
This patch introduces new platform APIs and context management helper APIs
to support the new topology framework based on linear core position. This
framework will be introduced in the follwoing patch and it removes the
assumption that the MPIDR based affinity levels map directly to levels
in a power domain tree. The new platforms APIs and context management
helpers based on core position are as described below:

* plat_my_core_pos() and plat_core_pos_by_mpidr()

These 2 new mandatory platform APIs are meant to replace the existing
'platform_get_core_pos()' API. The 'plat_my_core_pos()' API returns the
linear index of the calling core and 'plat_core_pos_by_mpidr()' returns
the linear index of a core specified by its MPIDR. The latter API will also
validate the MPIDR passed as an argument and will return an error code (-1)
if an invalid MPIDR is passed as the argument. This enables the caller to
safely convert an MPIDR of another core to its linear index without querying
the PSCI topology tree e.g. during a call to PSCI CPU_ON.

Since the 'plat_core_pos_by_mpidr()' API verifies an MPIDR, which is always
platform specific, it is no longer possible to maintain a default implementation
of this API. Also it might not be possible for a platform port to verify an
MPIDR before the C runtime has been setup or the topology has been initialized.
This would prevent 'plat_core_pos_by_mpidr()' from being callable prior to
topology setup. As a result, the generic Trusted Firmware code does not call
this API before the topology setup has been done.

The 'plat_my_core_pos' API should be able to run without a C runtime.
Since this API needs to return a core position which is equal to the one
returned by 'plat_core_pos_by_mpidr()' API for the corresponding MPIDR,
this too cannot have default implementation and is a mandatory API for
platform ports. These APIs will be implemented by the ARM reference platform
ports later in the patch stack.

* plat_get_my_stack() and plat_set_my_stack()

These APIs are the stack management APIs which set/return stack addresses
appropriate for the calling core. These replace the 'platform_get_stack()' and
'platform_set_stack()' APIs. A default weak MP version and a global UP version
of these APIs are provided for the platforms.

* Context management helpers based on linear core position

A set of new context management(CM) helpers viz cm_get_context_by_index(),
cm_set_context_by_index(), cm_init_my_context() and cm_init_context_by_index()
are defined which are meant to replace the old helpers which took MPIDR
as argument. The old CM helpers are implemented based on the new helpers to
allow for code consolidation and will be deprecated once the switch to the new
framework is done.

Change-Id: I89758632b370c2812973a4b2efdd9b81a41f9b69
2015-08-13 16:17:58 +01:00
bl1 TBB: switch to the new authentication framework 2015-06-25 08:53:27 +01:00
bl2 TBB: switch to the new authentication framework 2015-06-25 08:53:27 +01:00
bl31 PSCI: Introduce new platform and CM helper APIs 2015-08-13 16:17:58 +01:00
bl32/tsp Add linker symbol declarations to bl_common.h 2015-04-28 19:50:56 +01:00
common TBB: delete deprecated PolarSSL authentication module 2015-06-25 08:53:27 +01:00
docs Update user guide to use Linaro releases 2015-07-15 11:34:22 +01:00
drivers Merge pull request #335 from jcastillo-arm/jc/sh_write 2015-07-17 10:16:51 +01:00
fdts FVP: update device tree idle state entries 2015-04-29 14:57:12 +01:00
include PSCI: Introduce new platform and CM helper APIs 2015-08-13 16:17:58 +01:00
lib Fix bug in semihosting write function 2015-07-16 20:36:41 +01:00
plat PSCI: Introduce new platform and CM helper APIs 2015-08-13 16:17:58 +01:00
services PSCI: Introduce new platform and CM helper APIs 2015-08-13 16:17:58 +01:00
tools TBB: build 'cert_create' with ECDSA only if OpenSSL supports it 2015-07-01 12:37:00 +01:00
.gitignore TBB: add tool to generate certificates 2015-01-28 18:26:59 +00:00
Makefile TBB: switch to the new authentication framework 2015-06-25 08:53:27 +01:00
acknowledgements.md TLK-D documentation and add NVIDIA to the Acknowledgements file 2015-03-31 10:11:47 +05:30
contributing.md Update contributing.md with new integration process 2014-04-01 11:22:43 +01:00
license.md Update year in copyright text to 2014 2014-01-17 10:27:53 +00:00
readme.md Documentation for version 1.1 2015-02-03 11:43:43 +00:00

readme.md

ARM Trusted Firmware - version 1.1

ARM Trusted Firmware provides a reference implementation of secure world software for ARMv8-A, including Exception Level 3 (EL3) software. This release provides complete support for version 0.2 of the PSCI specification, initial support for the new version 1.0 of that specification, and prototype support for the Trusted Board Boot Requirements specification.

The intent is to provide a reference implementation of various ARM interface standards, such as the Power State Coordination Interface (PSCI), Trusted Board Boot Requirements (TBBR) and [Secure Monitor] TEE-SMC code. As far as possible the code is designed for reuse or porting to other ARMv8-A model and hardware platforms.

ARM will continue development in collaboration with interested parties to provide a full reference implementation of PSCI, TBBR and Secure Monitor code to the benefit of all developers working with ARMv8-A TrustZone technology.

License

The software is provided under a BSD 3-Clause license. Certain source files are derived from FreeBSD code: the original license is included in these source files.

This Release

This release is a limited functionality implementation of the Trusted Firmware. It provides a suitable starting point for productization. Future versions will contain new features, optimizations and quality improvements.

Functionality

  • Prototype implementation of a subset of the Trusted Board Boot Requirements Platform Design Document (PDD). This includes packaging the various firmware images into a Firmware Image Package (FIP) to be loaded from non-volatile storage, and a prototype of authenticated boot using key certificates stored in the FIP.

  • Initializes the secure world (for example, exception vectors, control registers, GIC and interrupts for the platform), before transitioning into the normal world.

  • Supports both GICv2 and GICv3 initialization for use by normal world software.

  • Starts the normal world at the Exception Level and Register Width specified by the platform port. Typically this is AArch64 EL2 if available.

  • Handles SMCs (Secure Monitor Calls) conforming to the [SMC Calling Convention PDD] SMCCC using an EL3 runtime services framework.

  • Handles SMCs relating to the [Power State Coordination Interface PDD] PSCI for the Secondary CPU Boot, CPU Hotplug, CPU Idle and System Shutdown/Reset use-cases.

  • A Test Secure-EL1 Payload and Dispatcher to demonstrate Secure Monitor functionality such as world switching, EL1 context management and interrupt routing. This also demonstrates Secure-EL1 interaction with PSCI. Some of this functionality is provided in library form for re-use by other Secure-EL1 Payload Dispatchers.

  • Support for alternative Trusted Boot Firmware. Some platforms have their own Trusted Boot implementation and only require the Secure Monitor functionality provided by ARM Trusted Firmware.

  • Isolation of memory accessible by the secure world from the normal world through programming of a TrustZone controller.

  • Support for CPU specific reset sequences, power down sequences and register dumping during crash reporting. The CPU specific reset sequences include support for errata workarounds.

For a full description of functionality and implementation details, please see the Firmware Design and supporting documentation. The Change Log provides details of changes made since the last release.

Platforms

This release of the Trusted Firmware has been tested on Revision B of the [Juno ARM Development Platform] Juno with Version r0p0-00rel7 of the [ARM SCP Firmware] SCP download.

The Trusted Firmware has also been tested on the 64-bit Linux versions of the following ARM FVPs:

  • Foundation_Platform (Version 9.1, Build 9.1.33)
  • FVP_Base_AEMv8A-AEMv8A (Version 6.2, Build 0.8.6202)
  • FVP_Base_Cortex-A57x4-A53x4 (Version 6.2, Build 0.8.6202)
  • FVP_Base_Cortex-A57x1-A53x1 (Version 6.2, Build 0.8.6202)
  • FVP_Base_Cortex-A57x2-A53x4 (Version 6.2, Build 0.8.6202)

The Foundation FVP can be downloaded free of charge. The Base FVPs can be licensed from ARM: see [www.arm.com/fvp] FVP.

Still to Come

  • Complete and more flexible Trusted Board Boot implementation.

  • Complete implementation of the PSCI v1.0 specification.

  • Support for alternative types of Secure-EL1 Payloads.

  • Extending the GICv3 support to the secure world.

  • Support for new System IP devices.

For a full list of detailed issues in the current code, please see the Change Log and the GitHub issue tracker.

Getting Started

Get the Trusted Firmware source code from GitHub.

See the User Guide for instructions on how to install, build and use the Trusted Firmware with the ARM FVPs.

See the Firmware Design for information on how the ARM Trusted Firmware works.

See the Porting Guide as well for information about how to use this software on another ARMv8-A platform.

See the Contributing Guidelines for information on how to contribute to this project and the Acknowledgments file for a list of contributors to the project.

Feedback and support

ARM welcomes any feedback on the Trusted Firmware. Please send feedback using the GitHub issue tracker.

ARM licensees may contact ARM directly via their partner managers.


Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved.