X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FChangeLog.txt;h=86cb910fb3b38a25ae3fa88f4ea38147f42b00b0;hb=c3d4e543f0c9e88ca2ad924827a2b663dfed5a5d;hp=570d134a42f5faca5b65407b17828f5f88c2d74b;hpb=63e4bea4445f168de5a5f810371c1ae62c1f208b;p=mirror_edk2.git diff --git a/MdePkg/ChangeLog.txt b/MdePkg/ChangeLog.txt index 570d134a42..86cb910fb3 100644 --- a/MdePkg/ChangeLog.txt +++ b/MdePkg/ChangeLog.txt @@ -109,3 +109,137 @@ EDK_3922: Non-Compatible: qwang12, klu2 also provide convinient way to retrieve the pointer to Pei Service Table. +EDK_4067: Non-Compatible: qwang12 + Class_PIEnable[1]: Add PeiPiLib library class and replace PiLib with DxePiLib library class. + + Code Change : + 1) Change MdePkg/Include/Library/PiLib.h to MdePkg/Include/Library/DxePiLib.h. DxePiLib is mainly used + for modules in DXE phase. Add a DxePiLib.h library instance at MdePkg/Library/DxePiLib/DxePiLib.inf. + 2) Add MdePkg/Include/Library/PeiPiLib.h. PeiPiLib is mainly used by modules in PEI phase. + Add a DxePiLib.h library instance at MdePkg/Library/PeiPiLib/PeiPiLib.inf. + 3) Rename API in PeiPiLib.h from PeiPiLibBuildPiFvInfoPpi to PiLibInstallFvInfoPpi. + 4) Rename APIs originally in PiLib.h with new names defined in DxePiLib.h: + 4.1) GetSectionFrom*Fv functions are changed to PiLibGetSectionFrom*Fv to reduce possibility of name collision. + 4.2) Remove API named ImageHandleToFvHandle and GetSectionFromFvFile + + + Possible Impacts: + + 1) Platform modules that reference PeiPiLibBuildPiFvInfoPpi and GetSectionFrom*Fv should reference the new + names defined. + 2) Platform DSC file that specifying library instance for PiLib should be updated to add one line (a example + is given below): + [LibraryClasses.common.DXE_DRIVER] + ... + DxePiLib|MdePkg/Library/DxePiLib/DxePiLib.inf + ... + 3) Platform DSC file including modules that make use of API from PeiPiLib.h should add the following line (a example + is given below): + [LibraryClasses.common.PEIM] + ... + PeiPiLib|MdePkg/Library/PeiPiLib/PeiPiLib.inf + ... + + +EDK_5835: Non-Compatible: qwang12 + Class General Definitions: NULL_HANDLE definition is removed from UefiBaseType.h. If any modules referencs NULL_HANDLE, they should be updated to use NULL. + +EDK_5869: Non-Compatible: qhuang8 + Class General Definitions: Update the macro ALIGN_VARIALBE to drop the second parameter. + + Code Change: + The macro ALIGN_VARIABLE in base.h is changed to keep the first paramter + + Possible Impacts: + Modules using this macro, it needs to adapt to new interface. + +EDK_5939: Non-Compatible: qwang12 + Library API moved from HiiLib to UefiLib. + + Code Change: + Change HiiLibGetCurrentLanguage to GetCurrentLanguage and moved it from HiiLib to UefiLib. + + Possible Impacts: + All module that reference HiiLibGetCurrentLanguage should be updated in the following step: + 0) Change HiiLibGetCurrentLanguage to GetCurrentLanguage. + 1) Add UefiLib to [LibraryClass] in INF if it is not included before. + 2) Remove HiiLib from [LibraryClass] if HiiLibGetCurrentLanguage is the only API from original HiiLib referenced by this module. + 3) Add UefiLib to [LibraryClasses.common.Module Type] for the affected module if UefiLib is not in the list. + +EDK_5989: Non-Compatible: qwang12 + Library API name changed: + In IfrSupportLib, + Rename BufToHexString to BufInReverseOrderToHexString + Rename HexStringToBuf to HexStringToBufInReverseOrder + +Possible Impacts: + All module that reference BufToHexString or HexStringToBuf should be updated in the following step: + 0) Change HiiLibGetCurrentLanguage to GetCurrentLanguage. + 1) Change BufToHexString to BufInReverseOrderToHexString + 2) Change HexStringToBuf to HexStringToBufInReverseOrder + +EDK_6111: Non-Compatible: qwang12 + Module type Include file is not included on default. + In Protocol/PPI/GUID/Libary header file, the "#include" of the module type header file such as , , and + are removed. The module (DXE driver, UEFI Driver, PEIM) should include these files if required. + +Possible Impacts: + Customer's module (DXE driver, UEFI Driver, PEIM) may failed to build as module type header file such as , , + is removed from the Protocol/PPI/GUID/Libary header file. If the module can build before the update but failed after the update + because of some undefined basic data type such as "EFI_GUID", module developer should include the module type header file accordingly. + +EDK_6131: Non-Compatible: qwang12 + +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. + +Possible Impacts: + Customer's module that reference GetPeiServicesTablePointer in PeiServicesTablePointer library may need to updated. Otherwise + a build break (mismatch of data type) may occur. + +EDK_6307: Non-Compatible: qwang12 + +Remove SafeFreePool from MemoryAllocationLib as this API's name is misleading. Its implementation only check if a pointer is NULL. If a garbage pointer is passed in, the gBS->FreePool will still ASSERT in debug build and return error code. + +It is recommended that module writer should keep track how a pointer is allocated and free it after use. + +Possible Impacts: + Customer's module that reference SafeFreePool need to updated. Otherwise + a build break may occur. + +EDK_6496-6519: Non-Compatible: qhuang8 + + A bundle of library class/instance renames, moves and merges: + 1. Rename library class UsbLib to UefiUsbLib + 2. Rename library class ScsiLib to UefiScsiLib + 3. Rename library class PalCallLib to PalLib + 4. Rename library class DxePiLib to DxeSerivcesLib and drop the prefix "PiLib" to all its APIs. + 5. Merge library class PiPeiLib to PeiServicesLib and rename the PiLibInstallFvInfoPpi() to PeiServicesInstallFvInfoPpi() + 6. Move library class HiiLib to MdeModulePkg + 7. Move library class IfrSupportLib to MdeModulePkg + 8. Move library class FvbServiceLib to MdeModulePkg + 9. Rename library instance of BasePalCallLibNull to BasePalLibNull + 10. Move library instance UefiHiiLib to MdeModulePkg + 11. Move library instance UefiIfrSupportLib to MdeModulePkg + +Possible Impacts: + Every change listed above is non-backward compatible for MdePkg and other packages. It is required to update module + sources (*.c;*.h), module meta data files (*.inf) and update the platform DSC files to fix the build break. + However, it is less likely to bring about functional issue for these updates. + + +EDK_6565: Non-Compatible: qhuang8 + + Remove some macro in UefiScsiLib: + EFI_SCSI_STALL_1_MICROSECOND, EFI_SCSI_STALL_1_MILLISECOND, EFI_SCSI_STALL_1_SECOND & EFI_SCSI_STALL_SECONDS(a) + +Possible Impacts: + Modules depending on UefiScsiLib for these macros should update the source to use new UefiLib macros + EFI_TIMER_PERIOD_MICROSECONDS(X), EFI_TIMER_PERIOD_MILLISECONDS(X) and EFI_TIMER_PERIOD_SECONDS(X) for managing Timer Events. + Especailly, EFI_SCSI_STALL_SECONDS(a) is simply replaced by EFI_TIMER_PERIOD_SECONDS(a) + +EDK_6886: Non-Compatible: mdkinney + + Rename _CR macro in MdePkg\Include\Base.h to BASE_CR macro aligned to MdeLib spec. + +Possible Impacts: + All source codes that depends on _CR macro must be changed to use BASE_CR.