EmbeddedPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmbeddedPkg / Library / TemplateResetSystemLib / ResetSystemLib.c

/** @file\r
  Template library implementation to support ResetSystem Runtime call.\r
\r
  Fill in the templates with what ever makes you system reset.\r
\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include <PiDxe.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/EfiResetSystemLib.h>\r
\r
\r
/**\r
  Resets the entire platform.\r
\r
  @param  ResetType             The type of reset to perform.\r
  @param  ResetStatus           The status code for the reset.\r
  @param  DataSize              The size, in bytes, of WatchdogData.\r
  @param  ResetData             For a ResetType of EfiResetCold, EfiResetWarm, or\r
                                EfiResetShutdown the data buffer starts with a Null-terminated\r
                                Unicode string, optionally followed by additional binary data.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibResetSystem (\r
  IN EFI_RESET_TYPE   ResetType,\r
  IN EFI_STATUS       ResetStatus,\r
  IN UINTN            DataSize,\r
  IN CHAR16           *ResetData OPTIONAL\r
  )\r
{\r
  UINTN   Address;\r
  UINT8   Data;\r
\r
\r
  switch (ResetType) {\r
  case EfiResetCold:\r
    // system power cycle\r
\r
    // Example using IoLib functions to do IO.\r
    Address = 0x12345678;\r
    Data = MmioRead8 (Address);\r
    MmioWrite8 (Address, Data | 0x01);\r
\r
    // Note this is a bad example asa MmioOr8 (Address, 0x01) does the same thing\r
    break;\r
\r
  case EfiResetWarm:\r
    // not a full power cycle, maybe memory stays around.\r
    // if not support do the same thing as EfiResetCold.\r
    break;\r
\r
  case EfiResetShutdown:\r
    // turn off the system.\r
    // if not support do the same thing as EfiResetCold.\r
    break;\r
\r
  default:\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // If we reset, we would not have returned...\r
  //\r
  return EFI_DEVICE_ERROR;\r
}\r
\r
\r
\r
/**\r
  Initialize any infrastructure required for LibResetSystem () to function.\r
\r
  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibInitializeResetSystem (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r