summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan Harkin <ryan.harkin@linaro.org>2014-06-26 17:20:28 +0100
committerRyan Harkin <ryan.harkin@linaro.org>2014-06-26 17:20:28 +0100
commite8bb9ac442f48182db9449138d5a51fff8bd8546 (patch)
treee12efac678c3ad9bfd2f0e18377de0c7605a6c08
parentd34ee511c143c1fd062edf28e06604f2c813a079 (diff)
14.06: apply HACKING update from Andy
Signed-off-by: Ryan Harkin <ryan.harkin@linaro.org>
-rw-r--r--android/images/armv8-android-juno-lsk/HOWTO_getsourceandbuild.txt95
-rw-r--r--android/images/armv8-juice-juno-lsk/HOWTO_getsourceandbuild.txt95
-rw-r--r--openembedded/juno-lsk/HACKING.textile95
3 files changed, 120 insertions, 165 deletions
diff --git a/android/images/armv8-android-juno-lsk/HOWTO_getsourceandbuild.txt b/android/images/armv8-android-juno-lsk/HOWTO_getsourceandbuild.txt
index 53b723b..e535a41 100644
--- a/android/images/armv8-android-juno-lsk/HOWTO_getsourceandbuild.txt
+++ b/android/images/armv8-android-juno-lsk/HOWTO_getsourceandbuild.txt
@@ -81,24 +81,21 @@ The following tools and environment are required:
bc. $ export JUNO_ROOT_DIR=<path-to-working-dir>/<name-of-working-dir>
-
-h1. Building the components
-
h2. SCP Firmware
The SCP Firmware is only available as a pre-built binary.
 
-h2. AP Trusted Firmware
+h2. ARM Trusted Firmware
-The AP trusted firmware consists of the following images:
+The ARM trusted firmware consists of the following images:
|<b>Filename</b>|<b>Image Type</b>|<b>Image Name</b>|
-|bl1.bin|BL1|AP Trusted ROM image|
-|bl2.bin|BL2|AP Trusted Firmware|
+|bl1.bin|BL1|ARM Trusted ROM image|
+|bl2.bin|BL2|ARM Trusted Firmware|
|bl31.bin|BL3-1|EL3 runtime|
-|bl32.bin|BL3-2|Test Secure Payload|
+|bl32.bin (optional)|BL3-2|Test Secure Payload|
The bl2.bin, bl31.bin and bl32.bin images are inputs to the process of creating a Firmware Image Package.
@@ -107,9 +104,9 @@ h3. Obtaining sources
Clone the ARM Trusted Firmware repository from GitHub:
bc. $ cd $JUNO_ROOT_DIR
-$ git clone "$":https://github.com/ARM-software/arm-trusted-firmware.git
+$ git clone https://github.com/ARM-software/arm-trusted-firmware.git
$ cd arm-trusted-firmware
-$ git checkout v0.3-Juno-0.3
+$ git checkout v0.4-Juno-0.5
h3. Configuration
@@ -127,27 +124,25 @@ bc. $ cd $JUNO_ROOT_DIR/arm-trusted-firmware
bc. $ make PLAT=juno all
-By default this produces a release version of the build. To produce a debug version instead and make the build more verbose use:
-
-bc. $ make PLAT=juno DEBUG=1 V=1 all
-
-The build process creates products in a `build` directory tree, building the objects for each boot loader stage in separate sub-directories. The following boot loader binary files are created:
-
-    `build/juno/<build-type>/bl1.bin`
+To build the optional bl3-2 Test Secure Payload component, use the following commands instead (the 'make realclean' is important):
-    `build/juno/<build-type>/bl2.bin`
+bc. $ make realclean
+$ make PLAT=juno SPD=tspd all
-    `build/juno/<build-type>/bl31.bin`
+By default the preceding commands produce a release version of the build. To produce a debug version instead and make the build more verbose use:
-    `build/juno/<build-type>/bl32.bin`
+bc. $ make PLAT=juno DEBUG=1 V=1 all
+The build process creates products in a `build` directory tree, building the objects for each boot loader stage in separate sub-directories. The following boot loader binary files are created:
-... where `<build-type>` is either `debug` or `release`.
+* @build/juno/<build-type>/bl1.bin@
+* @build/juno/<build-type>/bl2.bin@
+* @build/juno/<build-type>/bl31.bin@
+* @build/juno/<build-type>/bl32.bin@ (if the 'SPD=tspd' flag is used)
+... where @<build-type>@ is either `debug` or `release`.
-To clean the AP Trusted Firmware source tree (warning, this will remove the binaries too):
+To clean the ARM Trusted Firmware source tree (warning, this will remove the binaries too):
bc. $ make realclean
@@ -164,7 +159,7 @@ Clone the Juno UEFI Github repository:
bc. $ cd $JUNO_ROOT_DIR
$ git clone https://github.com/ARM-software/edk2.git -b juno
$ cd edk2
-$ git checkout v0.3
+$ git checkout v1.0-rc0
 
