MdeModulePkg ResetSystem: Update the comments of ResetSystem()

Update the comments of ResetSystem() that was missed by
37078045d7 and 28426918f0.

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>
Reviewed-by: Dandan Bi <dandan.bi@intel.com>
This commit is contained in:
Star Zeng 2017-06-29 22:39:40 +08:00
parent cf6da55693
commit eeeabe4001
2 changed files with 12 additions and 1 deletions

View File

@ -207,6 +207,9 @@ DoS3 (
valid if ResetStatus is something other than EFI_SUCCESS valid if ResetStatus is something other than EFI_SUCCESS
unless the ResetType is EfiResetPlatformSpecific unless the ResetType is EfiResetPlatformSpecific
where a minimum amount of ResetData is always required. 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 VOID
EFIAPI EFIAPI

View File

@ -75,10 +75,18 @@ InitializeResetSystem (
@param[in] ResetType The type of reset to perform. @param[in] ResetType The type of reset to perform.
@param[in] ResetStatus The status code for the reset. @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 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or
EfiResetShutdown the data buffer starts with a Null-terminated EfiResetShutdown the data buffer starts with a Null-terminated
string, optionally followed by additional binary data. 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 VOID