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