[mirror_edk2.git] / MdeModulePkg / 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
\r
\r
\r
==========================================================================================\r
EDK_3773:  Non-Compatible: qwang12\r
\r
	  Class_PIEnable[0]:  Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.\r
\r
		Code Change :\r
		1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only\r
		   EFI_FIRMWARE_VOLUME2_PROTOCOL.	Previously, EFI_FIRMWARE_VOLUME_PROTOCOL\r
		   is produced by Dxe Core.\r
\r
		Possible Impacts:\r
		1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use\r
	 	   EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
		2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to\r
		   use gEfiFirmwareVolume2ProtocolGuid.\r
		3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.\r
		   And the package dependency should also be changed if needed due to this protocol\r
		   GUID change.\r
\r
==========================================================================================\r
EDK_3871: Non-Compatible: klu2\r
	\r
	Class_PIEnable[1]: Use new entry point for PeiCore defined in PI specification.\r
	\r
	Code Change:\r
	1) PeiMain module use PeiCoreEntryPoint library class but *not* original OldPeiCoreEntryPoint.\r
	2) The memory service in PeiMain module get CAR base and size from parameter of PeiCore's\r
	   Entry point directly but *not* computed from stack's base.\r
	\r
	Possible Impacts:\r
	1) Platform should select MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.inf for \r
	   PeiMain module.\r
	2) The SecCore module should provide parameters for new entry point defined in \r
	   MdePkg\Include\Library\PeiCoreEntryPoint.h\r
\r
==========================================================================================\r
EDK_3922:  Non-Compatible: qwang12, klu2\r
  Class_PIEnable[2]:  Update PEI core to only consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI\r
\r
  Code Change :\r
  1) Update PEI core to consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI to get the location of new FVs other than BFV\r
     reported by PEIMs . \r
\r
  Possible Impacts:\r
  1) Platform code that is going to inform PEI core about the new FVs other than BFV should install \r
     EFI_PEI_FIRMWARE_VOLUME_INFO_PPI. A library function named PeiPiLibBuildPiFvInfoPpi() defined in \r
     MdePkg\Include\Library\PeiPiLib.h can be used to install the PPI. \r
     There are two notes worth mentioning:\r
     1) Platform PEIMs should report at least FVs containing DXE_CORE and all other PEIM to PEI Core if they\r
        are not in the BFV. \r
     2) PEI core will dispatch PEIMs in the FV reported by PeiPiLibBuildPiFvInfoPpi() and invoke BuildFvHob () to build the \r
        FV HOB for this FV (see Section 4.8.1.2 of Vol 1 named Multiple Firmware Volume Support for details). \r
        If PEIM only want to inform DXE core about the existance of the new FV, it should call BuildFvHob instead.\r
  \r
  \r
  Class_PIEnable[3]:  Update PEI core to support RegisterForShadow feature introduced by PI spec\r
\r
     Code Change :\r
     1) DXEIPL no longer produce EFI_PEI_FV_FILE_LOADER_PPI defined in Framework PEI CIS.\r
\r
     Possible Impacts:\r
\r
     1)All PEIMs that need to shadow itself into memory and rerun the entry point should be updated to call RegisterForShadow\r
     (PeiServicesLibRegisterForShadow () is a helper function).\r
     2)The depex of PEIMs that including EFI_PEI_FV_FILE_LOADER_PPI (or gEfiPeiFvFileLoaderPpiGuid) should be removed.\r
 \r
\r
  Class_PIEnable[4]:  Update PEI core to produce other new features defined in PI spec\r
\r
      Code Change :\r
      1) Add the following services: FfsGetFileInfo, FfsFindFileByName and FfsGetVolumeInfo\r
\r
      Possible Impacts:\r
\r
      1) Platform code is recommended to make use of these new PI features. The functions in MdePkg/Include/Library/PeiServicesLib.h are \r
         recommended as PeiServices is saved for every PEI Services API invokation.\r
\r
	   \r
==========================================================================================\r
EDK_3866:  Compatible: qhuang8\r
\r
	  Class_UefiEnable[0]:  Uefi2.1 feature - Add Hardware Error Record Persistence Support \r
		Code Change :\r
		1) Modify MdeModulePkg/Universal/Variable/RuntimeDxe\r
                2) Modify MdeModulePkg/Universal/Variable/EmuRuntimeDxe\r
