MdeModulePkg/ResetSystemPei: Change comments of ResetSystem2

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1460

Refer to Uefi spec 2.8, the ResetData is valid while ResetStatus
is EFI_SUCCESS regardless of the ResetType is EfiResetPlatformSpecific
or not.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao Wu <hao.a.wu@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael Turner <Michael.Turner@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
Reviewed-by: Hao Wu <hao.a.wu@intel.com>

diff --git a/MdeModulePkg/Universal/ResetSystemPei/ResetSystem.c b/MdeModulePkg/Universal/ResetSystemPei/ResetSystem.c
index 068e4e1130e3c16a57a8d1bd0859daa817e9d66a..ce90c8625717805458b65d081da8db66a97b8d9f 100644 (file)
--- a/MdeModulePkg/Universal/ResetSystemPei/ResetSystem.c
+++ b/MdeModulePkg/Universal/ResetSystemPei/ResetSystem.c
@@ -1,7 +1,7 @@
 /** @file\r
   Implementation of Reset2, ResetFilter and ResetHandler PPIs.\r
 \r
-  Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2017 - 2019, Intel Corporation. All rights reserved.<BR>\r
 \r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
@@ -265,10 +265,7 @@ InitializeResetSystem (
                                 EfiResetShutdown the data buffer starts with a Null-terminated\r
                                 string, optionally followed by additional binary data.\r
                                 The string is a description that the caller may use to further\r
-                                indicate the reason for the system reset. ResetData is only\r
-                                valid if ResetStatus is something other than EFI_SUCCESS\r
-                                unless the ResetType is EfiResetPlatformSpecific\r
-                                where a minimum amount of ResetData is always required.\r
+                                indicate the reason for the system reset.\r
                                 For a ResetType of EfiResetPlatformSpecific the data buffer\r
                                 also starts with a Null-terminated string that is followed\r
                                 by an EFI_GUID that describes the specific type of reset to perform.\r

diff --git a/MdeModulePkg/Universal/ResetSystemPei/ResetSystem.h b/MdeModulePkg/Universal/ResetSystemPei/ResetSystem.h
index 6c96ddaa849e7da0c471ba673c0460e263629e23..4d49a308af87581adb27b75860abd912caa9e8ac 100644 (file)
--- a/MdeModulePkg/Universal/ResetSystemPei/ResetSystem.h
+++ b/MdeModulePkg/Universal/ResetSystemPei/ResetSystem.h
@@ -58,10 +58,7 @@ typedef struct {
                                 EfiResetShutdown the data buffer starts with a Null-terminated\r
                                 string, optionally followed by additional binary data.\r
                                 The string is a description that the caller may use to further\r
-                                indicate the reason for the system reset. ResetData is only\r
-                                valid if ResetStatus is something other than EFI_SUCCESS\r
-                                unless the ResetType is EfiResetPlatformSpecific\r
-                                where a minimum amount of ResetData is always required.\r
+                                indicate the reason for the system reset.\r
                                 For a ResetType of EfiResetPlatformSpecific the data buffer\r
                                 also starts with a Null-terminated string that is followed\r
                                 by an EFI_GUID that describes the specific type of reset to perform.\r