[mirror_edk2.git] / BaseTools / ChangeLog.txt

##########################################################################################\r
!!!!!!!!!!!!!!!!!               Notes for this ChangeLog.txt             !!!!!!!!!!!!!!!!!\r
\r
This log file is used to record two kinds of important information:\r
 a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info\r
    will help the package user to merge this package; and some non-compatible changes\r
    can also be added into release notes as news features when we release this package.\r
    Normally Non-Compatible Changes contains the following types:\r
      1) Package's external services were changed/updated\r
      2) Package's common .h file is renamed, deleted, or the file path is changed.\r
      3) The definition of package's common data structure is changed\r
      ...\r
\r
 b) "Important Compatible Changes": some important compatible changes can aslo be recorded\r
    in this file, and we can add these updating into release notes when we release this\r
    package.\r
\r
Non-Compatible and Compatible example format:\r
==========================================================================================\r
EDK_0010: Non-Compatible: owner\r
\r
      Class_HFile: PPI A of MdePkg has been removed.\r
\r
        Code Change :\r
        1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
\r
        Possible Impacts:\r
        1) All modules that used this PPI A should be updated.\r
\r
==========================================================================================\r
EDK_0000: Compatible: owner\r
\r
      Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
\r
        Code Change :\r
        1) BaseTools\Bin\Win32\build.exe\r
\r
!!!!!!!!!!!!!!!!!!                     End of Notes                     !!!!!!!!!!!!!!!!!!\r
##########################################################################################\r
\r
==========================================================================================\r
EDK_3911: Compatible: jlin16\r
\r
      Class_BuildTool:\r
        1) Added support of Apriori file generation from FDF file.\r
        2) Added support of INF that describes binary files to put binary into FV.\r
        3) Fixed single FV/FD generation error when specifying -i/-r option in GenFds.\r
        \r
 \r
        Code Change :\r
        1) BaseTools/Bin/Win32/build.exe\r
        2) BaseTools/Bin/Win32/GenFds.exe\r
\r
        Possible Impacts:\r
        1) To generate Apriori file in FV, insert APRIORI statement just before the INF or\r
        FILE statement list of the FV, For example:\r
        APRIORI PEI {\r
          INF  MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
          FILE PEIM = B7A5041A-78BA-49e3-B73B-54C757811FB6 {\r
                  SECTION PE32 = MyBinPkg\bin\ia32\PeimAfterPcd.efi\r
          }\r
          INF  IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.inf\r
        }\r
        2) To add binary file described by INF file into FV, only insert the INF statement\r
        into the INF statements list of that FV, like this:\r
        \r
        INF RuleOverride=Test MdeModulePkg/Logo/Logo.inf\r
        \r
        Specifying how to process the binary file by defining corresponding Rule like this:\r
        [Rule.Common.Base.Test]\r
	       FILE FREEFORM = $(NAMED_GUID) {\r
	         COMPRESS PI_STD {\r
  	         GUIDED {\r
                RAW BIN |.bmp   \r
             }\r
	         }\r
	       }\r
\r
==========================================================================================\r
EDK_3832: Non-Compatible: jwang36\r
\r
      Class_BuildTool:\r
        1) Added support of MACRO in tools_def.txt\r
        2) Merged PATH and NAME attributes in tools_def.txt\r
        3) Changed DPATH attribute to DLL in tools_def.txt\r
        4) Removed SPATH attribute in tools_def.txt\r
        5) Added support for library instance without library class\r
        6) Fixed the issue in Trim tool which zero file will be generated if the trimmed \r
           file has not line directive\r
 \r
        Code Change :\r
        1) BaseTools/Bin/Win32/build.exe\r
        2) BaseTools/Bin/Win32/GenFds.exe\r
        3) BaseTools/Bin/Win32/Trim.exe\r
        4) BaseTools/Conf/tools_def.template\r
\r
        Possible Impacts:\r
        1) All platforms and modules build\r
\r
==========================================================================================\r
EDK_3801: Compatible: jwang36\r
\r
      Class_BuildConfiguration: Added makefile as dependency for "Dynamic-Library-File" to \r
        solve the incremental build issue occurred when there's library changes\r
\r
        Code Change :\r
        1) BaseTools/Conf/build_rule.template\r
\r
==========================================================================================\r
EDK_3800: Compatible: lgao4\r
\r
      Class_BuildTool: Update EfiRom tool to fix checksum and PCI3.0 data structure\r
\r
        Code Change :\r
        1) BaseTools/Bin/Win32/EfiRom.exe\r
