Unverified Commit cfd2e04a authored by Dimitris Papastamos's avatar Dimitris Papastamos Committed by GitHub
Browse files

Merge pull request #1444 from jts-arm/docs

Fix typos in documentation
parents ebce735d 677ad32c
...@@ -1661,6 +1661,7 @@ Function : bl2\_plat\_preload\_setup [optional] ...@@ -1661,6 +1661,7 @@ Function : bl2\_plat\_preload\_setup [optional]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:: ::
Argument : void Argument : void
Return : void Return : void
...@@ -1674,6 +1675,7 @@ Function : plat\_try\_next\_boot\_source() [optional] ...@@ -1674,6 +1675,7 @@ Function : plat\_try\_next\_boot\_source() [optional]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:: ::
Argument : void Argument : void
Return : int Return : int
...@@ -1704,6 +1706,7 @@ Function : bl2\_el3\_early\_platform\_setup() [mandatory] ...@@ -1704,6 +1706,7 @@ Function : bl2\_el3\_early\_platform\_setup() [mandatory]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:: ::
Argument : u_register_t, u_register_t, u_register_t, u_register_t Argument : u_register_t, u_register_t, u_register_t, u_register_t
Return : void Return : void
...@@ -1726,6 +1729,7 @@ Function : bl2\_el3\_plat\_arch\_setup() [mandatory] ...@@ -1726,6 +1729,7 @@ Function : bl2\_el3\_plat\_arch\_setup() [mandatory]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:: ::
Argument : void Argument : void
Return : void Return : void
...@@ -1741,6 +1745,7 @@ Function : bl2\_el3\_plat\_prepare\_exit() [optional] ...@@ -1741,6 +1745,7 @@ Function : bl2\_el3\_plat\_prepare\_exit() [optional]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:: ::
Argument : void Argument : void
Return : void Return : void
......
...@@ -243,10 +243,10 @@ Common build options ...@@ -243,10 +243,10 @@ Common build options
- ``BL2U``: This is an optional build option which specifies the path to - ``BL2U``: This is an optional build option which specifies the path to
BL2U image. In this case, the BL2U in TF-A will not be built. BL2U image. In this case, the BL2U in TF-A will not be built.
- ``BL2_AT_EL3``: This is an optional build option that enables the use of - ``BL2_AT_EL3``: This is an optional build option that enables the use of
BL2 at EL3 execution level. BL2 at EL3 execution level.
- ``BL2_IN_XIP_MEM``: In some use-cases BL2 will be stored in eXecute In Place - ``BL2_IN_XIP_MEM``: In some use-cases BL2 will be stored in eXecute In Place
(XIP) memory, like BL1. In these use-cases, it is necessary to initialize (XIP) memory, like BL1. In these use-cases, it is necessary to initialize
the RW sections in RAM, while leaving the RO sections in place. This option the RW sections in RAM, while leaving the RO sections in place. This option
enable this use-case. For now, this option is only supported when BL2_AT_EL3 enable this use-case. For now, this option is only supported when BL2_AT_EL3
...@@ -264,10 +264,10 @@ Common build options ...@@ -264,10 +264,10 @@ Common build options
BL32 image for the ``fip`` target. In this case, the BL32 in TF-A will not BL32 image for the ``fip`` target. In this case, the BL32 in TF-A will not
be built. be built.
- ``BL32_EXTRA1``: This is an optional build option which specifies the path to - ``BL32_EXTRA1``: This is an optional build option which specifies the path to
Trusted OS Extra1 image for the ``fip`` target. Trusted OS Extra1 image for the ``fip`` target.
- ``BL32_EXTRA2``: This is an optional build option which specifies the path to - ``BL32_EXTRA2``: This is an optional build option which specifies the path to
Trusted OS Extra2 image for the ``fip`` target. Trusted OS Extra2 image for the ``fip`` target.
- ``BL32_KEY``: This option is used when ``GENERATE_COT=1``. It specifies the - ``BL32_KEY``: This option is used when ``GENERATE_COT=1``. It specifies the
...@@ -323,10 +323,10 @@ Common build options ...@@ -323,10 +323,10 @@ Common build options
- ``DEBUG``: Chooses between a debug and release build. It can take either 0 - ``DEBUG``: Chooses between a debug and release build. It can take either 0
(release) or 1 (debug) as values. 0 is the default. (release) or 1 (debug) as values. 0 is the default.
- ``DYN_DISABLE_AUTH``: Enables the capability to disable Trusted Board Boot - ``DYN_DISABLE_AUTH``: Provides the capability to dynamically disable Trusted
authentication. This option is only meant to be enabled for development Board Boot authentication at runtime. This option is meant to be enabled only
platforms. Both TRUSTED_BOARD_BOOT and the LOAD_IMAGE_V2 flags need to be for development platforms. Both TRUSTED_BOARD_BOOT and LOAD_IMAGE_V2 flags
set if this flag has to be enabled. 0 is the default. must be set if this flag has to be enabled. 0 is the default.
- ``EL3_PAYLOAD_BASE``: This option enables booting an EL3 payload instead of - ``EL3_PAYLOAD_BASE``: This option enables booting an EL3 payload instead of
the normal boot flow. It must specify the entry point address of the EL3 the normal boot flow. It must specify the entry point address of the EL3
...@@ -743,8 +743,8 @@ Arm development platform specific build options ...@@ -743,8 +743,8 @@ Arm development platform specific build options
- ``tsram`` : Trusted SRAM (default option when TBB is not enabled) - ``tsram`` : Trusted SRAM (default option when TBB is not enabled)
- ``tdram`` : Trusted DRAM (if available) - ``tdram`` : Trusted DRAM (if available)
- ``dram`` : Secure region in DRAM (default option when TBB is enabled, - ``dram`` : Secure region in DRAM (default option when TBB is enabled,
configured by the TrustZone controller) configured by the TrustZone controller)
- ``ARM_XLAT_TABLES_LIB_V1``: boolean option to compile TF-A with version 1 - ``ARM_XLAT_TABLES_LIB_V1``: boolean option to compile TF-A with version 1
of the translation tables library instead of version 2. It is set to 0 by of the translation tables library instead of version 2. It is set to 0 by
...@@ -919,8 +919,7 @@ To check the entire source tree, you must first download copies of ...@@ -919,8 +919,7 @@ To check the entire source tree, you must first download copies of
``checkpatch.pl``, ``spelling.txt`` and ``const_structs.checkpatch`` available ``checkpatch.pl``, ``spelling.txt`` and ``const_structs.checkpatch`` available
in the `Linux master tree`_ scripts directory, then set the ``CHECKPATCH`` in the `Linux master tree`_ scripts directory, then set the ``CHECKPATCH``
environment variable to point to ``checkpatch.pl`` (with the other 2 files in environment variable to point to ``checkpatch.pl`` (with the other 2 files in
the same directory) and build the target the same directory) and build the target checkcodebase:
checkcodebase:
:: ::
......
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