@@ -196,7 +191,7 @@ To build RELEASE version of UEFI firmware:
bc. $ make -f ArmPlatformPkg/ArmJunoPkg/Makefile EDK2_BUILD=RELEASE
-Use the release binary $JUNO_ROOT_DIR/edk2>/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd as bl33.bin when generating the Firmware Image Package binary.
+Use the release binary $JUNO_ROOT_DIR/edk2/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd as bl33.bin when generating the Firmware Image Package binary.
To clean EDK2 source tree:
@@ -208,13 +203,10 @@ h2. Packaging the binaries
ARM Trusted Firmware uses the Firmware Image Package (FIP) binary blob to load images into the system, so that the firmware can avoid managing lots of smaller images. The FIP will contain:
-    BL2 and BL3-1 boot loader images
-
-    Test Secure Payload (BL3-2 image)
-
-    UEFI firmware (BL3-3 image)
-
-    SCP firmware (BL3-0 image)
+* BL2 and BL3-1 boot loader images
+* Test Secure Payload (BL3-2 image - optional)
+* UEFI firmware (BL3-3 image)
+* SCP firmware (BL3-0 image)
Note: BL1 image is NOT part of the FIP.
@@ -246,20 +238,18 @@ $ cp $JUNO_ROOT_DIR/edk2/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd  bl33.b
4. Create the FIP file:
-bc. $ fip_create --dump         \
-             --bl2 bl2.bin  \
-             --bl30 bl30.bin \
-             --bl31 bl31.bin \
-             --bl33 bl33.bin \
-             fip.bin
-
+bc. $ fip_create --dump \
+ --bl2 bl2.bin \
+ --bl30 bl30.bin \
+ --bl31 bl31.bin \
+ --bl32 bl32.bin \ (if the optional bl32 image is present)
+ --bl33 bl33.bin \
+ fip.bin
The previous command will display the FIP layout:
-
-bc. Firmware Image Package ToC:
+
+bc.. Firmware Image Package ToC:
---------------------------
- Trusted Boot Firmware BL2: offset=0xD8, size=0x5268
- SCP Firmware BL3-0: offset=0x5340, size=0x9C64
@@ -267,19 +257,16 @@ bc. Firmware Image Package ToC:
- Non-Trusted Firmware BL3-3: offset=0x17244, size=0xF0000
---------------------------
-bc. Creating &quot;fip.bin&quot;
-
+Creating "fip.bin";
+p.
5. Optional: the `fip_create` tool can be used in the exact same way to update individual images inside an existing FIP file. For example, to update the SCP Firmware BL3-0 image:
bc. $ fip_create --dump --bl30 new_bl30.bin fip.bin
The previous command will again display the FIP layout:
-
-bc. Firmware Image Package ToC:
+bc.. Firmware Image Package ToC:
---------------------------
- Trusted Boot Firmware BL2: offset=0xD8, size=0x5268
- SCP Firmware BL3-0: offset=0x5340, size=0x9C64
@@ -288,13 +275,11 @@ file: 'new_bl30.bin'
- Non-Trusted Firmware BL3-3: offset=0x17244, size=0xF0000
---------------------------
-bc. Updating &quot;fip.bin&quot;
-
+Updating "fip.bin"
+p.
For more details and options about the `fip_create` tool:
bc. $ fip_create --help
-
+
diff --git a/android/images/armv8-juice-juno-lsk/HOWTO_getsourceandbuild.txt b/android/images/armv8-juice-juno-lsk/HOWTO_getsourceandbuild.txt
index 0b80017..c337230 100644
--- a/android/images/armv8-juice-juno-lsk/HOWTO_getsourceandbuild.txt
+++ b/android/images/armv8-juice-juno-lsk/HOWTO_getsourceandbuild.txt
@@ -81,24 +81,21 @@ The following tools and environment are required:
bc. $ export JUNO_ROOT_DIR=<path-to-working-dir>/<name-of-working-dir>
-
-h1. Building the components
-
h2. SCP Firmware
The SCP Firmware is only available as a pre-built binary.
 
