MdePkg/UefiSpec.h: Align function header of ResetSystem to UEFI Spec

[mirror_edk2.git] / MdePkg / Include / Uefi / UefiSpec.h

diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index e8feed120ded92565c511feeb7b8b3b03468c610..57cb4e804f703e7e21c1cf6ca1b23b3aa65386ab 100644 (file)
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -1004,11 +1004,15 @@ EFI_STATUS
 \r
   @param[in]  ResetType         The type of reset to perform.\r
   @param[in]  ResetStatus       The status code for the reset.\r
-  @param[in]  DataSize          The size, in bytes, of WatchdogData.\r
+  @param[in]  DataSize          The size, in bytes, of ResetData.\r
   @param[in]  ResetData         For a ResetType of EfiResetCold, EfiResetWarm, or\r
                                 EfiResetShutdown the data buffer starts with a Null-terminated\r
                                 string, optionally followed by additional binary data.\r
-\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
 **/\r
 typedef\r
 VOID\r