Commit 7921fe6a authored by Paul Beesley's avatar Paul Beesley Committed by TrustedFirmware Code Review
Browse files

Merge "doc: Misc syntax and spelling fixes" into integration

Showing with 21 additions and 19 deletions
+21 -19
...@@ -7,7 +7,7 @@ Introduction ...@@ -7,7 +7,7 @@ Introduction
This document describes the design of the Firmware Update (FWU) feature, which This document describes the design of the Firmware Update (FWU) feature, which
enables authenticated firmware to update firmware images from external enables authenticated firmware to update firmware images from external
interfaces such as USB, UART, SD-eMMC, NAND, NOR or Ethernet to SoC Non-Volatile interfaces such as USB, UART, SD-eMMC, NAND, NOR or Ethernet to SoC Non-Volatile
memories such as NAND Flash, LPPDR2-NVM or any memory determined by the memories such as NAND Flash, LPDDR2-NVM or any memory determined by the
platform. This feature functions even when the current firmware in the system platform. This feature functions even when the current firmware in the system
is corrupt or missing; it therefore may be used as a recovery mode. It may also is corrupt or missing; it therefore may be used as a recovery mode. It may also
be complemented by other, higher level firmware update software. be complemented by other, higher level firmware update software.
......
...@@ -1672,7 +1672,7 @@ The following list describes the memory layout on the Arm development platforms: ...@@ -1672,7 +1672,7 @@ The following list describes the memory layout on the Arm development platforms:
point during a cold boot. point during a cold boot.
- On Juno, SCP_BL2 is loaded temporarily into the EL3 Runtime Software memory - On Juno, SCP_BL2 is loaded temporarily into the EL3 Runtime Software memory
region and transfered to the SCP before being overwritten by EL3 Runtime region and transferred to the SCP before being overwritten by EL3 Runtime
Software. Software.
- BL32 (for AArch64) can be loaded in one of the following locations: - BL32 (for AArch64) can be loaded in one of the following locations:
...@@ -2623,7 +2623,7 @@ Cortex-A architecture through ``ARM_CORTEX_A<X> = yes`` in their ...@@ -2623,7 +2623,7 @@ Cortex-A architecture through ``ARM_CORTEX_A<X> = yes`` in their
Cortex-A15 target. Cortex-A15 target.
Platform can also set ``ARM_WITH_NEON=yes`` to enable neon support. Platform can also set ``ARM_WITH_NEON=yes`` to enable neon support.
Note that using neon at runtime has constraints on non secure wolrd context. Note that using neon at runtime has constraints on non secure world context.
TF-A does not yet provide VFP context management. TF-A does not yet provide VFP context management.
Directive ``ARM_CORTEX_A<x>`` and ``ARM_WITH_NEON`` are used to set Directive ``ARM_CORTEX_A<x>`` and ``ARM_WITH_NEON`` are used to set
......
...@@ -7,7 +7,7 @@ images referred to in the Trusted Firmware project. ...@@ -7,7 +7,7 @@ images referred to in the Trusted Firmware project.
General Notes General Notes
------------- -------------
- Some of the names and abbreviated names have changed to accomodate new - Some of the names and abbreviated names have changed to accommodate new
requirements. The changed names are as backward compatible as possible to requirements. The changed names are as backward compatible as possible to
minimize confusion. Where applicable, the previous names are indicated. Some minimize confusion. Where applicable, the previous names are indicated. Some
code, documentation and build artefacts may still refer to the previous names; code, documentation and build artefacts may still refer to the previous names;
...@@ -44,7 +44,7 @@ AP Boot ROM: ``AP_BL1`` ...@@ -44,7 +44,7 @@ AP Boot ROM: ``AP_BL1``
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
Typically, this is the first code to execute on the AP and cannot be modified. Typically, this is the first code to execute on the AP and cannot be modified.
Its primary purpose is to perform the minimum intialization necessary to load Its primary purpose is to perform the minimum initialization necessary to load
and authenticate an updateable AP firmware image into an executable RAM and authenticate an updateable AP firmware image into an executable RAM
location, then hand-off control to that image. location, then hand-off control to that image.
...@@ -96,7 +96,7 @@ SCP Boot ROM: ``SCP_BL1`` (previously ``BL0``) ...@@ -96,7 +96,7 @@ SCP Boot ROM: ``SCP_BL1`` (previously ``BL0``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Typically, this is the first code to execute on the SCP and cannot be modified. Typically, this is the first code to execute on the SCP and cannot be modified.
Its primary purpose is to perform the minimum intialization necessary to load Its primary purpose is to perform the minimum initialization necessary to load
and authenticate an updateable SCP firmware image into an executable RAM and authenticate an updateable SCP firmware image into an executable RAM
location, then hand-off control to that image. This may be performed in location, then hand-off control to that image. This may be performed in
conjunction with other processor firmware (for example, ``AP_BL1`` and conjunction with other processor firmware (for example, ``AP_BL1`` and
...@@ -129,7 +129,7 @@ AP Firmware Update Boot ROM: ``AP_NS_BL1U`` ...@@ -129,7 +129,7 @@ AP Firmware Update Boot ROM: ``AP_NS_BL1U``
Typically, this is the first normal world code to execute on the AP during a Typically, this is the first normal world code to execute on the AP during a
firmware update operation, and cannot be modified. Its primary purpose is to firmware update operation, and cannot be modified. Its primary purpose is to
load subequent firmware update images from an external interface and communicate load subsequent firmware update images from an external interface and communicate
with ``AP_BL1`` to authenticate those images. with ``AP_BL1`` to authenticate those images.
During firmware update, there are (potentially) multiple transitions between the During firmware update, there are (potentially) multiple transitions between the
......
...@@ -549,7 +549,7 @@ optionally be defined: ...@@ -549,7 +549,7 @@ optionally be defined:
- **PLAT_PARTITION_BLOCK_SIZE** - **PLAT_PARTITION_BLOCK_SIZE**
The size of partition block. It could be either 512 bytes or 4096 bytes. The size of partition block. It could be either 512 bytes or 4096 bytes.
The default value is 512. The default value is 512.
`For example, define the build flag in platform.mk`_: For example, define the build flag in ``platform.mk``:
PLAT_PARTITION_BLOCK_SIZE := 4096 PLAT_PARTITION_BLOCK_SIZE := 4096
$(eval $(call add_define,PLAT_PARTITION_BLOCK_SIZE)) $(eval $(call add_define,PLAT_PARTITION_BLOCK_SIZE))
...@@ -954,7 +954,7 @@ Function : plat_reset_handler() ...@@ -954,7 +954,7 @@ Function : plat_reset_handler()
Return : void Return : void
A platform may need to do additional initialization after reset. This function A platform may need to do additional initialization after reset. This function
allows the platform to do the platform specific intializations. Platform allows the platform to do the platform specific initializations. Platform
specific errata workarounds could also be implemented here. The API should specific errata workarounds could also be implemented here. The API should
preserve the values of callee saved registers x19 to x29. preserve the values of callee saved registers x19 to x29.
...@@ -2777,7 +2777,7 @@ more functionality is required, the needed library functions will need to be ...@@ -2777,7 +2777,7 @@ more functionality is required, the needed library functions will need to be
added to the local implementation. added to the local implementation.
Some C headers have been obtained from `FreeBSD`_ and `SCC`_, while others have Some C headers have been obtained from `FreeBSD`_ and `SCC`_, while others have
been written specifically for TF-A. Fome implementation files have been obtained been written specifically for TF-A. Some implementation files have been obtained
from `FreeBSD`_, others have been written specifically for TF-A as well. The from `FreeBSD`_, others have been written specifically for TF-A as well. The
files can be found in ``include/lib/libc`` and ``lib/libc``. files can be found in ``include/lib/libc`` and ``lib/libc``.
......
...@@ -49,9 +49,9 @@ Amlogic Meson S905x (GXL) platform port ...@@ -49,9 +49,9 @@ Amlogic Meson S905x (GXL) platform port
:F: plat/amlogic/gxl/ :F: plat/amlogic/gxl/
Amlogic Meson S905X2 (G12A) platform port Amlogic Meson S905X2 (G12A) platform port
--------------------------------------- -----------------------------------------
:M: Carlo Caione <ccaione@baylibre.com> :M: Carlo Caione <ccaione@baylibre.com>
:G: `carlo.caione`_ :G: `carlocaione`_
:F: docs/plat/meson-g12a.rst :F: docs/plat/meson-g12a.rst
:F: drivers/amlogic/g12a :F: drivers/amlogic/g12a
:F: plat/amlogic/g12a/ :F: plat/amlogic/g12a/
...@@ -122,7 +122,7 @@ Intel SocFPGA platform ports ...@@ -122,7 +122,7 @@ Intel SocFPGA platform ports
:M: Tien Hock Loh <tien.hock.loh@intel.com> :M: Tien Hock Loh <tien.hock.loh@intel.com>
:G: `thloh85-intel`_ :G: `thloh85-intel`_
:M: Hadi Asyrafi <muhammad.hadi.asyrafi.abdul.halim@intel.com> :M: Hadi Asyrafi <muhammad.hadi.asyrafi.abdul.halim@intel.com>
:G: `mabdulha`_ :G: mabdulha
:F: plat/intel/soc :F: plat/intel/soc
:F: drivers/intel/soc/ :F: drivers/intel/soc/
...@@ -282,6 +282,7 @@ Xilinx platform port ...@@ -282,6 +282,7 @@ Xilinx platform port
.. _Anson-Huang: https://github.com/Anson-Huang .. _Anson-Huang: https://github.com/Anson-Huang
.. _bryanodonoghue: https://github.com/bryanodonoghue .. _bryanodonoghue: https://github.com/bryanodonoghue
.. _b49020: https://github.com/b49020 .. _b49020: https://github.com/b49020
.. _carlocaione: https://github.com/carlocaione
.. _danh-arm: https://github.com/danh-arm .. _danh-arm: https://github.com/danh-arm
.. _etienne-lms: https://github.com/etienne-lms .. _etienne-lms: https://github.com/etienne-lms
.. _glneo: https://github.com/glneo .. _glneo: https://github.com/glneo
...@@ -308,6 +309,7 @@ Xilinx platform port ...@@ -308,6 +309,7 @@ Xilinx platform port
.. _sivadur: https://github.com/sivadur .. _sivadur: https://github.com/sivadur
.. _smaeul: https://github.com/smaeul .. _smaeul: https://github.com/smaeul
.. _soby-mathew: https://github.com/soby-mathew .. _soby-mathew: https://github.com/soby-mathew
.. _thloh85-intel: https://github.com/thloh85-intel
.. _thomas-arm: https://github.com/thomas-arm .. _thomas-arm: https://github.com/thomas-arm
.. _TonyXie06: https://github.com/TonyXie06 .. _TonyXie06: https://github.com/TonyXie06
.. _vwadekar: https://github.com/vwadekar .. _vwadekar: https://github.com/vwadekar
......
...@@ -168,7 +168,7 @@ the cache associated with power level 0 is flushed (L1). ...@@ -168,7 +168,7 @@ the cache associated with power level 0 is flushed (L1).
| 5 | 21 | 17 | 6 | | 5 | 21 | 17 | 6 |
+-------+---------------------+--------------------+--------------------------+ +-------+---------------------+--------------------+--------------------------+
The ``CLUSH_OVERHEAD`` times for lead CPU 4 and all CPUs in the non-lead cluster The ``CFLUSH_OVERHEAD`` times for lead CPU 4 and all CPUs in the non-lead cluster
are large because all other CPUs in the cluster are powered down during the are large because all other CPUs in the cluster are powered down during the
test. The ``CPU_SUSPEND`` call powers down to the cluster level, requiring a test. The ``CPU_SUSPEND`` call powers down to the cluster level, requiring a
flush of both L1 and L2 caches. flush of both L1 and L2 caches.
......
...@@ -112,7 +112,7 @@ Comphy Porting (phy-porting-layer.h or phy-default-porting-layer.h) ...@@ -112,7 +112,7 @@ Comphy Porting (phy-porting-layer.h or phy-default-porting-layer.h)
.. seealso:: .. seealso::
For XFI/SFI comphy type there is procedure "rx_training" which eases For XFI/SFI comphy type there is procedure "rx_training" which eases
process of suiting some of the parameters. Please see :ref:`uboot_cmd` process of suiting some of the parameters. Please see *uboot_cmd*
section: rx_training. section: rx_training.
The PHY porting layer simplifies updating static values per board type, The PHY porting layer simplifies updating static values per board type,
......
Amlogic Meson S905X2 (G12A) Amlogic Meson S905X2 (G12A)
========================== ===========================
The Amlogic Meson S905X2 is a SoC with a quad core Arm Cortex-A53 running at The Amlogic Meson S905X2 is a SoC with a quad core Arm Cortex-A53 running at
~1.8GHz. It also contains a Cortex-M3 used as SCP. ~1.8GHz. It also contains a Cortex-M3 used as SCP.
......
...@@ -23,8 +23,8 @@ include: ...@@ -23,8 +23,8 @@ include:
- ``**WARNING: Use of volatile is usually wrong``: see - ``**WARNING: Use of volatile is usually wrong``: see
`Why the “volatile” type class should not be used`_ . Although this document `Why the “volatile” type class should not be used`_ . Although this document
contains some very useful information, there are several legimate uses of the contains some very useful information, there are several legitimate uses of
volatile keyword within the TF codebase. the volatile keyword within the TF codebase.
Headers and inclusion Headers and inclusion
--------------------- ---------------------
......
...@@ -51,7 +51,7 @@ the MMU. ...@@ -51,7 +51,7 @@ the MMU.
For Cortex-A73 and Cortex-A75 CPUs, the PRs in this advisory invalidate the For Cortex-A73 and Cortex-A75 CPUs, the PRs in this advisory invalidate the
branch predictor when entering EL3 by temporarily dropping into AArch32 branch predictor when entering EL3 by temporarily dropping into AArch32
Secure-EL1 and executing the ``BPIALL`` instruction. This workaround is Secure-EL1 and executing the ``BPIALL`` instruction. This workaround is
signifiantly more complex than the "MMU disable/enable" workaround. The latter significantly more complex than the "MMU disable/enable" workaround. The latter
is not effective at invalidating the branch predictor on Cortex-A73/Cortex-A75. is not effective at invalidating the branch predictor on Cortex-A73/Cortex-A75.
Note that if other privileged software, for example a Rich OS kernel, implements Note that if other privileged software, for example a Rich OS kernel, implements
......
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