MdePkg: Follow PI1.4a to update the comments of EndOfDxe and SmmReadyToLock

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>

3 files changed, 41 insertions, 20 deletions

diff --git a/MdePkg/Include/Protocol/DxeSmmReadyToLock.h b/MdePkg/Include/Protocol/DxeSmmReadyToLock.h
index 27045578aa..a52a8a2c34 100644
--- a/MdePkg/Include/Protocol/DxeSmmReadyToLock.h
+++ b/MdePkg/Include/Protocol/DxeSmmReadyToLock.h
@@ -1,11 +1,23 @@
 /** @file

-  DXE SMM Ready To Lock protocol as defined in the PI 1.2 specification.

-

-  This UEFI protocol indicates that SMM is about to be locked.

-  This protocol is a mandatory protocol published by a DXE driver prior to invoking the 

-  EFI_SMM_ACCESS2_PROTOCOL.Lock() function to lock SMM. 

-

-  Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>

+  DXE SMM Ready To Lock protocol introduced in the PI 1.2 specification.

+

+  According to PI 1.4a specification, this UEFI protocol indicates that

+  resources and services that should not be used by the third party code

+  are about to be locked.

+  This protocol is a mandatory protocol published by PI platform code.

+  This protocol in tandem with the End of DXE Event facilitates transition

+  of the platform from the environment where all of the components are

+  under the authority of the platform manufacturer to the environment where

+  third party extensible modules such as UEFI drivers and UEFI applications

+  are executed. The protocol is published immediately after signaling of the

+  End of DXE Event. PI modules that need to lock or protect their resources

+  in anticipation of the invocation of 3rd party extensible modules should

+  register for notification on installation of this protocol and effect the

+  appropriate protections in their notification handlers. For example, PI

+  platform code may choose to use notification handler to lock SMM by invoking

+  EFI_SMM_ACCESS2_PROTOCOL.Lock() function.

+

+  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

diff --git a/MdePkg/Include/Protocol/SmmEndOfDxe.h b/MdePkg/Include/Protocol/SmmEndOfDxe.h
index 4637ca1df3..e92ce4afbf 100644
--- a/MdePkg/Include/Protocol/SmmEndOfDxe.h
+++ b/MdePkg/Include/Protocol/SmmEndOfDxe.h
@@ -1,11 +1,15 @@
 /** @file

-  SMM End Of Dxe protocol as defined in the PI 1.2.1 specification.

+  SMM End Of Dxe protocol introduced in the PI 1.2.1 specification.

 

-  This protocol is a mandatory protocol published by the PI platform code prior to invoking any

-  3rd party content, including options ROM's and UEFI executables that are not from the platform manufacturer.

-  There is an associated event GUID that is signaled for the DXE drivers called EFI_END_OF_DXE_EVENT_GUID.

+  According to PI 1.4a specification, this protocol indicates end of the

+  execution phase when all of the components are under the authority of

+  the platform manufacturer.

+  This protocol is a mandatory protocol published by SMM Foundation code.

+  This protocol is an SMM counterpart of the End of DXE Event.

+  This protocol prorogates End of DXE notification into SMM environment.

+  This protocol is installed prior to installation of the SMM Ready to Lock Protocol.

 

-  Copyright (c) 2012 - 2015, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2012 - 2016, Intel Corporation. All rights reserved.<BR>

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

diff --git a/MdePkg/Include/Protocol/SmmReadyToLock.h b/MdePkg/Include/Protocol/SmmReadyToLock.h
index 59c92327a9..edf171923a 100644
--- a/MdePkg/Include/Protocol/SmmReadyToLock.h
+++ b/MdePkg/Include/Protocol/SmmReadyToLock.h
@@ -1,12 +1,17 @@
 /** @file

-  SMM Ready To Lock protocol as defined in the PI 1.2 specification.

-

-  This SMM protocol indicates that SMM is about to be locked.

-  This protocol is a mandatory protocol published by the SMM Foundation code when the system is 

-  preparing to lock SMM. This protocol should be installed immediately after

-  EFI_END_OF_DXE_EVENT_GROUP_GUID with no intervening modules dispatched.

-

-  Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>

+  SMM Ready To Lock protocol introduced in the PI 1.2 specification.

+

+  According to PI 1.4a specification, this SMM protocol indicates that

+  SMM resources and services that should not be used by the third party

+  code are about to be locked.

+  This protocol is a mandatory protocol published by the SMM Foundation

+  code when the system is preparing to lock certain resources and interfaces

+  in anticipation of the invocation of 3rd party extensible modules.

+  This protocol is an SMM counterpart of the DXE SMM Ready to Lock Protocol.

+  This protocol prorogates resource locking notification into SMM environment.

+  This protocol is installed after installation of the SMM End of DXE Protocol.

+

+  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>

   This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at