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 the system to enter S3 and then wake up immediately.
  67
  68   If this function returns, it means that the system does not support S3 feature.
  69 **/
  70 VOID
  71 EFIAPI
  72 EnterS3WithImmediateWake (
  73   VOID
  74   )
  75 {
  76 }
  77
  78 /**
  79   This function causes a systemwide reset. The exact type of the reset is
  80   defined by the EFI_GUID that follows the Null-terminated Unicode string passed
  81   into ResetData. If the platform does not recognize the EFI_GUID in ResetData
  82   the platform must pick a supported reset type to perform.The platform may
  83   optionally log the parameters from any non-normal reset that occurs.
  84
  85   @param[in]  DataSize   The size, in bytes, of ResetData.
  86   @param[in]  ResetData  The data buffer starts with a Null-terminated string,
  87                          followed by the EFI_GUID.
  88 **/
  89 VOID
  90 EFIAPI
  91 ResetPlatformSpecific (
  92   IN UINTN   DataSize,
  93   IN VOID    *ResetData
  94   )
  95 {
  96   mInternalRT->ResetSystem (EfiResetPlatformSpecific, EFI_SUCCESS, DataSize, ResetData);
  97 }
  98
  99 /**
 100   The ResetSystem function resets the entire platform.
 101
 102   @param[in] ResetType      The type of reset to perform.
 103   @param[in] ResetStatus    The status code for the reset.
 104   @param[in] DataSize       The size, in bytes, of ResetData.
 105   @param[in] ResetData      For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown
 106                             the data buffer starts with a Null-terminated string, optionally
 107                             followed by additional binary data. The string is a description
 108                             that the caller may use to further indicate the reason for the
 109                             system reset. ResetData is only valid if ResetStatus is something
 110                             other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific
 111                             where a minimum amount of ResetData is always required.
 112 **/
 113 VOID
 114 EFIAPI
 115 ResetSystem (
 116   IN EFI_RESET_TYPE               ResetType,
 117   IN EFI_STATUS                   ResetStatus,
 118   IN UINTN                        DataSize,
 119   IN VOID                         *ResetData OPTIONAL
 120   )
 121 {
 122   mInternalRT->ResetSystem (ResetType, ResetStatus, DataSize, ResetData);
 123 }
 124
 125 /**
 126   Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
 127
 128   @param  Event        Event whose notification function is being invoked.
 129   @param  Context      Pointer to the notification function's context
 130
 131 **/
 132 VOID
 133 EFIAPI
 134 RuntimeResetSystemLibVirtualAddressChange (
 135   IN EFI_EVENT        Event,
 136   IN VOID             *Context
 137   )
 138 {
 139   mInternalRT->ConvertPointer (0, (VOID **) &mInternalRT);
 140 }
 141
 142 /**
 143   The constructor function of Runtime Reset System Lib.
 144
 145   This function allocates memory for extended status code data, caches
 146   the report status code service, and registers events.
 147
 148   @param  ImageHandle   The firmware allocated handle for the EFI image.
 149   @param  SystemTable   A pointer to the EFI System Table.
 150
 151   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
 152
 153 **/
 154 EFI_STATUS
 155 EFIAPI
 156 RuntimeResetSystemLibConstruct (
 157   IN EFI_HANDLE           ImageHandle,
 158   IN EFI_SYSTEM_TABLE     *SystemTable
 159   )
 160 {
 161   EFI_STATUS  Status;
 162
 163   //
 164   // Library should not use the gRT directly, for it may be converted by other library instance.
 165   //
 166   mInternalRT = gRT;
 167
 168   //
 169   // Register notify function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
 170   //
 171   Status = gBS->CreateEventEx (
 172                   EVT_NOTIFY_SIGNAL,
 173                   TPL_NOTIFY,
 174                   RuntimeResetSystemLibVirtualAddressChange,
 175                   NULL,
 176                   &gEfiEventVirtualAddressChangeGuid,
 177                   &mRuntimeResetSystemLibVirtualAddressChangeEvent
 178                   );
 179   ASSERT_EFI_ERROR (Status);
 180
 181   return EFI_SUCCESS;
 182 }
 183
 184 /**
 185   The Deconstructor function of Runtime Reset System Lib.
 186
 187   The destructor function frees memory allocated by constructor, and closes related events.
 188   It will ASSERT() if that related operation fails and it will always return EFI_SUCCESS.
 189
 190   @param  ImageHandle   The firmware allocated handle for the EFI image.
 191   @param  SystemTable   A pointer to the EFI System Table.
 192
 193   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
 194
 195 **/
 196 EFI_STATUS
 197 EFIAPI
 198 RuntimeResetSystemLibDeconstruct (
 199   IN EFI_HANDLE           ImageHandle,
 200   IN EFI_SYSTEM_TABLE     *SystemTable
 201   )
 202 {
 203   EFI_STATUS  Status;
 204
 205   ASSERT (gBS != NULL);
 206   Status = gBS->CloseEvent (mRuntimeResetSystemLibVirtualAddressChangeEvent);
 207   ASSERT_EFI_ERROR (Status);
 208
 209   return EFI_SUCCESS;
 210 }