Commit	Line	Data
5182bf8e	1	##########################################################################################\r
	2	!!!!!!!!!!!!!!!!! Notes for this ChangeLog.txt !!!!!!!!!!!!!!!!!\r
	3	\r
	4	This log file is used to record two kinds of important information:\r
	5	a) "Non-Compatible Changes": all non-compatible changes should be recorded. These info\r
	6	will help the package user to merge this package; and some non-compatible changes\r
	7	can also be added into release notes as news features when we release this package.\r
	8	Normally Non-Compatible Changes contains the following types:\r
	9	1) Package's external services were changed/updated\r
	10	2) Package's common .h file is renamed, deleted, or the file path is changed.\r
	11	3) The definition of package's common data structure is changed\r
	12	...\r
	13	\r
	14	b) "Important Compatible Changes": some important compatible changes can aslo be recorded\r
	15	in this file, and we can add these updating into release notes when we release this\r
	16	package.\r
	17	\r
	18	Non-Compatible and Compatible example format:\r
	19	==========================================================================================\r
	20	EDK_0010: Non-Compatible: owner\r
	21	\r
	22	Class_HFile: PPI A of MdePkg has been removed.\r
	23	\r
	24	Code Change :\r
	25	1) Removed the .h file: MdePkg\Include\Ppi\A.h\r
	26	\r
	27	Possible Impacts:\r
	28	1) All modules that used this PPI A should be updated.\r
	29	\r
	30	==========================================================================================\r
	31	EDK_0000: Compatible: owner\r
	32	\r
	33	Class_BuildTool: with the EDK_0000 build.exe, the build performance is enhanced great.\r
	34	\r
	35	Code Change :\r
	36	1) BaseTools\Bin\Win32\build.exe\r
	37	\r
	38	!!!!!!!!!!!!!!!!!! End of Notes !!!!!!!!!!!!!!!!!!\r
	39	##########################################################################################\r
	40	\r
	41	\r
	42	\r
	43	\r
	44	==========================================================================================\r
	45	EDK_3773: Non-Compatible: qwang12\r
	46	\r
	47	Class_PIEnable[0]: Enable DXE Core to produce EFI_FIRMWARE_VOLUME2_PROTOCOL only.\r
	48	\r
	49	Code Change :\r
	50	1) Modify MdeModulePkg/Core/Dxe/DxeMain.inf module to produce only\r
	51	EFI_FIRMWARE_VOLUME2_PROTOCOL. Previously, EFI_FIRMWARE_VOLUME_PROTOCOL\r
	52	is produced by Dxe Core.\r
	53	\r
	54	Possible Impacts:\r
	55	1) All modules that references EFI_FIRMWARE_VOLUME_PROTOCOL must be updated to use\r
	56	EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
	57	2) All modules that references gEfiFirmwareVolumeProtocolGuid must be updated to\r
	58	use gEfiFirmwareVolume2ProtocolGuid.\r
	59	3) The gEfiFirmwareVolumeProtocolGuid in [Depex] section of INF file should updated.\r
	60	And the package dependency should also be changed if needed due to this protocol\r
	61	GUID change.\r
c6492839	62	\r
6a9d345a	63	==========================================================================================\r
	64	EDK_3871: Non-Compatible: klu2\r
	65	\r
	66	Class_PIEnable[1]: Use new entry point for PeiCore defined in PI specification.\r
	67	\r
	68	Code Change:\r
	69	1) PeiMain module use PeiCoreEntryPoint library class but not original OldPeiCoreEntryPoint.\r
	70	2) The memory service in PeiMain module get CAR base and size from parameter of PeiCore's\r
	71	Entry point directly but not computed from stack's base.\r
	72	\r
	73	Possible Impacts:\r
	74	1) Platform should select MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.inf for \r
	75	PeiMain module.\r
	76	2) The SecCore module should provide parameters for new entry point defined in \r
	77	MdePkg\Include\Library\PeiCoreEntryPoint.h\r
b4f5f5d6	78	\r
	79	==========================================================================================\r
	80	EDK_3922: Non-Compatible: qwang12, klu2\r
	81	Class_PIEnable[2]: Update PEI core to only consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI\r
	82	\r
	83	Code Change :\r
	84	1) Update PEI core to consume EFI_PEI_FIRMWARE_VOLUME_INFO_PPI to get the location of new FVs other than BFV\r
	85	reported by PEIMs . \r
	86	\r
	87	Possible Impacts:\r
	88	1) Platform code that is going to inform PEI core about the new FVs other than BFV should install \r
	89	EFI_PEI_FIRMWARE_VOLUME_INFO_PPI. A library function named PeiPiLibBuildPiFvInfoPpi() defined in \r
	90	MdePkg\Include\Library\PeiPiLib.h can be used to install the PPI. \r
	91	There are two notes worth mentioning:\r
	92	1) Platform PEIMs should report at least FVs containing DXE_CORE and all other PEIM to PEI Core if they\r
	93	are not in the BFV. \r
	94	2) PEI core will dispatch PEIMs in the FV reported by PeiPiLibBuildPiFvInfoPpi() and invoke BuildFvHob () to build the \r
	95	FV HOB for this FV (see Section 4.8.1.2 of Vol 1 named Multiple Firmware Volume Support for details). \r
	96	If PEIM only want to inform DXE core about the existance of the new FV, it should call BuildFvHob instead.\r
	97	\r
	98	\r
	99	Class_PIEnable[3]: Update PEI core to support RegisterForShadow feature introduced by PI spec\r
	100	\r
	101	Code Change :\r
	102	1) DXEIPL no longer produce EFI_PEI_FV_FILE_LOADER_PPI defined in Framework PEI CIS.\r
	103	\r
	104	Possible Impacts:\r
	105	\r
	106	1)All PEIMs that need to shadow itself into memory and rerun the entry point should be updated to call RegisterForShadow\r
	107	(PeiServicesLibRegisterForShadow () is a helper function).\r
	108	2)The depex of PEIMs that including EFI_PEI_FV_FILE_LOADER_PPI (or gEfiPeiFvFileLoaderPpiGuid) should be removed.\r
	109	\r
	110	\r
	111	Class_PIEnable[4]: Update PEI core to produce other new features defined in PI spec\r
	112	\r
	113	Code Change :\r
	114	1) Add the following services: FfsGetFileInfo, FfsFindFileByName and FfsGetVolumeInfo\r
	115	\r
	116	Possible Impacts:\r
	117	\r
	118	1) Platform code is recommended to make use of these new PI features. The functions in MdePkg/Include/Library/PeiServicesLib.h are \r
	119	recommended as PeiServices is saved for every PEI Services API invokation.\r
	120	\r
6a9d345a	121	\r
c6492839	122	==========================================================================================\r
e4b561fb	123	EDK_3866: Compatible: qhuang8\r
c6492839	124	\r
	125	Class_UefiEnable[0]: Uefi2.1 feature - Add Hardware Error Record Persistence Support \r
	126	Code Change :\r
	127	1) Modify MdeModulePkg/Universal/Variable/RuntimeDxe\r
	128	2) Modify MdeModulePkg/Universal/Variable/EmuRuntimeDxe\r