Minor code refinement.

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

3 files changed, 229 insertions, 54 deletions

diff --git a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.c b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.c
index 802b4fef2b..0202fc57bf 100644
--- a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.c
+++ b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.c
@@ -12,59 +12,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 **/

 

-#include <PiDxe.h>

-

-#include <Protocol/CpuIo.h>

-

-#include <Library/BaseLib.h>

-#include <Library/DebugLib.h>

-#include <Library/IoLib.h>

-#include <Library/UefiBootServicesTableLib.h>

-

-#define MAX_IO_PORT_ADDRESS   0xFFFF

-

-//

-// Function Prototypes

-//

-EFI_STATUS

-EFIAPI

-CpuMemoryServiceRead (

-  IN  EFI_CPU_IO_PROTOCOL        *This,

-  IN  EFI_CPU_IO_PROTOCOL_WIDTH  Width,

-  IN  UINT64                     Address,

-  IN  UINTN                      Count,

-  OUT VOID                       *Buffer

-  );

-

-EFI_STATUS

-EFIAPI

-CpuMemoryServiceWrite (

-  IN EFI_CPU_IO_PROTOCOL        *This,

-  IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,

-  IN UINT64                     Address,

-  IN UINTN                      Count,

-  IN VOID                       *Buffer

-  );

-

-EFI_STATUS

-EFIAPI

-CpuIoServiceRead (

-  IN  EFI_CPU_IO_PROTOCOL        *This,

-  IN  EFI_CPU_IO_PROTOCOL_WIDTH  Width,

-  IN  UINT64                     Address,

-  IN  UINTN                      Count,

-  OUT VOID                       *Buffer

-  );

-

-EFI_STATUS

-EFIAPI

-CpuIoServiceWrite (

-  IN EFI_CPU_IO_PROTOCOL        *This,

-  IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,

-  IN UINT64                     Address,

-  IN UINTN                      Count,

-  IN VOID                       *Buffer

-  );

+#include "CpuIo.h"

 

 //

 // Handle for the CPU I/O Protocol

diff --git a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.h b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.h
new file mode 100644
index 0000000000..d23054bb94
--- /dev/null
+++ b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIo.h
@@ -0,0 +1,226 @@
+/** @file

+  Internal include file of CPU I/O DXE Driver.

+

+  Copyright (c) 2004 - 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 __CPU_IO_DXE_H__

+#define __CPU_IO_DXE_H__

+

+

+#include <PiDxe.h>

+

+#include <Protocol/CpuIo.h>

+

+#include <Library/BaseLib.h>

+#include <Library/DebugLib.h>

+#include <Library/IoLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+

+#define MAX_IO_PORT_ADDRESS   0xFFFF

+

+/**

+  Reads memory-mapped registers.

+

+  The I/O operations are carried out exactly as requested. The caller is responsible 

+  for satisfying any alignment and I/O width restrictions that a PI System on a 

+  platform might require. For example on some platforms, width requests of 

+  EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will 

+  be handled by the driver.

+  

+  If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, 

+  or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for 

+  each of the Count operations that is performed.

+  

+  If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, 

+  EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is 

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times on the same Address.

+  

+  If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, 

+  EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is 

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times from the first element of Buffer.

+  

+  @param[in]  This     A pointer to the EFI_CPU_IO_PROTOCOL instance.

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

+  @param[in]  Address  The base address of the I/O operation. 

+  @param[in]  Count    The number of I/O operations to perform. The number of 

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

+  @param[out] 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 PI system.

+  @retval EFI_INVALID_PARAMETER  Width is invalid for this PI system.

+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.

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

+  @retval EFI_UNSUPPORTED        The address range specified by Address, Width, 

+                                 and Count is not valid for this PI system.

+

+**/

+EFI_STATUS

+EFIAPI

+CpuMemoryServiceRead (

+  IN  EFI_CPU_IO_PROTOCOL        *This,

+  IN  EFI_CPU_IO_PROTOCOL_WIDTH  Width,

+  IN  UINT64                     Address,

+  IN  UINTN                      Count,

+  OUT VOID                       *Buffer

+  );

+

+/**

+  Writes memory-mapped registers.

+

+  The I/O operations are carried out exactly as requested. The caller is responsible 

+  for satisfying any alignment and I/O width restrictions that a PI System on a 

+  platform might require. For example on some platforms, width requests of 

+  EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will 

+  be handled by the driver.

+  

+  If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, 

+  or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for 

+  each of the Count operations that is performed.

+  

+  If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, 

+  EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is 

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times on the same Address.

+  

+  If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, 

+  EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is 

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times from the first element of Buffer.

+  

+  @param[in]  This     A pointer to the EFI_CPU_IO_PROTOCOL instance.

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

+  @param[in]  Address  The base address of the I/O operation. 

+  @param[in]  Count    The number of I/O operations to perform. The number of 

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

+  @param[in]  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 PI system.

+  @retval EFI_INVALID_PARAMETER  Width is invalid for this PI system.

+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.

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

+  @retval EFI_UNSUPPORTED        The address range specified by Address, Width, 

+                                 and Count is not valid for this PI system.

+

+**/

