MdeModulePkg/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_3871: Non-Compatible: klu2
  43
  44         Class_PIEnable[5]: New library class for S3Resume and Recovery for DxeIpl PEIM.
  45
  46         Code Change:
  47         1) Add new library class
  48            a) MdeModulePkg/Include/Library/S3Lib.h
  49            b) MdeModulePkg/Include/Library/RecoveryLib.h
  50         2) Add NULL library instances for MdeModulePkg:
  51            a) MdeModulePkg/Library/PeiS3Lib.inf.
  52            b) MdeModulePkg/Library/PeiRecoveryLib.inf
  53         3) Add framework implement library instances:
  54            a) IntelFrameworkModulePkg/Library/PeiS3Lib.inf
  55            b) IntelFrameworkModulePkg/Library/PeiRecovery.inf
  56
  57         Possible Impacts:
  58         1) In DSC file, if platform use framework implementation, should select:
  59            S3Lib library class       -> IntelFrameworkModulePkg/Library/PeiS3Lib.inf
  60            RecoveryLib library class -> IntelFrameworkModulePkg/Library/PeiRecovery.inf
  61
  62 ==========================================================================================
  63 EDK_3922:  Non-Compatible: qwang12, klu2
  64   Class_PIEnable[2]:  Update PEI core to only consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI
  65
  66   Code Change :
  67   1) Update PEI core to consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI to get the location of new FVs other than BFV
  68      reported by PEIMs .
  69
  70   Possible Impacts:
  71   1) Platform code that is going to inform PEI core about the new FVs other than BFV should install
  72      EFI_PEI_FIRMWARE_VOLUME_INFO_PPI. A library function named PeiPiLibBuildPiFvInfoPpi() defined in
  73      MdePkg\Include\Library\PeiPiLib.h can be used to install the PPI.
  74      There are two notes worth mentioning:
  75      1) Platform PEIMs should report at least FVs containing DXE_CORE and all other PEIM to PEI Core if they
  76         are not in the BFV.
  77      2) PEI core will dispatch PEIMs in the FV reported by PeiPiLibBuildPiFvInfoPpi() and invoke BuildFvHob () to build the
  78         FV HOB for this FV (see Section 4.8.1.2 of Vol 1 named Multiple Firmware Volume Support for details).
  79         If PEIM only want to inform DXE core about the existance of the new FV, it should call BuildFvHob instead.
  80
  81
  82   Class_PIEnable[3]:  Update PEI core to support RegisterForShadow feature introduced by PI spec
  83
  84      Code Change :
  85      1) DXEIPL no longer produce EFI_PEI_FV_FILE_LOADER_PPI defined in Framework PEI CIS.
  86
  87      Possible Impacts:
  88
  89      1)All PEIMs that need to shadow itself into memory and rerun the entry point should be updated to call RegisterForShadow
  90      (PeiServicesLibRegisterForShadow () is a helper function).
  91      2)The depex of PEIMs that including EFI_PEI_FV_FILE_LOADER_PPI (or gEfiPeiFvFileLoaderPpiGuid) should be removed.
  92
  93
  94   Class_PIEnable[4]:  Update PEI core to produce other new features defined in PI spec
  95
  96       Code Change :
  97       1) Add the following services: FfsGetFileInfo, FfsFindFileByName and FfsGetVolumeInfo
  98
  99       Possible Impacts:
 100
 101       1) Platform code is recommended to make use of these new PI features. The functions in MdePkg/Include/Library/PeiServicesLib.h are
 102          recommended as PeiServices is saved for every PEI Services API invokation.
 103
 104 ==========================================================================================
 105 EDK_3871: Non-Compatible: klu2
 106
 107         Class_PIEnable[1]: Use new entry point for PeiCore defined in PI specification.
 108
 109         Code Change:
 110         1) PeiMain module use PeiCoreEntryPoint library class but *not* original OldPeiCoreEntryPoint.
 111         2) The memory service in PeiMain module get CAR base and size from parameter of PeiCore's
 112            Entry point directly but *not* computed from stack's base.
 113
 114         Possible Impacts:
 115         1) Platform should select MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.inf for
 116            PeiMain module.
 117         2) The SecCore module should provide parameters for new entry point defined in
 118            MdePkg\Include\Library\PeiCoreEntryPoint.h
 119
 120 ==========================================================================================
 121 EDK_3866:  Compatible: qhuang8
 122
 123           Class_UefiEnable[0]:  Uefi2.1 feature - Add Hardware Error Record Persistence Support
 124                 Code Change :
 125                 1) Modify MdeModulePkg/Universal/Variable/RuntimeDxe
 126                 2) Modify MdeModulePkg/Universal/Variable/EmuRuntimeDxe
 127
 128 ==========================================================================================
 129 EDK_3773:  Non-Compatible: qwang12
 130
 131           Class_PIEnable[0]:  Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.
 132
 133                 Code Change :
 134                 1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only
 135                    EFI_FIRMWARE_VOLUME2_PROTOCOL.       Previously, EFI_FIRMWARE_VOLUME_PROTOCOL
 136                    is produced by Dxe Core.
 137
 138                 Possible Impacts:
 139                 1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use
 140                    EFI_FIRMWARE_VOLUME2_PROTOCOL.
 141                 2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to
 142                    use gEfiFirmwareVolume2ProtocolGuid.
 143                 3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.
 144                    And the package dependency should also be changed if needed due to this protocol
 145                    GUID change.