aboutsummaryrefslogtreecommitdiff

Contributor's Guide

Getting Started

  • Make sure you have a Github account and you are logged on both developer.trustedfirmware.org and review.trustedfirmware.org.

  • If you plan to contribute a major piece of work, it is usually a good idea to start a discussion around it on the mailing list. This gives everyone visibility of what is coming up, you might learn that somebody else is already working on something similar or the community might be able to provide some early input to help shaping the design of the feature.

    If you intend to include Third Party IP in your contribution, please mention it explicitly in the email thread and ensure that the changes that include Third Party IP are made in a separate patch (or patch series).

  • Clone Trusted Firmware-A on your own machine as described in :ref:`prerequisites_get_source`.

    System Message: ERROR/3 (<stdin>, line 20); backlink

    Unknown interpreted text role "ref".

  • Create a local topic branch based on the Trusted Firmware-A master branch.

Making Changes

  • Ensure commits adhere to the the project's :ref:`Commit Style`.

    System Message: ERROR/3 (<stdin>, line 29); backlink

    Unknown interpreted text role "ref".

  • Make commits of logical units. See these general Git guidelines for contributing to a project.

  • Keep the commits on topic. If you need to fix another bug or make another enhancement, please address it on a separate topic branch.

  • Split the patch in manageable units. Small patches are usually easier to review so this will speed up the review process.

  • Avoid long commit series. If you do have a long series, consider whether some commits should be squashed together or addressed in a separate topic.

  • Follow the :ref:`Coding Style` and :ref:`Coding Guidelines`.

    System Message: ERROR/3 (<stdin>, line 43); backlink

    Unknown interpreted text role "ref".

    System Message: ERROR/3 (<stdin>, line 43); backlink

    Unknown interpreted text role "ref".

  • Where appropriate, please update the documentation.

    • Consider whether the :ref:`Porting Guide`, :ref:`Firmware Design` document or other in-source documentation needs updating.

      System Message: ERROR/3 (<stdin>, line 51); backlink

      Unknown interpreted text role "ref".

      System Message: ERROR/3 (<stdin>, line 51); backlink

      Unknown interpreted text role "ref".

    • If you are submitting new files that you intend to be the code owner for (for example, a new platform port), then also update the :ref:`code owners` file.

      System Message: ERROR/3 (<stdin>, line 54); backlink

      Unknown interpreted text role "ref".

    • For topics with multiple commits, you should make all documentation changes (and nothing else) in the last commit of the series. Otherwise, include the documentation changes within the single commit.

Submitting Changes

  • Submit your changes for review at https://review.trustedfirmware.org targeting the integration branch.

  • Add reviewers for your patch:

    • At least one code owner for each module modified by the patch. See the list of modules and their :ref:`code owners`.

      System Message: ERROR/3 (<stdin>, line 101); backlink

      Unknown interpreted text role "ref".

    • At least one maintainer. See the list of :ref:`maintainers`.

      System Message: ERROR/3 (<stdin>, line 104); backlink

      Unknown interpreted text role "ref".

    • If some module has no code owner, try to identify a suitable (non-code owner) reviewer. Running git blame on the module's source code can help, as it shows who has been working the most recently on this area of the code.

      Alternatively, if it is impractical to identify such a reviewer, you might send an email to the TF-A mailing list to broadcast your review request to the community.

    Note that self-reviewing a patch is prohibited, even if the patch author is the only code owner of a module modified by the patch. Getting a second pair of eyes on the code is essential to keep up with the quality standards the project aspires to.

  • The changes will then undergo further review by the designated people. Any review comments will be made directly on your patch. This may require you to do some rework. For controversial changes, the discussion might be moved to the TF-A mailing list to involve more of the community.

    Refer to the Gerrit Uploading Changes documentation for more details.

  • The patch submission rules are the following. For a patch to be approved and merged in the tree, it must get:

    • One Code-Owner-Review+1 for each of the modules modified by the patch.
    • A Maintainer-Review+1.

    In the case where a code owner could not be found for a given module, Code-Owner-Review+1 is substituted by Code-Review+1.

    In addition to these various code review labels, the patch must also get a Verified+1. This is usually set by the Continuous Integration (CI) bot when all automated tests passed on the patch. Sometimes, some of these automated tests may fail for reasons unrelated to the patch. In this case, the maintainers might (after analysis of the failures) override the CI bot score to certify that the patch has been correctly tested.

    In the event where the CI system lacks proper tests for a patch, the patch author or a reviewer might agree to perform additional manual tests in their review and the reviewer incorporates the review of the additional testing in the Code-Review+1 or Code-Owner-Review+1 as applicable to attest that the patch works as expected. Where possible additional tests should be added to the CI system as a follow up task. For example, for a platform-dependent patch where the said platform is not available in the CI system's board farm.

  • When the changes are accepted, the :ref:`maintainers` will integrate them.

    System Message: ERROR/3 (<stdin>, line 152); backlink

    Unknown interpreted text role "ref".

    • Typically, the :ref:`maintainers` will merge the changes into the integration branch.

      System Message: ERROR/3 (<stdin>, line 154); backlink

      Unknown interpreted text role "ref".

    • If the changes are not based on a sufficiently-recent commit, or if they cannot be automatically rebased, then the :ref:`maintainers` may rebase it on the integration branch or ask you to do so.

      System Message: ERROR/3 (<stdin>, line 157); backlink

      Unknown interpreted text role "ref".

    • After final integration testing, the changes will make their way into the master branch. If a problem is found during integration, the :ref:`maintainers` will request your help to solve the issue. They may revert your patches and ask you to resubmit a reworked version of them or they may ask you to provide a fix-up patch.

      System Message: ERROR/3 (<stdin>, line 161); backlink

      Unknown interpreted text role "ref".

