]> git.proxmox.com Git - mirror_edk2.git/commitdiff
MdeModulePkg: Add the new API ResetSystem in the head file
authorZhichao Gao <zhichao.gao@intel.com>
Thu, 21 Feb 2019 00:59:39 +0000 (08:59 +0800)
committerLiming Gao <liming.gao@intel.com>
Fri, 22 Feb 2019 01:45:44 +0000 (09:45 +0800)
BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=1460

Add the new API ResetSystem in the related head file so that
the consumer can use it through the combination of library
instance and head file.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
MdeModulePkg/Include/Library/ResetSystemLib.h

index 55d1923ae1081f8c2b5830bda499e4af6691a676..e438a0a90e9c5c7b3d9b977b60f091de08e1332e 100644 (file)
@@ -2,7 +2,7 @@
   System reset Library Services.  This library class defines a set of\r
   methods that reset the whole system.\r
 \r
-Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2005 - 2019, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under\r
 the terms and conditions of the BSD License that accompanies this distribution.\r
 The full text of the license may be found at\r
@@ -16,6 +16,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __RESET_SYSTEM_LIB_H__\r
 #define __RESET_SYSTEM_LIB_H__\r
 \r
+#include <Uefi/UefiBaseType.h>\r
+#include <Uefi/UefiMultiPhase.h>\r
+\r
 /**\r
   This function causes a system-wide reset (cold reset), in which\r
   all circuitry within the system returns to its initial state. This type of reset\r
@@ -83,4 +86,27 @@ ResetPlatformSpecific (
   IN VOID    *ResetData\r
   );\r
 \r
+/**\r
+  The ResetSystem function resets the entire platform.\r
+\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 ResetData.\r
+  @param[in] ResetData      For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown\r
+                            the data buffer starts with a Null-terminated string, optionally\r
+                            followed by additional binary data. The string is a description\r
+                            that the caller may use to further indicate the reason for the\r
+                            system reset. ResetData is only valid if ResetStatus is something\r
+                            other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific\r
+                            where a minimum amount of ResetData is always required.\r
+**/\r
+VOID\r
+EFIAPI\r
+ResetSystem (\r
+  IN EFI_RESET_TYPE               ResetType,\r
+  IN EFI_STATUS                   ResetStatus,\r
+  IN UINTN                        DataSize,\r
+  IN VOID                         *ResetData OPTIONAL\r
+  );\r
+\r
 #endif\r