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