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