Add CI Configurations

  • TF-A uses Jenkins tool for Continuous Integration and testing activities. Various CI Jobs are deployed which run tests on every patch before being merged. So each of your patches go through a series of checks before they get merged on to the master branch. Kindly ensure, that everytime you add new files under your platform, they are covered under the following two sections:

Coverity Scan

  • Coverity Scan analysis is one of the tests we perform on our source code at regular intervals. We maintain a build script tf-cov-make which contains the build configurations of various platforms in order to cover the entire source code being analysed by Coverity.
  • When you submit your patches for review containing new source files, please ensure to include them for the Coverity Scan analysis by adding the respective build configurations in the tf-cov-make build script.
  • In this section you find the details on how to append your new build configurations for Coverity scan analysis illustrated with examples:
  1. We maintain a separate repository named tf-a-ci-scripts repository for placing all the test scripts which will be executed by the CI Jobs.
  2. In this repository, tf-cov-make script is located at tf-a-ci-scripts/script/tf-coverity/tf-cov-make
  3. Edit tf-cov-make script by appending all the possible build configurations with the specific build-flags relevant to your platform, so that newly added source files get built and analysed by Coverity.
  4. For better understanding follow the below specified examples listed in the tf-cov-make script.
Example 1:
#Intel
make PLAT=stratix10 $(common_flags) all
make PLAT=agilex $(common_flags) all
  • In the above example there are two different SoCs stratix and agilex under the Intel platform and the build configurations has been added suitably to include most of their source files.
Example 2:
#Hikey
make PLAT=hikey $(common_flags) ${TBB_OPTIONS} ENABLE_PMF=1 all
make PLAT=hikey960 $(common_flags) ${TBB_OPTIONS} all
make PLAT=poplar $(common_flags) all
  • In this case for Hikey boards additional build-flags has been included along with the commom_flags to cover most of the files relevant to it.
  • Similar to this you can still find many other different build configurations of various other platforms listed in the tf-cov-make script. Kindly refer them and append your build configurations respectively.

Test Build Configuration (tf-l1-build-plat)

  • Coverity Scan analysis, runs on a daily basis and will not be triggered for every individual trusted-firmware patch.
  • Considering this, we have other distinguished CI jobs which run a set of test configurations on every patch, before they are being passed to Coverity scan analysis.
  • tf-l1-build-plat is the test group, which holds the test configurations to build all the platforms. So be kind enough to verify that your newly added files are built as part of one of the existing platform configurations present in tf-l1-build-plat test group.
  • In this section you find the details on how to add the appropriate files, needed to build your newly introduced platform as part of tf-l1-build-plat test group, illustrated with an example:
  • Lets consider Hikey platform: In the tf-a-ci-scripts repository we need to add a build configuration file hikey-default under tf_config folder, tf_config/hikey-default listing all the build parameters relevant to it.
#Hikey Build Parameters
CROSS_COMPILE=aarch64-none-elf-
PLAT=hikey
  • Further a test-configuration file hikey-default:nil need to be added under the test group, tf-l1-build-plat located at tf-a-ci-scripts/group/tf-l1-build-plat, to allow the platform to be built as part of this group.
#
# Copyright (c) 2019-2022 Arm Limited. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
  • As illustrated above, you need to add the similar files supporting your platform.

Binary Components

  • Platforms may depend on binary components submitted to the Trusted Firmware binary repository if they require code that the contributor is unable or unwilling to open-source. This should be used as a rare exception.
  • All binary components must follow the contribution guidelines (in particular licensing rules) outlined in the readme.rst file of the binary repository.
  • Binary components must be restricted to only the specific functionality that cannot be open-sourced and must be linked into a larger open-source platform port. The majority of the platform port must still be implemented in open source. Platform ports that are merely a thin wrapper around a binary component that contains all the actual code will not be accepted.
  • Only platform port code (i.e. in the plat/<vendor> directory) may rely on binary components. Generic code must always be fully open-source.

Copyright (c) 2013-2022, Arm Limited and Contributors. All rights reserved.