[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_3936: Compatible: klu2\r
\r
      Class_BuildTool:\r
        1) The first parameter of PEIM's entry point in autogen.c has been changed to \r
           EFI_PEI_FILE_HANDLE\r
 \r
        Code Change :\r
        1) BaseTools/Bin/Win32/build.exe\r
\r
==========================================================================================\r
EDK_3926: Compatible: jlin16\r
\r
      Class_BuildTool:\r
        1) Added support of Capsule generation from 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) To generate capsule, insert [Capsule] section after [FV] sections and specifying\r
        what FV will be put into capsule, For example:\r
        [Capsule.Fob]\r
        CAPSULE_GUID = 3B6686BD-0D76-4030-B70E-B5519E2FC5A0\r
        CAPSULE_FLAG = PersistAcrossReset\r
        FV = BiosUpdate\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, \r
             for example PcdWinNtFdBaseAddress in old FDF file will be replaced \r
             by gEfiNt32PkgTokenSpaceGuid.PcdWinNtFdBaseAddres.\r
          b) Rule format adds binary file type and file postfix name support, \r
             and doesn't require the full file path. Examples for Peim and AcpiTable module:\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
          Old AcpiTable Rule:\r
          [Rule.Common.DXE_DRIVER.ACPITABLE]\r
            FILE FREEFORM = $(NAMED_GUID) {\r
              RAW                    $(INF_OUTPUT)/Madt.acpi\r
              RAW                    $(INF_OUTPUT)/Fadt.acpi\r
              RAW                    $(INF_OUTPUT)/Facs.acpi\r
              RAW                    $(INF_OUTPUT)/Spcr.acpi\r
              RAW                    $(INF_OUTPUT)/Dsdt.aml\r
            }\r
          New AcpiTable Rule:\r
          [Rule.Common.DXE_DRIVER.ACPITABLE]\r
            FILE FREEFORM = $(NAMED_GUID) {\r
              RAW ACPI |.acpi\r
              RAW ASL  |.aml\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 \r
        for APP_FLAGS in module inf to override the default /E option defined in 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
0ad41bfa	41	==========================================================================================\r
	42	EDK_3936: Compatible: klu2\r
	43	\r
	44	Class_BuildTool:\r
	45	1) The first parameter of PEIM's entry point in autogen.c has been changed to \r
	46	EFI_PEI_FILE_HANDLE\r
	47	\r
	48	Code Change :\r
	49	1) BaseTools/Bin/Win32/build.exe\r
	50	\r
679efe0a	51	==========================================================================================\r
5f568053	52	EDK_3926: Compatible: jlin16\r
	53	\r
	54	Class_BuildTool:\r
	55	1) Added support of Capsule generation from FDF file.\r
	56	\r
	57	Code Change :\r
	58	1) BaseTools/Bin/Win32/build.exe\r
	59	2) BaseTools/Bin/Win32/GenFds.exe\r
	60	\r
	61	Possible Impacts:\r
	62	1) To generate capsule, insert [Capsule] section after [FV] sections and specifying\r
	63	what FV will be put into capsule, For example:\r
	64	[Capsule.Fob]\r
	65	CAPSULE_GUID = 3B6686BD-0D76-4030-B70E-B5519E2FC5A0\r
	66	CAPSULE_FLAG = PersistAcrossReset\r
	67	FV = BiosUpdate\r
	68	\r
	69	==========================================================================================\r
679efe0a	70	EDK_3911: Compatible: jlin16\r
	71	\r
	72	Class_BuildTool:\r
	73	1) Added support of Apriori file generation from FDF file.\r
	74	2) Added support of INF that describes binary files to put binary into FV.\r
	75	3) Fixed single FV/FD generation error when specifying -i/-r option in GenFds.\r
	76	\r
	77	\r
	78	Code Change :\r
	79	1) BaseTools/Bin/Win32/build.exe\r
	80	2) BaseTools/Bin/Win32/GenFds.exe\r
	81	\r
	82	Possible Impacts:\r
	83	1) To generate Apriori file in FV, insert APRIORI statement just before the INF or\r
	84	FILE statement list of the FV, For example:\r
	85	APRIORI PEI {\r
	86	INF MdeModulePkg/Universal/PCD/Pei/Pcd.inf\r
	87	FILE PEIM = B7A5041A-78BA-49e3-B73B-54C757811FB6 {\r
	88	SECTION PE32 = MyBinPkg\bin\ia32\PeimAfterPcd.efi\r
	89	}\r
	90	INF IntelFrameworkModulePkg/Universal/StatusCode/Pei/PeiStatusCode.inf\r
	91	}\r
	92	2) To add binary file described by INF file into FV, only insert the INF statement\r
	93	into the INF statements list of that FV, like this:\r
	94	\r
	95	INF RuleOverride=Test MdeModulePkg/Logo/Logo.inf\r
	96	\r
	97	Specifying how to process the binary file by defining corresponding Rule like this:\r
	98	[Rule.Common.Base.Test]\r
	99	FILE FREEFORM = $(NAMED_GUID) {\r
	100	COMPRESS PI_STD {\r
	101	GUIDED {\r
	102	RAW BIN \|.bmp \r
	103	}\r
	104	}\r
	105	}\r
