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