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