EmbeddedPkg/Include/Library/EfiResetSystemLib.h

   1 /** @file
   2
   3   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
   4
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9
  10 #ifndef __EFI_RESET_SYSTEM_LIB_H___
  11 #define __EFI_RESET_SYSTEM_LIB_H___
  12
  13
  14 /**
  15   Resets the entire platform.
  16
  17   @param  ResetType             The type of reset to perform.
  18   @param  ResetStatus           The status code for the reset.
  19   @param  DataSize              The size, in bytes, of WatchdogData.
  20   @param  ResetData             For a ResetType of EfiResetCold, EfiResetWarm, or
  21                                 EfiResetShutdown the data buffer starts with a Null-terminated
  22                                 Unicode string, optionally followed by additional binary data.
  23
  24 **/
  25 EFI_STATUS
  26 EFIAPI
  27 LibResetSystem (
  28   IN EFI_RESET_TYPE   ResetType,
  29   IN EFI_STATUS       ResetStatus,
  30   IN UINTN            DataSize,
  31   IN CHAR16           *ResetData OPTIONAL
  32   );
  33
  34
  35
  36 /**
  37   Initialize any infrastructure required for LibResetSystem () to function.
  38
  39   @param  ImageHandle   The firmware allocated handle for the EFI image.
  40   @param  SystemTable   A pointer to the EFI System Table.
  41
  42   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
  43
  44 **/
  45 EFI_STATUS
  46 EFIAPI
  47 LibInitializeResetSystem (
  48   IN EFI_HANDLE        ImageHandle,
  49   IN EFI_SYSTEM_TABLE  *SystemTable
  50   );
  51
  52 #endif