MdeModulePkg/Include/Library/ResetSystemLib.h

   1 /** @file
   2   System reset Library Services.  This library class defines a set of
   3   methods to reset whole system.
   4
   5   Copyright (c) 2005 - 2007, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  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   Calling this function causes a system-wide reset. This sets
  21   all circuitry within the system to its initial state. This type of reset
  22   is asynchronous to system operation and operates without regard to
  23   cycle boundaries.
  24
  25   System reset should not return, if it returns, it means the system does
  26   not support cold reset.
  27 **/
  28 VOID
  29 EFIAPI
  30 ResetCold (
  31   VOID
  32   );
  33
  34 /**
  35   Calling this function causes a system-wide initialization. The processors
  36   are set to their initial state, and pending cycles are not corrupted.
  37
  38   System reset should not return, if it returns, it means the system does
  39   not support warm reset.
  40 **/
  41 VOID
  42 EFIAPI
  43 ResetWarm (
  44   VOID
  45   );
  46
  47 /**
  48   Calling this function causes the system to enter a power state equivalent
  49   to the ACPI G2/S5 or G3 states.
  50
  51   System shutdown should not return, if it returns, it means the system does
  52   not support shut down reset.
  53 **/
  54 VOID
  55 EFIAPI
  56 ResetShutdown (
  57   VOID
  58   );
  59
  60 /**
  61   Calling this function causes the system to enter S3 and then
  62   wake up immediately.
  63
  64   Reset update should not return, if it returns, it means the
  65   library does not the feature.
  66 **/
  67 VOID
  68 EFIAPI
  69 EnterS3WithImmediateWake (
  70   VOID
  71   );
  72 #endif