MdeModulePkg ResetSystem: Update the comments of ResetSystem()

[mirror_edk2.git] / MdeModulePkg / Universal / ResetSystemRuntimeDxe / ResetSystem.h

/** @file\r
\r
  Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _RESET_SYSTEM_H_\r
#define _RESET_SYSTEM_H_\r
\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/Reset.h>\r
#include <Protocol/ResetNotification.h>\r
#include <Guid/CapsuleVendor.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/ResetSystemLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
typedef struct {\r
  UINT32                   Signature;\r
  LIST_ENTRY               Link;\r
  EFI_RESET_SYSTEM         ResetNotify;\r
} RESET_NOTIFY_ENTRY;\r
#define RESET_NOTIFY_ENTRY_SIGNATURE    SIGNATURE_32('r', 's', 't', 'n')\r
#define RESET_NOTIFY_ENTRY_FROM_LINK(a) CR (a, RESET_NOTIFY_ENTRY, Link, RESET_NOTIFY_ENTRY_SIGNATURE)\r
\r
typedef struct {\r
  UINT32                          Signature;\r
  EFI_RESET_NOTIFICATION_PROTOCOL ResetNotification;\r
  LIST_ENTRY                      ResetNotifies;\r
} RESET_NOTIFICATION_INSTANCE;\r
#define RESET_NOTIFICATION_INSTANCE_SIGNATURE    SIGNATURE_32('r', 's', 't', 'i')\r
#define RESET_NOTIFICATION_INSTANCE_FROM_THIS(a) \\r
  CR (a, RESET_NOTIFICATION_INSTANCE, ResetNotification, RESET_NOTIFICATION_INSTANCE_SIGNATURE)\r
\r
/**\r
  The driver's entry point.\r
\r
  It initializes the Reset Architectural Protocol.\r
\r
  @param[in] ImageHandle  The firmware allocated handle for the EFI image.  \r
  @param[in] SystemTable  A pointer to the EFI System Table.\r
  \r
  @retval EFI_SUCCESS     The entry point is executed successfully.\r
  @retval other           Cannot install ResetArch protocol.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeResetSystem (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  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\r
                                EfiResetShutdown the data buffer starts with a Null-terminated\r
                                string, optionally followed by additional binary data.\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
                                For a ResetType of EfiResetPlatformSpecific the data buffer\r
                                also starts with a Null-terminated string that is followed\r
                                by an EFI_GUID that describes the specific type of reset to perform.\r
\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