-h2. AP Trusted Firmware
+h2. ARM Trusted Firmware
-The AP trusted firmware consists of the following images:
+The ARM trusted firmware consists of the following images:
|<b>Filename</b>|<b>Image Type</b>|<b>Image Name</b>|
-|bl1.bin|BL1|AP Trusted ROM image|
-|bl2.bin|BL2|AP Trusted Firmware|
+|bl1.bin|BL1|ARM Trusted ROM image|
+|bl2.bin|BL2|ARM Trusted Firmware|
|bl31.bin|BL3-1|EL3 runtime|
-|bl32.bin|BL3-2|Test Secure Payload|
+|bl32.bin (optional)|BL3-2|Test Secure Payload|
The bl2.bin, bl31.bin and bl32.bin images are inputs to the process of creating a Firmware Image Package.
@@ -107,9 +104,9 @@ h3. Obtaining sources
Clone the ARM Trusted Firmware repository from GitHub:
bc. $ cd $JUNO_ROOT_DIR
-$ git clone "$":https://github.com/ARM-software/arm-trusted-firmware.git
+$ git clone https://github.com/ARM-software/arm-trusted-firmware.git
$ cd arm-trusted-firmware
-$ git checkout v0.3-Juno-0.3
+$ git checkout v0.4-Juno-0.5
h3. Configuration
@@ -127,27 +124,25 @@ bc. $ cd $JUNO_ROOT_DIR/arm-trusted-firmware
bc. $ make PLAT=juno all
-By default this produces a release version of the build. To produce a debug version instead and make the build more verbose use:
-
-bc. $ make PLAT=juno DEBUG=1 V=1 all
-
-The build process creates products in a `build` directory tree, building the objects for each boot loader stage in separate sub-directories. The following boot loader binary files are created:
-
-    `build/juno/<build-type>/bl1.bin`
+To build the optional bl3-2 Test Secure Payload component, use the following commands instead (the 'make realclean' is important):
-    `build/juno/<build-type>/bl2.bin`
+bc. $ make realclean
+$ make PLAT=juno SPD=tspd all
-    `build/juno/<build-type>/bl31.bin`
+By default the preceding commands produce a release version of the build. To produce a debug version instead and make the build more verbose use:
-    `build/juno/<build-type>/bl32.bin`
+bc. $ make PLAT=juno DEBUG=1 V=1 all
+The build process creates products in a `build` directory tree, building the objects for each boot loader stage in separate sub-directories. The following boot loader binary files are created:
-... where `<build-type>` is either `debug` or `release`.
+* @build/juno/<build-type>/bl1.bin@
+* @build/juno/<build-type>/bl2.bin@
+* @build/juno/<build-type>/bl31.bin@
+* @build/juno/<build-type>/bl32.bin@ (if the 'SPD=tspd' flag is used)
+... where @<build-type>@ is either `debug` or `release`.
-To clean the AP Trusted Firmware source tree (warning, this will remove the binaries too):
+To clean the ARM Trusted Firmware source tree (warning, this will remove the binaries too):
bc. $ make realclean
@@ -164,7 +159,7 @@ Clone the Juno UEFI Github repository:
bc. $ cd $JUNO_ROOT_DIR
$ git clone https://github.com/ARM-software/edk2.git -b juno
$ cd edk2
-$ git checkout v0.3
+$ git checkout v1.0-rc0
 
