diff options
| author | Star Zeng <star.zeng@intel.com> | 2017-06-29 22:39:40 +0800 |
|---|---|---|
| committer | Star Zeng <star.zeng@intel.com> | 2017-07-03 17:53:12 +0800 |
| commit | eeeabe40012938d6d895f51b3b40cb6496887a3c (patch) | |
| tree | cca96c05cff2e284b6688e7422e3f88fa6f145fe /MdeModulePkg/Universal/ResetSystemRuntimeDxe | |
| parent | cf6da5569307cb3033465d2207e17f438f6e7655 (diff) | |
| download | edk2-eeeabe40012938d6d895f51b3b40cb6496887a3c.tar.gz edk2-eeeabe40012938d6d895f51b3b40cb6496887a3c.tar.bz2 edk2-eeeabe40012938d6d895f51b3b40cb6496887a3c.zip | |
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>
Reviewed-by: Dandan Bi <dandan.bi@intel.com>
Diffstat (limited to 'MdeModulePkg/Universal/ResetSystemRuntimeDxe')
| -rw-r--r-- | MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c | 3 | ||||
| -rw-r--r-- | MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h | 10 |
2 files changed, 12 insertions, 1 deletions
diff --git a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c index b8e3ea460d..75cff37773 100644 --- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c +++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.c @@ -207,6 +207,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 73e657d4e0..75cdd88896 100644 --- a/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h +++ b/MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h @@ -75,10 +75,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
|