If the board layout is different, we can use different FileGuid in the
config.ini file.
The format is defined in
SignedCapsulePkg\Universal\SystemFirmwareUpdate\ParseConfigProfile.c
[Head]
NumOfUpdate = <Num> # Decimal
Update0 = <Name1> # String
Update1 = <Name2> # String
Update<Num-1> = <NameX> # String
[Name?]
FirmwareType = 0 # 0 - SystemFirmware, 1 - NvRam
AddressType = 0 # 0 - relative address, 1 - absolute address.
BaseAddress = <BaseAddress> # Base address offset on flash (HEX)
Length = <Length> # Image Length (HEX)
ImageOffset = <ImageOffset> # Image offset of this SystemFirmware image
(HEX)
FileGuid = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX #
PcdEdkiiSystemFirmwareFileGuid
So the OEM can use below:
[Head]
NumOfUpdate = 2 # Decimal
Update0 = ROM1 # String
Update1 = ROM2 # String
[ROM1]
FirmwareType = 0 # 0 - SystemFirmware, 1 - NvRam
AddressType = 0 # 0 - relative address, 1 - absolute address.
BaseAddress = <BaseAddress> # Base address offset on flash (HEX)
Length = <Length> # Image Length (HEX)
ImageOffset = <ImageOffset> # Image offset of this SystemFirmware image
(HEX)
FileGuid = SystemFirmwareFileGuid1 # PcdEdkiiSystemFirmwareFileGuid
[ROM2]
FirmwareType = 0 # 0 - SystemFirmware, 1 - NvRam
AddressType = 0 # 0 - relative address, 1 - absolute address.
BaseAddress = <BaseAddress> # Base address offset on flash (HEX)
Length = <Length> # Image Length (HEX)
ImageOffset = <ImageOffset> # Image offset of this SystemFirmware image
(HEX)
FileGuid = SystemFirmwareFileGuid2 # PcdEdkiiSystemFirmwareFileGuid
Then it will be filtered by UpdateImage().
if (IsZeroGuid(&UpdateConfigData->ImageTypeId) ||
CompareGuid(&UpdateConfigData->ImageTypeId, &mCurrentImageTypeId)) {
Status = PerformUpdate (
SystemFirmwareImage,
SystemFirmwareImageSize,
UpdateConfigData,
LastAttemptVersion,
LastAttemptStatus
);
From: Yao, Jiewen
Sent: Wednesday, November 2, 2016 3:02 PM
To: Kinney, Michael D <michael.d.kin...@intel.com>; edk2-devel@lists.01.org
Cc: Tian, Feng <feng.t...@intel.com>; Zeng, Star <star.z...@intel.com>; Gao,
Liming <liming....@intel.com>; Zhang, Chao B <chao.b.zh...@intel.com>
Subject: RE: [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule
related definition.
Yes. You are right.
From: Kinney, Michael D
Sent: Wednesday, November 2, 2016 2:17 PM
To: Yao, Jiewen <jiewen....@intel.com<mailto:jiewen....@intel.com>>;
edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>; Kinney, Michael D
<michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>
Cc: Tian, Feng <feng.t...@intel.com<mailto:feng.t...@intel.com>>; Zeng, Star
<star.z...@intel.com<mailto:star.z...@intel.com>>; Gao, Liming
<liming....@intel.com<mailto:liming....@intel.com>>; Zhang, Chao B
<chao.b.zh...@intel.com<mailto:chao.b.zh...@intel.com>>
Subject: RE: [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule
related definition.
Jiewen,
I did think about your use case some more. It does require that multiple
boards uses the exact same nvstorage layout using the same INI file and same
System Firmware Update driver. If the boards have different nvstorage layout
or require different PlatformFlashAccessLib instances to update nvstorage than
each board would require its own capsule.
Mike
From: Kinney, Michael D
Sent: Tuesday, November 1, 2016 8:41 PM
To: Yao, Jiewen <jiewen....@intel.com<mailto:jiewen....@intel.com>>;
edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>; Kinney, Michael D
<michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>
Cc: Tian, Feng <feng.t...@intel.com<mailto:feng.t...@intel.com>>; Zeng, Star
<star.z...@intel.com<mailto:star.z...@intel.com>>; Gao, Liming
<liming....@intel.com<mailto:liming....@intel.com>>; Zhang, Chao B
<chao.b.zh...@intel.com<mailto:chao.b.zh...@intel.com>>
Subject: RE: [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule
related definition.
Jiewen,
Thanks for providing the detailed use case. That makes a lot of sense. I
agree we should keep current design with a PCD that is one FFS file GUID.
Thanks,
Mike
From: Yao, Jiewen
Sent: Tuesday, November 1, 2016 7:04 PM
To: Kinney, Michael D
<michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>;
edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
Cc: Tian, Feng <feng.t...@intel.com<mailto:feng.t...@intel.com>>; Zeng, Star
<star.z...@intel.com<mailto:star.z...@intel.com>>; Gao, Liming
<liming....@intel.com<mailto:liming....@intel.com>>; Zhang, Chao B
<chao.b.zh...@intel.com<mailto:chao.b.zh...@intel.com>>
Subject: RE: [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule
related definition.
Yes, this PCD is a single FFS GUID.
A real example blow:
The Capsule may contain below data:
FILE RAW = SystemFirmwareFileGuid1 { # PcdEdkiiSystemFirmwareFileGuid
$(WORKSPACE)/$(OUTPUT_DIRECTORY)/$(TARGET)_$(TOOL_CHAIN_TAG)/FV/BIOS_BOARD1.ROM
}
FILE RAW = SystemFirmwareFileGuid2 { # PcdEdkiiSystemFirmwareFileGuid
$(WORKSPACE)/$(OUTPUT_DIRECTORY)/$(TARGET)_$(TOOL_CHAIN_TAG)/FV/
BIOS_BOARD2.ROM
}
FILE RAW = ce57b167-b0e4-41e8-a897-5f4feb781d40 { #
gEdkiiSystemFmpCapsuleDriverFvFileGuid
$(WORKSPACE)/$(OUTPUT_DIRECTORY)/$(TARGET)_$(TOOL_CHAIN_TAG)/FV/CAPSULEDISPATCHFV.Fv
## It contains a generic SystemFirmwareUpdate.efi
}
FILE RAW = 812136D3-4D3A-433A-9418-29BB9BF78F6E { #
gEdkiiSystemFmpCapsuleConfigFileGuid
PlatformPkg/Feature/Capsule/SystemFirmwareUpdateConfig/SystemFirmwareUpdateConfig.ini
}
During system boot, if current BIOS is BOARD1.ROM, it sets
PcdEdkiiSystemFirmwareFileGuid to be SystemFirmwareFileGuid1.
if current BIOS is BOARD2.ROM, it sets PcdEdkiiSystemFirmwareFileGuid to be
SystemFirmwareFileGuid2.
The generic SystemFirmwareUpdate.efi can determine which ROM should be used for
current firmware.
The benefit is that the OEM can provide one big capsule contains multiple ROM
images, which can be used for multiple boards.
Thank you
Yao Jiewen
From: Kinney, Michael D
Sent: Wednesday, November 2, 2016 9:10 AM
To: Yao, Jiewen <jiewen....@intel.com<mailto:jiewen....@intel.com>>;
edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>; Kinney, Michael D
<michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>
Cc: Tian, Feng <feng.t...@intel.com<mailto:feng.t...@intel.com>>; Zeng, Star
<star.z...@intel.com<mailto:star.z...@intel.com>>; Gao, Liming
<liming....@intel.com<mailto:liming....@intel.com>>; Zhang, Chao B
<chao.b.zh...@intel.com<mailto:chao.b.zh...@intel.com>>
Subject: RE: [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule
related definition.
Jiewen,
The description of this PCD says it is a single FFS file GUID.
How would multiple FFS files with data contents be supported with the INI file
format used in these FMP patch series?
Mike
From: Yao, Jiewen
Sent: Tuesday, November 1, 2016 5:46 PM
To: Kinney, Michael D
<michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>;
edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
Cc: Tian, Feng <feng.t...@intel.com<mailto:feng.t...@intel.com>>; Zeng, Star
<star.z...@intel.com<mailto:star.z...@intel.com>>; Gao, Liming
<liming....@intel.com<mailto:liming....@intel.com>>; Zhang, Chao B
<chao.b.zh...@intel.com<mailto:chao.b.zh...@intel.com>>
Subject: RE: [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule
related definition.
1) That is a good question.
We designed to use PCD instead of fixed GUID purposely.
There is requirement that the value should be determined at runtime, because
different board may use different system firmware file name value and the
capsule may contain multiple system BIOS firmware images.
2) I am OK to make default value to be {0x0}
Thank you
Yao Jiewen
From: Kinney, Michael D
Sent: Wednesday, November 2, 2016 5:57 AM
To: Yao, Jiewen <jiewen....@intel.com<mailto:jiewen....@intel.com>>;
edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>; Kinney, Michael D
<michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>
Cc: Tian, Feng <feng.t...@intel.com<mailto:feng.t...@intel.com>>; Zeng, Star
<star.z...@intel.com<mailto:star.z...@intel.com>>; Gao, Liming
<liming....@intel.com<mailto:liming....@intel.com>>; Zhang, Chao B
<chao.b.zh...@intel.com<mailto:chao.b.zh...@intel.com>>
Subject: RE: [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule
related definition.
Jiewen,
Why is PcdEdkiiSystemFirmwareFileGuid a PCD instead of a GUID like
gEdkiiSystemFmpCapsuleDriverFvFileGuid and
gEdkiiSystemFmpCapsuleConfigFileGuid?
The PcdEdkiiSystemFirmwareFileGuid value from the DEC file default is
used for both Quark and Vlv2 platforms, so it does not appear to be a
value you expect a platform developer to make unique per platform.
It makes sense to use a fixed value, so the system firmware update
Processing can find the FFS file in the Cargo FV to find the
Binary file described by the INI file with FFS file GUID of
gEdkiiSystemFmpCapsuleConfigFileGuid.
The following is an example of where this PCD and GUIDs are used
In an FDF file to generate a firmware update image and recovery imaghe.
[FV.SystemFirmwareUpdateCargo]
FvAlignment = 16
ERASE_POLARITY = 1
MEMORY_MAPPED = TRUE
STICKY_WRITE = TRUE
LOCK_CAP = TRUE
LOCK_STATUS = TRUE
WRITE_DISABLED_CAP = TRUE
WRITE_ENABLED_CAP = TRUE
WRITE_STATUS = TRUE
WRITE_LOCK_CAP = TRUE
WRITE_LOCK_STATUS = TRUE
READ_DISABLED_CAP = TRUE
READ_ENABLED_CAP = TRUE
READ_STATUS = TRUE
READ_LOCK_CAP = TRUE
READ_LOCK_STATUS = TRUE
FILE RAW = AF9C9EB2-12AD-4D3E-A4D4-96F6C9966215 { #
PcdEdkiiSystemFirmwareFileGuid
$(WORKSPACE)/$(OUTPUT_DIRECTORY)/$(TARGET)_$(TOOL_CHAIN_TAG)/FV/Vlv.ROM
}
FILE RAW = ce57b167-b0e4-41e8-a897-5f4feb781d40 { #
gEdkiiSystemFmpCapsuleDriverFvFileGuid
$(WORKSPACE)/$(OUTPUT_DIRECTORY)/$(TARGET)_$(TOOL_CHAIN_TAG)/FV/CAPSULEDISPATCHFV.Fv
}
FILE RAW = 812136D3-4D3A-433A-9418-29BB9BF78F6E { #
gEdkiiSystemFmpCapsuleConfigFileGuid
Vlv2TbltDevicePkg/Feature/Capsule/SystemFirmwareUpdateConfig/SystemFirmwareUpdateConfig.ini
}
Best regards,
Mike
> -----Original Message-----
> From: Yao, Jiewen
> Sent: Thursday, October 27, 2016 6:42 AM
> To: edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
> Cc: Tian, Feng <feng.t...@intel.com<mailto:feng.t...@intel.com>>; Zeng, Star
> <star.z...@intel.com<mailto:star.z...@intel.com>>; Kinney, Michael
> D <michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>; Gao,
> Liming <liming....@intel.com<mailto:liming....@intel.com>>; Zhang, Chao B
> <chao.b.zh...@intel.com<mailto:chao.b.zh...@intel.com>>
> Subject: [PATCH V5 06/12] SignedCapsulePkg/CapsulePkg.dec: Add capsule related
> definition.
>
> 1) Add capsule related GUID.
> EdkiiSystemFmpCapsule
> 2) Add capsule related library.
> EdkiiSystemCapsuleLib
> IniParsingLib
> PlatformFlashAccessLib
> 3) Add EDKII system capsule related DynamicEx PCD
> PcdEdkiiSystemFirmwareImageDescriptor
> PcdEdkiiSystemFirmwareFileGuid
> NOTE: We use DynamicEx here because the update driver may be in
> the capsule FMP, instead of system firmware.
> The update driver MUST use the PCD info produced system firmware.
> 4) Add Test key file PCD
> These PCDs indicate the GUID of FFS which contains test key file.
>
> Cc: Feng Tian <feng.t...@intel.com<mailto:feng.t...@intel.com>>
> Cc: Star Zeng <star.z...@intel.com<mailto:star.z...@intel.com>>
> Cc: Michael D Kinney
> <michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>
> Cc: Liming Gao <liming....@intel.com<mailto:liming....@intel.com>>
> Cc: Chao Zhang <chao.b.zh...@intel.com<mailto:chao.b.zh...@intel.com>>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Jiewen Yao <jiewen....@intel.com<mailto:jiewen....@intel.com>>
> Reviewed-by: Liming Gao <liming....@intel.com<mailto:liming....@intel.com>>
> ---
> SignedCapsulePkg/SignedCapsulePkg.dec | 76 ++++++++++++++++++++
> 1 file changed, 76 insertions(+)
>
> diff --git a/SignedCapsulePkg/SignedCapsulePkg.dec
> b/SignedCapsulePkg/SignedCapsulePkg.dec
> new file mode 100644
> index 0000000..436d602
> --- /dev/null
> +++ b/SignedCapsulePkg/SignedCapsulePkg.dec
> @@ -0,0 +1,76 @@
> +## @file
> +# This package provides EDKII capsule related support.
> +#
> +# Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
> +# This program and the accompanying materials are licensed and made
> available under
> +# the terms and conditions of the BSD License that accompanies this
> distribution.
> +# The full text of the license may be found at
> +# http://opensource.org/licenses/bsd-license.php.
> +#
> +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
> IMPLIED.
> +#
> +##
> +
> +
> +[Defines]
> + DEC_SPECIFICATION = 0x00010005
> + PACKAGE_NAME = SignedCapsulePkg
> + PACKAGE_GUID = 75AA5D82-7BC4-44A9-82FB-0820EBC79BED
> + PACKAGE_VERSION = 0.1
> +
> +[Includes]
> + Include
> +
> +[LibraryClasses]
> + ## @libraryclass Provides services for EDKII system FMP capsule.
> + #
> + EdkiiSystemCapsuleLib|Include/Library/EdkiiSystemCapsuleLib.h
> +
> + ## @libraryclass Provides services to parse the INI configuration file.
> + #
> + IniParsingLib|Include/Library/IniParsingLib.h
> +
> + ## @libraryclass Provides services to access flash device.
> + #
> + PlatformFlashAccessLib|Include/Library/PlatformFlashAccessLib.h
> +
> +[Guids]
> + gEfiSignedCapsulePkgTokenSpaceGuid = { 0xe1eb612f, 0x1c6c, 0x485d, {
> 0x9d, 0x6,
> 0x65, 0x8, 0x44, 0x88, 0x15, 0x69 }}
> +
> + ## Include/Guid/EdkiiSystemFmpCapsule.h
> + gEdkiiSystemFirmwareImageDescriptorFileGuid = {0x90b2b846, 0xca6d, 0x4d6e,
> {0xa8,
> 0xd3, 0xc1, 0x40, 0xa8, 0xe1, 0x10, 0xac}}
> + gEdkiiSystemFmpCapsuleConfigFileGuid = {0x812136d3, 0x4d3a, 0x433a,
> {0x94,
> 0x18, 0x29, 0xbb, 0x9b, 0xf7, 0x8f, 0x6e}}
> + gEdkiiSystemFmpCapsuleDriverFvFileGuid = {0xce57b167, 0xb0e4, 0x41e8,
> {0xa8,
> 0x97, 0x5f, 0x4f, 0xeb, 0x78, 0x1d, 0x40}}
> +
> +[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
> + ## This is the GUID of the FFS which contains the
> Rsa2048Sha256TestPublicKeyFile as
> a RAW section.
> + # @Prompt GUID of the FFS which contains the
> Rsa2048Sha256TestPublicKeyFile.
> +
> gEfiSignedCapsulePkgTokenSpaceGuid.PcdEdkiiRsa2048Sha256TestPublicKeyFileGuid|{0x04,
> 0xe1, 0xfe, 0xc4, 0x57, 0x66, 0x36, 0x49, 0xa6, 0x11, 0x13, 0x8d, 0xbc, 0x2a,
> 0x76,
> 0xad}|VOID*|0xA0010001
> +
> + ## This is the GUID of the FFS which contains the Pkcs7TestPublicKeyFile
> as a RAW
> section.
> + # @Prompt GUID of the FFS which contains the Pkcs7TestPublicKeyFile.
> +
> gEfiSignedCapsulePkgTokenSpaceGuid.PcdEdkiiPkcs7TestPublicKeyFileGuid|{0xba,
> 0xf5,
> 0x93, 0xf0, 0x37, 0x6f, 0x16, 0x48, 0x9e, 0x52, 0x91, 0xbe, 0xa0, 0xf7, 0xe0,
> 0xb8}|VOID*|0xA0010002
> +
> +[PcdsDynamicEx]
> + ## This dynamic PCD holds the EDKII system firmware image descriptor.
> + # This information can be used for version check in EDKII system FMP
> capsule.
> + # Only if the new EdkiiSystemFrimwareImageDescriptor.Version is not less
> than
> + # the current
> PcdEdkiiSystemFirmwareImageDescriptor.LowestSupportedVersion,
> + # the EDKII system FmpCapsule will be processed.
> + # The data structure of this PCD is
> EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR,
> + # SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h.
> + # It must be in [PcdsDynamicEx], because the EDKII system firmware update
> module
> may
> + # consume the PCD produced in current system firmware.
> + # @Prompt EDKII system firmware image descriptor.
> +
> gEfiSignedCapsulePkgTokenSpaceGuid.PcdEdkiiSystemFirmwareImageDescriptor|{0x0}|VOID*|0x
> 00000037
> +
> + ## This dynamic PCD hold the GUID of a firmware FFS which includes EDKII
> + # system firmware image.
> + # An EDKII system firmware udpate module need consume this PCD to extract
> + # the EDKII system firmware from the capsule image.
> + # It must be in [PcdsDynamicEx], because the EDKII system firmware update
> module
> may
> + # consume the PCD produced in current system firmware image.
> + # @Prompt EDKII system firmware image FFS GUID.
> + gEfiSignedCapsulePkgTokenSpaceGuid.PcdEdkiiSystemFirmwareFileGuid|{0xb2,
> 0x9e, 0x9c,
> 0xaf, 0xad, 0x12, 0x3e, 0x4d, 0xa4, 0xd4, 0x96, 0xf6, 0xc9, 0x96, 0x62,
> 0x15}|VOID*|0x00001010
> +
> --
> 2.7.4.windows.1
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
