2 # Firmware Management Protocol Device Package
4 # This package provides an implementation of a Firmware Management Protocol
5 # instance that supports the update of firmware storage devices using UEFI
6 # Capsules. The behavior of the Firmware Management Protocol instance is
7 # customized using libraries and PCDs.
9 # Copyright (c) Microsoft Corporation.<BR>
10 # Copyright (c) 2018 - 2020, Intel Corporation. All rights reserved.<BR>
11 # Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
13 # SPDX-License-Identifier: BSD-2-Clause-Patent
18 PLATFORM_NAME = FmpDevicePkg
19 PLATFORM_GUID = 0af3d540-27c6-11e8-828b-f8597177a00a
20 PLATFORM_VERSION = 0.1
21 DSC_SPECIFICATION = 0x00010005
22 OUTPUT_DIRECTORY = Build/FmpDevicePkg
23 SUPPORTED_ARCHITECTURES = IA32|X64|ARM|AARCH64|RISCV64
24 BUILD_TARGETS = DEBUG|RELEASE|NOOPT
25 SKUID_IDENTIFIER = DEFAULT
28 # Define ESRT GUIDs for Firmware Management Protocol instances
30 DEFINE SYSTEM_FMP_ESRT_GUID = B461B3BD-E62A-4A71-841C-50BA4E500267
31 DEFINE DEVICE_FMP_ESRT_GUID = 226034C4-8B67-4536-8653-D6EE7CE5A316
34 # TRUE - Build FmpDxe module for with storage access enabled
35 # FALSE - Build FmpDxe module for with storage access disabled
37 DEFINE DEVICE_FMP_STORAGE_ACCESS_ENABLE = TRUE
39 !include UnitTestFrameworkPkg/UnitTestFrameworkPkgTarget.dsc.inc
42 UefiDriverEntryPoint|MdePkg/Library/UefiDriverEntryPoint/UefiDriverEntryPoint.inf
43 UefiBootServicesTableLib|MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.inf
44 UefiLib|MdePkg/Library/UefiLib/UefiLib.inf
45 UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf
46 MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf
47 DevicePathLib|MdePkg/Library/UefiDevicePathLib/UefiDevicePathLib.inf
48 BaseLib|MdePkg/Library/BaseLib/BaseLib.inf
49 BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf
50 PrintLib|MdePkg/Library/BasePrintLib/BasePrintLib.inf
51 DebugLib|MdePkg/Library/UefiDebugLibStdErr/UefiDebugLibStdErr.inf
52 DebugPrintErrorLevelLib|MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.inf
53 PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf
54 !ifdef CONTINUOUS_INTEGRATION
55 BaseCryptLib|CryptoPkg/Library/BaseCryptLibNull/BaseCryptLibNull.inf
57 IntrinsicLib|CryptoPkg/Library/IntrinsicLib/IntrinsicLib.inf
58 OpensslLib|CryptoPkg/Library/OpensslLib/OpensslLib.inf
59 BaseCryptLib|CryptoPkg/Library/BaseCryptLib/BaseCryptLib.inf
60 RngLib|MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf
62 FmpAuthenticationLib|SecurityPkg/Library/FmpAuthenticationLibPkcs7/FmpAuthenticationLibPkcs7.inf
63 CapsuleUpdatePolicyLib|FmpDevicePkg/Library/CapsuleUpdatePolicyLibNull/CapsuleUpdatePolicyLibNull.inf
64 FmpPayloadHeaderLib|FmpDevicePkg/Library/FmpPayloadHeaderLibV1/FmpPayloadHeaderLibV1.inf
65 FmpDeviceLib|FmpDevicePkg/Library/FmpDeviceLibNull/FmpDeviceLibNull.inf
66 FmpDependencyLib|FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.inf
67 FmpDependencyCheckLib|FmpDevicePkg/Library/FmpDependencyCheckLibNull/FmpDependencyCheckLibNull.inf
68 FmpDependencyDeviceLib|FmpDevicePkg/Library/FmpDependencyDeviceLibNull/FmpDependencyDeviceLibNull.inf
69 TimerLib|MdePkg/Library/BaseTimerLibNullTemplate/BaseTimerLibNullTemplate.inf
71 [LibraryClasses.ARM, LibraryClasses.AARCH64]
73 # It is not possible to prevent the ARM compiler for generic intrinsic functions.
74 # This library provides the intrinsic functions generate by a given compiler.
75 # [LibraryClasses.ARM, LibraryClasses.AARCH64] and NULL mean link this library
76 # into all ARM and AARCH64 images.
78 NULL|ArmPkg/Library/CompilerIntrinsicsLib/CompilerIntrinsicsLib.inf
80 # Add support for stack protector
81 NULL|MdePkg/Library/BaseStackCheckLib/BaseStackCheckLib.inf
84 ArmSoftFloatLib|ArmPkg/Library/ArmSoftFloatLib/ArmSoftFloatLib.inf
86 [PcdsPatchableInModule]
87 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageTypeIdGuid|{0}
93 FmpDevicePkg/Library/CapsuleUpdatePolicyLibNull/CapsuleUpdatePolicyLibNull.inf
94 FmpDevicePkg/Library/CapsuleUpdatePolicyLibOnProtocol/CapsuleUpdatePolicyLibOnProtocol.inf
95 FmpDevicePkg/Library/FmpPayloadHeaderLibV1/FmpPayloadHeaderLibV1.inf
96 FmpDevicePkg/Library/FmpDeviceLibNull/FmpDeviceLibNull.inf
97 FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.inf
98 FmpDevicePkg/Library/FmpDependencyCheckLib/FmpDependencyCheckLib.inf
99 FmpDevicePkg/Library/FmpDependencyCheckLibNull/FmpDependencyCheckLibNull.inf
100 FmpDevicePkg/Library/FmpDependencyDeviceLibNull/FmpDependencyDeviceLibNull.inf
101 FmpDevicePkg/FmpDxe/FmpDxeLib.inf
106 FmpDevicePkg/CapsuleUpdatePolicyDxe/CapsuleUpdatePolicyDxe.inf {
108 CapsuleUpdatePolicyLib|FmpDevicePkg/Library/CapsuleUpdatePolicyLibNull/CapsuleUpdatePolicyLibNull.inf
110 FmpDevicePkg/FmpDxe/FmpDxe.inf {
113 # FILE_GUID is used as ESRT GUID
115 FILE_GUID = $(SYSTEM_FMP_ESRT_GUID)
118 # Unicode name string that is used to populate FMP Image Descriptor for this capsule update module
120 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageIdName|L"Sample Firmware Device"
122 # Certificates used to authenticate capsule update image
124 !include BaseTools/Source/Python/Pkcs7Sign/TestRoot.cer.gFmpDevicePkgTokenSpaceGuid.PcdFmpDevicePkcs7CertBufferXdr.inc
125 <PcdsPatchableInModule>
126 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageTypeIdGuid|{GUID("$(SYSTEM_FMP_ESRT_GUID)")}
129 # Use CapsuleUpdatePolicyLib that calls the Capsule Update Policy Protocol.
130 # Depends on the CapsuleUpdatePolicyDxe module to produce the protocol.
131 # Required for FmpDxe modules that are intended to be platform independent.
133 CapsuleUpdatePolicyLib|FmpDevicePkg/Library/CapsuleUpdatePolicyLibOnProtocol/CapsuleUpdatePolicyLibOnProtocol.inf
136 FmpDevicePkg/FmpDxe/FmpDxe.inf {
139 # FILE_GUID is used as ESRT GUID
141 FILE_GUID = $(DEVICE_FMP_ESRT_GUID)
143 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceStorageAccessEnable|$(DEVICE_FMP_STORAGE_ACCESS_ENABLE)
145 !if $(DEVICE_FMP_STORAGE_ACCESS_ENABLE) == FALSE
147 # Disable test key detection
149 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceTestKeySha256Digest|{0}
152 # Unicode name string that is used to populate FMP Image Descriptor for this capsule update module
154 !if $(DEVICE_FMP_STORAGE_ACCESS_ENABLE) == TRUE
155 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageIdName|L"Sample Firmware Device"
157 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageIdName|L"Sample Firmware Device No Storage Access"
160 # Certificates used to authenticate capsule update image
162 !include BaseTools/Source/Python/Pkcs7Sign/TestRoot.cer.gFmpDevicePkgTokenSpaceGuid.PcdFmpDevicePkcs7CertBufferXdr.inc
163 <PcdsPatchableInModule>
164 gFmpDevicePkgTokenSpaceGuid.PcdFmpDeviceImageTypeIdGuid|{GUID("$(DEVICE_FMP_ESRT_GUID)")}
167 # Directly use a platform specific CapsuleUpdatePolicyLib instance.
168 # Only works for FmpDxe modules that are build from sources and included
169 # in a system firmware image.
171 CapsuleUpdatePolicyLib|FmpDevicePkg/Library/CapsuleUpdatePolicyLibNull/CapsuleUpdatePolicyLibNull.inf
175 # Add UEFI Target Based Unit Tests
177 FmpDevicePkg/Test/UnitTest/Library/FmpDependencyLib/FmpDependencyLibUnitTestsUefi.inf
180 *_*_*_CC_FLAGS = -D DISABLE_NEW_DEPRECATED_INTERFACES