MdeModulePkg/Universal/ResetSystemPei/ResetSystem.h

   1 /** @file
   2
   3   Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>
   4
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _RESET_SYSTEM2_H_
  10 #define _RESET_SYSTEM2_H_
  11
  12
  13 #include <Uefi.h>
  14 #include <PiPei.h>
  15
  16 #include <Ppi/Reset2.h>
  17 #include <Ppi/PlatformSpecificResetFilter.h>
  18 #include <Ppi/PlatformSpecificResetNotification.h>
  19 #include <Ppi/PlatformSpecificResetHandler.h>
  20
  21 #include <Library/BaseLib.h>
  22 #include <Library/BaseMemoryLib.h>
  23 #include <Library/DebugLib.h>
  24 #include <Library/PeiServicesLib.h>
  25 #include <Library/HobLib.h>
  26 #include <Library/ResetSystemLib.h>
  27 #include <Library/ReportStatusCodeLib.h>
  28
  29
  30 //
  31 // The maximum recursion depth to ResetSystem() by reset notification handlers
  32 //
  33 #define MAX_RESET_NOTIFY_DEPTH 10
  34
  35 //
  36 // Data to put in GUIDed HOB
  37 //
  38 typedef struct {
  39   UINT32                          Signature;
  40   UINT32                          Count;
  41   EFI_RESET_SYSTEM                ResetFilters[0]; // ResetFilters[PcdGet32 (PcdMaximumResetNotifies)]
  42 } RESET_FILTER_LIST;
  43 #define RESET_FILTER_LIST_SIGNATURE    SIGNATURE_32('r', 's', 't', 'l')
  44
  45
  46 typedef struct {
  47   EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PPI ResetFilter;
  48   EFI_GUID                                 *Guid;
  49 } RESET_FILTER_INSTANCE;
  50
  51 /**
  52   Resets the entire platform.
  53
  54   @param[in] ResetType          The type of reset to perform.
  55   @param[in] ResetStatus        The status code for the reset.
  56   @param[in] DataSize           The size, in bytes, of ResetData.
  57   @param[in] ResetData          For a ResetType of EfiResetCold, EfiResetWarm, or
  58                                 EfiResetShutdown the data buffer starts with a Null-terminated
  59                                 string, optionally followed by additional binary data.
  60                                 The string is a description that the caller may use to further
  61                                 indicate the reason for the system reset. ResetData is only
  62                                 valid if ResetStatus is something other than EFI_SUCCESS
  63                                 unless the ResetType is EfiResetPlatformSpecific
  64                                 where a minimum amount of ResetData is always required.
  65                                 For a ResetType of EfiResetPlatformSpecific the data buffer
  66                                 also starts with a Null-terminated string that is followed
  67                                 by an EFI_GUID that describes the specific type of reset to perform.
  68
  69 **/
  70 VOID
  71 EFIAPI
  72 ResetSystem2 (
  73   IN EFI_RESET_TYPE   ResetType,
  74   IN EFI_STATUS       ResetStatus,
  75   IN UINTN            DataSize,
  76   IN VOID             *ResetData OPTIONAL
  77   );
  78 /**
  79   Register a notification function to be called when ResetSystem() is called.
  80
  81   The RegisterResetNotify() function registers a notification function that is called when
  82   ResetSystem()is called and prior to completing the reset of the platform.
  83   The registered functions must not perform a platform reset themselves. These
  84   notifications are intended only for the notification of components which may need some
  85   special-purpose maintenance prior to the platform resetting.
  86
  87   @param[in]  This              A pointer to the EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PPI instance.
  88   @param[in]  ResetFunction     Points to the function to be called when a ResetSystem() is executed.
  89
  90   @retval EFI_SUCCESS           The reset notification function was successfully registered.
  91   @retval EFI_INVALID_PARAMETER ResetFunction is NULL.
  92   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to register the reset notification function.
  93   @retval EFI_ALREADY_STARTED   The reset notification function specified by ResetFunction has already been registered.
  94
  95 **/
  96 EFI_STATUS
  97 EFIAPI
  98 RegisterResetNotify (
  99   IN EDKII_PLATFORM_SPECIFIC_RESET_FILTER_PPI *This,
 100   IN EFI_RESET_SYSTEM                         ResetFunction
 101   );
 102
 103 /**
 104   Unregister a notification function.
 105
 106   The UnregisterResetNotify() function removes the previously registered
 107   notification using RegisterResetNotify().
 108
 109   @param[in]  This              A pointer to the EFI_RESET_NOTIFICATION_PROTOCOL instance.
 110   @param[in]  ResetFunction     The pointer to the ResetFunction being unregistered.
 111
 112   @retval EFI_SUCCESS           The reset notification function was unregistered.
 113   @retval EFI_INVALID_PARAMETER ResetFunction is NULL.
 114   @retval EFI_INVALID_PARAMETER The reset notification function specified by ResetFunction was not previously
 115                                 registered using RegisterResetNotify().
 116
 117 **/
 118 EFI_STATUS
 119 EFIAPI
 120 UnregisterResetNotify (
 121   IN EFI_RESET_NOTIFICATION_PROTOCOL *This,
 122   IN EFI_RESET_SYSTEM                ResetFunction
 123   );
 124 #endif