MdeModulePkg/Library/RuntimeResetSystemLib/RuntimeResetSystemLib.c

   1 /** @file
   2   DXE Reset System Library instance that calls gRT->ResetSystem().
   3
   4   Copyright (c) 2017 - 2019, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include <PiDxe.h>
  10 #include <Library/ResetSystemLib.h>
  11 #include <Library/UefiRuntimeServicesTableLib.h>
  12 #include <Library/UefiBootServicesTableLib.h>
  13 #include <Library/DebugLib.h>
  14
  15 EFI_EVENT                     mRuntimeResetSystemLibVirtualAddressChangeEvent;
  16 EFI_RUNTIME_SERVICES          *mInternalRT;
  17
  18 /**
  19   This function causes a system-wide reset (cold reset), in which
  20   all circuitry within the system returns to its initial state. This type of reset
  21   is asynchronous to system operation and operates without regard to
  22   cycle boundaries.
  23
  24   If this function returns, it means that the system does not support cold reset.
  25 **/
  26 VOID
  27 EFIAPI
  28 ResetCold (
  29   VOID
  30   )
  31 {
  32   mInternalRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);
  33 }
  34
  35 /**
  36   This function causes a system-wide initialization (warm reset), in which all processors
  37   are set to their initial state. Pending cycles are not corrupted.
  38
  39   If this function returns, it means that the system does not support warm reset.
  40 **/
  41 VOID
  42 EFIAPI
  43 ResetWarm (
  44   VOID
  45   )
  46 {
  47   mInternalRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);
  48 }
  49
  50 /**
  51   This function causes the system to enter a power state equivalent
  52   to the ACPI G2/S5 or G3 states.
  53
  54   If this function returns, it means that the system does not support shut down reset.
  55 **/
  56 VOID
  57 EFIAPI
  58 ResetShutdown (
  59   VOID
  60   )
  61 {
  62   mInternalRT->ResetSystem (EfiResetShutdown, EFI_SUCCESS, 0, NULL);
  63 }
  64
  65 /**
  66   This function causes a systemwide reset. The exact type of the reset is
  67   defined by the EFI_GUID that follows the Null-terminated Unicode string passed
  68   into ResetData. If the platform does not recognize the EFI_GUID in ResetData
  69   the platform must pick a supported reset type to perform.The platform may
  70   optionally log the parameters from any non-normal reset that occurs.
  71
  72   @param[in]  DataSize   The size, in bytes, of ResetData.
  73   @param[in]  ResetData  The data buffer starts with a Null-terminated string,
  74                          followed by the EFI_GUID.
  75 **/
  76 VOID
  77 EFIAPI
  78 ResetPlatformSpecific (
  79   IN UINTN   DataSize,
  80   IN VOID    *ResetData
  81   )
  82 {
  83   mInternalRT->ResetSystem (EfiResetPlatformSpecific, EFI_SUCCESS, DataSize, ResetData);
  84 }
  85
  86 /**
  87   The ResetSystem function resets the entire platform.
  88
  89   @param[in] ResetType      The type of reset to perform.
  90   @param[in] ResetStatus    The status code for the reset.
  91   @param[in] DataSize       The size, in bytes, of ResetData.
  92   @param[in] ResetData      For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown
  93                             the data buffer starts with a Null-terminated string, optionally
  94                             followed by additional binary data. The string is a description
  95                             that the caller may use to further indicate the reason for the
  96                             system reset.
  97 **/
  98 VOID
  99 EFIAPI
 100 ResetSystem (
 101   IN EFI_RESET_TYPE               ResetType,
 102   IN EFI_STATUS                   ResetStatus,
 103   IN UINTN                        DataSize,
 104   IN VOID                         *ResetData OPTIONAL
 105   )
 106 {
 107   mInternalRT->ResetSystem (ResetType, ResetStatus, DataSize, ResetData);
 108 }
 109
 110 /**
 111   Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
 112
 113   @param  Event        Event whose notification function is being invoked.
 114   @param  Context      Pointer to the notification function's context
 115
 116 **/
 117 VOID
 118 EFIAPI
 119 RuntimeResetSystemLibVirtualAddressChange (
 120   IN EFI_EVENT        Event,
 121   IN VOID             *Context
 122   )
 123 {
 124   mInternalRT->ConvertPointer (0, (VOID **) &mInternalRT);
 125 }
 126
 127 /**
 128   The constructor function of Runtime Reset System Lib.
 129
 130   This function allocates memory for extended status code data, caches
 131   the report status code service, and registers events.
 132
 133   @param  ImageHandle   The firmware allocated handle for the EFI image.
 134   @param  SystemTable   A pointer to the EFI System Table.
 135
 136   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
 137
 138 **/
 139 EFI_STATUS
 140 EFIAPI
 141 RuntimeResetSystemLibConstruct (
 142   IN EFI_HANDLE           ImageHandle,
 143   IN EFI_SYSTEM_TABLE     *SystemTable
 144   )
 145 {
 146   EFI_STATUS  Status;
 147
 148   //
 149   // Library should not use the gRT directly, for it may be converted by other library instance.
 150   //
 151   mInternalRT = gRT;
 152
 153   //
 154   // Register notify function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
 155   //
 156   Status = gBS->CreateEventEx (
 157                   EVT_NOTIFY_SIGNAL,
 158                   TPL_NOTIFY,
 159                   RuntimeResetSystemLibVirtualAddressChange,
 160                   NULL,
 161                   &gEfiEventVirtualAddressChangeGuid,
 162                   &mRuntimeResetSystemLibVirtualAddressChangeEvent
 163                   );
 164   ASSERT_EFI_ERROR (Status);
 165
 166   return EFI_SUCCESS;
 167 }
 168
 169 /**
 170   The Deconstructor function of Runtime Reset System Lib.
 171
 172   The destructor function frees memory allocated by constructor, and closes related events.
 173   It will ASSERT() if that related operation fails and it will always return EFI_SUCCESS.
 174
 175   @param  ImageHandle   The firmware allocated handle for the EFI image.
 176   @param  SystemTable   A pointer to the EFI System Table.
 177
 178   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
 179
 180 **/
 181 EFI_STATUS
 182 EFIAPI
 183 RuntimeResetSystemLibDeconstruct (
 184   IN EFI_HANDLE           ImageHandle,
 185   IN EFI_SYSTEM_TABLE     *SystemTable
 186   )
 187 {
 188   EFI_STATUS  Status;
 189
 190   ASSERT (gBS != NULL);
 191   Status = gBS->CloseEvent (mRuntimeResetSystemLibVirtualAddressChangeEvent);
 192   ASSERT_EFI_ERROR (Status);
 193
 194   return EFI_SUCCESS;
 195 }