Update to support to produce Component Name and & Component Name 2 protocol based...
[mirror_edk2.git] / MdeModulePkg / ChangeLog.txt
CommitLineData
5182bf8e 1##########################################################################################\r
2!!!!!!!!!!!!!!!!! Notes for this ChangeLog.txt !!!!!!!!!!!!!!!!!\r
3\r
4This log file is used to record two kinds of important information:\r
5 a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info\r
6 will help the package user to merge this package; and some non-compatible changes\r
7 can also be added into release notes as news features when we release this package.\r
8 Normally Non-Compatible Changes contains the following types:\r
9 1) Package's external services were changed/updated\r
10 2) Package's common .h file is renamed, deleted, or the file path is changed.\r
11 3) The definition of package's common data structure is changed\r
12 ...\r
13\r
14 b) "Important Compatible Changes": some important compatible changes can aslo be recorded\r
15 in this file, and we can add these updating into release notes when we release this\r
16 package.\r
17\r
18Non-Compatible and Compatible example format:\r
19==========================================================================================\r
20EDK_0010: Non-Compatible: owner\r
21\r
22 Class_HFile: PPI A of MdePkg has been removed.\r
23\r
24 Code Change :\r
25 1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
26\r
27 Possible Impacts:\r
28 1) All modules that used this PPI A should be updated.\r
29\r
30==========================================================================================\r
31EDK_0000: Compatible: owner\r
32\r
33 Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
34\r
35 Code Change :\r
36 1) BaseTools\Bin\Win32\build.exe\r
37\r
38!!!!!!!!!!!!!!!!!! End of Notes !!!!!!!!!!!!!!!!!!\r
39##########################################################################################\r
40\r
6a9d345a 41==========================================================================================\r
a0ae8996
LG
42EDK_3967: Non-Compatible: lgao4\r
43\r
44 Class_Library: Remove PeCoffLoader library class and its instances.\r
45\r
46 Code Change :\r
47 1) Remove MdeModulePkg/Include/Library/PeCoffLoaderLib.h\r
48 2) Remove MdeModulePkg/Library/DxePeCoffLoaderFromHobLib and PeiDxePeCoffLoaderLib instance\r
49 3) Modify PeiCore, DxeIpl and DxeCore to use PeCoffLib in place of PeCoffLoaderLib.\r
50\r
51 Possible Impacts:\r
52 1) All modules don't use PeCoffloader library class any longer to load PeImage. \r
53 If necessary, they should use PeCoffLib of MdePkg to load PeImage.\r
54\r
55==========================================================================================\r
56EDK_3931: Non-Compatible: klu2\r
6a9d345a 57 \r
d3d32ac0 58 Class_PIEnable[5]: New library class for S3Resume and Recovery for DxeIpl PEIM.\r
6a9d345a 59 \r
60 Code Change:\r
d3d32ac0 61 1) Add new library class \r
62 a) MdeModulePkg/Include/Library/S3Lib.h\r
63 b) MdeModulePkg/Include/Library/RecoveryLib.h\r
64 2) Add NULL library instances for MdeModulePkg:\r
78818e8e 65 a) MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf.\r
66 b) MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf\r
d3d32ac0 67 3) Add framework implement library instances:\r
78818e8e 68 a) IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.inf\r
69 b) IntelFrameworkModulePkg/Library/PeiRecovery/PeiRecovery.inf\r
6a9d345a 70 \r
71 Possible Impacts:\r
78818e8e 72 1) In DSC file, real platform should select:\r
73 S3Lib library class -> IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.inf\r
74 RecoveryLib library class -> IntelFrameworkModulePkg/Library/PeiRecovery/PeiRecovery.inf\r
75 \r
76 Nt32 platform should select:\r
77 S3Lib library class -> MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf.\r
78 RecoveryLib library class -> MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf\r
79 \r
b4f5f5d6 80==========================================================================================\r
81EDK_3922: Non-Compatible: qwang12, klu2\r
82 Class_PIEnable[2]: Update PEI core to only consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI\r
83\r
84 Code Change :\r
85 1) Update PEI core to consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI to get the location of new FVs other than BFV\r
86 reported by PEIMs . \r
87\r
88 Possible Impacts:\r
89 1) Platform code that is going to inform PEI core about the new FVs other than BFV should install \r
90 EFI_PEI_FIRMWARE_VOLUME_INFO_PPI. A library function named PeiPiLibBuildPiFvInfoPpi() defined in \r
91 MdePkg\Include\Library\PeiPiLib.h can be used to install the PPI. \r
92 There are two notes worth mentioning:\r
93 1) Platform PEIMs should report at least FVs containing DXE_CORE and all other PEIM to PEI Core if they\r
94 are not in the BFV. \r
95 2) PEI core will dispatch PEIMs in the FV reported by PeiPiLibBuildPiFvInfoPpi() and invoke BuildFvHob () to build the \r
96 FV HOB for this FV (see Section 4.8.1.2 of Vol 1 named Multiple Firmware Volume Support for details). \r
97 If PEIM only want to inform DXE core about the existance of the new FV, it should call BuildFvHob instead.\r
98 \r
99 \r
100 Class_PIEnable[3]: Update PEI core to support RegisterForShadow feature introduced by PI spec\r
101\r
102 Code Change :\r
103 1) DXEIPL no longer produce EFI_PEI_FV_FILE_LOADER_PPI defined in Framework PEI CIS.\r
104\r
105 Possible Impacts:\r
106\r
107 1)All PEIMs that need to shadow itself into memory and rerun the entry point should be updated to call RegisterForShadow\r
108 (PeiServicesLibRegisterForShadow () is a helper function).\r
109 2)The depex of PEIMs that including EFI_PEI_FV_FILE_LOADER_PPI (or gEfiPeiFvFileLoaderPpiGuid) should be removed.\r
110 \r
111\r
112 Class_PIEnable[4]: Update PEI core to produce other new features defined in PI spec\r
113\r
114 Code Change :\r
115 1) Add the following services: FfsGetFileInfo, FfsFindFileByName and FfsGetVolumeInfo\r
116\r
117 Possible Impacts:\r
118\r
119 1) Platform code is recommended to make use of these new PI features. The functions in MdePkg/Include/Library/PeiServicesLib.h are \r
120 recommended as PeiServices is saved for every PEI Services API invokation.\r
121\r
d3d32ac0 122==========================================================================================\r
123EDK_3871: Non-Compatible: klu2\r
124 \r
125 Class_PIEnable[1]: Use new entry point for PeiCore defined in PI specification.\r
126 \r
127 Code Change:\r
128 1) PeiMain module use PeiCoreEntryPoint library class but *not* original OldPeiCoreEntryPoint.\r
129 2) The memory service in PeiMain module get CAR base and size from parameter of PeiCore's\r
130 Entry point directly but *not* computed from stack's base.\r
131 \r
132 Possible Impacts:\r
133 1) Platform should select MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.inf for \r
134 PeiMain module.\r
135 2) The SecCore module should provide parameters for new entry point defined in \r
136 MdePkg\Include\Library\PeiCoreEntryPoint.h\r
6a9d345a 137 \r
c6492839 138==========================================================================================\r
e4b561fb 139EDK_3866: Compatible: qhuang8\r
c6492839 140\r
141 Class_UefiEnable[0]: Uefi2.1 feature - Add Hardware Error Record Persistence Support \r
142 Code Change :\r
143 1) Modify MdeModulePkg/Universal/Variable/RuntimeDxe\r
144 2) Modify MdeModulePkg/Universal/Variable/EmuRuntimeDxe\r
d3d32ac0 145\r
146==========================================================================================\r
147EDK_3773: Non-Compatible: qwang12\r
148\r
149 Class_PIEnable[0]: Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.\r
150\r
151 Code Change :\r
152 1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only\r
153 EFI_FIRMWARE_VOLUME2_PROTOCOL. Previously, EFI_FIRMWARE_VOLUME_PROTOCOL\r
154 is produced by Dxe Core.\r
155\r
156 Possible Impacts:\r
157 1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use\r
158 EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
159 2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to\r
160 use gEfiFirmwareVolume2ProtocolGuid.\r
161 3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.\r
162 And the package dependency should also be changed if needed due to this protocol\r
b9f020e9 163 GUID change.\r