EDK II Packages: Add Contributions.txt and License.txt files

[mirror_edk2.git] / DuetPkg / AcpiResetDxe / Reset.c

/*++ @file\r
  Reset Architectural Protocol implementation.\r
\r
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
--*/\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/Reset.h>\r
\r
#include <Guid/AcpiDescription.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/PciLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
///\r
/// Handle for the Reset Architectural Protocol\r
///\r
EFI_HANDLE            mResetHandle = NULL;\r
\r
///\r
/// Copy of ACPI Description HOB in runtime memory\r
///\r
EFI_ACPI_DESCRIPTION  mAcpiDescription;\r
\r
/**\r
  Reset the system.\r
\r
  @param[in] ResetType       Warm or cold\r
  @param[in] ResetStatus     Possible cause of reset\r
  @param[in] DataSize        Size of ResetData in bytes\r
  @param[in] ResetData       Optional Unicode string\r
\r
**/\r
VOID\r
EFIAPI\r
EfiAcpiResetSystem (\r
  IN EFI_RESET_TYPE   ResetType,\r
  IN EFI_STATUS       ResetStatus,\r
  IN UINTN            DataSize,\r
  IN VOID             *ResetData OPTIONAL\r
  )\r
{\r
  UINT8   Dev;\r
  UINT8   Func;\r
  UINT8   Register;\r
  \r
  switch (ResetType) {\r
  case EfiResetShutdown:\r
    //\r
    // 1. Write SLP_TYPa\r
    //\r
    if ((mAcpiDescription.PM1a_CNT_BLK.Address != 0) && (mAcpiDescription.SLP_TYPa != 0)) {\r
      switch (mAcpiDescription.PM1a_CNT_BLK.AddressSpaceId) {\r
      case EFI_ACPI_3_0_SYSTEM_IO:\r
        IoAndThenOr16 ((UINTN)mAcpiDescription.PM1a_CNT_BLK.Address, 0xc3ff, (UINT16)(0x2000 | (mAcpiDescription.SLP_TYPa << 10)));\r
        break;\r
      case EFI_ACPI_3_0_SYSTEM_MEMORY:\r
        MmioAndThenOr16 ((UINTN)mAcpiDescription.PM1a_CNT_BLK.Address, 0xc3ff, (UINT16)(0x2000 | (mAcpiDescription.SLP_TYPa << 10)));\r
        break;\r
      }\r
    }\r
\r
    //\r
    // 2. Write SLP_TYPb\r
    //\r
    if ((mAcpiDescription.PM1b_CNT_BLK.Address != 0) && (mAcpiDescription.SLP_TYPb != 0)) {\r
      switch (mAcpiDescription.PM1b_CNT_BLK.AddressSpaceId) {\r
      case EFI_ACPI_3_0_SYSTEM_IO:\r
        IoAndThenOr16 ((UINTN)mAcpiDescription.PM1b_CNT_BLK.Address, 0xc3ff, (UINT16)(0x2000 | (mAcpiDescription.SLP_TYPb << 10)));\r
        break;\r
      case EFI_ACPI_3_0_SYSTEM_MEMORY:\r
        MmioAndThenOr16 ((UINTN)mAcpiDescription.PM1b_CNT_BLK.Address, 0xc3ff, (UINT16)(0x2000 | (mAcpiDescription.SLP_TYPb << 10)));\r
        break;\r
      }\r
    }\r
    //\r
    // If Shutdown fails, then let fall through to reset \r
    //\r
  case EfiResetWarm:\r
  case EfiResetCold:\r
    if ((mAcpiDescription.RESET_REG.Address != 0) &&\r
        ((mAcpiDescription.RESET_REG.AddressSpaceId == EFI_ACPI_3_0_SYSTEM_IO) ||\r
         (mAcpiDescription.RESET_REG.AddressSpaceId == EFI_ACPI_3_0_SYSTEM_MEMORY) ||\r
         (mAcpiDescription.RESET_REG.AddressSpaceId == EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE))) {\r
      //\r
      // Use ACPI System Reset\r
      //\r
      switch (mAcpiDescription.RESET_REG.AddressSpaceId) {\r
      case EFI_ACPI_3_0_SYSTEM_IO:\r
        //\r
        // Send reset request through I/O port register\r
        //\r
        IoWrite8 ((UINTN)mAcpiDescription.RESET_REG.Address, mAcpiDescription.RESET_VALUE);\r
        //\r
        // Halt \r
        //\r
        CpuDeadLoop ();\r
      case EFI_ACPI_3_0_SYSTEM_MEMORY:\r
        //\r
        // Send reset request through MMIO register\r
        //\r
        MmioWrite8 ((UINTN)mAcpiDescription.RESET_REG.Address, mAcpiDescription.RESET_VALUE);\r
        //\r
        // Halt \r
        //\r
        CpuDeadLoop ();\r
      case EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE:\r
        //\r
        // Send reset request through PCI register\r
        //\r
        Register = (UINT8)mAcpiDescription.RESET_REG.Address;\r
        Func     = (UINT8) (RShiftU64 (mAcpiDescription.RESET_REG.Address, 16) & 0x7);\r
        Dev      = (UINT8) (RShiftU64 (mAcpiDescription.RESET_REG.Address, 32) & 0x1F);\r
        PciWrite8 (PCI_LIB_ADDRESS (0, Dev, Func, Register), mAcpiDescription.RESET_VALUE);\r
        //\r
        // Halt \r
        //\r
        CpuDeadLoop ();\r
      }\r
    }\r
\r
    //\r
    // If system comes here, means ACPI reset is not supported, so do Legacy System Reset, assume 8042 available\r
    //\r
    IoWrite8 (0x64, 0xfe);\r
    CpuDeadLoop ();\r
  }\r
\r
  //\r
  // Given we should have reset getting here would be bad\r
  //\r
  ASSERT (FALSE);\r
  CpuDeadLoop();\r
}\r
\r
/**\r
  Initialize the state information for the Reset Architectural Protocol.\r
\r
  @param[in] ImageHandle  Image handle of the loaded driver\r
  @param[in] SystemTable  Pointer to the System Table\r
\r
  @retval EFI_SUCCESS           Thread can be successfully created\r
  @retval EFI_UNSUPPORTED       Cannot find the info to reset system\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeReset (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS         Status;\r
  EFI_HOB_GUID_TYPE  *HobAcpiDescription;\r
\r
  //\r
  // Make sure the Reset Architectural Protocol is not already installed in the system\r
  //\r
  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiResetArchProtocolGuid);\r
\r
  //\r
  // Get ACPI Description HOB\r
  //\r
  HobAcpiDescription = GetFirstGuidHob (&gEfiAcpiDescriptionGuid);\r
  if (HobAcpiDescription == NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Copy it to Runtime Memory\r
  //\r
  ASSERT (sizeof (EFI_ACPI_DESCRIPTION) == GET_GUID_HOB_DATA_SIZE (HobAcpiDescription));\r
  CopyMem (&mAcpiDescription, GET_GUID_HOB_DATA (HobAcpiDescription), sizeof (EFI_ACPI_DESCRIPTION));\r
\r
  DEBUG ((DEBUG_INFO, "ACPI Reset Base  - %lx\n", mAcpiDescription.RESET_REG.Address));\r
  DEBUG ((DEBUG_INFO, "ACPI Reset Value - %02x\n", (UINTN)mAcpiDescription.RESET_VALUE));\r
  DEBUG ((DEBUG_INFO, "IAPC support     - %x\n", (UINTN)(mAcpiDescription.IAPC_BOOT_ARCH)));\r
  \r
  //\r
  // Hook the runtime service table\r
  //\r
  SystemTable->RuntimeServices->ResetSystem = EfiAcpiResetSystem;\r
\r
  //\r
  // Install the Reset Architectural Protocol onto a new handle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &mResetHandle,\r
                  &gEfiResetArchProtocolGuid, NULL,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r