diff options
Diffstat (limited to 'docs/user-guide.rst')
| -rw-r--r-- | docs/user-guide.rst | 53 |
1 files changed, 12 insertions, 41 deletions
diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 67fe5780..2632329a 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -234,11 +234,6 @@ Common build options compiling TF-A. Its value must be a numeric, and defaults to 0. See also, *Armv8 Architecture Extensions* in `Firmware Design`_. -- ``ARM_GIC_ARCH``: Choice of Arm GIC architecture version used by the Arm - Legacy GIC driver for implementing the platform GIC API. This API is used - by the interrupt management framework. Default is 2 (that is, version 2.0). - This build option is deprecated. - - ``ARM_PLAT_MT``: This flag determines whether the Arm platform layer has to cater for the multi-threading ``MT`` bit when accessing MPIDR. When this flag is set, the functions which deal with MPIDR assume that the ``MT`` bit in @@ -334,8 +329,8 @@ Common build options - ``DYN_DISABLE_AUTH``: Provides the capability to dynamically disable Trusted Board Boot authentication at runtime. This option is meant to be enabled only - for development platforms. Both TRUSTED_BOARD_BOOT and LOAD_IMAGE_V2 flags - must be set if this flag has to be enabled. 0 is the default. + for development platforms. ``TRUSTED_BOARD_BOOT`` flag 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 the normal boot flow. It must specify the entry point address of the EL3 @@ -396,6 +391,10 @@ Common build options The default is 1 but is automatically disabled when the target architecture is AArch32. +- ``ENABLE_SPM`` : Boolean option to enable the Secure Partition Manager (SPM). + Refer to the `Secure Partition Manager Design guide`_ for more details about + this feature. Default is 0. + - ``ENABLE_SVE_FOR_NS``: Boolean option to enable Scalable Vector Extension (SVE) for the Non-secure world only. SVE is an optional architectural feature for AArch64. Note that when SVE is enabled for the Non-secure world, access @@ -510,12 +509,6 @@ Common build options - ``LDFLAGS``: Extra user options appended to the linkers' command line in addition to the one set by the build system. -- ``LOAD_IMAGE_V2``: Boolean option to enable support for new version (v2) of - image loading, which provides more flexibility and scalability around what - images are loaded and executed during boot. Default is 0. - - Note: this flag must be enabled for AArch32 builds. - - ``LOG_LEVEL``: Chooses the log level, which controls the amount of console log output compiled into the build. This should be one of the following: @@ -714,14 +707,6 @@ Arm development platform specific build options sets the TSP location to DRAM and ignores the ``ARM_TSP_RAM_LOCATION`` build flag. -- ``ARM_BOARD_OPTIMISE_MEM``: Boolean option to enable or disable optimisation - of the memory reserved for each image. This affects the maximum size of each - BL image as well as the number of allocated memory regions and translation - tables. By default this flag is 0, which means it uses the default - unoptimised values for these macros. Arm development platforms that wish to - optimise memory usage need to set this flag to 1 and must override the - related macros. - - ``ARM_CONFIG_CNTACR``: boolean option to unlock access to the ``CNTBase<N>`` frame registers by setting the ``CNTCTLBase.CNTACR<N>`` register bits. The frame number ``<N>`` is defined by ``PLAT_ARM_NSTIMER_FRAME_ID``, which should @@ -840,9 +825,6 @@ Arm FVP platform specific build options - ``FVP_GIC600`` : The GIC600 implementation of GICv3 is selected - ``FVP_GICV2`` : The GICv2 only driver is selected - ``FVP_GICV3`` : The GICv3 only driver is selected (default option) - - ``FVP_GICV3_LEGACY``: The Legacy GICv3 driver is selected (deprecated) - Note: If TF-A is compiled with this option on FVPs with GICv3 hardware, - then it configures the hardware to run in GICv2 emulation mode - ``FVP_USE_SP804_TIMER`` : Use the SP804 timer instead of the Generic Timer for functions that wait for an arbitrary time length (udelay and mdelay). @@ -1081,18 +1063,6 @@ destination. In that case, use -f or --force to continue. More information about FIP can be found in the `Firmware Design`_ document. -Migrating from fip\_create to fiptool -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The previous version of fiptool was called fip\_create. A compatibility script -that emulates the basic functionality of the previous fip\_create is provided. -However, users are strongly encouraged to migrate to fiptool. - -- To create a new FIP file, replace "fip\_create" with "fiptool create". -- To update a FIP file, replace "fip\_create" with "fiptool update". -- To dump the contents of a FIP file, replace "fip\_create --dump" - with "fiptool info". - Building FIP images with support for Trusted Board Boot ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1211,12 +1181,12 @@ command: make PLAT=<platform> [DEBUG=1] [V=1] certtool -For platforms that do not require their own IDs in certificate files, -the generic 'cert\_create' tool can be built with the following command: +For platforms that require their own IDs in certificate files, the generic +'cert\_create' tool can be built with the following command: :: - make USE_TBBR_DEFS=1 [DEBUG=1] [V=1] certtool + make USE_TBBR_DEFS=0 [DEBUG=1] [V=1] certtool ``DEBUG=1`` builds the tool in debug mode. ``V=1`` makes the build process more verbose. The following command should be used to obtain help about the tool: @@ -1334,7 +1304,7 @@ section for more info on selecting the right FDT to use. :: - make ARCH=aarch64 PLAT=juno LOAD_IMAGE_V2=1 JUNO_AARCH32_EL3_RUNTIME=1 \ + make ARCH=aarch64 PLAT=juno JUNO_AARCH32_EL3_RUNTIME=1 \ BL33=<path-to-juno32-oe-uboot>/SOFTWARE/bl33-uboot.bin \ SCP_BL2=<path-to-juno32-oe-uboot>/SOFTWARE/scp_bl2.bin \ BL32=<path-to-bl32>/bl32.bin all fip @@ -2076,7 +2046,7 @@ wakeup interrupt from RTC. .. _Instructions for using Linaro's deliverables on Juno: https://community.arm.com/dev-platforms/w/docs/303/juno .. _Arm Platforms Portal: https://community.arm.com/dev-platforms/ .. _Development Studio 5 (DS-5): http://www.arm.com/products/tools/software-tools/ds-5/index.php -.. _Linux master tree: <https://github.com/torvalds/linux/tree/master/> +.. _Linux master tree: https://github.com/torvalds/linux/tree/master/ .. _Dia: https://wiki.gnome.org/Apps/Dia/Download .. _here: psci-lib-integration-guide.rst .. _Trusted Board Boot: trusted-board-boot.rst @@ -2090,3 +2060,4 @@ wakeup interrupt from RTC. .. _FVP models: https://developer.arm.com/products/system-design/fixed-virtual-platforms .. _Juno Getting Started Guide: http://infocenter.arm.com/help/topic/com.arm.doc.dui0928e/DUI0928E_juno_arm_development_platform_gsg.pdf .. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf +.. _Secure Partition Manager Design guide: secure-partition-manager-design.rst |