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