feat(fwu): document the config flag for including image info in the FWU metadata

The version 2 of the FWU metadata structure is designed such that the
information on the updatable images can be omitted from the metadata
structure. Add a config flag, PSA_FWU_METADATA_FW_STORE_DESC, which is
used to select whether the metadata structure has this information
included or not. It's value is set to 1 by default.

Change-Id: Id6c99455db768edd59b0a316051432a900d30076
Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org>
This commit is contained in:
Sughosh Ganu 2024-02-01 12:42:40 +05:30
parent e106a78ef0
commit 7ae16196cc

View file

@ -1340,6 +1340,15 @@ Firmware update options
This flag is used in defining the firmware update metadata structure. This
flag is by default set to '1'.
- ``PSA_FWU_METADATA_FW_STORE_DESC``: To be enabled when the FWU
metadata contains image description. The default value is 1.
The version 2 of the FWU metadata allows for an opaque metadata
structure where a platform can choose to not include the firmware
store description in the metadata structure. This option indicates
if the firmware store description, which provides information on
the updatable images is part of the structure.
--------------
*Copyright (c) 2019-2024, Arm Limited. All rights reserved.*