[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


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


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


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?


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


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


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