]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/ChangeLog.txt
Coding style fix.
[mirror_edk2.git] / MdePkg / ChangeLog.txt
index 570d134a42f5faca5b65407b17828f5f88c2d74b..30c8bf7c96b0ef21fe01748b0ccc86c4654b6306 100644 (file)
@@ -109,3 +109,90 @@ EDK_3922:  Non-Compatible: qwang12, klu2
          also provide convinient way to retrieve the pointer to Pei Service Table.\r
          \r
 \r
+EDK_4067:  Non-Compatible: qwang12\r
+  Class_PIEnable[1]:  Add PeiPiLib library class and replace PiLib with DxePiLib library class.\r
+\r
+      Code Change :\r
+      1) Change MdePkg/Include/Library/PiLib.h to MdePkg/Include/Library/DxePiLib.h. DxePiLib is mainly used\r
+         for modules in DXE phase. Add a DxePiLib.h library instance at MdePkg/Library/DxePiLib/DxePiLib.inf.\r
+      2) Add MdePkg/Include/Library/PeiPiLib.h. PeiPiLib is mainly used by modules in PEI phase. \r
+         Add a DxePiLib.h library instance at MdePkg/Library/PeiPiLib/PeiPiLib.inf.\r
+      3) Rename API in PeiPiLib.h from PeiPiLibBuildPiFvInfoPpi to PiLibInstallFvInfoPpi.\r
+      4) Rename APIs originally in PiLib.h with new names defined in DxePiLib.h:\r
+          4.1) GetSectionFrom*Fv functions are changed to PiLibGetSectionFrom*Fv to reduce possibility of name collision.\r
+          4.2) Remove API named ImageHandleToFvHandle and GetSectionFromFvFile \r
+\r
+\r
+      Possible Impacts:\r
+\r
+      1) Platform modules that reference PeiPiLibBuildPiFvInfoPpi and GetSectionFrom*Fv should reference the new\r
+         names defined.\r
+      2) Platform DSC file that specifying library instance for PiLib should be updated to add one line (a example \r
+         is given below):\r
+          [LibraryClasses.common.DXE_DRIVER]\r
+              ...\r
+              DxePiLib|MdePkg/Library/DxePiLib/DxePiLib.inf\r
+              ...\r
+      3) Platform DSC file including modules that make use of API from PeiPiLib.h should add the following line (a example \r
+         is given below):\r
+          [LibraryClasses.common.PEIM]\r
+              ...\r
+              PeiPiLib|MdePkg/Library/PeiPiLib/PeiPiLib.inf\r
+              ...\r
+          \r
+\r
+EDK_5835:  Non-Compatible: qwang12\r
+  Class General Definitions: NULL_HANDLE definition is removed from UefiBaseType.h. If any modules referencs NULL_HANDLE, they should be updated to use NULL. \r
+  \r
+EDK_5869:  Non-Compatible: qhuang8\r
+  Class General Definitions: Update the macro ALIGN_VARIALBE to drop the second parameter.\r
+  \r
+               Code Change:\r
+                       The macro ALIGN_VARIABLE in base.h is changed to keep the first paramter\r
+\r
+               Possible Impacts:\r
+                       Modules using this macro, it needs to adapt to new interface.\r
+                       \r
+EDK_5939:  Non-Compatible: qwang12\r
+  Library API moved frrom HiiLib to UefiLib.\r
+  \r
+               Code Change:\r
+                       Change HiiLibGetCurrentLanguage to GetCurrentLanguage and moved it from HiiLib to UefiLib.\r
+\r
+               Possible Impacts:\r
+                       All module that reference HiiLibGetCurrentLanguage should be updated in the following step:\r
+                         0) Change HiiLibGetCurrentLanguage to GetCurrentLanguage.\r
+                               1) Add UefiLib to [LibraryClass] in INF if it is not included before.\r
+                               2) Remove HiiLib from [LibraryClass] if HiiLibGetCurrentLanguage is the only API from original HiiLib referenced by this module.\r
+                               3) Add UefiLib to [LibraryClasses.common.Module Type] for the affected module if UefiLib is not in the list.\r
+                               \r
+EDK_5989:  Non-Compatible: qwang12\r
+  Library API name changed:\r
+   In IfrSupportLib,\r
+        Rename BufToHexString to BufInReverseOrderToHexString \r
+   Rename HexStringToBuf to HexStringToBufInReverseOrder\r
+\r
+Possible Impacts:\r
+                       All module that reference BufToHexString or HexStringToBuf should be updated in the following step:\r
+                         0) Change HiiLibGetCurrentLanguage to GetCurrentLanguage.\r
+                               1) Change BufToHexString to BufInReverseOrderToHexString \r
+                         2) Change HexStringToBuf to HexStringToBufInReverseOrder\r
+\r
+EDK_6111:  Non-Compatible: qwang12\r
+  Module type Include file is not included on default.\r
+   In Protocol/PPI/GUID/Libary header file, the "#include" of the module type header file such as <Base.h>, <PiPei.h>, <PiDxe.h> and \r
+   <Uefi.h> are removed. The module (DXE driver, UEFI Driver, PEIM) should include these files if required.\r
+\r
+Possible Impacts:\r
+                       Customer's module (DXE driver, UEFI Driver, PEIM) may failed to build as module type header file such as <Base.h>, <PiPei.h>, <PiDxe.h>\r
+                       <Uefi.h> is removed from the Protocol/PPI/GUID/Libary header file. If the module can build before the update but failed after the update\r
+                       because of some undefined basic data type such as "EFI_GUID", module developer should include the module type header file accordingly.\r
+                               \r
+EDK_6131:  Non-Compatible: qwang12\r
+\r
+Base on PI spec, GetPeiServicesTablePointer in PeiServicesTablePointer library is updated to return CONST EFI_PEI_SERVICES**. This is a incompatible changes. All file that reference this must be updated.\r
+\r
+Possible Impacts:\r
+                       Customer's module that reference GetPeiServicesTablePointer in PeiServicesTablePointer library may need to updated. Otherwise\r
+                       a build break (mismatch of data type) may occur.\r
+                       \r