Commit 8f457dac authored by Antonio Nino Diaz's avatar Antonio Nino Diaz
Browse files

docs: Update note about plat/arm in Porting Guide



Platforms are not allowed to use any file inside include/plat/arm or
plat/arm to prevent dependencies between Arm platforms and non-Arm
platforms.

Change-Id: I6dc336ab71134c8d2758761fac0e4716e2d7e6ff
Signed-off-by: default avatarAntonio Nino Diaz <antonio.ninodiaz@arm.com>
parent 3e310f30
...@@ -27,14 +27,6 @@ implementations are all weakly defined; they are provided to ease the porting ...@@ -27,14 +27,6 @@ implementations are all weakly defined; they are provided to ease the porting
effort. Each platform port can override them with its own implementation if the effort. Each platform port can override them with its own implementation if the
default implementation is inadequate. default implementation is inadequate.
Platform ports that want to be aligned with standard Arm platforms (for example
FVP and Juno) may also use `include/plat/arm/common/plat_arm.h`_ and the
corresponding source files in ``plat/arm/common/``. These provide standard
implementations for some of the required platform porting functions. However,
using these functions requires the platform port to implement additional
Arm standard platform porting functions. These additional functions are not
documented here.
Some modifications are common to all Boot Loader (BL) stages. Section 2 Some modifications are common to all Boot Loader (BL) stages. Section 2
discusses these in detail. The subsequent sections discuss the remaining discusses these in detail. The subsequent sections discuss the remaining
modifications for each BL stage in detail. modifications for each BL stage in detail.
...@@ -44,6 +36,14 @@ This document should be read in conjunction with the TF-A `User Guide`_. ...@@ -44,6 +36,14 @@ This document should be read in conjunction with the TF-A `User Guide`_.
Please refer to the `Platform compatibility policy`_ for the policy regarding Please refer to the `Platform compatibility policy`_ for the policy regarding
compatibility and deprecation of these porting interfaces. compatibility and deprecation of these porting interfaces.
Only Arm development platforms (such as FVP and Juno) may use the
functions/definitions in ``include/plat/arm/common/`` and the corresponding
source files in ``plat/arm/common/``. This is done so that there are no
dependencies between platforms maintained by different people/companies. If you
want to use any of the functionality present in ``plat/arm`` files, please
create a pull request that moves the code to ``plat/common`` so that it can be
discussed.
Common modifications Common modifications
-------------------- --------------------
...@@ -2770,7 +2770,7 @@ operations such as loading a bootloader image. ...@@ -2770,7 +2770,7 @@ operations such as loading a bootloader image.
The current implementation only allows for known images to be loaded by the The current implementation only allows for known images to be loaded by the
firmware. These images are specified by using their identifiers, as defined in firmware. These images are specified by using their identifiers, as defined in
[include/plat/common/platform_def.h] (or a separate header file included from ``include/plat/common/common_def.h`` (or a separate header file included from
there). The platform layer (``plat_get_image_source()``) then returns a reference there). The platform layer (``plat_get_image_source()``) then returns a reference
to a device and a driver-specific ``spec`` which will be understood by the driver to a device and a driver-specific ``spec`` which will be understood by the driver
to allow access to the image data. to allow access to the image data.
...@@ -2788,7 +2788,7 @@ amount of open resources per driver. ...@@ -2788,7 +2788,7 @@ amount of open resources per driver.
-------------- --------------
*Copyright (c) 2013-2018, Arm Limited and Contributors. All rights reserved.* *Copyright (c) 2013-2019, Arm Limited and Contributors. All rights reserved.*
.. _include/plat/common/platform.h: ../include/plat/common/platform.h .. _include/plat/common/platform.h: ../include/plat/common/platform.h
.. _include/plat/arm/common/plat_arm.h: ../include/plat/arm/common/plat_arm.h%5D .. _include/plat/arm/common/plat_arm.h: ../include/plat/arm/common/plat_arm.h%5D
......
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