]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/ChangeLog.txt
Added change log for the latest tools update (r4190 & r4189).
[mirror_edk2.git] / BaseTools / ChangeLog.txt
CommitLineData
07a756b9 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
183eb3e6 39\r
40##########################################################################################\r
41\r
07a756b9 42##########################################################################################\r
183eb3e6 43########## Revision number of tools source code ##########\r
44 BaseTools/Bin/Win32/build.exe\r
45 r844 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Autogen\r
46 r844 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/build\r
47 r844 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
48 r844 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
49 r844 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
50\r
51 BaseTools/Bin/Win32/GenFds.exe\r
52 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Common\r
53 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/CommonDataClass\r
54 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/GenFds\r
55\r
56 BaseTools/Bin/Win32/Trim.exe\r
57 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/Trim\r
58\r
59 BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
60 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/MigrationMsa2Inf\r
61\r
62 BaseTools/Bin/Win32/TargetTool.exe\r
63 r843 https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools/Source/Python/TargetTool\r
64\r
65\r
66==========================================================================================\r
67EDK_4190: Non-Compatible: jwang36\r
68\r
69 Class_BuildTool:\r
70 1) Added support of using PCD default value from DEC/INF file if one\r
71 PCD is declared in INF file but not found in DSC file.\r
72 2) Added support of breaking build if no library instance is found for\r
73 a library class.\r
74 \r
75 Code Change :\r
76 1) BaseTools/Bin/Win32/build.exe\r
77 1) BaseTools/Bin/Win32/GenFds.exe\r
78\r
79 Possible Impacts:\r
80 1) All packages/platforms/modules, which have wrong library classes\r
81 declared or have no library instance for some library classes, must be\r
82 changed to make sure each library class declared in INF file has\r
83 corresponding library instance.\r
07a756b9 84\r
85==========================================================================================\r
86EDK_4096: Non-Compatible: jwang36\r
87\r
88 Class_BuildTool:\r
89 1) Removed the calling of vsvars32.bat in edksetup.bat, unless\r
90 "--nt32" switch is used.\r
91 2) Added MAKE command in tools_def.txt. This is used to locate where\r
92 the nmake.exe or make.exe is because it will not be in PATH any more.\r
93 3) Removed the calling of vsvars32.bat in toolsetup.bat.\r
94 4) Solved the hang issue of build.exe when error occurred or Ctrl+C is\r
95 pressed.\r
96 5) Passed "-v/-d/-q" command line option to GenFds.exe in makefile if\r
97 it's used by build.exe.\r
98 \r
99 Code Change :\r
100 1) BaseTools/Bin/Win32/build.exe\r
101 2) BaseTools/Bin/Win32/GenFds.exe\r
102 3) BaseTools/Conf/tools_def.template\r
103 4) BaseTools/toolsetup.bat\r
104 5) edksetup.bat\r
105\r
106 Possible Impacts:\r
107 1) Nt32Pkg build needs to run vsvars32.bat before edksetup.bat or run\r
108 edksetup.bat with "--nt32" option, like\r
109\r
110 edksetup.bat --nt32 newbuild\r
111\r
112 2) $(WORKSPACE)/Conf/tools_def.txt must be deleted before running\r
113 edksetup.bat because of new tools_def.template. Otherwise the\r
114 build.exe cannot find the nmake.exe to call.\r
115\r
116==========================================================================================\r
117EDK_3947: Compatible: jwang36\r
118\r
119 Class_BuildTool:\r
120 1) Improved spawn mode (multi-thread) build performance (build -s)\r
121 2) Changed the error/debug/warning message format\r
122 3) Added "--log" command line option to support storing log in file\r
123 \r
124 Code Change :\r
125 1) BaseTools/Bin/Win32/build.exe\r
126\r
127\r
128==========================================================================================\r
129EDK_3936: Compatible: klu2\r
130\r
131 Class_BuildTool:\r
132 1) The first parameter of PEIM's entry point in autogen.c has been changed to \r
133 EFI_PEI_FILE_HANDLE\r
134 \r
135 Code Change :\r
136 1) BaseTools/Bin/Win32/build.exe\r
137\r
138==========================================================================================\r
139EDK_3926: Compatible: jlin16\r
140\r
141 Class_BuildTool:\r
142 1) Added support of Capsule generation from FDF file.\r
143 \r
144 Code Change :\r
145 1) BaseTools/Bin/Win32/build.exe\r
146 2) BaseTools/Bin/Win32/GenFds.exe\r
147\r
148 Possible Impacts:\r
149 1) To generate capsule, insert [Capsule] section after [FV] sections and specifying\r
150 what FV will be put into capsule, For example:\r
151 [Capsule.Fob]\r
152 CAPSULE_GUID = 3B6686BD-0D76-4030-B70E-B5519E2FC5A0\r
153 CAPSULE_FLAG = PersistAcrossReset\r
154 FV = BiosUpdate\r
155\r
156==========================================================================================\r
157EDK_3911: Compatible: jlin16\r
158\r
159 Class_BuildTool:\r
160 1) Added support of Apriori file generation from FDF file.\r
161 2) Added support of INF that describes binary files to put binary into FV.\r
162 3) Fixed single FV/FD generation error when specifying -i/-r option in GenFds.\r
163 \r
164 \r
165 Code Change :\r
166 1) BaseTools/Bin/Win32/build.exe\r
167 2) BaseTools/Bin/Win32/GenFds.exe\r
168\r
169 Possible Impacts:\r
170 1) To generate Apriori file in FV, insert APRIORI statement just before the INF or\r
171 FILE statement list of the FV, For example:\r
172 APRIORI PEI {\r
173 INF MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
174 FILE PEIM = B7A5041A-78BA-49e3-B73B-54C757811FB6 {\r
175 SECTION PE32 = MyBinPkg\bin\ia32\PeimAfterPcd.efi\r
176 }\r
177 INF IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.inf\r
178 }\r
179 2) To add binary file described by INF file into FV, only insert the INF statement\r
180 into the INF statements list of that FV, like this:\r
181 \r
182 INF RuleOverride=Test MdeModulePkg/Logo/Logo.inf\r
183 \r
184 Specifying how to process the binary file by defining corresponding Rule like this:\r
185 [Rule.Common.Base.Test]\r
186 FILE FREEFORM = $(NAMED_GUID) {\r
187 COMPRESS PI_STD {\r
188 GUIDED {\r
189 RAW BIN |.bmp \r
190 }\r
191 }\r
192 }\r
193\r
194==========================================================================================\r
195EDK_3832: Non-Compatible: jwang36\r
196\r
197 Class_BuildTool:\r
198 1) Added support of MACRO in tools_def.txt\r
199 2) Merged PATH and NAME attributes in tools_def.txt\r
200 3) Changed DPATH attribute to DLL in tools_def.txt\r
201 4) Removed SPATH attribute in tools_def.txt\r
202 5) Added support for library instance without library class\r
203 6) Fixed the issue in Trim tool which zero file will be generated if the trimmed \r
204 file has not line directive\r
205 \r
206 Code Change :\r
207 1) BaseTools/Bin/Win32/build.exe\r
208 2) BaseTools/Bin/Win32/GenFds.exe\r
209 3) BaseTools/Bin/Win32/Trim.exe\r
210 4) BaseTools/Conf/tools_def.template\r
211\r
212 Possible Impacts:\r
213 1) All platforms and modules build\r
214\r
215==========================================================================================\r
216EDK_3801: Compatible: jwang36\r
217\r
218 Class_BuildConfiguration: Added makefile as dependency for "Dynamic-Library-File" to \r
219 solve the incremental build issue occurred when there's library changes\r
220\r
221 Code Change :\r
222 1) BaseTools/Conf/build_rule.template\r
223\r
224==========================================================================================\r
225EDK_3800: Compatible: lgao4\r
226\r
227 Class_BuildTool: Update EfiRom tool to fix checksum and PCI3.0 data structure\r
228\r
229 Code Change :\r
230 1) BaseTools/Bin/Win32/EfiRom.exe\r
231\r
232==========================================================================================\r
233EDK_3795: Compatible: htao\r
234\r
235 Class_BuildTool: GenVtf tool open/write file with "r+b"/"w+b" attribute, but this cause\r
236 the RO attribute of the file changed. Fix this issue by changing \r
237 "r+b"/"w+b" to "rb"/"wb".\r
238\r
239 Code Change :\r
240 1) BaseTools/Bin/Win32/GenVtf.exe\r
241\r
242==========================================================================================\r
243EDK_3791: Compatible: jlin16\r
244\r
245 Class_BuildTool:\r
246 1) use '#' to indicate flash generation progress.\r
247 2) use -v to switch on detail output messages.\r
248\r
249 Code Change :\r
250 1) BaseTools/Bin/Win32/GenFds.exe\r
251\r
252==========================================================================================\r
253EDK_3789: Non-Compatible: lgao4\r
254\r
255 Class_BuildTool: support new Rules format and PCD format defined in FDF file\r
256\r
257 Code Change :\r
258 1) BaseTools/Bin/Win32/build.exe\r
259 2) BaseTools/Bin/Win32/GenFds.exe\r
260\r
261 Possible Impacts:\r
262 1) All platform's FDF file, if any, must be changed to new format.\r
263 a) PCD format is changed from old PcdName to new PcdTokenSpaceGuid.PcdName, \r
264 for example PcdWinNtFdBaseAddress in old FDF file will be replaced \r
265 by gEfiNt32PkgTokenSpaceGuid.PcdWinNtFdBaseAddres.\r
266 b) Rule format adds binary file type and file postfix name support, \r
267 and doesn't require the full file path. Examples for Peim and AcpiTable module:\r
268 Old Peim Rule:\r
269 [Rule.Common.PEIM]\r
270 FILE PEIM = $(NAMED_GUID) {\r
271 PEI_DEPEX Optional $(INF_OUTPUT)/$(MODULE_NAME).Depex\r
272 PE32 $(INF_OUTPUT)/$(MODULE_NAME).efi\r
273 UI Optional $(MODULE_NAME)\r
274 VERSION Optional BUILD_NUM=$(BUILD_NUMBER) $(INF_VERSION)\r
275 }\r
276 New Peim Rule:\r
277 [Rule.Common.PEIM]\r
278 FILE PEIM = $(NAMED_GUID) {\r
279 PEI_DEPEX PEI_DEPEX Optional |.Depex\r
280 PE32 PE32 |.efi\r
281 UI STRING="$(MODULE_NAME)" Optional \r
282 VERSION STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER) \r
283 }\r
284\r
285 Old AcpiTable Rule:\r
286 [Rule.Common.DXE_DRIVER.ACPITABLE]\r
287 FILE FREEFORM = $(NAMED_GUID) {\r
288 RAW $(INF_OUTPUT)/Madt.acpi\r
289 RAW $(INF_OUTPUT)/Fadt.acpi\r
290 RAW $(INF_OUTPUT)/Facs.acpi\r
291 RAW $(INF_OUTPUT)/Spcr.acpi\r
292 RAW $(INF_OUTPUT)/Dsdt.aml\r
293 }\r
294 New AcpiTable Rule:\r
295 [Rule.Common.DXE_DRIVER.ACPITABLE]\r
296 FILE FREEFORM = $(NAMED_GUID) {\r
297 RAW ACPI |.acpi\r
298 RAW ASL |.aml\r
299 }\r
300\r
301==========================================================================================\r
302EDK_3786: Compatible: vjeff\r
303\r
304 Class_BuildConfiguration:\r
305 1) Redirect ICC_IA32_*_PATH from C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin \r
306 to C:\Program Files\Intel\Compiler\C++\9.1\IA32\Bin. \r
307 2) Add ICC X64 definition to enable ICC X64 build.\r
308\r
309 Code Change :\r
310 1) BaseTools/Conf/tools_def.template\r
311\r
312==========================================================================================\r
313EDK_3785: Non-Compatible: klu2\r
314\r
315 Class_BuildTool: Upgrade the format of EFI_PEIM_ENTRY_POINT to \r
316 EFI_PEIM_ENTRY_POINT2 according to PI specification.\r
317\r
318\r
319 Code Change :\r
320 1) BaseTools/Bin/Win32/build.exe\r
321\r
322 Possible Impacts:\r
323 1) All modules build\r
324\r
325\r
326==========================================================================================\r
327EDK_3780: Non-Compatible: qhuang8\r
328\r
329 Class_MigrationTool: Update the syntax of PCD section.\r
330 Update the syntax of binary INF file\r
331 The generated Extended INF file should follow Extended INF spec 0.44\r
332\r
333 Code Change :\r
334 1) BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
335\r
336 Possible Impacts:\r
337 1) New module migrated from old R9\r
338\r
339\r
340==========================================================================================\r
341EDK_3766: Non-Compatible: lgao4\r
342\r
343 Class_BuildConfiguration: Update Acpi Asl file Build rule to remove trim step.\r
344\r
345 Code Change :\r
346 1) Conf/build_rule.template\r
347\r
348 Possible Impacts:\r
349 1) Platform with ACPI module. Acpi module needs to set /EP preprocessor compiler option \r
350 for APP_FLAGS in module inf to override the default /E option defined in tools_def.txt file. \r
351\r
352\r