Add module that produces the SMM CPU I/O 2 Protocol

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

3 files changed, 509 insertions, 2 deletions

diff --git a/UefiCpuPkg/CpuIo2Smm/CpuIo2Smm.c b/UefiCpuPkg/CpuIo2Smm/CpuIo2Smm.c
new file mode 100644
index 0000000000..da470a044a
--- /dev/null
+++ b/UefiCpuPkg/CpuIo2Smm/CpuIo2Smm.c
@@ -0,0 +1,442 @@
+/** @file

+  Produces the SMM CPU I/O Protocol.

+

+Copyright (c) 2009 - 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 <PiSmm.h>

+

+#include <Protocol/SmmCpuIo2.h>

+

+#include <Library/BaseLib.h>

+#include <Library/DebugLib.h>

+#include <Library/IoLib.h>

+#include <Library/SmmServicesTableLib.h>

+#include <Library/BaseMemoryLib.h>

+

+#define MAX_IO_PORT_ADDRESS   0xFFFF

+

+//

+// Function Prototypes

+//

+EFI_STATUS

+EFIAPI

+CpuMemoryServiceRead (

+  IN  CONST EFI_SMM_CPU_IO2_PROTOCOL  *This,

+  IN  EFI_SMM_IO_WIDTH                Width,

+  IN  UINT64                          Address,

+  IN  UINTN                           Count,

+  OUT VOID                            *Buffer

+  );

+

+EFI_STATUS

+EFIAPI

+CpuMemoryServiceWrite (

+  IN CONST EFI_SMM_CPU_IO2_PROTOCOL  *This,

+  IN EFI_SMM_IO_WIDTH                Width,

+  IN UINT64                          Address,

+  IN UINTN                           Count,

+  IN VOID                            *Buffer

+  );

+

+EFI_STATUS

+EFIAPI

+CpuIoServiceRead (

+  IN  CONST EFI_SMM_CPU_IO2_PROTOCOL  *This,

+  IN  EFI_SMM_IO_WIDTH                Width,

+  IN  UINT64                          Address,

+  IN  UINTN                           Count,

+  OUT VOID                            *Buffer

+  );

+

+EFI_STATUS

+EFIAPI

+CpuIoServiceWrite (

+  IN CONST EFI_SMM_CPU_IO2_PROTOCOL  *This,

+  IN EFI_SMM_IO_WIDTH                Width,

+  IN UINT64                          Address,

+  IN UINTN                           Count,

+  IN VOID                            *Buffer

+  );

+

+//

+// Handle for the SMM CPU I/O Protocol

+//

+EFI_HANDLE  mHandle = NULL;

+

+//

+// SMM CPU I/O Protocol instance

+//

+EFI_SMM_CPU_IO2_PROTOCOL mSmmCpuIo2 = {

+  {

+    CpuMemoryServiceRead,

+    CpuMemoryServiceWrite

+  },

+  {

+    CpuIoServiceRead,

+    CpuIoServiceWrite

+  }

+};

+

+//

+// Lookup table for increment values based on transfer widths

+//

+UINT8 mStride[] = {

+  1, // SMM_IO_UINT8

+  2, // SMM_IO_UINT16

+  4, // SMM_IO_UINT32

+  8  // SMM_IO_UINT64

+};

+

+/**

+  Check parameters to a SMM CPU I/O Protocol service request.

+

+  @param  Width                 Signifies the width of the I/O or Memory operation.

+  @param  Address               The base address of the I/O or Memory operation.

+  @param  Count                 The number of I/O or Memory operations to perform.

+                                The number of bytes moved is Width size * Count, starting at Address.

+  @param  Buffer                For read operations, the destination buffer to store the results.

+                                For write operations, the source buffer from which to write data.

+  @param  MmioOperation         TRUE for an MMIO operation, FALSE for I/O Port operation.

+  

+  @retval EFI_SUCCESS           The parameters for this request pass the checks.

+  @retval EFI_INVALID_PARAMETER Buffer is NULL or Width is not valid.

+  @retval EFI_UNSUPPORTED       The address range specified by Address, Width, and Count exceeds Limit.

+                                The Buffer is not aligned for the given Width.

+

+**/

+EFI_STATUS

