[PATCH v2 0/6] efi: capsule: Image GUID usage cleanup

[Sughosh Ganu]

This series is cleaning up the usage of the image GUIDs that are used
in capsule update and the EFI System Resource Table(ESRT).

Currently, there are two instances of the Firmware Management
Protocol(FMP), one defined for updating the FIT images, and the other
for updating raw images. The FMP code defines two GUID values, one for
all FIT images, and one for raw images. Depending on the FMP instance
used on a platform, the platform needs to use the corresponding image
GUID value for all images on the platform, and also across platforms.

A few issues are being fixed through the patch series. One, that an
image for a different platform can be flashed on another platform if
both the platforms are using the same FMP instance. So, for e.g. a
capsule generated for the Socionext DeveloperBox platform can be
flashed on the ZynqMP platform, since both the platforms use the
CONFIG_EFI_CAPSULE_FIRMWARE_RAW instance of the FMP. This can be
corrected if each firmware image that can be updated through the
capsule update mechanism has it's own unique image GUID.

The second issue that this patch series fixes is the value of FwClass
in the ESRT. With the current logic, all firmware image entries in the
ESRT display the same GUID value -- either the FIT GUID or the raw
GUID. This is not in compliance with the UEFI specification, as the
specification requires all entries to have unique GUID values.

The third issue being fixed is the population of the
EFI_FIRMWARE_IMAGE_DESCRIPTOR array. The current code uses the dfu
framework for populating the image descriptor array. However, there
might be other images that are not to be updated through the capsule
update mechanism also registered with the dfu framework. As a result
of this, the ESRT will show up entries of images that are not to be
targeted by the capsule update mechanism.

These issues are being fixed by defining a structure, efi_fw_images. A
platform can then define image related information like the image GUID
and image name. Every platform that uses capsule update mechanism
needs to define fw_images array. This array will then be used to
populate the image descriptor array, and also in determining if a
particular capsule's payload can be used for updating an image on the
platform.


Changes since V1:
* Make changes for the xilinx boards as suggested by Michal Simek.
* Add a GUID for the sandbox FIT image.
* Split the capsule update test cases into two scripts, one for raw
  images and one for FIT images.
* Add the capsule update test case for FIT images on sandbox64 and
  sandbox_flattree variants.
* Add capsule update support on sandbox_flattree variant for enabling
  FIT capsule update testing as part of the python tests
 

The first patch of this series adds the fw_images array in all
platforms which are using UEFI capsule updates

The second patch of the series changes the logic for populating the
image descriptor array, using the information from the fw_images array
defined by the platform.

The third patch of the series removes the test cases using the --raw
and --fit parameters, removes test case for FIT images, and refactors
the test scripts, one for raw images, and one for FIT images. The FIT
test case is enabled on sandbox_flattree variant.

The fourth patch of the series makes corresponding changes in the
capsule update related documentation.

The fifth patch of the series removes the now unused FIT and raw image
GUID values from the FMP module.

The sixth patch of the series removes the --raw and --fit command line
parameters in the mkeficapsule utility.


Sughosh Ganu (6):
  capsule: Add Image GUIDs for platforms using capsule updates
  capsule: FMP: Populate the image descriptor array from platform data
  test: capsule: Modify the capsule tests to use GUID values for sandbox
  doc: uefi: Update the capsule update related documentation
  FMP: Remove GUIDs for FIT and raw images
  mkeficapsule: Remove raw and FIT GUID types

 .../imx8mp_rsb3720a1/imx8mp_rsb3720a1.c       |  19 ++
 .../imx8mm-cl-iot-gate/imx8mm-cl-iot-gate.c   |  18 ++
 board/emulation/qemu-arm/qemu-arm.c           |  20 ++
 board/kontron/pitx_imx8m/pitx_imx8m.c         |  15 +-
 board/kontron/sl-mx8mm/sl-mx8mm.c             |  14 ++
 board/kontron/sl28/sl28.c                     |  14 ++
 board/sandbox/sandbox.c                       |  25 +++
 board/socionext/developerbox/developerbox.c   |  23 +++
 board/xilinx/common/board.c                   |  18 ++
 configs/sandbox64_defconfig                   |   1 -
 configs/sandbox_defconfig                     |   1 -
 configs/sandbox_flattree_defconfig            |   5 +
 doc/develop/uefi/uefi.rst                     |  10 +-
 include/configs/imx8mm-cl-iot-gate.h          |  10 +
 include/configs/imx8mp_rsb3720.h              |  10 +
 include/configs/kontron-sl-mx8mm.h            |   6 +
 include/configs/kontron_pitx_imx8m.h          |   6 +
 include/configs/kontron_sl28.h                |   6 +
 include/configs/qemu-arm.h                    |  10 +
 include/configs/sandbox.h                     |  14 ++
 include/configs/synquacer.h                   |  14 ++
 include/configs/xilinx_versal.h               |  10 +
 include/configs/xilinx_zynqmp.h               |  10 +
 include/configs/zynq-common.h                 |  10 +
 include/efi_api.h                             |   8 -
 include/efi_loader.h                          |  18 ++
 lib/efi_loader/efi_firmware.c                 |  95 +++------
 test/py/tests/test_efi_capsule/conftest.py    |  21 +-
 .../test_capsule_firmware_fit.py              | 186 ++++++++++++++++++
 ...rmware.py => test_capsule_firmware_raw.py} | 169 ++++++----------
 tools/eficapsule.h                            |   8 -
 tools/mkeficapsule.c                          |  26 +--
 32 files changed, 589 insertions(+), 231 deletions(-)
 create mode 100644 test/py/tests/test_efi_capsule/test_capsule_firmware_fit.py
 rename test/py/tests/test_efi_capsule/{test_capsule_firmware.py => test_capsule_firmware_raw.py} (76%)

-- 
2.25.1