diff options
author | Antonio Nino Diaz <antonio.ninodiaz@arm.com> | 2016-04-06 17:31:57 +0100 |
---|---|---|
committer | Antonio Nino Diaz <antonio.ninodiaz@arm.com> | 2016-04-08 09:36:48 +0100 |
commit | 68450a6d5bbe3b6a79bd42d508e2d6bb0ed4b6f6 (patch) | |
tree | 37740c15dd62bda3ea0c6529adcbdb247a33a915 /docs | |
parent | d5d6b896114c06e2632c2965fca0efc869f1969c (diff) |
Rename BL33_BASE option to PRELOADED_BL33_BASE
To avoid confusion the build option BL33_BASE has been renamed to
PRELOADED_BL33_BASE, which is more descriptive of what it does and
doesn't get mistaken by similar names like BL32_BASE that work in a
completely different way.
NOTE: PLATFORMS USING BUILD OPTION `BL33_BASE` MUST CHANGE TO THE NEW
BUILD OPTION `PRELOADED_BL33_BASE`.
Change-Id: I658925ebe95406edf0325f15aa1752e1782aa45b
Diffstat (limited to 'docs')
-rw-r--r-- | docs/porting-guide.md | 12 | ||||
-rw-r--r-- | docs/user-guide.md | 22 |
2 files changed, 17 insertions, 17 deletions
diff --git a/docs/porting-guide.md b/docs/porting-guide.md index f8d0ff38..e62db4de 100644 --- a/docs/porting-guide.md +++ b/docs/porting-guide.md @@ -1242,8 +1242,8 @@ BL33 image. The meminfo provided by this is used by load_image() to validate whether the BL33 image can be loaded with in the given memory from the given base. -This function isn't needed if either `BL33_BASE` or `EL3_PAYLOAD_BASE` build -options are used. +This function isn't needed if either `PRELOADED_BL33_BASE` or `EL3_PAYLOAD_BASE` +build options are used. ### Function : bl2_plat_flush_bl31_params() [mandatory] @@ -1267,8 +1267,8 @@ entrypoint of that image, which BL31 uses to jump to it. BL2 is responsible for loading the normal world BL33 image (e.g. UEFI). -This function isn't needed if either `BL33_BASE` or `EL3_PAYLOAD_BASE` build -options are used. +This function isn't needed if either `PRELOADED_BL33_BASE` or `EL3_PAYLOAD_BASE` +build options are used. 3.3 FWU Boot Loader Stage 2 (BL2U) @@ -1973,8 +1973,8 @@ build system. By default, this flag is defined `yes` by the build system and `BL33` build option should be supplied as a build option. The platform has the option of excluding the BL33 image in the `fip` image by defining this flag - to `no`. If any of the options `EL3_PAYLOAD_BASE` or `BL33_BASE` are used, - this flag will be set to `no` automatically. + to `no`. If any of the options `EL3_PAYLOAD_BASE` or `PRELOADED_BL33_BASE` + are used, this flag will be set to `no` automatically. 5. C Library ------------- diff --git a/docs/user-guide.md b/docs/user-guide.md index 37e20346..3458f640 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -408,11 +408,11 @@ performed. payload. Please refer to the "Booting an EL3 payload" section for more details. -* `BL33_BASE`: This option enables booting a preloaded BL33 image instead of - the normal boot flow. When defined, it must specify the entry point address - for the preloaded BL33 image. This option is incompatible with +* `PRELOADED_BL33_BASE`: This option enables booting a preloaded BL33 image + instead of the normal boot flow. When defined, it must specify the entry + point address for the preloaded BL33 image. This option is incompatible with `EL3_PAYLOAD_BASE`. If both are defined, `EL3_PAYLOAD_BASE` has priority - over `BL33_BASE`. + over `PRELOADED_BL33_BASE`. * `PL011_GENERIC_UART`: Boolean option to indicate the PL011 driver that the underlying hardware is not a full PL011 UART but a minimally compliant @@ -998,13 +998,13 @@ code and improve performance in a development environment. When secure world cold boot is complete, Trusted Firmware simply jumps to a BL33 base address provided at build time. -For this option to be used, the `BL33_BASE` build option has to be used when -compiling the Trusted Firmware. For example, the following command will create -a FIP without a BL33 and prepare to jump to a BL33 image loaded at address -0x80000000: +For this option to be used, the `PRELOADED_BL33_BASE` build option has to be +used when compiling the Trusted Firmware. For example, the following command +will create a FIP without a BL33 and prepare to jump to a BL33 image loaded at +address 0x80000000: CROSS_COMPILE=<path-to>/bin/aarch64-linux-gnu- \ - make BL33_BASE=0x80000000 PLAT=fvp all fip + make PRELOADED_BL33_BASE=0x80000000 PLAT=fvp all fip #### Boot of a preloaded bootwrapped kernel image on Base FVP @@ -1026,8 +1026,8 @@ following command: The `-a cluster0.cpu0=<bootwrapped-kernel.elf>` option loads the ELF file. It also sets the PC register to the ELF entry point address, which is not the desired behaviour, so the `--start cluster0.cpu0=0x0` option forces the PC back -to 0x0 (the BL1 entry point address) on CPU #0. The `BL33_BASE` define used when -compiling the FIP must match the ELF entry point. +to 0x0 (the BL1 entry point address) on CPU #0. The `PRELOADED_BL33_BASE` define +used when compiling the FIP must match the ELF entry point. #### Boot of a preloaded bootwrapped kernel image on Juno |