+EFI_STATUS

+EFIAPI

+CpuMemoryServiceWrite (

+  IN EFI_CPU_IO_PROTOCOL        *This,

+  IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,

+  IN UINT64                     Address,

+  IN UINTN                      Count,

+  IN VOID                       *Buffer

+  );

+

+/**

+  Reads I/O registers.

+

+  The I/O operations are carried out exactly as requested. The caller is responsible 

+  for satisfying any alignment and I/O width restrictions that a PI System on a 

+  platform might require. For example on some platforms, width requests of 

+  EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will 

+  be handled by the driver.

+  

+  If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, 

+  or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for 

+  each of the Count operations that is performed.

+  

+  If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, 

+  EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is 

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times on the same Address.

+  

+  If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, 

+  EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is 

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times from the first element of Buffer.

+  

+  @param[in]  This     A pointer to the EFI_CPU_IO_PROTOCOL instance.

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

+  @param[in]  Address  The base address of the I/O operation. 

+  @param[in]  Count    The number of I/O operations to perform. The number of 

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

+  @param[out] 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 PI system.

+  @retval EFI_INVALID_PARAMETER  Width is invalid for this PI system.

+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.

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

+  @retval EFI_UNSUPPORTED        The address range specified by Address, Width, 

+                                 and Count is not valid for this PI system.

+

+**/

+EFI_STATUS

+EFIAPI

+CpuIoServiceRead (

+  IN  EFI_CPU_IO_PROTOCOL        *This,

+  IN  EFI_CPU_IO_PROTOCOL_WIDTH  Width,

+  IN  UINT64                     Address,

+  IN  UINTN                      Count,

+  OUT VOID                       *Buffer

+  );

+

+/**

+  Write I/O registers.

+

+  The I/O operations are carried out exactly as requested. The caller is responsible 

+  for satisfying any alignment and I/O width restrictions that a PI System on a 

+  platform might require. For example on some platforms, width requests of 

+  EfiCpuIoWidthUint64 do not work. Misaligned buffers, on the other hand, will 

+  be handled by the driver.

+  

+  If Width is EfiCpuIoWidthUint8, EfiCpuIoWidthUint16, EfiCpuIoWidthUint32, 

+  or EfiCpuIoWidthUint64, then both Address and Buffer are incremented for 

+  each of the Count operations that is performed.

+  

+  If Width is EfiCpuIoWidthFifoUint8, EfiCpuIoWidthFifoUint16, 

+  EfiCpuIoWidthFifoUint32, or EfiCpuIoWidthFifoUint64, then only Buffer is 

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times on the same Address.

+  

+  If Width is EfiCpuIoWidthFillUint8, EfiCpuIoWidthFillUint16, 

+  EfiCpuIoWidthFillUint32, or EfiCpuIoWidthFillUint64, then only Address is 

+  incremented for each of the Count operations that is performed. The read or 

+  write operation is performed Count times from the first element of Buffer.

+  

+  @param[in]  This     A pointer to the EFI_CPU_IO_PROTOCOL instance.

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

+  @param[in]  Address  The base address of the I/O operation. 

+  @param[in]  Count    The number of I/O operations to perform. The number of 

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

+  @param[in]  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 PI system.

+  @retval EFI_INVALID_PARAMETER  Width is invalid for this PI system.

+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.

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

+  @retval EFI_UNSUPPORTED        The address range specified by Address, Width, 

+                                 and Count is not valid for this PI system.

+                                 

+**/

+EFI_STATUS

+EFIAPI

+CpuIoServiceWrite (

+  IN EFI_CPU_IO_PROTOCOL        *This,

+  IN EFI_CPU_IO_PROTOCOL_WIDTH  Width,

+  IN UINT64                     Address,

+  IN UINTN                      Count,

+  IN VOID                       *Buffer

+  );

+

+#endif

diff --git a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIoDxe.inf b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIoDxe.inf
index 93d63ca755..feb0579067 100644
--- a/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIoDxe.inf
+++ b/IntelFrameworkModulePkg/Universal/CpuIoDxe/CpuIoDxe.inf
@@ -27,6 +27,7 @@
 

 [Sources]

   CpuIo.c

+  CpuIo.h

 

 [Packages]

   MdePkg/MdePkg.dec

@@ -40,7 +41,7 @@
   UefiBootServicesTableLib

 

 [Protocols]

-  gEfiCpuIoProtocolGuid                         # PROTOCOL SOMETIMES_PRODUCED

+  gEfiCpuIoProtocolGuid                         ## PRODUCES

 

 [Depex]

   TRUE