1b7f7985	106	\r
38f2ab29	107	==========================================================================================\r
	108	EDK_3832: Non-Compatible: jwang36\r
	109	\r
	110	Class_BuildTool:\r
	111	1) Added support of MACRO in tools_def.txt\r
	112	2) Merged PATH and NAME attributes in tools_def.txt\r
	113	3) Changed DPATH attribute to DLL in tools_def.txt\r
	114	4) Removed SPATH attribute in tools_def.txt\r
	115	5) Added support for library instance without library class\r
	116	6) Fixed the issue in Trim tool which zero file will be generated if the trimmed \r
	117	file has not line directive\r
	118	\r
	119	Code Change :\r
	120	1) BaseTools/Bin/Win32/build.exe\r
	121	2) BaseTools/Bin/Win32/GenFds.exe\r
	122	3) BaseTools/Bin/Win32/Trim.exe\r
	123	4) BaseTools/Conf/tools_def.template\r
	124	\r
	125	Possible Impacts:\r
	126	1) All platforms and modules build\r
	127	\r
	128	==========================================================================================\r
	129	EDK_3801: Compatible: jwang36\r
	130	\r
	131	Class_BuildConfiguration: Added makefile as dependency for "Dynamic-Library-File" to \r
	132	solve the incremental build issue occurred when there's library changes\r
	133	\r
	134	Code Change :\r
	135	1) BaseTools/Conf/build_rule.template\r
	136	\r
	137	==========================================================================================\r
	138	EDK_3800: Compatible: lgao4\r
	139	\r
	140	Class_BuildTool: Update EfiRom tool to fix checksum and PCI3.0 data structure\r
	141	\r
	142	Code Change :\r
	143	1) BaseTools/Bin/Win32/EfiRom.exe\r
	144	\r
	145	==========================================================================================\r
	146	EDK_3795: Compatible: htao\r
	147	\r
	148	Class_BuildTool: GenVtf tool open/write file with "r+b"/"w+b" attribute, but this cause\r
	149	the RO attribute of the file changed. Fix this issue by changing \r
	150	"r+b"/"w+b" to "rb"/"wb".\r
	151	\r
	152	Code Change :\r
	153	1) BaseTools/Bin/Win32/GenVtf.exe\r
	154	\r
	155	==========================================================================================\r
	156	EDK_3791: Compatible: jlin16\r
	157	\r
	158	Class_BuildTool:\r
	159	1) use '#' to indicate flash generation progress.\r
	160	2) use -v to switch on detail output messages.\r
	161	\r
	162	Code Change :\r
	163	1) BaseTools/Bin/Win32/GenFds.exe\r
	164	\r
	165	==========================================================================================\r
	166	EDK_3789: Non-Compatible: lgao4\r
	167	\r
	168	Class_BuildTool: support new Rules format and PCD format defined in FDF file\r
	169	\r
	170	Code Change :\r
171	1) BaseTools/Bin/Win32/build.exe\r
172	2) BaseTools/Bin/Win32/GenFds.exe\r
173	\r
174	Possible Impacts:\r
8fb31ab7	175	1) All platform's FDF file, if any, must be changed to new format.\r
7eb4be18 LG	176	a) PCD format is changed from old PcdName to new PcdTokenSpaceGuid.PcdName, \r
	177	for example PcdWinNtFdBaseAddress in old FDF file will be replaced \r
	178	by gEfiNt32PkgTokenSpaceGuid.PcdWinNtFdBaseAddres.\r
	179	b) Rule format adds binary file type and file postfix name support, \r
	180	and doesn't require the full file path. Examples for Peim and AcpiTable module:\r
