1. Patchew
  2. EDK2
  3. View series

[edk2] [PATCH] MdeModulePkg ResetSystem: Update the comments of ResetSystem()

Star Zeng posted 1 patch 6 years, 9 months ago
Failed in applying to current master (apply log)
MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c |  3 +++
MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h | 10 +++++++++-
2 files changed, 12 insertions(+), 1 deletion(-)
[edk2] [PATCH] MdeModulePkg ResetSystem: Update the comments of ResetSystem()
Posted by Star Zeng 6 years, 9 months ago 
Update the comments of ResetSystem() that was missed by
37078045d717 and 28426918f0ea.

Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Dandan Bi <dandan.bi@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c |  3 +++
 MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h | 10 +++++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c
index f61e65e151ab..ba839eef39b2 100644
--- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c
+++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c
@@ -95,6 +95,9 @@ DoS3 (
                                 valid if ResetStatus is something other than EFI_SUCCESS
                                 unless the ResetType is EfiResetPlatformSpecific
                                 where a minimum amount of ResetData is always required.
+                                For a ResetType of EfiResetPlatformSpecific the data buffer
+                                also starts with a Null-terminated string that is followed
+                                by an EFI_GUID that describes the specific type of reset to perform.
 **/
 VOID
 EFIAPI
diff --git a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h
index c3a2a7f1279a..e007d118e53f 100644
--- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h
+++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h
@@ -56,10 +56,18 @@ InitializeResetSystem (
 
   @param[in] ResetType          The type of reset to perform.
   @param[in] ResetStatus        The status code for the reset.
-  @param[in] DataSize           The size, in bytes, of WatchdogData.
+  @param[in] DataSize           The size, in bytes, of ResetData.
   @param[in] ResetData          For a ResetType of EfiResetCold, EfiResetWarm, or
                                 EfiResetShutdown the data buffer starts with a Null-terminated
                                 string, optionally followed by additional binary data.
+                                The string is a description that the caller may use to further
+                                indicate the reason for the system reset. ResetData is only
+                                valid if ResetStatus is something other than EFI_SUCCESS
+                                unless the ResetType is EfiResetPlatformSpecific
+                                where a minimum amount of ResetData is always required.
+                                For a ResetType of EfiResetPlatformSpecific the data buffer
+                                also starts with a Null-terminated string that is followed
+                                by an EFI_GUID that describes the specific type of reset to perform.
 
 **/
 VOID
-- 
2.7.0.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [PATCH] MdeModulePkg ResetSystem: Update the comments of ResetSystem()
Posted by Bi, Dandan 6 years, 9 months ago 
Star, thanks for detecting that. Reviewed-by: Dandan Bi <dandan.bi@intel.com>

Thanks,
Dandan

-----Original Message-----
From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Star Zeng
Sent: Thursday, June 29, 2017 10:45 PM
To: edk2-devel@lists.01.org
Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Bi, Dandan <dandan.bi@intel.com>; Zeng, Star <star.zeng@intel.com>
Subject: [edk2] [PATCH] MdeModulePkg ResetSystem: Update the comments of ResetSystem()

Update the comments of ResetSystem() that was missed by
37078045d717 and 28426918f0ea.

Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Dandan Bi <dandan.bi@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c |  3 +++  MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h | 10 +++++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c
index f61e65e151ab..ba839eef39b2 100644
--- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c
+++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c
@@ -95,6 +95,9 @@ DoS3 (
                                 valid if ResetStatus is something other than EFI_SUCCESS
                                 unless the ResetType is EfiResetPlatformSpecific
                                 where a minimum amount of ResetData is always required.
+                                For a ResetType of EfiResetPlatformSpecific the data buffer
+                                also starts with a Null-terminated string that is followed
+                                by an EFI_GUID that describes the specific type of reset to perform.
 **/
 VOID
 EFIAPI
diff --git a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h
index c3a2a7f1279a..e007d118e53f 100644
--- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h
+++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h
@@ -56,10 +56,18 @@ InitializeResetSystem (
 
   @param[in] ResetType          The type of reset to perform.
   @param[in] ResetStatus        The status code for the reset.
-  @param[in] DataSize           The size, in bytes, of WatchdogData.
+  @param[in] DataSize           The size, in bytes, of ResetData.
   @param[in] ResetData          For a ResetType of EfiResetCold, EfiResetWarm, or
                                 EfiResetShutdown the data buffer starts with a Null-terminated
                                 string, optionally followed by additional binary data.
+                                The string is a description that the caller may use to further
+                                indicate the reason for the system reset. ResetData is only
+                                valid if ResetStatus is something other than EFI_SUCCESS
+                                unless the ResetType is EfiResetPlatformSpecific
+                                where a minimum amount of ResetData is always required.
+                                For a ResetType of EfiResetPlatformSpecific the data buffer
+                                also starts with a Null-terminated string that is followed
+                                by an EFI_GUID that describes the specific type of reset to perform.
 
 **/
 VOID
--
2.7.0.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Patchew 2.1-devel-0870f84

© 2016 - 2024 Red Hat, Inc.