+CpuIoCheckParameter (

+  IN BOOLEAN           MmioOperation,

+  IN EFI_SMM_IO_WIDTH  Width,

+  IN UINT64            Address,

+  IN UINTN             Count,

+  IN VOID              *Buffer

+  )

+{

+  UINT64  MaxCount;

+  UINT64  Limit;

+

+  //

+  // Check to see if Buffer is NULL

+  //

+  if (Buffer == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  //

+  // Check to see if Width is in the valid range

+  //

+  if (Width > SMM_IO_UINT64) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  //

+  // Check to see if Width is in the valid range for I/O Port operations

+  //

+  if (!MmioOperation && (Width == SMM_IO_UINT64)) {

+    return EFI_INVALID_PARAMETER;

+  }

+  

+  //

+  // Check to see if any address associated with this transfer exceeds the maximum 

+  // allowed address.  The maximum address implied by the parameters passed in is

+  // Address + Size * Count.  If the following condition is met, then the transfer

+  // is not supported.

+  //

+  //    Address + Size * Count > (MmioOperation ? MAX_ADDRESS : MAX_IO_PORT_ADDRESS) + 1

+  //

+  // Since MAX_ADDRESS can be the maximum integer value supported by the CPU and Count 

+  // can also be the maximum integer value supported by the CPU, this range

+  // check must be adjusted to avoid all oveflow conditions.

+  //   

+  // The follwing form of the range check is equivalent but assumes that 

+  // MAX_ADDRESS and MAX_IO_PORT_ADDRESS are of the form (2^n - 1).

+  //

+  Limit = (MmioOperation ? MAX_ADDRESS : MAX_IO_PORT_ADDRESS);

+  if (Count == 0) {

+    if (Address > Limit) {

+      return EFI_UNSUPPORTED;

+    }

+  } else {  

+    MaxCount = RShiftU64 (Limit, Width);

+    if (MaxCount < (Count - 1)) {

+      return EFI_UNSUPPORTED;

+    }

+    if (Address > LShiftU64 (MaxCount - Count + 1, Width)) {

+      return EFI_UNSUPPORTED;

+    }

+  }

+  

+  //

+  // Check to see if Address is aligned

+  //

+  if ((Address & (UINT64)(mStride[Width] - 1)) != 0) {

+    return EFI_UNSUPPORTED;

+  }

+

+  return EFI_SUCCESS;

+}

+

+/**

+  Reads memory-mapped registers.

+

+  @param  This                  A pointer to the EFI_SMM_CPU_IO2_PROTOCOL instance.

+  @param  Width                 Signifies the width of the I/O or Memory operation.

+  @param  Address               The base address of the I/O or Memoryoperation.

+  @param  Count                 The number of I/O or Memory operations to perform.

+                                The number of bytes moved is Width size * Count, starting at Address.

+  @param  Buffer                For read operations, the destination buffer to store the results.

+                                For write operations, the source buffer from which to write data.

+

+  @retval EFI_SUCCESS           The data was read from or written to the EFI system.

+  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system.Or Buffer is NULL.

+  @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.

+                                Or,The address range specified by Address, Width, and Count is not valid for this EFI system.

+

+**/

+EFI_STATUS

+EFIAPI

+CpuMemoryServiceRead (

+  IN  CONST EFI_SMM_CPU_IO2_PROTOCOL  *This,

+  IN  EFI_SMM_IO_WIDTH                Width,

+  IN  UINT64                          Address,

+  IN  UINTN                           Count,

+  OUT VOID                            *Buffer

+  )

+{

+  EFI_STATUS  Status;

+  UINT8       Stride;

+  UINT8       *Uint8Buffer;

+

+  Status = CpuIoCheckParameter (TRUE, Width, Address, Count, Buffer);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Select loop based on the width of the transfer

+  //

+  Stride = mStride[Width];

+  for (Uint8Buffer = Buffer; Count > 0; Address += Stride, Uint8Buffer += Stride, Count--) {

+    if (Width == SMM_IO_UINT8) {

+      *Uint8Buffer = MmioRead8 ((UINTN)Address);

+    } else if (Width == SMM_IO_UINT16) {

+      *((UINT16 *)Uint8Buffer) = MmioRead16 ((UINTN)Address);

+    } else if (Width == SMM_IO_UINT32) {

+      *((UINT32 *)Uint8Buffer) = MmioRead32 ((UINTN)Address);

+    } else if (Width == SMM_IO_UINT64) {

+      *((UINT64 *)Uint8Buffer) = MmioRead64 ((UINTN)Address);

+    }

+  }

+  return EFI_SUCCESS;

+}

+

+/**

+  Writes memory-mapped registers.

+

+  @param  This                  A pointer to the EFI_SMM_CPU_IO2_PROTOCOL instance.

+  @param  Width                 Signifies the width of the I/O or Memory operation.

+  @param  Address               The base address of the I/O or Memoryoperation.

+  @param  Count                 The number of I/O or Memory operations to perform.

+                                The number of bytes moved is Width size * Count, starting at Address.

+  @param  Buffer                For read operations, the destination buffer to store the results.

+                                For write operations, the source buffer from which to write data.

+

+  @retval EFI_SUCCESS           The data was read from or written to the EFI system.

+  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system.Or Buffer is NULL.

+  @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.

+                                Or,The address range specified by Address, Width, and Count is not valid for this EFI system.

+

+**/

+EFI_STATUS

+EFIAPI

+CpuMemoryServiceWrite (

+  IN CONST EFI_SMM_CPU_IO2_PROTOCOL  *This,

+  IN EFI_SMM_IO_WIDTH                Width,

+  IN UINT64                          Address,

+  IN UINTN                           Count,

+  IN VOID                            *Buffer

+  )

+{

+  EFI_STATUS  Status;

+  UINT8       Stride;

+  UINT8       *Uint8Buffer;

+

+  Status = CpuIoCheckParameter (TRUE, Width, Address, Count, Buffer);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Select loop based on the width of the transfer

+  //

+  Stride = mStride[Width];

+  for (Uint8Buffer = Buffer; Count > 0; Address += Stride, Uint8Buffer += Stride, Count--) {

+    if (Width == SMM_IO_UINT8) {

+      MmioWrite8 ((UINTN)Address, *Uint8Buffer);

+    } else if (Width == SMM_IO_UINT16) {

+      MmioWrite16 ((UINTN)Address, *((UINT16 *)Uint8Buffer));

+    } else if (Width == SMM_IO_UINT32) {

+      MmioWrite32 ((UINTN)Address, *((UINT32 *)Uint8Buffer));

+    } else if (Width == SMM_IO_UINT64) {

+      MmioWrite64 ((UINTN)Address, *((UINT64 *)Uint8Buffer));

+    }

+  }

+  return EFI_SUCCESS;

+}

+

+/**

+  Reads I/O registers.

+

+  @param  This                  A pointer to the EFI_SMM_CPU_IO2_PROTOCOL instance.

+  @param  Width                 Signifies the width of the I/O or Memory operation.

+  @param  Address               The base address of the I/O or Memoryoperation.

+  @param  Count                 The number of I/O or Memory operations to perform.

+                                The number of bytes moved is Width size * Count, starting at Address.

+  @param  Buffer                For read operations, the destination buffer to store the results.

+                                For write operations, the source buffer from which to write data.

+

+  @retval EFI_SUCCESS           The data was read from or written to the EFI system.

+  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system.Or Buffer is NULL.

+  @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.

+                                Or,The address range specified by Address, Width, and Count is not valid for this EFI system.

+

+**/

+EFI_STATUS

+EFIAPI

+CpuIoServiceRead (

+  IN  CONST EFI_SMM_CPU_IO2_PROTOCOL  *This,

+  IN  EFI_SMM_IO_WIDTH                Width,

+  IN  UINT64                          Address,

+  IN  UINTN                           Count,

+  OUT VOID                            *Buffer

+  )

+{

+  EFI_STATUS  Status;

+  UINT8       Stride;

+  UINT8       *Uint8Buffer;

+

+  Status = CpuIoCheckParameter (FALSE, Width, Address, Count, Buffer);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Select loop based on the width of the transfer

+  //

+  Stride = mStride[Width];

+  for (Uint8Buffer = Buffer; Count > 0; Address += Stride, Uint8Buffer += Stride, Count--) {

+    if (Width == SMM_IO_UINT8) {

+      *Uint8Buffer = IoRead8 ((UINTN)Address);

+    } else if (Width == SMM_IO_UINT16) {

+      *((UINT16 *)Uint8Buffer) = IoRead16 ((UINTN)Address);

+    } else if (Width == SMM_IO_UINT32) {

+      *((UINT32 *)Uint8Buffer) = IoRead32 ((UINTN)Address);

+    }

+  }

+

+  return EFI_SUCCESS;

+}

+

+/**

+  Write I/O registers.

+

+  @param  This                  A pointer to the EFI_SMM_CPU_IO2_PROTOCOL instance.

+  @param  Width                 Signifies the width of the I/O or Memory operation.

+  @param  Address               The base address of the I/O or Memoryoperation.

+  @param  Count                 The number of I/O or Memory operations to perform.

+                                The number of bytes moved is Width size * Count, starting at Address.

+  @param  Buffer                For read operations, the destination buffer to store the results.

+                                For write operations, the source buffer from which to write data.

+

+  @retval EFI_SUCCESS           The data was read from or written to the EFI system.

+  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI system.Or Buffer is NULL.

+  @retval EFI_UNSUPPORTED       The Buffer is not aligned for the given Width.

+                                Or,The address range specified by Address, Width, and Count is not valid for this EFI system.

+

+**/

+EFI_STATUS

+EFIAPI

+CpuIoServiceWrite (

+  IN CONST EFI_SMM_CPU_IO2_PROTOCOL  *This,

+  IN EFI_SMM_IO_WIDTH                Width,

+  IN UINT64                          Address,

+  IN UINTN                           Count,

+  IN VOID                            *Buffer

+  )

+{

+  EFI_STATUS  Status;

+  UINT8       Stride;

+  UINT8       *Uint8Buffer;

+

+  //

+  // Make sure the parameters are valid

+  //

+  Status = CpuIoCheckParameter (FALSE, Width, Address, Count, Buffer);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Select loop based on the width of the transfer

+  //

+  Stride = mStride[Width];

+  for (Uint8Buffer = (UINT8 *)Buffer; Count > 0; Address += Stride, Uint8Buffer += Stride, Count--) {

+    if (Width == SMM_IO_UINT8) {

+      IoWrite8 ((UINTN)Address, *Uint8Buffer);

+    } else if (Width == SMM_IO_UINT16) {

+      IoWrite16 ((UINTN)Address, *((UINT16 *)Uint8Buffer));

+    } else if (Width == SMM_IO_UINT32) {

+      IoWrite32 ((UINTN)Address, *((UINT32 *)Uint8Buffer));

+    }

+  }

+  

+  return EFI_SUCCESS;

+}

+

+/**

+  The module Entry Point SmmCpuIoProtocol driver

+

+  @param  ImageHandle    The firmware allocated handle for the EFI image.

+  @param  SystemTable    A pointer to the EFI System Table.

+

+  @retval EFI_SUCCESS    The entry point is executed successfully.

+  @retval Other          Some error occurs when executing this entry point.

+

+**/

+EFI_STATUS

+EFIAPI

+SmmCpuIo2Initialize (

+  IN EFI_HANDLE        ImageHandle,

+  IN EFI_SYSTEM_TABLE  *SystemTable

+  )

+ {

+  EFI_STATUS  Status;

+

+  //

+  // Copy the SMM CPU I/O Protocol instance into the System Management System Table

+  //

+  CopyMem (&gSmst->SmmIo, &mSmmCpuIo2, sizeof (mSmmCpuIo2));

+

+  //

+  // Install the SMM CPU I/O Protocol into the SMM protocol database

+  //

+  Status = gSmst->SmmInstallProtocolInterface (

+                    &mHandle,

+                    &gEfiSmmCpuIo2ProtocolGuid,

+                    EFI_NATIVE_INTERFACE,

+                    &mSmmCpuIo2

+                    );

+  ASSERT_EFI_ERROR (Status);

+  

+  return Status;

+}

diff --git a/UefiCpuPkg/CpuIo2Smm/CpuIo2Smm.inf b/UefiCpuPkg/CpuIo2Smm/CpuIo2Smm.inf
new file mode 100644
index 0000000000..d8549f9fa3
--- /dev/null
+++ b/UefiCpuPkg/CpuIo2Smm/CpuIo2Smm.inf
@@ -0,0 +1,51 @@
+#/** @file

+# Component description file for CPU I/O SMM Driver.

+#

+# Copyright (c) 2009 - 2010, Intel Corporation.

+#

+#  All rights reserved.

+#  This software and associated documentation (if any) is furnished

+#  under a license and may only be used or copied in accordance

+#  with the terms of the license. Except as permitted by such

+#  license, no part of this software or documentation may be

+#  reproduced, stored in a retrieval system, or transmitted in any

+#  form or by any means without the express written consent of

+#  Intel Corporation.

+#

+#

+#**/

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = CpuIo2Smm

+  FILE_GUID                      = A47EE2D8-F60E-42fd-8E58-7BD65EE4C29B

+  MODULE_TYPE                    = DXE_SMM_DRIVER

+  VERSION_STRING                 = 1.0

+  PI_SPECIFICATION_VERSION       = 0x0001000A

+  ENTRY_POINT                    = SmmCpuIo2Initialize

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64 

+#

+

+[Sources]

+  CpuIo2Smm.c

+  

+[Packages]

+  MdePkg/MdePkg.dec

+

+[LibraryClasses]

+  UefiDriverEntryPoint

+  BaseLib

+  DebugLib

+  IoLib

+  SmmServicesTableLib

+  BaseMemoryLib

+  

+[Protocols]

+  gEfiSmmCpuIo2ProtocolGuid                   # PROTOCOL ALWAYS_CONSUMED

+

+[Depex]

+  TRUE

diff --git a/UefiCpuPkg/UefiCpuPkg.dsc b/UefiCpuPkg/UefiCpuPkg.dsc
index 1b978396fa..ef43e1835f 100644
--- a/UefiCpuPkg/UefiCpuPkg.dsc
+++ b/UefiCpuPkg/UefiCpuPkg.dsc
@@ -1,7 +1,7 @@
 #/** @file

 #  UefiCpuPkg Package

 #

-#  Copyright (c) 2007 - 2009, Intel Corporation

+#  Copyright (c) 2007 - 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

@@ -19,7 +19,7 @@
   PLATFORM_VERSION               = 0.1

   DSC_SPECIFICATION              = 0x00010005

   OUTPUT_DIRECTORY               = Build/UefiCpu

-  SUPPORTED_ARCHITECTURES        = IA32|X64

+  SUPPORTED_ARCHITECTURES        = IA32|IPF|X64

   BUILD_TARGETS                  = DEBUG|RELEASE

   SKUID_IDENTIFIER               = DEFAULT

 

@@ -38,16 +38,30 @@
   PrintLib|MdePkg/Library/BasePrintLib/BasePrintLib.inf

   IoLib|MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf

 

+[LibraryClasses.common.PEIM]

+  PeimEntryPoint|MdePkg/Library/PeimEntryPoint/PeimEntryPoint.inf

+  PeiServicesTablePointerLib|MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointerLibIdt.inf

+  PeiServicesLib|MdePkg/Library/PeiServicesLib/PeiServicesLib.inf

+  MemoryAllocationLib|MdePkg/Library/PeiMemoryAllocationLib/PeiMemoryAllocationLib.inf

+

 [LibraryClasses.common.DXE_DRIVER]

   DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf

   MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf

   UefiBootServicesTableLib|MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.inf

   UefiDriverEntryPoint|MdePkg/Library/UefiDriverEntryPoint/UefiDriverEntryPoint.inf

 

+[LibraryClasses.common.DXE_SMM_DRIVER]

+  UefiDriverEntryPoint|MdePkg/Library/UefiDriverEntryPoint/UefiDriverEntryPoint.inf

+  SmmServicesTableLib|MdePkg/Library/SmmServicesTableLib/SmmServicesTableLib.inf

+  UefiBootServicesTableLib|MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.inf

+  

 #

 # Drivers/Libraries within this package

 #

 

 [Components.common]

   UefiCpuPkg/CpuIo2Dxe/CpuIo2Dxe.inf

+

+[Components.IA32, Components.X64]

+  UefiCpuPkg/CpuIo2Smm/CpuIo2Smm.inf

   UefiCpuPkg/Library/BaseUefiCpuLib/BaseUefiCpuLib.inf