Fix build breaks

Update EfiAcpiResetSystem() to match function prototype for EFI_RESET_SYSTEM
Add CpuDeadLoop() in all paths, so EfiAcpiResetSystem() can never return to be compliant with UEFI Spec, even when ASSERT() statements are disabled.
Change DEBUG() messages from EFI_D_ERROR to DEBUG_INFO because they are not error messages.
Simplify implementation from 4 files down to 2 files.
Use IoAndTheOr16() and MmioAndTheOr16() instead if IoRead/Write16() and MmioRead/Write16()



git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10035 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 146 insertions, 300 deletions

diff --git a/DuetPkg/AcpiResetDxe/Reset.c b/DuetPkg/AcpiResetDxe/Reset.c
index fe2d0a8da8..6d4dcc532e 100644
--- a/DuetPkg/AcpiResetDxe/Reset.c
+++ b/DuetPkg/AcpiResetDxe/Reset.c
@@ -12,115 +12,29 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 --*/

 

-#include "Reset.h"

+#include <PiDxe.h>

 

-/**

-  Use ACPI method to reset the sytem. If fail, use legacy 8042 method to reset the system

-

-  @param[in] AcpiDescription   Global variable to record reset info

-

-**/

-VOID

-SystemReset (

-  IN EFI_ACPI_DESCRIPTION *AcpiDescription

-  )

-{

-  UINT8   Dev;

-  UINT8   Func;

-  UINT8   Register;

+#include <Protocol/Reset.h>

 

-  if ((AcpiDescription->RESET_REG.Address != 0) &&

-      ((AcpiDescription->RESET_REG.AddressSpaceId == EFI_ACPI_3_0_SYSTEM_IO) ||

-       (AcpiDescription->RESET_REG.AddressSpaceId == EFI_ACPI_3_0_SYSTEM_MEMORY) ||

-       (AcpiDescription->RESET_REG.AddressSpaceId == EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE))) {

-    //

-    // Use ACPI System Reset

-    //

-    switch (AcpiDescription->RESET_REG.AddressSpaceId) {

-    case EFI_ACPI_3_0_SYSTEM_IO:

-      IoWrite8 ((UINTN) AcpiDescription->RESET_REG.Address, AcpiDescription->RESET_VALUE);

-      break;

-    case EFI_ACPI_3_0_SYSTEM_MEMORY:

-      MmioWrite8 ((UINTN) AcpiDescription->RESET_REG.Address, AcpiDescription->RESET_VALUE);

-      break;

-    case EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE:

-      Register = (UINT8) AcpiDescription->RESET_REG.Address;

-      Func     = (UINT8) (RShiftU64 (AcpiDescription->RESET_REG.Address, 16) & 0x7);

-      Dev      = (UINT8) (RShiftU64 (AcpiDescription->RESET_REG.Address, 32) & 0x1F);

-      PciWrite8 (PCI_LIB_ADDRESS (0, Dev, Func, Register), AcpiDescription->RESET_VALUE);

-      break;

-    }

-  }

+#include <Guid/AcpiDescription.h>

 

-  //

-  // If system comes here, means ACPI reset fail, do Legacy System Reset, assume 8042 available

-  //

-  Register = 0xfe;

-  IoWrite8 (0x64, Register);

+#include <Library/BaseLib.h>

+#include <Library/IoLib.h>

+#include <Library/PciLib.h>

+#include <Library/HobLib.h>

+#include <Library/DebugLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/UefiBootServicesTableLib.h>

 

-  //

-  // System should reset now

-  //

+///

+/// Handle for the Reset Architectural Protocol

+///

+EFI_HANDLE            mResetHandle = NULL;

 

-  return ;

-}

-

-/**

-  Use ACPI method to shutdown the sytem

-

-  @param[in] AcpiDescription   Global variable to record reset info

-

-  @retval EFI_UNSUPPORTED      Shutdown fails

-

-**/

-EFI_STATUS

-SystemShutdown (

-  IN EFI_ACPI_DESCRIPTION *AcpiDescription

-  )