\r
==========================================================================================\r
EDK_3795: Compatible: htao\r
\r
      Class_BuildTool: GenVtf tool open/write file with "r+b"/"w+b" attribute, but this cause\r
                       the RO attribute of the file changed. Fix this issue by changing \r
                       "r+b"/"w+b" to "rb"/"wb".\r
\r
        Code Change :\r
        1) BaseTools/Bin/Win32/GenVtf.exe\r
\r
==========================================================================================\r
EDK_3791: Compatible: jlin16\r
\r
      Class_BuildTool:\r
        1) use '#' to indicate flash generation progress.\r
        2) use -v to switch on detail output messages.\r
\r
        Code Change :\r
        1) BaseTools/Bin/Win32/GenFds.exe\r
\r
==========================================================================================\r
EDK_3789: Non-Compatible: lgao4\r
\r
      Class_BuildTool: support new Rules format and PCD format defined in FDF file\r
\r
        Code Change :\r
        1) BaseTools/Bin/Win32/build.exe\r
        2) BaseTools/Bin/Win32/GenFds.exe\r
\r
        Possible Impacts:\r
        1) All platform's FDF file, if any, must be changed to new format.\r
          a) PCD format is changed from old PcdName to new PcdTokenSpaceGuid.PcdName, for example PcdWinNtFdBaseAddress in old FDF file will be replaced by gEfiNt32PkgTokenSpaceGuid.PcdWinNtFdBaseAddres.\r
          b) Rule format adds binary file type and file postfix name support, and doesn't require the full file path. For example:\r
          Old Peim Rule:\r
          [Rule.Common.PEIM]\r
          FILE PEIM = $(NAMED_GUID) {\r
             PEI_DEPEX Optional        $(INF_OUTPUT)/$(MODULE_NAME).Depex\r
             PE32                      $(INF_OUTPUT)/$(MODULE_NAME).efi\r
             UI Optional               $(MODULE_NAME)\r
             VERSION Optional          BUILD_NUM=$(BUILD_NUMBER) $(INF_VERSION)\r
          }\r
          New Peim Rule:\r
          [Rule.Common.PEIM]\r
            FILE PEIM = $(NAMED_GUID) {\r
               PEI_DEPEX PEI_DEPEX Optional        |.Depex\r
               PE32      PE32                      |.efi\r
               UI       STRING="$(MODULE_NAME)" Optional         \r
               VERSION  STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)   \r
            }\r
\r
==========================================================================================\r
EDK_3786: Compatible: vjeff\r
\r
      Class_BuildConfiguration:\r
        1) Redirect ICC_IA32_*_PATH from C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin \r
           to C:\Program Files\Intel\Compiler\C++\9.1\IA32\Bin. \r
        2) Add ICC X64 definition to enable ICC X64 build.\r
\r
        Code Change :\r
        1) BaseTools/Conf/tools_def.template\r
\r
==========================================================================================\r
EDK_3785: Non-Compatible: klu2\r
\r
      Class_BuildTool: Upgrade the format of EFI_PEIM_ENTRY_POINT to \r
                       EFI_PEIM_ENTRY_POINT2 according to PI specification.\r
\r
\r
        Code Change :\r
        1) BaseTools/Bin/Win32/build.exe\r
\r
        Possible Impacts:\r
        1) All modules build\r
\r
\r
==========================================================================================\r
EDK_3780: Non-Compatible: qhuang8\r
\r
      Class_MigrationTool: Update the syntax of PCD section.\r
                           Update the syntax of binary INF file\r
                           The generated Extended INF file should follow Extended INF spec 0.44\r
\r
        Code Change :\r
        1) BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
\r
        Possible Impacts:\r
        1) New module migrated from old R9\r
\r
\r
==========================================================================================\r
EDK_3766: Non-Compatible: lgao4\r
\r
      Class_BuildConfiguration: Update Acpi Asl file Build rule to remove trim step.\r
\r
        Code Change :\r
        1) Conf/build_rule.template\r
\r
        Possible Impacts:\r
        1) Platform with ACPI module. Acpi module needs to set /EP preprocessor compiler option for APP_FLAGS in module inf to override the default /E option from tools_def.txt file. \r
\r
\r
Commit	Line	Data
1b7f7985	1	##########################################################################################\r
	2	!!!!!!!!!!!!!!!!! Notes for this ChangeLog.txt !!!!!!!!!!!!!!!!!\r
	3	\r
	4	This 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
	18	Non-Compatible and Compatible example format:\r
	19	==========================================================================================\r
	20	EDK_0010: Non-Compatible: owner\r
	21	\r
