Allow style checking of tree and local changes

New phony Makefile targets have been added:

 * checkcodebase
 * checkpatch

The checkcodebase target will run a Linux style compliance check over the
entire codebase, and honours the V=1 Makefile verbose setting and so will
show more information when this is enabled.

If the local directory is a git checkout then the output of git ls-files is
used to decide which files to test for compliance.  If the local directory
is not under git control then a 'best attempt' is made, but in this case it
should be noted that it is possible for additional non-codebase files to be
tested, so care should be taken when parsing the output.

The checkpatch target will compare local changes against the git origin/master
to allow issues with the last set of changes to be identified.  To override
the change comparision location, set the BASE_COMMIT variable to your
desired git branch.

Both targets rely on the Linux source tree script checkpatch.pl to do the
syntax checking, and expects that the CHECKPATCH environment variable points
to the location of this file.

Notes on the usage of these targets have been added to the contributing.md
and docs/user-guide.md text files.

Change-Id: I6d73c97af578e24a34226d972afadab9d30f1d8d
3 files changed
tree: 39f8b4b782d50946ea257774af5f761039f54f9b
  1. arch/
  2. bl1/
  3. bl2/
  4. bl31/
  5. common/
  6. docs/
  7. drivers/
  8. fdts/
  9. include/
  10. lib/
  11. plat/
  12. .gitignore
  13. acknowledgements.md
  14. contributing.md
  15. license.md
  16. Makefile
  17. readme.md
readme.md

ARM Trusted Firmware - version 0.2

ARM Trusted Firmware provides a reference implementation of secure world software for ARMv8-A, including Exception Level 3 (EL3) software. This first release focuses on support for ARM's [Fixed Virtual Platforms (FVPs)] FVP.

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.

This release is the first one as source code: an initial prototype release was available in binary form in the [Linaro AArch64 OpenEmbedded Engineering Build] AArch64 LEB to support the new FVP Base platform models from ARM.

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 software.

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 software is an early implementation of the Trusted Firmware. Only limited functionality is provided at present and it has not been optimized or subjected to extended robustness or stress testing.

Functionality

  • Initial implementation of a subset of the Trusted Board Boot Requirements Platform Design Document (PDD).

  • 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 highest available Exception Level: EL2 if available, otherwise EL1.

  • Handles SMCs (Secure Monitor Calls) conforming to the [SMC Calling Convention PDD] SMCCC.

  • Handles SMCs relating to the [Power State Coordination Interface PDD] PSCI for the Secondary CPU Boot and CPU hotplug use-cases.

For a full list of updated functionality and implementation details, please see the User Guide. The Change Log provides details of changes made since the last release.

Platforms

This release of the Trusted Firmware has been tested on the following ARM FVPs (64-bit versions only):

  • FVP_Base_AEMv8A-AEMv8A (Version 5.1, Build 0.8.5108).
  • FVP_Base_Cortex-A57x4-A53x4 (Version 5.1, Build 0.8.5108).
  • FVP_Base_Cortex-A57x1-A53x1 (Version 5.1, Build 0.8.5108).

These models can be licensed from ARM: see [www.arm.com/fvp] FVP.

For an updated list of supported platforms, please see the Change Log.

Still to Come

  • Complete implementation of the PSCI specification.

  • Secure memory, Secure monitor, Test Secure OS & Secure interrupts.

  • Booting the firmware from a block device.

  • Completing the currently experimental GICv3 support.

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

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 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 Acknowledgements 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-2014, ARM Limited and Contributors. All rights reserved.