@@ -196,7 +191,7 @@ To build RELEASE version of UEFI firmware:
bc. $ make -f ArmPlatformPkg/ArmJunoPkg/Makefile EDK2_BUILD=RELEASE
-Use the release binary $JUNO_ROOT_DIR/edk2>/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd as bl33.bin when generating the Firmware Image Package binary.
+Use the release binary $JUNO_ROOT_DIR/edk2/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd as bl33.bin when generating the Firmware Image Package binary.
To clean EDK2 source tree:
@@ -208,13 +203,10 @@ h2. Packaging the binaries
ARM Trusted Firmware uses the Firmware Image Package (FIP) binary blob to load images into the system, so that the firmware can avoid managing lots of smaller images. The FIP will contain:
-    BL2 and BL3-1 boot loader images
-
-    Test Secure Payload (BL3-2 image)
-
-    UEFI firmware (BL3-3 image)
-
-    SCP firmware (BL3-0 image)
+* BL2 and BL3-1 boot loader images
+* Test Secure Payload (BL3-2 image - optional)
+* UEFI firmware (BL3-3 image)
+* SCP firmware (BL3-0 image)
Note: BL1 image is NOT part of the FIP.
@@ -246,20 +238,18 @@ $ cp $JUNO_ROOT_DIR/edk2/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd  bl33.b
4. Create the FIP file:
-bc. $ fip_create --dump         \
-             --bl2 bl2.bin  \
-             --bl30 bl30.bin \
-             --bl31 bl31.bin \
-             --bl33 bl33.bin \
-             fip.bin
-
+bc. $ fip_create --dump \
+ --bl2 bl2.bin \
+ --bl30 bl30.bin \
+ --bl31 bl31.bin \
+ --bl32 bl32.bin \ (if the optional bl32 image is present)
+ --bl33 bl33.bin \
+ fip.bin
The previous command will display the FIP layout:
-
-bc. Firmware Image Package ToC:
+
+bc.. Firmware Image Package ToC:
---------------------------
- Trusted Boot Firmware BL2: offset=0xD8, size=0x5268
- SCP Firmware BL3-0: offset=0x5340, size=0x9C64
@@ -267,19 +257,16 @@ bc. Firmware Image Package ToC:
- Non-Trusted Firmware BL3-3: offset=0x17244, size=0xF0000
---------------------------
-bc. Creating &quot;fip.bin&quot;
-
+Creating "fip.bin";
+p.
5. Optional: the `fip_create` tool can be used in the exact same way to update individual images inside an existing FIP file. For example, to update the SCP Firmware BL3-0 image:
bc. $ fip_create --dump --bl30 new_bl30.bin fip.bin
The previous command will again display the FIP layout:
-
-bc. Firmware Image Package ToC:
+bc.. Firmware Image Package ToC:
---------------------------
- Trusted Boot Firmware BL2: offset=0xD8, size=0x5268
- SCP Firmware BL3-0: offset=0x5340, size=0x9C64
@@ -288,13 +275,11 @@ file: 'new_bl30.bin'
- Non-Trusted Firmware BL3-3: offset=0x17244, size=0xF0000
---------------------------
-bc. Updating &quot;fip.bin&quot;
-
+Updating "fip.bin"
+p.
For more details and options about the `fip_create` tool:
bc. $ fip_create --help
-
+
diff --git a/openembedded/juno-lsk/HACKING.textile b/openembedded/juno-lsk/HACKING.textile
index 11cceeb..b6db5ed 100644
--- a/openembedded/juno-lsk/HACKING.textile
+++ b/openembedded/juno-lsk/HACKING.textile
@@ -70,24 +70,21 @@ The following tools and environment are required:
bc. $ export JUNO_ROOT_DIR=<path-to-working-dir>/<name-of-working-dir>
-
-h1. Building the components
-
h2. SCP Firmware
The SCP Firmware is only available as a pre-built binary.
 
-h2. AP Trusted Firmware
+h2. ARM Trusted Firmware
-The AP trusted firmware consists of the following images:
+The ARM trusted firmware consists of the following images:
|<b>Filename</b>|<b>Image Type</b>|<b>Image Name</b>|
-|bl1.bin|BL1|AP Trusted ROM image|
-|bl2.bin|BL2|AP Trusted Firmware|
+|bl1.bin|BL1|ARM Trusted ROM image|
+|bl2.bin|BL2|ARM Trusted Firmware|
|bl31.bin|BL3-1|EL3 runtime|
-|bl32.bin|BL3-2|Test Secure Payload|
+|bl32.bin (optional)|BL3-2|Test Secure Payload|
The bl2.bin, bl31.bin and bl32.bin images are inputs to the process of creating a Firmware Image Package.
@@ -96,9 +93,9 @@ h3. Obtaining sources
Clone the ARM Trusted Firmware repository from GitHub:
bc. $ cd $JUNO_ROOT_DIR
-$ git clone "$":https://github.com/ARM-software/arm-trusted-firmware.git
+$ git clone https://github.com/ARM-software/arm-trusted-firmware.git
$ cd arm-trusted-firmware
-$ git checkout v0.3-Juno-0.3
+$ git checkout v0.4-Juno-0.5
h3. Configuration
@@ -116,27 +113,25 @@ bc. $ cd $JUNO_ROOT_DIR/arm-trusted-firmware
bc. $ make PLAT=juno all
-By default this produces a release version of the build. To produce a debug version instead and make the build more verbose use:
-
-bc. $ make PLAT=juno DEBUG=1 V=1 all
-
-The build process creates products in a `build` directory tree, building the objects for each boot loader stage in separate sub-directories. The following boot loader binary files are created:
-
-    `build/juno/<build-type>/bl1.bin`
+To build the optional bl3-2 Test Secure Payload component, use the following commands instead (the 'make realclean' is important):
-    `build/juno/<build-type>/bl2.bin`
+bc. $ make realclean
+$ make PLAT=juno SPD=tspd all
-    `build/juno/<build-type>/bl31.bin`
+By default the preceding commands produce a release version of the build. To produce a debug version instead and make the build more verbose use:
-    `build/juno/<build-type>/bl32.bin`
+bc. $ make PLAT=juno DEBUG=1 V=1 all
+The build process creates products in a `build` directory tree, building the objects for each boot loader stage in separate sub-directories. The following boot loader binary files are created:
-... where `<build-type>` is either `debug` or `release`.
+* @build/juno/<build-type>/bl1.bin@
+* @build/juno/<build-type>/bl2.bin@
+* @build/juno/<build-type>/bl31.bin@
+* @build/juno/<build-type>/bl32.bin@ (if the 'SPD=tspd' flag is used)
+... where @<build-type>@ is either `debug` or `release`.
-To clean the AP Trusted Firmware source tree (warning, this will remove the binaries too):
+To clean the ARM Trusted Firmware source tree (warning, this will remove the binaries too):
bc. $ make realclean
@@ -153,7 +148,7 @@ Clone the Juno UEFI Github repository:
bc. $ cd $JUNO_ROOT_DIR
$ git clone https://github.com/ARM-software/edk2.git -b juno
$ cd edk2
-$ git checkout v0.3
+$ git checkout v1.0-rc0
 
