[edk2-platforms PATCH 0/4] Marvell readmes

[edk2-platforms PATCH 0/4] Marvell readmes

[Marcin Wojtas]

Hi,

This short patchset adds README files for the platforms
based on Marvell SoC's, which have already been
SystemReady ES certified. It also bumps the firmware
revision after the PCI / IcuLib rework and addition of
the CN913x CEx7 Evaluation Board support.

The patches are available on a public branch:
https://github.com/semihalf-wojtas-marcin/edk2-platforms/commits/marvell-howtos-upstream-r20210921

Any comments / remarks will be appreciated.

Best regards,
Marcin

Grzegorz Bernacki (1):
  SolidRun/Armada80x0McBin: Add Readme.md

Marcin Wojtas (3):
  SolidRun/Cn913xCEx7Eval: Add Readme.md
  Marvell/Cn913xDbA: Add Readme.md
  Marvell: Armada7k8k/OcteonTx: Bump firmware to "EDK2 SH 1.1" revision

 Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc |  4 +-
 Platform/Marvell/Cn913xDb/Readme.md           | 98 ++++++++++++++++++++
 Platform/SolidRun/Armada80x0McBin/Readme.md   | 97 +++++++++++++++++++
 Platform/SolidRun/Cn913xCEx7Eval/Readme.md    | 98 ++++++++++++++++++++
 4 files changed, 295 insertions(+), 2 deletions(-)
 create mode 100644 Platform/Marvell/Cn913xDb/Readme.md
 create mode 100644 Platform/SolidRun/Armada80x0McBin/Readme.md
 create mode 100644 Platform/SolidRun/Cn913xCEx7Eval/Readme.md

-- 
2.29.0

[edk2-platforms PATCH 1/4] SolidRun/Cn913xCEx7Eval: Add Readme.md

[Marcin Wojtas]

Add the complete build instruction for CN913x CEx7 Evaluation Board.

Signed-off-by: Marcin Wojtas <mw@semihalf.com>
---
 Platform/SolidRun/Cn913xCEx7Eval/Readme.md | 98 ++++++++++++++++++++
 1 file changed, 98 insertions(+)
 create mode 100644 Platform/SolidRun/Cn913xCEx7Eval/Readme.md