38f2ab29	22	Class_HFile: PPI A of MdePkg has been removed.\r
1b7f7985	23	\r
38f2ab29	24	Code Change :\r
38f2ab29	25	1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
1b7f7985	26	\r
38f2ab29	27	Possible Impacts:\r
38f2ab29	28	1) All modules that used this PPI A should be updated.\r
1b7f7985	29	\r
	30	==========================================================================================\r
	31	EDK_0000: Compatible: owner\r
	32	\r
38f2ab29	33	Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
1b7f7985	34	\r
38f2ab29	35	Code Change :\r
38f2ab29	36	1) BaseTools\Bin\Win32\build.exe\r
1b7f7985	37	\r
	38	!!!!!!!!!!!!!!!!!! End of Notes !!!!!!!!!!!!!!!!!!\r
	39	##########################################################################################\r
	40	\r
679efe0a	41	==========================================================================================\r
	42	EDK_3911: Compatible: jlin16\r
	43	\r
	44	Class_BuildTool:\r
	45	1) Added support of Apriori file generation from FDF file.\r
	46	2) Added support of INF that describes binary files to put binary into FV.\r
	47	3) Fixed single FV/FD generation error when specifying -i/-r option in GenFds.\r
	48	\r
	49	\r
	50	Code Change :\r
	51	1) BaseTools/Bin/Win32/build.exe\r
	52	2) BaseTools/Bin/Win32/GenFds.exe\r
	53	\r
	54	Possible Impacts:\r
	55	1) To generate Apriori file in FV, insert APRIORI statement just before the INF or\r
	56	FILE statement list of the FV, For example:\r
	57	APRIORI PEI {\r
	58	INF MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
	59	FILE PEIM = B7A5041A-78BA-49e3-B73B-54C757811FB6 {\r
	60	SECTION PE32 = MyBinPkg\bin\ia32\PeimAfterPcd.efi\r
	61	}\r
	62	INF IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.inf\r
	63	}\r
	64	2) To add binary file described by INF file into FV, only insert the INF statement\r
	65	into the INF statements list of that FV, like this:\r
	66	\r
	67	INF RuleOverride=Test MdeModulePkg/Logo/Logo.inf\r
	68	\r
	69	Specifying how to process the binary file by defining corresponding Rule like this:\r
	70	[Rule.Common.Base.Test]\r
	71	FILE FREEFORM = $(NAMED_GUID) {\r
	72	COMPRESS PI_STD {\r
	73	GUIDED {\r
	74	RAW BIN \|.bmp \r
	75	}\r
	76	}\r
	77	}\r
1b7f7985	78	\r
38f2ab29	79	==========================================================================================\r
	80	EDK_3832: Non-Compatible: jwang36\r
	81	\r
	82	Class_BuildTool:\r
	83	1) Added support of MACRO in tools_def.txt\r
	84	2) Merged PATH and NAME attributes in tools_def.txt\r
	85	3) Changed DPATH attribute to DLL in tools_def.txt\r
	86	4) Removed SPATH attribute in tools_def.txt\r
	87	5) Added support for library instance without library class\r
	88	6) Fixed the issue in Trim tool which zero file will be generated if the trimmed \r
	89	file has not line directive\r
	90	\r
	91	Code Change :\r
	92	1) BaseTools/Bin/Win32/build.exe\r
	93	2) BaseTools/Bin/Win32/GenFds.exe\r
	94	3) BaseTools/Bin/Win32/Trim.exe\r
	95	4) BaseTools/Conf/tools_def.template\r
	96	\r
	97	Possible Impacts:\r
	98	1) All platforms and modules build\r
	99	\r
	100	==========================================================================================\r
	101	EDK_3801: Compatible: jwang36\r
	102	\r
	103	Class_BuildConfiguration: Added makefile as dependency for "Dynamic-Library-File" to \r
	104	solve the incremental build issue occurred when there's library changes\r
	105	\r
	106	Code Change :\r
	107	1) BaseTools/Conf/build_rule.template\r
	108	\r
	109	==========================================================================================\r
	110	EDK_3800: Compatible: lgao4\r
	111	\r
	112	Class_BuildTool: Update EfiRom tool to fix checksum and PCI3.0 data structure\r
	113	\r
	114	Code Change :\r
	115	1) BaseTools/Bin/Win32/EfiRom.exe\r
	116	\r
	117	==========================================================================================\r
	118	EDK_3795: Compatible: htao\r
	119	\r
	120	Class_BuildTool: GenVtf tool open/write file with "r+b"/"w+b" attribute, but this cause\r
	121	the RO attribute of the file changed. Fix this issue by changing \r
	122	"r+b"/"w+b" to "rb"/"wb".\r
	123	\r
	124	Code Change :\r
	125	1) BaseTools/Bin/Win32/GenVtf.exe\r
	126	\r
	127	==========================================================================================\r
	128	EDK_3791: Compatible: jlin16\r
	129	\r
	130	Class_BuildTool:\r
	131	1) use '#' to indicate flash generation progress.\r
	132	2) use -v to switch on detail output messages.\r
	133	\r
	134	Code Change :\r
	135	1) BaseTools/Bin/Win32/GenFds.exe\r
	136	\r
	137	==========================================================================================\r
	138	EDK_3789: Non-Compatible: lgao4\r
	139	\r
	140	Class_BuildTool: support new Rules format and PCD format defined in FDF file\r
	141	\r
	142	Code Change :\r
