MdeModulePkg Variable: Align TPL level for (Smm)EndOfDxe callback

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

/** @file\r
\r
  Copyright (c) 2017 - 2018, 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_SYSTEM2_H_\r
#define _RESET_SYSTEM2_H_\r
\r
\r
#include <Uefi.h>\r
#include <PiPei.h>\r
\r
#include <Ppi/Reset2.h>\r
#include <Ppi/PlatformSpecificResetFilter.h>\r
#include <Ppi/PlatformSpecificResetNotification.h>\r
#include <Ppi/PlatformSpecificResetHandler.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/ResetSystemLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
\r
\r
//\r
// The maximum recursion depth to ResetSystem() by reset notification handlers\r
//\r
#define MAX_RESET_NOTIFY_DEPTH 10\r
\r
//\r
// Data to put in GUIDed HOB\r
//\r
typedef struct {\r
  UINT32                          Signature;\r
  UINT32                          Count;\r
  EFI_RESET_SYSTEM                ResetFilters[0]; // ResetFilters[PcdGet32 (PcdMaximumResetNotifies)]\r
} RESET_FILTER_LIST;\r
#define RESET_FILTER_LIST_SIGNATURE    SIGNATURE_32('r', 's', 't', 'l')\r
\r
\r
typedef struct {\r
  EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PPI ResetFilter;\r
  EFI_GUID                                 *Guid;\r
} RESET_FILTER_INSTANCE;\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
ResetSystem2 (\r
  IN EFI_RESET_TYPE   ResetType,\r
  IN EFI_STATUS       ResetStatus,\r
  IN UINTN            DataSize,\r
  IN VOID             *ResetData OPTIONAL\r
  );\r
/**\r
  Register a notification function to be called when ResetSystem() is called.\r
\r
  The RegisterResetNotify() function registers a notification function that is called when\r
  ResetSystem()is called and prior to completing the reset of the platform.\r
  The registered functions must not perform a platform reset themselves. These\r
  notifications are intended only for the notification of components which may need some\r
  special-purpose maintenance prior to the platform resetting.\r
\r
  @param[in]  This              A pointer to the EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PPI instance.\r
  @param[in]  ResetFunction     Points to the function to be called when a ResetSystem() is executed.\r
\r
  @retval EFI_SUCCESS           The reset notification function was successfully registered.\r
  @retval EFI_INVALID_PARAMETER ResetFunction is NULL.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to register the reset notification function.\r
  @retval EFI_ALREADY_STARTED   The reset notification function specified by ResetFunction has already been registered.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegisterResetNotify (\r
  IN EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PPI *This,\r
  IN EFI_RESET_SYSTEM                         ResetFunction\r
  );\r
\r
/**\r
  Unregister a notification function.\r
\r
  The UnregisterResetNotify() function removes the previously registered\r
  notification using RegisterResetNotify().\r
\r
  @param[in]  This              A pointer to the EFI_RESET_NOTIFICATION_PROTOCOL instance.\r
  @param[in]  ResetFunction     The pointer to the ResetFunction being unregistered.\r
\r
  @retval EFI_SUCCESS           The reset notification function was unregistered.\r
  @retval EFI_INVALID_PARAMETER ResetFunction is NULL.\r
  @retval EFI_INVALID_PARAMETER The reset notification function specified by ResetFunction was not previously\r
                                registered using RegisterResetNotify().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UnregisterResetNotify (\r
  IN EFI_RESET_NOTIFICATION_PROTOCOL *This,\r
  IN EFI_RESET_SYSTEM                ResetFunction\r
  );\r
#endif\r