8fb31ab7 LG	181	Old Peim Rule:\r
	182	[Rule.Common.PEIM]\r
	183	FILE PEIM = $(NAMED_GUID) {\r
	184	PEI_DEPEX Optional $(INF_OUTPUT)/$(MODULE_NAME).Depex\r
	185	PE32 $(INF_OUTPUT)/$(MODULE_NAME).efi\r
	186	UI Optional $(MODULE_NAME)\r
	187	VERSION Optional BUILD_NUM=$(BUILD_NUMBER) $(INF_VERSION)\r
	188	}\r
	189	New Peim Rule:\r
	190	[Rule.Common.PEIM]\r
	191	FILE PEIM = $(NAMED_GUID) {\r
	192	PEI_DEPEX PEI_DEPEX Optional \|.Depex\r
	193	PE32 PE32 \|.efi\r
	194	UI STRING="$(MODULE_NAME)" Optional \r
	195	VERSION STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER) \r
	196	}\r
38f2ab29	197	\r
7eb4be18 LG	198	Old AcpiTable Rule:\r
	199	[Rule.Common.DXE_DRIVER.ACPITABLE]\r
	200	FILE FREEFORM = $(NAMED_GUID) {\r
	201	RAW $(INF_OUTPUT)/Madt.acpi\r
	202	RAW $(INF_OUTPUT)/Fadt.acpi\r
	203	RAW $(INF_OUTPUT)/Facs.acpi\r
	204	RAW $(INF_OUTPUT)/Spcr.acpi\r
	205	RAW $(INF_OUTPUT)/Dsdt.aml\r
	206	}\r
	207	New AcpiTable Rule:\r
	208	[Rule.Common.DXE_DRIVER.ACPITABLE]\r
	209	FILE FREEFORM = $(NAMED_GUID) {\r
	210	RAW ACPI \|.acpi\r
	211	RAW ASL \|.aml\r
	212	}\r
	213	\r
38f2ab29	214	==========================================================================================\r
	215	EDK_3786: Compatible: vjeff\r
	216	\r
	217	Class_BuildConfiguration:\r
	218	1) Redirect ICC_IA32_*_PATH from C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin \r
	219	to C:\Program Files\Intel\Compiler\C++\9.1\IA32\Bin. \r
	220	2) Add ICC X64 definition to enable ICC X64 build.\r
	221	\r
	222	Code Change :\r
	223	1) BaseTools/Conf/tools_def.template\r
	224	\r
	225	==========================================================================================\r
	226	EDK_3785: Non-Compatible: klu2\r
	227	\r
	228	Class_BuildTool: Upgrade the format of EFI_PEIM_ENTRY_POINT to \r
	229	EFI_PEIM_ENTRY_POINT2 according to PI specification.\r
	230	\r
	231	\r
	232	Code Change :\r
	233	1) BaseTools/Bin/Win32/build.exe\r
	234	\r
	235	Possible Impacts:\r
	236	1) All modules build\r
	237	\r
	238	\r
	239	==========================================================================================\r
	240	EDK_3780: Non-Compatible: qhuang8\r
	241	\r
	242	Class_MigrationTool: Update the syntax of PCD section.\r
	243	Update the syntax of binary INF file\r
	244	The generated Extended INF file should follow Extended INF spec 0.44\r
	245	\r
	246	Code Change :\r
	247	1) BaseTools/Bin/Win32/MigrationMsa2Inf.exe\r
	248	\r
	249	Possible Impacts:\r
	250	1) New module migrated from old R9\r
	251	\r
	252	\r
	253	==========================================================================================\r
	254	EDK_3766: Non-Compatible: lgao4\r
	255	\r
	256	Class_BuildConfiguration: Update Acpi Asl file Build rule to remove trim step.\r
	257	\r
	258	Code Change :\r
	259	1) Conf/build_rule.template\r
	260	\r
	261	Possible Impacts:\r
7eb4be18 LG	262	1) Platform with ACPI module. Acpi module needs to set /EP preprocessor compiler option \r
7eb4be18 LG	263	for APP_FLAGS in module inf to override the default /E option defined in tools_def.txt file. \r
38f2ab29	264	\r
1b7f7985	265	\r