EdkCompatibilityPkg/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 EDK_r5418-5419: Non-Compatible: qhuang8
  42         Class_Library: Update EfiDriverLib in ECP to make it compatible with EDK1.01(EDK1117),
  43                                    but the change itself is incompatible.
  44     With this change, EFI1.10 drivers can be directly dropped
  45     in and built in UEFI build mode. EfiLibInstallAllDriverProtocols2() and
  46     INSTALL_ALL_DRIVER_PROTOCOLS_OR_PROTOCOLS2() are added to support UEFI driver
  47     model protocols. Please replace all the occurrences of EfiLibInstallAllDriverProtocols
  48     and INSTALL_ALL_DRIVER_PROTOCOLS with INSTALL_ALL_DRIVER_PROTOCOLS_OR_PROTOCOLS2
  49     in Edk 1.04 based source tree.
  50
  51     Code Change:
  52     1) Edk\Foundation\Include\EfiCompNameSupport.h:
  53            Add macro INSTALL_ALL_DRIVER_PROTOCOLS_OR_PROTOCOLS2().
  54     2) Edk\Foundation\Library\Dxe\EfiDriverLib\EfiDriverModelLib.c
  55        Edk\Foundation\Library\Dxe\Include\EfiDriverLib.h
  56        Update EfiLibInstallAllDriverProtocols() and add EfiLibInstallAllDriverProtocols2()
  57
  58         Possible impact:
  59         1) If your "EDK style" code base is based on ECP r5417 or below, please replace all the
  60            occurrences of EfiLibInstallAllDriverProtocols and INSTALL_ALL_DRIVER_PROTOCOLS with
  61            INSTALL_ALL_DRIVER_PROTOCOLS_OR_PROTOCOLS2
  62
  63
  64 ==========================================================================================
  65 EDK_r4955: Non-Compatible: qhuang8
  66
  67         Class_HFile: Update the Device Type Value of MEDIA_FV_DP & MEDIA_FV_FILEPATH_DP.
  68         The definitions in MdePkg have already been updated in r4632. This will remove the
  69         potential compatibility issues when native EDK II modules & EDK modules built with
  70         ECP and run with EDK II core.
  71
  72         Code Change:
  73         1) Reverse the value of MEDIA_FV_DP & MEDIA_FV_FILEPATH_DP to fix a UEFI errata.
  74
  75
  76         Possible impact:
  77         1) EDK I modules built with this update might not work with old EDK environment.
  78
  79
  80 ==========================================================================================
  81 EDK_r4960: Non-Compatible: qhuang8
  82
  83         Class_HFile: Remove the default value 0xE0000000 of EDKII_GLUE_PciExpressBaseAddress.
  84         It now requires platform DSC file to specify it explicitly to avoid runtime issue
  85         if they ever uses PciExpressLib in EDK GlueLib.
  86         Unlike other default value in GlueLib, this value might not function for all real
  87         platforms.
  88
  89         Code Change:
  90         1) Replace 0xE0000000 to be PCD_EDKII_GLUE_PciExpressBaseAddress.
  91
  92         Possible impact:
  93         1) If a platform ever uses PciExpressLib in Glue Lib. It needs to explictly specify
  94         the value of PCD_EDKII_GLUE_PciExpressBaseAddress for their platform to function.
  95         e.g. in EDK II DSC file to build EDK modules:
  96         [BuildOptions]
  97           *_*_*_CC_FLAGS = /D PCD_EDKII_GLUE_PciExpressBaseAddress=0xC0000000
  98