-{

-  UINT16  Value;

-

-  //

-  // 1. Write SLP_TYPa

-  //

-  if ((AcpiDescription->PM1a_CNT_BLK.Address != 0) && (AcpiDescription->SLP_TYPa != 0)) {

-    switch (AcpiDescription->PM1a_CNT_BLK.AddressSpaceId) {

-    case EFI_ACPI_3_0_SYSTEM_IO:

-      Value = IoRead16 ((UINTN) AcpiDescription->PM1a_CNT_BLK.Address);

-      Value = (Value & 0xc3ff) | 0x2000 | (AcpiDescription->SLP_TYPa << 10);

-      IoWrite16 ((UINTN) AcpiDescription->PM1a_CNT_BLK.Address, Value);

-      break;

-    case EFI_ACPI_3_0_SYSTEM_MEMORY:

-      Value = MmioRead16 ((UINTN) AcpiDescription->PM1a_CNT_BLK.Address);

-      Value = (Value & 0xc3ff) | 0x2000 | (AcpiDescription->SLP_TYPa << 10);

-      MmioWrite16 ((UINTN) AcpiDescription->PM1a_CNT_BLK.Address, Value);

-      break;

-    }

-  }

-

-  //

-  // 2. Write SLP_TYPb

-  //

-  if ((AcpiDescription->PM1b_CNT_BLK.Address != 0) && (AcpiDescription->SLP_TYPb != 0)) {

-    switch (AcpiDescription->PM1b_CNT_BLK.AddressSpaceId) {

-    case EFI_ACPI_3_0_SYSTEM_IO:

-      Value = IoRead16 ((UINTN) AcpiDescription->PM1b_CNT_BLK.Address);

-      Value = (Value & 0xc3ff) | 0x2000 | (AcpiDescription->SLP_TYPb << 10);

-      IoWrite16 ((UINTN) AcpiDescription->PM1b_CNT_BLK.Address, Value);

-      break;

-    case EFI_ACPI_3_0_SYSTEM_MEMORY:

-      Value = MmioRead16 ((UINTN) AcpiDescription->PM1b_CNT_BLK.Address);

-      Value = (Value & 0xc3ff) | 0x2000 | (AcpiDescription->SLP_TYPb << 10);

-      MmioWrite16 ((UINTN) AcpiDescription->PM1b_CNT_BLK.Address, Value);

-      break;

-    }

-  }

-

-  //

-  // Done, if code runs here, mean not shutdown correctly

-  //

-  return EFI_UNSUPPORTED;

-}

+///

+/// Copy of ACPI Description HOB in runtime memory

+///

+EFI_ACPI_DESCRIPTION  mAcpiDescription;

 

 /**

   Reset the system.

@@ -129,66 +43,167 @@ SystemShutdown (
   @param[in] ResetStatus     Possible cause of reset

   @param[in] DataSize        Size of ResetData in bytes

   @param[in] ResetData       Optional Unicode string

-  @param[in] AcpiDescription Global variable to record reset info

 

 **/

 VOID

 EFIAPI