143	1) BaseTools/Bin/Win32/build.exe\r
144	2) BaseTools/Bin/Win32/GenFds.exe\r
145	\r
146	Possible Impacts:\r
8fb31ab7 LG	147	1) All platform's FDF file, if any, must be changed to new format.\r
	148	a) PCD format is changed from old PcdName to new PcdTokenSpaceGuid.PcdName, for example PcdWinNtFdBaseAddress in old FDF file will be replaced by gEfiNt32PkgTokenSpaceGuid.PcdWinNtFdBaseAddres.\r
	149	b) Rule format adds binary file type and file postfix name support, and doesn't require the full file path. For example:\r
	150	Old Peim Rule:\r
	151	[Rule.Common.PEIM]\r
	152	FILE PEIM = $(NAMED_GUID) {\r
	153	PEI_DEPEX Optional $(INF_OUTPUT)/$(MODULE_NAME).Depex\r
	154	PE32 $(INF_OUTPUT)/$(MODULE_NAME).efi\r
	155	UI Optional $(MODULE_NAME)\r
	156	VERSION Optional BUILD_NUM=$(BUILD_NUMBER) $(INF_VERSION)\r
	157	}\r
	158	New Peim Rule:\r
	159	[Rule.Common.PEIM]\r
	160	FILE PEIM = $(NAMED_GUID) {\r
	161	PEI_DEPEX PEI_DEPEX Optional \|.Depex\r
	162	PE32 PE32 \|.efi\r
	163	UI STRING="$(MODULE_NAME)" Optional \r
	164	VERSION STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER) \r
	165	}\r
38f2ab29	166	\r
	167	==========================================================================================\r
	168	EDK_3786: Compatible: vjeff\r
	169	\r
	170	Class_BuildConfiguration:\r
	171	1) Redirect ICC_IA32_*_PATH from C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin \r
	172	to C:\Program Files\Intel\Compiler\C++\9.1\IA32\Bin. \r
	173	2) Add ICC X64 definition to enable ICC X64 build.\r
	174	\r
	175	Code Change :\r
	176	1) BaseTools/Conf/tools_def.template\r
	177	\r
	178	==========================================================================================\r
	179	EDK_3785: Non-Compatible: klu2\r
	180	\r
	181	Class_BuildTool: Upgrade the format of EFI_PEIM_ENTRY_POINT to \r
	182	EFI_PEIM_ENTRY_POINT2 according to PI specification.\r
	183	\r
	184	\r
	185	Code Change :\r
	186	1) BaseTools/Bin/Win32/build.exe\r
	187	\r
	188	Possible Impacts:\r
	189	1) All modules build\r
	190	\r
	191	\r
	192	==========================================================================================\r
	193	EDK_3780: Non-Compatible: qhuang8\r
	194	\r
	195	Class_MigrationTool: Update the syntax of PCD section.\r
	196	Update the syntax of binary INF file\r
	197	The generated Extended INF file should follow Extended INF spec 0.44\r
	198	\r
	199	Code Change :\r
	200	1) BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
	201	\r
	202	Possible Impacts:\r
	203	1) New module migrated from old R9\r
	204	\r
	205	\r
	206	==========================================================================================\r
	207	EDK_3766: Non-Compatible: lgao4\r
	208	\r
	209	Class_BuildConfiguration: Update Acpi Asl file Build rule to remove trim step.\r
	210	\r
	211	Code Change :\r
	212	1) Conf/build_rule.template\r
	213	\r
	214	Possible Impacts:\r
8fb31ab7	215	1) Platform with ACPI module. Acpi module needs to set /EP preprocessor compiler option for APP_FLAGS in module inf to override the default /E option from tools_def.txt file. \r
38f2ab29	216	\r
1b7f7985	217	\r