[edk2-platforms PATCH] Platform/ARM: Update Readme.md

[edk2-platforms PATCH] Platform/ARM: Update Readme.md

[Rebecca Cran]

The repo with the Visual Studio support no longer exists.
fiptool from the prebuilt_tools repo doesn't work due to a missing
dependency on libcrypto.so.1.0.0, so tell users to build it from the
trusted-firmware-a repo instead.
There's a newer version of fvp-uefi.zip that was released in 2020.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
---
 Platform/ARM/Readme.md | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Platform/ARM/Readme.md b/Platform/ARM/Readme.md
index e1a405b700..afc9ad3646 100644
--- a/Platform/ARM/Readme.md
+++ b/Platform/ARM/Readme.md
@@ -8,10 +8,8 @@ can be found here:
 
 ##Requirements
 - A 32-bit or 64-bit Linux host machine.
-- Visual Studio is not officially supported, experimental support can be found here:
-[https://git.linaro.org/people/leif.lindholm/edk2.git/log/?h=aarch64-vs]
 
-# Build EDK2 Tianocore
+# Build EDK2 TianoCore
 
 `build -a AARCH64 -p Platform/ARM/VExpressPkg/ArmVExpress-FVP-AArch64.dsc -t GCC5`
 
@@ -26,7 +24,7 @@ prebuilt edk2 image.
 
 We will also rely on the "run_model" script that comes with the prebuilts, it
 is entirely possible to run the model without this but would require quite a bit
-of knowledge regarding the areguments ARM fastmodel (documentation can be found here:
+of knowledge regarding the arguments ARM fastmodel (documentation can be found here:
 [https://developer.arm.com/docs/100966/1101/programming-reference-for-base-fvps/base-platform-revc-features])
 however the manual set of the FVP is outside the scope of this document. If you are interested
 please consult the documentation.
@@ -40,16 +38,18 @@ the binaries in the same directory.
 	- Select Armv8-A Base Platform FVP based on Fast Models 11.4
 	- It has a click through license but is free.
 
-2. Download the 18.10 Linaro ARM Landing Team release for FVP booting UEFI
-https://releases.linaro.org/members/arm/platforms/18.10/fvp-uefi.zip
+2. Download the 20.01 Linaro ARM Landing Team release for FVP booting UEFI
+https://releases.linaro.org/members/arm/platforms/20.01/fvp-uefi.zip
 
-3. Download the prebuilt fiptool from https://git.linaro.org/landing-teams/working/arm/prebuilt_tools.git
+3. Clone the trusted firmware repo from https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git
 
-4. Update the fip.bin image from fvp-uefi.zip by running the following command:
+4. Build fiptool: `make -C trusted-firmware-a/tools/fiptool`
 
-	`fiptool update --nt-fw=[path to binary built above] fip.bin`
+5. Update the fip.bin image from fvp-uefi.zip by running the following command:
 
-5. Execute the FVP run_model.sh script from fvp-uefi.zip and provide a path to the FVP binaries
+	`./trusted-firmware-a/tools/fiptool/fiptool update --nt-fw=[path to binary built above] fip.bin`
+
+6. Execute the FVP run_model.sh script from fvp-uefi.zip and provide a path to the FVP binaries
 downloaded in step 1):
 
 	`MODEL=[path to FVP binary] ./run_model.sh`
-- 
2.31.1

Re: [edk2-devel] [edk2-platforms PATCH] Platform/ARM: Update Readme.md

[christopher.jones]

[-- Attachment #1: Type: text/plain, Size: 3872 bytes --]

Hi Rebecca,

Thank you for your patch.

It functionally looks good however I noticed one small grammatical error to fix, noted below.

Reviewed-by: Chris Jones <christopher.jones@arm.com>

Thanks,
Chris

> 
> The repo with the Visual Studio support no longer exists.
> fiptool from the prebuilt_tools repo doesn't work due to a missing
> dependency on libcrypto.so.1.0.0, so tell users to build it from the
> trusted-firmware-a repo instead.
> There's a newer version of fvp-uefi.zip that was released in 2020.
> 
> Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
> ---
> Platform/ARM/Readme.md | 20 ++++++++++----------
> 1 file changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/Platform/ARM/Readme.md b/Platform/ARM/Readme.md
> index e1a405b700..afc9ad3646 100644
> --- a/Platform/ARM/Readme.md
> +++ b/Platform/ARM/Readme.md
> @@ -8,10 +8,8 @@ can be found here:
> =0D
> ##Requirements=0D
> - A 32-bit or 64-bit Linux host machine.=0D
> -- Visual Studio is not officially supported, experimental support can be
> f=
> ound here:=0D
> -[ https://git.linaro.org/people/leif.lindholm/edk2.git/log/?h=3Daarch64-vs
> ]=
> =0D
> =0D
> -# Build EDK2 Tianocore=0D
> +# Build EDK2 TianoCore=0D
> =0D
> `build -a AARCH64 -p Platform/ARM/VExpressPkg/ArmVExpress-FVP-AArch64.dsc
> =
> -t GCC5`=0D
> =0D
> @@ -26,7 +24,7 @@ prebuilt edk2 image.
> =0D
> We will also rely on the "run_model" script that comes with the
> prebuilts,=
> it=0D
> is entirely possible to run the model without this but would require
> quite=
> a bit=0D

[CHRIS] This does not make sense, instead I suggest:
"of knowledge regarding the arguments *of the* ARM fastmodel (documentation can be f=
ound here:=0D".
Note: while this was not introduced by you it would be nice to fix now.

> 
> -of knowledge regarding the areguments ARM fastmodel (documentation can be
> =
> found here:=0D
> +of knowledge regarding the arguments ARM fastmodel (documentation can be
> f=
> ound here:=0D

> 
> [ https://developer.arm.com/docs/100966/1101/programming-reference-for-base=
> 
> -fvps/base-platform-revc-features])=0D
> however the manual set of the FVP is outside the scope of this document.
> I=
> f you are interested=0D
> please consult the documentation.=0D
> @@ -40,16 +38,18 @@ the binaries in the same directory.
> - Select Armv8-A Base Platform FVP based on Fast Models 11.4=0D
> - It has a click through license but is free.=0D
> =0D
> -2. Download the 18.10 Linaro ARM Landing Team release for FVP booting
> UEFI=
> =0D
> - https://releases.linaro.org/members/arm/platforms/18.10/fvp-uefi.zip=0D
> +2. Download the 20.01 Linaro ARM Landing Team release for FVP booting
> UEFI=
> =0D
> + https://releases.linaro.org/members/arm/platforms/20.01/fvp-uefi.zip=0D
> =0D
> -3. Download the prebuilt fiptool from https://git.linaro.org/landing-teams=
> 
> /working/arm/prebuilt_tools.git=0D
> +3. Clone the trusted firmware repo from https://git.trustedfirmware.org/TF=
> 
> -A/trusted-firmware-a.git=0D
> =0D
> -4. Update the fip.bin image from fvp-uefi.zip by running the following
> com=
> mand:=0D
> +4. Build fiptool: `make -C trusted-firmware-a/tools/fiptool`=0D
> =0D
> - `fiptool update --nt-fw=3D[path to binary built above] fip.bin`=0D
> +5. Update the fip.bin image from fvp-uefi.zip by running the following
> com=
> mand:=0D
> =0D
> -5. Execute the FVP run_model.sh script from fvp-uefi.zip and provide a
> pat=
> h to the FVP binaries=0D
> + `./trusted-firmware-a/tools/fiptool/fiptool update --nt-fw=3D[path to
> bin=
> ary built above] fip.bin`=0D
> +=0D
> +6. Execute the FVP run_model.sh script from fvp-uefi.zip and provide a
> pat=
> h to the FVP binaries=0D
> downloaded in step 1):=0D
> =0D
> `MODEL=3D[path to FVP binary] ./run_model.sh`=0D
> --=20
> 2.31.1

[-- Attachment #2: Type: text/html, Size: 4758 bytes --]