Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / EdkCompatibilityPkg / ChangeLog.txt

##########################################################################################\r
!!!!!!!!!!!!!!!!!               Notes for this ChangeLog.txt             !!!!!!!!!!!!!!!!!\r
\r
This log file is used to record two kinds of important information:\r
 a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info\r
    will help the package user to merge this package; and some non-compatible changes\r
    can also be added into release notes as news features when we release this package.\r
    Normally Non-Compatible Changes contains the following types:\r
      1) Package's external services were changed/updated\r
      2) Package's common .h file is renamed, deleted, or the file path is changed.\r
      3) The definition of package's common data structure is changed\r
      ...\r
\r
 b) "Important Compatible Changes": some important compatible changes can aslo be recorded\r
    in this file, and we can add these updating into release notes when we release this\r
    package.\r
\r
Non-Compatible and Compatible example format:\r
==========================================================================================\r
EDK_0010: Non-Compatible: owner\r
\r
	  Class_HFile: PPI A of MdePkg has been removed.\r
\r
		Code Change :\r
		1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
\r
		Possible Impacts:\r
		1) All modules that used this PPI A should be updated.\r
\r
==========================================================================================\r
EDK_0000: Compatible: owner\r
\r
	  Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
\r
		Code Change :\r
		1) BaseTools\Bin\Win32\build.exe\r
\r
!!!!!!!!!!!!!!!!!!                     End of Notes                     !!!!!!!!!!!!!!!!!!\r
##########################################################################################\r
==========================================================================================\r
EDK_r5418-5419: Non-Compatible: qhuang8\r
	Class_Library: Update EfiDriverLib in ECP to make it compatible with EDK1.01(EDK1117),\r
				   but the change itself is incompatible.\r
    With this change, EFI1.10 drivers can be directly dropped\r
    in and built in UEFI build mode. EfiLibInstallAllDriverProtocols2() and\r
    INSTALL_ALL_DRIVER_PROTOCOLS_OR_PROTOCOLS2() are added to support UEFI driver\r
    model protocols. Please replace all the occurrences of EfiLibInstallAllDriverProtocols\r
    and INSTALL_ALL_DRIVER_PROTOCOLS with INSTALL_ALL_DRIVER_PROTOCOLS_OR_PROTOCOLS2\r
    in Edk 1.04 based source tree.\r
    \r
    Code Change:\r
    1) Edk\Foundation\Include\EfiCompNameSupport.h:\r
	   Add macro INSTALL_ALL_DRIVER_PROTOCOLS_OR_PROTOCOLS2().\r
    2) Edk\Foundation\Library\Dxe\EfiDriverLib\EfiDriverModelLib.c\r
       Edk\Foundation\Library\Dxe\Include\EfiDriverLib.h\r
       Update EfiLibInstallAllDriverProtocols() and add EfiLibInstallAllDriverProtocols2()\r
\r
	Possible impact:\r
	1) If your "EDK style" code base is based on ECP r5417 or below, please replace all the\r
	   occurrences of EfiLibInstallAllDriverProtocols and INSTALL_ALL_DRIVER_PROTOCOLS with\r
	   INSTALL_ALL_DRIVER_PROTOCOLS_OR_PROTOCOLS2\r
\r
\r
==========================================================================================\r
EDK_r4955: Non-Compatible: qhuang8\r
	\r
	Class_HFile: Update the Device Type Value of MEDIA_FV_DP & MEDIA_FV_FILEPATH_DP.\r
	The definitions in MdePkg have already been updated in r4632. This will remove the\r
        potential compatibility issues when native EDK II modules & EDK modules built with\r
        ECP and run with EDK II core.  \r
\r
	Code Change:\r
	1) Reverse the value of MEDIA_FV_DP & MEDIA_FV_FILEPATH_DP to fix a UEFI errata. \r
\r
\r
	Possible impact:\r
	1) EDK I modules built with this update might not work with old EDK environment. 	\r
\r
\r
==========================================================================================\r
EDK_r4960: Non-Compatible: qhuang8\r
	\r
	Class_HFile: Remove the default value 0xE0000000 of EDKII_GLUE_PciExpressBaseAddress.\r
	It now requires platform DSC file to specify it explicitly to avoid runtime issue\r
        if they ever uses PciExpressLib in EDK GlueLib.\r
        Unlike other default value in GlueLib, this value might not function for all real\r
        platforms.   \r
\r
	Code Change:\r
	1) Replace 0xE0000000 to be PCD_EDKII_GLUE_PciExpressBaseAddress. \r
\r
	Possible impact:\r
	1) If a platform ever uses PciExpressLib in Glue Lib. It needs to explictly specify\r
	the value of PCD_EDKII_GLUE_PciExpressBaseAddress for their platform to function.\r
	e.g. in EDK II DSC file to build EDK modules: \r
       	[BuildOptions]\r
          *_*_*_CC_FLAGS = /D PCD_EDKII_GLUE_PciExpressBaseAddress=0xC0000000\r
 \r
\r
EDK_r7286: Compatible: qhuang8\r
	\r
	Class_HFile: Add several new UEFI definition to build with newest EFI shell source.\r
\r
	Code Change:\r
	1) Add new UEFI Load File 2 protocol defininition.\r
	2) Add MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH device path type. \r
\r
	Possible impact:\r
  None.\r
\r
EDK_r7342: No-Compatible: qwang12\r
  Rename module names in EdkCompatibility/Compatibility directory from ***To*** to ***On***.\r
  For example, Fv2ToFvThunk is renamed to Fv2OnFvThunk.\r
  AAAOnBBB means this module produce AAA Protocol/PPI based on BBB. This change improves the readability and \r
  help developers to select correct thunk module to use.\r
\r
  Code Changes:\r
  These module directory and module INF file name is updated:\r
   DeviceIoToPciRootBridgeIoThunk -> DeviceIoToPciRootBridgeIoThunk\r
   FrameworkHiiToUefiHiiThunk  ->  FrameworkHiiToUefiHiiThunk\r
   Fv2ToFvThunk  -> Fv2ToFvThunk\r
   FvFileLoaderToLoadFileThunk  -> FvFileLoaderToLoadFileThunk\r
   FvToFv2Thunk  -> FvToFv2Thunk\r
   PciCfg2ToPciCfgThunk  -> PciCfg2ToPciCfgThunk\r
   PciCfgToPciCfg2Thunk  -> PciCfgToPciCfg2Thunk\r
   ReadOnlyVariable2ToReadOnlyVariableThunk  -> ReadOnlyVariable2ToReadOnlyVariableThunk\r
   ReadOnlyVariableToReadOnlyVariable2Thunk  -> ReadOnlyVariableToReadOnlyVariable2Thunk\r
   Uc2ToUcThunk  -> Uc2ToUcThunk\r
   UcToUc2Thunk  -> UcToUc2Thunk\r
   \r
  Possible Impact:\r
  All DSC and FDF files that reference these module should be updated to use the new module directory\r
  and file names.