-AcpiResetSystem (

+EfiAcpiResetSystem (

   IN EFI_RESET_TYPE   ResetType,

   IN EFI_STATUS       ResetStatus,

   IN UINTN            DataSize,

-  IN CHAR16           *ResetData, OPTIONAL

-  IN EFI_ACPI_DESCRIPTION *AcpiDescription

+  IN VOID             *ResetData OPTIONAL

   )

 {

-  EFI_STATUS  Status;

-

+  UINT8   Dev;

+  UINT8   Func;

+  UINT8   Register;

+  

   switch (ResetType) {

+  case EfiResetShutdown:

+    //

+    // 1. Write SLP_TYPa

+    //

+    if ((mAcpiDescription.PM1a_CNT_BLK.Address != 0) && (mAcpiDescription.SLP_TYPa != 0)) {

+      switch (mAcpiDescription.PM1a_CNT_BLK.AddressSpaceId) {

+      case EFI_ACPI_3_0_SYSTEM_IO:

+        IoAndThenOr16 ((UINTN)mAcpiDescription.PM1a_CNT_BLK.Address, 0xc3ff, (UINT16)(0x2000 | (mAcpiDescription.SLP_TYPa << 10)));

+        break;

+      case EFI_ACPI_3_0_SYSTEM_MEMORY:

+        MmioAndThenOr16 ((UINTN)mAcpiDescription.PM1a_CNT_BLK.Address, 0xc3ff, (UINT16)(0x2000 | (mAcpiDescription.SLP_TYPa << 10)));

+        break;

+      }

+    }

+

+    //

+    // 2. Write SLP_TYPb

+    //

+    if ((mAcpiDescription.PM1b_CNT_BLK.Address != 0) && (mAcpiDescription.SLP_TYPb != 0)) {

+      switch (mAcpiDescription.PM1b_CNT_BLK.AddressSpaceId) {

+      case EFI_ACPI_3_0_SYSTEM_IO:

+        IoAndThenOr16 ((UINTN)mAcpiDescription.PM1b_CNT_BLK.Address, 0xc3ff, (UINT16)(0x2000 | (mAcpiDescription.SLP_TYPb << 10)));

+        break;

+      case EFI_ACPI_3_0_SYSTEM_MEMORY:

+        MmioAndThenOr16 ((UINTN)mAcpiDescription.PM1b_CNT_BLK.Address, 0xc3ff, (UINT16)(0x2000 | (mAcpiDescription.SLP_TYPb << 10)));

+        break;

+      }

+    }

+    //

+    // If Shutdown fails, then let fall through to reset 

+    //

   case EfiResetWarm:

   case EfiResetCold:

-    SystemReset (AcpiDescription);

-    break;

-

-  case EfiResetShutdown:

-    Status = SystemShutdown (AcpiDescription);

-    if (EFI_ERROR (Status)) {

-      SystemReset (AcpiDescription);

+    if ((mAcpiDescription.RESET_REG.Address != 0) &&

+        ((mAcpiDescription.RESET_REG.AddressSpaceId == EFI_ACPI_3_0_SYSTEM_IO) ||

+         (mAcpiDescription.RESET_REG.AddressSpaceId == EFI_ACPI_3_0_SYSTEM_MEMORY) ||

+         (mAcpiDescription.RESET_REG.AddressSpaceId == EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE))) {

+      //

+      // Use ACPI System Reset

+      //

+      switch (mAcpiDescription.RESET_REG.AddressSpaceId) {

+      case EFI_ACPI_3_0_SYSTEM_IO:

+        //

+        // Send reset request through I/O port register

+        //

+        IoWrite8 ((UINTN)mAcpiDescription.RESET_REG.Address, mAcpiDescription.RESET_VALUE);

+        //

+        // Halt 

+        //

+        CpuDeadLoop ();

+      case EFI_ACPI_3_0_SYSTEM_MEMORY:

+        //

+        // Send reset request through MMIO register

+        //

+        MmioWrite8 ((UINTN)mAcpiDescription.RESET_REG.Address, mAcpiDescription.RESET_VALUE);

+        //

+        // Halt 

+        //

+        CpuDeadLoop ();

+      case EFI_ACPI_3_0_PCI_CONFIGURATION_SPACE:

+        //

+        // Send reset request through PCI register

+        //

+        Register = (UINT8)mAcpiDescription.RESET_REG.Address;

+        Func     = (UINT8) (RShiftU64 (mAcpiDescription.RESET_REG.Address, 16) & 0x7);

+        Dev      = (UINT8) (RShiftU64 (mAcpiDescription.RESET_REG.Address, 32) & 0x1F);

+        PciWrite8 (PCI_LIB_ADDRESS (0, Dev, Func, Register), mAcpiDescription.RESET_VALUE);

+        //

+        // Halt 

+        //

+        CpuDeadLoop ();

+      }

     }

-    break;

 

-  default:

-    return ;

+    //

+    // If system comes here, means ACPI reset is not supported, so do Legacy System Reset, assume 8042 available

+    //

+    IoWrite8 (0x64, 0xfe);

+    CpuDeadLoop ();

   }

 

   //

   // Given we should have reset getting here would be bad

   //

   ASSERT (FALSE);

+  CpuDeadLoop();

 }

 

-BOOLEAN

-GetAcpiDescription (

-  IN EFI_ACPI_DESCRIPTION *AcpiDescription

+/**

+  Initialize the state information for the Reset Architectural Protocol.

+

+  @param[in] ImageHandle  Image handle of the loaded driver

+  @param[in] SystemTable  Pointer to the System Table

+

+  @retval EFI_SUCCESS           Thread can be successfully created

+  @retval EFI_UNSUPPORTED       Cannot find the info to reset system

+

+**/

+EFI_STATUS

+EFIAPI

+InitializeReset (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

   )

 {

-  EFI_HOB_GUID_TYPE       *HobAcpiDescription;

+  EFI_STATUS         Status;

+  EFI_HOB_GUID_TYPE  *HobAcpiDescription;

+

   //

-  // Get AcpiDescription Hob

+  // Make sure the Reset Architectural Protocol is not already installed in the system

+  //

+  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiResetArchProtocolGuid);

+

+  //

+  // Get ACPI Description HOB

   //

   HobAcpiDescription = GetFirstGuidHob (&gEfiAcpiDescriptionGuid);

   if (HobAcpiDescription == NULL) {

-    return FALSE;

+    return EFI_UNSUPPORTED;

   }

 

   //

   // Copy it to Runtime Memory

   //

   ASSERT (sizeof (EFI_ACPI_DESCRIPTION) == GET_GUID_HOB_DATA_SIZE (HobAcpiDescription));

-  CopyMem (AcpiDescription, GET_GUID_HOB_DATA (HobAcpiDescription), sizeof (EFI_ACPI_DESCRIPTION));

+  CopyMem (&mAcpiDescription, GET_GUID_HOB_DATA (HobAcpiDescription), sizeof (EFI_ACPI_DESCRIPTION));

+

+  DEBUG ((DEBUG_INFO, "ACPI Reset Base  - %lx\n", mAcpiDescription.RESET_REG.Address));

+  DEBUG ((DEBUG_INFO, "ACPI Reset Value - %02x\n", (UINTN)mAcpiDescription.RESET_VALUE));

+  DEBUG ((DEBUG_INFO, "IAPC support     - %x\n", (UINTN)(mAcpiDescription.IAPC_BOOT_ARCH)));

+  

+  //

+  // Hook the runtime service table

+  //

+  SystemTable->RuntimeServices->ResetSystem = EfiAcpiResetSystem;

+

+  //

+  // Install the Reset Architectural Protocol onto a new handle

+  //

+  Status = gBS->InstallMultipleProtocolInterfaces (

+                  &mResetHandle,

+                  &gEfiResetArchProtocolGuid, NULL,

+                  NULL

+                  );

+  ASSERT_EFI_ERROR (Status);

 

-  DEBUG ((EFI_D_ERROR, "ACPI Reset Base - %lx\n", AcpiDescription->RESET_REG.Address));

-  DEBUG ((EFI_D_ERROR, "ACPI Reset Value - %02x\n", (UINTN)AcpiDescription->RESET_VALUE));

-  DEBUG ((EFI_D_ERROR, "IAPC support - %x\n", (UINTN)(AcpiDescription->IAPC_BOOT_ARCH)));

-  return TRUE;

+  return Status;

 }

diff --git a/DuetPkg/AcpiResetDxe/Reset.h b/DuetPkg/AcpiResetDxe/Reset.h
deleted file mode 100644
index 448c103b2b..0000000000
--- a/DuetPkg/AcpiResetDxe/Reset.h
+++ /dev/null
@@ -1,74 +0,0 @@
-/*++ @file

-  Some definitions for reset.

-

-Copyright (c) 2006 - 2010, Intel Corporation                                                         

-All rights reserved. This program and the accompanying materials                          

-are licensed and made available under the terms and conditions of the BSD License         

-which accompanies this distribution.  The full text of the license may be found at        

-http://opensource.org/licenses/bsd-license.php                                            

-                                                                                          

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

-

---*/

-

-#ifndef _ACPI_RESET_H

-#define _ACPI_RESET_H

-

-#include <PiDxe.h>

-

-#include <Library/BaseLib.h>

-#include <Library/IoLib.h>

-#include <Library/PciLib.h>

-#include <Library/HobLib.h>

-#include <Library/DebugLib.h>

-#include <Library/BaseMemoryLib.h>

-#include <Library/UefiBootServicesTableLib.h>

-

-#include <Protocol/Reset.h>

-#include <Guid/AcpiDescription.h>

-

-/**

-  Initialize the state information for the Reset Architectural Protocol.

-

-  @param[in] ImageHandle  Image handle of the loaded driver

-  @param[in] SystemTable  Pointer to the System Table

-

-  @retval EFI_SUCCESS           Thread can be successfully created

-  @retval EFI_UNSUPPORTED       Cannot find the info to reset system

-

-**/

-EFI_STATUS

-EFIAPI

-InitializeReset (

-  IN EFI_HANDLE        ImageHandle,

-  IN EFI_SYSTEM_TABLE  *SystemTable

-  )

-;

-

-/**

-  Reset the system.

-

-  @param[in] ResetType       Warm or cold

-  @param[in] ResetStatus     Possible cause of reset

-  @param[in] DataSize        Size of ResetData in bytes

-  @param[in] ResetData       Optional Unicode string

-

-**/

-VOID

-EFIAPI

-AcpiResetSystem (

-  IN EFI_RESET_TYPE   ResetType,

-  IN EFI_STATUS       ResetStatus,

-  IN UINTN            DataSize,

-  IN CHAR16           *ResetData, OPTIONAL

-  IN EFI_ACPI_DESCRIPTION *AcpiDescription

-  )

-;

-

-BOOLEAN

-GetAcpiDescription (

-  IN EFI_ACPI_DESCRIPTION *AcpiDescription

-  );

-

-#endif

diff --git a/DuetPkg/AcpiResetDxe/Reset.inf b/DuetPkg/AcpiResetDxe/Reset.inf
index 3af6becbe3..a0bd634110 100644
--- a/DuetPkg/AcpiResetDxe/Reset.inf
+++ b/DuetPkg/AcpiResetDxe/Reset.inf
@@ -36,8 +36,6 @@
 

 [Sources]

   Reset.c

-  Reset.h

-  ResetEntry.c

 

 [Protocols]

   gEfiResetArchProtocolGuid

@@ -47,8 +45,3 @@
 

 [Depex]

   TRUE

-

-[BuildOptions]

-  MSFT:*_*_IA32_CC_FLAGS  = /Od

-

-

diff --git a/DuetPkg/AcpiResetDxe/ResetEntry.c b/DuetPkg/AcpiResetDxe/ResetEntry.c
deleted file mode 100644
index 3da08a10d2..0000000000
--- a/DuetPkg/AcpiResetDxe/ResetEntry.c
+++ /dev/null
@@ -1,88 +0,0 @@
-/*++ @file

-  Entrypoint of AcpiResetDxe driver.

-

-Copyright (c) 2010, Intel Corporation                                                         

-All rights reserved. This program and the accompanying materials                          

-are licensed and made available under the terms and conditions of the BSD License         

-which accompanies this distribution.  The full text of the license may be found at        

-http://opensource.org/licenses/bsd-license.php                                            

-                                                                                          

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

---*/

-

-#include "Reset.h"

-

-EFI_ACPI_DESCRIPTION  mAcpiDescription;

-

-/**

-  Reset the system.

-

-  @param[in] ResetType       Warm or cold

-  @param[in] ResetStatus     Possible cause of reset

-  @param[in] DataSize        Size of ResetData in bytes

-  @param[in] ResetData       Optional Unicode string

-

-**/

-VOID

-EFIAPI

-EfiAcpiResetSystem (

-  IN EFI_RESET_TYPE   ResetType,

-  IN EFI_STATUS       ResetStatus,

-  IN UINTN            DataSize,

-  IN CHAR16           *ResetData OPTIONAL

-  )

-{

-  AcpiResetSystem (ResetType, ResetStatus, DataSize, ResetData, &mAcpiDescription);

-}

-

-/**

-  Initialize the state information for the Reset Architectural Protocol.

-

-  @param[in] ImageHandle  Image handle of the loaded driver

-  @param[in] SystemTable  Pointer to the System Table

-

-  @retval EFI_SUCCESS           Thread can be successfully created

-  @retval EFI_UNSUPPORTED       Cannot find the info to reset system

-

-**/

-EFI_STATUS

-EFIAPI

-InitializeReset (

-  IN EFI_HANDLE        ImageHandle,

-  IN EFI_SYSTEM_TABLE  *SystemTable

-  )

-{

-  EFI_STATUS            Status;

-  EFI_HANDLE            Handle;

-  //

-  // Initialize AcpiDescription

-  //

-  if (!GetAcpiDescription (&mAcpiDescription)) {

-    return EFI_UNSUPPORTED;

-  }

-

-  //

-  // Make sure the Reset Architectural Protocol is not already installed in the system

-  //

-  ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiResetArchProtocolGuid);

-

-  //

-  // Hook the runtime service table

-  //

-  SystemTable->RuntimeServices->ResetSystem = EfiAcpiResetSystem;

-

-  //

-  // Now install the Reset RT AP on a new handle

-  //

-  Handle = NULL;

-  Status = gBS->InstallMultipleProtocolInterfaces (

-                  &Handle,

-                  &gEfiResetArchProtocolGuid,

-                  NULL,

-                  NULL

-                  );

-  ASSERT_EFI_ERROR (Status);

-

-  return Status;

-}