diff --git a/Platform/SolidRun/Cn913xCEx7Eval/Readme.md b/Platform/SolidRun/Cn913xCEx7Eval/Readme.md
new file mode 100644
index 0000000000..813e723b65
--- /dev/null
+++ b/Platform/SolidRun/Cn913xCEx7Eval/Readme.md
@@ -0,0 +1,98 @@
+SolidRun CN913x CEx7 Evaluation Board
+=====================================
+
+# Summary
+
+This is a port of 64-bit TianoCore EDK II firmware for the SolidRun CN913x CEx7 Evaluation Board.
+
+# Building the firmware
+
+## Prepare toolchain (for cross-compilation only):
+
+1. Download the toolchain:
+
+   ```
+   wget https://releases.linaro.org/components/toolchain/binaries/7.5-2019.12/aarch64-linux-gnu/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu.tar.xz
+   ```
+
+1. After extracting, setup the path and compiler prefix to GCC5\_AARCH64\_PREFIX variable:
+
+   ```
+   export GCC5_AARCH64_PREFIX=<toolchain_path>/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-
+   ```
+
+## Prepare prerequisites
+
+1. Create a new folder (directory) on your local development machine
+   for use as your workspace. This example uses `/work/git/tianocore`, modify as
+   appropriate for your needs.
+
+   ```
+   $ export WORKSPACE=/work/git/tianocore
+   $ mkdir -p $WORKSPACE
+   $ cd $WORKSPACE
+   ```
+
+1. Clone the Trusted Firmware repository:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git
+   ```
+1. Clone repository for auxiliary firmware on the SoC co-processors and checkout to binaries-marvell-armada-SDK10.0.1.0:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://github.com/MarvellEmbeddedProcessors/binaries-marvell.git
+   $ cd binaries-marvell/
+   $ git checkout -b binaries-marvell-armada-SDK10.0.1.0 origin/binaries-marvell-armada-SDK10.0.1.0
+   ```
+1. Clone the DDR training code from:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://github.com/MarvellEmbeddedProcessors/mv-ddr-marvell.git
+   ```
+## Prepare EDKII environment:
+
+Please follow instructions from "Obtaining source code" and "Manual building" from the top level edk2-platforms [Readme.md](https://github.com/tianocore/edk2-platforms#readme).
+
+## Build EDKII:
+
+1. Use below build command:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ build -a AARCH64 -t GCC5 -b RELEASE -D INCLUDE_TFTP_COMMAND -D CAPSULE_ENABLE -D X64EMU_ENABLE -p Platform/SolidRun/Cn913xCEx7Eval/Cn913xCEx7Eval.dsc
+   ```
+
+## Build the final firmware image:
+
+1. Set BL33 variable to path to EDK II output binary:
+
+   ```
+   $ export BL33=${WORKSPACE}/Build/Cn913xCEx7Eval-AARCH64/RELEASE_GCC5/FV/ARMADA_EFI.fd
+   ```
+1. Export SCP_BL2 variable:
+
+   ```
+   $ export SCP_BL2=${WORKSKPACE}/binaries-marvell/mrvl_scp_bl2.img
+   ```
+1. Export compiler variables (for cross-compilation only):
+
+   ```
+   $ export ARCH=arm64
+   $ export CROSS_COMPILE=<toolchain_path>/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-
+   ```
+1. Build the image:
+
+   ```
+   $ cd ${WORKSPACE}/trusted-firmware-a/
+   $ make LOG_LEVEL=20 MV_DDR_PATH=${WORKSPACE}/mv-ddr-marvell CP_NUM=3 PLAT=t9130_cex7_eval all fip mrvl_flash
+
+   ```
+The firmware image `flash-image.bin` can be found in `build/t9130_cex7_eval/release/` directory.
+
+# ARM System Ready certification.
+
+CN913x CEx7 Evaluation Board is [System Ready ES](https://developer.arm.com/architectures/system-architectures/arm-systemready/es) certified. Release binary and the firmware components' baselines list are available in a dedicated [wiki page](https://github.com/semihalf/edk2-platforms/wiki).
-- 
2.29.0

[edk2-platforms PATCH 2/4] SolidRun/Armada80x0McBin: Add Readme.md

[Marcin Wojtas]

From: Grzegorz Bernacki <gjb@semihalf.com>

Add the complete build instruction for MacchiatoBin platform.

Signed-off-by: Marcin Wojtas <mw@semihalf.com>
---
 Platform/SolidRun/Armada80x0McBin/Readme.md | 97 ++++++++++++++++++++
 1 file changed, 97 insertions(+)
 create mode 100644 Platform/SolidRun/Armada80x0McBin/Readme.md

diff --git a/Platform/SolidRun/Armada80x0McBin/Readme.md b/Platform/SolidRun/Armada80x0McBin/Readme.md
new file mode 100644
index 0000000000..c63cf41b2d
--- /dev/null
+++ b/Platform/SolidRun/Armada80x0McBin/Readme.md
@@ -0,0 +1,97 @@
+SolidRun MacchiatoBin
+=====================
+
+# Summary
+
+This is a port of 64-bit TianoCore EDK II firmware for the SolidRun MacchiatoBin platform based on the Marvell ARMADA 8040 SoC.
+
+# Building the firmware
+
+## Prepare toolchain (for cross-compilation only):
+
+1. Download the toolchain:
+
+   ```
+   wget https://releases.linaro.org/components/toolchain/binaries/7.5-2019.12/aarch64-linux-gnu/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu.tar.xz
+   ```
+
+1. After extracting, setup the path and compiler prefix to GCC5\_AARCH64\_PREFIX variable:
+
+   ```
+   export GCC5_AARCH64_PREFIX=<toolchain_path>/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-
+   ```
+
+## Prepare prerequisites
+
+1. Create a new folder (directory) on your local development machine
+   for use as your workspace. This example uses `/work/git/tianocore`, modify as
+   appropriate for your needs.
+
+   ```
+   $ export WORKSPACE=/work/git/tianocore
+   $ mkdir -p $WORKSPACE
+   $ cd $WORKSPACE
+   ```
+
+1. Clone the Trusted Firmware repository:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git
+   ```
+1. Clone repository for auxiliary firmware on the SoC co-processors and checkout to binaries-marvell-armada-SDK10.0.1.0:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://github.com/MarvellEmbeddedProcessors/binaries-marvell.git
+   $ cd binaries-marvell/
+   $ git checkout -b binaries-marvell-armada-SDK10.0.1.0 origin/binaries-marvell-armada-SDK10.0.1.0
+   ```
+1. Clone the DDR training code from:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://github.com/MarvellEmbeddedProcessors/mv-ddr-marvell.git
+   ```
+## Prepare EDKII environment:
+
+Please follow instructions from "Obtaining source code" and "Manual building" from the top level edk2-platforms [Readme.md](https://github.com/tianocore/edk2-platforms#readme).
+
+## Build EDKII:
+
+1. Use below build command:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ build -a AARCH64 -t GCC5 -b RELEASE -D INCLUDE_TFTP_COMMAND -D X64EMU_ENABLE -p Platform/SolidRun/Armada80x0McBin/Armada80x0McBin.dsc
+   ```
+
+## Build the final firmware image:
+
+1. Set BL33 variable to path to EDK II output binary:
+
+   ```
+   $ export BL33=${WORKSPACE}/Build/Armada80x0McBin-AARCH64/RELEASE_GCC5/FV/ARMADA_EFI.fd
+   ```
+1. Export SCP_BL2 variable:
+
+   ```
+   $ export SCP_BL2=${WORKSKPACE}/binaries-marvell/mrvl_scp_bl2.img
+   ```
+1. Export compiler variables (for cross-compilation only):
+
+   ```
+   $ export ARCH=arm64
+   $ export CROSS_COMPILE=<toolchain_path>/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-
+   ```
+1. Build the image:
+
+   ```
+   $ cd ${WORKSPACE}/trusted-firmware-a/
+   $ make LOG_LEVEL=20 MV_DDR_PATH=${WORKSPACE}/mv-ddr-marvell PLAT=a80x0_mcbin all fip mrvl_flash
+   ```
+The firmware image `flash-image.bin` can be found in `build/a80x0_mcbin/release/` directory.
+
+# ARM System Ready certification.
+
+MacchiatoBin is [System Ready ES](https://developer.arm.com/architectures/system-architectures/arm-systemready/es) certified. Release binary and the firmware components' baselines list are available in a dedicated [wiki page](https://github.com/semihalf/edk2-platforms/wiki).
-- 
2.29.0

[edk2-platforms PATCH 3/4] Marvell/Cn913xDbA: Add Readme.md

[Marcin Wojtas]

Add the complete build instruction for CN913x Development Board.

Signed-off-by: Marcin Wojtas <mw@semihalf.com>
---
 Platform/Marvell/Cn913xDb/Readme.md | 98 ++++++++++++++++++++
 1 file changed, 98 insertions(+)
 create mode 100644 Platform/Marvell/Cn913xDb/Readme.md

diff --git a/Platform/Marvell/Cn913xDb/Readme.md b/Platform/Marvell/Cn913xDb/Readme.md
new file mode 100644
index 0000000000..ecdb78302b
--- /dev/null
+++ b/Platform/Marvell/Cn913xDb/Readme.md
@@ -0,0 +1,98 @@
+Marvell CN913x Development Board
+================================
+
+# Summary
+
+This is a port of 64-bit TianoCore EDK II firmware for the Marvell CN913x Development Board.
+
+# Building the firmware
+
+## Prepare toolchain (for cross-compilation only):
+
+1. Download the toolchain:
+
+   ```
+   wget https://releases.linaro.org/components/toolchain/binaries/7.5-2019.12/aarch64-linux-gnu/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu.tar.xz
+   ```
+
+1. After extracting, setup the path and compiler prefix to GCC5\_AARCH64\_PREFIX variable:
+
+   ```
+   export GCC5_AARCH64_PREFIX=<toolchain_path>/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-
+   ```
+
+## Prepare prerequisites
+
+1. Create a new folder (directory) on your local development machine
+   for use as your workspace. This example uses `/work/git/tianocore`, modify as
+   appropriate for your needs.
+
+   ```
+   $ export WORKSPACE=/work/git/tianocore
+   $ mkdir -p $WORKSPACE
+   $ cd $WORKSPACE
+   ```
+
+1. Clone the Trusted Firmware repository:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git
+   ```
+1. Clone repository for auxiliary firmware on the SoC co-processors and checkout to binaries-marvell-armada-SDK10.0.1.0:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://github.com/MarvellEmbeddedProcessors/binaries-marvell.git
+   $ cd binaries-marvell/
+   $ git checkout -b binaries-marvell-armada-SDK10.0.1.0 origin/binaries-marvell-armada-SDK10.0.1.0
+   ```
+1. Clone the DDR training code from:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ git clone https://github.com/MarvellEmbeddedProcessors/mv-ddr-marvell.git
+   ```
+## Prepare EDKII environment:
+
+Please follow instructions from "Obtaining source code" and "Manual building" from the top level edk2-platforms [Readme.md](https://github.com/tianocore/edk2-platforms#readme).
+
+## Build EDKII:
+
+1. Use below build command:
+
+   ```
+   $ cd ${WORKSPACE}
+   $ build -a AARCH64 -t GCC5 -b RELEASE -D CN9132 -D INCLUDE_TFTP_COMMAND -D CAPSULE_ENABLE -p Platform/Marvell/Cn913xDb/Cn913xDbA.dsc
+   ```
+
+## Build the final firmware image:
+
+1. Set BL33 variable to path to EDK II output binary:
+
+   ```
+   $ export BL33=${WORKSPACE}/Build/Cn9132DbA-AARCH64/RELEASE_GCC5/FV/ARMADA_EFI.fd
+   ```
+1. Export SCP_BL2 variable:
+
+   ```
+   $ export SCP_BL2=${WORKSKPACE}/binaries-marvell/mrvl_scp_bl2.img
+   ```
+1. Export compiler variables (for cross-compilation only):
+
+   ```
+   $ export ARCH=arm64
+   $ export CROSS_COMPILE=<toolchain_path>/gcc-linaro-7.5.0-2019.12-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-
+   ```
+1. Build the image:
+
+   ```
+   $ cd ${WORKSPACE}/trusted-firmware-a/
+   $ make LOG_LEVEL=20 MV_DDR_PATH=${WORKSPACE}/mv-ddr-marvell CP_NUM=3 PLAT=t9130 all fip mrvl_flash
+
+   ```
+The firmware image `flash-image.bin` can be found in `build/t9130/release/` directory.
+
+# ARM System Ready certification.
+
+CN913x Development Board is [System Ready ES](https://developer.arm.com/architectures/system-architectures/arm-systemready/es) certified. Release binary and the firmware components' baselines list are available in a dedicated [wiki page](https://github.com/semihalf/edk2-platforms/wiki).
-- 
2.29.0

[edk2-platforms PATCH 4/4] Marvell: Armada7k8k/OcteonTx: Bump firmware to "EDK2 SH 1.1" revision

[Marcin Wojtas]

Update firmware revision after PCI / IcuLib reworks and
adding CN913x CEx7 Evaluation Board support.

Signed-off-by: Marcin Wojtas <mw@semihalf.com>
---
 Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc
index d27e582b54..3b76acd99c 100644
--- a/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc
+++ b/Silicon/Marvell/Armada7k8k/Armada7k8k.dsc.inc
@@ -248,7 +248,7 @@
 !endif
 
 [PcdsFixedAtBuild.common]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareVersionString|L"EDK2 SH 1.0"
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareVersionString|L"EDK2 SH 1.1"
   gArmPlatformTokenSpaceGuid.PcdCoreCount|4
 
   gEfiMdePkgTokenSpaceGuid.PcdMaximumUnicodeStringLength|1000000
@@ -388,7 +388,7 @@
   gEfiMdeModulePkgTokenSpaceGuid.PcdSmbiosDocRev|0x0
   gEfiMdeModulePkgTokenSpaceGuid.PcdSmbiosEntryPointProvideMethod|0x2
   gEfiMdeModulePkgTokenSpaceGuid.PcdSmbiosVersion|0x0302
-  gMarvellTokenSpaceGuid.PcdFirmwareVersion|"EDK2 SH 1.0"
+  gMarvellTokenSpaceGuid.PcdFirmwareVersion|"EDK2 SH 1.1"
 
   # TRNG
   gMarvellTokenSpaceGuid.PcdEip76TrngBaseAddress|0xF2760000
-- 
2.29.0

Re: [edk2-platforms PATCH 0/4] Marvell readmes

[Ard Biesheuvel]

On Tue, 21 Sept 2021 at 13:02, Marcin Wojtas <mw@semihalf.com> wrote:
>
> Hi,
>
> This short patchset adds README files for the platforms
> based on Marvell SoC's, which have already been
> SystemReady ES certified. It also bumps the firmware
> revision after the PCI / IcuLib rework and addition of
> the CN913x CEx7 Evaluation Board support.
>
> The patches are available on a public branch:
> https://github.com/semihalf-wojtas-marcin/edk2-platforms/commits/marvell-howtos-upstream-r20210921
>

Thanks

Pushed as 64394fd2b48f..d1d4dd2c39e7

Re: [edk2-platforms PATCH 0/4] Marvell readmes

[Leif Lindholm]

On Wed, Sep 22, 2021 at 13:24:07 +0200, Ard Biesheuvel wrote:
> On Tue, 21 Sept 2021 at 13:02, Marcin Wojtas <mw@semihalf.com> wrote:
> >
> > Hi,
> >
> > This short patchset adds README files for the platforms
> > based on Marvell SoC's, which have already been
> > SystemReady ES certified. It also bumps the firmware
> > revision after the PCI / IcuLib rework and addition of
> > the CN913x CEx7 Evaluation Board support.
> >
> > The patches are available on a public branch:
> > https://github.com/semihalf-wojtas-marcin/edk2-platforms/commits/marvell-howtos-upstream-r20210921
> >
> 
> Thanks
> 
> Pushed as 64394fd2b48f..d1d4dd2c39e7

Ugh, wish I'd taken the time to respond yesterday.

This is more proliferation of "include all very specific build
steps for a very specific target and build environment" documentation.

I don't see this as an improvement.

Platform docs should document what one needs to know specific to the
platform. If a vendor wishes to provide full recipes, they should host
that on a wiki somewhere.

/
    Leif

Re: [edk2-platforms PATCH 0/4] Marvell readmes

[Ard Biesheuvel]

On Wed, 22 Sept 2021 at 14:14, Leif Lindholm <leif@nuviainc.com> wrote:
>
> On Wed, Sep 22, 2021 at 13:24:07 +0200, Ard Biesheuvel wrote:
> > On Tue, 21 Sept 2021 at 13:02, Marcin Wojtas <mw@semihalf.com> wrote:
> > >
> > > Hi,
> > >
> > > This short patchset adds README files for the platforms
> > > based on Marvell SoC's, which have already been
> > > SystemReady ES certified. It also bumps the firmware
> > > revision after the PCI / IcuLib rework and addition of
> > > the CN913x CEx7 Evaluation Board support.
> > >
> > > The patches are available on a public branch:
> > > https://github.com/semihalf-wojtas-marcin/edk2-platforms/commits/marvell-howtos-upstream-r20210921
> > >
> >
> > Thanks
> >
> > Pushed as 64394fd2b48f..d1d4dd2c39e7
>
> Ugh, wish I'd taken the time to respond yesterday.
>
> This is more proliferation of "include all very specific build
> steps for a very specific target and build environment" documentation.
>
> I don't see this as an improvement.
>
> Platform docs should document what one needs to know specific to the
> platform. If a vendor wishes to provide full recipes, they should host
> that on a wiki somewhere.
>

Fair point.

Marcin, when you find the time, could you please do a pass over these
files with Leif's critique in mind?

Re: [edk2-platforms PATCH 0/4] Marvell readmes

[Marcin Wojtas]

Hi Ard, Leif,

śr., 22 wrz 2021 o 14:20 Ard Biesheuvel <ardb@kernel.org> napisał(a):
>
> On Wed, 22 Sept 2021 at 14:14, Leif Lindholm <leif@nuviainc.com> wrote:
> >
> > On Wed, Sep 22, 2021 at 13:24:07 +0200, Ard Biesheuvel wrote:
> > > On Tue, 21 Sept 2021 at 13:02, Marcin Wojtas <mw@semihalf.com> wrote:
> > > >
> > > > Hi,
> > > >
> > > > This short patchset adds README files for the platforms
> > > > based on Marvell SoC's, which have already been
> > > > SystemReady ES certified. It also bumps the firmware
> > > > revision after the PCI / IcuLib rework and addition of
> > > > the CN913x CEx7 Evaluation Board support.
> > > >
> > > > The patches are available on a public branch:
> > > > https://github.com/semihalf-wojtas-marcin/edk2-platforms/commits/marvell-howtos-upstream-r20210921
> > > >
> > >
> > > Thanks
> > >
> > > Pushed as 64394fd2b48f..d1d4dd2c39e7
> >
> > Ugh, wish I'd taken the time to respond yesterday.
> >
> > This is more proliferation of "include all very specific build
> > steps for a very specific target and build environment" documentation.
> >
> > I don't see this as an improvement.
> >
> > Platform docs should document what one needs to know specific to the
> > platform. If a vendor wishes to provide full recipes, they should host
> > that on a wiki somewhere.
> >
>
> Fair point.
>
> Marcin, when you find the time, could you please do a pass over these
> files with Leif's critique in mind?


For all 3 platforms, how about the following update:
- extend the "Summary" section with supported features or interfaces
(or add an extra heading for that).
- "Build" section -> add link to external wiki/.md file
- "ARM System Ready certification." - leave intact

Please let me know if that will work for you.

Best regards1,
Marcin

Re: [edk2-platforms PATCH 0/4] Marvell readmes

[Leif Lindholm]

On Wed, Sep 22, 2021 at 14:20:31 +0200, Ard Biesheuvel wrote:
> On Wed, 22 Sept 2021 at 14:14, Leif Lindholm <leif@nuviainc.com> wrote:
> >
> > On Wed, Sep 22, 2021 at 13:24:07 +0200, Ard Biesheuvel wrote:
> > > On Tue, 21 Sept 2021 at 13:02, Marcin Wojtas <mw@semihalf.com> wrote:
> > > >
> > > > Hi,
> > > >
> > > > This short patchset adds README files for the platforms
> > > > based on Marvell SoC's, which have already been
> > > > SystemReady ES certified. It also bumps the firmware
> > > > revision after the PCI / IcuLib rework and addition of
> > > > the CN913x CEx7 Evaluation Board support.
> > > >
> > > > The patches are available on a public branch:
> > > > https://github.com/semihalf-wojtas-marcin/edk2-platforms/commits/marvell-howtos-upstream-r20210921
> > > >
> > >
> > > Thanks
> > >
> > > Pushed as 64394fd2b48f..d1d4dd2c39e7
> >
> > Ugh, wish I'd taken the time to respond yesterday.
> >
> > This is more proliferation of "include all very specific build
> > steps for a very specific target and build environment" documentation.
> >
> > I don't see this as an improvement.
> >
> > Platform docs should document what one needs to know specific to the
> > platform. If a vendor wishes to provide full recipes, they should host
> > that on a wiki somewhere.
> >
> 
> Fair point.
> 
> Marcin, when you find the time, could you please do a pass over these
> files with Leif's critique in mind?

Some suggestions/requests:

The top-level Readme.md should contain all relevant build system and
cross compilation information, so please refer to that instead of
duplicating information. If it is missing some generically useful
information, please add it.
(That file, for example, points out the appropriate location to get
arm cross-toolchains from if your distro doesn't provide them, and
Linaro stopped working on GCC years ago.)

Please *do* document the repositories required to build (and hence
need to specify in PACKAGES_PATH). The example build command line for
CN913x CEx7 requires edk2-non-osi.

Please don't document the inclusion of the Shell TFTP command by
default. Mention it as an option if you must.

Document the builds in chronological order, don't interleave TF-A and
EDK2 instructions. Ideally, cut TF-A instructions down to a bare
minimum (e.g. "pass the generated EDK2 image to the TF-A build with
`$ export BL33=...`) and link to aforementioned wiki page for the full
recipe.

Best Regards,

Leif

Re: [edk2-platforms PATCH 0/4] Marvell readmes

[Leif Lindholm]

Hi Marcin,

On Wed, Sep 22, 2021 at 14:46:10 +0200, Marcin Wojtas wrote:
> > Marcin, when you find the time, could you please do a pass over these
> > files with Leif's critique in mind?
> 
> 
> For all 3 platforms, how about the following update:
> - extend the "Summary" section with supported features or interfaces
> (or add an extra heading for that).
> - "Build" section -> add link to external wiki/.md file

To be clear - I don't mind the actual example build command line, and
maybe listing the expected/available command line options (-D).

> - "ARM System Ready certification." - leave intact
> 
> Please let me know if that will work for you.

Sure, sounds good.

Best Regards,

Leif