remove member context from _EFI_MTFTP4_TOKEN structure.
[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
a021b849 41==========================================================================================\r
42EDK_4067: Non-Compatible: qwang12\r
43 Class_PIEnable[6]: PEI core does not build FV HOB upon notification of a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI automatically.\r
44\r
45 Code Change :\r
46 1) MdeModulePkg/Core/Pei/FwVol/FwVol.c \r
47 \r
48 Impact to platform code:\r
49 1) If platform module want to inform both PEI core and DXE core about the existance of new FV \r
50 it must both install EFI_PEI_FIRMWARE_VOLUME_INFO_PPI and FV HOB. \r
51\r
52 A example is given belows:\r
53 \r
54 PiLibInstallFvInfoPpi (\r
55 NULL,\r
56 Buffer,\r
57 (UINT32) FvHeader->FvLength,\r
58 NULL,\r
59 NULL\r
60 );\r
61 \r
62 BuildFvHob (\r
63 (EFI_PHYSICAL_ADDRESS) (UINTN) Buffer,\r
64 (UINT32) FvHeader->FvLength\r
65 );\r
66\r
67 PEI core does not automatically build FV HOB upon notification of a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI. \r
68 The description in Item 2 in Section 4.8.1.2 in Vol 1 of PI spec will be updated to remove the \r
69 "Create a new firmware volume HOB" wording.\r
70 \r
71\r
02cc3e96 72==========================================================================================\r
73EDK_4000-4006: Compatible: qhuang8\r
74\r
75 Class_UefiEnable[0]: Uefi feature -Add component name 2 protocol support for\r
76 all drivers that support component name protocol\r
77 \r
78\r
79 Code Change :\r
80 1) Update MdeModulePkg/Bus/Pci/*\r
81 2) Update MdeModulePkg/Bus/Scsi/*\r
82 3) Update MdeModulePkg/Bus/Usb/*\r
83 4) Update MdeModulePkg/Universal/Disk/*\r
84 5) Update MdeModulePkg/Universal/DebugPortDxe/*\r
85 6) Update MdeModulePkg/Universal/Console/*\r
86 7) Update MdeModulePkg/Universal/Network/*\r
87 \r
88 possible impact:\r
89 1) To produce the component name 2 protocol, platform DSC file needs to set feature\r
90 flag 'PcdComponentName2Disable' to 'FALSE'\r
91\r
6a9d345a 92==========================================================================================\r
a0ae8996
LG
93EDK_3967: Non-Compatible: lgao4\r
94\r
95 Class_Library: Remove PeCoffLoader library class and its instances.\r
96\r
97 Code Change :\r
98 1) Remove MdeModulePkg/Include/Library/PeCoffLoaderLib.h\r
99 2) Remove MdeModulePkg/Library/DxePeCoffLoaderFromHobLib and PeiDxePeCoffLoaderLib instance\r
100 3) Modify PeiCore, DxeIpl and DxeCore to use PeCoffLib in place of PeCoffLoaderLib.\r
101\r
102 Possible Impacts:\r
103 1) All modules don't use PeCoffloader library class any longer to load PeImage. \r
104 If necessary, they should use PeCoffLib of MdePkg to load PeImage.\r
105\r
106==========================================================================================\r
107EDK_3931: Non-Compatible: klu2\r
6a9d345a 108 \r
d3d32ac0 109 Class_PIEnable[5]: New library class for S3Resume and Recovery for DxeIpl PEIM.\r
6a9d345a 110 \r
111 Code Change:\r
d3d32ac0 112 1) Add new library class \r
113 a) MdeModulePkg/Include/Library/S3Lib.h\r
114 b) MdeModulePkg/Include/Library/RecoveryLib.h\r
115 2) Add NULL library instances for MdeModulePkg:\r
78818e8e 116 a) MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf.\r
117 b) MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf\r
d3d32ac0 118 3) Add framework implement library instances:\r
78818e8e 119 a) IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.inf\r
120 b) IntelFrameworkModulePkg/Library/PeiRecovery/PeiRecovery.inf\r
6a9d345a 121 \r
122 Possible Impacts:\r
78818e8e 123 1) In DSC file, real platform should select:\r
124 S3Lib library class -> IntelFrameworkModulePkg/Library/PeiS3Lib/PeiS3Lib.inf\r
125 RecoveryLib library class -> IntelFrameworkModulePkg/Library/PeiRecovery/PeiRecovery.inf\r
126 \r
127 Nt32 platform should select:\r
128 S3Lib library class -> MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf.\r
129 RecoveryLib library class -> MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf\r
130 \r
b4f5f5d6 131==========================================================================================\r
132EDK_3922: Non-Compatible: qwang12, klu2\r
133 Class_PIEnable[2]: Update PEI core to only consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI\r
134\r
135 Code Change :\r
136 1) Update PEI core to consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI to get the location of new FVs other than BFV\r
137 reported by PEIMs . \r
138\r
139 Possible Impacts:\r
140 1) Platform code that is going to inform PEI core about the new FVs other than BFV should install \r
141 EFI_PEI_FIRMWARE_VOLUME_INFO_PPI. A library function named PeiPiLibBuildPiFvInfoPpi() defined in \r
142 MdePkg\Include\Library\PeiPiLib.h can be used to install the PPI. \r
143 There are two notes worth mentioning:\r
144 1) Platform PEIMs should report at least FVs containing DXE_CORE and all other PEIM to PEI Core if they\r
145 are not in the BFV. \r
146 2) PEI core will dispatch PEIMs in the FV reported by PeiPiLibBuildPiFvInfoPpi() and invoke BuildFvHob () to build the \r
147 FV HOB for this FV (see Section 4.8.1.2 of Vol 1 named Multiple Firmware Volume Support for details). \r
148 If PEIM only want to inform DXE core about the existance of the new FV, it should call BuildFvHob instead.\r
149 \r
150 \r
151 Class_PIEnable[3]: Update PEI core to support RegisterForShadow feature introduced by PI spec\r
152\r
153 Code Change :\r
154 1) DXEIPL no longer produce EFI_PEI_FV_FILE_LOADER_PPI defined in Framework PEI CIS.\r
155\r
156 Possible Impacts:\r
157\r
158 1)All PEIMs that need to shadow itself into memory and rerun the entry point should be updated to call RegisterForShadow\r
159 (PeiServicesLibRegisterForShadow () is a helper function).\r
160 2)The depex of PEIMs that including EFI_PEI_FV_FILE_LOADER_PPI (or gEfiPeiFvFileLoaderPpiGuid) should be removed.\r
161 \r
162\r
163 Class_PIEnable[4]: Update PEI core to produce other new features defined in PI spec\r
164\r
165 Code Change :\r
166 1) Add the following services: FfsGetFileInfo, FfsFindFileByName and FfsGetVolumeInfo\r
167\r
168 Possible Impacts:\r
169\r
170 1) Platform code is recommended to make use of these new PI features. The functions in MdePkg/Include/Library/PeiServicesLib.h are \r
171 recommended as PeiServices is saved for every PEI Services API invokation.\r
172\r
d3d32ac0 173==========================================================================================\r
174EDK_3871: Non-Compatible: klu2\r
175 \r
176 Class_PIEnable[1]: Use new entry point for PeiCore defined in PI specification.\r
177 \r
178 Code Change:\r
179 1) PeiMain module use PeiCoreEntryPoint library class but *not* original OldPeiCoreEntryPoint.\r
180 2) The memory service in PeiMain module get CAR base and size from parameter of PeiCore's\r
181 Entry point directly but *not* computed from stack's base.\r
182 \r
183 Possible Impacts:\r
184 1) Platform should select MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.inf for \r
185 PeiMain module.\r
186 2) The SecCore module should provide parameters for new entry point defined in \r
187 MdePkg\Include\Library\PeiCoreEntryPoint.h\r
6a9d345a 188 \r
c6492839 189==========================================================================================\r
e4b561fb 190EDK_3866: Compatible: qhuang8\r
c6492839 191\r
192 Class_UefiEnable[0]: Uefi2.1 feature - Add Hardware Error Record Persistence Support \r
193 Code Change :\r
194 1) Modify MdeModulePkg/Universal/Variable/RuntimeDxe\r
195 2) Modify MdeModulePkg/Universal/Variable/EmuRuntimeDxe\r
d3d32ac0 196\r
197==========================================================================================\r
198EDK_3773: Non-Compatible: qwang12\r
199\r
200 Class_PIEnable[0]: Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.\r
201\r
202 Code Change :\r
203 1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only\r
204 EFI_FIRMWARE_VOLUME2_PROTOCOL. Previously, EFI_FIRMWARE_VOLUME_PROTOCOL\r
205 is produced by Dxe Core.\r
206\r
207 Possible Impacts:\r
208 1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use\r
209 EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
210 2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to\r
211 use gEfiFirmwareVolume2ProtocolGuid.\r
212 3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.\r
213 And the package dependency should also be changed if needed due to this protocol\r
b9f020e9 214 GUID change.\r