MdeModulePkg/Universal/ResetSystemRuntimeDxe/ResetSystem.h

   1 /** @file
   2
   3   Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
   4
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _RESET_SYSTEM_H_
  16 #define _RESET_SYSTEM_H_
  17
  18
  19 #include <PiDxe.h>
  20
  21 #include <Protocol/Reset.h>
  22 #include <Guid/CapsuleVendor.h>
  23
  24 #include <Library/BaseLib.h>
  25 #include <Library/DebugLib.h>
  26 #include <Library/UefiLib.h>
  27 #include <Library/IoLib.h>
  28 #include <Library/UefiDriverEntryPoint.h>
  29 #include <Library/UefiBootServicesTableLib.h>
  30 #include <Library/UefiRuntimeLib.h>
  31 #include <Library/UefiRuntimeServicesTableLib.h>
  32 #include <Library/ResetSystemLib.h>
  33
  34 /**
  35   The driver's entry point.
  36
  37   It initializes the Reset Architectural Protocol.
  38
  39   @param[in] ImageHandle  The firmware allocated handle for the EFI image.
  40   @param[in] SystemTable  A pointer to the EFI System Table.
  41
  42   @retval EFI_SUCCESS     The entry point is executed successfully.
  43   @retval other           Cannot install ResetArch protocol.
  44
  45 **/
  46 EFI_STATUS
  47 EFIAPI
  48 InitializeResetSystem (
  49   IN EFI_HANDLE        ImageHandle,
  50   IN EFI_SYSTEM_TABLE  *SystemTable
  51   );
  52
  53 /**
  54   Resets the entire platform.
  55
  56   @param[in] ResetType          The type of reset to perform.
  57   @param[in] ResetStatus        The status code for the reset.
  58   @param[in] DataSize           The size, in bytes, of WatchdogData.
  59   @param[in] ResetData          For a ResetType of EfiResetCold, EfiResetWarm, or
  60                                 EfiResetShutdown the data buffer starts with a Null-terminated
  61                                 string, optionally followed by additional binary data.
  62
  63 **/
  64 VOID
  65 EFIAPI
  66 ResetSystem (
  67   IN EFI_RESET_TYPE   ResetType,
  68   IN EFI_STATUS       ResetStatus,
  69   IN UINTN            DataSize,
  70   IN VOID             *ResetData OPTIONAL
  71   );
  72
  73 /**
  74   Reset system for capsule update.
  75
  76   @param[in] CapsuleDataPtr  Pointer to the capsule block descriptors.
  77
  78 **/
  79 VOID
  80 CapsuleReset (
  81   IN UINTN  CapsuleDataPtr
  82   );
  83
  84 #endif