MdeModulePkg/Include/Library/ResetSystemLib.h

   1 /** @file
   2   System reset Library Services.  This library class defines a set of
   3   methods that reset the whole system.
   4
   5 Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>
   6 This program and the accompanying materials are licensed and made available under
   7 the terms and conditions of the BSD License that accompanies this distribution.
   8 The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php.
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __RESET_SYSTEM_LIB_H__
  17 #define __RESET_SYSTEM_LIB_H__
  18
  19 /**
  20   This function causes a system-wide reset (cold reset), in which
  21   all circuitry within the system returns to its initial state. This type of reset
  22   is asynchronous to system operation and operates without regard to
  23   cycle boundaries.
  24
  25   If this function returns, it means that the system does not support cold reset.
  26 **/
  27 VOID
  28 EFIAPI
  29 ResetCold (
  30   VOID
  31   );
  32
  33 /**
  34   This function causes a system-wide initialization (warm reset), in which all processors
  35   are set to their initial state. Pending cycles are not corrupted.
  36
  37   If this function returns, it means that the system does not support warm reset.
  38 **/
  39 VOID
  40 EFIAPI
  41 ResetWarm (
  42   VOID
  43   );
  44
  45 /**
  46   This function causes the system to enter a power state equivalent
  47   to the ACPI G2/S5 or G3 states.
  48
  49   If this function returns, it means that the system does not support shutdown reset.
  50 **/
  51 VOID
  52 EFIAPI
  53 ResetShutdown (
  54   VOID
  55   );
  56
  57 /**
  58   This function causes the system to enter S3 and then wake up immediately.
  59
  60   If this function returns, it means that the system does not support S3 feature.
  61 **/
  62 VOID
  63 EFIAPI
  64 EnterS3WithImmediateWake (
  65   VOID
  66   );
  67
  68 #endif