@@ -185,7 +180,7 @@ To build RELEASE version of UEFI firmware:
bc. $ make -f ArmPlatformPkg/ArmJunoPkg/Makefile EDK2_BUILD=RELEASE
-Use the release binary $JUNO_ROOT_DIR/edk2>/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd as bl33.bin when generating the Firmware Image Package binary.
+Use the release binary $JUNO_ROOT_DIR/edk2/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd as bl33.bin when generating the Firmware Image Package binary.
To clean EDK2 source tree:
@@ -197,13 +192,10 @@ h2. Packaging the binaries
ARM Trusted Firmware uses the Firmware Image Package (FIP) binary blob to load images into the system, so that the firmware can avoid managing lots of smaller images. The FIP will contain:
-    BL2 and BL3-1 boot loader images
-
-    Test Secure Payload (BL3-2 image)
-
-    UEFI firmware (BL3-3 image)
-
-    SCP firmware (BL3-0 image)
+* BL2 and BL3-1 boot loader images
+* Test Secure Payload (BL3-2 image - optional)
+* UEFI firmware (BL3-3 image)
+* SCP firmware (BL3-0 image)
Note: BL1 image is NOT part of the FIP.
@@ -235,20 +227,18 @@ $ cp $JUNO_ROOT_DIR/edk2/Build/ArmJuno/RELEASE_GCC48/FV/BL32_AP_UEFI.fd  bl33.b
4. Create the FIP file:
-bc. $ fip_create --dump         \
-             --bl2 bl2.bin  \
-             --bl30 bl30.bin \
-             --bl31 bl31.bin \
-             --bl33 bl33.bin \
-             fip.bin
-
+bc. $ fip_create --dump \
+ --bl2 bl2.bin \
+ --bl30 bl30.bin \
+ --bl31 bl31.bin \
+ --bl32 bl32.bin \ (if the optional bl32 image is present)
+ --bl33 bl33.bin \
+ fip.bin
The previous command will display the FIP layout:
-
-bc. Firmware Image Package ToC:
+
+bc.. Firmware Image Package ToC:
---------------------------
- Trusted Boot Firmware BL2: offset=0xD8, size=0x5268
- SCP Firmware BL3-0: offset=0x5340, size=0x9C64
@@ -256,19 +246,16 @@ bc. Firmware Image Package ToC:
- Non-Trusted Firmware BL3-3: offset=0x17244, size=0xF0000
---------------------------
-bc. Creating &quot;fip.bin&quot;
-
+Creating "fip.bin";
+p.
5. Optional: the `fip_create` tool can be used in the exact same way to update individual images inside an existing FIP file. For example, to update the SCP Firmware BL3-0 image:
bc. $ fip_create --dump --bl30 new_bl30.bin fip.bin
The previous command will again display the FIP layout:
-
-bc. Firmware Image Package ToC:
+bc.. Firmware Image Package ToC:
---------------------------
- Trusted Boot Firmware BL2: offset=0xD8, size=0x5268
- SCP Firmware BL3-0: offset=0x5340, size=0x9C64
@@ -277,13 +264,11 @@ file: 'new_bl30.bin'
- Non-Trusted Firmware BL3-3: offset=0x17244, size=0xF0000
---------------------------
-bc. Updating &quot;fip.bin&quot;
-
+Updating "fip.bin"
+p.
For more details and options about the `fip_create` tool:
bc. $ fip_create --help
-
+